crypto/external/bsd/openssl/dist/doc/ssl/SSL_CTX_new.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 SSL_CTX_new - 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.
  32
  33 =item SSLv3_method(void), SSLv3_server_method(void), SSLv3_client_method(void)
  34
  35 A TLS/SSL connection established with these methods will only understand the
  36 SSLv3 protocol. A client will send out SSLv3 client hello messages
  37 and will indicate that it only understands SSLv3. A server will only understand
  38 SSLv3 client hello messages. This especially means, that it will
  39 not understand SSLv2 client hello messages which are widely used for
  40 compatibility reasons, see SSLv23_*_method().
  41
  42 =item TLSv1_method(void), TLSv1_server_method(void), TLSv1_client_method(void)
  43
  44 A TLS/SSL connection established with these methods will only understand the
  45 TLSv1 protocol. A client will send out TLSv1 client hello messages
  46 and will indicate that it only understands TLSv1. A server will only understand
  47 TLSv1 client hello messages. This especially means, that it will
  48 not understand SSLv2 client hello messages which are widely used for
  49 compatibility reasons, see SSLv23_*_method(). It will also not understand
  50 SSLv3 client hello messages.
  51
  52 =item SSLv23_method(void), SSLv23_server_method(void), SSLv23_client_method(void)
  53
  54 A TLS/SSL connection established with these methods may understand the SSLv2,
  55 SSLv3, TLSv1, TLSv1.1 and TLSv1.2 protocols.
  56
  57 If the cipher list does not contain any SSLv2 ciphersuites (the default
  58 cipher list does not) or extensions are required (for example server name)
  59 a client will send out TLSv1 client hello messages including extensions and
  60 will indicate that it also understands TLSv1.1, TLSv1.2 and permits a
  61 fallback to SSLv3. A server will support SSLv3, TLSv1, TLSv1.1 and TLSv1.2
  62 protocols. This is the best choice when compatibility is a concern.
  63
  64 If any SSLv2 ciphersuites are included in the cipher list and no extensions
  65 are required then SSLv2 compatible client hellos will be used by clients and
  66 SSLv2 will be accepted by servers. This is B<not> recommended due to the
  67 insecurity of SSLv2 and the limited nature of the SSLv2 client hello
  68 prohibiting the use of extensions.
  69
  70 =back
  71
  72 The list of protocols available can later be limited using the SSL_OP_NO_SSLv2,
  73 SSL_OP_NO_SSLv3, SSL_OP_NO_TLSv1, SSL_OP_NO_TLSv1_1 and SSL_OP_NO_TLSv1_2
  74 options of the SSL_CTX_set_options() or SSL_set_options() functions.
  75 Using these options it is possible to choose e.g. SSLv23_server_method() and
  76 be able to negotiate with all possible clients, but to only allow newer
  77 protocols like TLSv1, TLSv1.1 or TLS v1.2.
  78
  79 Applications which never want to support SSLv2 (even is the cipher string
  80 is configured to use SSLv2 ciphersuites) can set SSL_OP_NO_SSLv2.
  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 SEE ALSO
 104
 105 L<SSL_CTX_free(3)|SSL_CTX_free(3)>, L<SSL_accept(3)|SSL_accept(3)>,
 106 L<ssl(3)|ssl(3)>,  L<SSL_set_connect_state(3)|SSL_set_connect_state(3)>
 107
 108 =cut