ssl.pod 24.9 KB
Newer Older
U
Ulf Möller 已提交
1 2 3 4 5 6 7 8 9

=pod

=head1 NAME

SSL - OpenSSL SSL/TLS library

=head1 SYNOPSIS

U
Ulf Möller 已提交
10
=head1 DESCRIPTION
U
Ulf Möller 已提交
11 12 13 14 15

The OpenSSL B<ssl> library implements the Secure Sockets Layer (SSL v2/v3) and
Transport Layer Security (TLS v1) protocols. It provides a rich API which is
documented here.

16
Then an B<SSL_CTX> object is created as a framework to establish
R
Rich Salz 已提交
17
TLS/SSL enabled connections (see L<SSL_CTX_new(3)>).
18 19
Various options regarding certificates, algorithms etc. can be set
in this object.
U
Ulf Möller 已提交
20

21 22
When a network connection has been created, it can be assigned to an
B<SSL> object. After the B<SSL> object has been created using
R
Rich Salz 已提交
23 24
L<SSL_new(3)>, L<SSL_set_fd(3)> or
L<SSL_set_bio(3)> can be used to associate the network
25
connection with the object.
U
Ulf Möller 已提交
26

27
Then the TLS/SSL handshake is performed using
R
Rich Salz 已提交
28
L<SSL_accept(3)> or L<SSL_connect(3)>
29
respectively.
R
Rich Salz 已提交
30
L<SSL_read(3)> and L<SSL_write(3)> are used
31
to read and write data on the TLS/SSL connection.
R
Rich Salz 已提交
32
L<SSL_shutdown(3)> can be used to shut down the
33
TLS/SSL connection.
U
Ulf Möller 已提交
34 35 36 37 38 39 40 41 42 43 44

=head1 DATA STRUCTURES

Currently the OpenSSL B<ssl> library functions deals with the following data
structures:

=over 4

=item B<SSL_METHOD> (SSL Method)

That's a dispatch structure describing the internal B<ssl> library
K
Kurt Roeckx 已提交
45 46
methods/functions which implement the various protocol versions (SSLv3
TLSv1, ...). It's needed to create an B<SSL_CTX>.
U
Ulf Möller 已提交
47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62

=item B<SSL_CIPHER> (SSL Cipher)

This structure holds the algorithm information for a particular cipher which
are a core part of the SSL/TLS protocol. The available ciphers are configured
on a B<SSL_CTX> basis and the actually used ones are then part of the
B<SSL_SESSION>.

=item B<SSL_CTX> (SSL Context)

That's the global context structure which is created by a server or client
once per program life-time and which holds mainly default values for the
B<SSL> structures which are later created for the connections.

=item B<SSL_SESSION> (SSL Session)

B
Bodo Möller 已提交
63
This is a structure containing the current TLS/SSL session details for a
U
Ulf Möller 已提交
64 65 66 67 68 69 70 71 72 73 74
connection: B<SSL_CIPHER>s, client and server certificates, keys, etc.

=item B<SSL> (SSL Connection)

That's the main SSL/TLS structure which is created by a server or client per
established connection. This actually is the core structure in the SSL API.
Under run-time the application usually deals with this structure which has
links to mostly all other structures.

=back

75 76 77 78

=head1 HEADER FILES

Currently the OpenSSL B<ssl> library provides the following C header files
A
Alex Gaynor 已提交
79
containing the prototypes for the data structures and functions:
80 81 82 83 84 85 86 87 88 89 90 91 92

=over 4

=item B<ssl.h>

That's the common header file for the SSL/TLS API.  Include it into your
program to make the API of the B<ssl> library available. It internally
includes both more private SSL headers and headers from the B<crypto> library.
Whenever you need hard-core details on the internals of the SSL API, look
inside this header file.

=item B<ssl2.h>

M
Matt Caswell 已提交
93
Unused. Present for backwards compatibility only.
94 95 96 97 98 99 100 101 102 103 104 105 106 107 108

=item B<ssl3.h>

That's the sub header file dealing with the SSLv3 protocol only.
I<Usually you don't have to include it explicitly because
it's already included by ssl.h>.

=item B<tls1.h>

That's the sub header file dealing with the TLSv1 protocol only.
I<Usually you don't have to include it explicitly because
it's already included by ssl.h>.

=back

U
Ulf Möller 已提交
109 110 111 112 113 114 115 116 117 118 119 120
=head1 API FUNCTIONS

Currently the OpenSSL B<ssl> library exports 214 API functions.
They are documented in the following:

=head2 DEALING WITH PROTOCOL METHODS

Here we document the various API functions which deal with the SSL/TLS
protocol methods defined in B<SSL_METHOD> structures.

=over 4

121
=item const SSL_METHOD *B<TLS_method>(void);
U
Ulf Möller 已提交
122

123 124 125
Constructor for the I<version-flexible> SSL_METHOD structure for clients,
servers or both.
See L<SSL_CTX_new(3)> for details.
U
Ulf Möller 已提交
126

127
=item const SSL_METHOD *B<TLS_client_method>(void);
U
Ulf Möller 已提交
128

129
Constructor for the I<version-flexible> SSL_METHOD structure for clients.
U
Ulf Möller 已提交
130

