doc/man7/ssl.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 SSL - OpenSSL SSL/TLS library
   6
   7 =head1 SYNOPSIS
   8
   9 See the individual manual pages for details.
  10
  11 =head1 DESCRIPTION
  12
  13 The OpenSSL B<ssl> library implements the Secure Sockets Layer (SSL v2/v3) and
  14 Transport Layer Security (TLS v1) protocols. It provides a rich API which is
  15 documented here.
  16
  17 Then an B<SSL_CTX> object is created as a framework to establish
  18 TLS/SSL enabled connections (see L<SSL_CTX_new(3)>).
  19 Various options regarding certificates, algorithms etc. can be set
  20 in this object.
  21
  22 When a network connection has been created, it can be assigned to an
  23 B<SSL> object. After the B<SSL> object has been created using
  24 L<SSL_new(3)>, L<SSL_set_fd(3)> or
  25 L<SSL_set_bio(3)> can be used to associate the network
  26 connection with the object.
  27
  28 Then the TLS/SSL handshake is performed using
  29 L<SSL_accept(3)> or L<SSL_connect(3)>
  30 respectively.
  31 L<SSL_read_ex(3)>, L<SSL_read(3)>, L<SSL_write_ex(3)> and L<SSL_write(3)> are
  32 used to read and write data on the TLS/SSL connection.
  33 L<SSL_shutdown(3)> can be used to shut down the
  34 TLS/SSL connection.
  35
  36 =head1 DATA STRUCTURES
  37
  38 Currently the OpenSSL B<ssl> library functions deals with the following data
  39 structures:
  40
  41 =over 4
  42
  43 =item B<SSL_METHOD> (SSL Method)
  44
  45 That's a dispatch structure describing the internal B<ssl> library
  46 methods/functions which implement the various protocol versions (SSLv3
  47 TLSv1, ...). It's needed to create an B<SSL_CTX>.
  48
  49 =item B<SSL_CIPHER> (SSL Cipher)
  50
  51 This structure holds the algorithm information for a particular cipher which
  52 are a core part of the SSL/TLS protocol. The available ciphers are configured
  53 on a B<SSL_CTX> basis and the actually used ones are then part of the
  54 B<SSL_SESSION>.
  55
  56 =item B<SSL_CTX> (SSL Context)
  57
  58 That's the global context structure which is created by a server or client
  59 once per program life-time and which holds mainly default values for the
  60 B<SSL> structures which are later created for the connections.
  61
  62 =item B<SSL_SESSION> (SSL Session)
  63
  64 This is a structure containing the current TLS/SSL session details for a
  65 connection: B<SSL_CIPHER>s, client and server certificates, keys, etc.
  66
  67 =item B<SSL> (SSL Connection)
  68
  69 That's the main SSL/TLS structure which is created by a server or client per
  70 established connection. This actually is the core structure in the SSL API.
  71 Under run-time the application usually deals with this structure which has
  72 links to mostly all other structures.
  73
  74 =back
  75
  76
  77 =head1 HEADER FILES
  78
  79 Currently the OpenSSL B<ssl> library provides the following C header files
  80 containing the prototypes for the data structures and functions:
  81
  82 =over 4
  83
  84 =item B<ssl.h>
  85
  86 That's the common header file for the SSL/TLS API.  Include it into your
  87 program to make the API of the B<ssl> library available. It internally
  88 includes both more private SSL headers and headers from the B<crypto> library.
  89 Whenever you need hard-core details on the internals of the SSL API, look
  90 inside this header file.
  91
  92 =item B<ssl2.h>
  93
  94 Unused. Present for backwards compatibility only.
  95
  96 =item B<ssl3.h>
  97
  98 That's the sub header file dealing with the SSLv3 protocol only.
  99 I<Usually you don't have to include it explicitly because
 100 it's already included by ssl.h>.
 101
 102 =item B<tls1.h>
 103
 104 That's the sub header file dealing with the TLSv1 protocol only.
 105 I<Usually you don't have to include it explicitly because
 106 it's already included by ssl.h>.
 107
 108 =back
 109
 110 =head1 API FUNCTIONS
 111
 112 Currently the OpenSSL B<ssl> library exports 214 API functions.
 113 They are documented in the following:
 114
 115 =head2 Dealing with Protocol Methods
 116
 117 Here we document the various API functions which deal with the SSL/TLS
 118 protocol methods defined in B<SSL_METHOD> structures.
 119
 120 =over 4
 121
 122 =item const SSL_METHOD *B<TLS_method>(void);
 123
 124 Constructor for the I<version-flexible> SSL_METHOD structure for clients,
 125 servers or both.
 126 See L<SSL_CTX_new(3)> for details.
 127
 128 =item const SSL_METHOD *B<TLS_client_method>(void);
 129
 130 Constructor for the I<version-flexible> SSL_METHOD structure for clients.
 131
 132 =item const SSL_METHOD *B<TLS_server_method>(void);
 133
 134 Constructor for the I<version-flexible> SSL_METHOD structure for servers.
 135
 136 =item const SSL_METHOD *B<TLSv1_2_method>(void);
 137
 138 Constructor for the TLSv1.2 SSL_METHOD structure for clients, servers or both.
 139
 140 =item const SSL_METHOD *B<TLSv1_2_client_method>(void);
 141
 142 Constructor for the TLSv1.2 SSL_METHOD structure for clients.
 143
 144 =item const SSL_METHOD *B<TLSv1_2_server_method>(void);
 145
 146 Constructor for the TLSv1.2 SSL_METHOD structure for servers.
 147
 148 =item const SSL_METHOD *B<TLSv1_1_method>(void);
 149
 150 Constructor for the TLSv1.1 SSL_METHOD structure for clients, servers or both.
 151
 152 =item const SSL_METHOD *B<TLSv1_1_client_method>(void);
 153
 154 Constructor for the TLSv1.1 SSL_METHOD structure for clients.
 155
 156 =item const SSL_METHOD *B<TLSv1_1_server_method>(void);
 157
 158 Constructor for the TLSv1.1 SSL_METHOD structure for servers.
 159
 160 =item const SSL_METHOD *B<TLSv1_method>(void);
 161
 162 Constructor for the TLSv1 SSL_METHOD structure for clients, servers or both.
 163
 164 =item const SSL_METHOD *B<TLSv1_client_method>(void);
 165
 166 Constructor for the TLSv1 SSL_METHOD structure for clients.
 167
 168 =item const SSL_METHOD *B<TLSv1_server_method>(void);
 169
 170 Constructor for the TLSv1 SSL_METHOD structure for servers.
 171
 172 =item const SSL_METHOD *B<SSLv3_method>(void);
 173
 174 Constructor for the SSLv3 SSL_METHOD structure for clients, servers or both.
 175
 176 =item const SSL_METHOD *B<SSLv3_client_method>(void);
 177
 178 Constructor for the SSLv3 SSL_METHOD structure for clients.
 179
 180 =item const SSL_METHOD *B<SSLv3_server_method>(void);
 181
 182 Constructor for the SSLv3 SSL_METHOD structure for servers.
 183
 184 =back
 185
 186 =head2 Dealing with Ciphers
 187
 188 Here we document the various API functions which deal with the SSL/TLS
 189 ciphers defined in B<SSL_CIPHER> structures.
 190
 191 =over 4
 192
 193 =item char *B<SSL_CIPHER_description>(SSL_CIPHER *cipher, char *buf, int len);
 194
 195 Write a string to I<buf> (with a maximum size of I<len>) containing a human
 196 readable description of I<cipher>. Returns I<buf>.
 197
 198 =item int B<SSL_CIPHER_get_bits>(SSL_CIPHER *cipher, int *alg_bits);
 199
 200 Determine the number of bits in I<cipher>. Because of export crippled ciphers
 201 there are two bits: The bits the algorithm supports in general (stored to
 202 I<alg_bits>) and the bits which are actually used (the return value).
 203
 204 =item const char *B<SSL_CIPHER_get_name>(SSL_CIPHER *cipher);
 205
 206 Return the internal name of I<cipher> as a string. These are the various
 207 strings defined by the I<SSL3_TXT_xxx> and I<TLS1_TXT_xxx>
 208 definitions in the header files.
 209
 210 =item const char *B<SSL_CIPHER_get_version>(SSL_CIPHER *cipher);
 211
 212 Returns a string like "C<SSLv3>" or "C<TLSv1.2>" which indicates the
 213 SSL/TLS protocol version to which I<cipher> belongs (i.e. where it was defined
 214 in the specification the first time).
 215
 216 =back
 217
 218 =head2 Dealing with Protocol Contexts
 219
 220 Here we document the various API functions which deal with the SSL/TLS
 221 protocol context defined in the B<SSL_CTX> structure.
 222
 223 =over 4
 224
 225 =item int B<SSL_CTX_add_client_CA>(SSL_CTX *ctx, X509 *x);
 226
 227 =item long B<SSL_CTX_add_extra_chain_cert>(SSL_CTX *ctx, X509 *x509);
 228
 229 =item int B<SSL_CTX_add_session>(SSL_CTX *ctx, SSL_SESSION *c);
 230
 231 =item int B<SSL_CTX_check_private_key>(const SSL_CTX *ctx);
 232
 233 =item long B<SSL_CTX_ctrl>(SSL_CTX *ctx, int cmd, long larg, char *parg);
 234
 235 =item void B<SSL_CTX_flush_sessions>(SSL_CTX *s, long t);
 236
 237 =item void B<SSL_CTX_free>(SSL_CTX *a);
 238
 239 =item char *B<SSL_CTX_get_app_data>(SSL_CTX *ctx);
 240
 241 =item X509_STORE *B<SSL_CTX_get_cert_store>(SSL_CTX *ctx);
 242
 243 =item STACK *B<SSL_CTX_get_ciphers>(const SSL_CTX *ctx);
 244
 245 =item STACK *B<SSL_CTX_get_client_CA_list>(const SSL_CTX *ctx);
 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
 251 =item char *B<SSL_CTX_get_ex_data>(const SSL_CTX *s, int idx);
 252
 253 =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))
 254
 255 =item void (*B<SSL_CTX_get_info_callback>(SSL_CTX *ctx))(SSL *ssl, int cb, int ret);
 256
 257 =item int B<SSL_CTX_get_quiet_shutdown>(const SSL_CTX *ctx);
 258
 259 =item void B<SSL_CTX_get_read_ahead>(SSL_CTX *ctx);
 260
 261 =item int B<SSL_CTX_get_session_cache_mode>(SSL_CTX *ctx);
 262
 263 =item long B<SSL_CTX_get_timeout>(const SSL_CTX *ctx);
 264
 265 =item int (*B<SSL_CTX_get_verify_callback>(const SSL_CTX *ctx))(int ok, X509_STORE_CTX *ctx);
 266
 267 =item int B<SSL_CTX_get_verify_mode>(SSL_CTX *ctx);
 268
 269 =item int B<SSL_CTX_load_verify_locations>(SSL_CTX *ctx, const char *CAfile, const char *CApath);
 270
 271 =item SSL_CTX *B<SSL_CTX_new>(const SSL_METHOD *meth);
 272
 273 =item int SSL_CTX_up_ref(SSL_CTX *ctx);
 274
 275 =item int B<SSL_CTX_remove_session>(SSL_CTX *ctx, SSL_SESSION *c);
 276
 277 =item int B<SSL_CTX_sess_accept>(SSL_CTX *ctx);
 278
 279 =item int B<SSL_CTX_sess_accept_good>(SSL_CTX *ctx);
 280
 281 =item int B<SSL_CTX_sess_accept_renegotiate>(SSL_CTX *ctx);
 282
 283 =item int B<SSL_CTX_sess_cache_full>(SSL_CTX *ctx);
 284
 285 =item int B<SSL_CTX_sess_cb_hits>(SSL_CTX *ctx);
 286
 287 =item int B<SSL_CTX_sess_connect>(SSL_CTX *ctx);
 288
 289 =item int B<SSL_CTX_sess_connect_good>(SSL_CTX *ctx);
 290
 291 =item int B<SSL_CTX_sess_connect_renegotiate>(SSL_CTX *ctx);
 292
 293 =item int B<SSL_CTX_sess_get_cache_size>(SSL_CTX *ctx);
 294
 295 =item SSL_SESSION *(*B<SSL_CTX_sess_get_get_cb>(SSL_CTX *ctx))(SSL *ssl, unsigned char *data, int len, int *copy);
 296
 297 =item int (*B<SSL_CTX_sess_get_new_cb>(SSL_CTX *ctx)(SSL *ssl, SSL_SESSION *sess);
 298
 299 =item void (*B<SSL_CTX_sess_get_remove_cb>(SSL_CTX *ctx)(SSL_CTX *ctx, SSL_SESSION *sess);
 300
 301 =item int B<SSL_CTX_sess_hits>(SSL_CTX *ctx);
 302
 303 =item int B<SSL_CTX_sess_misses>(SSL_CTX *ctx);
 304
 305 =item int B<SSL_CTX_sess_number>(SSL_CTX *ctx);
 306
 307 =item void B<SSL_CTX_sess_set_cache_size>(SSL_CTX *ctx, t);
 308
 309 =item void B<SSL_CTX_sess_set_get_cb>(SSL_CTX *ctx, SSL_SESSION *(*cb)(SSL *ssl, unsigned char *data, int len, int *copy));
 310
 311 =item void B<SSL_CTX_sess_set_new_cb>(SSL_CTX *ctx, int (*cb)(SSL *ssl, SSL_SESSION *sess));
 312
 313 =item void B<SSL_CTX_sess_set_remove_cb>(SSL_CTX *ctx, void (*cb)(SSL_CTX *ctx, SSL_SESSION *sess));
 314
 315 =item int B<SSL_CTX_sess_timeouts>(SSL_CTX *ctx);
 316
 317 =item LHASH *B<SSL_CTX_sessions>(SSL_CTX *ctx);
 318
 319 =item int B<SSL_CTX_set_app_data>(SSL_CTX *ctx, void *arg);
 320
 321 =item void B<SSL_CTX_set_cert_store>(SSL_CTX *ctx, X509_STORE *cs);
 322
 323 =item void B<SSL_CTX_set1_cert_store>(SSL_CTX *ctx, X509_STORE *cs);
 324
 325 =item void B<SSL_CTX_set_cert_verify_cb>(SSL_CTX *ctx, int (*cb)(), char *arg)
 326
 327 =item int B<SSL_CTX_set_cipher_list>(SSL_CTX *ctx, char *str);
 328
 329 =item void B<SSL_CTX_set_client_CA_list>(SSL_CTX *ctx, STACK *list);
 330
 331 =item void B<SSL_CTX_set_client_cert_cb>(SSL_CTX *ctx, int (*cb)(SSL *ssl, X509 **x509, EVP_PKEY **pkey));
 332
 333 =item int B<SSL_CTX_set_ct_validation_callback>(SSL_CTX *ctx, ssl_ct_validation_cb callback, void *arg);
 334
 335 =item void B<SSL_CTX_set_default_passwd_cb>(SSL_CTX *ctx, int (*cb);(void))
 336
 337 =item void B<SSL_CTX_set_default_read_ahead>(SSL_CTX *ctx, int m);
 338
 339 =item int B<SSL_CTX_set_default_verify_paths>(SSL_CTX *ctx);
 340
 341 Use the default paths to locate trusted CA certificates. There is one default
 342 directory path and one default file path. Both are set via this call.
 343
 344 =item int B<SSL_CTX_set_default_verify_dir>(SSL_CTX *ctx)
 345
 346 Use the default directory path to locate trusted CA certificates.
 347
 348 =item int B<SSL_CTX_set_default_verify_file>(SSL_CTX *ctx)
 349
 350 Use the file path to locate trusted CA certificates.
 351
 352 =item int B<SSL_CTX_set_ex_data>(SSL_CTX *s, int idx, char *arg);
 353
 354 =item void B<SSL_CTX_set_info_callback>(SSL_CTX *ctx, void (*cb)(SSL *ssl, int cb, int ret));
 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));
 357
 358 =item void B<SSL_CTX_set_msg_callback_arg>(SSL_CTX *ctx, void *arg);
 359
 360 =item unsigned long B<SSL_CTX_clear_options>(SSL_CTX *ctx, unsigned long op);
 361
 362 =item unsigned long B<SSL_CTX_get_options>(SSL_CTX *ctx);
 363
 364 =item unsigned long B<SSL_CTX_set_options>(SSL_CTX *ctx, unsigned long op);
 365
 366 =item void B<SSL_CTX_set_quiet_shutdown>(SSL_CTX *ctx, int mode);
 367
 368 =item void B<SSL_CTX_set_read_ahead>(SSL_CTX *ctx, int m);
 369
 370 =item void B<SSL_CTX_set_session_cache_mode>(SSL_CTX *ctx, int mode);
 371
 372 =item int B<SSL_CTX_set_ssl_version>(SSL_CTX *ctx, const SSL_METHOD *meth);
 373
 374 =item void B<SSL_CTX_set_timeout>(SSL_CTX *ctx, long t);
 375
 376 =item long B<SSL_CTX_set_tmp_dh>(SSL_CTX* ctx, DH *dh);
 377
 378 =item long B<SSL_CTX_set_tmp_dh_callback>(SSL_CTX *ctx, DH *(*cb)(void));
 379
 380 =item void B<SSL_CTX_set_verify>(SSL_CTX *ctx, int mode, int (*cb);(void))
 381
 382 =item int B<SSL_CTX_use_PrivateKey>(SSL_CTX *ctx, EVP_PKEY *pkey);
 383
 384 =item int B<SSL_CTX_use_PrivateKey_ASN1>(int type, SSL_CTX *ctx, unsigned char *d, long len);
 385
 386 =item int B<SSL_CTX_use_PrivateKey_file>(SSL_CTX *ctx, const char *file, int type);
 387
 388 =item int B<SSL_CTX_use_RSAPrivateKey>(SSL_CTX *ctx, RSA *rsa);
 389
 390 =item int B<SSL_CTX_use_RSAPrivateKey_ASN1>(SSL_CTX *ctx, unsigned char *d, long len);
 391
 392 =item int B<SSL_CTX_use_RSAPrivateKey_file>(SSL_CTX *ctx, const char *file, int type);
 393
 394 =item int B<SSL_CTX_use_certificate>(SSL_CTX *ctx, X509 *x);
 395
 396 =item int B<SSL_CTX_use_certificate_ASN1>(SSL_CTX *ctx, int len, unsigned char *d);
 397
 398 =item int B<SSL_CTX_use_certificate_file>(SSL_CTX *ctx, const char *file, int type);
 399
 400 =item X509 *B<SSL_CTX_get0_certificate>(const SSL_CTX *ctx);
 401
 402 =item EVP_PKEY *B<SSL_CTX_get0_privatekey>(const SSL_CTX *ctx);
 403
 404 =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));
 405
 406 =item int B<SSL_CTX_use_psk_identity_hint>(SSL_CTX *ctx, const char *hint);
 407
 408 =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));
 409
 410
 411 =back
 412
 413 =head2 Dealing with Sessions
 414
 415 Here we document the various API functions which deal with the SSL/TLS
 416 sessions defined in the B<SSL_SESSION> structures.
 417
 418 =over 4
 419
 420 =item int B<SSL_SESSION_cmp>(const SSL_SESSION *a, const SSL_SESSION *b);
 421
 422 =item void B<SSL_SESSION_free>(SSL_SESSION *ss);
 423
 424 =item char *B<SSL_SESSION_get_app_data>(SSL_SESSION *s);
 425
 426 =item char *B<SSL_SESSION_get_ex_data>(const SSL_SESSION *s, int idx);
 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
 430 =item long B<SSL_SESSION_get_time>(const SSL_SESSION *s);
 431
 432 =item long B<SSL_SESSION_get_timeout>(const SSL_SESSION *s);
 433
 434 =item unsigned long B<SSL_SESSION_hash>(const SSL_SESSION *a);
 435
 436 =item SSL_SESSION *B<SSL_SESSION_new>(void);
 437
 438 =item int B<SSL_SESSION_print>(BIO *bp, const SSL_SESSION *x);
 439
 440 =item int B<SSL_SESSION_print_fp>(FILE *fp, const SSL_SESSION *x);
 441
 442 =item int B<SSL_SESSION_set_app_data>(SSL_SESSION *s, char *a);
 443
 444 =item int B<SSL_SESSION_set_ex_data>(SSL_SESSION *s, int idx, char *arg);
 445
 446 =item long B<SSL_SESSION_set_time>(SSL_SESSION *s, long t);
 447
 448 =item long B<SSL_SESSION_set_timeout>(SSL_SESSION *s, long t);
 449
 450 =back
 451
 452 =head2 Dealing with Connections
 453
 454 Here we document the various API functions which deal with the SSL/TLS
 455 connection defined in the B<SSL> structure.
 456
 457 =over 4
 458
 459 =item int B<SSL_accept>(SSL *ssl);
 460
 461 =item int B<SSL_add_dir_cert_subjects_to_stack>(STACK *stack, const char *dir);
 462
 463 =item int B<SSL_add_file_cert_subjects_to_stack>(STACK *stack, const char *file);
 464
 465 =item int B<SSL_add_client_CA>(SSL *ssl, X509 *x);
 466
 467 =item char *B<SSL_alert_desc_string>(int value);
 468
 469 =item char *B<SSL_alert_desc_string_long>(int value);
 470
 471 =item char *B<SSL_alert_type_string>(int value);
 472
 473 =item char *B<SSL_alert_type_string_long>(int value);
 474
 475 =item int B<SSL_check_private_key>(const SSL *ssl);
 476
 477 =item void B<SSL_clear>(SSL *ssl);
 478
 479 =item long B<SSL_clear_num_renegotiations>(SSL *ssl);
 480
 481 =item int B<SSL_connect>(SSL *ssl);
 482
 483 =item int B<SSL_copy_session_id>(SSL *t, const SSL *f);
 484
 485 Sets the session details for B<t> to be the same as in B<f>. Returns 1 on
 486 success or 0 on failure.
 487
 488 =item long B<SSL_ctrl>(SSL *ssl, int cmd, long larg, char *parg);
 489
 490 =item int B<SSL_do_handshake>(SSL *ssl);
 491
 492 =item SSL *B<SSL_dup>(SSL *ssl);
 493
 494 SSL_dup() allows applications to configure an SSL handle for use
 495 in multiple SSL connections, and then duplicate it prior to initiating
 496 each connection with the duplicated handle.
 497 Use of SSL_dup() avoids the need to repeat the configuration of the
 498 handles for each connection.
 499 This is used internally by L<BIO_s_accept(3)> to construct
 500 per-connection SSL handles after L<accept(2)>.
 501
 502 For SSL_dup() to work, the connection MUST be in its initial state
 503 and MUST NOT have not yet have started the SSL handshake.
 504 For connections that are not in their initial state SSL_dup() just
 505 increments an internal reference count and returns the I<same>
 506 handle.
 507 It may be possible to use L<SSL_clear(3)> to recycle an SSL handle
 508 that is not in its initial state for re-use, but this is best
 509 avoided.
 510 Instead, save and restore the session, if desired, and construct a
 511 fresh handle for each connection.
 512
 513 =item STACK *B<SSL_dup_CA_list>(STACK *sk);
 514
 515 =item void B<SSL_free>(SSL *ssl);
 516
 517 =item SSL_CTX *B<SSL_get_SSL_CTX>(const SSL *ssl);
 518
 519 =item char *B<SSL_get_app_data>(SSL *ssl);
 520
 521 =item X509 *B<SSL_get_certificate>(const SSL *ssl);
 522
 523 =item const char *B<SSL_get_cipher>(const SSL *ssl);
 524
 525 =item int B<SSL_is_dtls>(const SSL *ssl);
 526
 527 =item int B<SSL_get_cipher_bits>(const SSL *ssl, int *alg_bits);
 528
 529 =item char *B<SSL_get_cipher_list>(const SSL *ssl, int n);
 530
 531 =item char *B<SSL_get_cipher_name>(const SSL *ssl);
 532
 533 =item char *B<SSL_get_cipher_version>(const SSL *ssl);
 534
 535 =item STACK *B<SSL_get_ciphers>(const SSL *ssl);
 536
 537 =item STACK *B<SSL_get_client_CA_list>(const SSL *ssl);
 538
 539 =item SSL_CIPHER *B<SSL_get_current_cipher>(SSL *ssl);
 540
 541 =item long B<SSL_get_default_timeout>(const SSL *ssl);
 542
 543 =item int B<SSL_get_error>(const SSL *ssl, int i);
 544
 545 =item char *B<SSL_get_ex_data>(const SSL *ssl, int idx);
 546
 547 =item int B<SSL_get_ex_data_X509_STORE_CTX_idx>(void);
 548
 549 =item int B<SSL_get_ex_new_index>(long argl, char *argp, int (*new_func);(void), int (*dup_func)(void), void (*free_func)(void))
 550
 551 =item int B<SSL_get_fd>(const SSL *ssl);
 552
 553 =item void (*B<SSL_get_info_callback>(const SSL *ssl);)()
 554
 555 =item STACK *B<SSL_get_peer_cert_chain>(const SSL *ssl);
 556
 557 =item X509 *B<SSL_get_peer_certificate>(const SSL *ssl);
 558
 559 =item const STACK_OF(SCT) *B<SSL_get0_peer_scts>(SSL *s);
 560
 561 =item EVP_PKEY *B<SSL_get_privatekey>(const SSL *ssl);
 562
 563 =item int B<SSL_get_quiet_shutdown>(const SSL *ssl);
 564
 565 =item BIO *B<SSL_get_rbio>(const SSL *ssl);
 566
 567 =item int B<SSL_get_read_ahead>(const SSL *ssl);
 568
 569 =item SSL_SESSION *B<SSL_get_session>(const SSL *ssl);
 570
 571 =item char *B<SSL_get_shared_ciphers>(const SSL *ssl, char *buf, int len);
 572
 573 =item int B<SSL_get_shutdown>(const SSL *ssl);
 574
 575 =item const SSL_METHOD *B<SSL_get_ssl_method>(SSL *ssl);
 576
 577 =item int B<SSL_get_state>(const SSL *ssl);
 578
 579 =item long B<SSL_get_time>(const SSL *ssl);
 580
 581 =item long B<SSL_get_timeout>(const SSL *ssl);
 582
 583 =item int (*B<SSL_get_verify_callback>(const SSL *ssl))(int, X509_STORE_CTX *)
 584
 585 =item int B<SSL_get_verify_mode>(const SSL *ssl);
 586
 587 =item long B<SSL_get_verify_result>(const SSL *ssl);
 588
 589 =item char *B<SSL_get_version>(const SSL *ssl);
 590
 591 =item BIO *B<SSL_get_wbio>(const SSL *ssl);
 592
 593 =item int B<SSL_in_accept_init>(SSL *ssl);
 594
 595 =item int B<SSL_in_before>(SSL *ssl);
 596
 597 =item int B<SSL_in_connect_init>(SSL *ssl);
 598
 599 =item int B<SSL_in_init>(SSL *ssl);
 600
 601 =item int B<SSL_is_init_finished>(SSL *ssl);
 602
 603 =item STACK *B<SSL_load_client_CA_file>(const char *file);
 604
 605 =item SSL *B<SSL_new>(SSL_CTX *ctx);
 606
 607 =item int SSL_up_ref(SSL *s);
 608
 609 =item long B<SSL_num_renegotiations>(SSL *ssl);
 610
 611 =item int B<SSL_peek>(SSL *ssl, void *buf, int num);
 612
 613 =item int B<SSL_pending>(const SSL *ssl);
 614
 615 =item int B<SSL_read>(SSL *ssl, void *buf, int num);
 616
 617 =item int B<SSL_renegotiate>(SSL *ssl);
 618
 619 =item char *B<SSL_rstate_string>(SSL *ssl);
 620
 621 =item char *B<SSL_rstate_string_long>(SSL *ssl);
 622
 623 =item long B<SSL_session_reused>(SSL *ssl);
 624
 625 =item void B<SSL_set_accept_state>(SSL *ssl);
 626
 627 =item void B<SSL_set_app_data>(SSL *ssl, char *arg);
 628
 629 =item void B<SSL_set_bio>(SSL *ssl, BIO *rbio, BIO *wbio);
 630
 631 =item int B<SSL_set_cipher_list>(SSL *ssl, char *str);
 632
 633 =item void B<SSL_set_client_CA_list>(SSL *ssl, STACK *list);
 634
 635 =item void B<SSL_set_connect_state>(SSL *ssl);
 636
 637 =item int B<SSL_set_ct_validation_callback>(SSL *ssl, ssl_ct_validation_cb callback, void *arg);
 638
 639 =item int B<SSL_set_ex_data>(SSL *ssl, int idx, char *arg);
 640
 641 =item int B<SSL_set_fd>(SSL *ssl, int fd);
 642
 643 =item void B<SSL_set_info_callback>(SSL *ssl, void (*cb);(void))
 644
 645 =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));
 646
 647 =item void B<SSL_set_msg_callback_arg>(SSL *ctx, void *arg);
 648
 649 =item unsigned long B<SSL_clear_options>(SSL *ssl, unsigned long op);
 650
 651 =item unsigned long B<SSL_get_options>(SSL *ssl);
 652
 653 =item unsigned long B<SSL_set_options>(SSL *ssl, unsigned long op);
 654
 655 =item void B<SSL_set_quiet_shutdown>(SSL *ssl, int mode);
 656
 657 =item void B<SSL_set_read_ahead>(SSL *ssl, int yes);
 658
 659 =item int B<SSL_set_rfd>(SSL *ssl, int fd);
 660
 661 =item int B<SSL_set_session>(SSL *ssl, SSL_SESSION *session);
 662
 663 =item void B<SSL_set_shutdown>(SSL *ssl, int mode);
 664
 665 =item int B<SSL_set_ssl_method>(SSL *ssl, const SSL_METHOD *meth);
 666
 667 =item void B<SSL_set_time>(SSL *ssl, long t);
 668
 669 =item void B<SSL_set_timeout>(SSL *ssl, long t);
 670
 671 =item void B<SSL_set_verify>(SSL *ssl, int mode, int (*callback);(void))
 672
 673 =item void B<SSL_set_verify_result>(SSL *ssl, long arg);
 674
 675 =item int B<SSL_set_wfd>(SSL *ssl, int fd);
 676
 677 =item int B<SSL_shutdown>(SSL *ssl);
 678
 679 =item OSSL_HANDSHAKE_STATE B<SSL_get_state>(const SSL *ssl);
 680
 681 Returns the current handshake state.
 682
 683 =item char *B<SSL_state_string>(const SSL *ssl);
 684
 685 =item char *B<SSL_state_string_long>(const SSL *ssl);
 686
 687 =item long B<SSL_total_renegotiations>(SSL *ssl);
 688
 689 =item int B<SSL_use_PrivateKey>(SSL *ssl, EVP_PKEY *pkey);
 690
 691 =item int B<SSL_use_PrivateKey_ASN1>(int type, SSL *ssl, unsigned char *d, long len);
 692
 693 =item int B<SSL_use_PrivateKey_file>(SSL *ssl, const char *file, int type);
 694
 695 =item int B<SSL_use_RSAPrivateKey>(SSL *ssl, RSA *rsa);
 696
 697 =item int B<SSL_use_RSAPrivateKey_ASN1>(SSL *ssl, unsigned char *d, long len);
 698
 699 =item int B<SSL_use_RSAPrivateKey_file>(SSL *ssl, const char *file, int type);
 700
 701 =item int B<SSL_use_certificate>(SSL *ssl, X509 *x);
 702
 703 =item int B<SSL_use_certificate_ASN1>(SSL *ssl, int len, unsigned char *d);
 704
 705 =item int B<SSL_use_certificate_file>(SSL *ssl, const char *file, int type);
 706
 707 =item int B<SSL_version>(const SSL *ssl);
 708
 709 =item int B<SSL_want>(const SSL *ssl);
 710
 711 =item int B<SSL_want_nothing>(const SSL *ssl);
 712
 713 =item int B<SSL_want_read>(const SSL *ssl);
 714
 715 =item int B<SSL_want_write>(const SSL *ssl);
 716
 717 =item int B<SSL_want_x509_lookup>(const SSL *ssl);
 718
 719 =item int B<SSL_write>(SSL *ssl, const void *buf, int num);
 720
 721 =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));
 722
 723 =item int B<SSL_use_psk_identity_hint>(SSL *ssl, const char *hint);
 724
 725 =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));
 726
 727 =item const char *B<SSL_get_psk_identity_hint>(SSL *ssl);
 728
 729 =item const char *B<SSL_get_psk_identity>(SSL *ssl);
 730
 731 =back
 732
 733 =head1 RETURN VALUES
 734
 735 See the individual manual pages for details.
 736
 737 =head1 SEE ALSO
 738
 739 L<openssl(1)>, L<crypto(3)>,
 740 L<CRYPTO_get_ex_new_index(3)>,
 741 L<SSL_accept(3)>, L<SSL_clear(3)>,
 742 L<SSL_connect(3)>,
 743 L<SSL_CIPHER_get_name(3)>,
 744 L<SSL_COMP_add_compression_method(3)>,
 745 L<SSL_CTX_add_extra_chain_cert(3)>,
 746 L<SSL_CTX_add_session(3)>,
 747 L<SSL_CTX_ctrl(3)>,
 748 L<SSL_CTX_flush_sessions(3)>,
 749 L<SSL_CTX_get_verify_mode(3)>,
 750 L<SSL_CTX_load_verify_locations(3)>
 751 L<SSL_CTX_new(3)>,
 752 L<SSL_CTX_sess_number(3)>,
 753 L<SSL_CTX_sess_set_cache_size(3)>,
 754 L<SSL_CTX_sess_set_get_cb(3)>,
 755 L<SSL_CTX_sessions(3)>,
 756 L<SSL_CTX_set_cert_store(3)>,
 757 L<SSL_CTX_set_cert_verify_callback(3)>,
 758 L<SSL_CTX_set_cipher_list(3)>,
 759 L<SSL_CTX_set_client_CA_list(3)>,
 760 L<SSL_CTX_set_client_cert_cb(3)>,
 761 L<SSL_CTX_set_default_passwd_cb(3)>,
 762 L<SSL_CTX_set_generate_session_id(3)>,
 763 L<SSL_CTX_set_info_callback(3)>,
 764 L<SSL_CTX_set_max_cert_list(3)>,
 765 L<SSL_CTX_set_mode(3)>,
 766 L<SSL_CTX_set_msg_callback(3)>,
 767 L<SSL_CTX_set_options(3)>,
 768 L<SSL_CTX_set_quiet_shutdown(3)>,
 769 L<SSL_CTX_set_read_ahead(3)>,
 770 L<SSL_CTX_set_session_cache_mode(3)>,
 771 L<SSL_CTX_set_session_id_context(3)>,
 772 L<SSL_CTX_set_ssl_version(3)>,
 773 L<SSL_CTX_set_timeout(3)>,
 774 L<SSL_CTX_set_tmp_dh_callback(3)>,
 775 L<SSL_CTX_set_verify(3)>,
 776 L<SSL_CTX_use_certificate(3)>,
 777 L<SSL_alert_type_string(3)>,
 778 L<SSL_do_handshake(3)>,
 779 L<SSL_enable_ct(3)>,
 780 L<SSL_get_SSL_CTX(3)>,
 781 L<SSL_get_ciphers(3)>,
 782 L<SSL_get_client_CA_list(3)>,
 783 L<SSL_get_default_timeout(3)>,
 784 L<SSL_get_error(3)>,
 785 L<SSL_get_ex_data_X509_STORE_CTX_idx(3)>,
 786 L<SSL_get_fd(3)>,
 787 L<SSL_get_peer_cert_chain(3)>,
 788 L<SSL_get_rbio(3)>,
 789 L<SSL_get_session(3)>,
 790 L<SSL_get_verify_result(3)>,
 791 L<SSL_get_version(3)>,
 792 L<SSL_load_client_CA_file(3)>,
 793 L<SSL_new(3)>,
 794 L<SSL_pending(3)>,
 795 L<SSL_read_ex(3)>,
 796 L<SSL_read(3)>,
 797 L<SSL_rstate_string(3)>,
 798 L<SSL_session_reused(3)>,
 799 L<SSL_set_bio(3)>,
 800 L<SSL_set_connect_state(3)>,
 801 L<SSL_set_fd(3)>,
 802 L<SSL_set_session(3)>,
 803 L<SSL_set_shutdown(3)>,
 804 L<SSL_shutdown(3)>,
 805 L<SSL_state_string(3)>,
 806 L<SSL_want(3)>,
 807 L<SSL_write_ex(3)>,
 808 L<SSL_write(3)>,
 809 L<SSL_SESSION_free(3)>,
 810 L<SSL_SESSION_get_time(3)>,
 811 L<d2i_SSL_SESSION(3)>,
 812 L<SSL_CTX_set_psk_client_callback(3)>,
 813 L<SSL_CTX_use_psk_identity_hint(3)>,
 814 L<SSL_get_psk_identity(3)>,
 815 L<DTLSv1_listen(3)>
 816
 817 =head1 HISTORY
 818
 819 B<SSLv2_client_method>, B<SSLv2_server_method> and B<SSLv2_method> where removed
 820 in OpenSSL 1.1.0.
 821
 822 The return type of B<SSL_copy_session_id> was changed from void to int in
 823 OpenSSL 1.1.0.
 824
 825 =head1 COPYRIGHT
 826
 827 Copyright 2000-2016 The OpenSSL Project Authors. All Rights Reserved.
 828
 829 Licensed under the OpenSSL license (the "License").  You may not use
 830 this file except in compliance with the License.  You can obtain a copy
 831 in the file LICENSE in the source distribution or at
 832 L<https://www.openssl.org/source/license.html>.
 833
 834 =cut