secure/lib/libssl/man/SSL_CTX_new.3

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