131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151
=item const SSL_METHOD *B<TLS_server_method>(void);

Constructor for the I<version-flexible> SSL_METHOD structure for servers.

=item const SSL_METHOD *B<TLSv1_2_method>(void);

Constructor for the TLSv1.2 SSL_METHOD structure for clients, servers or both.

=item const SSL_METHOD *B<TLSv1_2_client_method>(void);

Constructor for the TLSv1.2 SSL_METHOD structure for clients.

=item const SSL_METHOD *B<TLSv1_2_server_method>(void);

Constructor for the TLSv1.2 SSL_METHOD structure for servers.

=item const SSL_METHOD *B<TLSv1_1_method>(void);

Constructor for the TLSv1.1 SSL_METHOD structure for clients, servers or both.

=item const SSL_METHOD *B<TLSv1_1_client_method>(void);
U
Ulf Möller 已提交
152

153 154 155 156 157 158 159 160 161
Constructor for the TLSv1.1 SSL_METHOD structure for clients.

=item const SSL_METHOD *B<TLSv1_1_server_method>(void);

Constructor for the TLSv1.1 SSL_METHOD structure for servers.

=item const SSL_METHOD *B<TLSv1_method>(void);

Constructor for the TLSv1 SSL_METHOD structure for clients, servers or both.
U
Ulf Möller 已提交
162

163
=item const SSL_METHOD *B<TLSv1_client_method>(void);
U
Ulf Möller 已提交
164

165
Constructor for the TLSv1 SSL_METHOD structure for clients.
U
Ulf Möller 已提交
166

B
Bodo Möller 已提交
167
=item const SSL_METHOD *B<TLSv1_server_method>(void);
U
Ulf Möller 已提交
168

169
Constructor for the TLSv1 SSL_METHOD structure for servers.
U
Ulf Möller 已提交
170

171 172 173 174 175 176 177 178 179
=item const SSL_METHOD *B<SSLv3_method>(void);

Constructor for the SSLv3 SSL_METHOD structure for clients, servers or both.

=item const SSL_METHOD *B<SSLv3_client_method>(void);

Constructor for the SSLv3 SSL_METHOD structure for clients.

=item const SSL_METHOD *B<SSLv3_server_method>(void);
U
Ulf Möller 已提交
180

181
Constructor for the SSLv3 SSL_METHOD structure for servers.
U
Ulf Möller 已提交
182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202

=back

=head2 DEALING WITH CIPHERS

Here we document the various API functions which deal with the SSL/TLS
ciphers defined in B<SSL_CIPHER> structures.

=over 4

=item char *B<SSL_CIPHER_description>(SSL_CIPHER *cipher, char *buf, int len);

Write a string to I<buf> (with a maximum size of I<len>) containing a human
readable description of I<cipher>. Returns I<buf>.

=item int B<SSL_CIPHER_get_bits>(SSL_CIPHER *cipher, int *alg_bits);

Determine the number of bits in I<cipher>. Because of export crippled ciphers
there are two bits: The bits the algorithm supports in general (stored to
I<alg_bits>) and the bits which are actually used (the return value).

B
Bodo Möller 已提交
203
=item const char *B<SSL_CIPHER_get_name>(SSL_CIPHER *cipher);
U
Ulf Möller 已提交
204 205

Return the internal name of I<cipher> as a string. These are the various
K
Kurt Roeckx 已提交
206
strings defined by the I<SSL3_TXT_xxx> and I<TLS1_TXT_xxx>
U
Ulf Möller 已提交
207 208
definitions in the header files.

209
=item const char *B<SSL_CIPHER_get_version>(SSL_CIPHER *cipher);
U
Ulf Möller 已提交
210

M
Matt Caswell 已提交
211
Returns a string like "C<SSLv3>" or "C<TLSv1.2>" which indicates the
U
Ulf Möller 已提交
212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229
SSL/TLS protocol version to which I<cipher> belongs (i.e. where it was defined
in the specification the first time).

=back

=head2 DEALING WITH PROTOCOL CONTEXTS

Here we document the various API functions which deal with the SSL/TLS
protocol context defined in the B<SSL_CTX> structure.

=over 4

=item int B<SSL_CTX_add_client_CA>(SSL_CTX *ctx, X509 *x);

=item long B<SSL_CTX_add_extra_chain_cert>(SSL_CTX *ctx, X509 *x509);

=item int B<SSL_CTX_add_session>(SSL_CTX *ctx, SSL_SESSION *c);

230
=item int B<SSL_CTX_check_private_key>(const SSL_CTX *ctx);
U
Ulf Möller 已提交
231 232 233 234 235 236 237 238 239 240 241

=item long B<SSL_CTX_ctrl>(SSL_CTX *ctx, int cmd, long larg, char *parg);

=item void B<SSL_CTX_flush_sessions>(SSL_CTX *s, long t);

=item void B<SSL_CTX_free>(SSL_CTX *a);

=item char *B<SSL_CTX_get_app_data>(SSL_CTX *ctx);

=item X509_STORE *B<SSL_CTX_get_cert_store>(SSL_CTX *ctx);

