NAME<\/a> ssl \u2212 OpenSSL SSL\/TLS library<\/p>\n See the individual manual pages for details.<\/p>\n The OpenSSL ssl<\/b> library implements the Secure Sockets Layer ( SSL<\/small> v2\/v3) and Transport Layer Security ( TLS<\/small> v1) protocols. It provides a rich API<\/small> which is documented here.<\/p>\n An SSL_CTX<\/small><\/b> object is created as a framework to establish TLS\/SSL<\/small> enabled connections (see SSL_CTX_new<\/b>(3)). Various options regarding certificates, algorithms etc. can be set in this object.<\/p>\n When a network connection has been created, it can be assigned to an SSL<\/small><\/b> object. After the SSL<\/small><\/b> object has been created using SSL_new<\/b>(3), SSL_set_fd<\/b>(3) or SSL_set_bio<\/b>(3) can be used to associate the network connection with the object.<\/p>\n When the TLS\/SSL<\/small> handshake is performed using SSL_accept<\/b>(3) or SSL_connect<\/b>(3) respectively. SSL_read_ex<\/b>(3), SSL_read<\/b>(3), SSL_write_ex<\/b>(3) and SSL_write<\/b>(3) are used to read and write data on the TLS\/SSL<\/small> connection. SSL_shutdown<\/b>(3) can be used to shut down the TLS\/SSL<\/small> connection.<\/p>\n Currently the OpenSSL ssl<\/b> library functions deals with the following data structures: This is a dispatch structure describing the internal ssl<\/b> library methods\/functions which implement the various protocol versions (SSLv3 TLSv1, …). It\u2019s needed to create an SSL_CTX<\/small><\/b> .<\/p>\n SSL_CIPHER<\/small><\/b> ( SSL<\/small> Cipher)<\/p>\n This structure holds the algorithm information for a particular cipher which are a core part of the SSL\/TLS<\/small> protocol. The available ciphers are configured on a SSL_CTX<\/small><\/b> basis and the actual ones used are then part of the SSL_SESSION<\/small><\/b> .<\/p>\n SSL_CTX<\/small><\/b> ( SSL<\/small> Context)<\/p>\n 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 SSL<\/small><\/b> structures which are later created for the connections.<\/p>\n SSL_SESSION<\/small><\/b> ( SSL<\/small> Session)<\/p>\n This is a structure containing the current TLS\/SSL<\/small> session details for a connection: SSL_CIPHER<\/small><\/b> s, client and server certificates, keys, etc.<\/p>\n SSL<\/small><\/b> ( SSL<\/small> Connection)<\/p>\n This is the main SSL\/TLS<\/small> structure which is created by a server or client per established connection. This actually is the core structure in the SSL API.<\/small> At run-time the application usually deals with this structure which has links to mostly all other structures.<\/p>\n Currently the OpenSSL ssl<\/b> library provides the following C header files containing the prototypes for the data structures and functions: This is the common header file for the SSL\/TLS API.<\/small> Include it into your program to make the API<\/small> of the ssl<\/b> library available. It internally includes both more private SSL<\/small> headers and headers from the crypto<\/b> library. Whenever you need hard-core details on the internals of the SSL API,<\/small> look inside this header file.<\/p>\n ssl2.h<\/b><\/p>\n Unused. Present for backwards compatibility only.<\/p>\n ssl3.h<\/b><\/p>\n This is the sub header file dealing with the SSLv3 protocol only. Usually you don\u2019t have to include it explicitly because it\u2019s already included by ssl.h<\/i>.<\/p>\n tls1.h<\/b><\/p>\n This is the sub header file dealing with the TLSv1 protocol only. Usually you don\u2019t have to include it explicitly because it\u2019s already included by ssl.h<\/i>.<\/p>\n Currently the OpenSSL ssl<\/b> library exports 214 API<\/small> functions. They are documented in the following:<\/p>\n Dealing with Protocol Methods<\/b> Constructor for the version-flexible<\/i> SSL_METHOD<\/small> structure for clients, servers or both. See SSL_CTX_new<\/b>(3) for details.<\/p>\n const SSL_METHOD<\/small> *TLS_client_method<\/b>(void);<\/p>\n Constructor for the version-flexible<\/i> SSL_METHOD<\/small> structure for clients. Must be used to support the TLSv1.3 protocol.<\/p>\n const SSL_METHOD<\/small> *TLS_server_method<\/b>(void);<\/p>\n Constructor for the version-flexible<\/i> SSL_METHOD<\/small> structure for servers. Must be used to support the TLSv1.3 protocol.<\/p>\n const SSL_METHOD<\/small> *TLSv1_2_method<\/b>(void);<\/p>\n Constructor for the TLSv1.2 SSL_METHOD<\/small> structure for clients, servers or both.<\/p>\n const SSL_METHOD<\/small> *TLSv1_2_client_method<\/b>(void);<\/p>\n Constructor for the TLSv1.2 SSL_METHOD<\/small> structure for clients.<\/p>\n const SSL_METHOD<\/small> *TLSv1_2_server_method<\/b>(void);<\/p>\n Constructor for the TLSv1.2 SSL_METHOD<\/small> structure for servers.<\/p>\n const SSL_METHOD<\/small> *TLSv1_1_method<\/b>(void);<\/p>\n Constructor for the TLSv1.1 SSL_METHOD<\/small> structure for clients, servers or both.<\/p>\n const SSL_METHOD<\/small> *TLSv1_1_client_method<\/b>(void);<\/p>\n Constructor for the TLSv1.1 SSL_METHOD<\/small> structure for clients.<\/p>\n const SSL_METHOD<\/small> *TLSv1_1_server_method<\/b>(void);<\/p>\n Constructor for the TLSv1.1 SSL_METHOD<\/small> structure for servers.<\/p>\n const SSL_METHOD<\/small> *TLSv1_method<\/b>(void);<\/p>\n Constructor for the TLSv1 SSL_METHOD<\/small> structure for clients, servers or both.<\/p>\n const SSL_METHOD<\/small> *TLSv1_client_method<\/b>(void);<\/p>\n Constructor for the TLSv1 SSL_METHOD<\/small> structure for clients.<\/p>\n const SSL_METHOD<\/small> *TLSv1_server_method<\/b>(void);<\/p>\n Constructor for the TLSv1 SSL_METHOD<\/small> structure for servers.<\/p>\n const SSL_METHOD<\/small> *SSLv3_method<\/b>(void);<\/p>\n Constructor for the SSLv3 SSL_METHOD<\/small> structure for clients, servers or both.<\/p>\n const SSL_METHOD<\/small> *SSLv3_client_method<\/b>(void);<\/p>\n Constructor for the SSLv3 SSL_METHOD<\/small> structure for clients.<\/p>\n const SSL_METHOD<\/small> *SSLv3_server_method<\/b>(void);<\/p>\n Constructor for the SSLv3 SSL_METHOD<\/small> structure for servers.<\/p>\n Dealing with Ciphers<\/b> Write a string to buf<\/i> (with a maximum size of len<\/i>) containing a human readable description of cipher<\/i>. Returns buf<\/i>.<\/p>\n int SSL_CIPHER_get_bits<\/b>( SSL_CIPHER<\/small> *cipher, int *alg_bits);<\/p>\n Determine the number of bits in cipher<\/i>. Because of export crippled ciphers there are two bits: The bits the algorithm supports in general (stored to alg_bits<\/i>) and the bits which are actually used (the return value).<\/p>\n const char *SSL_CIPHER_get_name<\/b>( SSL_CIPHER<\/small> *cipher);<\/p>\n Return the internal name of cipher<\/i> as a string. These are the various strings defined by the SSL3_TXT_xxx<\/i> and TLS1_TXT_xxx<\/i> definitions in the header files.<\/p>\n const char *SSL_CIPHER_get_version<\/b>( SSL_CIPHER<\/small> *cipher);<\/p>\n Returns a string like “”SSLv3″” or “”TLSv1.2″” which indicates the SSL\/TLS<\/small> protocol version to which cipher<\/i> belongs (i.e. where it was defined in the specification the first time).<\/p>\n Dealing with Protocol Contexts<\/b> Use the default paths to locate trusted CA<\/small> certificates. There is one default directory path and one default file path. Both are set via this call.<\/p>\n int SSL_CTX_set_default_verify_dir<\/b>( SSL_CTX<\/small> *ctx)<\/p>\n Use the default directory path to locate trusted CA<\/small> certificates.<\/p>\n int SSL_CTX_set_default_verify_file<\/b>( SSL_CTX<\/small> *ctx)<\/p>\n Use the file path to locate trusted CA<\/small> certificates.<\/p>\n int SSL_CTX_set_ex_data<\/b>( SSL_CTX<\/small> *s, int idx, char *arg); Dealing with Sessions<\/b> Dealing with Connections<\/b> Sets the session details for t<\/b> to be the same as in f<\/b>. Returns 1 on success or 0 on failure.<\/p>\n long SSL_ctrl<\/b>( SSL<\/small> *ssl, int cmd, long larg, char *parg); SSL_dup()<\/b> allows applications to configure an SSL<\/small> handle for use in multiple SSL<\/small> connections, and then duplicate it prior to initiating each connection with the duplicated handle. Use of SSL_dup()<\/b> avoids the need to repeat the configuration of the handles for each connection.<\/p>\n For SSL_dup()<\/b> to work, the connection MUST<\/small> be in its initial state and MUST NOT<\/small> have not yet have started the SSL<\/small> handshake. For connections that are not in their initial state SSL_dup()<\/b> just increments an internal reference count and returns the same<\/i> handle. It may be possible to use SSL_clear<\/b>(3) to recycle an SSL<\/small> 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.<\/p>\n STACK<\/small> *SSL_dup_CA_list<\/b>( STACK<\/small> *sk); Returns the current handshake state.<\/p>\n char *SSL_state_string<\/b>(const SSL<\/small> *ssl); See the individual manual pages for details.<\/p>\n openssl<\/b>(1), crypto<\/b>(7), CRYPTO_get_ex_new_index<\/b>(3), SSL_accept<\/b>(3), SSL_clear<\/b>(3), SSL_connect<\/b>(3), SSL_CIPHER_get_name<\/b>(3), SSL_COMP_add_compression_method<\/b>(3), SSL_CTX_add_extra_chain_cert<\/b>(3), SSL_CTX_add_session<\/b>(3), SSL_CTX_ctrl<\/b>(3), SSL_CTX_flush_sessions<\/b>(3), SSL_CTX_get_verify_mode<\/b>(3), SSL_CTX_load_verify_locations<\/b>(3) SSL_CTX_new<\/b>(3), SSL_CTX_sess_number<\/b>(3), SSL_CTX_sess_set_cache_size<\/b>(3), SSL_CTX_sess_set_get_cb<\/b>(3), SSL_CTX_sessions<\/b>(3), SSL_CTX_set_cert_store<\/b>(3), SSL_CTX_set_cert_verify_callback<\/b>(3), SSL_CTX_set_cipher_list<\/b>(3), SSL_CTX_set_client_CA_list<\/b>(3), SSL_CTX_set_client_cert_cb<\/b>(3), SSL_CTX_set_default_passwd_cb<\/b>(3), SSL_CTX_set_generate_session_id<\/b>(3), SSL_CTX_set_info_callback<\/b>(3), SSL_CTX_set_max_cert_list<\/b>(3), SSL_CTX_set_mode<\/b>(3), SSL_CTX_set_msg_callback<\/b>(3), SSL_CTX_set_options<\/b>(3), SSL_CTX_set_quiet_shutdown<\/b>(3), SSL_CTX_set_read_ahead<\/b>(3), SSL_CTX_set_security_level<\/b>(3), SSL_CTX_set_session_cache_mode<\/b>(3), SSL_CTX_set_session_id_context<\/b>(3), SSL_CTX_set_ssl_version<\/b>(3), SSL_CTX_set_timeout<\/b>(3), SSL_CTX_set_tmp_dh_callback<\/b>(3), SSL_CTX_set_verify<\/b>(3), SSL_CTX_use_certificate<\/b>(3), SSL_alert_type_string<\/b>(3), SSL_do_handshake<\/b>(3), SSL_enable_ct<\/b>(3), SSL_get_SSL_CTX<\/b>(3), SSL_get_ciphers<\/b>(3), SSL_get_client_CA_list<\/b>(3), SSL_get_default_timeout<\/b>(3), SSL_get_error<\/b>(3), SSL_get_ex_data_X509_STORE_CTX_idx<\/b>(3), SSL_get_fd<\/b>(3), SSL_get_peer_cert_chain<\/b>(3), SSL_get_rbio<\/b>(3), SSL_get_session<\/b>(3), SSL_get_verify_result<\/b>(3), SSL_get_version<\/b>(3), SSL_load_client_CA_file<\/b>(3), SSL_new<\/b>(3), SSL_pending<\/b>(3), SSL_read_ex<\/b>(3), SSL_read<\/b>(3), SSL_rstate_string<\/b>(3), SSL_session_reused<\/b>(3), SSL_set_bio<\/b>(3), SSL_set_connect_state<\/b>(3), SSL_set_fd<\/b>(3), SSL_set_session<\/b>(3), SSL_set_shutdown<\/b>(3), SSL_shutdown<\/b>(3), SSL_state_string<\/b>(3), SSL_want<\/b>(3), SSL_write_ex<\/b>(3), SSL_write<\/b>(3), SSL_SESSION_free<\/b>(3), SSL_SESSION_get_time<\/b>(3), d2i_SSL_SESSION<\/b>(3), SSL_CTX_set_psk_client_callback<\/b>(3), SSL_CTX_use_psk_identity_hint<\/b>(3), SSL_get_psk_identity<\/b>(3), DTLSv1_listen<\/b>(3)<\/p>\n SSLv2_client_method<\/b>, SSLv2_server_method<\/b> and SSLv2_method<\/b> were removed in OpenSSL 1.1.0.<\/p>\n
SYNOPSIS<\/a>
DESCRIPTION<\/a>
DATA STRUCTURES<\/a>
HEADER FILES<\/a>
API FUNCTIONS<\/a>
RETURN VALUES<\/a>
SEE ALSO<\/a>
HISTORY<\/a>
COPYRIGHT<\/a> <\/p>\n
\nNAME <\/a> <\/h2>\n
SYNOPSIS <\/a> <\/h2>\n
DESCRIPTION <\/a> <\/h2>\n
DATA STRUCTURES <\/a> <\/h2>\n
SSL_METHOD<\/small><\/b> ( SSL<\/small> Method)<\/p>\nHEADER FILES <\/a> <\/h2>\n
ssl.h<\/b><\/p>\nAPI FUNCTIONS <\/a> <\/h2>\n
Here we document the various API<\/small> functions which deal with the SSL\/TLS<\/small> protocol methods defined in SSL_METHOD<\/small><\/b> structures.
const SSL_METHOD<\/small> *TLS_method<\/b>(void);<\/p>\n
Here we document the various API<\/small> functions which deal with the SSL\/TLS<\/small> ciphers defined in SSL_CIPHER<\/small><\/b> structures.
char *SSL_CIPHER_description<\/b>( SSL_CIPHER<\/small> *cipher, char *buf, int len);<\/p>\n
Here we document the various API<\/small> functions which deal with the SSL\/TLS<\/small> protocol context defined in the SSL_CTX<\/small><\/b> structure.
int SSL_CTX_add_client_CA<\/b>( SSL_CTX<\/small> *ctx, X509 *x);
long SSL_CTX_add_extra_chain_cert<\/b>( SSL_CTX<\/small> *ctx, X509 *x509);
int SSL_CTX_add_session<\/b>( SSL_CTX<\/small> *ctx, SSL_SESSION<\/small> *c);
int SSL_CTX_check_private_key<\/b>(const SSL_CTX<\/small> *ctx);
long SSL_CTX_ctrl<\/b>( SSL_CTX<\/small> *ctx, int cmd, long larg, char *parg);
void SSL_CTX_flush_sessions<\/b>( SSL_CTX<\/small> *s, long t);
void SSL_CTX_free<\/b>( SSL_CTX<\/small> *a);
char *SSL_CTX_get_app_data<\/b>( SSL_CTX<\/small> *ctx);
X509_STORE *SSL_CTX_get_cert_store<\/b>( SSL_CTX<\/small> *ctx);
STACK<\/small> *SSL_CTX_get_ciphers<\/b>(const SSL_CTX<\/small> *ctx);
STACK<\/small> *SSL_CTX_get_client_CA_list<\/b>(const SSL_CTX<\/small> *ctx);
int (*SSL_CTX_get_client_cert_cb<\/b>( SSL_CTX<\/small> *ctx))( SSL<\/small> *ssl, X509 **x509,
EVP_PKEY<\/small> **pkey);
void SSL_CTX_get_default_read_ahead<\/b>( SSL_CTX<\/small> *ctx);
char *SSL_CTX_get_ex_data<\/b>(const SSL_CTX<\/small> *s, int idx);
int SSL_CTX_get_ex_new_index<\/b>(long argl, char *argp, int
(*new_func);(void), int (*dup_func)(void), void (*free_func)(void))
void (*SSL_CTX_get_info_callback<\/b>( SSL_CTX<\/small> *ctx))( SSL<\/small> *ssl, int cb, int
ret);
int SSL_CTX_get_quiet_shutdown<\/b>(const SSL_CTX<\/small> *ctx);
void SSL_CTX_get_read_ahead<\/b>( SSL_CTX<\/small> *ctx);
int SSL_CTX_get_session_cache_mode<\/b>( SSL_CTX<\/small> *ctx);
long SSL_CTX_get_timeout<\/b>(const SSL_CTX<\/small> *ctx);
int (*SSL_CTX_get_verify_callback<\/b>(const SSL_CTX<\/small> *ctx))(int ok,
X509_STORE_CTX *ctx);
int SSL_CTX_get_verify_mode<\/b>( SSL_CTX<\/small> *ctx);
int SSL_CTX_load_verify_locations<\/b>( SSL_CTX<\/small> *ctx, const char *CAfile,
const char *CApath);
SSL_CTX<\/small> *SSL_CTX_new<\/b>(const SSL_METHOD<\/small> *meth);
int SSL_CTX_up_ref( SSL_CTX<\/small> *ctx);
int SSL_CTX_remove_session<\/b>( SSL_CTX<\/small> *ctx, SSL_SESSION<\/small> *c);
int SSL_CTX_sess_accept<\/b>( SSL_CTX<\/small> *ctx);
int SSL_CTX_sess_accept_good<\/b>( SSL_CTX<\/small> *ctx);
int SSL_CTX_sess_accept_renegotiate<\/b>( SSL_CTX<\/small> *ctx);
int SSL_CTX_sess_cache_full<\/b>( SSL_CTX<\/small> *ctx);
int SSL_CTX_sess_cb_hits<\/b>( SSL_CTX<\/small> *ctx);
int SSL_CTX_sess_connect<\/b>( SSL_CTX<\/small> *ctx);
int SSL_CTX_sess_connect_good<\/b>( SSL_CTX<\/small> *ctx);
int SSL_CTX_sess_connect_renegotiate<\/b>( SSL_CTX<\/small> *ctx);
int SSL_CTX_sess_get_cache_size<\/b>( SSL_CTX<\/small> *ctx);
SSL_SESSION<\/small> *(*SSL_CTX_sess_get_get_cb<\/b>( SSL_CTX<\/small> *ctx))( SSL<\/small> *ssl,
unsigned char *data, int len, int *copy);
int (*SSL_CTX_sess_get_new_cb<\/b>( SSL_CTX<\/small> *ctx)( SSL<\/small> *ssl, SSL_SESSION<\/small>
*sess);
void (*SSL_CTX_sess_get_remove_cb<\/b>( SSL_CTX<\/small> *ctx)( SSL_CTX<\/small> *ctx,
SSL_SESSION<\/small> *sess);
int SSL_CTX_sess_hits<\/b>( SSL_CTX<\/small> *ctx);
int SSL_CTX_sess_misses<\/b>( SSL_CTX<\/small> *ctx);
int SSL_CTX_sess_number<\/b>( SSL_CTX<\/small> *ctx);
void SSL_CTX_sess_set_cache_size<\/b>( SSL_CTX<\/small> *ctx, t);
void SSL_CTX_sess_set_get_cb<\/b>( SSL_CTX<\/small> *ctx, SSL_SESSION<\/small> *(*cb)( SSL<\/small> *ssl,
unsigned char *data, int len, int *copy));
void SSL_CTX_sess_set_new_cb<\/b>( SSL_CTX<\/small> *ctx, int (*cb)( SSL<\/small> *ssl,
SSL_SESSION<\/small> *sess));
void SSL_CTX_sess_set_remove_cb<\/b>( SSL_CTX<\/small> *ctx, void (*cb)( SSL_CTX<\/small> *ctx,
SSL_SESSION<\/small> *sess));
int SSL_CTX_sess_timeouts<\/b>( SSL_CTX<\/small> *ctx);
LHASH<\/small> *SSL_CTX_sessions<\/b>( SSL_CTX<\/small> *ctx);
int SSL_CTX_set_app_data<\/b>( SSL_CTX<\/small> *ctx, void *arg);
void SSL_CTX_set_cert_store<\/b>( SSL_CTX<\/small> *ctx, X509_STORE *cs);
void SSL_CTX_set1_cert_store<\/b>( SSL_CTX<\/small> *ctx, X509_STORE *cs);
void SSL_CTX_set_cert_verify_cb<\/b>( SSL_CTX<\/small> *ctx, int (*cb)(), char *arg)
int SSL_CTX_set_cipher_list<\/b>( SSL_CTX<\/small> *ctx, char *str);
void SSL_CTX_set_client_CA_list<\/b>( SSL_CTX<\/small> *ctx, STACK<\/small> *list);
void SSL_CTX_set_client_cert_cb<\/b>( SSL_CTX<\/small> *ctx, int (*cb)( SSL<\/small> *ssl, X509
**x509, EVP_PKEY<\/small> **pkey));
int SSL_CTX_set_ct_validation_callback<\/b>( SSL_CTX<\/small> *ctx,
ssl_ct_validation_cb callback, void *arg);
void SSL_CTX_set_default_passwd_cb<\/b>( SSL_CTX<\/small> *ctx, int (*cb);(void))
void SSL_CTX_set_default_read_ahead<\/b>( SSL_CTX<\/small> *ctx, int m);
int SSL_CTX_set_default_verify_paths<\/b>( SSL_CTX<\/small> *ctx);<\/p>\n
void SSL_CTX_set_info_callback<\/b>( SSL_CTX<\/small> *ctx, void (*cb)( SSL<\/small> *ssl, int
cb, int ret));
void SSL_CTX_set_msg_callback<\/b>( SSL_CTX<\/small> *ctx, void (*cb)(int write_p, int
version, int content_type, const void *buf, size_t len, SSL<\/small> *ssl, void
*arg));
void SSL_CTX_set_msg_callback_arg<\/b>( SSL_CTX<\/small> *ctx, void *arg);
unsigned long SSL_CTX_clear_options<\/b>( SSL_CTX<\/small> *ctx, unsigned long op);
unsigned long SSL_CTX_get_options<\/b>( SSL_CTX<\/small> *ctx);
unsigned long SSL_CTX_set_options<\/b>( SSL_CTX<\/small> *ctx, unsigned long op);
void SSL_CTX_set_quiet_shutdown<\/b>( SSL_CTX<\/small> *ctx, int mode);
void SSL_CTX_set_read_ahead<\/b>( SSL_CTX<\/small> *ctx, int m);
void SSL_CTX_set_session_cache_mode<\/b>( SSL_CTX<\/small> *ctx, int mode);
int SSL_CTX_set_ssl_version<\/b>( SSL_CTX<\/small> *ctx, const SSL_METHOD<\/small> *meth);
void SSL_CTX_set_timeout<\/b>( SSL_CTX<\/small> *ctx, long t);
long SSL_CTX_set_tmp_dh<\/b>(SSL_CTX* ctx, DH<\/small> *dh);
long SSL_CTX_set_tmp_dh_callback<\/b>( SSL_CTX<\/small> *ctx, DH<\/small> *(*cb)(void));
void SSL_CTX_set_verify<\/b>( SSL_CTX<\/small> *ctx, int mode, int (*cb);(void))
int SSL_CTX_use_PrivateKey<\/b>( SSL_CTX<\/small> *ctx, EVP_PKEY<\/small> *pkey);
int SSL_CTX_use_PrivateKey_ASN1<\/b>(int type, SSL_CTX<\/small> *ctx, unsigned char
*d, long len);
int SSL_CTX_use_PrivateKey_file<\/b>( SSL_CTX<\/small> *ctx, const char *file, int
type);
int SSL_CTX_use_RSAPrivateKey<\/b>( SSL_CTX<\/small> *ctx, RSA<\/small> *rsa);
int SSL_CTX_use_RSAPrivateKey_ASN1<\/b>( SSL_CTX<\/small> *ctx, unsigned char *d, long
len);
int SSL_CTX_use_RSAPrivateKey_file<\/b>( SSL_CTX<\/small> *ctx, const char *file, int
type);
int SSL_CTX_use_certificate<\/b>( SSL_CTX<\/small> *ctx, X509 *x);
int SSL_CTX_use_certificate_ASN1<\/b>( SSL_CTX<\/small> *ctx, int len, unsigned char
*d);
int SSL_CTX_use_certificate_file<\/b>( SSL_CTX<\/small> *ctx, const char *file, int
type);
int SSL_CTX_use_cert_and_key<\/b>( SSL_CTX<\/small> *ctx, X509 *x, EVP_PKEY<\/small> *pkey,
STACK_OF<\/small> (X509) *chain, int override);
X509 *SSL_CTX_get0_certificate<\/b>(const SSL_CTX<\/small> *ctx);
EVP_PKEY<\/small> *SSL_CTX_get0_privatekey<\/b>(const SSL_CTX<\/small> *ctx);
void SSL_CTX_set_psk_client_callback<\/b>( SSL_CTX<\/small> *ctx, unsigned int
(*callback)( SSL<\/small> *ssl, const char *hint, char *identity, unsigned int
max_identity_len, unsigned char *psk, unsigned int max_psk_len));
int SSL_CTX_use_psk_identity_hint<\/b>( SSL_CTX<\/small> *ctx, const char *hint);
void SSL_CTX_set_psk_server_callback<\/b>( SSL_CTX<\/small> *ctx, unsigned int
(*callback)( SSL<\/small> *ssl, const char *identity, unsigned char *psk, int
max_psk_len));<\/p>\n
Here we document the various API<\/small> functions which deal with the SSL\/TLS<\/small> sessions defined in the SSL_SESSION<\/small><\/b> structures.
int SSL_SESSION_cmp<\/b>(const SSL_SESSION<\/small> *a, const SSL_SESSION<\/small> *b);
void SSL_SESSION_free<\/b>( SSL_SESSION<\/small> *ss);
char *SSL_SESSION_get_app_data<\/b>( SSL_SESSION<\/small> *s);
char *SSL_SESSION_get_ex_data<\/b>(const SSL_SESSION<\/small> *s, int idx);
int SSL_SESSION_get_ex_new_index<\/b>(long argl, char *argp, int
(*new_func);(void), int (*dup_func)(void), void (*free_func)(void))
long SSL_SESSION_get_time<\/b>(const SSL_SESSION<\/small> *s);
long SSL_SESSION_get_timeout<\/b>(const SSL_SESSION<\/small> *s);
unsigned long SSL_SESSION_hash<\/b>(const SSL_SESSION<\/small> *a);
SSL_SESSION<\/small> *SSL_SESSION_new<\/b>(void);
int SSL_SESSION_print<\/b>( BIO<\/small> *bp, const SSL_SESSION<\/small> *x);
int SSL_SESSION_print_fp<\/b>( FILE<\/small> *fp, const SSL_SESSION<\/small> *x);
int SSL_SESSION_set_app_data<\/b>( SSL_SESSION<\/small> *s, char *a);
int SSL_SESSION_set_ex_data<\/b>( SSL_SESSION<\/small> *s, int idx, char *arg);
long SSL_SESSION_set_time<\/b>( SSL_SESSION<\/small> *s, long t);
long SSL_SESSION_set_timeout<\/b>( SSL_SESSION<\/small> *s, long t);<\/p>\n
Here we document the various API<\/small> functions which deal with the SSL\/TLS<\/small> connection defined in the SSL<\/small><\/b> structure.
int SSL_accept<\/b>( SSL<\/small> *ssl);
int SSL_add_dir_cert_subjects_to_stack<\/b>( STACK<\/small> *stack, const char *dir);
int SSL_add_file_cert_subjects_to_stack<\/b>( STACK<\/small> *stack, const char
*file);
int SSL_add_client_CA<\/b>( SSL<\/small> *ssl, X509 *x);
char *SSL_alert_desc_string<\/b>(int value);
char *SSL_alert_desc_string_long<\/b>(int value);
char *SSL_alert_type_string<\/b>(int value);
char *SSL_alert_type_string_long<\/b>(int value);
int SSL_check_private_key<\/b>(const SSL<\/small> *ssl);
void SSL_clear<\/b>( SSL<\/small> *ssl);
long SSL_clear_num_renegotiations<\/b>( SSL<\/small> *ssl);
int SSL_connect<\/b>( SSL<\/small> *ssl);
int SSL_copy_session_id<\/b>( SSL<\/small> *t, const SSL<\/small> *f);<\/p>\n
int SSL_do_handshake<\/b>( SSL<\/small> *ssl);
SSL<\/small> *SSL_dup<\/b>( SSL<\/small> *ssl);<\/p>\n
void SSL_free<\/b>( SSL<\/small> *ssl);
SSL_CTX<\/small> *SSL_get_SSL_CTX<\/b>(const SSL<\/small> *ssl);
char *SSL_get_app_data<\/b>( SSL<\/small> *ssl);
X509 *SSL_get_certificate<\/b>(const SSL<\/small> *ssl);
const char *SSL_get_cipher<\/b>(const SSL<\/small> *ssl);
int SSL_is_dtls<\/b>(const SSL<\/small> *ssl);
int SSL_get_cipher_bits<\/b>(const SSL<\/small> *ssl, int *alg_bits);
char *SSL_get_cipher_list<\/b>(const SSL<\/small> *ssl, int n);
char *SSL_get_cipher_name<\/b>(const SSL<\/small> *ssl);
char *SSL_get_cipher_version<\/b>(const SSL<\/small> *ssl);
STACK<\/small> *SSL_get_ciphers<\/b>(const SSL<\/small> *ssl);
STACK<\/small> *SSL_get_client_CA_list<\/b>(const SSL<\/small> *ssl);
SSL_CIPHER<\/small> *SSL_get_current_cipher<\/b>( SSL<\/small> *ssl);
long SSL_get_default_timeout<\/b>(const SSL<\/small> *ssl);
int SSL_get_error<\/b>(const SSL<\/small> *ssl, int i);
char *SSL_get_ex_data<\/b>(const SSL<\/small> *ssl, int idx);
int SSL_get_ex_data_X509_STORE_CTX_idx<\/b>(void);
int SSL_get_ex_new_index<\/b>(long argl, char *argp, int (*new_func);(void),
int (*dup_func)(void), void (*free_func)(void))
int SSL_get_fd<\/b>(const SSL<\/small> *ssl);
void (*SSL_get_info_callback<\/b>(const SSL<\/small> *ssl);)()
int SSL_get_key_update_type<\/b>( SSL<\/small> *s);
STACK<\/small> *SSL_get_peer_cert_chain<\/b>(const SSL<\/small> *ssl);
X509 *SSL_get_peer_certificate<\/b>(const SSL<\/small> *ssl);
const STACK_OF<\/small> ( SCT<\/small> ) *SSL_get0_peer_scts<\/b>( SSL<\/small> *s);
EVP_PKEY<\/small> *SSL_get_privatekey<\/b>(const SSL<\/small> *ssl);
int SSL_get_quiet_shutdown<\/b>(const SSL<\/small> *ssl);
BIO<\/small> *SSL_get_rbio<\/b>(const SSL<\/small> *ssl);
int SSL_get_read_ahead<\/b>(const SSL<\/small> *ssl);
SSL_SESSION<\/small> *SSL_get_session<\/b>(const SSL<\/small> *ssl);
char *SSL_get_shared_ciphers<\/b>(const SSL<\/small> *ssl, char *buf, int size);
int SSL_get_shutdown<\/b>(const SSL<\/small> *ssl);
const SSL_METHOD<\/small> *SSL_get_ssl_method<\/b>( SSL<\/small> *ssl);
int SSL_get_state<\/b>(const SSL<\/small> *ssl);
long SSL_get_time<\/b>(const SSL<\/small> *ssl);
long SSL_get_timeout<\/b>(const SSL<\/small> *ssl);
int (*SSL_get_verify_callback<\/b>(const SSL<\/small> *ssl))(int, X509_STORE_CTX *)
int SSL_get_verify_mode<\/b>(const SSL<\/small> *ssl);
long SSL_get_verify_result<\/b>(const SSL<\/small> *ssl);
char *SSL_get_version<\/b>(const SSL<\/small> *ssl);
BIO<\/small> *SSL_get_wbio<\/b>(const SSL<\/small> *ssl);
int SSL_in_accept_init<\/b>( SSL<\/small> *ssl);
int SSL_in_before<\/b>( SSL<\/small> *ssl);
int SSL_in_connect_init<\/b>( SSL<\/small> *ssl);
int SSL_in_init<\/b>( SSL<\/small> *ssl);
int SSL_is_init_finished<\/b>( SSL<\/small> *ssl);
int SSL_key_update<\/b>( SSL<\/small> *s, int updatetype);
STACK<\/small> *SSL_load_client_CA_file<\/b>(const char *file);
SSL<\/small> *SSL_new<\/b>( SSL_CTX<\/small> *ctx);
int SSL_up_ref( SSL<\/small> *s);
long SSL_num_renegotiations<\/b>( SSL<\/small> *ssl);
int SSL_peek<\/b>( SSL<\/small> *ssl, void *buf, int num);
int SSL_pending<\/b>(const SSL<\/small> *ssl);
int SSL_read<\/b>( SSL<\/small> *ssl, void *buf, int num);
int SSL_renegotiate<\/b>( SSL<\/small> *ssl);
char *SSL_rstate_string<\/b>( SSL<\/small> *ssl);
char *SSL_rstate_string_long<\/b>( SSL<\/small> *ssl);
long SSL_session_reused<\/b>( SSL<\/small> *ssl);
void SSL_set_accept_state<\/b>( SSL<\/small> *ssl);
void SSL_set_app_data<\/b>( SSL<\/small> *ssl, char *arg);
void SSL_set_bio<\/b>( SSL<\/small> *ssl, BIO<\/small> *rbio, BIO<\/small> *wbio);
int SSL_set_cipher_list<\/b>( SSL<\/small> *ssl, char *str);
void SSL_set_client_CA_list<\/b>( SSL<\/small> *ssl, STACK<\/small> *list);
void SSL_set_connect_state<\/b>( SSL<\/small> *ssl);
int SSL_set_ct_validation_callback<\/b>( SSL<\/small> *ssl, ssl_ct_validation_cb
callback, void *arg);
int SSL_set_ex_data<\/b>( SSL<\/small> *ssl, int idx, char *arg);
int SSL_set_fd<\/b>( SSL<\/small> *ssl, int fd);
void SSL_set_info_callback<\/b>( SSL<\/small> *ssl, void (*cb);(void))
void SSL_set_msg_callback<\/b>( SSL<\/small> *ctx, void (*cb)(int write_p, int
version, int content_type, const void *buf, size_t len, SSL<\/small> *ssl, void
*arg));
void SSL_set_msg_callback_arg<\/b>( SSL<\/small> *ctx, void *arg);
unsigned long SSL_clear_options<\/b>( SSL<\/small> *ssl, unsigned long op);
unsigned long SSL_get_options<\/b>( SSL<\/small> *ssl);
unsigned long SSL_set_options<\/b>( SSL<\/small> *ssl, unsigned long op);
void SSL_set_quiet_shutdown<\/b>( SSL<\/small> *ssl, int mode);
void SSL_set_read_ahead<\/b>( SSL<\/small> *ssl, int yes);
int SSL_set_rfd<\/b>( SSL<\/small> *ssl, int fd);
int SSL_set_session<\/b>( SSL<\/small> *ssl, SSL_SESSION<\/small> *session);
void SSL_set_shutdown<\/b>( SSL<\/small> *ssl, int mode);
int SSL_set_ssl_method<\/b>( SSL<\/small> *ssl, const SSL_METHOD<\/small> *meth);
void SSL_set_time<\/b>( SSL<\/small> *ssl, long t);
void SSL_set_timeout<\/b>( SSL<\/small> *ssl, long t);
void SSL_set_verify<\/b>( SSL<\/small> *ssl, int mode, int (*callback);(void))
void SSL_set_verify_result<\/b>( SSL<\/small> *ssl, long arg);
int SSL_set_wfd<\/b>( SSL<\/small> *ssl, int fd);
int SSL_shutdown<\/b>( SSL<\/small> *ssl);
OSSL_HANDSHAKE_STATE<\/small> SSL_get_state<\/b>(const SSL<\/small> *ssl);<\/p>\n
char *SSL_state_string_long<\/b>(const SSL<\/small> *ssl);
long SSL_total_renegotiations<\/b>( SSL<\/small> *ssl);
int SSL_use_PrivateKey<\/b>( SSL<\/small> *ssl, EVP_PKEY<\/small> *pkey);
int SSL_use_PrivateKey_ASN1<\/b>(int type, SSL<\/small> *ssl, unsigned char *d, long
len);
int SSL_use_PrivateKey_file<\/b>( SSL<\/small> *ssl, const char *file, int type);
int SSL_use_RSAPrivateKey<\/b>( SSL<\/small> *ssl, RSA<\/small> *rsa);
int SSL_use_RSAPrivateKey_ASN1<\/b>( SSL<\/small> *ssl, unsigned char *d, long len);
int SSL_use_RSAPrivateKey_file<\/b>( SSL<\/small> *ssl, const char *file, int type);
int SSL_use_certificate<\/b>( SSL<\/small> *ssl, X509 *x);
int SSL_use_certificate_ASN1<\/b>( SSL<\/small> *ssl, int len, unsigned char *d);
int SSL_use_certificate_file<\/b>( SSL<\/small> *ssl, const char *file, int type);
int SSL_use_cert_and_key<\/b>( SSL<\/small> *ssl, X509 *x, EVP_PKEY<\/small> *pkey,
STACK_OF<\/small> (X509) *chain, int override);
int SSL_version<\/b>(const SSL<\/small> *ssl);
int SSL_want<\/b>(const SSL<\/small> *ssl);
int SSL_want_nothing<\/b>(const SSL<\/small> *ssl);
int SSL_want_read<\/b>(const SSL<\/small> *ssl);
int SSL_want_write<\/b>(const SSL<\/small> *ssl);
int SSL_want_x509_lookup<\/b>(const SSL<\/small> *ssl);
int SSL_write<\/b>( SSL<\/small> *ssl, const void *buf, int num);
void SSL_set_psk_client_callback<\/b>( SSL<\/small> *ssl, unsigned int (*callback)( SSL<\/small>
*ssl, const char *hint, char *identity, unsigned int max_identity_len,
unsigned char *psk, unsigned int max_psk_len));
int SSL_use_psk_identity_hint<\/b>( SSL<\/small> *ssl, const char *hint);
void SSL_set_psk_server_callback<\/b>( SSL<\/small> *ssl, unsigned int (*callback)( SSL<\/small>
*ssl, const char *identity, unsigned char *psk, int max_psk_len));
const char *SSL_get_psk_identity_hint<\/b>( SSL<\/small> *ssl);
const char *SSL_get_psk_identity<\/b>( SSL<\/small> *ssl);<\/p>\nRETURN VALUES <\/a> <\/h2>\n
SEE ALSO <\/a> <\/h2>\n
HISTORY <\/a> <\/h2>\n