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 At first the library must be initialized; see
17 L<SSL_library_init(3)>.
19 Then an B<SSL_CTX> object is created as a framework to establish
20 TLS/SSL enabled connections (see L<SSL_CTX_new(3)>).
21 Various options regarding certificates, algorithms etc. can be set
24 When a network connection has been created, it can be assigned to an
25 B<SSL> object. After the B<SSL> object has been created using
26 L<SSL_new(3)>, L<SSL_set_fd(3)> or
27 L<SSL_set_bio(3)> can be used to associate the network
28 connection with the object.
30 Then the TLS/SSL handshake is performed using
31 L<SSL_accept(3)> or L<SSL_connect(3)>
33 L<SSL_read(3)> and L<SSL_write(3)> are used
34 to read and write data on the TLS/SSL connection.
35 L<SSL_shutdown(3)> can be used to shut down the
38 =head1 DATA STRUCTURES
40 Currently the OpenSSL B<ssl> library functions deals with the following data
45 =item B<SSL_METHOD> (SSL Method)
47 That's a dispatch structure describing the internal B<ssl> library
48 methods/functions which implement the various protocol versions (SSLv3
49 TLSv1, ...). It's needed to create an B<SSL_CTX>.
51 =item B<SSL_CIPHER> (SSL Cipher)
53 This structure holds the algorithm information for a particular cipher which
54 are a core part of the SSL/TLS protocol. The available ciphers are configured
55 on a B<SSL_CTX> basis and the actually used ones are then part of the
58 =item B<SSL_CTX> (SSL Context)
60 That's the global context structure which is created by a server or client
61 once per program life-time and which holds mainly default values for the
62 B<SSL> structures which are later created for the connections.
64 =item B<SSL_SESSION> (SSL Session)
66 This is a structure containing the current TLS/SSL session details for a
67 connection: B<SSL_CIPHER>s, client and server certificates, keys, etc.
69 =item B<SSL> (SSL Connection)
71 That's the main SSL/TLS structure which is created by a server or client per
72 established connection. This actually is the core structure in the SSL API.
73 Under run-time the application usually deals with this structure which has
74 links to mostly all other structures.
81 Currently the OpenSSL B<ssl> library provides the following C header files
82 containing the prototypes for the data structures and and functions:
88 That's the common header file for the SSL/TLS API. Include it into your
89 program to make the API of the B<ssl> library available. It internally
90 includes both more private SSL headers and headers from the B<crypto> library.
91 Whenever you need hard-core details on the internals of the SSL API, look
92 inside this header file.
96 That's the sub header file dealing with the SSLv2 protocol only.
97 I<Usually you don't have to include it explicitly because
98 it's already included by ssl.h>.
102 That's the sub header file dealing with the SSLv3 protocol only.
103 I<Usually you don't have to include it explicitly because
104 it's already included by ssl.h>.
108 That's the sub header file dealing with the TLSv1 protocol only.
109 I<Usually you don't have to include it explicitly because
110 it's already included by ssl.h>.
116 Currently the OpenSSL B<ssl> library exports 214 API functions.
117 They are documented in the following:
119 =head2 DEALING WITH PROTOCOL METHODS
121 Here we document the various API functions which deal with the SSL/TLS
122 protocol methods defined in B<SSL_METHOD> structures.
126 =item const SSL_METHOD *B<SSLv3_client_method>(void);
128 Constructor for the SSLv3 SSL_METHOD structure for a dedicated client.
130 =item const SSL_METHOD *B<SSLv3_server_method>(void);
132 Constructor for the SSLv3 SSL_METHOD structure for a dedicated server.
134 =item const SSL_METHOD *B<SSLv3_method>(void);
136 Constructor for the SSLv3 SSL_METHOD structure for combined client and server.
138 =item const SSL_METHOD *B<TLSv1_client_method>(void);
140 Constructor for the TLSv1 SSL_METHOD structure for a dedicated client.
142 =item const SSL_METHOD *B<TLSv1_server_method>(void);
144 Constructor for the TLSv1 SSL_METHOD structure for a dedicated server.
146 =item const SSL_METHOD *B<TLSv1_method>(void);
148 Constructor for the TLSv1 SSL_METHOD structure for combined client and server.
152 =head2 DEALING WITH CIPHERS
154 Here we document the various API functions which deal with the SSL/TLS
155 ciphers defined in B<SSL_CIPHER> structures.
159 =item char *B<SSL_CIPHER_description>(SSL_CIPHER *cipher, char *buf, int len);
161 Write a string to I<buf> (with a maximum size of I<len>) containing a human
162 readable description of I<cipher>. Returns I<buf>.
164 =item int B<SSL_CIPHER_get_bits>(SSL_CIPHER *cipher, int *alg_bits);
166 Determine the number of bits in I<cipher>. Because of export crippled ciphers
167 there are two bits: The bits the algorithm supports in general (stored to
168 I<alg_bits>) and the bits which are actually used (the return value).
170 =item const char *B<SSL_CIPHER_get_name>(SSL_CIPHER *cipher);
172 Return the internal name of I<cipher> as a string. These are the various
173 strings defined by the I<SSL3_TXT_xxx> and I<TLS1_TXT_xxx>
174 definitions in the header files.
176 =item char *B<SSL_CIPHER_get_version>(SSL_CIPHER *cipher);
178 Returns a string like "C<TLSv1/SSLv3>" or "C<SSLv2>" which indicates the
179 SSL/TLS protocol version to which I<cipher> belongs (i.e. where it was defined
180 in the specification the first time).
184 =head2 DEALING WITH PROTOCOL CONTEXTS
186 Here we document the various API functions which deal with the SSL/TLS
187 protocol context defined in the B<SSL_CTX> structure.
191 =item int B<SSL_CTX_add_client_CA>(SSL_CTX *ctx, X509 *x);
193 =item long B<SSL_CTX_add_extra_chain_cert>(SSL_CTX *ctx, X509 *x509);
195 =item int B<SSL_CTX_add_session>(SSL_CTX *ctx, SSL_SESSION *c);
197 =item int B<SSL_CTX_check_private_key>(const SSL_CTX *ctx);
199 =item long B<SSL_CTX_ctrl>(SSL_CTX *ctx, int cmd, long larg, char *parg);
201 =item void B<SSL_CTX_flush_sessions>(SSL_CTX *s, long t);
203 =item void B<SSL_CTX_free>(SSL_CTX *a);
205 =item char *B<SSL_CTX_get_app_data>(SSL_CTX *ctx);
207 =item X509_STORE *B<SSL_CTX_get_cert_store>(SSL_CTX *ctx);
209 =item STACK *B<SSL_CTX_get_client_CA_list>(const SSL_CTX *ctx);
211 =item int (*B<SSL_CTX_get_client_cert_cb>(SSL_CTX *ctx))(SSL *ssl, X509 **x509, EVP_PKEY **pkey);
213 =item void B<SSL_CTX_get_default_read_ahead>(SSL_CTX *ctx);
215 =item char *B<SSL_CTX_get_ex_data>(const SSL_CTX *s, int idx);
217 =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))
219 =item void (*B<SSL_CTX_get_info_callback>(SSL_CTX *ctx))(SSL *ssl, int cb, int ret);
221 =item int B<SSL_CTX_get_quiet_shutdown>(const SSL_CTX *ctx);
223 =item void B<SSL_CTX_get_read_ahead>(SSL_CTX *ctx);
225 =item int B<SSL_CTX_get_session_cache_mode>(SSL_CTX *ctx);
227 =item long B<SSL_CTX_get_timeout>(const SSL_CTX *ctx);
229 =item int (*B<SSL_CTX_get_verify_callback>(const SSL_CTX *ctx))(int ok, X509_STORE_CTX *ctx);
231 =item int B<SSL_CTX_get_verify_mode>(SSL_CTX *ctx);
233 =item int B<SSL_CTX_load_verify_locations>(SSL_CTX *ctx, char *CAfile, char *CApath);
235 =item long B<SSL_CTX_need_tmp_RSA>(SSL_CTX *ctx);
237 =item SSL_CTX *B<SSL_CTX_new>(const SSL_METHOD *meth);
239 =item int B<SSL_CTX_remove_session>(SSL_CTX *ctx, SSL_SESSION *c);
241 =item int B<SSL_CTX_sess_accept>(SSL_CTX *ctx);
243 =item int B<SSL_CTX_sess_accept_good>(SSL_CTX *ctx);
245 =item int B<SSL_CTX_sess_accept_renegotiate>(SSL_CTX *ctx);
247 =item int B<SSL_CTX_sess_cache_full>(SSL_CTX *ctx);
249 =item int B<SSL_CTX_sess_cb_hits>(SSL_CTX *ctx);
251 =item int B<SSL_CTX_sess_connect>(SSL_CTX *ctx);
253 =item int B<SSL_CTX_sess_connect_good>(SSL_CTX *ctx);
255 =item int B<SSL_CTX_sess_connect_renegotiate>(SSL_CTX *ctx);
257 =item int B<SSL_CTX_sess_get_cache_size>(SSL_CTX *ctx);
259 =item SSL_SESSION *(*B<SSL_CTX_sess_get_get_cb>(SSL_CTX *ctx))(SSL *ssl, unsigned char *data, int len, int *copy);
261 =item int (*B<SSL_CTX_sess_get_new_cb>(SSL_CTX *ctx)(SSL *ssl, SSL_SESSION *sess);
263 =item void (*B<SSL_CTX_sess_get_remove_cb>(SSL_CTX *ctx)(SSL_CTX *ctx, SSL_SESSION *sess);
265 =item int B<SSL_CTX_sess_hits>(SSL_CTX *ctx);
267 =item int B<SSL_CTX_sess_misses>(SSL_CTX *ctx);
269 =item int B<SSL_CTX_sess_number>(SSL_CTX *ctx);
271 =item void B<SSL_CTX_sess_set_cache_size>(SSL_CTX *ctx,t);
273 =item void B<SSL_CTX_sess_set_get_cb>(SSL_CTX *ctx, SSL_SESSION *(*cb)(SSL *ssl, unsigned char *data, int len, int *copy));
275 =item void B<SSL_CTX_sess_set_new_cb>(SSL_CTX *ctx, int (*cb)(SSL *ssl, SSL_SESSION *sess));
277 =item void B<SSL_CTX_sess_set_remove_cb>(SSL_CTX *ctx, void (*cb)(SSL_CTX *ctx, SSL_SESSION *sess));
279 =item int B<SSL_CTX_sess_timeouts>(SSL_CTX *ctx);
281 =item LHASH *B<SSL_CTX_sessions>(SSL_CTX *ctx);
283 =item void B<SSL_CTX_set_app_data>(SSL_CTX *ctx, void *arg);
285 =item void B<SSL_CTX_set_cert_store>(SSL_CTX *ctx, X509_STORE *cs);
287 =item void B<SSL_CTX_set_cert_verify_cb>(SSL_CTX *ctx, int (*cb)(), char *arg)
289 =item int B<SSL_CTX_set_cipher_list>(SSL_CTX *ctx, char *str);
291 =item void B<SSL_CTX_set_client_CA_list>(SSL_CTX *ctx, STACK *list);
293 =item void B<SSL_CTX_set_client_cert_cb>(SSL_CTX *ctx, int (*cb)(SSL *ssl, X509 **x509, EVP_PKEY **pkey));
295 =item void B<SSL_CTX_set_default_passwd_cb>(SSL_CTX *ctx, int (*cb);(void))
297 =item void B<SSL_CTX_set_default_read_ahead>(SSL_CTX *ctx, int m);
299 =item int B<SSL_CTX_set_default_verify_paths>(SSL_CTX *ctx);
301 Use the default paths to locate trusted CA certificates. There is one default
302 directory path and one default file path. Both are set via this call.
304 =item int B<SSL_CTX_set_default_verify_dir>(SSL_CTX *ctx)
306 Use the default directory path to locate trusted CA certficates.
308 =item int B<SSL_CTX_set_default_verify_file>(SSL_CTX *ctx)
310 Use the file path to locate trusted CA certficates.
312 =item int B<SSL_CTX_set_ex_data>(SSL_CTX *s, int idx, char *arg);
314 =item void B<SSL_CTX_set_info_callback>(SSL_CTX *ctx, void (*cb)(SSL *ssl, int cb, int ret));
316 =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));
318 =item void B<SSL_CTX_set_msg_callback_arg>(SSL_CTX *ctx, void *arg);
320 =item void B<SSL_CTX_set_options>(SSL_CTX *ctx, unsigned long op);
322 =item void B<SSL_CTX_set_quiet_shutdown>(SSL_CTX *ctx, int mode);
324 =item void B<SSL_CTX_set_read_ahead>(SSL_CTX *ctx, int m);
326 =item void B<SSL_CTX_set_session_cache_mode>(SSL_CTX *ctx, int mode);
328 =item int B<SSL_CTX_set_ssl_version>(SSL_CTX *ctx, const SSL_METHOD *meth);
330 =item void B<SSL_CTX_set_timeout>(SSL_CTX *ctx, long t);
332 =item long B<SSL_CTX_set_tmp_dh>(SSL_CTX* ctx, DH *dh);
334 =item long B<SSL_CTX_set_tmp_dh_callback>(SSL_CTX *ctx, DH *(*cb)(void));
336 =item long B<SSL_CTX_set_tmp_rsa>(SSL_CTX *ctx, RSA *rsa);
338 =item SSL_CTX_set_tmp_rsa_callback
340 C<long B<SSL_CTX_set_tmp_rsa_callback>(SSL_CTX *B<ctx>, RSA *(*B<cb>)(SSL *B<ssl>, int B<export>, int B<keylength>));>
342 Sets the callback which will be called when a temporary private key is
343 required. The B<C<export>> flag will be set if the reason for needing
344 a temp key is that an export ciphersuite is in use, in which case,
345 B<C<keylength>> will contain the required keylength in bits. Generate a key of
346 appropriate size (using ???) and return it.
348 =item SSL_set_tmp_rsa_callback
350 long B<SSL_set_tmp_rsa_callback>(SSL *ssl, RSA *(*cb)(SSL *ssl, int export, int keylength));
352 The same as B<SSL_CTX_set_tmp_rsa_callback>, except it operates on an SSL
353 session instead of a context.
355 =item void B<SSL_CTX_set_verify>(SSL_CTX *ctx, int mode, int (*cb);(void))
357 =item int B<SSL_CTX_use_PrivateKey>(SSL_CTX *ctx, EVP_PKEY *pkey);
359 =item int B<SSL_CTX_use_PrivateKey_ASN1>(int type, SSL_CTX *ctx, unsigned char *d, long len);
361 =item int B<SSL_CTX_use_PrivateKey_file>(SSL_CTX *ctx, char *file, int type);
363 =item int B<SSL_CTX_use_RSAPrivateKey>(SSL_CTX *ctx, RSA *rsa);
365 =item int B<SSL_CTX_use_RSAPrivateKey_ASN1>(SSL_CTX *ctx, unsigned char *d, long len);
367 =item int B<SSL_CTX_use_RSAPrivateKey_file>(SSL_CTX *ctx, char *file, int type);
369 =item int B<SSL_CTX_use_certificate>(SSL_CTX *ctx, X509 *x);
371 =item int B<SSL_CTX_use_certificate_ASN1>(SSL_CTX *ctx, int len, unsigned char *d);
373 =item int B<SSL_CTX_use_certificate_file>(SSL_CTX *ctx, char *file, int type);
375 =item X509 *B<SSL_CTX_get0_certificate>(const SSL_CTX *ctx);
377 =item EVP_PKEY *B<SSL_CTX_get0_privatekey>(const SSL_CTX *ctx);
379 =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));
381 =item int B<SSL_CTX_use_psk_identity_hint>(SSL_CTX *ctx, const char *hint);
383 =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));
390 =head2 DEALING WITH SESSIONS
392 Here we document the various API functions which deal with the SSL/TLS
393 sessions defined in the B<SSL_SESSION> structures.
397 =item int B<SSL_SESSION_cmp>(const SSL_SESSION *a, const SSL_SESSION *b);
399 =item void B<SSL_SESSION_free>(SSL_SESSION *ss);
401 =item char *B<SSL_SESSION_get_app_data>(SSL_SESSION *s);
403 =item char *B<SSL_SESSION_get_ex_data>(const SSL_SESSION *s, int idx);
405 =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))
407 =item long B<SSL_SESSION_get_time>(const SSL_SESSION *s);
409 =item long B<SSL_SESSION_get_timeout>(const SSL_SESSION *s);
411 =item unsigned long B<SSL_SESSION_hash>(const SSL_SESSION *a);
413 =item SSL_SESSION *B<SSL_SESSION_new>(void);
415 =item int B<SSL_SESSION_print>(BIO *bp, const SSL_SESSION *x);
417 =item int B<SSL_SESSION_print_fp>(FILE *fp, const SSL_SESSION *x);
419 =item void B<SSL_SESSION_set_app_data>(SSL_SESSION *s, char *a);
421 =item int B<SSL_SESSION_set_ex_data>(SSL_SESSION *s, int idx, char *arg);
423 =item long B<SSL_SESSION_set_time>(SSL_SESSION *s, long t);
425 =item long B<SSL_SESSION_set_timeout>(SSL_SESSION *s, long t);
429 =head2 DEALING WITH CONNECTIONS
431 Here we document the various API functions which deal with the SSL/TLS
432 connection defined in the B<SSL> structure.
436 =item int B<SSL_accept>(SSL *ssl);
438 =item int B<SSL_add_dir_cert_subjects_to_stack>(STACK *stack, const char *dir);
440 =item int B<SSL_add_file_cert_subjects_to_stack>(STACK *stack, const char *file);
442 =item int B<SSL_add_client_CA>(SSL *ssl, X509 *x);
444 =item char *B<SSL_alert_desc_string>(int value);
446 =item char *B<SSL_alert_desc_string_long>(int value);
448 =item char *B<SSL_alert_type_string>(int value);
450 =item char *B<SSL_alert_type_string_long>(int value);
452 =item int B<SSL_check_private_key>(const SSL *ssl);
454 =item void B<SSL_clear>(SSL *ssl);
456 =item long B<SSL_clear_num_renegotiations>(SSL *ssl);
458 =item int B<SSL_connect>(SSL *ssl);
460 =item int B<SSL_copy_session_id>(SSL *t, const SSL *f);
462 Sets the session details for B<t> to be the same as in B<f>. Returns 1 on
463 success or 0 on failure.
465 =item long B<SSL_ctrl>(SSL *ssl, int cmd, long larg, char *parg);
467 =item int B<SSL_do_handshake>(SSL *ssl);
469 =item SSL *B<SSL_dup>(SSL *ssl);
471 =item STACK *B<SSL_dup_CA_list>(STACK *sk);
473 =item void B<SSL_free>(SSL *ssl);
475 =item SSL_CTX *B<SSL_get_SSL_CTX>(const SSL *ssl);
477 =item char *B<SSL_get_app_data>(SSL *ssl);
479 =item X509 *B<SSL_get_certificate>(const SSL *ssl);
481 =item const char *B<SSL_get_cipher>(const SSL *ssl);
483 =item int B<SSL_get_cipher_bits>(const SSL *ssl, int *alg_bits);
485 =item char *B<SSL_get_cipher_list>(const SSL *ssl, int n);
487 =item char *B<SSL_get_cipher_name>(const SSL *ssl);
489 =item char *B<SSL_get_cipher_version>(const SSL *ssl);
491 =item STACK *B<SSL_get_ciphers>(const SSL *ssl);
493 =item STACK *B<SSL_get_client_CA_list>(const SSL *ssl);
495 =item SSL_CIPHER *B<SSL_get_current_cipher>(SSL *ssl);
497 =item long B<SSL_get_default_timeout>(const SSL *ssl);
499 =item int B<SSL_get_error>(const SSL *ssl, int i);
501 =item char *B<SSL_get_ex_data>(const SSL *ssl, int idx);
503 =item int B<SSL_get_ex_data_X509_STORE_CTX_idx>(void);
505 =item int B<SSL_get_ex_new_index>(long argl, char *argp, int (*new_func);(void), int (*dup_func)(void), void (*free_func)(void))
507 =item int B<SSL_get_fd>(const SSL *ssl);
509 =item void (*B<SSL_get_info_callback>(const SSL *ssl);)()
511 =item STACK *B<SSL_get_peer_cert_chain>(const SSL *ssl);
513 =item X509 *B<SSL_get_peer_certificate>(const SSL *ssl);
515 =item EVP_PKEY *B<SSL_get_privatekey>(const SSL *ssl);
517 =item int B<SSL_get_quiet_shutdown>(const SSL *ssl);
519 =item BIO *B<SSL_get_rbio>(const SSL *ssl);
521 =item int B<SSL_get_read_ahead>(const SSL *ssl);
523 =item SSL_SESSION *B<SSL_get_session>(const SSL *ssl);
525 =item char *B<SSL_get_shared_ciphers>(const SSL *ssl, char *buf, int len);
527 =item int B<SSL_get_shutdown>(const SSL *ssl);
529 =item const SSL_METHOD *B<SSL_get_ssl_method>(SSL *ssl);
531 =item int B<SSL_get_state>(const SSL *ssl);
533 =item long B<SSL_get_time>(const SSL *ssl);
535 =item long B<SSL_get_timeout>(const SSL *ssl);
537 =item int (*B<SSL_get_verify_callback>(const SSL *ssl))(int,X509_STORE_CTX *)
539 =item int B<SSL_get_verify_mode>(const SSL *ssl);
541 =item long B<SSL_get_verify_result>(const SSL *ssl);
543 =item char *B<SSL_get_version>(const SSL *ssl);
545 =item BIO *B<SSL_get_wbio>(const SSL *ssl);
547 =item int B<SSL_in_accept_init>(SSL *ssl);
549 =item int B<SSL_in_before>(SSL *ssl);
551 =item int B<SSL_in_connect_init>(SSL *ssl);
553 =item int B<SSL_in_init>(SSL *ssl);
555 =item int B<SSL_is_init_finished>(SSL *ssl);
557 =item STACK *B<SSL_load_client_CA_file>(char *file);
559 =item void B<SSL_load_error_strings>(void);
561 =item SSL *B<SSL_new>(SSL_CTX *ctx);
563 =item long B<SSL_num_renegotiations>(SSL *ssl);
565 =item int B<SSL_peek>(SSL *ssl, void *buf, int num);
567 =item int B<SSL_pending>(const SSL *ssl);
569 =item int B<SSL_read>(SSL *ssl, void *buf, int num);
571 =item int B<SSL_renegotiate>(SSL *ssl);
573 =item char *B<SSL_rstate_string>(SSL *ssl);
575 =item char *B<SSL_rstate_string_long>(SSL *ssl);
577 =item long B<SSL_session_reused>(SSL *ssl);
579 =item void B<SSL_set_accept_state>(SSL *ssl);
581 =item void B<SSL_set_app_data>(SSL *ssl, char *arg);
583 =item void B<SSL_set_bio>(SSL *ssl, BIO *rbio, BIO *wbio);
585 =item int B<SSL_set_cipher_list>(SSL *ssl, char *str);
587 =item void B<SSL_set_client_CA_list>(SSL *ssl, STACK *list);
589 =item void B<SSL_set_connect_state>(SSL *ssl);
591 =item int B<SSL_set_ex_data>(SSL *ssl, int idx, char *arg);
593 =item int B<SSL_set_fd>(SSL *ssl, int fd);
595 =item void B<SSL_set_info_callback>(SSL *ssl, void (*cb);(void))
597 =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));
599 =item void B<SSL_set_msg_callback_arg>(SSL *ctx, void *arg);
601 =item void B<SSL_set_options>(SSL *ssl, unsigned long op);
603 =item void B<SSL_set_quiet_shutdown>(SSL *ssl, int mode);
605 =item void B<SSL_set_read_ahead>(SSL *ssl, int yes);
607 =item int B<SSL_set_rfd>(SSL *ssl, int fd);
609 =item int B<SSL_set_session>(SSL *ssl, SSL_SESSION *session);
611 =item void B<SSL_set_shutdown>(SSL *ssl, int mode);
613 =item int B<SSL_set_ssl_method>(SSL *ssl, const SSL_METHOD *meth);
615 =item void B<SSL_set_time>(SSL *ssl, long t);
617 =item void B<SSL_set_timeout>(SSL *ssl, long t);
619 =item void B<SSL_set_verify>(SSL *ssl, int mode, int (*callback);(void))
621 =item void B<SSL_set_verify_result>(SSL *ssl, long arg);
623 =item int B<SSL_set_wfd>(SSL *ssl, int fd);
625 =item int B<SSL_shutdown>(SSL *ssl);
627 =item int B<SSL_state>(const SSL *ssl);
629 =item char *B<SSL_state_string>(const SSL *ssl);
631 =item char *B<SSL_state_string_long>(const SSL *ssl);
633 =item long B<SSL_total_renegotiations>(SSL *ssl);
635 =item int B<SSL_use_PrivateKey>(SSL *ssl, EVP_PKEY *pkey);
637 =item int B<SSL_use_PrivateKey_ASN1>(int type, SSL *ssl, unsigned char *d, long len);
639 =item int B<SSL_use_PrivateKey_file>(SSL *ssl, char *file, int type);
641 =item int B<SSL_use_RSAPrivateKey>(SSL *ssl, RSA *rsa);
643 =item int B<SSL_use_RSAPrivateKey_ASN1>(SSL *ssl, unsigned char *d, long len);
645 =item int B<SSL_use_RSAPrivateKey_file>(SSL *ssl, char *file, int type);
647 =item int B<SSL_use_certificate>(SSL *ssl, X509 *x);
649 =item int B<SSL_use_certificate_ASN1>(SSL *ssl, int len, unsigned char *d);
651 =item int B<SSL_use_certificate_file>(SSL *ssl, char *file, int type);
653 =item int B<SSL_version>(const SSL *ssl);
655 =item int B<SSL_want>(const SSL *ssl);
657 =item int B<SSL_want_nothing>(const SSL *ssl);
659 =item int B<SSL_want_read>(const SSL *ssl);
661 =item int B<SSL_want_write>(const SSL *ssl);
663 =item int B<SSL_want_x509_lookup>(const SSL *ssl);
665 =item int B<SSL_write>(SSL *ssl, const void *buf, int num);
667 =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));
669 =item int B<SSL_use_psk_identity_hint>(SSL *ssl, const char *hint);
671 =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));
673 =item const char *B<SSL_get_psk_identity_hint>(SSL *ssl);
675 =item const char *B<SSL_get_psk_identity>(SSL *ssl);
681 L<openssl(1)>, L<crypto(3)>,
682 L<SSL_accept(3)>, L<SSL_clear(3)>,
684 L<SSL_CIPHER_get_name(3)>,
685 L<SSL_COMP_add_compression_method(3)>,
686 L<SSL_CTX_add_extra_chain_cert(3)>,
687 L<SSL_CTX_add_session(3)>,
689 L<SSL_CTX_flush_sessions(3)>,
690 L<SSL_CTX_get_ex_new_index(3)>,
691 L<SSL_CTX_get_verify_mode(3)>,
692 L<SSL_CTX_load_verify_locations(3)>
694 L<SSL_CTX_sess_number(3)>,
695 L<SSL_CTX_sess_set_cache_size(3)>,
696 L<SSL_CTX_sess_set_get_cb(3)>,
697 L<SSL_CTX_sessions(3)>,
698 L<SSL_CTX_set_cert_store(3)>,
699 L<SSL_CTX_set_cert_verify_callback(3)>,
700 L<SSL_CTX_set_cipher_list(3)>,
701 L<SSL_CTX_set_client_CA_list(3)>,
702 L<SSL_CTX_set_client_cert_cb(3)>,
703 L<SSL_CTX_set_default_passwd_cb(3)>,
704 L<SSL_CTX_set_generate_session_id(3)>,
705 L<SSL_CTX_set_info_callback(3)>,
706 L<SSL_CTX_set_max_cert_list(3)>,
707 L<SSL_CTX_set_mode(3)>,
708 L<SSL_CTX_set_msg_callback(3)>,
709 L<SSL_CTX_set_options(3)>,
710 L<SSL_CTX_set_quiet_shutdown(3)>,
711 L<SSL_CTX_set_read_ahead(3)>,
712 L<SSL_CTX_set_session_cache_mode(3)>,
713 L<SSL_CTX_set_session_id_context(3)>,
714 L<SSL_CTX_set_ssl_version(3)>,
715 L<SSL_CTX_set_timeout(3)>,
716 L<SSL_CTX_set_tmp_rsa_callback(3)>,
717 L<SSL_CTX_set_tmp_dh_callback(3)>,
718 L<SSL_CTX_set_verify(3)>,
719 L<SSL_CTX_use_certificate(3)>,
720 L<SSL_alert_type_string(3)>,
721 L<SSL_do_handshake(3)>,
722 L<SSL_get_SSL_CTX(3)>,
723 L<SSL_get_ciphers(3)>,
724 L<SSL_get_client_CA_list(3)>,
725 L<SSL_get_default_timeout(3)>,
727 L<SSL_get_ex_data_X509_STORE_CTX_idx(3)>,
728 L<SSL_get_ex_new_index(3)>,
730 L<SSL_get_peer_cert_chain(3)>,
732 L<SSL_get_session(3)>,
733 L<SSL_get_verify_result(3)>,
734 L<SSL_get_version(3)>,
735 L<SSL_library_init(3)>,
736 L<SSL_load_client_CA_file(3)>,
740 L<SSL_rstate_string(3)>,
741 L<SSL_session_reused(3)>,
743 L<SSL_set_connect_state(3)>,
745 L<SSL_set_session(3)>,
746 L<SSL_set_shutdown(3)>,
748 L<SSL_state_string(3)>,
751 L<SSL_SESSION_free(3)>,
752 L<SSL_SESSION_get_ex_new_index(3)>,
753 L<SSL_SESSION_get_time(3)>,
754 L<d2i_SSL_SESSION(3)>,
755 L<SSL_CTX_set_psk_client_callback(3)>,
756 L<SSL_CTX_use_psk_identity_hint(3)>,
757 L<SSL_get_psk_identity(3)>,
758 L<DTLSv1_listen(3)|DTLSv1_listen(3)>
762 B<SSLv2_client_method>, B<SSLv2_server_method> and B<SSLv2_method> where removed
765 The return type of B<SSL_copy_session_id> was changed from void to int in