doc/ssl/SSL_CTX_new.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 SSL_CTX_new, SSLv2_method, SSLv2_server_method, SSLv2_client_method, SSLv3_method, SSLv3_server_method, SSLv3_client_method, TLSv1_method(void), TLSv1_server_method(void), TLSv1_client_method, TLSv1_1_method, TLSv1_1_server_method, TLSv1_1_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 SSLv2_method(void), SSLv2_server_method(void), SSLv2_client_method(void)
  27
  28 A TLS/SSL connection established with these methods will only understand
  29 the SSLv2 protocol. A client will send out SSLv2 client hello messages
  30 and will also indicate that it only understand SSLv2. A server will only
  31 understand SSLv2 client hello messages. The SSLv2 protocol is deprecated
  32 and very broken: its use is B<strongly> discouraged.
  33
  34 =item SSLv3_method(void), SSLv3_server_method(void), SSLv3_client_method(void)
  35
  36 A TLS/SSL connection established with these methods will only understand the
  37 SSLv3 protocol. A client will send out SSLv3 client hello messages
  38 and will indicate that it only understands SSLv3. A server will only understand
  39 SSLv3 client hello messages. This especially means, that it will
  40 not understand SSLv2 client hello messages which are widely used for
  41 compatibility reasons, see SSLv23_*_method().
  42
  43 =item TLSv1_method(void), TLSv1_server_method(void), TLSv1_client_method(void)
  44
  45 A TLS/SSL connection established with these methods will only understand the
  46 TLSv1 protocol. A client will send out TLSv1 client hello messages
  47 and will indicate that it only understands TLSv1. A server will only understand
  48 TLSv1 client hello messages. This especially means, that it will
  49 not understand SSLv2 client hello messages which are widely used for
  50 compatibility reasons, see SSLv23_*_method(). It will also not understand
  51 SSLv3 client hello messages.
  52
  53 =item TLSv1_1_method(void), TLSv1_1_server_method(void), TLSv1_1_client_method(void)
  54
  55 A TLS/SSL connection established with these methods will only understand the
  56 TLSv1.1 protocol. A client will send out TLSv1.1 client hello messages
  57 and will indicate that it only understands TLSv1.1. A server will only
  58 understand TLSv1.1 client hello messages. This especially means, that it will
  59 not understand SSLv2 client hello messages which are widely used for
  60 compatibility reasons, see SSLv23_*_method(). It will also not understand
  61 SSLv3 client hello messages.
  62
  63 =item SSLv23_method(void), SSLv23_server_method(void), SSLv23_client_method(void)
  64
  65 A TLS/SSL connection established with these methods may understand the SSLv2,
  66 SSLv3, TLSv1, TLSv1.1 and TLSv1.2 protocols.
  67
  68 If the cipher list does not contain any SSLv2 ciphersuites (the default
  69 cipher list does not) or extensions are required (for example server name)
  70 a client will send out TLSv1 client hello messages including extensions and
  71 will indicate that it also understands TLSv1.1, TLSv1.2 and permits a
  72 fallback to SSLv3. A server will support SSLv3, TLSv1, TLSv1.1 and TLSv1.2
  73 protocols. This is the best choice when compatibility is a concern.
  74
  75 If any SSLv2 ciphersuites are included in the cipher list and no extensions
  76 are required then SSLv2 compatible client hellos will be used by clients and
  77 SSLv2 will be accepted by servers. This is B<not> recommended due to the
  78 insecurity of SSLv2 and the limited nature of the SSLv2 client hello
  79 prohibiting the use of extensions.
  80
  81 =back
  82
  83 The list of protocols available can later be limited using the SSL_OP_NO_SSLv2,
  84 SSL_OP_NO_SSLv3, SSL_OP_NO_TLSv1, SSL_OP_NO_TLSv1_1 and SSL_OP_NO_TLSv1_2
  85 options of the SSL_CTX_set_options() or SSL_set_options() functions.
  86 Using these options it is possible to choose e.g. SSLv23_server_method() and
  87 be able to negotiate with all possible clients, but to only allow newer
  88 protocols like TLSv1, TLSv1.1 or TLS v1.2.
  89
  90 Applications which never want to support SSLv2 (even is the cipher string
  91 is configured to use SSLv2 ciphersuites) can set SSL_OP_NO_SSLv2.
  92
  93 SSL_CTX_new() initializes the list of ciphers, the session cache setting,
  94 the callbacks, the keys and certificates and the options to its default
  95 values.
  96
  97 =head1 RETURN VALUES
  98
  99 The following return values can occur:
 100
 101 =over 4
 102
 103 =item NULL
 104
 105 The creation of a new SSL_CTX object failed. Check the error stack to
 106 find out the reason.
 107
 108 =item Pointer to an SSL_CTX object
 109
 110 The return value points to an allocated SSL_CTX object.
 111
 112 =back
 113
 114 =head1 SEE ALSO
 115
 116 L<SSL_CTX_free(3)|SSL_CTX_free(3)>, L<SSL_accept(3)|SSL_accept(3)>,
 117 L<ssl(3)|ssl(3)>,  L<SSL_set_connect_state(3)|SSL_set_connect_state(3)>
 118
 119 =cut