K
Kazuki Yamaguchi 已提交
242 243
=item STACK *B<SSL_CTX_get_ciphers>(const SSL_CTX *ctx);

244
=item STACK *B<SSL_CTX_get_client_CA_list>(const SSL_CTX *ctx);
U
Ulf Möller 已提交
245 246 247

=item int (*B<SSL_CTX_get_client_cert_cb>(SSL_CTX *ctx))(SSL *ssl, X509 **x509, EVP_PKEY **pkey);

248 249
=item void B<SSL_CTX_get_default_read_ahead>(SSL_CTX *ctx);

250
=item char *B<SSL_CTX_get_ex_data>(const SSL_CTX *s, int idx);
U
Ulf Möller 已提交
251 252 253 254 255

=item int B<SSL_CTX_get_ex_new_index>(long argl, char *argp, int (*new_func);(void), int (*dup_func)(void), void (*free_func)(void))

=item void (*B<SSL_CTX_get_info_callback>(SSL_CTX *ctx))(SSL *ssl, int cb, int ret);

256
=item int B<SSL_CTX_get_quiet_shutdown>(const SSL_CTX *ctx);
U
Ulf Möller 已提交
257

258 259
=item void B<SSL_CTX_get_read_ahead>(SSL_CTX *ctx);

U
Ulf Möller 已提交
260 261
=item int B<SSL_CTX_get_session_cache_mode>(SSL_CTX *ctx);

262
=item long B<SSL_CTX_get_timeout>(const SSL_CTX *ctx);
U
Ulf Möller 已提交
263

264
=item int (*B<SSL_CTX_get_verify_callback>(const SSL_CTX *ctx))(int ok, X509_STORE_CTX *ctx);
U
Ulf Möller 已提交
265 266 267

=item int B<SSL_CTX_get_verify_mode>(SSL_CTX *ctx);

268
=item int B<SSL_CTX_load_verify_locations>(SSL_CTX *ctx, const char *CAfile, const char *CApath);
U
Ulf Möller 已提交
269 270 271

=item long B<SSL_CTX_need_tmp_RSA>(SSL_CTX *ctx);

272
=item SSL_CTX *B<SSL_CTX_new>(const SSL_METHOD *meth);
U
Ulf Möller 已提交
273

274
=item int SSL_CTX_up_ref(SSL_CTX *ctx);
275

U
Ulf Möller 已提交
276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323
=item int B<SSL_CTX_remove_session>(SSL_CTX *ctx, SSL_SESSION *c);

=item int B<SSL_CTX_sess_accept>(SSL_CTX *ctx);

=item int B<SSL_CTX_sess_accept_good>(SSL_CTX *ctx);

=item int B<SSL_CTX_sess_accept_renegotiate>(SSL_CTX *ctx);

=item int B<SSL_CTX_sess_cache_full>(SSL_CTX *ctx);

=item int B<SSL_CTX_sess_cb_hits>(SSL_CTX *ctx);

=item int B<SSL_CTX_sess_connect>(SSL_CTX *ctx);

=item int B<SSL_CTX_sess_connect_good>(SSL_CTX *ctx);

=item int B<SSL_CTX_sess_connect_renegotiate>(SSL_CTX *ctx);

=item int B<SSL_CTX_sess_get_cache_size>(SSL_CTX *ctx);

=item SSL_SESSION *(*B<SSL_CTX_sess_get_get_cb>(SSL_CTX *ctx))(SSL *ssl, unsigned char *data, int len, int *copy);

=item int (*B<SSL_CTX_sess_get_new_cb>(SSL_CTX *ctx)(SSL *ssl, SSL_SESSION *sess);

=item void (*B<SSL_CTX_sess_get_remove_cb>(SSL_CTX *ctx)(SSL_CTX *ctx, SSL_SESSION *sess);

=item int B<SSL_CTX_sess_hits>(SSL_CTX *ctx);

=item int B<SSL_CTX_sess_misses>(SSL_CTX *ctx);

=item int B<SSL_CTX_sess_number>(SSL_CTX *ctx);

=item void B<SSL_CTX_sess_set_cache_size>(SSL_CTX *ctx,t);

=item void B<SSL_CTX_sess_set_get_cb>(SSL_CTX *ctx, SSL_SESSION *(*cb)(SSL *ssl, unsigned char *data, int len, int *copy));

=item void B<SSL_CTX_sess_set_new_cb>(SSL_CTX *ctx, int (*cb)(SSL *ssl, SSL_SESSION *sess));

=item void B<SSL_CTX_sess_set_remove_cb>(SSL_CTX *ctx, void (*cb)(SSL_CTX *ctx, SSL_SESSION *sess));

=item int B<SSL_CTX_sess_timeouts>(SSL_CTX *ctx);

=item LHASH *B<SSL_CTX_sessions>(SSL_CTX *ctx);

=item void B<SSL_CTX_set_app_data>(SSL_CTX *ctx, void *arg);

=item void B<SSL_CTX_set_cert_store>(SSL_CTX *ctx, X509_STORE *cs);

324
=item void B<SSL_CTX_set_cert_verify_cb>(SSL_CTX *ctx, int (*cb)(), char *arg)
U
Ulf Möller 已提交
325 326 327 328 329 330 331 332 333 334 335 336 337

=item int B<SSL_CTX_set_cipher_list>(SSL_CTX *ctx, char *str);

=item void B<SSL_CTX_set_client_CA_list>(SSL_CTX *ctx, STACK *list);

=item void B<SSL_CTX_set_client_cert_cb>(SSL_CTX *ctx, int (*cb)(SSL *ssl, X509 **x509, EVP_PKEY **pkey));

=item void B<SSL_CTX_set_default_passwd_cb>(SSL_CTX *ctx, int (*cb);(void))

=item void B<SSL_CTX_set_default_read_ahead>(SSL_CTX *ctx, int m);

=item int B<SSL_CTX_set_default_verify_paths>(SSL_CTX *ctx);

338 339 340 341 342
Use the default paths to locate trusted CA certificates. There is one default
directory path and one default file path. Both are set via this call.

=item int B<SSL_CTX_set_default_verify_dir>(SSL_CTX *ctx)

F
FdaSilvaYY 已提交
343
Use the default directory path to locate trusted CA certificates.
344 345 346

=item int B<SSL_CTX_set_default_verify_file>(SSL_CTX *ctx)

F
FdaSilvaYY 已提交
347
Use the file path to locate trusted CA certificates.
348

U
Ulf Möller 已提交
349 350 351 352
=item int B<SSL_CTX_set_ex_data>(SSL_CTX *s, int idx, char *arg);

=item void B<SSL_CTX_set_info_callback>(SSL_CTX *ctx, void (*cb)(SSL *ssl, int cb, int ret));

353 354 355 356
=item void B<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));

