doc/ssl/SSL_CTX_new.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 SSL_CTX_new, SSLv3_method, SSLv3_server_method, SSLv3_client_method, TLSv1_method, TLSv1_server_method, TLSv1_client_method, TLSv1_1_method, TLSv1_1_server_method, TLSv1_1_client_method, TLS_method, TLS_server_method, TLS_client_method, SSLv23_method, SSLv23_server_method, SSLv23_client_method - create a new SSL_CTX object as framework for TLS/SSL enabled functions
   6
   7 =head1 SYNOPSIS
   8
   9  #include <openssl/ssl.h>
  10
  11  SSL_CTX *SSL_CTX_new(const SSL_METHOD *method);
  12
  13 =head1 DESCRIPTION
  14
  15 SSL_CTX_new() creates a new B<SSL_CTX> object as framework to establish
  16 TLS/SSL enabled connections.
  17
  18 =head1 NOTES
  19
  20 The SSL_CTX object uses B<method> as connection method. The methods exist
  21 in a generic type (for client and server use), a server only type, and a
  22 client only type. B<method> can be of the following types:
  23
  24 =over 4
  25
  26 =item SSLv3_method(void), SSLv3_server_method(void), SSLv3_client_method(void)
  27
  28 A TLS/SSL connection established with these methods will only understand the
  29 SSLv3 protocol. A client will send out SSLv3 client hello messages
  30 and will indicate that it only understands SSLv3. A server will only understand
  31 SSLv3 client hello messages.
  32
  33 =item TLSv1_method(void), TLSv1_server_method(void), TLSv1_client_method(void)
  34
  35 A TLS/SSL connection established with these methods will only understand the
  36 TLSv1 protocol. A client will send out TLSv1 client hello messages
  37 and will indicate that it only understands TLSv1. A server will only understand
  38 TLSv1 client hello messages.
  39
  40 =item TLSv1_1_method(void), TLSv1_1_server_method(void), TLSv1_1_client_method(void)
  41
  42 A TLS/SSL connection established with these methods will only understand the
  43 TLSv1.1 protocol. A client will send out TLSv1.1 client hello messages
  44 and will indicate that it only understands TLSv1.1. A server will only
  45 understand TLSv1.1 client hello messages.
  46
  47 =item TLSv1_2_method(void), TLSv1_2_server_method(void), TLSv1_2_client_method(void)
  48
  49 A TLS/SSL connection established with these methods will only understand the
  50 TLSv1.2 protocol. A client will send out TLSv1.2 client hello messages
  51 and will indicate that it only understands TLSv1.2. A server will only
  52 understand TLSv1.2 client hello messages.
  53
  54 =item TLS_method(void), TLS_server_method(void), TLS_client_method(void)
  55
  56 A TLS/SSL connection established with these methods may understand the
  57 SSLv3, TLSv1, TLSv1.1 and TLSv1.2 protocols.
  58
  59 If extensions are required (for example server name)
  60 a client will send out TLSv1 client hello messages including extensions and
  61 will indicate that it also understands TLSv1.1, TLSv1.2 and permits a
  62 fallback to SSLv3. A server will support SSLv3, TLSv1, TLSv1.1 and TLSv1.2
  63 protocols. This is the best choice when compatibility is a concern.
  64
  65 =item SSLv23_method(void), SSLv23_server_method(void), SSLv23_client_method(void)
  66
  67 Use of these functions is deprecated. They have been replaced with TLS_Method(),
  68 TLS_server_method() and TLS_client_method() respectively. New code should use
  69 those functions instead.
  70
  71 =back
  72
  73 The list of protocols available can later be limited using the
  74 SSL_OP_NO_SSLv3, SSL_OP_NO_TLSv1, SSL_OP_NO_TLSv1_1 and SSL_OP_NO_TLSv1_2
  75 options of the SSL_CTX_set_options() or SSL_set_options() functions.
  76 Using these options it is possible to choose e.g. SSLv23_server_method() and
  77 be able to negotiate with all possible clients, but to only allow newer
  78 protocols like TLSv1, TLSv1.1 or TLS v1.2.
  79
  80 Applications which never want to support SSLv3 can set SSL_OP_NO_SSLv3.
  81
  82 SSL_CTX_new() initializes the list of ciphers, the session cache setting,
  83 the callbacks, the keys and certificates and the options to its default
  84 values.
  85
  86 =head1 RETURN VALUES
  87
  88 The following return values can occur:
  89
  90 =over 4
  91
  92 =item NULL
  93
  94 The creation of a new SSL_CTX object failed. Check the error stack to
  95 find out the reason.
  96
  97 =item Pointer to an SSL_CTX object
  98
  99 The return value points to an allocated SSL_CTX object.
 100
 101 =back
 102
 103 =head1 HISTORY
 104
 105 SSLv2_method, SSLv2_server_method and SSLv2_client_method where removed in
 106 OpenSSL 1.1.0. SSLv23_method, SSLv23_server_method and SSLv23_client_method were
 107 deprecated and TLS_method, TLS_server_method and TLS_client_method
 108 were introduced in OpenSSL 1.1.0.
 109
 110 =head1 SEE ALSO
 111
 112 L<SSL_CTX_free(3)>, L<SSL_accept(3)>,
 113 L<ssl(3)>,  L<SSL_set_connect_state(3)>
 114
 115 =cut