secure/lib/libssl/man/SSL_CTX_new.3

   1 .\" Automatically generated by Pod::Man 2.27 (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 "2015-06-11" "1.0.1n" "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 \- create a new SSL_CTX object as framework for TLS/SSL enabled functions
 143 .SH "SYNOPSIS"
 144 .IX Header "SYNOPSIS"
 145 .Vb 1
 146 \& #include <openssl/ssl.h>
 147 \&
 148 \& SSL_CTX *SSL_CTX_new(const SSL_METHOD *method);
 149 .Ve
 150 .SH "DESCRIPTION"
 151 .IX Header "DESCRIPTION"
 152 \&\fISSL_CTX_new()\fR creates a new \fB\s-1SSL_CTX\s0\fR object as framework to establish
 153 \&\s-1TLS/SSL\s0 enabled connections.
 154 .SH "NOTES"
 155 .IX Header "NOTES"
 156 The \s-1SSL_CTX\s0 object uses \fBmethod\fR as connection method. The methods exist
 157 in a generic type (for client and server use), a server only type, and a
 158 client only type. \fBmethod\fR can be of the following types:
 159 .IP "SSLv2_method(void), SSLv2_server_method(void), SSLv2_client_method(void)" 4
 160 .IX Item "SSLv2_method(void), SSLv2_server_method(void), SSLv2_client_method(void)"
 161 A \s-1TLS/SSL\s0 connection established with these methods will only understand
 162 the SSLv2 protocol. A client will send out SSLv2 client hello messages
 163 and will also indicate that it only understand SSLv2. A server will only
 164 understand SSLv2 client hello messages.
 165 .IP "SSLv3_method(void), SSLv3_server_method(void), SSLv3_client_method(void)" 4
 166 .IX Item "SSLv3_method(void), SSLv3_server_method(void), SSLv3_client_method(void)"
 167 A \s-1TLS/SSL\s0 connection established with these methods will only understand the
 168 SSLv3 protocol. A client will send out SSLv3 client hello messages
 169 and will indicate that it only understands SSLv3. A server will only understand
 170 SSLv3 client hello messages. This especially means, that it will
 171 not understand SSLv2 client hello messages which are widely used for
 172 compatibility reasons, see SSLv23_*\fI_method()\fR.
 173 .IP "TLSv1_method(void), TLSv1_server_method(void), TLSv1_client_method(void)" 4
 174 .IX Item "TLSv1_method(void), TLSv1_server_method(void), TLSv1_client_method(void)"
 175 A \s-1TLS/SSL\s0 connection established with these methods will only understand the
 176 TLSv1 protocol. A client will send out TLSv1 client hello messages
 177 and will indicate that it only understands TLSv1. A server will only understand
 178 TLSv1 client hello messages. This especially means, that it will
 179 not understand SSLv2 client hello messages which are widely used for
 180 compatibility reasons, see SSLv23_*\fI_method()\fR. It will also not understand
 181 SSLv3 client hello messages.
 182 .IP "SSLv23_method(void), SSLv23_server_method(void), SSLv23_client_method(void)" 4
 183 .IX Item "SSLv23_method(void), SSLv23_server_method(void), SSLv23_client_method(void)"
 184 A \s-1TLS/SSL\s0 connection established with these methods may understand the SSLv2,
 185 SSLv3, TLSv1, TLSv1.1 and TLSv1.2 protocols.
 186 .Sp
 187 If the cipher list does not contain any SSLv2 ciphersuites (the default
 188 cipher list does not) or extensions are required (for example server name)
 189 a client will send out TLSv1 client hello messages including extensions and
 190 will indicate that it also understands TLSv1.1, TLSv1.2 and permits a
 191 fallback to SSLv3. A server will support SSLv3, TLSv1, TLSv1.1 and TLSv1.2
 192 protocols. This is the best choice when compatibility is a concern.
 193 .Sp
 194 If any SSLv2 ciphersuites are included in the cipher list and no extensions
 195 are required then SSLv2 compatible client hellos will be used by clients and
 196 SSLv2 will be accepted by servers. This is \fBnot\fR recommended due to the
 197 insecurity of SSLv2 and the limited nature of the SSLv2 client hello
 198 prohibiting the use of extensions.
 199 .PP
 200 The list of protocols available can later be limited using the SSL_OP_NO_SSLv2,
 201 SSL_OP_NO_SSLv3, SSL_OP_NO_TLSv1, SSL_OP_NO_TLSv1_1 and SSL_OP_NO_TLSv1_2
 202 options of the \fISSL_CTX_set_options()\fR or \fISSL_set_options()\fR functions.
 203 Using these options it is possible to choose e.g. \fISSLv23_server_method()\fR and
 204 be able to negotiate with all possible clients, but to only allow newer
 205 protocols like TLSv1, TLSv1.1 or \s-1TLS\s0 v1.2.
 206 .PP
 207 Applications which never want to support SSLv2 (even is the cipher string
 208 is configured to use SSLv2 ciphersuites) can set SSL_OP_NO_SSLv2.
 209 .PP
 210 \&\fISSL_CTX_new()\fR initializes the list of ciphers, the session cache setting,
 211 the callbacks, the keys and certificates and the options to its default
 212 values.
 213 .SH "RETURN VALUES"
 214 .IX Header "RETURN VALUES"
 215 The following return values can occur:
 216 .IP "\s-1NULL\s0" 4
 217 .IX Item "NULL"
 218 The creation of a new \s-1SSL_CTX\s0 object failed. Check the error stack to
 219 find out the reason.
 220 .IP "Pointer to an \s-1SSL_CTX\s0 object" 4
 221 .IX Item "Pointer to an SSL_CTX object"
 222 The return value points to an allocated \s-1SSL_CTX\s0 object.
 223 .SH "SEE ALSO"
 224 .IX Header "SEE ALSO"
 225 \&\fISSL_CTX_free\fR\|(3), \fISSL_accept\fR\|(3),
 226 \&\fIssl\fR\|(3),  \fISSL_set_connect_state\fR\|(3)