=item void B<SSL_CTX_set_msg_callback_arg>(SSL_CTX *ctx, void *arg);

357 358 359 360 361
=item unsigned long B<SSL_CTX_clear_options>(SSL_CTX *ctx, unsigned long op);

=item unsigned long B<SSL_CTX_get_options>(SSL_CTX *ctx);

=item unsigned long B<SSL_CTX_set_options>(SSL_CTX *ctx, unsigned long op);
U
Ulf Möller 已提交
362 363 364

=item void B<SSL_CTX_set_quiet_shutdown>(SSL_CTX *ctx, int mode);

365 366
=item void B<SSL_CTX_set_read_ahead>(SSL_CTX *ctx, int m);

U
Ulf Möller 已提交
367 368
=item void B<SSL_CTX_set_session_cache_mode>(SSL_CTX *ctx, int mode);

369
=item int B<SSL_CTX_set_ssl_version>(SSL_CTX *ctx, const SSL_METHOD *meth);
U
Ulf Möller 已提交
370 371 372 373 374 375 376 377 378 379 380 381 382

=item void B<SSL_CTX_set_timeout>(SSL_CTX *ctx, long t);

=item long B<SSL_CTX_set_tmp_dh>(SSL_CTX* ctx, DH *dh);

=item long B<SSL_CTX_set_tmp_dh_callback>(SSL_CTX *ctx, DH *(*cb)(void));

=item void B<SSL_CTX_set_verify>(SSL_CTX *ctx, int mode, int (*cb);(void))

=item int B<SSL_CTX_use_PrivateKey>(SSL_CTX *ctx, EVP_PKEY *pkey);

=item int B<SSL_CTX_use_PrivateKey_ASN1>(int type, SSL_CTX *ctx, unsigned char *d, long len);

383
=item int B<SSL_CTX_use_PrivateKey_file>(SSL_CTX *ctx, const char *file, int type);
U
Ulf Möller 已提交
384 385 386 387 388

=item int B<SSL_CTX_use_RSAPrivateKey>(SSL_CTX *ctx, RSA *rsa);

=item int B<SSL_CTX_use_RSAPrivateKey_ASN1>(SSL_CTX *ctx, unsigned char *d, long len);

389
=item int B<SSL_CTX_use_RSAPrivateKey_file>(SSL_CTX *ctx, const char *file, int type);
U
Ulf Möller 已提交
390 391 392 393 394

=item int B<SSL_CTX_use_certificate>(SSL_CTX *ctx, X509 *x);

=item int B<SSL_CTX_use_certificate_ASN1>(SSL_CTX *ctx, int len, unsigned char *d);

395
=item int B<SSL_CTX_use_certificate_file>(SSL_CTX *ctx, const char *file, int type);
U
Ulf Möller 已提交
396

397 398 399 400
=item X509 *B<SSL_CTX_get0_certificate>(const SSL_CTX *ctx);

=item EVP_PKEY *B<SSL_CTX_get0_privatekey>(const SSL_CTX *ctx);

401 402 403 404 405 406 407 408 409
=item void B<SSL_CTX_set_psk_client_callback>(SSL_CTX *ctx, unsigned int (*callback)(SSL *ssl, const char *hint, char *identity, unsigned int max_identity_len, unsigned char *psk, unsigned int max_psk_len));

=item int B<SSL_CTX_use_psk_identity_hint>(SSL_CTX *ctx, const char *hint);

