secure/lib/libssl/man/ssl.3

   1 .\" Automatically generated by Pod::Man version 1.15
   2 .\" Wed Feb 19 16:47:50 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 3"
 141 .TH ssl 3 "0.9.7a" "2003-02-19" "OpenSSL"
 142 .UC
 143 .SH "NAME"
 144 \&\s-1SSL\s0 \- OpenSSL \s-1SSL/TLS\s0 library
 145 .SH "SYNOPSIS"
 146 .IX Header "SYNOPSIS"
 147 .SH "DESCRIPTION"
 148 .IX Header "DESCRIPTION"
 149 The OpenSSL \fBssl\fR library implements the Secure Sockets Layer (\s-1SSL\s0 v2/v3) and
 150 Transport Layer Security (\s-1TLS\s0 v1) protocols. It provides a rich \s-1API\s0 which is
 151 documented here.
 152 .PP
 153 At first the library must be initialized; see
 154 SSL_library_init(3).
 155 .PP
 156 Then an \fB\s-1SSL_CTX\s0\fR object is created as a framework to establish
 157 \&\s-1TLS/SSL\s0 enabled connections (see SSL_CTX_new(3)).
 158 Various options regarding certificates, algorithms etc. can be set
 159 in this object.
 160 .PP
 161 When a network connection has been created, it can be assigned to an
 162 \&\fB\s-1SSL\s0\fR object. After the \fB\s-1SSL\s0\fR object has been created using
 163 SSL_new(3), SSL_set_fd(3) or
 164 SSL_set_bio(3) can be used to associate the network
 165 connection with the object.
 166 .PP
 167 Then the \s-1TLS/SSL\s0 handshake is performed using
 168 SSL_accept(3) or SSL_connect(3)
 169 respectively.
 170 SSL_read(3) and SSL_write(3) are used
 171 to read and write data on the \s-1TLS/SSL\s0 connection.
 172 SSL_shutdown(3) can be used to shut down the
 173 \&\s-1TLS/SSL\s0 connection.
 174 .SH "DATA STRUCTURES"
 175 .IX Header "DATA STRUCTURES"
 176 Currently the OpenSSL \fBssl\fR library functions deals with the following data
 177 structures:
 178 .Ip "\fB\s-1SSL_METHOD\s0\fR (\s-1SSL\s0 Method)" 4
 179 .IX Item "SSL_METHOD (SSL Method)"
 180 That's a dispatch structure describing the internal \fBssl\fR library
 181 methods/functions which implement the various protocol versions (SSLv1, SSLv2
 182 and TLSv1). It's needed to create an \fB\s-1SSL_CTX\s0\fR.
 183 .Ip "\fB\s-1SSL_CIPHER\s0\fR (\s-1SSL\s0 Cipher)" 4
 184 .IX Item "SSL_CIPHER (SSL Cipher)"
 185 This structure holds the algorithm information for a particular cipher which
 186 are a core part of the \s-1SSL/TLS\s0 protocol. The available ciphers are configured
 187 on a \fB\s-1SSL_CTX\s0\fR basis and the actually used ones are then part of the
 188 \&\fB\s-1SSL_SESSION\s0\fR.
 189 .Ip "\fB\s-1SSL_CTX\s0\fR (\s-1SSL\s0 Context)" 4
 190 .IX Item "SSL_CTX (SSL Context)"
 191 That's the global context structure which is created by a server or client
 192 once per program life-time and which holds mainly default values for the
 193 \&\fB\s-1SSL\s0\fR structures which are later created for the connections.
 194 .Ip "\fB\s-1SSL_SESSION\s0\fR (\s-1SSL\s0 Session)" 4
 195 .IX Item "SSL_SESSION (SSL Session)"
 196 This is a structure containing the current \s-1TLS/SSL\s0 session details for a
 197 connection: \fB\s-1SSL_CIPHER\s0\fRs, client and server certificates, keys, etc.
 198 .Ip "\fB\s-1SSL\s0\fR (\s-1SSL\s0 Connection)" 4
 199 .IX Item "SSL (SSL Connection)"
 200 That's the main \s-1SSL/TLS\s0 structure which is created by a server or client per
 201 established connection. This actually is the core structure in the \s-1SSL\s0 \s-1API\s0.
 202 Under run-time the application usually deals with this structure which has
 203 links to mostly all other structures.
 204 .SH "HEADER FILES"
 205 .IX Header "HEADER FILES"
 206 Currently the OpenSSL \fBssl\fR library provides the following C header files
 207 containing the prototypes for the data structures and and functions:
 208 .Ip "\fBssl.h\fR" 4
 209 .IX Item "ssl.h"
 210 That's the common header file for the \s-1SSL/TLS\s0 \s-1API\s0.  Include it into your
 211 program to make the \s-1API\s0 of the \fBssl\fR library available. It internally
 212 includes both more private \s-1SSL\s0 headers and headers from the \fBcrypto\fR library.
 213 Whenever you need hard-core details on the internals of the \s-1SSL\s0 \s-1API\s0, look
 214 inside this header file.
 215 .Ip "\fBssl2.h\fR" 4
 216 .IX Item "ssl2.h"
 217 That's the sub header file dealing with the SSLv2 protocol only.
 218 \&\fIUsually you don't have to include it explicitly because
 219 it's already included by ssl.h\fR.
 220 .Ip "\fBssl3.h\fR" 4
 221 .IX Item "ssl3.h"
 222 That's the sub header file dealing with the SSLv3 protocol only.
 223 \&\fIUsually you don't have to include it explicitly because
 224 it's already included by ssl.h\fR.
 225 .Ip "\fBssl23.h\fR" 4
 226 .IX Item "ssl23.h"
 227 That's the sub header file dealing with the combined use of the SSLv2 and
 228 SSLv3 protocols.
 229 \&\fIUsually you don't have to include it explicitly because
 230 it's already included by ssl.h\fR.
 231 .Ip "\fBtls1.h\fR" 4
 232 .IX Item "tls1.h"
 233 That's the sub header file dealing with the TLSv1 protocol only.
 234 \&\fIUsually you don't have to include it explicitly because
 235 it's already included by ssl.h\fR.
 236 .SH "API FUNCTIONS"
 237 .IX Header "API FUNCTIONS"
 238 Currently the OpenSSL \fBssl\fR library exports 214 \s-1API\s0 functions.
 239 They are documented in the following:
 240 .Sh "\s-1DEALING\s0 \s-1WITH\s0 \s-1PROTOCOL\s0 \s-1METHODS\s0"
 241 .IX Subsection "DEALING WITH PROTOCOL METHODS"
 242 Here we document the various \s-1API\s0 functions which deal with the \s-1SSL/TLS\s0
 243 protocol methods defined in \fB\s-1SSL_METHOD\s0\fR structures.
 244 .Ip "\s-1SSL_METHOD\s0 *\fBSSLv2_client_method\fR(void);" 4
 245 .IX Item "SSL_METHOD *SSLv2_client_method(void);"
 246 Constructor for the SSLv2 \s-1SSL_METHOD\s0 structure for a dedicated client.
 247 .Ip "\s-1SSL_METHOD\s0 *\fBSSLv2_server_method\fR(void);" 4
 248 .IX Item "SSL_METHOD *SSLv2_server_method(void);"
 249 Constructor for the SSLv2 \s-1SSL_METHOD\s0 structure for a dedicated server.
 250 .Ip "\s-1SSL_METHOD\s0 *\fBSSLv2_method\fR(void);" 4
 251 .IX Item "SSL_METHOD *SSLv2_method(void);"
 252 Constructor for the SSLv2 \s-1SSL_METHOD\s0 structure for combined client and server.
 253 .Ip "\s-1SSL_METHOD\s0 *\fBSSLv3_client_method\fR(void);" 4
 254 .IX Item "SSL_METHOD *SSLv3_client_method(void);"
 255 Constructor for the SSLv3 \s-1SSL_METHOD\s0 structure for a dedicated client.
 256 .Ip "\s-1SSL_METHOD\s0 *\fBSSLv3_server_method\fR(void);" 4
 257 .IX Item "SSL_METHOD *SSLv3_server_method(void);"
 258 Constructor for the SSLv3 \s-1SSL_METHOD\s0 structure for a dedicated server.
 259 .Ip "\s-1SSL_METHOD\s0 *\fBSSLv3_method\fR(void);" 4
 260 .IX Item "SSL_METHOD *SSLv3_method(void);"
 261 Constructor for the SSLv3 \s-1SSL_METHOD\s0 structure for combined client and server.
 262 .Ip "\s-1SSL_METHOD\s0 *\fBTLSv1_client_method\fR(void);" 4
 263 .IX Item "SSL_METHOD *TLSv1_client_method(void);"
 264 Constructor for the TLSv1 \s-1SSL_METHOD\s0 structure for a dedicated client.
 265 .Ip "\s-1SSL_METHOD\s0 *\fBTLSv1_server_method\fR(void);" 4
 266 .IX Item "SSL_METHOD *TLSv1_server_method(void);"
 267 Constructor for the TLSv1 \s-1SSL_METHOD\s0 structure for a dedicated server.
 268 .Ip "\s-1SSL_METHOD\s0 *\fBTLSv1_method\fR(void);" 4
 269 .IX Item "SSL_METHOD *TLSv1_method(void);"
 270 Constructor for the TLSv1 \s-1SSL_METHOD\s0 structure for combined client and server.
 271 .Sh "\s-1DEALING\s0 \s-1WITH\s0 \s-1CIPHERS\s0"
 272 .IX Subsection "DEALING WITH CIPHERS"
 273 Here we document the various \s-1API\s0 functions which deal with the \s-1SSL/TLS\s0
 274 ciphers defined in \fB\s-1SSL_CIPHER\s0\fR structures.
 275 .Ip "char *\fBSSL_CIPHER_description\fR(\s-1SSL_CIPHER\s0 *cipher, char *buf, int len);" 4
 276 .IX Item "char *SSL_CIPHER_description(SSL_CIPHER *cipher, char *buf, int len);"
 277 Write a string to \fIbuf\fR (with a maximum size of \fIlen\fR) containing a human
 278 readable description of \fIcipher\fR. Returns \fIbuf\fR.
 279 .Ip "int \fBSSL_CIPHER_get_bits\fR(\s-1SSL_CIPHER\s0 *cipher, int *alg_bits);" 4
 280 .IX Item "int SSL_CIPHER_get_bits(SSL_CIPHER *cipher, int *alg_bits);"
 281 Determine the number of bits in \fIcipher\fR. Because of export crippled ciphers
 282 there are two bits: The bits the algorithm supports in general (stored to
 283 \&\fIalg_bits\fR) and the bits which are actually used (the return value).
 284 .Ip "const char *\fBSSL_CIPHER_get_name\fR(\s-1SSL_CIPHER\s0 *cipher);" 4
 285 .IX Item "const char *SSL_CIPHER_get_name(SSL_CIPHER *cipher);"
 286 Return the internal name of \fIcipher\fR as a string. These are the various
 287 strings defined by the \fISSL2_TXT_xxx\fR, \fISSL3_TXT_xxx\fR and \fITLS1_TXT_xxx\fR
 288 definitions in the header files.
 289 .Ip "char *\fBSSL_CIPHER_get_version\fR(\s-1SSL_CIPHER\s0 *cipher);" 4
 290 .IX Item "char *SSL_CIPHER_get_version(SSL_CIPHER *cipher);"
 291 Returns a string like "\f(CW\*(C`TLSv1/SSLv3\*(C'\fR\*(L" or \*(R"\f(CW\*(C`SSLv2\*(C'\fR" which indicates the
 292 \&\s-1SSL/TLS\s0 protocol version to which \fIcipher\fR belongs (i.e. where it was defined
 293 in the specification the first time).
 294 .Sh "\s-1DEALING\s0 \s-1WITH\s0 \s-1PROTOCOL\s0 \s-1CONTEXTS\s0"
 295 .IX Subsection "DEALING WITH PROTOCOL CONTEXTS"
 296 Here we document the various \s-1API\s0 functions which deal with the \s-1SSL/TLS\s0
 297 protocol context defined in the \fB\s-1SSL_CTX\s0\fR structure.
 298 .Ip "int \fBSSL_CTX_add_client_CA\fR(\s-1SSL_CTX\s0 *ctx, X509 *x);" 4
 299 .IX Item "int SSL_CTX_add_client_CA(SSL_CTX *ctx, X509 *x);"
 300 .PD 0
 301 .Ip "long \fBSSL_CTX_add_extra_chain_cert\fR(\s-1SSL_CTX\s0 *ctx, X509 *x509);" 4
 302 .IX Item "long SSL_CTX_add_extra_chain_cert(SSL_CTX *ctx, X509 *x509);"
 303 .Ip "int \fBSSL_CTX_add_session\fR(\s-1SSL_CTX\s0 *ctx, \s-1SSL_SESSION\s0 *c);" 4
 304 .IX Item "int SSL_CTX_add_session(SSL_CTX *ctx, SSL_SESSION *c);"
 305 .Ip "int \fBSSL_CTX_check_private_key\fR(\s-1SSL_CTX\s0 *ctx);" 4
 306 .IX Item "int SSL_CTX_check_private_key(SSL_CTX *ctx);"
 307 .Ip "long \fBSSL_CTX_ctrl\fR(\s-1SSL_CTX\s0 *ctx, int cmd, long larg, char *parg);" 4
 308 .IX Item "long SSL_CTX_ctrl(SSL_CTX *ctx, int cmd, long larg, char *parg);"
 309 .Ip "void \fBSSL_CTX_flush_sessions\fR(\s-1SSL_CTX\s0 *s, long t);" 4
 310 .IX Item "void SSL_CTX_flush_sessions(SSL_CTX *s, long t);"
 311 .Ip "void \fBSSL_CTX_free\fR(\s-1SSL_CTX\s0 *a);" 4
 312 .IX Item "void SSL_CTX_free(SSL_CTX *a);"
 313 .Ip "char *\fBSSL_CTX_get_app_data\fR(\s-1SSL_CTX\s0 *ctx);" 4
 314 .IX Item "char *SSL_CTX_get_app_data(SSL_CTX *ctx);"
 315 .Ip "X509_STORE *\fBSSL_CTX_get_cert_store\fR(\s-1SSL_CTX\s0 *ctx);" 4
 316 .IX Item "X509_STORE *SSL_CTX_get_cert_store(SSL_CTX *ctx);"
 317 .Ip "\s-1STACK\s0 *\fBSSL_CTX_get_client_CA_list\fR(\s-1SSL_CTX\s0 *ctx);" 4
 318 .IX Item "STACK *SSL_CTX_get_client_CA_list(SSL_CTX *ctx);"
 319 .Ip "int (*\fBSSL_CTX_get_client_cert_cb\fR(\s-1SSL_CTX\s0 *ctx))(\s-1SSL\s0 *ssl, X509 **x509, \s-1EVP_PKEY\s0 **pkey);" 4
 320 .IX Item "int (*SSL_CTX_get_client_cert_cb(SSL_CTX *ctx))(SSL *ssl, X509 **x509, EVP_PKEY **pkey);"
 321 .Ip "char *\fBSSL_CTX_get_ex_data\fR(\s-1SSL_CTX\s0 *s, int idx);" 4
 322 .IX Item "char *SSL_CTX_get_ex_data(SSL_CTX *s, int idx);"
 323 .Ip "int \fBSSL_CTX_get_ex_new_index\fR(long argl, char *argp, int (*new_func);(void), int (*dup_func)(void), void (*free_func)(void))" 4
 324 .IX Item "int SSL_CTX_get_ex_new_index(long argl, char *argp, int (*new_func);(void), int (*dup_func)(void), void (*free_func)(void))"
 325 .Ip "void (*\fBSSL_CTX_get_info_callback\fR(\s-1SSL_CTX\s0 *ctx))(\s-1SSL\s0 *ssl, int cb, int ret);" 4
 326 .IX Item "void (*SSL_CTX_get_info_callback(SSL_CTX *ctx))(SSL *ssl, int cb, int ret);"
 327 .Ip "int \fBSSL_CTX_get_quiet_shutdown\fR(\s-1SSL_CTX\s0 *ctx);" 4
 328 .IX Item "int SSL_CTX_get_quiet_shutdown(SSL_CTX *ctx);"
 329 .Ip "int \fBSSL_CTX_get_session_cache_mode\fR(\s-1SSL_CTX\s0 *ctx);" 4
 330 .IX Item "int SSL_CTX_get_session_cache_mode(SSL_CTX *ctx);"
 331 .Ip "long \fBSSL_CTX_get_timeout\fR(\s-1SSL_CTX\s0 *ctx);" 4
 332 .IX Item "long SSL_CTX_get_timeout(SSL_CTX *ctx);"
 333 .Ip "int (*\fBSSL_CTX_get_verify_callback\fR(\s-1SSL_CTX\s0 *ctx))(int ok, X509_STORE_CTX *ctx);" 4
 334 .IX Item "int (*SSL_CTX_get_verify_callback(SSL_CTX *ctx))(int ok, X509_STORE_CTX *ctx);"
 335 .Ip "int \fBSSL_CTX_get_verify_mode\fR(\s-1SSL_CTX\s0 *ctx);" 4
 336 .IX Item "int SSL_CTX_get_verify_mode(SSL_CTX *ctx);"
 337 .Ip "int \fBSSL_CTX_load_verify_locations\fR(\s-1SSL_CTX\s0 *ctx, char *CAfile, char *CApath);" 4
 338 .IX Item "int SSL_CTX_load_verify_locations(SSL_CTX *ctx, char *CAfile, char *CApath);"
 339 .Ip "long \fBSSL_CTX_need_tmp_RSA\fR(\s-1SSL_CTX\s0 *ctx);" 4
 340 .IX Item "long SSL_CTX_need_tmp_RSA(SSL_CTX *ctx);"
 341 .Ip "\s-1SSL_CTX\s0 *\fBSSL_CTX_new\fR(\s-1SSL_METHOD\s0 *meth);" 4
 342 .IX Item "SSL_CTX *SSL_CTX_new(SSL_METHOD *meth);"
 343 .Ip "int \fBSSL_CTX_remove_session\fR(\s-1SSL_CTX\s0 *ctx, \s-1SSL_SESSION\s0 *c);" 4
 344 .IX Item "int SSL_CTX_remove_session(SSL_CTX *ctx, SSL_SESSION *c);"
 345 .Ip "int \fBSSL_CTX_sess_accept\fR(\s-1SSL_CTX\s0 *ctx);" 4
 346 .IX Item "int SSL_CTX_sess_accept(SSL_CTX *ctx);"
 347 .Ip "int \fBSSL_CTX_sess_accept_good\fR(\s-1SSL_CTX\s0 *ctx);" 4
 348 .IX Item "int SSL_CTX_sess_accept_good(SSL_CTX *ctx);"
 349 .Ip "int \fBSSL_CTX_sess_accept_renegotiate\fR(\s-1SSL_CTX\s0 *ctx);" 4
 350 .IX Item "int SSL_CTX_sess_accept_renegotiate(SSL_CTX *ctx);"
 351 .Ip "int \fBSSL_CTX_sess_cache_full\fR(\s-1SSL_CTX\s0 *ctx);" 4
 352 .IX Item "int SSL_CTX_sess_cache_full(SSL_CTX *ctx);"
 353 .Ip "int \fBSSL_CTX_sess_cb_hits\fR(\s-1SSL_CTX\s0 *ctx);" 4
 354 .IX Item "int SSL_CTX_sess_cb_hits(SSL_CTX *ctx);"
 355 .Ip "int \fBSSL_CTX_sess_connect\fR(\s-1SSL_CTX\s0 *ctx);" 4
 356 .IX Item "int SSL_CTX_sess_connect(SSL_CTX *ctx);"
 357 .Ip "int \fBSSL_CTX_sess_connect_good\fR(\s-1SSL_CTX\s0 *ctx);" 4
 358 .IX Item "int SSL_CTX_sess_connect_good(SSL_CTX *ctx);"
 359 .Ip "int \fBSSL_CTX_sess_connect_renegotiate\fR(\s-1SSL_CTX\s0 *ctx);" 4
 360 .IX Item "int SSL_CTX_sess_connect_renegotiate(SSL_CTX *ctx);"
 361 .Ip "int \fBSSL_CTX_sess_get_cache_size\fR(\s-1SSL_CTX\s0 *ctx);" 4
 362 .IX Item "int SSL_CTX_sess_get_cache_size(SSL_CTX *ctx);"
 363 .Ip "\s-1SSL_SESSION\s0 *(*\fBSSL_CTX_sess_get_get_cb\fR(\s-1SSL_CTX\s0 *ctx))(\s-1SSL\s0 *ssl, unsigned char *data, int len, int *copy);" 4
 364 .IX Item "SSL_SESSION *(*SSL_CTX_sess_get_get_cb(SSL_CTX *ctx))(SSL *ssl, unsigned char *data, int len, int *copy);"
 365 .Ip "int (*\fBSSL_CTX_sess_get_new_cb\fR(\s-1SSL_CTX\s0 *ctx)(\s-1SSL\s0 *ssl, \s-1SSL_SESSION\s0 *sess);" 4
 366 .IX Item "int (*SSL_CTX_sess_get_new_cb(SSL_CTX *ctx)(SSL *ssl, SSL_SESSION *sess);"
 367 .Ip "void (*\fBSSL_CTX_sess_get_remove_cb\fR(\s-1SSL_CTX\s0 *ctx)(\s-1SSL_CTX\s0 *ctx, \s-1SSL_SESSION\s0 *sess);" 4
 368 .IX Item "void (*SSL_CTX_sess_get_remove_cb(SSL_CTX *ctx)(SSL_CTX *ctx, SSL_SESSION *sess);"
 369 .Ip "int \fBSSL_CTX_sess_hits\fR(\s-1SSL_CTX\s0 *ctx);" 4
 370 .IX Item "int SSL_CTX_sess_hits(SSL_CTX *ctx);"
 371 .Ip "int \fBSSL_CTX_sess_misses\fR(\s-1SSL_CTX\s0 *ctx);" 4
 372 .IX Item "int SSL_CTX_sess_misses(SSL_CTX *ctx);"
 373 .Ip "int \fBSSL_CTX_sess_number\fR(\s-1SSL_CTX\s0 *ctx);" 4
 374 .IX Item "int SSL_CTX_sess_number(SSL_CTX *ctx);"
 375 .Ip "void \fBSSL_CTX_sess_set_cache_size\fR(\s-1SSL_CTX\s0 *ctx,t);" 4
 376 .IX Item "void SSL_CTX_sess_set_cache_size(SSL_CTX *ctx,t);"
 377 .Ip "void \fBSSL_CTX_sess_set_get_cb\fR(\s-1SSL_CTX\s0 *ctx, \s-1SSL_SESSION\s0 *(*cb)(\s-1SSL\s0 *ssl, unsigned char *data, int len, int *copy));" 4
 378 .IX Item "void SSL_CTX_sess_set_get_cb(SSL_CTX *ctx, SSL_SESSION *(*cb)(SSL *ssl, unsigned char *data, int len, int *copy));"
 379 .Ip "void \fBSSL_CTX_sess_set_new_cb\fR(\s-1SSL_CTX\s0 *ctx, int (*cb)(\s-1SSL\s0 *ssl, \s-1SSL_SESSION\s0 *sess));" 4
 380 .IX Item "void SSL_CTX_sess_set_new_cb(SSL_CTX *ctx, int (*cb)(SSL *ssl, SSL_SESSION *sess));"
 381 .Ip "void \fBSSL_CTX_sess_set_remove_cb\fR(\s-1SSL_CTX\s0 *ctx, void (*cb)(\s-1SSL_CTX\s0 *ctx, \s-1SSL_SESSION\s0 *sess));" 4
 382 .IX Item "void SSL_CTX_sess_set_remove_cb(SSL_CTX *ctx, void (*cb)(SSL_CTX *ctx, SSL_SESSION *sess));"
 383 .Ip "int \fBSSL_CTX_sess_timeouts\fR(\s-1SSL_CTX\s0 *ctx);" 4
 384 .IX Item "int SSL_CTX_sess_timeouts(SSL_CTX *ctx);"
 385 .Ip "\s-1LHASH\s0 *\fBSSL_CTX_sessions\fR(\s-1SSL_CTX\s0 *ctx);" 4
 386 .IX Item "LHASH *SSL_CTX_sessions(SSL_CTX *ctx);"
 387 .Ip "void \fBSSL_CTX_set_app_data\fR(\s-1SSL_CTX\s0 *ctx, void *arg);" 4
 388 .IX Item "void SSL_CTX_set_app_data(SSL_CTX *ctx, void *arg);"
 389 .Ip "void \fBSSL_CTX_set_cert_store\fR(\s-1SSL_CTX\s0 *ctx, X509_STORE *cs);" 4
 390 .IX Item "void SSL_CTX_set_cert_store(SSL_CTX *ctx, X509_STORE *cs);"
 391 .Ip "void \fBSSL_CTX_set_cert_verify_cb\fR(\s-1SSL_CTX\s0 *ctx, int (*cb)(), char *arg)" 4
 392 .IX Item "void SSL_CTX_set_cert_verify_cb(SSL_CTX *ctx, int (*cb)(), char *arg)"
 393 .Ip "int \fBSSL_CTX_set_cipher_list\fR(\s-1SSL_CTX\s0 *ctx, char *str);" 4
 394 .IX Item "int SSL_CTX_set_cipher_list(SSL_CTX *ctx, char *str);"
 395 .Ip "void \fBSSL_CTX_set_client_CA_list\fR(\s-1SSL_CTX\s0 *ctx, \s-1STACK\s0 *list);" 4
 396 .IX Item "void SSL_CTX_set_client_CA_list(SSL_CTX *ctx, STACK *list);"
 397 .Ip "void \fBSSL_CTX_set_client_cert_cb\fR(\s-1SSL_CTX\s0 *ctx, int (*cb)(\s-1SSL\s0 *ssl, X509 **x509, \s-1EVP_PKEY\s0 **pkey));" 4
 398 .IX Item "void SSL_CTX_set_client_cert_cb(SSL_CTX *ctx, int (*cb)(SSL *ssl, X509 **x509, EVP_PKEY **pkey));"
 399 .Ip "void \fBSSL_CTX_set_default_passwd_cb\fR(\s-1SSL_CTX\s0 *ctx, int (*cb);(void))" 4
 400 .IX Item "void SSL_CTX_set_default_passwd_cb(SSL_CTX *ctx, int (*cb);(void))"
 401 .Ip "void \fBSSL_CTX_set_default_read_ahead\fR(\s-1SSL_CTX\s0 *ctx, int m);" 4
 402 .IX Item "void SSL_CTX_set_default_read_ahead(SSL_CTX *ctx, int m);"
 403 .Ip "int \fBSSL_CTX_set_default_verify_paths\fR(\s-1SSL_CTX\s0 *ctx);" 4
 404 .IX Item "int SSL_CTX_set_default_verify_paths(SSL_CTX *ctx);"
 405 .Ip "int \fBSSL_CTX_set_ex_data\fR(\s-1SSL_CTX\s0 *s, int idx, char *arg);" 4
 406 .IX Item "int SSL_CTX_set_ex_data(SSL_CTX *s, int idx, char *arg);"
 407 .Ip "void \fBSSL_CTX_set_info_callback\fR(\s-1SSL_CTX\s0 *ctx, void (*cb)(\s-1SSL\s0 *ssl, int cb, int ret));" 4
 408 .IX Item "void SSL_CTX_set_info_callback(SSL_CTX *ctx, void (*cb)(SSL *ssl, int cb, int ret));"
 409 .Ip "void \fBSSL_CTX_set_msg_callback\fR(\s-1SSL_CTX\s0 *ctx, void (*cb)(int write_p, int version, int content_type, const void *buf, size_t len, \s-1SSL\s0 *ssl, void *arg));" 4
 410 .IX Item "void SSL_CTX_set_msg_callback(SSL_CTX *ctx, void (*cb)(int write_p, int version, int content_type, const void *buf, size_t len, SSL *ssl, void *arg));"
 411 .Ip "void \fBSSL_CTX_set_msg_callback_arg\fR(\s-1SSL_CTX\s0 *ctx, void *arg);" 4
 412 .IX Item "void SSL_CTX_set_msg_callback_arg(SSL_CTX *ctx, void *arg);"
 413 .Ip "void \fBSSL_CTX_set_options\fR(\s-1SSL_CTX\s0 *ctx, unsigned long op);" 4
 414 .IX Item "void SSL_CTX_set_options(SSL_CTX *ctx, unsigned long op);"
 415 .Ip "void \fBSSL_CTX_set_quiet_shutdown\fR(\s-1SSL_CTX\s0 *ctx, int mode);" 4
 416 .IX Item "void SSL_CTX_set_quiet_shutdown(SSL_CTX *ctx, int mode);"
 417 .Ip "void \fBSSL_CTX_set_session_cache_mode\fR(\s-1SSL_CTX\s0 *ctx, int mode);" 4
 418 .IX Item "void SSL_CTX_set_session_cache_mode(SSL_CTX *ctx, int mode);"
 419 .Ip "int \fBSSL_CTX_set_ssl_version\fR(\s-1SSL_CTX\s0 *ctx, \s-1SSL_METHOD\s0 *meth);" 4
 420 .IX Item "int SSL_CTX_set_ssl_version(SSL_CTX *ctx, SSL_METHOD *meth);"
 421 .Ip "void \fBSSL_CTX_set_timeout\fR(\s-1SSL_CTX\s0 *ctx, long t);" 4
 422 .IX Item "void SSL_CTX_set_timeout(SSL_CTX *ctx, long t);"
 423 .Ip "long \fBSSL_CTX_set_tmp_dh\fR(SSL_CTX* ctx, \s-1DH\s0 *dh);" 4
 424 .IX Item "long SSL_CTX_set_tmp_dh(SSL_CTX* ctx, DH *dh);"
 425 .Ip "long \fBSSL_CTX_set_tmp_dh_callback\fR(\s-1SSL_CTX\s0 *ctx, \s-1DH\s0 *(*cb)(void));" 4
 426 .IX Item "long SSL_CTX_set_tmp_dh_callback(SSL_CTX *ctx, DH *(*cb)(void));"
 427 .Ip "long \fBSSL_CTX_set_tmp_rsa\fR(\s-1SSL_CTX\s0 *ctx, \s-1RSA\s0 *rsa);" 4
 428 .IX Item "long SSL_CTX_set_tmp_rsa(SSL_CTX *ctx, RSA *rsa);"
 429 .Ip "SSL_CTX_set_tmp_rsa_callback" 4
 430 .IX Item "SSL_CTX_set_tmp_rsa_callback"
 431 .PD
 432 \&\f(CW\*(C`long \f(CBSSL_CTX_set_tmp_rsa_callback\f(CW(SSL_CTX *\f(CBctx\f(CW, RSA *(*\f(CBcb\f(CW)(SSL *\f(CBssl\f(CW, int \f(CBexport\f(CW, int \f(CBkeylength\f(CW));\*(C'\fR
 433 .Sp
 434 Sets the callback which will be called when a temporary private key is
 435 required. The \fB\f(CB\*(C`export\*(C'\fB\fR flag will be set if the reason for needing
 436 a temp key is that an export ciphersuite is in use, in which case,
 437 \&\fB\f(CB\*(C`keylength\*(C'\fB\fR will contain the required keylength in bits. Generate a key of
 438 appropriate size (using ???) and return it.
 439 .Ip "SSL_set_tmp_rsa_callback" 4
 440 .IX Item "SSL_set_tmp_rsa_callback"
 441 long \fBSSL_set_tmp_rsa_callback\fR(\s-1SSL\s0 *ssl, \s-1RSA\s0 *(*cb)(\s-1SSL\s0 *ssl, int export, int keylength));
 442 .Sp
 443 The same as \fBSSL_CTX_set_tmp_rsa_callback\fR, except it operates on an \s-1SSL\s0
 444 session instead of a context.
 445 .Ip "void \fBSSL_CTX_set_verify\fR(\s-1SSL_CTX\s0 *ctx, int mode, int (*cb);(void))" 4
 446 .IX Item "void SSL_CTX_set_verify(SSL_CTX *ctx, int mode, int (*cb);(void))"
 447 .PD 0
 448 .Ip "int \fBSSL_CTX_use_PrivateKey\fR(\s-1SSL_CTX\s0 *ctx, \s-1EVP_PKEY\s0 *pkey);" 4
 449 .IX Item "int SSL_CTX_use_PrivateKey(SSL_CTX *ctx, EVP_PKEY *pkey);"
 450 .Ip "int \fBSSL_CTX_use_PrivateKey_ASN1\fR(int type, \s-1SSL_CTX\s0 *ctx, unsigned char *d, long len);" 4
 451 .IX Item "int SSL_CTX_use_PrivateKey_ASN1(int type, SSL_CTX *ctx, unsigned char *d, long len);"
 452 .Ip "int \fBSSL_CTX_use_PrivateKey_file\fR(\s-1SSL_CTX\s0 *ctx, char *file, int type);" 4
 453 .IX Item "int SSL_CTX_use_PrivateKey_file(SSL_CTX *ctx, char *file, int type);"
 454 .Ip "int \fBSSL_CTX_use_RSAPrivateKey\fR(\s-1SSL_CTX\s0 *ctx, \s-1RSA\s0 *rsa);" 4
 455 .IX Item "int SSL_CTX_use_RSAPrivateKey(SSL_CTX *ctx, RSA *rsa);"
 456 .Ip "int \fBSSL_CTX_use_RSAPrivateKey_ASN1\fR(\s-1SSL_CTX\s0 *ctx, unsigned char *d, long len);" 4
 457 .IX Item "int SSL_CTX_use_RSAPrivateKey_ASN1(SSL_CTX *ctx, unsigned char *d, long len);"
 458 .Ip "int \fBSSL_CTX_use_RSAPrivateKey_file\fR(\s-1SSL_CTX\s0 *ctx, char *file, int type);" 4
 459 .IX Item "int SSL_CTX_use_RSAPrivateKey_file(SSL_CTX *ctx, char *file, int type);"
 460 .Ip "int \fBSSL_CTX_use_certificate\fR(\s-1SSL_CTX\s0 *ctx, X509 *x);" 4
 461 .IX Item "int SSL_CTX_use_certificate(SSL_CTX *ctx, X509 *x);"
 462 .Ip "int \fBSSL_CTX_use_certificate_ASN1\fR(\s-1SSL_CTX\s0 *ctx, int len, unsigned char *d);" 4
 463 .IX Item "int SSL_CTX_use_certificate_ASN1(SSL_CTX *ctx, int len, unsigned char *d);"
 464 .Ip "int \fBSSL_CTX_use_certificate_file\fR(\s-1SSL_CTX\s0 *ctx, char *file, int type);" 4
 465 .IX Item "int SSL_CTX_use_certificate_file(SSL_CTX *ctx, char *file, int type);"
 466 .PD
 467 .Sh "\s-1DEALING\s0 \s-1WITH\s0 \s-1SESSIONS\s0"
 468 .IX Subsection "DEALING WITH SESSIONS"
 469 Here we document the various \s-1API\s0 functions which deal with the \s-1SSL/TLS\s0
 470 sessions defined in the \fB\s-1SSL_SESSION\s0\fR structures.
 471 .Ip "int \fBSSL_SESSION_cmp\fR(\s-1SSL_SESSION\s0 *a, \s-1SSL_SESSION\s0 *b);" 4
 472 .IX Item "int SSL_SESSION_cmp(SSL_SESSION *a, SSL_SESSION *b);"
 473 .PD 0
 474 .Ip "void \fBSSL_SESSION_free\fR(\s-1SSL_SESSION\s0 *ss);" 4
 475 .IX Item "void SSL_SESSION_free(SSL_SESSION *ss);"
 476 .Ip "char *\fBSSL_SESSION_get_app_data\fR(\s-1SSL_SESSION\s0 *s);" 4
 477 .IX Item "char *SSL_SESSION_get_app_data(SSL_SESSION *s);"
 478 .Ip "char *\fBSSL_SESSION_get_ex_data\fR(\s-1SSL_SESSION\s0 *s, int idx);" 4
 479 .IX Item "char *SSL_SESSION_get_ex_data(SSL_SESSION *s, int idx);"
 480 .Ip "int \fBSSL_SESSION_get_ex_new_index\fR(long argl, char *argp, int (*new_func);(void), int (*dup_func)(void), void (*free_func)(void))" 4
 481 .IX Item "int SSL_SESSION_get_ex_new_index(long argl, char *argp, int (*new_func);(void), int (*dup_func)(void), void (*free_func)(void))"
 482 .Ip "long \fBSSL_SESSION_get_time\fR(\s-1SSL_SESSION\s0 *s);" 4
 483 .IX Item "long SSL_SESSION_get_time(SSL_SESSION *s);"
 484 .Ip "long \fBSSL_SESSION_get_timeout\fR(\s-1SSL_SESSION\s0 *s);" 4
 485 .IX Item "long SSL_SESSION_get_timeout(SSL_SESSION *s);"
 486 .Ip "unsigned long \fBSSL_SESSION_hash\fR(\s-1SSL_SESSION\s0 *a);" 4
 487 .IX Item "unsigned long SSL_SESSION_hash(SSL_SESSION *a);"
 488 .Ip "\s-1SSL_SESSION\s0 *\fBSSL_SESSION_new\fR(void);" 4
 489 .IX Item "SSL_SESSION *SSL_SESSION_new(void);"
 490 .Ip "int \fBSSL_SESSION_print\fR(\s-1BIO\s0 *bp, \s-1SSL_SESSION\s0 *x);" 4
 491 .IX Item "int SSL_SESSION_print(BIO *bp, SSL_SESSION *x);"
 492 .Ip "int \fBSSL_SESSION_print_fp\fR(\s-1FILE\s0 *fp, \s-1SSL_SESSION\s0 *x);" 4
 493 .IX Item "int SSL_SESSION_print_fp(FILE *fp, SSL_SESSION *x);"
 494 .Ip "void \fBSSL_SESSION_set_app_data\fR(\s-1SSL_SESSION\s0 *s, char *a);" 4
 495 .IX Item "void SSL_SESSION_set_app_data(SSL_SESSION *s, char *a);"
 496 .Ip "int \fBSSL_SESSION_set_ex_data\fR(\s-1SSL_SESSION\s0 *s, int idx, char *arg);" 4
 497 .IX Item "int SSL_SESSION_set_ex_data(SSL_SESSION *s, int idx, char *arg);"
 498 .Ip "long \fBSSL_SESSION_set_time\fR(\s-1SSL_SESSION\s0 *s, long t);" 4
 499 .IX Item "long SSL_SESSION_set_time(SSL_SESSION *s, long t);"
 500 .Ip "long \fBSSL_SESSION_set_timeout\fR(\s-1SSL_SESSION\s0 *s, long t);" 4
 501 .IX Item "long SSL_SESSION_set_timeout(SSL_SESSION *s, long t);"
 502 .PD
 503 .Sh "\s-1DEALING\s0 \s-1WITH\s0 \s-1CONNECTIONS\s0"
 504 .IX Subsection "DEALING WITH CONNECTIONS"
 505 Here we document the various \s-1API\s0 functions which deal with the \s-1SSL/TLS\s0
 506 connection defined in the \fB\s-1SSL\s0\fR structure.
 507 .Ip "int \fBSSL_accept\fR(\s-1SSL\s0 *ssl);" 4
 508 .IX Item "int SSL_accept(SSL *ssl);"
 509 .PD 0
 510 .Ip "int \fBSSL_add_dir_cert_subjects_to_stack\fR(\s-1STACK\s0 *stack, const char *dir);" 4
 511 .IX Item "int SSL_add_dir_cert_subjects_to_stack(STACK *stack, const char *dir);"
 512 .Ip "int \fBSSL_add_file_cert_subjects_to_stack\fR(\s-1STACK\s0 *stack, const char *file);" 4
 513 .IX Item "int SSL_add_file_cert_subjects_to_stack(STACK *stack, const char *file);"
 514 .Ip "int \fBSSL_add_client_CA\fR(\s-1SSL\s0 *ssl, X509 *x);" 4
 515 .IX Item "int SSL_add_client_CA(SSL *ssl, X509 *x);"
 516 .Ip "char *\fBSSL_alert_desc_string\fR(int value);" 4
 517 .IX Item "char *SSL_alert_desc_string(int value);"
 518 .Ip "char *\fBSSL_alert_desc_string_long\fR(int value);" 4
 519 .IX Item "char *SSL_alert_desc_string_long(int value);"
 520 .Ip "char *\fBSSL_alert_type_string\fR(int value);" 4
 521 .IX Item "char *SSL_alert_type_string(int value);"
 522 .Ip "char *\fBSSL_alert_type_string_long\fR(int value);" 4
 523 .IX Item "char *SSL_alert_type_string_long(int value);"
 524 .Ip "int \fBSSL_check_private_key\fR(\s-1SSL\s0 *ssl);" 4
 525 .IX Item "int SSL_check_private_key(SSL *ssl);"
 526 .Ip "void \fBSSL_clear\fR(\s-1SSL\s0 *ssl);" 4
 527 .IX Item "void SSL_clear(SSL *ssl);"
 528 .Ip "long \fBSSL_clear_num_renegotiations\fR(\s-1SSL\s0 *ssl);" 4
 529 .IX Item "long SSL_clear_num_renegotiations(SSL *ssl);"
 530 .Ip "int \fBSSL_connect\fR(\s-1SSL\s0 *ssl);" 4
 531 .IX Item "int SSL_connect(SSL *ssl);"
 532 .Ip "void \fBSSL_copy_session_id\fR(\s-1SSL\s0 *t, \s-1SSL\s0 *f);" 4
 533 .IX Item "void SSL_copy_session_id(SSL *t, SSL *f);"
 534 .Ip "long \fBSSL_ctrl\fR(\s-1SSL\s0 *ssl, int cmd, long larg, char *parg);" 4
 535 .IX Item "long SSL_ctrl(SSL *ssl, int cmd, long larg, char *parg);"
 536 .Ip "int \fBSSL_do_handshake\fR(\s-1SSL\s0 *ssl);" 4
 537 .IX Item "int SSL_do_handshake(SSL *ssl);"
 538 .Ip "\s-1SSL\s0 *\fBSSL_dup\fR(\s-1SSL\s0 *ssl);" 4
 539 .IX Item "SSL *SSL_dup(SSL *ssl);"
 540 .Ip "\s-1STACK\s0 *\fBSSL_dup_CA_list\fR(\s-1STACK\s0 *sk);" 4
 541 .IX Item "STACK *SSL_dup_CA_list(STACK *sk);"
 542 .Ip "void \fBSSL_free\fR(\s-1SSL\s0 *ssl);" 4
 543 .IX Item "void SSL_free(SSL *ssl);"
 544 .Ip "\s-1SSL_CTX\s0 *\fBSSL_get_SSL_CTX\fR(\s-1SSL\s0 *ssl);" 4
 545 .IX Item "SSL_CTX *SSL_get_SSL_CTX(SSL *ssl);"
 546 .Ip "char *\fBSSL_get_app_data\fR(\s-1SSL\s0 *ssl);" 4
 547 .IX Item "char *SSL_get_app_data(SSL *ssl);"
 548 .Ip "X509 *\fBSSL_get_certificate\fR(\s-1SSL\s0 *ssl);" 4
 549 .IX Item "X509 *SSL_get_certificate(SSL *ssl);"
 550 .Ip "const char *\fBSSL_get_cipher\fR(\s-1SSL\s0 *ssl);" 4
 551 .IX Item "const char *SSL_get_cipher(SSL *ssl);"
 552 .Ip "int \fBSSL_get_cipher_bits\fR(\s-1SSL\s0 *ssl, int *alg_bits);" 4
 553 .IX Item "int SSL_get_cipher_bits(SSL *ssl, int *alg_bits);"
 554 .Ip "char *\fBSSL_get_cipher_list\fR(\s-1SSL\s0 *ssl, int n);" 4
 555 .IX Item "char *SSL_get_cipher_list(SSL *ssl, int n);"
 556 .Ip "char *\fBSSL_get_cipher_name\fR(\s-1SSL\s0 *ssl);" 4
 557 .IX Item "char *SSL_get_cipher_name(SSL *ssl);"
 558 .Ip "char *\fBSSL_get_cipher_version\fR(\s-1SSL\s0 *ssl);" 4
 559 .IX Item "char *SSL_get_cipher_version(SSL *ssl);"
 560 .Ip "\s-1STACK\s0 *\fBSSL_get_ciphers\fR(\s-1SSL\s0 *ssl);" 4
 561 .IX Item "STACK *SSL_get_ciphers(SSL *ssl);"
 562 .Ip "\s-1STACK\s0 *\fBSSL_get_client_CA_list\fR(\s-1SSL\s0 *ssl);" 4
 563 .IX Item "STACK *SSL_get_client_CA_list(SSL *ssl);"
 564 .Ip "\s-1SSL_CIPHER\s0 *\fBSSL_get_current_cipher\fR(\s-1SSL\s0 *ssl);" 4
 565 .IX Item "SSL_CIPHER *SSL_get_current_cipher(SSL *ssl);"
 566 .Ip "long \fBSSL_get_default_timeout\fR(\s-1SSL\s0 *ssl);" 4
 567 .IX Item "long SSL_get_default_timeout(SSL *ssl);"
 568 .Ip "int \fBSSL_get_error\fR(\s-1SSL\s0 *ssl, int i);" 4
 569 .IX Item "int SSL_get_error(SSL *ssl, int i);"
 570 .Ip "char *\fBSSL_get_ex_data\fR(\s-1SSL\s0 *ssl, int idx);" 4
 571 .IX Item "char *SSL_get_ex_data(SSL *ssl, int idx);"
 572 .Ip "int \fBSSL_get_ex_data_X509_STORE_CTX_idx\fR(void);" 4
 573 .IX Item "int SSL_get_ex_data_X509_STORE_CTX_idx(void);"
 574 .Ip "int \fBSSL_get_ex_new_index\fR(long argl, char *argp, int (*new_func);(void), int (*dup_func)(void), void (*free_func)(void))" 4
 575 .IX Item "int SSL_get_ex_new_index(long argl, char *argp, int (*new_func);(void), int (*dup_func)(void), void (*free_func)(void))"
 576 .Ip "int \fBSSL_get_fd\fR(\s-1SSL\s0 *ssl);" 4
 577 .IX Item "int SSL_get_fd(SSL *ssl);"
 578 .Ip "void (*\fBSSL_get_info_callback\fR(\s-1SSL\s0 *ssl);)(void)" 4
 579 .IX Item "void (*SSL_get_info_callback(SSL *ssl);)(void)"
 580 .Ip "\s-1STACK\s0 *\fBSSL_get_peer_cert_chain\fR(\s-1SSL\s0 *ssl);" 4
 581 .IX Item "STACK *SSL_get_peer_cert_chain(SSL *ssl);"
 582 .Ip "X509 *\fBSSL_get_peer_certificate\fR(\s-1SSL\s0 *ssl);" 4
 583 .IX Item "X509 *SSL_get_peer_certificate(SSL *ssl);"
 584 .Ip "\s-1EVP_PKEY\s0 *\fBSSL_get_privatekey\fR(\s-1SSL\s0 *ssl);" 4
 585 .IX Item "EVP_PKEY *SSL_get_privatekey(SSL *ssl);"
 586 .Ip "int \fBSSL_get_quiet_shutdown\fR(\s-1SSL\s0 *ssl);" 4
 587 .IX Item "int SSL_get_quiet_shutdown(SSL *ssl);"
 588 .Ip "\s-1BIO\s0 *\fBSSL_get_rbio\fR(\s-1SSL\s0 *ssl);" 4
 589 .IX Item "BIO *SSL_get_rbio(SSL *ssl);"
 590 .Ip "int \fBSSL_get_read_ahead\fR(\s-1SSL\s0 *ssl);" 4
 591 .IX Item "int SSL_get_read_ahead(SSL *ssl);"
 592 .Ip "\s-1SSL_SESSION\s0 *\fBSSL_get_session\fR(\s-1SSL\s0 *ssl);" 4
 593 .IX Item "SSL_SESSION *SSL_get_session(SSL *ssl);"
 594 .Ip "char *\fBSSL_get_shared_ciphers\fR(\s-1SSL\s0 *ssl, char *buf, int len);" 4
 595 .IX Item "char *SSL_get_shared_ciphers(SSL *ssl, char *buf, int len);"
 596 .Ip "int \fBSSL_get_shutdown\fR(\s-1SSL\s0 *ssl);" 4
 597 .IX Item "int SSL_get_shutdown(SSL *ssl);"
 598 .Ip "\s-1SSL_METHOD\s0 *\fBSSL_get_ssl_method\fR(\s-1SSL\s0 *ssl);" 4
 599 .IX Item "SSL_METHOD *SSL_get_ssl_method(SSL *ssl);"
 600 .Ip "int \fBSSL_get_state\fR(\s-1SSL\s0 *ssl);" 4
 601 .IX Item "int SSL_get_state(SSL *ssl);"
 602 .Ip "long \fBSSL_get_time\fR(\s-1SSL\s0 *ssl);" 4
 603 .IX Item "long SSL_get_time(SSL *ssl);"
 604 .Ip "long \fBSSL_get_timeout\fR(\s-1SSL\s0 *ssl);" 4
 605 .IX Item "long SSL_get_timeout(SSL *ssl);"
 606 .Ip "int (*\fBSSL_get_verify_callback\fR(\s-1SSL\s0 *ssl);)(void)" 4
 607 .IX Item "int (*SSL_get_verify_callback(SSL *ssl);)(void)"
 608 .Ip "int \fBSSL_get_verify_mode\fR(\s-1SSL\s0 *ssl);" 4
 609 .IX Item "int SSL_get_verify_mode(SSL *ssl);"
 610 .Ip "long \fBSSL_get_verify_result\fR(\s-1SSL\s0 *ssl);" 4
 611 .IX Item "long SSL_get_verify_result(SSL *ssl);"
 612 .Ip "char *\fBSSL_get_version\fR(\s-1SSL\s0 *ssl);" 4
 613 .IX Item "char *SSL_get_version(SSL *ssl);"
 614 .Ip "\s-1BIO\s0 *\fBSSL_get_wbio\fR(\s-1SSL\s0 *ssl);" 4
 615 .IX Item "BIO *SSL_get_wbio(SSL *ssl);"
 616 .Ip "int \fBSSL_in_accept_init\fR(\s-1SSL\s0 *ssl);" 4
 617 .IX Item "int SSL_in_accept_init(SSL *ssl);"
 618 .Ip "int \fBSSL_in_before\fR(\s-1SSL\s0 *ssl);" 4
 619 .IX Item "int SSL_in_before(SSL *ssl);"
 620 .Ip "int \fBSSL_in_connect_init\fR(\s-1SSL\s0 *ssl);" 4
 621 .IX Item "int SSL_in_connect_init(SSL *ssl);"
 622 .Ip "int \fBSSL_in_init\fR(\s-1SSL\s0 *ssl);" 4
 623 .IX Item "int SSL_in_init(SSL *ssl);"
 624 .Ip "int \fBSSL_is_init_finished\fR(\s-1SSL\s0 *ssl);" 4
 625 .IX Item "int SSL_is_init_finished(SSL *ssl);"
 626 .Ip "\s-1STACK\s0 *\fBSSL_load_client_CA_file\fR(char *file);" 4
 627 .IX Item "STACK *SSL_load_client_CA_file(char *file);"
 628 .Ip "void \fBSSL_load_error_strings\fR(void);" 4
 629 .IX Item "void SSL_load_error_strings(void);"
 630 .Ip "\s-1SSL\s0 *\fBSSL_new\fR(\s-1SSL_CTX\s0 *ctx);" 4
 631 .IX Item "SSL *SSL_new(SSL_CTX *ctx);"
 632 .Ip "long \fBSSL_num_renegotiations\fR(\s-1SSL\s0 *ssl);" 4
 633 .IX Item "long SSL_num_renegotiations(SSL *ssl);"
 634 .Ip "int \fBSSL_peek\fR(\s-1SSL\s0 *ssl, void *buf, int num);" 4
 635 .IX Item "int SSL_peek(SSL *ssl, void *buf, int num);"
 636 .Ip "int \fBSSL_pending\fR(\s-1SSL\s0 *ssl);" 4
 637 .IX Item "int SSL_pending(SSL *ssl);"
 638 .Ip "int \fBSSL_read\fR(\s-1SSL\s0 *ssl, void *buf, int num);" 4
 639 .IX Item "int SSL_read(SSL *ssl, void *buf, int num);"
 640 .Ip "int \fBSSL_renegotiate\fR(\s-1SSL\s0 *ssl);" 4
 641 .IX Item "int SSL_renegotiate(SSL *ssl);"
 642 .Ip "char *\fBSSL_rstate_string\fR(\s-1SSL\s0 *ssl);" 4
 643 .IX Item "char *SSL_rstate_string(SSL *ssl);"
 644 .Ip "char *\fBSSL_rstate_string_long\fR(\s-1SSL\s0 *ssl);" 4
 645 .IX Item "char *SSL_rstate_string_long(SSL *ssl);"
 646 .Ip "long \fBSSL_session_reused\fR(\s-1SSL\s0 *ssl);" 4
 647 .IX Item "long SSL_session_reused(SSL *ssl);"
 648 .Ip "void \fBSSL_set_accept_state\fR(\s-1SSL\s0 *ssl);" 4
 649 .IX Item "void SSL_set_accept_state(SSL *ssl);"
 650 .Ip "void \fBSSL_set_app_data\fR(\s-1SSL\s0 *ssl, char *arg);" 4
 651 .IX Item "void SSL_set_app_data(SSL *ssl, char *arg);"
 652 .Ip "void \fBSSL_set_bio\fR(\s-1SSL\s0 *ssl, \s-1BIO\s0 *rbio, \s-1BIO\s0 *wbio);" 4
 653 .IX Item "void SSL_set_bio(SSL *ssl, BIO *rbio, BIO *wbio);"
 654 .Ip "int \fBSSL_set_cipher_list\fR(\s-1SSL\s0 *ssl, char *str);" 4
 655 .IX Item "int SSL_set_cipher_list(SSL *ssl, char *str);"
 656 .Ip "void \fBSSL_set_client_CA_list\fR(\s-1SSL\s0 *ssl, \s-1STACK\s0 *list);" 4
 657 .IX Item "void SSL_set_client_CA_list(SSL *ssl, STACK *list);"
 658 .Ip "void \fBSSL_set_connect_state\fR(\s-1SSL\s0 *ssl);" 4
 659 .IX Item "void SSL_set_connect_state(SSL *ssl);"
 660 .Ip "int \fBSSL_set_ex_data\fR(\s-1SSL\s0 *ssl, int idx, char *arg);" 4
 661 .IX Item "int SSL_set_ex_data(SSL *ssl, int idx, char *arg);"
 662 .Ip "int \fBSSL_set_fd\fR(\s-1SSL\s0 *ssl, int fd);" 4
 663 .IX Item "int SSL_set_fd(SSL *ssl, int fd);"
 664 .Ip "void \fBSSL_set_info_callback\fR(\s-1SSL\s0 *ssl, void (*cb);(void))" 4
 665 .IX Item "void SSL_set_info_callback(SSL *ssl, void (*cb);(void))"
 666 .Ip "void \fBSSL_set_msg_callback\fR(\s-1SSL\s0 *ctx, void (*cb)(int write_p, int version, int content_type, const void *buf, size_t len, \s-1SSL\s0 *ssl, void *arg));" 4
 667 .IX Item "void SSL_set_msg_callback(SSL *ctx, void (*cb)(int write_p, int version, int content_type, const void *buf, size_t len, SSL *ssl, void *arg));"
 668 .Ip "void \fBSSL_set_msg_callback_arg\fR(\s-1SSL\s0 *ctx, void *arg);" 4
 669 .IX Item "void SSL_set_msg_callback_arg(SSL *ctx, void *arg);"
 670 .Ip "void \fBSSL_set_options\fR(\s-1SSL\s0 *ssl, unsigned long op);" 4
 671 .IX Item "void SSL_set_options(SSL *ssl, unsigned long op);"
 672 .Ip "void \fBSSL_set_quiet_shutdown\fR(\s-1SSL\s0 *ssl, int mode);" 4
 673 .IX Item "void SSL_set_quiet_shutdown(SSL *ssl, int mode);"
 674 .Ip "void \fBSSL_set_read_ahead\fR(\s-1SSL\s0 *ssl, int yes);" 4
 675 .IX Item "void SSL_set_read_ahead(SSL *ssl, int yes);"
 676 .Ip "int \fBSSL_set_rfd\fR(\s-1SSL\s0 *ssl, int fd);" 4
 677 .IX Item "int SSL_set_rfd(SSL *ssl, int fd);"
 678 .Ip "int \fBSSL_set_session\fR(\s-1SSL\s0 *ssl, \s-1SSL_SESSION\s0 *session);" 4
 679 .IX Item "int SSL_set_session(SSL *ssl, SSL_SESSION *session);"
 680 .Ip "void \fBSSL_set_shutdown\fR(\s-1SSL\s0 *ssl, int mode);" 4
 681 .IX Item "void SSL_set_shutdown(SSL *ssl, int mode);"
 682 .Ip "int \fBSSL_set_ssl_method\fR(\s-1SSL\s0 *ssl, \s-1SSL_METHOD\s0 *meth);" 4
 683 .IX Item "int SSL_set_ssl_method(SSL *ssl, SSL_METHOD *meth);"
 684 .Ip "void \fBSSL_set_time\fR(\s-1SSL\s0 *ssl, long t);" 4
 685 .IX Item "void SSL_set_time(SSL *ssl, long t);"
 686 .Ip "void \fBSSL_set_timeout\fR(\s-1SSL\s0 *ssl, long t);" 4
 687 .IX Item "void SSL_set_timeout(SSL *ssl, long t);"
 688 .Ip "void \fBSSL_set_verify\fR(\s-1SSL\s0 *ssl, int mode, int (*callback);(void))" 4
 689 .IX Item "void SSL_set_verify(SSL *ssl, int mode, int (*callback);(void))"
 690 .Ip "void \fBSSL_set_verify_result\fR(\s-1SSL\s0 *ssl, long arg);" 4
 691 .IX Item "void SSL_set_verify_result(SSL *ssl, long arg);"
 692 .Ip "int \fBSSL_set_wfd\fR(\s-1SSL\s0 *ssl, int fd);" 4
 693 .IX Item "int SSL_set_wfd(SSL *ssl, int fd);"
 694 .Ip "int \fBSSL_shutdown\fR(\s-1SSL\s0 *ssl);" 4
 695 .IX Item "int SSL_shutdown(SSL *ssl);"
 696 .Ip "int \fBSSL_state\fR(\s-1SSL\s0 *ssl);" 4
 697 .IX Item "int SSL_state(SSL *ssl);"
 698 .Ip "char *\fBSSL_state_string\fR(\s-1SSL\s0 *ssl);" 4
 699 .IX Item "char *SSL_state_string(SSL *ssl);"
 700 .Ip "char *\fBSSL_state_string_long\fR(\s-1SSL\s0 *ssl);" 4
 701 .IX Item "char *SSL_state_string_long(SSL *ssl);"
 702 .Ip "long \fBSSL_total_renegotiations\fR(\s-1SSL\s0 *ssl);" 4
 703 .IX Item "long SSL_total_renegotiations(SSL *ssl);"
 704 .Ip "int \fBSSL_use_PrivateKey\fR(\s-1SSL\s0 *ssl, \s-1EVP_PKEY\s0 *pkey);" 4
 705 .IX Item "int SSL_use_PrivateKey(SSL *ssl, EVP_PKEY *pkey);"
 706 .Ip "int \fBSSL_use_PrivateKey_ASN1\fR(int type, \s-1SSL\s0 *ssl, unsigned char *d, long len);" 4
 707 .IX Item "int SSL_use_PrivateKey_ASN1(int type, SSL *ssl, unsigned char *d, long len);"
 708 .Ip "int \fBSSL_use_PrivateKey_file\fR(\s-1SSL\s0 *ssl, char *file, int type);" 4
 709 .IX Item "int SSL_use_PrivateKey_file(SSL *ssl, char *file, int type);"
 710 .Ip "int \fBSSL_use_RSAPrivateKey\fR(\s-1SSL\s0 *ssl, \s-1RSA\s0 *rsa);" 4
 711 .IX Item "int SSL_use_RSAPrivateKey(SSL *ssl, RSA *rsa);"
 712 .Ip "int \fBSSL_use_RSAPrivateKey_ASN1\fR(\s-1SSL\s0 *ssl, unsigned char *d, long len);" 4
 713 .IX Item "int SSL_use_RSAPrivateKey_ASN1(SSL *ssl, unsigned char *d, long len);"
 714 .Ip "int \fBSSL_use_RSAPrivateKey_file\fR(\s-1SSL\s0 *ssl, char *file, int type);" 4
 715 .IX Item "int SSL_use_RSAPrivateKey_file(SSL *ssl, char *file, int type);"
 716 .Ip "int \fBSSL_use_certificate\fR(\s-1SSL\s0 *ssl, X509 *x);" 4
 717 .IX Item "int SSL_use_certificate(SSL *ssl, X509 *x);"
 718 .Ip "int \fBSSL_use_certificate_ASN1\fR(\s-1SSL\s0 *ssl, int len, unsigned char *d);" 4
 719 .IX Item "int SSL_use_certificate_ASN1(SSL *ssl, int len, unsigned char *d);"
 720 .Ip "int \fBSSL_use_certificate_file\fR(\s-1SSL\s0 *ssl, char *file, int type);" 4
 721 .IX Item "int SSL_use_certificate_file(SSL *ssl, char *file, int type);"
 722 .Ip "int \fBSSL_version\fR(\s-1SSL\s0 *ssl);" 4
 723 .IX Item "int SSL_version(SSL *ssl);"
 724 .Ip "int \fBSSL_want\fR(\s-1SSL\s0 *ssl);" 4
 725 .IX Item "int SSL_want(SSL *ssl);"
 726 .Ip "int \fBSSL_want_nothing\fR(\s-1SSL\s0 *ssl);" 4
 727 .IX Item "int SSL_want_nothing(SSL *ssl);"
 728 .Ip "int \fBSSL_want_read\fR(\s-1SSL\s0 *ssl);" 4
 729 .IX Item "int SSL_want_read(SSL *ssl);"
 730 .Ip "int \fBSSL_want_write\fR(\s-1SSL\s0 *ssl);" 4
 731 .IX Item "int SSL_want_write(SSL *ssl);"
 732 .Ip "int \fBSSL_want_x509_lookup\fR(s);" 4
 733 .IX Item "int SSL_want_x509_lookup(s);"
 734 .Ip "int \fBSSL_write\fR(\s-1SSL\s0 *ssl, const void *buf, int num);" 4
 735 .IX Item "int SSL_write(SSL *ssl, const void *buf, int num);"
 736 .PD
 737 .SH "SEE ALSO"
 738 .IX Header "SEE ALSO"
 739 openssl(1), crypto(3),
 740 SSL_accept(3), SSL_clear(3),
 741 SSL_connect(3),
 742 SSL_CIPHER_get_name(3),
 743 SSL_COMP_add_compression_method(3),
 744 SSL_CTX_add_extra_chain_cert(3),
 745 SSL_CTX_add_session(3),
 746 SSL_CTX_ctrl(3),
 747 SSL_CTX_flush_sessions(3),
 748 SSL_CTX_get_ex_new_index(3),
 749 SSL_CTX_get_verify_mode(3),
 750 SSL_CTX_load_verify_locations(3)
 751 SSL_CTX_new(3),
 752 SSL_CTX_sess_number(3),
 753 SSL_CTX_sess_set_cache_size(3),
 754 SSL_CTX_sess_set_get_cb(3),
 755 SSL_CTX_sessions(3),
 756 SSL_CTX_set_cert_store(3),
 757 SSL_CTX_set_cert_verify_callback(3),
 758 SSL_CTX_set_cipher_list(3),
 759 SSL_CTX_set_client_CA_list(3),
 760 SSL_CTX_set_client_cert_cb(3),
 761 SSL_CTX_set_default_passwd_cb(3),
 762 SSL_CTX_set_generate_session_id(3),
 763 SSL_CTX_set_info_callback(3),
 764 SSL_CTX_set_max_cert_list(3),
 765 SSL_CTX_set_mode(3),
 766 SSL_CTX_set_msg_callback(3),
 767 SSL_CTX_set_options(3),
 768 SSL_CTX_set_quiet_shutdown(3),
 769 SSL_CTX_set_session_cache_mode(3),
 770 SSL_CTX_set_session_id_context(3),
 771 SSL_CTX_set_ssl_version(3),
 772 SSL_CTX_set_timeout(3),
 773 SSL_CTX_set_tmp_rsa_callback(3),
 774 SSL_CTX_set_tmp_dh_callback(3),
 775 SSL_CTX_set_verify(3),
 776 SSL_CTX_use_certificate(3),
 777 SSL_alert_type_string(3),
 778 SSL_do_handshake(3),
 779 SSL_get_SSL_CTX(3),
 780 SSL_get_ciphers(3),
 781 SSL_get_client_CA_list(3),
 782 SSL_get_default_timeout(3),
 783 SSL_get_error(3),
 784 SSL_get_ex_data_X509_STORE_CTX_idx(3),
 785 SSL_get_ex_new_index(3),
 786 SSL_get_fd(3),
 787 SSL_get_peer_cert_chain(3),
 788 SSL_get_rbio(3),
 789 SSL_get_session(3),
 790 SSL_get_verify_result(3),
 791 SSL_get_version(3),
 792 SSL_library_init(3),
 793 SSL_load_client_CA_file(3),
 794 SSL_new(3),
 795 SSL_pending(3),
 796 SSL_read(3),
 797 SSL_rstate_string(3),
 798 SSL_session_reused(3),
 799 SSL_set_bio(3),
 800 SSL_set_connect_state(3),
 801 SSL_set_fd(3),
 802 SSL_set_session(3),
 803 SSL_set_shutdown(3),
 804 SSL_shutdown(3),
 805 SSL_state_string(3),
 806 SSL_want(3),
 807 SSL_write(3),
 808 SSL_SESSION_free(3),
 809 SSL_SESSION_get_ex_new_index(3),
 810 SSL_SESSION_get_time(3),
 811 d2i_SSL_SESSION(3)
 812 .SH "HISTORY"
 813 .IX Header "HISTORY"
 814 The ssl(3) document appeared in OpenSSL 0.9.2