secure/lib/libssl/man/SSL_CTX_new.3

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