=item void B<SSL_CTX_set_psk_server_callback>(SSL_CTX *ctx, unsigned int (*callback)(SSL *ssl, const char *identity, unsigned char *psk, int max_psk_len));




U
Ulf Möller 已提交
410 411 412 413 414 415 416 417 418
=back

=head2 DEALING WITH SESSIONS

Here we document the various API functions which deal with the SSL/TLS
sessions defined in the B<SSL_SESSION> structures.

=over 4

419
=item int B<SSL_SESSION_cmp>(const SSL_SESSION *a, const SSL_SESSION *b);
U
Ulf Möller 已提交
420 421 422 423 424

=item void B<SSL_SESSION_free>(SSL_SESSION *ss);

=item char *B<SSL_SESSION_get_app_data>(SSL_SESSION *s);

425
=item char *B<SSL_SESSION_get_ex_data>(const SSL_SESSION *s, int idx);
U
Ulf Möller 已提交
426 427 428

=item int B<SSL_SESSION_get_ex_new_index>(long argl, char *argp, int (*new_func);(void), int (*dup_func)(void), void (*free_func)(void))

429
=item long B<SSL_SESSION_get_time>(const SSL_SESSION *s);
U
Ulf Möller 已提交
430

431
=item long B<SSL_SESSION_get_timeout>(const SSL_SESSION *s);
U
Ulf Möller 已提交
432

433
=item unsigned long B<SSL_SESSION_hash>(const SSL_SESSION *a);
U
Ulf Möller 已提交
434 435 436

=item SSL_SESSION *B<SSL_SESSION_new>(void);

437
=item int B<SSL_SESSION_print>(BIO *bp, const SSL_SESSION *x);
U
Ulf Möller 已提交
438

439
=item int B<SSL_SESSION_print_fp>(FILE *fp, const SSL_SESSION *x);
U
Ulf Möller 已提交
440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473

=item void B<SSL_SESSION_set_app_data>(SSL_SESSION *s, char *a);

=item int B<SSL_SESSION_set_ex_data>(SSL_SESSION *s, int idx, char *arg);

=item long B<SSL_SESSION_set_time>(SSL_SESSION *s, long t);

=item long B<SSL_SESSION_set_timeout>(SSL_SESSION *s, long t);

=back

=head2 DEALING WITH CONNECTIONS

Here we document the various API functions which deal with the SSL/TLS
connection defined in the B<SSL> structure.

=over 4

=item int B<SSL_accept>(SSL *ssl);

=item int B<SSL_add_dir_cert_subjects_to_stack>(STACK *stack, const char *dir);

=item int B<SSL_add_file_cert_subjects_to_stack>(STACK *stack, const char *file);

=item int B<SSL_add_client_CA>(SSL *ssl, X509 *x);

=item char *B<SSL_alert_desc_string>(int value);

=item char *B<SSL_alert_desc_string_long>(int value);

=item char *B<SSL_alert_type_string>(int value);

=item char *B<SSL_alert_type_string_long>(int value);

474
=item int B<SSL_check_private_key>(const SSL *ssl);
U
Ulf Möller 已提交
475 476 477 478 479 480 481

=item void B<SSL_clear>(SSL *ssl);

=item long B<SSL_clear_num_renegotiations>(SSL *ssl);

=item int B<SSL_connect>(SSL *ssl);

M
Matt Caswell 已提交
482 483 484 485
=item int B<SSL_copy_session_id>(SSL *t, const SSL *f);

Sets the session details for B<t> to be the same as in B<f>. Returns 1 on
success or 0 on failure.
U
Ulf Möller 已提交
486 487 488 489 490 491 492

=item long B<SSL_ctrl>(SSL *ssl, int cmd, long larg, char *parg);

=item int B<SSL_do_handshake>(SSL *ssl);

=item SSL *B<SSL_dup>(SSL *ssl);

493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511
SSL_dup() allows applications to configure an SSL handle for use
in multiple SSL connections, and then duplicate it prior to initiating
each connection with the duplicated handle.
Use of SSL_dup() avoids the need to repeat the configuration of the
handles for each connection.
This is used internally by L<BIO_s_accept(3)> to construct
per-connection SSL handles after L<accept(2)>.

For SSL_dup() to work, the connection MUST be in its initial state
and MUST NOT have not yet have started the SSL handshake.
For connections that are not in their initial state SSL_dup() just
increments an internal reference count and returns the I<same>
handle.
It may be possible to use L<SSL_clear(3)> to recycle an SSL handle
that is not in its initial state for re-use, but this is best
avoided.
Instead, save and restore the session, if desired, and construct a
fresh handle for each connection.

U
Ulf Möller 已提交
512 513 514 515
=item STACK *B<SSL_dup_CA_list>(STACK *sk);

=item void B<SSL_free>(SSL *ssl);

516
=item SSL_CTX *B<SSL_get_SSL_CTX>(const SSL *ssl);
U
Ulf Möller 已提交
517 518 519

=item char *B<SSL_get_app_data>(SSL *ssl);

520
=item X509 *B<SSL_get_certificate>(const SSL *ssl);
U
Ulf Möller 已提交
521

522
=item const char *B<SSL_get_cipher>(const SSL *ssl);
U
Ulf Möller 已提交
523

