doc/ssl/ssl.pod

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