Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40)

Standard preamble:
========================================================================
..

..

.. Set up some character translations and predefined strings. \*(-- will
give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
double quote, and \*(R" will give a right double quote. \*(C+ will
give a nicer C++. Capital omega is used to do unbreakable dashes and
therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
nothing in troff, for use with C<>.
.tr \(*W- . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\}
Escape single quotes in literal strings from groff's Unicode transform.

If the F register is >0, we'll generate index entries on stderr for
titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
entries marked with X<> in POD. Of course, you'll have to process the
output yourself in some meaningful fashion.

Avoid warning from groff about undefined register 'F'.
.. .nr rF 0 . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF
Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
Fear. Run. Save yourself. No user-serviceable parts.
. \" fudge factors for nroff and troff . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] .\} . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents . \" corrections for vroff . \" for low resolution devices (crt and lpr) \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} ========================================================================

Title "SSL 7" For nroff, turn off justification. Always turn off hyphenation; it makes
way too many mistakes in technical documents.
ssl - OpenSSL SSL/TLS library Header "SYNOPSIS" See the individual manual pages for details. Header "DESCRIPTION" The OpenSSL ssl library implements the Secure Sockets Layer (\s-1SSL\s0 v2/v3) and Transport Layer Security (\s-1TLS\s0 v1) protocols. It provides a rich \s-1API\s0 which is documented here.

An \s-1SSL_CTX\s0 object is created as a framework to establish \s-1TLS/SSL\s0 enabled connections (see SSL_CTX_new\|(3)). Various options regarding certificates, algorithms etc. can be set in this object.

When a network connection has been created, it can be assigned to an \fB\s-1SSL\s0 object. After the \s-1SSL\s0 object has been created using \fBSSL_new\|(3), SSL_set_fd\|(3) or \fBSSL_set_bio\|(3) can be used to associate the network connection with the object.

When the \s-1TLS/SSL\s0 handshake is performed using \fBSSL_accept\|(3) or SSL_connect\|(3) respectively. \fBSSL_read_ex\|(3), SSL_read\|(3), SSL_write_ex\|(3) and SSL_write\|(3) are used to read and write data on the \s-1TLS/SSL\s0 connection. \fBSSL_shutdown\|(3) can be used to shut down the \s-1TLS/SSL\s0 connection.

Header "DATA STRUCTURES" Currently the OpenSSL ssl library functions deals with the following data structures: Item "SSL_METHOD (SSL Method)" This is a dispatch structure describing the internal ssl library methods/functions which implement the various protocol versions (SSLv3 TLSv1, ...). It's needed to create an \s-1SSL_CTX\s0. Item "SSL_CIPHER (SSL Cipher)" This structure holds the algorithm information for a particular cipher which are a core part of the \s-1SSL/TLS\s0 protocol. The available ciphers are configured on a \s-1SSL_CTX\s0 basis and the actual ones used are then part of the \fB\s-1SSL_SESSION\s0. Item "SSL_CTX (SSL Context)" This is the global context structure which is created by a server or client once per program life-time and which holds mainly default values for the \fB\s-1SSL\s0 structures which are later created for the connections. Item "SSL_SESSION (SSL Session)" This is a structure containing the current \s-1TLS/SSL\s0 session details for a connection: \s-1SSL_CIPHER\s0s, client and server certificates, keys, etc. Item "SSL (SSL Connection)" This is the main \s-1SSL/TLS\s0 structure which is created by a server or client per established connection. This actually is the core structure in the \s-1SSL API.\s0 At run-time the application usually deals with this structure which has links to mostly all other structures. Header "HEADER FILES" Currently the OpenSSL ssl library provides the following C header files containing the prototypes for the data structures and functions: Item "ssl.h" This is the common header file for the \s-1SSL/TLS API.\s0 Include it into your program to make the \s-1API\s0 of the ssl library available. It internally includes both more private \s-1SSL\s0 headers and headers from the crypto library. Whenever you need hard-core details on the internals of the \s-1SSL API,\s0 look inside this header file. Item "ssl2.h" Unused. Present for backwards compatibility only. Item "ssl3.h" This is the sub header file dealing with the SSLv3 protocol only. \fIUsually you don't have to include it explicitly because it's already included by ssl.h. Item "tls1.h" This is the sub header file dealing with the TLSv1 protocol only. \fIUsually you don't have to include it explicitly because it's already included by ssl.h. Header "API FUNCTIONS" Currently the OpenSSL ssl library exports 214 \s-1API\s0 functions. They are documented in the following: Subsection "Dealing with Protocol Methods" Here we document the various \s-1API\s0 functions which deal with the \s-1SSL/TLS\s0 protocol methods defined in \s-1SSL_METHOD\s0 structures. Item "const SSL_METHOD *TLS_method(void);" Constructor for the version-flexible \s-1SSL_METHOD\s0 structure for clients, servers or both. See SSL_CTX_new\|(3) for details. Item "const SSL_METHOD *TLS_client_method(void);" Constructor for the version-flexible \s-1SSL_METHOD\s0 structure for clients. Must be used to support the TLSv1.3 protocol. Item "const SSL_METHOD *TLS_server_method(void);" Constructor for the version-flexible \s-1SSL_METHOD\s0 structure for servers. Must be used to support the TLSv1.3 protocol. Item "const SSL_METHOD *TLSv1_2_method(void);" Constructor for the TLSv1.2 \s-1SSL_METHOD\s0 structure for clients, servers or both. Item "const SSL_METHOD *TLSv1_2_client_method(void);" Constructor for the TLSv1.2 \s-1SSL_METHOD\s0 structure for clients. Item "const SSL_METHOD *TLSv1_2_server_method(void);" Constructor for the TLSv1.2 \s-1SSL_METHOD\s0 structure for servers. Item "const SSL_METHOD *TLSv1_1_method(void);" Constructor for the TLSv1.1 \s-1SSL_METHOD\s0 structure for clients, servers or both. Item "const SSL_METHOD *TLSv1_1_client_method(void);" Constructor for the TLSv1.1 \s-1SSL_METHOD\s0 structure for clients. Item "const SSL_METHOD *TLSv1_1_server_method(void);" Constructor for the TLSv1.1 \s-1SSL_METHOD\s0 structure for servers. Item "const SSL_METHOD *TLSv1_method(void);" Constructor for the TLSv1 \s-1SSL_METHOD\s0 structure for clients, servers or both. Item "const SSL_METHOD *TLSv1_client_method(void);" Constructor for the TLSv1 \s-1SSL_METHOD\s0 structure for clients. Item "const SSL_METHOD *TLSv1_server_method(void);" Constructor for the TLSv1 \s-1SSL_METHOD\s0 structure for servers. Item "const SSL_METHOD *SSLv3_method(void);" Constructor for the SSLv3 \s-1SSL_METHOD\s0 structure for clients, servers or both. Item "const SSL_METHOD *SSLv3_client_method(void);" Constructor for the SSLv3 \s-1SSL_METHOD\s0 structure for clients. Item "const SSL_METHOD *SSLv3_server_method(void);" Constructor for the SSLv3 \s-1SSL_METHOD\s0 structure for servers. Subsection "Dealing with Ciphers" Here we document the various \s-1API\s0 functions which deal with the \s-1SSL/TLS\s0 ciphers defined in \s-1SSL_CIPHER\s0 structures. Item "char *SSL_CIPHER_description(SSL_CIPHER *cipher, char *buf, int len);" Write a string to buf (with a maximum size of len) containing a human readable description of cipher. Returns buf. Item "int SSL_CIPHER_get_bits(SSL_CIPHER *cipher, int *alg_bits);" Determine the number of bits in cipher. Because of export crippled ciphers there are two bits: The bits the algorithm supports in general (stored to \fIalg_bits) and the bits which are actually used (the return value). Item "const char *SSL_CIPHER_get_name(SSL_CIPHER *cipher);" Return the internal name of cipher as a string. These are the various strings defined by the SSL3_TXT_xxx and TLS1_TXT_xxx definitions in the header files. Item "const char *SSL_CIPHER_get_version(SSL_CIPHER *cipher);" Returns a string like "\*(C`SSLv3\*(C'\*(L" or \*(R"\*(C`TLSv1.2\*(C'" which indicates the \s-1SSL/TLS\s0 protocol version to which cipher belongs (i.e. where it was defined in the specification the first time). Subsection "Dealing with Protocol Contexts" Here we document the various \s-1API\s0 functions which deal with the \s-1SSL/TLS\s0 protocol context defined in the \s-1SSL_CTX\s0 structure. Item "int SSL_CTX_add_client_CA(SSL_CTX *ctx, X509 *x);"

0

Item "long SSL_CTX_add_extra_chain_cert(SSL_CTX *ctx, X509 *x509);" Item "int SSL_CTX_add_session(SSL_CTX *ctx, SSL_SESSION *c);" Item "int SSL_CTX_check_private_key(const SSL_CTX *ctx);" Item "long SSL_CTX_ctrl(SSL_CTX *ctx, int cmd, long larg, char *parg);" Item "void SSL_CTX_flush_sessions(SSL_CTX *s, long t);" Item "void SSL_CTX_free(SSL_CTX *a);" Item "char *SSL_CTX_get_app_data(SSL_CTX *ctx);" Item "X509_STORE *SSL_CTX_get_cert_store(SSL_CTX *ctx);" Item "STACK *SSL_CTX_get_ciphers(const SSL_CTX *ctx);" Item "STACK *SSL_CTX_get_client_CA_list(const SSL_CTX *ctx);" Item "int (*SSL_CTX_get_client_cert_cb(SSL_CTX *ctx))(SSL *ssl, X509 **x509, EVP_PKEY **pkey);" Item "void SSL_CTX_get_default_read_ahead(SSL_CTX *ctx);" Item "char *SSL_CTX_get_ex_data(const SSL_CTX *s, int idx);" Item "int SSL_CTX_get_ex_new_index(long argl, char *argp, int (*new_func);(void), int (*dup_func)(void), void (*free_func)(void))" Item "void (*SSL_CTX_get_info_callback(SSL_CTX *ctx))(SSL *ssl, int cb, int ret);" Item "int SSL_CTX_get_quiet_shutdown(const SSL_CTX *ctx);" Item "void SSL_CTX_get_read_ahead(SSL_CTX *ctx);" Item "int SSL_CTX_get_session_cache_mode(SSL_CTX *ctx);" Item "long SSL_CTX_get_timeout(const SSL_CTX *ctx);" Item "int (*SSL_CTX_get_verify_callback(const SSL_CTX *ctx))(int ok, X509_STORE_CTX *ctx);" Item "int SSL_CTX_get_verify_mode(SSL_CTX *ctx);" Item "int SSL_CTX_load_verify_locations(SSL_CTX *ctx, const char *CAfile, const char *CApath);" Item "SSL_CTX *SSL_CTX_new(const SSL_METHOD *meth);" Item "int SSL_CTX_up_ref(SSL_CTX *ctx);" Item "int SSL_CTX_remove_session(SSL_CTX *ctx, SSL_SESSION *c);" Item "int SSL_CTX_sess_accept(SSL_CTX *ctx);" Item "int SSL_CTX_sess_accept_good(SSL_CTX *ctx);" Item "int SSL_CTX_sess_accept_renegotiate(SSL_CTX *ctx);" Item "int SSL_CTX_sess_cache_full(SSL_CTX *ctx);" Item "int SSL_CTX_sess_cb_hits(SSL_CTX *ctx);" Item "int SSL_CTX_sess_connect(SSL_CTX *ctx);" Item "int SSL_CTX_sess_connect_good(SSL_CTX *ctx);" Item "int SSL_CTX_sess_connect_renegotiate(SSL_CTX *ctx);" Item "int SSL_CTX_sess_get_cache_size(SSL_CTX *ctx);" Item "SSL_SESSION *(*SSL_CTX_sess_get_get_cb(SSL_CTX *ctx))(SSL *ssl, unsigned char *data, int len, int *copy);" Item "int (*SSL_CTX_sess_get_new_cb(SSL_CTX *ctx)(SSL *ssl, SSL_SESSION *sess);" Item "void (*SSL_CTX_sess_get_remove_cb(SSL_CTX *ctx)(SSL_CTX *ctx, SSL_SESSION *sess);" Item "int SSL_CTX_sess_hits(SSL_CTX *ctx);" Item "int SSL_CTX_sess_misses(SSL_CTX *ctx);" Item "int SSL_CTX_sess_number(SSL_CTX *ctx);" Item "void SSL_CTX_sess_set_cache_size(SSL_CTX *ctx, t);" Item "void SSL_CTX_sess_set_get_cb(SSL_CTX *ctx, SSL_SESSION *(*cb)(SSL *ssl, unsigned char *data, int len, int *copy));" Item "void SSL_CTX_sess_set_new_cb(SSL_CTX *ctx, int (*cb)(SSL *ssl, SSL_SESSION *sess));" Item "void SSL_CTX_sess_set_remove_cb(SSL_CTX *ctx, void (*cb)(SSL_CTX *ctx, SSL_SESSION *sess));" Item "int SSL_CTX_sess_timeouts(SSL_CTX *ctx);" Item "LHASH *SSL_CTX_sessions(SSL_CTX *ctx);" Item "int SSL_CTX_set_app_data(SSL_CTX *ctx, void *arg);" Item "void SSL_CTX_set_cert_store(SSL_CTX *ctx, X509_STORE *cs);" Item "void SSL_CTX_set1_cert_store(SSL_CTX *ctx, X509_STORE *cs);" Item "void SSL_CTX_set_cert_verify_cb(SSL_CTX *ctx, int (*cb)(), char *arg)" Item "int SSL_CTX_set_cipher_list(SSL_CTX *ctx, char *str);" Item "void SSL_CTX_set_client_CA_list(SSL_CTX *ctx, STACK *list);" Item "void SSL_CTX_set_client_cert_cb(SSL_CTX *ctx, int (*cb)(SSL *ssl, X509 **x509, EVP_PKEY **pkey));" Item "int SSL_CTX_set_ct_validation_callback(SSL_CTX *ctx, ssl_ct_validation_cb callback, void *arg);" Item "void SSL_CTX_set_default_passwd_cb(SSL_CTX *ctx, int (*cb);(void))" Item "void SSL_CTX_set_default_read_ahead(SSL_CTX *ctx, int m);" Item "int SSL_CTX_set_default_verify_paths(SSL_CTX *ctx);"

Use the default paths to locate trusted \s-1CA\s0 certificates. There is one default directory path and one default file path. Both are set via this call.

Item "int SSL_CTX_set_default_verify_dir(SSL_CTX *ctx)" Use the default directory path to locate trusted \s-1CA\s0 certificates. Item "int SSL_CTX_set_default_verify_file(SSL_CTX *ctx)" Use the file path to locate trusted \s-1CA\s0 certificates. Item "int SSL_CTX_set_ex_data(SSL_CTX *s, int idx, char *arg);"

0

Item "void SSL_CTX_set_info_callback(SSL_CTX *ctx, void (*cb)(SSL *ssl, int cb, int ret));" Item "void 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));" Item "void SSL_CTX_set_msg_callback_arg(SSL_CTX *ctx, void *arg);" Item "unsigned long SSL_CTX_clear_options(SSL_CTX *ctx, unsigned long op);" Item "unsigned long SSL_CTX_get_options(SSL_CTX *ctx);" Item "unsigned long SSL_CTX_set_options(SSL_CTX *ctx, unsigned long op);" Item "void SSL_CTX_set_quiet_shutdown(SSL_CTX *ctx, int mode);" Item "void SSL_CTX_set_read_ahead(SSL_CTX *ctx, int m);" Item "void SSL_CTX_set_session_cache_mode(SSL_CTX *ctx, int mode);" Item "int SSL_CTX_set_ssl_version(SSL_CTX *ctx, const SSL_METHOD *meth);" Item "void SSL_CTX_set_timeout(SSL_CTX *ctx, long t);" Item "long SSL_CTX_set_tmp_dh(SSL_CTX* ctx, DH *dh);" Item "long SSL_CTX_set_tmp_dh_callback(SSL_CTX *ctx, DH *(*cb)(void));" Item "void SSL_CTX_set_verify(SSL_CTX *ctx, int mode, int (*cb);(void))" Item "int SSL_CTX_use_PrivateKey(SSL_CTX *ctx, EVP_PKEY *pkey);" Item "int SSL_CTX_use_PrivateKey_ASN1(int type, SSL_CTX *ctx, unsigned char *d, long len);" Item "int SSL_CTX_use_PrivateKey_file(SSL_CTX *ctx, const char *file, int type);" Item "int SSL_CTX_use_RSAPrivateKey(SSL_CTX *ctx, RSA *rsa);" Item "int SSL_CTX_use_RSAPrivateKey_ASN1(SSL_CTX *ctx, unsigned char *d, long len);" Item "int SSL_CTX_use_RSAPrivateKey_file(SSL_CTX *ctx, const char *file, int type);" Item "int SSL_CTX_use_certificate(SSL_CTX *ctx, X509 *x);" Item "int SSL_CTX_use_certificate_ASN1(SSL_CTX *ctx, int len, unsigned char *d);" Item "int SSL_CTX_use_certificate_file(SSL_CTX *ctx, const char *file, int type);" Item "int SSL_CTX_use_cert_and_key(SSL_CTX *ctx, X509 *x, EVP_PKEY *pkey, STACK_OF(X509) *chain, int override);" Item "X509 *SSL_CTX_get0_certificate(const SSL_CTX *ctx);" Item "EVP_PKEY *SSL_CTX_get0_privatekey(const SSL_CTX *ctx);" Item "void 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));" Item "int SSL_CTX_use_psk_identity_hint(SSL_CTX *ctx, const char *hint);" Item "void SSL_CTX_set_psk_server_callback(SSL_CTX *ctx, unsigned int (*callback)(SSL *ssl, const char *identity, unsigned char *psk, int max_psk_len));"

Subsection "Dealing with Sessions" Here we document the various \s-1API\s0 functions which deal with the \s-1SSL/TLS\s0 sessions defined in the \s-1SSL_SESSION\s0 structures. Item "int SSL_SESSION_cmp(const SSL_SESSION *a, const SSL_SESSION *b);"

0

Item "void SSL_SESSION_free(SSL_SESSION *ss);" Item "char *SSL_SESSION_get_app_data(SSL_SESSION *s);" Item "char *SSL_SESSION_get_ex_data(const SSL_SESSION *s, int idx);" Item "int SSL_SESSION_get_ex_new_index(long argl, char *argp, int (*new_func);(void), int (*dup_func)(void), void (*free_func)(void))" Item "long SSL_SESSION_get_time(const SSL_SESSION *s);" Item "long SSL_SESSION_get_timeout(const SSL_SESSION *s);" Item "unsigned long SSL_SESSION_hash(const SSL_SESSION *a);" Item "SSL_SESSION *SSL_SESSION_new(void);" Item "int SSL_SESSION_print(BIO *bp, const SSL_SESSION *x);" Item "int SSL_SESSION_print_fp(FILE *fp, const SSL_SESSION *x);" Item "int SSL_SESSION_set_app_data(SSL_SESSION *s, char *a);" Item "int SSL_SESSION_set_ex_data(SSL_SESSION *s, int idx, char *arg);" Item "long SSL_SESSION_set_time(SSL_SESSION *s, long t);" Item "long SSL_SESSION_set_timeout(SSL_SESSION *s, long t);"

Subsection "Dealing with Connections" Here we document the various \s-1API\s0 functions which deal with the \s-1SSL/TLS\s0 connection defined in the \s-1SSL\s0 structure. Item "int SSL_accept(SSL *ssl);"

0

Item "int SSL_add_dir_cert_subjects_to_stack(STACK *stack, const char *dir);" Item "int SSL_add_file_cert_subjects_to_stack(STACK *stack, const char *file);" Item "int SSL_add_client_CA(SSL *ssl, X509 *x);" Item "char *SSL_alert_desc_string(int value);" Item "char *SSL_alert_desc_string_long(int value);" Item "char *SSL_alert_type_string(int value);" Item "char *SSL_alert_type_string_long(int value);" Item "int SSL_check_private_key(const SSL *ssl);" Item "void SSL_clear(SSL *ssl);" Item "long SSL_clear_num_renegotiations(SSL *ssl);" Item "int SSL_connect(SSL *ssl);" Item "int SSL_copy_session_id(SSL *t, const SSL *f);"

Sets the session details for t to be the same as in f. Returns 1 on success or 0 on failure.

Item "long SSL_ctrl(SSL *ssl, int cmd, long larg, char *parg);"

0

Item "int SSL_do_handshake(SSL *ssl);" Item "SSL *SSL_dup(SSL *ssl);"

\fBSSL_dup() allows applications to configure an \s-1SSL\s0 handle for use in multiple \s-1SSL\s0 connections, and then duplicate it prior to initiating each connection with the duplicated handle. Use of SSL_dup() avoids the need to repeat the configuration of the handles for each connection. .Sp For SSL_dup() to work, the connection \s-1MUST\s0 be in its initial state and \s-1MUST NOT\s0 have not yet have started the \s-1SSL\s0 handshake. For connections that are not in their initial state SSL_dup() just increments an internal reference count and returns the same handle. It may be possible to use SSL_clear\|(3) to recycle an \s-1SSL\s0 handle that is not in its initial state for re-use, but this is best avoided. Instead, save and restore the session, if desired, and construct a fresh handle for each connection.

Item "STACK *SSL_dup_CA_list(STACK *sk);"

0

Item "void SSL_free(SSL *ssl);" Item "SSL_CTX *SSL_get_SSL_CTX(const SSL *ssl);" Item "char *SSL_get_app_data(SSL *ssl);" Item "X509 *SSL_get_certificate(const SSL *ssl);" Item "const char *SSL_get_cipher(const SSL *ssl);" Item "int SSL_is_dtls(const SSL *ssl);" Item "int SSL_get_cipher_bits(const SSL *ssl, int *alg_bits);" Item "char *SSL_get_cipher_list(const SSL *ssl, int n);" Item "char *SSL_get_cipher_name(const SSL *ssl);" Item "char *SSL_get_cipher_version(const SSL *ssl);" Item "STACK *SSL_get_ciphers(const SSL *ssl);" Item "STACK *SSL_get_client_CA_list(const SSL *ssl);" Item "SSL_CIPHER *SSL_get_current_cipher(SSL *ssl);" Item "long SSL_get_default_timeout(const SSL *ssl);" Item "int SSL_get_error(const SSL *ssl, int i);" Item "char *SSL_get_ex_data(const SSL *ssl, int idx);" Item "int SSL_get_ex_data_X509_STORE_CTX_idx(void);" Item "int SSL_get_ex_new_index(long argl, char *argp, int (*new_func);(void), int (*dup_func)(void), void (*free_func)(void))" Item "int SSL_get_fd(const SSL *ssl);" Item "void (*SSL_get_info_callback(const SSL *ssl);)()" Item "int SSL_get_key_update_type(SSL *s);" Item "STACK *SSL_get_peer_cert_chain(const SSL *ssl);" Item "X509 *SSL_get_peer_certificate(const SSL *ssl);" Item "const STACK_OF(SCT) *SSL_get0_peer_scts(SSL *s);" Item "EVP_PKEY *SSL_get_privatekey(const SSL *ssl);" Item "int SSL_get_quiet_shutdown(const SSL *ssl);" Item "BIO *SSL_get_rbio(const SSL *ssl);" Item "int SSL_get_read_ahead(const SSL *ssl);" Item "SSL_SESSION *SSL_get_session(const SSL *ssl);" Item "char *SSL_get_shared_ciphers(const SSL *ssl, char *buf, int size);" Item "int SSL_get_shutdown(const SSL *ssl);" Item "const SSL_METHOD *SSL_get_ssl_method(SSL *ssl);" Item "int SSL_get_state(const SSL *ssl);" Item "long SSL_get_time(const SSL *ssl);" Item "long SSL_get_timeout(const SSL *ssl);" Item "int (*SSL_get_verify_callback(const SSL *ssl))(int, X509_STORE_CTX *)" Item "int SSL_get_verify_mode(const SSL *ssl);" Item "long SSL_get_verify_result(const SSL *ssl);" Item "char *SSL_get_version(const SSL *ssl);" Item "BIO *SSL_get_wbio(const SSL *ssl);" Item "int SSL_in_accept_init(SSL *ssl);" Item "int SSL_in_before(SSL *ssl);" Item "int SSL_in_connect_init(SSL *ssl);" Item "int SSL_in_init(SSL *ssl);" Item "int SSL_is_init_finished(SSL *ssl);" Item "int SSL_key_update(SSL *s, int updatetype);" Item "STACK *SSL_load_client_CA_file(const char *file);" Item "SSL *SSL_new(SSL_CTX *ctx);" Item "int SSL_up_ref(SSL *s);" Item "long SSL_num_renegotiations(SSL *ssl);" Item "int SSL_peek(SSL *ssl, void *buf, int num);" Item "int SSL_pending(const SSL *ssl);" Item "int SSL_read(SSL *ssl, void *buf, int num);" Item "int SSL_renegotiate(SSL *ssl);" Item "char *SSL_rstate_string(SSL *ssl);" Item "char *SSL_rstate_string_long(SSL *ssl);" Item "long SSL_session_reused(SSL *ssl);" Item "void SSL_set_accept_state(SSL *ssl);" Item "void SSL_set_app_data(SSL *ssl, char *arg);" Item "void SSL_set_bio(SSL *ssl, BIO *rbio, BIO *wbio);" Item "int SSL_set_cipher_list(SSL *ssl, char *str);" Item "void SSL_set_client_CA_list(SSL *ssl, STACK *list);" Item "void SSL_set_connect_state(SSL *ssl);" Item "int SSL_set_ct_validation_callback(SSL *ssl, ssl_ct_validation_cb callback, void *arg);" Item "int SSL_set_ex_data(SSL *ssl, int idx, char *arg);" Item "int SSL_set_fd(SSL *ssl, int fd);" Item "void SSL_set_info_callback(SSL *ssl, void (*cb);(void))" Item "void 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));" Item "void SSL_set_msg_callback_arg(SSL *ctx, void *arg);" Item "unsigned long SSL_clear_options(SSL *ssl, unsigned long op);" Item "unsigned long SSL_get_options(SSL *ssl);" Item "unsigned long SSL_set_options(SSL *ssl, unsigned long op);" Item "void SSL_set_quiet_shutdown(SSL *ssl, int mode);" Item "void SSL_set_read_ahead(SSL *ssl, int yes);" Item "int SSL_set_rfd(SSL *ssl, int fd);" Item "int SSL_set_session(SSL *ssl, SSL_SESSION *session);" Item "void SSL_set_shutdown(SSL *ssl, int mode);" Item "int SSL_set_ssl_method(SSL *ssl, const SSL_METHOD *meth);" Item "void SSL_set_time(SSL *ssl, long t);" Item "void SSL_set_timeout(SSL *ssl, long t);" Item "void SSL_set_verify(SSL *ssl, int mode, int (*callback);(void))" Item "void SSL_set_verify_result(SSL *ssl, long arg);" Item "int SSL_set_wfd(SSL *ssl, int fd);" Item "int SSL_shutdown(SSL *ssl);" Item "OSSL_HANDSHAKE_STATE SSL_get_state(const SSL *ssl);"

Returns the current handshake state.

Item "char *SSL_state_string(const SSL *ssl);"

0

Item "char *SSL_state_string_long(const SSL *ssl);" Item "long SSL_total_renegotiations(SSL *ssl);" Item "int SSL_use_PrivateKey(SSL *ssl, EVP_PKEY *pkey);" Item "int SSL_use_PrivateKey_ASN1(int type, SSL *ssl, unsigned char *d, long len);" Item "int SSL_use_PrivateKey_file(SSL *ssl, const char *file, int type);" Item "int SSL_use_RSAPrivateKey(SSL *ssl, RSA *rsa);" Item "int SSL_use_RSAPrivateKey_ASN1(SSL *ssl, unsigned char *d, long len);" Item "int SSL_use_RSAPrivateKey_file(SSL *ssl, const char *file, int type);" Item "int SSL_use_certificate(SSL *ssl, X509 *x);" Item "int SSL_use_certificate_ASN1(SSL *ssl, int len, unsigned char *d);" Item "int SSL_use_certificate_file(SSL *ssl, const char *file, int type);" Item "int SSL_use_cert_and_key(SSL *ssl, X509 *x, EVP_PKEY *pkey, STACK_OF(X509) *chain, int override);" Item "int SSL_version(const SSL *ssl);" Item "int SSL_want(const SSL *ssl);" Item "int SSL_want_nothing(const SSL *ssl);" Item "int SSL_want_read(const SSL *ssl);" Item "int SSL_want_write(const SSL *ssl);" Item "int SSL_want_x509_lookup(const SSL *ssl);" Item "int SSL_write(SSL *ssl, const void *buf, int num);" Item "void 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));" Item "int SSL_use_psk_identity_hint(SSL *ssl, const char *hint);" Item "void SSL_set_psk_server_callback(SSL *ssl, unsigned int (*callback)(SSL *ssl, const char *identity, unsigned char *psk, int max_psk_len));" Item "const char *SSL_get_psk_identity_hint(SSL *ssl);" Item "const char *SSL_get_psk_identity(SSL *ssl);"

Header "RETURN VALUES" See the individual manual pages for details. Header "SEE ALSO" \fBopenssl\|(1), crypto\|(7), \fBCRYPTO_get_ex_new_index\|(3), \fBSSL_accept\|(3), SSL_clear\|(3), \fBSSL_connect\|(3), \fBSSL_CIPHER_get_name\|(3), \fBSSL_COMP_add_compression_method\|(3), \fBSSL_CTX_add_extra_chain_cert\|(3), \fBSSL_CTX_add_session\|(3), \fBSSL_CTX_ctrl\|(3), \fBSSL_CTX_flush_sessions\|(3), \fBSSL_CTX_get_verify_mode\|(3), \fBSSL_CTX_load_verify_locations\|(3) \fBSSL_CTX_new\|(3), \fBSSL_CTX_sess_number\|(3), \fBSSL_CTX_sess_set_cache_size\|(3), \fBSSL_CTX_sess_set_get_cb\|(3), \fBSSL_CTX_sessions\|(3), \fBSSL_CTX_set_cert_store\|(3), \fBSSL_CTX_set_cert_verify_callback\|(3), \fBSSL_CTX_set_cipher_list\|(3), \fBSSL_CTX_set_client_CA_list\|(3), \fBSSL_CTX_set_client_cert_cb\|(3), \fBSSL_CTX_set_default_passwd_cb\|(3), \fBSSL_CTX_set_generate_session_id\|(3), \fBSSL_CTX_set_info_callback\|(3), \fBSSL_CTX_set_max_cert_list\|(3), \fBSSL_CTX_set_mode\|(3), \fBSSL_CTX_set_msg_callback\|(3), \fBSSL_CTX_set_options\|(3), \fBSSL_CTX_set_quiet_shutdown\|(3), \fBSSL_CTX_set_read_ahead\|(3), \fBSSL_CTX_set_security_level\|(3), \fBSSL_CTX_set_session_cache_mode\|(3), \fBSSL_CTX_set_session_id_context\|(3), \fBSSL_CTX_set_ssl_version\|(3), \fBSSL_CTX_set_timeout\|(3), \fBSSL_CTX_set_tmp_dh_callback\|(3), \fBSSL_CTX_set_verify\|(3), \fBSSL_CTX_use_certificate\|(3), \fBSSL_alert_type_string\|(3), \fBSSL_do_handshake\|(3), \fBSSL_enable_ct\|(3), \fBSSL_get_SSL_CTX\|(3), \fBSSL_get_ciphers\|(3), \fBSSL_get_client_CA_list\|(3), \fBSSL_get_default_timeout\|(3), \fBSSL_get_error\|(3), \fBSSL_get_ex_data_X509_STORE_CTX_idx\|(3), \fBSSL_get_fd\|(3), \fBSSL_get_peer_cert_chain\|(3), \fBSSL_get_rbio\|(3), \fBSSL_get_session\|(3), \fBSSL_get_verify_result\|(3), \fBSSL_get_version\|(3), \fBSSL_load_client_CA_file\|(3), \fBSSL_new\|(3), \fBSSL_pending\|(3), \fBSSL_read_ex\|(3), \fBSSL_read\|(3), \fBSSL_rstate_string\|(3), \fBSSL_session_reused\|(3), \fBSSL_set_bio\|(3), \fBSSL_set_connect_state\|(3), \fBSSL_set_fd\|(3), \fBSSL_set_session\|(3), \fBSSL_set_shutdown\|(3), \fBSSL_shutdown\|(3), \fBSSL_state_string\|(3), \fBSSL_want\|(3), \fBSSL_write_ex\|(3), \fBSSL_write\|(3), \fBSSL_SESSION_free\|(3), \fBSSL_SESSION_get_time\|(3), \fBd2i_SSL_SESSION\|(3), \fBSSL_CTX_set_psk_client_callback\|(3), \fBSSL_CTX_use_psk_identity_hint\|(3), \fBSSL_get_psk_identity\|(3), \fBDTLSv1_listen\|(3) Header "HISTORY" \fBSSLv2_client_method, SSLv2_server_method and SSLv2_method were removed in OpenSSL 1.1.0.

The return type of SSL_copy_session_id was changed from void to int in OpenSSL 1.1.0.

Header "COPYRIGHT" Copyright 2000-2018 The OpenSSL Project Authors. All Rights Reserved.

Licensed under the OpenSSL license (the \*(L"License\*(R"). You may not use this file except in compliance with the License. You can obtain a copy in the file \s-1LICENSE\s0 in the source distribution or at <https://www.openssl.org/source/license.html>.