524
=item int B<SSL_get_cipher_bits>(const SSL *ssl, int *alg_bits);
U
Ulf Möller 已提交
525

526
=item char *B<SSL_get_cipher_list>(const SSL *ssl, int n);
U
Ulf Möller 已提交
527

528
=item char *B<SSL_get_cipher_name>(const SSL *ssl);
U
Ulf Möller 已提交
529

530
=item char *B<SSL_get_cipher_version>(const SSL *ssl);
U
Ulf Möller 已提交
531

532
=item STACK *B<SSL_get_ciphers>(const SSL *ssl);
U
Ulf Möller 已提交
533

534
=item STACK *B<SSL_get_client_CA_list>(const SSL *ssl);
U
Ulf Möller 已提交
535 536 537

=item SSL_CIPHER *B<SSL_get_current_cipher>(SSL *ssl);

538
=item long B<SSL_get_default_timeout>(const SSL *ssl);
U
Ulf Möller 已提交
539

540
=item int B<SSL_get_error>(const SSL *ssl, int i);
U
Ulf Möller 已提交
541

542
=item char *B<SSL_get_ex_data>(const SSL *ssl, int idx);
U
Ulf Möller 已提交
543 544 545 546 547

=item int B<SSL_get_ex_data_X509_STORE_CTX_idx>(void);

=item int B<SSL_get_ex_new_index>(long argl, char *argp, int (*new_func);(void), int (*dup_func)(void), void (*free_func)(void))

548
=item int B<SSL_get_fd>(const SSL *ssl);
U
Ulf Möller 已提交
549

550
=item void (*B<SSL_get_info_callback>(const SSL *ssl);)()
U
Ulf Möller 已提交
551

552
=item STACK *B<SSL_get_peer_cert_chain>(const SSL *ssl);
U
Ulf Möller 已提交
553

554
=item X509 *B<SSL_get_peer_certificate>(const SSL *ssl);
U
Ulf Möller 已提交
555

556
=item EVP_PKEY *B<SSL_get_privatekey>(const SSL *ssl);
U
Ulf Möller 已提交
557

558
=item int B<SSL_get_quiet_shutdown>(const SSL *ssl);
U
Ulf Möller 已提交
559

560
=item BIO *B<SSL_get_rbio>(const SSL *ssl);
U
Ulf Möller 已提交
561

562
=item int B<SSL_get_read_ahead>(const SSL *ssl);
U
Ulf Möller 已提交
563

564
=item SSL_SESSION *B<SSL_get_session>(const SSL *ssl);
U
Ulf Möller 已提交
565

566
=item char *B<SSL_get_shared_ciphers>(const SSL *ssl, char *buf, int len);
U
Ulf Möller 已提交
567

568
=item int B<SSL_get_shutdown>(const SSL *ssl);
U
Ulf Möller 已提交
569

570
=item const SSL_METHOD *B<SSL_get_ssl_method>(SSL *ssl);
U
Ulf Möller 已提交
571

572
=item int B<SSL_get_state>(const SSL *ssl);
U
Ulf Möller 已提交
573

574
=item long B<SSL_get_time>(const SSL *ssl);
U
Ulf Möller 已提交
575

576
=item long B<SSL_get_timeout>(const SSL *ssl);
U
Ulf Möller 已提交
577

578
=item int (*B<SSL_get_verify_callback>(const SSL *ssl))(int,X509_STORE_CTX *)
U
Ulf Möller 已提交
579

580
=item int B<SSL_get_verify_mode>(const SSL *ssl);
U
Ulf Möller 已提交
581

582
=item long B<SSL_get_verify_result>(const SSL *ssl);
U
Ulf Möller 已提交
583

584
=item char *B<SSL_get_version>(const SSL *ssl);
U
Ulf Möller 已提交
585

586
=item BIO *B<SSL_get_wbio>(const SSL *ssl);
U
Ulf Möller 已提交
587 588 589 590 591 592 593 594 595 596 597

=item int B<SSL_in_accept_init>(SSL *ssl);

=item int B<SSL_in_before>(SSL *ssl);

=item int B<SSL_in_connect_init>(SSL *ssl);

=item int B<SSL_in_init>(SSL *ssl);

=item int B<SSL_is_init_finished>(SSL *ssl);

598
=item STACK *B<SSL_load_client_CA_file>(const char *file);
U
Ulf Möller 已提交
599 600 601

=item SSL *B<SSL_new>(SSL_CTX *ctx);

602
=item int SSL_up_ref(SSL *s);
603

U
Ulf Möller 已提交
604 605
=item long B<SSL_num_renegotiations>(SSL *ssl);

606
=item int B<SSL_peek>(SSL *ssl, void *buf, int num);
U
Ulf Möller 已提交
607

608
=item int B<SSL_pending>(const SSL *ssl);
U
Ulf Möller 已提交
609

610
=item int B<SSL_read>(SSL *ssl, void *buf, int num);
U
Ulf Möller 已提交
611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637

=item int B<SSL_renegotiate>(SSL *ssl);

=item char *B<SSL_rstate_string>(SSL *ssl);

=item char *B<SSL_rstate_string_long>(SSL *ssl);

