crypto/external/bsd/openssl/lib/libcrypto/man/SSL_CTX_new.3

   1 .\"     $NetBSD: SSL_CTX_new.3,v 1.14 2015/06/12 17:01:14 christos Exp $
   2 .\"
   3 .\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.28)
   4 .\"
   5 .\" Standard preamble:
   6 .\" ========================================================================
   7 .de Sp \" Vertical space (when we can't use .PP)
   8 .if t .sp .5v
   9 .if n .sp
  10 ..
  11 .de Vb \" Begin verbatim text
  12 .ft CW
  13 .nf
  14 .ne \\$1
  15 ..
  16 .de Ve \" End verbatim text
  17 .ft R
  18 .fi
  19 ..
  20 .\" Set up some character translations and predefined strings.  \*(-- will
  21 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  22 .\" double quote, and \*(R" will give a right double quote.  \*(C+ will
  23 .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
  24 .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
  25 .\" nothing in troff, for use with C<>.
  26 .tr \(*W-
  27 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  28 .ie n \{\
  29 .    ds -- \(*W-
  30 .    ds PI pi
  31 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  32 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  33 .    ds L" ""
  34 .    ds R" ""
  35 .    ds C` ""
  36 .    ds C' ""
  37 'br\}
  38 .el\{\
  39 .    ds -- \|\(em\|
  40 .    ds PI \(*p
  41 .    ds L" ``
  42 .    ds R" ''
  43 .    ds C`
  44 .    ds C'
  45 'br\}
  46 .\"
  47 .\" Escape single quotes in literal strings from groff's Unicode transform.
  48 .ie \n(.g .ds Aq \(aq
  49 .el       .ds Aq '
  50 .\"
  51 .\" If the F register is turned on, we'll generate index entries on stderr for
  52 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
  53 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  54 .\" output yourself in some meaningful fashion.
  55 .\"
  56 .\" Avoid warning from groff about undefined register 'F'.
  57 .de IX
  58 ..
  59 .nr rF 0
  60 .if \n(.g .if rF .nr rF 1
  61 .if (\n(rF:(\n(.g==0)) \{
  62 .    if \nF \{
  63 .        de IX
  64 .        tm Index:\\$1\t\\n%\t"\\$2"
  65 ..
  66 .        if !\nF==2 \{
  67 .            nr % 0
  68 .            nr F 2
  69 .        \}
  70 .    \}
  71 .\}
  72 .rr rF
  73 .\"
  74 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  75 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  76 .    \" fudge factors for nroff and troff
  77 .if n \{\
  78 .    ds #H 0
  79 .    ds #V .8m
  80 .    ds #F .3m
  81 .    ds #[ \f1
  82 .    ds #] \fP
  83 .\}
  84 .if t \{\
  85 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  86 .    ds #V .6m
  87 .    ds #F 0
  88 .    ds #[ \&
  89 .    ds #] \&
  90 .\}
  91 .    \" simple accents for nroff and troff
  92 .if n \{\
  93 .    ds ' \&
  94 .    ds ` \&
  95 .    ds ^ \&
  96 .    ds , \&
  97 .    ds ~ ~
  98 .    ds /
  99 .\}
 100 .if t \{\
 101 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
 102 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
 103 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
 104 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
 105 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 106 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 107 .\}
 108 .    \" troff and (daisy-wheel) nroff accents
 109 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 110 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 111 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 112 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 113 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 114 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 115 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 116 .ds ae a\h'-(\w'a'u*4/10)'e
 117 .ds Ae A\h'-(\w'A'u*4/10)'E
 118 .    \" corrections for vroff
 119 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 120 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 121 .    \" for low resolution devices (crt and lpr)
 122 .if \n(.H>23 .if \n(.V>19 \
 123 \{\
 124 .    ds : e
 125 .    ds 8 ss
 126 .    ds o a
 127 .    ds d- d\h'-1'\(ga
 128 .    ds D- D\h'-1'\(hy
 129 .    ds th \o'bp'
 130 .    ds Th \o'LP'
 131 .    ds ae ae
 132 .    ds Ae AE
 133 .\}
 134 .rm #[ #] #H #V #F C
 135 .\" ========================================================================
 136 .\"
 137 .IX Title "SSL_CTX_new 3"
 138 .TH SSL_CTX_new 3 "2014-08-10" "1.0.1n" "OpenSSL"
 139 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 140 .\" way too many mistakes in technical documents.
 141 .if n .ad l
 142 .nh
 143 .SH "NAME"
 144 SSL_CTX_new \- create a new SSL_CTX object as framework for TLS/SSL enabled functions
 145 .SH "LIBRARY"
 146 libcrypto, -lcrypto
 147 .SH "SYNOPSIS"
 148 .IX Header "SYNOPSIS"
 149 .Vb 1
 150 \& #include <openssl/ssl.h>
 151 \&
 152 \& SSL_CTX *SSL_CTX_new(const SSL_METHOD *method);
 153 .Ve
 154 .SH "DESCRIPTION"
 155 .IX Header "DESCRIPTION"
 156 \&\fISSL_CTX_new()\fR creates a new \fB\s-1SSL_CTX\s0\fR object as framework to establish
 157 \&\s-1TLS/SSL\s0 enabled connections.
 158 .SH "NOTES"
 159 .IX Header "NOTES"
 160 The \s-1SSL_CTX\s0 object uses \fBmethod\fR as connection method. The methods exist
 161 in a generic type (for client and server use), a server only type, and a
 162 client only type. \fBmethod\fR can be of the following types:
 163 .IP "SSLv2_method(void), SSLv2_server_method(void), SSLv2_client_method(void)" 4
 164 .IX Item "SSLv2_method(void), SSLv2_server_method(void), SSLv2_client_method(void)"
 165 A \s-1TLS/SSL\s0 connection established with these methods will only understand
 166 the SSLv2 protocol. A client will send out SSLv2 client hello messages
 167 and will also indicate that it only understand SSLv2. A server will only
 168 understand SSLv2 client hello messages.
 169 .IP "SSLv3_method(void), SSLv3_server_method(void), SSLv3_client_method(void)" 4
 170 .IX Item "SSLv3_method(void), SSLv3_server_method(void), SSLv3_client_method(void)"
 171 A \s-1TLS/SSL\s0 connection established with these methods will only understand the
 172 SSLv3 protocol. A client will send out SSLv3 client hello messages
 173 and will indicate that it only understands SSLv3. A server will only understand
 174 SSLv3 client hello messages. This especially means, that it will
 175 not understand SSLv2 client hello messages which are widely used for
 176 compatibility reasons, see SSLv23_*\fI_method()\fR.
 177 .IP "TLSv1_method(void), TLSv1_server_method(void), TLSv1_client_method(void)" 4
 178 .IX Item "TLSv1_method(void), TLSv1_server_method(void), TLSv1_client_method(void)"
 179 A \s-1TLS/SSL\s0 connection established with these methods will only understand the
 180 TLSv1 protocol. A client will send out TLSv1 client hello messages
 181 and will indicate that it only understands TLSv1. A server will only understand
 182 TLSv1 client hello messages. This especially means, that it will
 183 not understand SSLv2 client hello messages which are widely used for
 184 compatibility reasons, see SSLv23_*\fI_method()\fR. It will also not understand
 185 SSLv3 client hello messages.
 186 .IP "SSLv23_method(void), SSLv23_server_method(void), SSLv23_client_method(void)" 4
 187 .IX Item "SSLv23_method(void), SSLv23_server_method(void), SSLv23_client_method(void)"
 188 A \s-1TLS/SSL\s0 connection established with these methods may understand the SSLv2,
 189 SSLv3, TLSv1, TLSv1.1 and TLSv1.2 protocols.
 190 .Sp
 191 If the cipher list does not contain any SSLv2 ciphersuites (the default
 192 cipher list does not) or extensions are required (for example server name)
 193 a client will send out TLSv1 client hello messages including extensions and
 194 will indicate that it also understands TLSv1.1, TLSv1.2 and permits a
 195 fallback to SSLv3. A server will support SSLv3, TLSv1, TLSv1.1 and TLSv1.2
 196 protocols. This is the best choice when compatibility is a concern.
 197 .Sp
 198 If any SSLv2 ciphersuites are included in the cipher list and no extensions
 199 are required then SSLv2 compatible client hellos will be used by clients and
 200 SSLv2 will be accepted by servers. This is \fBnot\fR recommended due to the
 201 insecurity of SSLv2 and the limited nature of the SSLv2 client hello
 202 prohibiting the use of extensions.
 203 .PP
 204 The list of protocols available can later be limited using the SSL_OP_NO_SSLv2,
 205 SSL_OP_NO_SSLv3, SSL_OP_NO_TLSv1, SSL_OP_NO_TLSv1_1 and SSL_OP_NO_TLSv1_2
 206 options of the \fISSL_CTX_set_options()\fR or \fISSL_set_options()\fR functions.
 207 Using these options it is possible to choose e.g. \fISSLv23_server_method()\fR and
 208 be able to negotiate with all possible clients, but to only allow newer
 209 protocols like TLSv1, TLSv1.1 or \s-1TLS\s0 v1.2.
 210 .PP
 211 Applications which never want to support SSLv2 (even is the cipher string
 212 is configured to use SSLv2 ciphersuites) can set SSL_OP_NO_SSLv2.
 213 .PP
 214 \&\fISSL_CTX_new()\fR initializes the list of ciphers, the session cache setting,
 215 the callbacks, the keys and certificates and the options to its default
 216 values.
 217 .SH "RETURN VALUES"
 218 .IX Header "RETURN VALUES"
 219 The following return values can occur:
 220 .IP "\s-1NULL\s0" 4
 221 .IX Item "NULL"
 222 The creation of a new \s-1SSL_CTX\s0 object failed. Check the error stack to
 223 find out the reason.
 224 .IP "Pointer to an \s-1SSL_CTX\s0 object" 4
 225 .IX Item "Pointer to an SSL_CTX object"
 226 The return value points to an allocated \s-1SSL_CTX\s0 object.
 227 .SH "SEE ALSO"
 228 .IX Header "SEE ALSO"
 229 \&\fISSL_CTX_free\fR\|(3), \fISSL_accept\fR\|(3),
 230 \&\fIssl\fR\|(3),  \fISSL_set_connect_state\fR\|(3)