5 ssl - OpenSSL SSL/TLS library
9 See the individual manual pages for details.
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
17 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
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.
28 When the TLS/SSL handshake is performed using
29 L<SSL_accept(3)> or L<SSL_connect(3)>
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
36 =head1 DATA STRUCTURES
38 Currently the OpenSSL B<ssl> library functions deals with the following data
43 =item B<SSL_METHOD> (SSL Method)
45 This is 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>.
49 =item B<SSL_CIPHER> (SSL Cipher)
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 actual ones used are then part of the
56 =item B<SSL_CTX> (SSL Context)
58 This is 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.
62 =item B<SSL_SESSION> (SSL Session)
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.
67 =item B<SSL> (SSL Connection)
69 This is 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 At run-time the application usually deals with this structure which has
72 links to mostly all other structures.
79 Currently the OpenSSL B<ssl> library provides the following C header files
80 containing the prototypes for the data structures and functions:
86 This is 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.
94 Unused. Present for backwards compatibility only.
98 This is 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>.
104 This is 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>.
112 Currently the OpenSSL B<ssl> library exports 214 API functions.
113 They are documented in the following:
115 =head2 Dealing with Protocol Methods
117 Here we document the various API functions which deal with the SSL/TLS
118 protocol methods defined in B<SSL_METHOD> structures.
122 =item const SSL_METHOD *B<TLS_method>(void);
124 Constructor for the I<version-flexible> SSL_METHOD structure for clients,
126 See L<SSL_CTX_new(3)> for details.
128 =item const SSL_METHOD *B<TLS_client_method>(void);
130 Constructor for the I<version-flexible> SSL_METHOD structure for clients.
131 Must be used to support the TLSv1.3 protocol.
133 =item const SSL_METHOD *B<TLS_server_method>(void);
135 Constructor for the I<version-flexible> SSL_METHOD structure for servers.
136 Must be used to support the TLSv1.3 protocol.
138 =item const SSL_METHOD *B<TLSv1_2_method>(void);
140 Constructor for the TLSv1.2 SSL_METHOD structure for clients, servers or both.
142 =item const SSL_METHOD *B<TLSv1_2_client_method>(void);
144 Constructor for the TLSv1.2 SSL_METHOD structure for clients.
146 =item const SSL_METHOD *B<TLSv1_2_server_method>(void);
148 Constructor for the TLSv1.2 SSL_METHOD structure for servers.
150 =item const SSL_METHOD *B<TLSv1_1_method>(void);
152 Constructor for the TLSv1.1 SSL_METHOD structure for clients, servers or both.
154 =item const SSL_METHOD *B<TLSv1_1_client_method>(void);
156 Constructor for the TLSv1.1 SSL_METHOD structure for clients.
158 =item const SSL_METHOD *B<TLSv1_1_server_method>(void);
160 Constructor for the TLSv1.1 SSL_METHOD structure for servers.
162 =item const SSL_METHOD *B<TLSv1_method>(void);
164 Constructor for the TLSv1 SSL_METHOD structure for clients, servers or both.
166 =item const SSL_METHOD *B<TLSv1_client_method>(void);
168 Constructor for the TLSv1 SSL_METHOD structure for clients.
170 =item const SSL_METHOD *B<TLSv1_server_method>(void);
172 Constructor for the TLSv1 SSL_METHOD structure for servers.
174 =item const SSL_METHOD *B<SSLv3_method>(void);
176 Constructor for the SSLv3 SSL_METHOD structure for clients, servers or both.
178 =item const SSL_METHOD *B<SSLv3_client_method>(void);
180 Constructor for the SSLv3 SSL_METHOD structure for clients.
182 =item const SSL_METHOD *B<SSLv3_server_method>(void);
184 Constructor for the SSLv3 SSL_METHOD structure for servers.
188 =head2 Dealing with Ciphers
190 Here we document the various API functions which deal with the SSL/TLS
191 ciphers defined in B<SSL_CIPHER> structures.
195 =item char *B<SSL_CIPHER_description>(SSL_CIPHER *cipher, char *buf, int len);
197 Write a string to I<buf> (with a maximum size of I<len>) containing a human
198 readable description of I<cipher>. Returns I<buf>.
200 =item int B<SSL_CIPHER_get_bits>(SSL_CIPHER *cipher, int *alg_bits);
202 Determine the number of bits in I<cipher>. Because of export crippled ciphers
203 there are two bits: The bits the algorithm supports in general (stored to
204 I<alg_bits>) and the bits which are actually used (the return value).
206 =item const char *B<SSL_CIPHER_get_name>(SSL_CIPHER *cipher);
208 Return the internal name of I<cipher> as a string. These are the various
209 strings defined by the I<SSL3_TXT_xxx> and I<TLS1_TXT_xxx>
210 definitions in the header files.
212 =item const char *B<SSL_CIPHER_get_version>(SSL_CIPHER *cipher);
214 Returns a string like "C<SSLv3>" or "C<TLSv1.2>" which indicates the
215 SSL/TLS protocol version to which I<cipher> belongs (i.e. where it was defined
216 in the specification the first time).
220 =head2 Dealing with Protocol Contexts
222 Here we document the various API functions which deal with the SSL/TLS
223 protocol context defined in the B<SSL_CTX> structure.
227 =item int B<SSL_CTX_add_client_CA>(SSL_CTX *ctx, X509 *x);
229 =item long B<SSL_CTX_add_extra_chain_cert>(SSL_CTX *ctx, X509 *x509);
231 =item int B<SSL_CTX_add_session>(SSL_CTX *ctx, SSL_SESSION *c);
233 =item int B<SSL_CTX_check_private_key>(const SSL_CTX *ctx);
235 =item long B<SSL_CTX_ctrl>(SSL_CTX *ctx, int cmd, long larg, char *parg);
237 =item void B<SSL_CTX_flush_sessions>(SSL_CTX *s, long t);
239 =item void B<SSL_CTX_free>(SSL_CTX *a);
241 =item char *B<SSL_CTX_get_app_data>(SSL_CTX *ctx);
243 =item X509_STORE *B<SSL_CTX_get_cert_store>(SSL_CTX *ctx);
245 =item STACK *B<SSL_CTX_get_ciphers>(const SSL_CTX *ctx);
247 =item STACK *B<SSL_CTX_get_client_CA_list>(const SSL_CTX *ctx);
249 =item int (*B<SSL_CTX_get_client_cert_cb>(SSL_CTX *ctx))(SSL *ssl, X509 **x509, EVP_PKEY **pkey);
251 =item void B<SSL_CTX_get_default_read_ahead>(SSL_CTX *ctx);
253 =item char *B<SSL_CTX_get_ex_data>(const SSL_CTX *s, int idx);
255 =item int B<SSL_CTX_get_ex_new_index>(long argl, char *argp, int (*new_func);(void), int (*dup_func)(void), void (*free_func)(void))
257 =item void (*B<SSL_CTX_get_info_callback>(SSL_CTX *ctx))(SSL *ssl, int cb, int ret);
259 =item int B<SSL_CTX_get_quiet_shutdown>(const SSL_CTX *ctx);
261 =item void B<SSL_CTX_get_read_ahead>(SSL_CTX *ctx);
263 =item int B<SSL_CTX_get_session_cache_mode>(SSL_CTX *ctx);
265 =item long B<SSL_CTX_get_timeout>(const SSL_CTX *ctx);
267 =item int (*B<SSL_CTX_get_verify_callback>(const SSL_CTX *ctx))(int ok, X509_STORE_CTX *ctx);
269 =item int B<SSL_CTX_get_verify_mode>(SSL_CTX *ctx);
271 =item int B<SSL_CTX_load_verify_locations>(SSL_CTX *ctx, const char *CAfile, const char *CApath);
273 =item SSL_CTX *B<SSL_CTX_new>(const SSL_METHOD *meth);
275 =item int SSL_CTX_up_ref(SSL_CTX *ctx);
277 =item int B<SSL_CTX_remove_session>(SSL_CTX *ctx, SSL_SESSION *c);
279 =item int B<SSL_CTX_sess_accept>(SSL_CTX *ctx);
281 =item int B<SSL_CTX_sess_accept_good>(SSL_CTX *ctx);
283 =item int B<SSL_CTX_sess_accept_renegotiate>(SSL_CTX *ctx);
285 =item int B<SSL_CTX_sess_cache_full>(SSL_CTX *ctx);
287 =item int B<SSL_CTX_sess_cb_hits>(SSL_CTX *ctx);
289 =item int B<SSL_CTX_sess_connect>(SSL_CTX *ctx);
291 =item int B<SSL_CTX_sess_connect_good>(SSL_CTX *ctx);
293 =item int B<SSL_CTX_sess_connect_renegotiate>(SSL_CTX *ctx);
295 =item int B<SSL_CTX_sess_get_cache_size>(SSL_CTX *ctx);
297 =item SSL_SESSION *(*B<SSL_CTX_sess_get_get_cb>(SSL_CTX *ctx))(SSL *ssl, unsigned char *data, int len, int *copy);
299 =item int (*B<SSL_CTX_sess_get_new_cb>(SSL_CTX *ctx)(SSL *ssl, SSL_SESSION *sess);
301 =item void (*B<SSL_CTX_sess_get_remove_cb>(SSL_CTX *ctx)(SSL_CTX *ctx, SSL_SESSION *sess);
303 =item int B<SSL_CTX_sess_hits>(SSL_CTX *ctx);
305 =item int B<SSL_CTX_sess_misses>(SSL_CTX *ctx);
307 =item int B<SSL_CTX_sess_number>(SSL_CTX *ctx);
309 =item void B<SSL_CTX_sess_set_cache_size>(SSL_CTX *ctx, t);
311 =item void B<SSL_CTX_sess_set_get_cb>(SSL_CTX *ctx, SSL_SESSION *(*cb)(SSL *ssl, unsigned char *data, int len, int *copy));
313 =item void B<SSL_CTX_sess_set_new_cb>(SSL_CTX *ctx, int (*cb)(SSL *ssl, SSL_SESSION *sess));
315 =item void B<SSL_CTX_sess_set_remove_cb>(SSL_CTX *ctx, void (*cb)(SSL_CTX *ctx, SSL_SESSION *sess));
317 =item int B<SSL_CTX_sess_timeouts>(SSL_CTX *ctx);
319 =item LHASH *B<SSL_CTX_sessions>(SSL_CTX *ctx);
321 =item int B<SSL_CTX_set_app_data>(SSL_CTX *ctx, void *arg);
323 =item void B<SSL_CTX_set_cert_store>(SSL_CTX *ctx, X509_STORE *cs);
325 =item void B<SSL_CTX_set1_cert_store>(SSL_CTX *ctx, X509_STORE *cs);
327 =item void B<SSL_CTX_set_cert_verify_cb>(SSL_CTX *ctx, int (*cb)(), char *arg)
329 =item int B<SSL_CTX_set_cipher_list>(SSL_CTX *ctx, char *str);
331 =item void B<SSL_CTX_set_client_CA_list>(SSL_CTX *ctx, STACK *list);
333 =item void B<SSL_CTX_set_client_cert_cb>(SSL_CTX *ctx, int (*cb)(SSL *ssl, X509 **x509, EVP_PKEY **pkey));
335 =item int B<SSL_CTX_set_ct_validation_callback>(SSL_CTX *ctx, ssl_ct_validation_cb callback, void *arg);
337 =item void B<SSL_CTX_set_default_passwd_cb>(SSL_CTX *ctx, int (*cb);(void))
339 =item void B<SSL_CTX_set_default_read_ahead>(SSL_CTX *ctx, int m);
341 =item int B<SSL_CTX_set_default_verify_paths>(SSL_CTX *ctx);
343 Use the default paths to locate trusted CA certificates. There is one default
344 directory path and one default file path. Both are set via this call.
346 =item int B<SSL_CTX_set_default_verify_dir>(SSL_CTX *ctx)
348 Use the default directory path to locate trusted CA certificates.
350 =item int B<SSL_CTX_set_default_verify_file>(SSL_CTX *ctx)
352 Use the file path to locate trusted CA certificates.
354 =item int B<SSL_CTX_set_ex_data>(SSL_CTX *s, int idx, char *arg);
356 =item void B<SSL_CTX_set_info_callback>(SSL_CTX *ctx, void (*cb)(SSL *ssl, int cb, int ret));
358 =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));
360 =item void B<SSL_CTX_set_msg_callback_arg>(SSL_CTX *ctx, void *arg);
362 =item unsigned long B<SSL_CTX_clear_options>(SSL_CTX *ctx, unsigned long op);
364 =item unsigned long B<SSL_CTX_get_options>(SSL_CTX *ctx);
366 =item unsigned long B<SSL_CTX_set_options>(SSL_CTX *ctx, unsigned long op);
368 =item void B<SSL_CTX_set_quiet_shutdown>(SSL_CTX *ctx, int mode);
370 =item void B<SSL_CTX_set_read_ahead>(SSL_CTX *ctx, int m);
372 =item void B<SSL_CTX_set_session_cache_mode>(SSL_CTX *ctx, int mode);
374 =item int B<SSL_CTX_set_ssl_version>(SSL_CTX *ctx, const SSL_METHOD *meth);
376 =item void B<SSL_CTX_set_timeout>(SSL_CTX *ctx, long t);
378 =item long B<SSL_CTX_set_tmp_dh>(SSL_CTX* ctx, DH *dh);
380 =item long B<SSL_CTX_set_tmp_dh_callback>(SSL_CTX *ctx, DH *(*cb)(void));
382 =item void B<SSL_CTX_set_verify>(SSL_CTX *ctx, int mode, int (*cb);(void))
384 =item int B<SSL_CTX_use_PrivateKey>(SSL_CTX *ctx, EVP_PKEY *pkey);
386 =item int B<SSL_CTX_use_PrivateKey_ASN1>(int type, SSL_CTX *ctx, unsigned char *d, long len);
388 =item int B<SSL_CTX_use_PrivateKey_file>(SSL_CTX *ctx, const char *file, int type);
390 =item int B<SSL_CTX_use_RSAPrivateKey>(SSL_CTX *ctx, RSA *rsa);
392 =item int B<SSL_CTX_use_RSAPrivateKey_ASN1>(SSL_CTX *ctx, unsigned char *d, long len);
394 =item int B<SSL_CTX_use_RSAPrivateKey_file>(SSL_CTX *ctx, const char *file, int type);
396 =item int B<SSL_CTX_use_certificate>(SSL_CTX *ctx, X509 *x);
398 =item int B<SSL_CTX_use_certificate_ASN1>(SSL_CTX *ctx, int len, unsigned char *d);
400 =item int B<SSL_CTX_use_certificate_file>(SSL_CTX *ctx, const char *file, int type);
402 =item int B<SSL_CTX_use_cert_and_key>(SSL_CTX *ctx, X509 *x, EVP_PKEY *pkey, STACK_OF(X509) *chain, int override);
404 =item X509 *B<SSL_CTX_get0_certificate>(const SSL_CTX *ctx);
406 =item EVP_PKEY *B<SSL_CTX_get0_privatekey>(const SSL_CTX *ctx);
408 =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));
410 =item int B<SSL_CTX_use_psk_identity_hint>(SSL_CTX *ctx, const char *hint);
412 =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));
417 =head2 Dealing with Sessions
419 Here we document the various API functions which deal with the SSL/TLS
420 sessions defined in the B<SSL_SESSION> structures.
424 =item int B<SSL_SESSION_cmp>(const SSL_SESSION *a, const SSL_SESSION *b);
426 =item void B<SSL_SESSION_free>(SSL_SESSION *ss);
428 =item char *B<SSL_SESSION_get_app_data>(SSL_SESSION *s);
430 =item char *B<SSL_SESSION_get_ex_data>(const SSL_SESSION *s, int idx);
432 =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))
434 =item long B<SSL_SESSION_get_time>(const SSL_SESSION *s);
436 =item long B<SSL_SESSION_get_timeout>(const SSL_SESSION *s);
438 =item unsigned long B<SSL_SESSION_hash>(const SSL_SESSION *a);
440 =item SSL_SESSION *B<SSL_SESSION_new>(void);
442 =item int B<SSL_SESSION_print>(BIO *bp, const SSL_SESSION *x);
444 =item int B<SSL_SESSION_print_fp>(FILE *fp, const SSL_SESSION *x);
446 =item int B<SSL_SESSION_set_app_data>(SSL_SESSION *s, char *a);
448 =item int B<SSL_SESSION_set_ex_data>(SSL_SESSION *s, int idx, char *arg);
450 =item long B<SSL_SESSION_set_time>(SSL_SESSION *s, long t);
452 =item long B<SSL_SESSION_set_timeout>(SSL_SESSION *s, long t);
456 =head2 Dealing with Connections
458 Here we document the various API functions which deal with the SSL/TLS
459 connection defined in the B<SSL> structure.
463 =item int B<SSL_accept>(SSL *ssl);
465 =item int B<SSL_add_dir_cert_subjects_to_stack>(STACK *stack, const char *dir);
467 =item int B<SSL_add_file_cert_subjects_to_stack>(STACK *stack, const char *file);
469 =item int B<SSL_add_client_CA>(SSL *ssl, X509 *x);
471 =item char *B<SSL_alert_desc_string>(int value);
473 =item char *B<SSL_alert_desc_string_long>(int value);
475 =item char *B<SSL_alert_type_string>(int value);
477 =item char *B<SSL_alert_type_string_long>(int value);
479 =item int B<SSL_check_private_key>(const SSL *ssl);
481 =item void B<SSL_clear>(SSL *ssl);
483 =item long B<SSL_clear_num_renegotiations>(SSL *ssl);
485 =item int B<SSL_connect>(SSL *ssl);
487 =item int B<SSL_copy_session_id>(SSL *t, const SSL *f);
489 Sets the session details for B<t> to be the same as in B<f>. Returns 1 on
490 success or 0 on failure.
492 =item long B<SSL_ctrl>(SSL *ssl, int cmd, long larg, char *parg);
494 =item int B<SSL_do_handshake>(SSL *ssl);
496 =item SSL *B<SSL_dup>(SSL *ssl);
498 SSL_dup() allows applications to configure an SSL handle for use
499 in multiple SSL connections, and then duplicate it prior to initiating
500 each connection with the duplicated handle.
501 Use of SSL_dup() avoids the need to repeat the configuration of the
502 handles for each connection.
504 For SSL_dup() to work, the connection MUST be in its initial state
505 and MUST NOT have not yet have started the SSL handshake.
506 For connections that are not in their initial state SSL_dup() just
507 increments an internal reference count and returns the I<same>
509 It may be possible to use L<SSL_clear(3)> to recycle an SSL handle
510 that is not in its initial state for re-use, but this is best
512 Instead, save and restore the session, if desired, and construct a
513 fresh handle for each connection.
515 =item STACK *B<SSL_dup_CA_list>(STACK *sk);
517 =item void B<SSL_free>(SSL *ssl);
519 =item SSL_CTX *B<SSL_get_SSL_CTX>(const SSL *ssl);
521 =item char *B<SSL_get_app_data>(SSL *ssl);
523 =item X509 *B<SSL_get_certificate>(const SSL *ssl);
525 =item const char *B<SSL_get_cipher>(const SSL *ssl);
527 =item int B<SSL_is_dtls>(const SSL *ssl);
529 =item int B<SSL_get_cipher_bits>(const SSL *ssl, int *alg_bits);
531 =item char *B<SSL_get_cipher_list>(const SSL *ssl, int n);
533 =item char *B<SSL_get_cipher_name>(const SSL *ssl);
535 =item char *B<SSL_get_cipher_version>(const SSL *ssl);
537 =item STACK *B<SSL_get_ciphers>(const SSL *ssl);
539 =item STACK *B<SSL_get_client_CA_list>(const SSL *ssl);
541 =item SSL_CIPHER *B<SSL_get_current_cipher>(SSL *ssl);
543 =item long B<SSL_get_default_timeout>(const SSL *ssl);
545 =item int B<SSL_get_error>(const SSL *ssl, int i);
547 =item char *B<SSL_get_ex_data>(const SSL *ssl, int idx);
549 =item int B<SSL_get_ex_data_X509_STORE_CTX_idx>(void);
551 =item int B<SSL_get_ex_new_index>(long argl, char *argp, int (*new_func);(void), int (*dup_func)(void), void (*free_func)(void))
553 =item int B<SSL_get_fd>(const SSL *ssl);
555 =item void (*B<SSL_get_info_callback>(const SSL *ssl);)()
557 =item int B<SSL_get_key_update_type>(SSL *s);
559 =item STACK *B<SSL_get_peer_cert_chain>(const SSL *ssl);
561 =item X509 *B<SSL_get_peer_certificate>(const SSL *ssl);
563 =item const STACK_OF(SCT) *B<SSL_get0_peer_scts>(SSL *s);
565 =item EVP_PKEY *B<SSL_get_privatekey>(const SSL *ssl);
567 =item int B<SSL_get_quiet_shutdown>(const SSL *ssl);
569 =item BIO *B<SSL_get_rbio>(const SSL *ssl);
571 =item int B<SSL_get_read_ahead>(const SSL *ssl);
573 =item SSL_SESSION *B<SSL_get_session>(const SSL *ssl);
575 =item char *B<SSL_get_shared_ciphers>(const SSL *ssl, char *buf, int size);
577 =item int B<SSL_get_shutdown>(const SSL *ssl);
579 =item const SSL_METHOD *B<SSL_get_ssl_method>(SSL *ssl);
581 =item int B<SSL_get_state>(const SSL *ssl);
583 =item long B<SSL_get_time>(const SSL *ssl);
585 =item long B<SSL_get_timeout>(const SSL *ssl);
587 =item int (*B<SSL_get_verify_callback>(const SSL *ssl))(int, X509_STORE_CTX *)
589 =item int B<SSL_get_verify_mode>(const SSL *ssl);
591 =item long B<SSL_get_verify_result>(const SSL *ssl);
593 =item char *B<SSL_get_version>(const SSL *ssl);
595 =item BIO *B<SSL_get_wbio>(const SSL *ssl);
597 =item int B<SSL_in_accept_init>(SSL *ssl);
599 =item int B<SSL_in_before>(SSL *ssl);
601 =item int B<SSL_in_connect_init>(SSL *ssl);
603 =item int B<SSL_in_init>(SSL *ssl);
605 =item int B<SSL_is_init_finished>(SSL *ssl);
607 =item int B<SSL_key_update>(SSL *s, int updatetype);
609 =item STACK *B<SSL_load_client_CA_file>(const char *file);
611 =item SSL *B<SSL_new>(SSL_CTX *ctx);
613 =item int SSL_up_ref(SSL *s);
615 =item long B<SSL_num_renegotiations>(SSL *ssl);
617 =item int B<SSL_peek>(SSL *ssl, void *buf, int num);
619 =item int B<SSL_pending>(const SSL *ssl);
621 =item int B<SSL_read>(SSL *ssl, void *buf, int num);
623 =item int B<SSL_renegotiate>(SSL *ssl);
625 =item char *B<SSL_rstate_string>(SSL *ssl);
627 =item char *B<SSL_rstate_string_long>(SSL *ssl);
629 =item long B<SSL_session_reused>(SSL *ssl);
631 =item void B<SSL_set_accept_state>(SSL *ssl);
633 =item void B<SSL_set_app_data>(SSL *ssl, char *arg);
635 =item void B<SSL_set_bio>(SSL *ssl, BIO *rbio, BIO *wbio);
637 =item int B<SSL_set_cipher_list>(SSL *ssl, char *str);
639 =item void B<SSL_set_client_CA_list>(SSL *ssl, STACK *list);
641 =item void B<SSL_set_connect_state>(SSL *ssl);
643 =item int B<SSL_set_ct_validation_callback>(SSL *ssl, ssl_ct_validation_cb callback, void *arg);
645 =item int B<SSL_set_ex_data>(SSL *ssl, int idx, char *arg);
647 =item int B<SSL_set_fd>(SSL *ssl, int fd);
649 =item void B<SSL_set_info_callback>(SSL *ssl, void (*cb);(void))
651 =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));
653 =item void B<SSL_set_msg_callback_arg>(SSL *ctx, void *arg);
655 =item unsigned long B<SSL_clear_options>(SSL *ssl, unsigned long op);
657 =item unsigned long B<SSL_get_options>(SSL *ssl);
659 =item unsigned long B<SSL_set_options>(SSL *ssl, unsigned long op);
661 =item void B<SSL_set_quiet_shutdown>(SSL *ssl, int mode);
663 =item void B<SSL_set_read_ahead>(SSL *ssl, int yes);
665 =item int B<SSL_set_rfd>(SSL *ssl, int fd);
667 =item int B<SSL_set_session>(SSL *ssl, SSL_SESSION *session);
669 =item void B<SSL_set_shutdown>(SSL *ssl, int mode);
671 =item int B<SSL_set_ssl_method>(SSL *ssl, const SSL_METHOD *meth);
673 =item void B<SSL_set_time>(SSL *ssl, long t);
675 =item void B<SSL_set_timeout>(SSL *ssl, long t);
677 =item void B<SSL_set_verify>(SSL *ssl, int mode, int (*callback);(void))
679 =item void B<SSL_set_verify_result>(SSL *ssl, long arg);
681 =item int B<SSL_set_wfd>(SSL *ssl, int fd);
683 =item int B<SSL_shutdown>(SSL *ssl);
685 =item OSSL_HANDSHAKE_STATE B<SSL_get_state>(const SSL *ssl);
687 Returns the current handshake state.
689 =item char *B<SSL_state_string>(const SSL *ssl);
691 =item char *B<SSL_state_string_long>(const SSL *ssl);
693 =item long B<SSL_total_renegotiations>(SSL *ssl);
695 =item int B<SSL_use_PrivateKey>(SSL *ssl, EVP_PKEY *pkey);
697 =item int B<SSL_use_PrivateKey_ASN1>(int type, SSL *ssl, unsigned char *d, long len);
699 =item int B<SSL_use_PrivateKey_file>(SSL *ssl, const char *file, int type);
701 =item int B<SSL_use_RSAPrivateKey>(SSL *ssl, RSA *rsa);
703 =item int B<SSL_use_RSAPrivateKey_ASN1>(SSL *ssl, unsigned char *d, long len);
705 =item int B<SSL_use_RSAPrivateKey_file>(SSL *ssl, const char *file, int type);
707 =item int B<SSL_use_certificate>(SSL *ssl, X509 *x);
709 =item int B<SSL_use_certificate_ASN1>(SSL *ssl, int len, unsigned char *d);
711 =item int B<SSL_use_certificate_file>(SSL *ssl, const char *file, int type);
713 =item int B<SSL_use_cert_and_key>(SSL *ssl, X509 *x, EVP_PKEY *pkey, STACK_OF(X509) *chain, int override);
715 =item int B<SSL_version>(const SSL *ssl);
717 =item int B<SSL_want>(const SSL *ssl);
719 =item int B<SSL_want_nothing>(const SSL *ssl);
721 =item int B<SSL_want_read>(const SSL *ssl);
723 =item int B<SSL_want_write>(const SSL *ssl);
725 =item int B<SSL_want_x509_lookup>(const SSL *ssl);
727 =item int B<SSL_write>(SSL *ssl, const void *buf, int num);
729 =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));
731 =item int B<SSL_use_psk_identity_hint>(SSL *ssl, const char *hint);
733 =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));
735 =item const char *B<SSL_get_psk_identity_hint>(SSL *ssl);
737 =item const char *B<SSL_get_psk_identity>(SSL *ssl);
743 See the individual manual pages for details.
747 L<openssl(1)>, L<crypto(7)>,
748 L<CRYPTO_get_ex_new_index(3)>,
749 L<SSL_accept(3)>, L<SSL_clear(3)>,
751 L<SSL_CIPHER_get_name(3)>,
752 L<SSL_COMP_add_compression_method(3)>,
753 L<SSL_CTX_add_extra_chain_cert(3)>,
754 L<SSL_CTX_add_session(3)>,
756 L<SSL_CTX_flush_sessions(3)>,
757 L<SSL_CTX_get_verify_mode(3)>,
758 L<SSL_CTX_load_verify_locations(3)>
760 L<SSL_CTX_sess_number(3)>,
761 L<SSL_CTX_sess_set_cache_size(3)>,
762 L<SSL_CTX_sess_set_get_cb(3)>,
763 L<SSL_CTX_sessions(3)>,
764 L<SSL_CTX_set_cert_store(3)>,
765 L<SSL_CTX_set_cert_verify_callback(3)>,
766 L<SSL_CTX_set_cipher_list(3)>,
767 L<SSL_CTX_set_client_CA_list(3)>,
768 L<SSL_CTX_set_client_cert_cb(3)>,
769 L<SSL_CTX_set_default_passwd_cb(3)>,
770 L<SSL_CTX_set_generate_session_id(3)>,
771 L<SSL_CTX_set_info_callback(3)>,
772 L<SSL_CTX_set_max_cert_list(3)>,
773 L<SSL_CTX_set_mode(3)>,
774 L<SSL_CTX_set_msg_callback(3)>,
775 L<SSL_CTX_set_options(3)>,
776 L<SSL_CTX_set_quiet_shutdown(3)>,
777 L<SSL_CTX_set_read_ahead(3)>,
778 L<SSL_CTX_set_security_level(3)>,
779 L<SSL_CTX_set_session_cache_mode(3)>,
780 L<SSL_CTX_set_session_id_context(3)>,
781 L<SSL_CTX_set_ssl_version(3)>,
782 L<SSL_CTX_set_timeout(3)>,
783 L<SSL_CTX_set_tmp_dh_callback(3)>,
784 L<SSL_CTX_set_verify(3)>,
785 L<SSL_CTX_use_certificate(3)>,
786 L<SSL_alert_type_string(3)>,
787 L<SSL_do_handshake(3)>,
789 L<SSL_get_SSL_CTX(3)>,
790 L<SSL_get_ciphers(3)>,
791 L<SSL_get_client_CA_list(3)>,
792 L<SSL_get_default_timeout(3)>,
794 L<SSL_get_ex_data_X509_STORE_CTX_idx(3)>,
796 L<SSL_get_peer_cert_chain(3)>,
798 L<SSL_get_session(3)>,
799 L<SSL_get_verify_result(3)>,
800 L<SSL_get_version(3)>,
801 L<SSL_load_client_CA_file(3)>,
806 L<SSL_rstate_string(3)>,
807 L<SSL_session_reused(3)>,
809 L<SSL_set_connect_state(3)>,
811 L<SSL_set_session(3)>,
812 L<SSL_set_shutdown(3)>,
814 L<SSL_state_string(3)>,
818 L<SSL_SESSION_free(3)>,
819 L<SSL_SESSION_get_time(3)>,
820 L<d2i_SSL_SESSION(3)>,
821 L<SSL_CTX_set_psk_client_callback(3)>,
822 L<SSL_CTX_use_psk_identity_hint(3)>,
823 L<SSL_get_psk_identity(3)>,
828 B<SSLv2_client_method>, B<SSLv2_server_method> and B<SSLv2_method> were removed
831 The return type of B<SSL_copy_session_id> was changed from void to int in
836 Copyright 2000-2018 The OpenSSL Project Authors. All Rights Reserved.
838 Licensed under the OpenSSL license (the "License"). You may not use
839 this file except in compliance with the License. You can obtain a copy
840 in the file LICENSE in the source distribution or at
841 L<https://www.openssl.org/source/license.html>.