=item long B<SSL_session_reused>(SSL *ssl);

=item void B<SSL_set_accept_state>(SSL *ssl);

=item void B<SSL_set_app_data>(SSL *ssl, char *arg);

=item void B<SSL_set_bio>(SSL *ssl, BIO *rbio, BIO *wbio);

=item int B<SSL_set_cipher_list>(SSL *ssl, char *str);

=item void B<SSL_set_client_CA_list>(SSL *ssl, STACK *list);

=item void B<SSL_set_connect_state>(SSL *ssl);

=item int B<SSL_set_ex_data>(SSL *ssl, int idx, char *arg);

=item int B<SSL_set_fd>(SSL *ssl, int fd);

=item void B<SSL_set_info_callback>(SSL *ssl, void (*cb);(void))

638 639 640 641
=item void B<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));

=item void B<SSL_set_msg_callback_arg>(SSL *ctx, void *arg);

642 643 644 645 646
=item unsigned long B<SSL_clear_options>(SSL *ssl, unsigned long op);

=item unsigned long B<SSL_get_options>(SSL *ssl);

=item unsigned long B<SSL_set_options>(SSL *ssl, unsigned long op);
U
Ulf Möller 已提交
647 648 649 650 651 652 653 654 655 656 657

=item void B<SSL_set_quiet_shutdown>(SSL *ssl, int mode);

=item void B<SSL_set_read_ahead>(SSL *ssl, int yes);

=item int B<SSL_set_rfd>(SSL *ssl, int fd);

=item int B<SSL_set_session>(SSL *ssl, SSL_SESSION *session);

=item void B<SSL_set_shutdown>(SSL *ssl, int mode);

658
=item int B<SSL_set_ssl_method>(SSL *ssl, const SSL_METHOD *meth);
U
Ulf Möller 已提交
659 660 661 662 663 664 665 666 667 668 669 670 671

=item void B<SSL_set_time>(SSL *ssl, long t);

=item void B<SSL_set_timeout>(SSL *ssl, long t);

=item void B<SSL_set_verify>(SSL *ssl, int mode, int (*callback);(void))

=item void B<SSL_set_verify_result>(SSL *ssl, long arg);

=item int B<SSL_set_wfd>(SSL *ssl, int fd);

=item int B<SSL_shutdown>(SSL *ssl);

M
Matt Caswell 已提交
672
=item OSSL_HANDSHAKE_STATE B<SSL_get_state>(const SSL *ssl);
M
Matt Caswell 已提交
673 674

Returns the current handshake state.
U
Ulf Möller 已提交
675

676
=item char *B<SSL_state_string>(const SSL *ssl);
U
Ulf Möller 已提交
677

678
=item char *B<SSL_state_string_long>(const SSL *ssl);
U
Ulf Möller 已提交
679 680 681 682 683 684 685

=item long B<SSL_total_renegotiations>(SSL *ssl);

=item int B<SSL_use_PrivateKey>(SSL *ssl, EVP_PKEY *pkey);

=item int B<SSL_use_PrivateKey_ASN1>(int type, SSL *ssl, unsigned char *d, long len);

686
=item int B<SSL_use_PrivateKey_file>(SSL *ssl, const char *file, int type);
U
Ulf Möller 已提交
687 688 689 690 691

=item int B<SSL_use_RSAPrivateKey>(SSL *ssl, RSA *rsa);

=item int B<SSL_use_RSAPrivateKey_ASN1>(SSL *ssl, unsigned char *d, long len);

692
=item int B<SSL_use_RSAPrivateKey_file>(SSL *ssl, const char *file, int type);
U
Ulf Möller 已提交
693 694 695 696 697

=item int B<SSL_use_certificate>(SSL *ssl, X509 *x);

=item int B<SSL_use_certificate_ASN1>(SSL *ssl, int len, unsigned char *d);

698
=item int B<SSL_use_certificate_file>(SSL *ssl, const char *file, int type);
U
Ulf Möller 已提交
699

700
=item int B<SSL_version>(const SSL *ssl);
U
Ulf Möller 已提交
701

702
=item int B<SSL_want>(const SSL *ssl);
U
Ulf Möller 已提交
703

704
=item int B<SSL_want_nothing>(const SSL *ssl);
U
Ulf Möller 已提交
705

706
=item int B<SSL_want_read>(const SSL *ssl);
U
Ulf Möller 已提交
707

708
=item int B<SSL_want_write>(const SSL *ssl);
U
Ulf Möller 已提交
709

710
=item int B<SSL_want_x509_lookup>(const SSL *ssl);
U
Ulf Möller 已提交
711

712
=item int B<SSL_write>(SSL *ssl, const void *buf, int num);
U
Ulf Möller 已提交
713

714 715 716 717 718 719 720 721 722 723
=item void B<SSL_set_psk_client_callback>(SSL *ssl, unsigned int (*callback)(SSL *ssl, const char *hint, char *identity, unsigned int max_identity_len, unsigned char *psk, unsigned int max_psk_len));

=item int B<SSL_use_psk_identity_hint>(SSL *ssl, const char *hint);

