6 SSL - OpenSSL SSL/TLS library
12 The OpenSSL B<ssl> library implements the Secure Sockets Layer (SSL v2/v3) and
13 Transport Layer Security (TLS v1) protocols. It provides a rich API which is
16 Then an B<SSL_CTX> object is created as a framework to establish
17 TLS/SSL enabled connections (see L<SSL_CTX_new(3)>).
18 Various options regarding certificates, algorithms etc. can be set
21 When a network connection has been created, it can be assigned to an
22 B<SSL> object. After the B<SSL> object has been created using
23 L<SSL_new(3)>, L<SSL_set_fd(3)> or
24 L<SSL_set_bio(3)> can be used to associate the network
25 connection with the object.
27 Then the TLS/SSL handshake is performed using
28 L<SSL_accept(3)> or L<SSL_connect(3)>
30 L<SSL_read(3)> and L<SSL_write(3)> are used
31 to read and write data on the TLS/SSL connection.
32 L<SSL_shutdown(3)> can be used to shut down the
35 =head1 DATA STRUCTURES
37 Currently the OpenSSL B<ssl> library functions deals with the following data
42 =item B<SSL_METHOD> (SSL Method)
44 That's a dispatch structure describing the internal B<ssl> library
45 methods/functions which implement the various protocol versions (SSLv3
46 TLSv1, ...). It's needed to create an B<SSL_CTX>.
48 =item B<SSL_CIPHER> (SSL Cipher)
50 This structure holds the algorithm information for a particular cipher which
51 are a core part of the SSL/TLS protocol. The available ciphers are configured
52 on a B<SSL_CTX> basis and the actually used ones are then part of the
55 =item B<SSL_CTX> (SSL Context)
57 That's the global context structure which is created by a server or client
58 once per program life-time and which holds mainly default values for the
59 B<SSL> structures which are later created for the connections.
61 =item B<SSL_SESSION> (SSL Session)
63 This is a structure containing the current TLS/SSL session details for a
64 connection: B<SSL_CIPHER>s, client and server certificates, keys, etc.
66 =item B<SSL> (SSL Connection)
68 That's the main SSL/TLS structure which is created by a server or client per
69 established connection. This actually is the core structure in the SSL API.
70 Under run-time the application usually deals with this structure which has
71 links to mostly all other structures.
78 Currently the OpenSSL B<ssl> library provides the following C header files
79 containing the prototypes for the data structures and functions:
85 That's the common header file for the SSL/TLS API. Include it into your
86 program to make the API of the B<ssl> library available. It internally
87 includes both more private SSL headers and headers from the B<crypto> library.
88 Whenever you need hard-core details on the internals of the SSL API, look
89 inside this header file.
93 Unused. Present for backwards compatibility only.
97 That's the sub header file dealing with the SSLv3 protocol only.
98 I<Usually you don't have to include it explicitly because
99 it's already included by ssl.h>.
103 That's the sub header file dealing with the TLSv1 protocol only.
104 I<Usually you don't have to include it explicitly because
105 it's already included by ssl.h>.
111 Currently the OpenSSL B<ssl> library exports 214 API functions.
112 They are documented in the following:
114 =head2 DEALING WITH PROTOCOL METHODS
116 Here we document the various API functions which deal with the SSL/TLS
117 protocol methods defined in B<SSL_METHOD> structures.
121 =item const SSL_METHOD *B<TLS_method>(void);
123 Constructor for the I<version-flexible> SSL_METHOD structure for clients,
125 See L<SSL_CTX_new(3)> for details.
127 =item const SSL_METHOD *B<TLS_client_method>(void);
129 Constructor for the I<version-flexible> SSL_METHOD structure for clients.
131 =item const SSL_METHOD *B<TLS_server_method>(void);
133 Constructor for the I<version-flexible> SSL_METHOD structure for servers.
135 =item const SSL_METHOD *B<TLSv1_2_method>(void);
137 Constructor for the TLSv1.2 SSL_METHOD structure for clients, servers or both.
139 =item const SSL_METHOD *B<TLSv1_2_client_method>(void);
141 Constructor for the TLSv1.2 SSL_METHOD structure for clients.
143 =item const SSL_METHOD *B<TLSv1_2_server_method>(void);
145 Constructor for the TLSv1.2 SSL_METHOD structure for servers.
147 =item const SSL_METHOD *B<TLSv1_1_method>(void);
149 Constructor for the TLSv1.1 SSL_METHOD structure for clients, servers or both.
151 =item const SSL_METHOD *B<TLSv1_1_client_method>(void);
153 Constructor for the TLSv1.1 SSL_METHOD structure for clients.
155 =item const SSL_METHOD *B<TLSv1_1_server_method>(void);
157 Constructor for the TLSv1.1 SSL_METHOD structure for servers.
159 =item const SSL_METHOD *B<TLSv1_method>(void);
161 Constructor for the TLSv1 SSL_METHOD structure for clients, servers or both.
163 =item const SSL_METHOD *B<TLSv1_client_method>(void);
165 Constructor for the TLSv1 SSL_METHOD structure for clients.
167 =item const SSL_METHOD *B<TLSv1_server_method>(void);
169 Constructor for the TLSv1 SSL_METHOD structure for servers.
171 =item const SSL_METHOD *B<SSLv3_method>(void);
173 Constructor for the SSLv3 SSL_METHOD structure for clients, servers or both.
175 =item const SSL_METHOD *B<SSLv3_client_method>(void);
177 Constructor for the SSLv3 SSL_METHOD structure for clients.
179 =item const SSL_METHOD *B<SSLv3_server_method>(void);
181 Constructor for the SSLv3 SSL_METHOD structure for servers.
185 =head2 DEALING WITH CIPHERS
187 Here we document the various API functions which deal with the SSL/TLS
188 ciphers defined in B<SSL_CIPHER> structures.
192 =item char *B<SSL_CIPHER_description>(SSL_CIPHER *cipher, char *buf, int len);
194 Write a string to I<buf> (with a maximum size of I<len>) containing a human
195 readable description of I<cipher>. Returns I<buf>.
197 =item int B<SSL_CIPHER_get_bits>(SSL_CIPHER *cipher, int *alg_bits);
199 Determine the number of bits in I<cipher>. Because of export crippled ciphers
200 there are two bits: The bits the algorithm supports in general (stored to
201 I<alg_bits>) and the bits which are actually used (the return value).
203 =item const char *B<SSL_CIPHER_get_name>(SSL_CIPHER *cipher);
205 Return the internal name of I<cipher> as a string. These are the various
206 strings defined by the I<SSL3_TXT_xxx> and I<TLS1_TXT_xxx>
207 definitions in the header files.
209 =item const char *B<SSL_CIPHER_get_version>(SSL_CIPHER *cipher);
211 Returns a string like "C<SSLv3>" or "C<TLSv1.2>" which indicates the
212 SSL/TLS protocol version to which I<cipher> belongs (i.e. where it was defined
213 in the specification the first time).
217 =head2 DEALING WITH PROTOCOL CONTEXTS
219 Here we document the various API functions which deal with the SSL/TLS
220 protocol context defined in the B<SSL_CTX> structure.
224 =item int B<SSL_CTX_add_client_CA>(SSL_CTX *ctx, X509 *x);
226 =item long B<SSL_CTX_add_extra_chain_cert>(SSL_CTX *ctx, X509 *x509);
228 =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);
232 =item long B<SSL_CTX_ctrl>(SSL_CTX *ctx, int cmd, long larg, char *parg);
234 =item void B<SSL_CTX_flush_sessions>(SSL_CTX *s, long t);
236 =item void B<SSL_CTX_free>(SSL_CTX *a);
238 =item char *B<SSL_CTX_get_app_data>(SSL_CTX *ctx);
240 =item X509_STORE *B<SSL_CTX_get_cert_store>(SSL_CTX *ctx);
242 =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);
246 =item int (*B<SSL_CTX_get_client_cert_cb>(SSL_CTX *ctx))(SSL *ssl, X509 **x509, EVP_PKEY **pkey);
248 =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);
252 =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 =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);
258 =item void B<SSL_CTX_get_read_ahead>(SSL_CTX *ctx);
260 =item int B<SSL_CTX_get_session_cache_mode>(SSL_CTX *ctx);
262 =item long B<SSL_CTX_get_timeout>(const SSL_CTX *ctx);
264 =item int (*B<SSL_CTX_get_verify_callback>(const SSL_CTX *ctx))(int ok, X509_STORE_CTX *ctx);
266 =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);
270 =item long B<SSL_CTX_need_tmp_RSA>(SSL_CTX *ctx);
272 =item SSL_CTX *B<SSL_CTX_new>(const SSL_METHOD *meth);
274 =item int SSL_CTX_up_ref(SSL_CTX *ctx);
276 =item int B<SSL_CTX_remove_session>(SSL_CTX *ctx, SSL_SESSION *c);
278 =item int B<SSL_CTX_sess_accept>(SSL_CTX *ctx);
280 =item int B<SSL_CTX_sess_accept_good>(SSL_CTX *ctx);
282 =item int B<SSL_CTX_sess_accept_renegotiate>(SSL_CTX *ctx);
284 =item int B<SSL_CTX_sess_cache_full>(SSL_CTX *ctx);
286 =item int B<SSL_CTX_sess_cb_hits>(SSL_CTX *ctx);
288 =item int B<SSL_CTX_sess_connect>(SSL_CTX *ctx);
290 =item int B<SSL_CTX_sess_connect_good>(SSL_CTX *ctx);
292 =item int B<SSL_CTX_sess_connect_renegotiate>(SSL_CTX *ctx);
294 =item int B<SSL_CTX_sess_get_cache_size>(SSL_CTX *ctx);
296 =item SSL_SESSION *(*B<SSL_CTX_sess_get_get_cb>(SSL_CTX *ctx))(SSL *ssl, unsigned char *data, int len, int *copy);
298 =item int (*B<SSL_CTX_sess_get_new_cb>(SSL_CTX *ctx)(SSL *ssl, SSL_SESSION *sess);
300 =item void (*B<SSL_CTX_sess_get_remove_cb>(SSL_CTX *ctx)(SSL_CTX *ctx, SSL_SESSION *sess);
302 =item int B<SSL_CTX_sess_hits>(SSL_CTX *ctx);
304 =item int B<SSL_CTX_sess_misses>(SSL_CTX *ctx);
306 =item int B<SSL_CTX_sess_number>(SSL_CTX *ctx);
308 =item void B<SSL_CTX_sess_set_cache_size>(SSL_CTX *ctx,t);
310 =item void B<SSL_CTX_sess_set_get_cb>(SSL_CTX *ctx, SSL_SESSION *(*cb)(SSL *ssl, unsigned char *data, int len, int *copy));
312 =item void B<SSL_CTX_sess_set_new_cb>(SSL_CTX *ctx, int (*cb)(SSL *ssl, SSL_SESSION *sess));
314 =item void B<SSL_CTX_sess_set_remove_cb>(SSL_CTX *ctx, void (*cb)(SSL_CTX *ctx, SSL_SESSION *sess));
316 =item int B<SSL_CTX_sess_timeouts>(SSL_CTX *ctx);
318 =item LHASH *B<SSL_CTX_sessions>(SSL_CTX *ctx);
320 =item void B<SSL_CTX_set_app_data>(SSL_CTX *ctx, void *arg);
322 =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)
326 =item int B<SSL_CTX_set_cipher_list>(SSL_CTX *ctx, char *str);
328 =item void B<SSL_CTX_set_client_CA_list>(SSL_CTX *ctx, STACK *list);
330 =item void B<SSL_CTX_set_client_cert_cb>(SSL_CTX *ctx, int (*cb)(SSL *ssl, X509 **x509, EVP_PKEY **pkey));
332 =item void B<SSL_CTX_set_default_passwd_cb>(SSL_CTX *ctx, int (*cb);(void))
334 =item void B<SSL_CTX_set_default_read_ahead>(SSL_CTX *ctx, int m);
336 =item int B<SSL_CTX_set_default_verify_paths>(SSL_CTX *ctx);
338 Use the default paths to locate trusted CA certificates. There is one default
339 directory path and one default file path. Both are set via this call.
341 =item int B<SSL_CTX_set_default_verify_dir>(SSL_CTX *ctx)
343 Use the default directory path to locate trusted CA certificates.
345 =item int B<SSL_CTX_set_default_verify_file>(SSL_CTX *ctx)
347 Use the file path to locate trusted CA certificates.
349 =item int B<SSL_CTX_set_ex_data>(SSL_CTX *s, int idx, char *arg);
351 =item void B<SSL_CTX_set_info_callback>(SSL_CTX *ctx, void (*cb)(SSL *ssl, int cb, int ret));
353 =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));
355 =item void B<SSL_CTX_set_msg_callback_arg>(SSL_CTX *ctx, void *arg);
357 =item unsigned long B<SSL_CTX_clear_options>(SSL_CTX *ctx, unsigned long op);
359 =item unsigned long B<SSL_CTX_get_options>(SSL_CTX *ctx);
361 =item unsigned long B<SSL_CTX_set_options>(SSL_CTX *ctx, unsigned long op);
363 =item void B<SSL_CTX_set_quiet_shutdown>(SSL_CTX *ctx, int mode);
365 =item void B<SSL_CTX_set_read_ahead>(SSL_CTX *ctx, int m);
367 =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);
371 =item void B<SSL_CTX_set_timeout>(SSL_CTX *ctx, long t);
373 =item long B<SSL_CTX_set_tmp_dh>(SSL_CTX* ctx, DH *dh);
375 =item long B<SSL_CTX_set_tmp_dh_callback>(SSL_CTX *ctx, DH *(*cb)(void));
377 =item void B<SSL_CTX_set_verify>(SSL_CTX *ctx, int mode, int (*cb);(void))
379 =item int B<SSL_CTX_use_PrivateKey>(SSL_CTX *ctx, EVP_PKEY *pkey);
381 =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);
385 =item int B<SSL_CTX_use_RSAPrivateKey>(SSL_CTX *ctx, RSA *rsa);
387 =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);
391 =item int B<SSL_CTX_use_certificate>(SSL_CTX *ctx, X509 *x);
393 =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);
397 =item X509 *B<SSL_CTX_get0_certificate>(const SSL_CTX *ctx);
399 =item EVP_PKEY *B<SSL_CTX_get0_privatekey>(const SSL_CTX *ctx);
401 =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));
403 =item int B<SSL_CTX_use_psk_identity_hint>(SSL_CTX *ctx, const char *hint);
405 =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));
412 =head2 DEALING WITH SESSIONS
414 Here we document the various API functions which deal with the SSL/TLS
415 sessions defined in the B<SSL_SESSION> structures.
419 =item int B<SSL_SESSION_cmp>(const SSL_SESSION *a, const SSL_SESSION *b);
421 =item void B<SSL_SESSION_free>(SSL_SESSION *ss);
423 =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);
427 =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);
431 =item long B<SSL_SESSION_get_timeout>(const SSL_SESSION *s);
433 =item unsigned long B<SSL_SESSION_hash>(const SSL_SESSION *a);
435 =item SSL_SESSION *B<SSL_SESSION_new>(void);
437 =item int B<SSL_SESSION_print>(BIO *bp, const SSL_SESSION *x);
439 =item int B<SSL_SESSION_print_fp>(FILE *fp, const SSL_SESSION *x);
441 =item void B<SSL_SESSION_set_app_data>(SSL_SESSION *s, char *a);
443 =item int B<SSL_SESSION_set_ex_data>(SSL_SESSION *s, int idx, char *arg);
445 =item long B<SSL_SESSION_set_time>(SSL_SESSION *s, long t);
447 =item long B<SSL_SESSION_set_timeout>(SSL_SESSION *s, long t);
451 =head2 DEALING WITH CONNECTIONS
453 Here we document the various API functions which deal with the SSL/TLS
454 connection defined in the B<SSL> structure.
458 =item int B<SSL_accept>(SSL *ssl);
460 =item int B<SSL_add_dir_cert_subjects_to_stack>(STACK *stack, const char *dir);
462 =item int B<SSL_add_file_cert_subjects_to_stack>(STACK *stack, const char *file);
464 =item int B<SSL_add_client_CA>(SSL *ssl, X509 *x);
466 =item char *B<SSL_alert_desc_string>(int value);
468 =item char *B<SSL_alert_desc_string_long>(int value);
470 =item char *B<SSL_alert_type_string>(int value);
472 =item char *B<SSL_alert_type_string_long>(int value);
474 =item int B<SSL_check_private_key>(const SSL *ssl);
476 =item void B<SSL_clear>(SSL *ssl);
478 =item long B<SSL_clear_num_renegotiations>(SSL *ssl);
480 =item int B<SSL_connect>(SSL *ssl);
482 =item int B<SSL_copy_session_id>(SSL *t, const SSL *f);
484 Sets the session details for B<t> to be the same as in B<f>. Returns 1 on
485 success or 0 on failure.
487 =item long B<SSL_ctrl>(SSL *ssl, int cmd, long larg, char *parg);
489 =item int B<SSL_do_handshake>(SSL *ssl);
491 =item SSL *B<SSL_dup>(SSL *ssl);
493 SSL_dup() allows applications to configure an SSL handle for use
494 in multiple SSL connections, and then duplicate it prior to initiating
495 each connection with the duplicated handle.
496 Use of SSL_dup() avoids the need to repeat the configuration of the
497 handles for each connection.
498 This is used internally by L<BIO_s_accept(3)> to construct
499 per-connection SSL handles after L<accept(2)>.
501 For SSL_dup() to work, the connection MUST be in its initial state
502 and MUST NOT have not yet have started the SSL handshake.
503 For connections that are not in their initial state SSL_dup() just
504 increments an internal reference count and returns the I<same>
506 It may be possible to use L<SSL_clear(3)> to recycle an SSL handle
507 that is not in its initial state for re-use, but this is best
509 Instead, save and restore the session, if desired, and construct a
510 fresh handle for each connection.
512 =item STACK *B<SSL_dup_CA_list>(STACK *sk);
514 =item void B<SSL_free>(SSL *ssl);
516 =item SSL_CTX *B<SSL_get_SSL_CTX>(const SSL *ssl);
518 =item char *B<SSL_get_app_data>(SSL *ssl);
520 =item X509 *B<SSL_get_certificate>(const SSL *ssl);
522 =item const char *B<SSL_get_cipher>(const SSL *ssl);
524 =item int B<SSL_get_cipher_bits>(const SSL *ssl, int *alg_bits);
526 =item char *B<SSL_get_cipher_list>(const SSL *ssl, int n);
528 =item char *B<SSL_get_cipher_name>(const SSL *ssl);
530 =item char *B<SSL_get_cipher_version>(const SSL *ssl);
532 =item STACK *B<SSL_get_ciphers>(const SSL *ssl);
534 =item STACK *B<SSL_get_client_CA_list>(const SSL *ssl);
536 =item SSL_CIPHER *B<SSL_get_current_cipher>(SSL *ssl);
538 =item long B<SSL_get_default_timeout>(const SSL *ssl);
540 =item int B<SSL_get_error>(const SSL *ssl, int i);
542 =item char *B<SSL_get_ex_data>(const SSL *ssl, int idx);
544 =item int B<SSL_get_ex_data_X509_STORE_CTX_idx>(void);
546 =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);
550 =item void (*B<SSL_get_info_callback>(const SSL *ssl);)()
552 =item STACK *B<SSL_get_peer_cert_chain>(const SSL *ssl);
554 =item X509 *B<SSL_get_peer_certificate>(const SSL *ssl);
556 =item EVP_PKEY *B<SSL_get_privatekey>(const SSL *ssl);
558 =item int B<SSL_get_quiet_shutdown>(const SSL *ssl);
560 =item BIO *B<SSL_get_rbio>(const SSL *ssl);
562 =item int B<SSL_get_read_ahead>(const SSL *ssl);
564 =item SSL_SESSION *B<SSL_get_session>(const SSL *ssl);
566 =item char *B<SSL_get_shared_ciphers>(const SSL *ssl, char *buf, int len);
568 =item int B<SSL_get_shutdown>(const SSL *ssl);
570 =item const SSL_METHOD *B<SSL_get_ssl_method>(SSL *ssl);
572 =item int B<SSL_get_state>(const SSL *ssl);
574 =item long B<SSL_get_time>(const SSL *ssl);
576 =item long B<SSL_get_timeout>(const SSL *ssl);
578 =item int (*B<SSL_get_verify_callback>(const SSL *ssl))(int,X509_STORE_CTX *)
580 =item int B<SSL_get_verify_mode>(const SSL *ssl);
582 =item long B<SSL_get_verify_result>(const SSL *ssl);
584 =item char *B<SSL_get_version>(const SSL *ssl);
586 =item BIO *B<SSL_get_wbio>(const SSL *ssl);
588 =item int B<SSL_in_accept_init>(SSL *ssl);
590 =item int B<SSL_in_before>(SSL *ssl);
592 =item int B<SSL_in_connect_init>(SSL *ssl);
594 =item int B<SSL_in_init>(SSL *ssl);
596 =item int B<SSL_is_init_finished>(SSL *ssl);
598 =item STACK *B<SSL_load_client_CA_file>(const char *file);
600 =item SSL *B<SSL_new>(SSL_CTX *ctx);
602 =item int SSL_up_ref(SSL *s);
604 =item long B<SSL_num_renegotiations>(SSL *ssl);
606 =item int B<SSL_peek>(SSL *ssl, void *buf, int num);
608 =item int B<SSL_pending>(const SSL *ssl);
610 =item int B<SSL_read>(SSL *ssl, void *buf, int num);
612 =item int B<SSL_renegotiate>(SSL *ssl);
614 =item char *B<SSL_rstate_string>(SSL *ssl);
616 =item char *B<SSL_rstate_string_long>(SSL *ssl);
618 =item long B<SSL_session_reused>(SSL *ssl);
620 =item void B<SSL_set_accept_state>(SSL *ssl);
622 =item void B<SSL_set_app_data>(SSL *ssl, char *arg);
624 =item void B<SSL_set_bio>(SSL *ssl, BIO *rbio, BIO *wbio);
626 =item int B<SSL_set_cipher_list>(SSL *ssl, char *str);
628 =item void B<SSL_set_client_CA_list>(SSL *ssl, STACK *list);
630 =item void B<SSL_set_connect_state>(SSL *ssl);
632 =item int B<SSL_set_ex_data>(SSL *ssl, int idx, char *arg);
634 =item int B<SSL_set_fd>(SSL *ssl, int fd);
636 =item void B<SSL_set_info_callback>(SSL *ssl, void (*cb);(void))
638 =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));
640 =item void B<SSL_set_msg_callback_arg>(SSL *ctx, void *arg);
642 =item unsigned long B<SSL_clear_options>(SSL *ssl, unsigned long op);
644 =item unsigned long B<SSL_get_options>(SSL *ssl);
646 =item unsigned long B<SSL_set_options>(SSL *ssl, unsigned long op);
648 =item void B<SSL_set_quiet_shutdown>(SSL *ssl, int mode);
650 =item void B<SSL_set_read_ahead>(SSL *ssl, int yes);
652 =item int B<SSL_set_rfd>(SSL *ssl, int fd);
654 =item int B<SSL_set_session>(SSL *ssl, SSL_SESSION *session);
656 =item void B<SSL_set_shutdown>(SSL *ssl, int mode);
658 =item int B<SSL_set_ssl_method>(SSL *ssl, const SSL_METHOD *meth);
660 =item void B<SSL_set_time>(SSL *ssl, long t);
662 =item void B<SSL_set_timeout>(SSL *ssl, long t);
664 =item void B<SSL_set_verify>(SSL *ssl, int mode, int (*callback);(void))
666 =item void B<SSL_set_verify_result>(SSL *ssl, long arg);
668 =item int B<SSL_set_wfd>(SSL *ssl, int fd);
670 =item int B<SSL_shutdown>(SSL *ssl);
672 =item OSSL_HANDSHAKE_STATE B<SSL_get_state>(const SSL *ssl);
674 Returns the current handshake state.
676 =item char *B<SSL_state_string>(const SSL *ssl);
678 =item char *B<SSL_state_string_long>(const SSL *ssl);
680 =item long B<SSL_total_renegotiations>(SSL *ssl);
682 =item int B<SSL_use_PrivateKey>(SSL *ssl, EVP_PKEY *pkey);
684 =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);
688 =item int B<SSL_use_RSAPrivateKey>(SSL *ssl, RSA *rsa);
690 =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);
694 =item int B<SSL_use_certificate>(SSL *ssl, X509 *x);
696 =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);
700 =item int B<SSL_version>(const SSL *ssl);
702 =item int B<SSL_want>(const SSL *ssl);
704 =item int B<SSL_want_nothing>(const SSL *ssl);
706 =item int B<SSL_want_read>(const SSL *ssl);
708 =item int B<SSL_want_write>(const SSL *ssl);
710 =item int B<SSL_want_x509_lookup>(const SSL *ssl);
712 =item int B<SSL_write>(SSL *ssl, const void *buf, int num);
714 =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));
716 =item int B<SSL_use_psk_identity_hint>(SSL *ssl, const char *hint);
718 =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));
720 =item const char *B<SSL_get_psk_identity_hint>(SSL *ssl);
722 =item const char *B<SSL_get_psk_identity>(SSL *ssl);
728 L<openssl(1)>, L<crypto(3)>,
729 L<CRYPTO_get_ex_new_index(3)>,
730 L<SSL_accept(3)>, L<SSL_clear(3)>,
732 L<SSL_CIPHER_get_name(3)>,
733 L<SSL_COMP_add_compression_method(3)>,
734 L<SSL_CTX_add_extra_chain_cert(3)>,
735 L<SSL_CTX_add_session(3)>,
737 L<SSL_CTX_flush_sessions(3)>,
738 L<SSL_CTX_get_verify_mode(3)>,
739 L<SSL_CTX_load_verify_locations(3)>
741 L<SSL_CTX_sess_number(3)>,
742 L<SSL_CTX_sess_set_cache_size(3)>,
743 L<SSL_CTX_sess_set_get_cb(3)>,
744 L<SSL_CTX_sessions(3)>,
745 L<SSL_CTX_set_cert_store(3)>,
746 L<SSL_CTX_set_cert_verify_callback(3)>,
747 L<SSL_CTX_set_cipher_list(3)>,
748 L<SSL_CTX_set_client_CA_list(3)>,
749 L<SSL_CTX_set_client_cert_cb(3)>,
750 L<SSL_CTX_set_default_passwd_cb(3)>,
751 L<SSL_CTX_set_generate_session_id(3)>,
752 L<SSL_CTX_set_info_callback(3)>,
753 L<SSL_CTX_set_max_cert_list(3)>,
754 L<SSL_CTX_set_mode(3)>,
755 L<SSL_CTX_set_msg_callback(3)>,
756 L<SSL_CTX_set_options(3)>,
757 L<SSL_CTX_set_quiet_shutdown(3)>,
758 L<SSL_CTX_set_read_ahead(3)>,
759 L<SSL_CTX_set_session_cache_mode(3)>,
760 L<SSL_CTX_set_session_id_context(3)>,
761 L<SSL_CTX_set_ssl_version(3)>,
762 L<SSL_CTX_set_timeout(3)>,
763 L<SSL_CTX_set_tmp_dh_callback(3)>,
764 L<SSL_CTX_set_verify(3)>,
765 L<SSL_CTX_use_certificate(3)>,
766 L<SSL_alert_type_string(3)>,
767 L<SSL_do_handshake(3)>,
768 L<SSL_get_SSL_CTX(3)>,
769 L<SSL_get_ciphers(3)>,
770 L<SSL_get_client_CA_list(3)>,
771 L<SSL_get_default_timeout(3)>,
773 L<SSL_get_ex_data_X509_STORE_CTX_idx(3)>,
775 L<SSL_get_peer_cert_chain(3)>,
777 L<SSL_get_session(3)>,
778 L<SSL_get_verify_result(3)>,
779 L<SSL_get_version(3)>,
780 L<SSL_load_client_CA_file(3)>,
784 L<SSL_rstate_string(3)>,
785 L<SSL_session_reused(3)>,
787 L<SSL_set_connect_state(3)>,
789 L<SSL_set_session(3)>,
790 L<SSL_set_shutdown(3)>,
792 L<SSL_state_string(3)>,
795 L<SSL_SESSION_free(3)>,
796 L<SSL_SESSION_get_time(3)>,
797 L<d2i_SSL_SESSION(3)>,
798 L<SSL_CTX_set_psk_client_callback(3)>,
799 L<SSL_CTX_use_psk_identity_hint(3)>,
800 L<SSL_get_psk_identity(3)>,
805 B<SSLv2_client_method>, B<SSLv2_server_method> and B<SSLv2_method> where removed
808 The return type of B<SSL_copy_session_id> was changed from void to int in