secure/lib/libssl/man/SSL_CTX_new.3

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