=item void B<SSL_set_psk_server_callback>(SSL *ssl, unsigned int (*callback)(SSL *ssl, const char *identity, unsigned char *psk, int max_psk_len));

=item const char *B<SSL_get_psk_identity_hint>(SSL *ssl);

=item const char *B<SSL_get_psk_identity>(SSL *ssl);

U
Ulf Möller 已提交
724 725 726 727
=back

=head1 SEE ALSO

R
Rich Salz 已提交
728
L<openssl(1)>, L<crypto(3)>,
R
Rich Salz 已提交
729
L<CRYPTO_get_ex_new_index(3)>,
R
Rich Salz 已提交
730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799
L<SSL_accept(3)>, L<SSL_clear(3)>,
L<SSL_connect(3)>,
L<SSL_CIPHER_get_name(3)>,
L<SSL_COMP_add_compression_method(3)>,
L<SSL_CTX_add_extra_chain_cert(3)>,
L<SSL_CTX_add_session(3)>,
L<SSL_CTX_ctrl(3)>,
L<SSL_CTX_flush_sessions(3)>,
L<SSL_CTX_get_verify_mode(3)>,
L<SSL_CTX_load_verify_locations(3)>
L<SSL_CTX_new(3)>,
L<SSL_CTX_sess_number(3)>,
L<SSL_CTX_sess_set_cache_size(3)>,
L<SSL_CTX_sess_set_get_cb(3)>,
L<SSL_CTX_sessions(3)>,
L<SSL_CTX_set_cert_store(3)>,
L<SSL_CTX_set_cert_verify_callback(3)>,
L<SSL_CTX_set_cipher_list(3)>,
L<SSL_CTX_set_client_CA_list(3)>,
L<SSL_CTX_set_client_cert_cb(3)>,
L<SSL_CTX_set_default_passwd_cb(3)>,
L<SSL_CTX_set_generate_session_id(3)>,
L<SSL_CTX_set_info_callback(3)>,
L<SSL_CTX_set_max_cert_list(3)>,
L<SSL_CTX_set_mode(3)>,
L<SSL_CTX_set_msg_callback(3)>,
L<SSL_CTX_set_options(3)>,
L<SSL_CTX_set_quiet_shutdown(3)>,
L<SSL_CTX_set_read_ahead(3)>,
L<SSL_CTX_set_session_cache_mode(3)>,
L<SSL_CTX_set_session_id_context(3)>,
L<SSL_CTX_set_ssl_version(3)>,
L<SSL_CTX_set_timeout(3)>,
L<SSL_CTX_set_tmp_dh_callback(3)>,
L<SSL_CTX_set_verify(3)>,
L<SSL_CTX_use_certificate(3)>,
L<SSL_alert_type_string(3)>,
L<SSL_do_handshake(3)>,
L<SSL_get_SSL_CTX(3)>,
L<SSL_get_ciphers(3)>,
L<SSL_get_client_CA_list(3)>,
L<SSL_get_default_timeout(3)>,
L<SSL_get_error(3)>,
L<SSL_get_ex_data_X509_STORE_CTX_idx(3)>,
L<SSL_get_fd(3)>,
L<SSL_get_peer_cert_chain(3)>,
L<SSL_get_rbio(3)>,
L<SSL_get_session(3)>,
L<SSL_get_verify_result(3)>,
L<SSL_get_version(3)>,
L<SSL_load_client_CA_file(3)>,
L<SSL_new(3)>,
L<SSL_pending(3)>,
L<SSL_read(3)>,
L<SSL_rstate_string(3)>,
L<SSL_session_reused(3)>,
L<SSL_set_bio(3)>,
L<SSL_set_connect_state(3)>,
L<SSL_set_fd(3)>,
L<SSL_set_session(3)>,
L<SSL_set_shutdown(3)>,
L<SSL_shutdown(3)>,
L<SSL_state_string(3)>,
L<SSL_want(3)>,
L<SSL_write(3)>,
L<SSL_SESSION_free(3)>,
L<SSL_SESSION_get_time(3)>,
L<d2i_SSL_SESSION(3)>,
L<SSL_CTX_set_psk_client_callback(3)>,
L<SSL_CTX_use_psk_identity_hint(3)>,
M
Matt Caswell 已提交
800
L<SSL_get_psk_identity(3)>,
801
L<DTLSv1_listen(3)>
U
Ulf Möller 已提交
802 803 804

=head1 HISTORY

K
Kurt Roeckx 已提交
805 806 807
B<SSLv2_client_method>, B<SSLv2_server_method> and B<SSLv2_method> where removed
in OpenSSL 1.1.0.

M
Matt Caswell 已提交
808 809 810
The return type of B<SSL_copy_session_id> was changed from void to int in
OpenSSL 1.1.0.

U
Ulf Möller 已提交
811
=cut
R
Rich Salz 已提交
812 813 814 815 816 817 818 819 820 821 822

=head1 COPYRIGHT

Copyright 2000-2016 The OpenSSL Project Authors. All Rights Reserved.

Licensed under the OpenSSL license (the "License").  You may not use
this file except in compliance with the License.  You can obtain a copy
in the file LICENSE in the source distribution or at
L<https://www.openssl.org/source/license.html>.

=cut