secure/lib/libssl/man/SSL_CTX_new.3

   1 .\" Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35)
   2 .\"
   3 .\" Standard preamble:
   4 .\" ========================================================================
   5 .de Sp \" Vertical space (when we can't use .PP)
   6 .if t .sp .5v
   7 .if n .sp
   8 ..
   9 .de Vb \" Begin verbatim text
  10 .ft CW
  11 .nf
  12 .ne \\$1
  13 ..
  14 .de Ve \" End verbatim text
  15 .ft R
  16 .fi
  17 ..
  18 .\" Set up some character translations and predefined strings.  \*(-- will
  19 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  20 .\" double quote, and \*(R" will give a right double quote.  \*(C+ will
  21 .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
  22 .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
  23 .\" nothing in troff, for use with C<>.
  24 .tr \(*W-
  25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  26 .ie n \{\
  27 .    ds -- \(*W-
  28 .    ds PI pi
  29 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  30 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  31 .    ds L" ""
  32 .    ds R" ""
  33 .    ds C` ""
  34 .    ds C' ""
  35 'br\}
  36 .el\{\
  37 .    ds -- \|\(em\|
  38 .    ds PI \(*p
  39 .    ds L" ``
  40 .    ds R" ''
  41 .    ds C`
  42 .    ds C'
  43 'br\}
  44 .\"
  45 .\" Escape single quotes in literal strings from groff's Unicode transform.
  46 .ie \n(.g .ds Aq \(aq
  47 .el       .ds Aq '
  48 .\"
  49 .\" If the F register is >0, we'll generate index entries on stderr for
  50 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
  51 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  52 .\" output yourself in some meaningful fashion.
  53 .\"
  54 .\" Avoid warning from groff about undefined register 'F'.
  55 .de IX
  56 ..
  57 .if !\nF .nr F 0
  58 .if \nF>0 \{\
  59 .    de IX
  60 .    tm Index:\\$1\t\\n%\t"\\$2"
  61 ..
  62 .    if !\nF==2 \{\
  63 .        nr % 0
  64 .        nr F 2
  65 .    \}
  66 .\}
  67 .\"
  68 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  69 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  70 .    \" fudge factors for nroff and troff
  71 .if n \{\
  72 .    ds #H 0
  73 .    ds #V .8m
  74 .    ds #F .3m
  75 .    ds #[ \f1
  76 .    ds #] \fP
  77 .\}
  78 .if t \{\
  79 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  80 .    ds #V .6m
  81 .    ds #F 0
  82 .    ds #[ \&
  83 .    ds #] \&
  84 .\}
  85 .    \" simple accents for nroff and troff
  86 .if n \{\
  87 .    ds ' \&
  88 .    ds ` \&
  89 .    ds ^ \&
  90 .    ds , \&
  91 .    ds ~ ~
  92 .    ds /
  93 .\}
  94 .if t \{\
  95 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
  96 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
  97 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
  98 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
  99 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 100 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 101 .\}
 102 .    \" troff and (daisy-wheel) nroff accents
 103 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 104 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 105 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 106 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 107 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 108 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 109 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 110 .ds ae a\h'-(\w'a'u*4/10)'e
 111 .ds Ae A\h'-(\w'A'u*4/10)'E
 112 .    \" corrections for vroff
 113 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 114 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 115 .    \" for low resolution devices (crt and lpr)
 116 .if \n(.H>23 .if \n(.V>19 \
 117 \{\
 118 .    ds : e
 119 .    ds 8 ss
 120 .    ds o a
 121 .    ds d- d\h'-1'\(ga
 122 .    ds D- D\h'-1'\(hy
 123 .    ds th \o'bp'
 124 .    ds Th \o'LP'
 125 .    ds ae ae
 126 .    ds Ae AE
 127 .\}
 128 .rm #[ #] #H #V #F C
 129 .\" ========================================================================
 130 .\"
 131 .IX Title "SSL_CTX_new 3"
 132 .TH SSL_CTX_new 3 "2018-08-14" "1.0.2p" "OpenSSL"
 133 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 134 .\" way too many mistakes in technical documents.
 135 .if n .ad l
 136 .nh
 137 .SH "NAME"
 138 SSL_CTX_new,
 139 SSLv23_method, SSLv23_server_method, SSLv23_client_method,
 140 TLSv1_2_method, TLSv1_2_server_method, TLSv1_2_client_method,
 141 TLSv1_1_method, TLSv1_1_server_method, TLSv1_1_client_method,
 142 TLSv1_method, TLSv1_server_method, TLSv1_client_method,
 143 SSLv3_method, SSLv3_server_method, SSLv3_client_method,
 144 SSLv2_method, SSLv2_server_method, SSLv2_client_method,
 145 DTLS_method, DTLS_server_method, DTLS_client_method,
 146 DTLSv1_2_method, DTLSv1_2_server_method, DTLSv1_2_client_method,
 147 DTLSv1_method, DTLSv1_server_method, DTLSv1_client_method \-
 148 create a new SSL_CTX object as framework for TLS/SSL enabled functions
 149 .SH "SYNOPSIS"
 150 .IX Header "SYNOPSIS"
 151 .Vb 1
 152 \& #include <openssl/ssl.h>
 153 \&
 154 \& SSL_CTX *SSL_CTX_new(const SSL_METHOD *method);
 155 \& const SSL_METHOD *SSLv23_method(void);
 156 \& const SSL_METHOD *SSLv23_server_method(void);
 157 \& const SSL_METHOD *SSLv23_client_method(void);
 158 \& const SSL_METHOD *TLSv1_2_method(void);
 159 \& const SSL_METHOD *TLSv1_2_server_method(void);
 160 \& const SSL_METHOD *TLSv1_2_client_method(void);
 161 \& const SSL_METHOD *TLSv1_1_method(void);
 162 \& const SSL_METHOD *TLSv1_1_server_method(void);
 163 \& const SSL_METHOD *TLSv1_1_client_method(void);
 164 \& const SSL_METHOD *TLSv1_method(void);
 165 \& const SSL_METHOD *TLSv1_server_method(void);
 166 \& const SSL_METHOD *TLSv1_client_method(void);
 167 \& #ifndef OPENSSL_NO_SSL3_METHOD
 168 \& const SSL_METHOD *SSLv3_method(void);
 169 \& const SSL_METHOD *SSLv3_server_method(void);
 170 \& const SSL_METHOD *SSLv3_client_method(void);
 171 \& #endif
 172 \& #ifndef OPENSSL_NO_SSL2
 173 \& const SSL_METHOD *SSLv2_method(void);
 174 \& const SSL_METHOD *SSLv2_server_method(void);
 175 \& const SSL_METHOD *SSLv2_client_method(void);
 176 \& #endif
 177 \&
 178 \& const SSL_METHOD *DTLS_method(void);
 179 \& const SSL_METHOD *DTLS_server_method(void);
 180 \& const SSL_METHOD *DTLS_client_method(void);
 181 \& const SSL_METHOD *DTLSv1_2_method(void);
 182 \& const SSL_METHOD *DTLSv1_2_server_method(void);
 183 \& const SSL_METHOD *DTLSv1_2_client_method(void);
 184 \& const SSL_METHOD *DTLSv1_method(void);
 185 \& const SSL_METHOD *DTLSv1_server_method(void);
 186 \& const SSL_METHOD *DTLSv1_client_method(void);
 187 .Ve
 188 .SH "DESCRIPTION"
 189 .IX Header "DESCRIPTION"
 190 \&\fISSL_CTX_new()\fR creates a new \fB\s-1SSL_CTX\s0\fR object as framework to establish
 191 \&\s-1TLS/SSL\s0 enabled connections.
 192 .SH "NOTES"
 193 .IX Header "NOTES"
 194 The \s-1SSL_CTX\s0 object uses \fBmethod\fR as connection method. The methods exist
 195 in a generic type (for client and server use), a server only type, and a
 196 client only type. \fBmethod\fR can be of the following types:
 197 .IP "\fISSLv23_method()\fR, \fISSLv23_server_method()\fR, \fISSLv23_client_method()\fR" 4
 198 .IX Item "SSLv23_method(), SSLv23_server_method(), SSLv23_client_method()"
 199 These are the general-purpose \fIversion-flexible\fR \s-1SSL/TLS\s0 methods.
 200 The actual protocol version used will be negotiated to the highest version
 201 mutually supported by the client and the server.
 202 The supported protocols are SSLv2, SSLv3, TLSv1, TLSv1.1 and TLSv1.2.
 203 Most applications should use these method, and avoid the version specific
 204 methods described below.
 205 .Sp
 206 The list of protocols available can be further limited using the
 207 \&\fBSSL_OP_NO_SSLv2\fR, \fBSSL_OP_NO_SSLv3\fR, \fBSSL_OP_NO_TLSv1\fR,
 208 \&\fBSSL_OP_NO_TLSv1_1\fR and \fBSSL_OP_NO_TLSv1_2\fR options of the
 209 \&\fISSL_CTX_set_options\fR\|(3) or \fISSL_set_options\fR\|(3) functions.
 210 Clients should avoid creating \*(L"holes\*(R" in the set of protocols they support,
 211 when disabling a protocol, make sure that you also disable either all previous
 212 or all subsequent protocol versions.
 213 In clients, when a protocol version is disabled without disabling \fIall\fR
 214 previous protocol versions, the effect is to also disable all subsequent
 215 protocol versions.
 216 .Sp
 217 The SSLv2 and SSLv3 protocols are deprecated and should generally not be used.
 218 Applications should typically use \fISSL_CTX_set_options\fR\|(3) in combination with
 219 the \fBSSL_OP_NO_SSLv3\fR flag to disable negotiation of SSLv3 via the above
 220 \&\fIversion-flexible\fR \s-1SSL/TLS\s0 methods.
 221 The \fBSSL_OP_NO_SSLv2\fR option is set by default, and would need to be cleared
 222 via \fISSL_CTX_clear_options\fR\|(3) in order to enable negotiation of SSLv2.
 223 .IP "\fITLSv1_2_method()\fR, \fITLSv1_2_server_method()\fR, \fITLSv1_2_client_method()\fR" 4
 224 .IX Item "TLSv1_2_method(), TLSv1_2_server_method(), TLSv1_2_client_method()"
 225 A \s-1TLS/SSL\s0 connection established with these methods will only understand the
 226 TLSv1.2 protocol.  A client will send out TLSv1.2 client hello messages and
 227 will also indicate that it only understand TLSv1.2.  A server will only
 228 understand TLSv1.2 client hello messages.
 229 .IP "\fITLSv1_1_method()\fR, \fITLSv1_1_server_method()\fR, \fITLSv1_1_client_method()\fR" 4
 230 .IX Item "TLSv1_1_method(), TLSv1_1_server_method(), TLSv1_1_client_method()"
 231 A \s-1TLS/SSL\s0 connection established with these methods will only understand the
 232 TLSv1.1 protocol.  A client will send out TLSv1.1 client hello messages and
 233 will also indicate that it only understand TLSv1.1.  A server will only
 234 understand TLSv1.1 client hello messages.
 235 .IP "\fITLSv1_method()\fR, \fITLSv1_server_method()\fR, \fITLSv1_client_method()\fR" 4
 236 .IX Item "TLSv1_method(), TLSv1_server_method(), TLSv1_client_method()"
 237 A \s-1TLS/SSL\s0 connection established with these methods will only understand the
 238 TLSv1 protocol.  A client will send out TLSv1 client hello messages and will
 239 indicate that it only understands TLSv1.  A server will only understand TLSv1
 240 client hello messages.
 241 .IP "\fISSLv3_method()\fR, \fISSLv3_server_method()\fR, \fISSLv3_client_method()\fR" 4
 242 .IX Item "SSLv3_method(), SSLv3_server_method(), SSLv3_client_method()"
 243 A \s-1TLS/SSL\s0 connection established with these methods will only understand the
 244 SSLv3 protocol.  A client will send out SSLv3 client hello messages and will
 245 indicate that it only understands SSLv3.  A server will only understand SSLv3
 246 client hello messages.  The SSLv3 protocol is deprecated and should not be
 247 used.
 248 .IP "\fISSLv2_method()\fR, \fISSLv2_server_method()\fR, \fISSLv2_client_method()\fR" 4
 249 .IX Item "SSLv2_method(), SSLv2_server_method(), SSLv2_client_method()"
 250 A \s-1TLS/SSL\s0 connection established with these methods will only understand the
 251 SSLv2 protocol.  A client will send out SSLv2 client hello messages and will
 252 also indicate that it only understand SSLv2.  A server will only understand
 253 SSLv2 client hello messages.  The SSLv2 protocol offers little to no security
 254 and should not be used.
 255 As of OpenSSL 1.0.2g, \s-1EXPORT\s0 ciphers and 56\-bit \s-1DES\s0 are no longer available
 256 with SSLv2.
 257 .IP "\fIDTLS_method()\fR, \fIDTLS_server_method()\fR, \fIDTLS_client_method()\fR" 4
 258 .IX Item "DTLS_method(), DTLS_server_method(), DTLS_client_method()"
 259 These are the version-flexible \s-1DTLS\s0 methods.
 260 .IP "\fIDTLSv1_2_method()\fR, \fIDTLSv1_2_server_method()\fR, \fIDTLSv1_2_client_method()\fR" 4
 261 .IX Item "DTLSv1_2_method(), DTLSv1_2_server_method(), DTLSv1_2_client_method()"
 262 These are the version-specific methods for DTLSv1.2.
 263 .IP "\fIDTLSv1_method()\fR, \fIDTLSv1_server_method()\fR, \fIDTLSv1_client_method()\fR" 4
 264 .IX Item "DTLSv1_method(), DTLSv1_server_method(), DTLSv1_client_method()"
 265 These are the version-specific methods for DTLSv1.
 266 .PP
 267 \&\fISSL_CTX_new()\fR initializes the list of ciphers, the session cache setting, the
 268 callbacks, the keys and certificates and the options to its default values.
 269 .SH "RETURN VALUES"
 270 .IX Header "RETURN VALUES"
 271 The following return values can occur:
 272 .IP "\s-1NULL\s0" 4
 273 .IX Item "NULL"
 274 The creation of a new \s-1SSL_CTX\s0 object failed. Check the error stack to find out
 275 the reason.
 276 .IP "Pointer to an \s-1SSL_CTX\s0 object" 4
 277 .IX Item "Pointer to an SSL_CTX object"
 278 The return value points to an allocated \s-1SSL_CTX\s0 object.
 279 .SH "SEE ALSO"
 280 .IX Header "SEE ALSO"
 281 \&\fISSL_CTX_set_options\fR\|(3), \fISSL_CTX_clear_options\fR\|(3), \fISSL_set_options\fR\|(3),
 282 \&\fISSL_CTX_free\fR\|(3), \fISSL_accept\fR\|(3),
 283 \&\fIssl\fR\|(3),  \fISSL_set_connect_state\fR\|(3)