The OpenSSL ssl library implements the Secure Sockets Layer (SSL v2/v3) and Transport Layer Security (TLS v1) protocols. The library functions are used by OpenSSL implementations of SSL, TLS and S/MIME. In addition, they are used in well-known software such as SSH, OpenPGP, and others.

See also: the libssl API.

Alphabetical Listing

Below is the list of available manual pages, sorted alphabetically for a quick lookup.

1d2i_SSL_SESSIONconvert SSL_SESSION object from/to ASN1 representation
2SSL_acceptwait for a TLS/SSL client to initiate a TLS/SSL handshake
3SSL_alert_type_stringget textual description of alert information
4SSL_CIPHER_get_nameget SSL_CIPHER properties
5SSL_clearreset SSL object to allow another connection
6SSL_COMP_add_compression_methodhandle SSL/TLS integrated compression methods
7SSL_connectinitiate the TLS/SSL handshake with an TLS/SSL server
8SSL_CTX_add_extra_chain_certadd certificate to chain
9SSL_CTX_add_sessionmanipulate session cache
10SSL_CTX_ctrlinternal handling functions for SSL_CTX and SSL objects
11SSL_CTX_flush_sessionsremove expired sessions
12SSL_CTX_freefree an allocated SSL_CTX object
13SSL_CTX_get_ex_new_indexinternal application specific data functions
14SSL_CTX_get_verify_modeget currently set verification parameters
15SSL_CTX_load_verify_locationsset default locations for trusted CA certificates
16SSL_CTX_newcreate a new SSL_CTX object as framework for TLS/SSL enabled functions
17SSL_CTX_sessionsaccess internal session cache
18SSL_CTX_sess_numberobtain session cache statistics
19SSL_CTX_sess_set_cache_sizemanipulate session cache size
20SSL_CTX_sess_set_get_cbprovide callback functions for server side external session caching
21SSL_CTX_set_cert_storemanipulate X509 certificate verification storage
22SSL_CTX_set_cert_verify_callbackset peer certificate verification procedure
23SSL_CTX_set_cipher_listchoose list of available SSL_CIPHERs
24SSL_CTX_set_client_CA_listset list of CAs sent to the client when requesting a client certificate
25SSL_CTX_set_client_cert_cbhandle client certificate callback function
26SSL_CTX_set_default_passwd_cbset passwd callback for encrypted PEM file handling
27SSL_CTX_set_generate_session_idmanipulate generation of SSL session IDs (server only)
28SSL_CTX_set_info_callbackhandle information callback for SSL connections
29SSL_CTX_set_max_cert_listmanipulate allowed for the peer's certificate chain
30SSL_CTX_set_modemanipulate SSL engine mode
31SSL_CTX_set_msg_callbackinstall callback for observing protocol messages
32SSL_CTX_set_optionsmanipulate SSL options
33SSL_CTX_set_psk_client_callbackset PSK client callback
34SSL_CTX_set_quiet_shutdownmanipulate shutdown behaviour
35SSL_CTX_set_session_cache_modeenable/disable session caching
36SSL_CTX_set_session_id_contextset context within which session can be reused (server side only)
37SSL_CTX_set_ssl_versionchoose a new TLS/SSL method
38SSL_CTX_set_timeoutmanipulate timeout values for session caching
39SSL_CTX_set_tmp_dh_callbackhandle DH keys for ephemeral key exchange
40SSL_CTX_set_tmp_rsa_callbackhandle RSA keys for ephemeral key exchange
41SSL_CTX_set_verifyset peer certificate verification parameters
42SSL_CTX_use_certificateload certificate and key data
43SSL_CTX_use_psk_identity_hintset PSK identity hint to use
44SSL_do_handshakeperform a TLS/SSL handshake
45SSL_freefree an allocated SSL structure
46SSL_get_ciphersget list of available SSL_CIPHERs
47SSL_get_client_CA_listget list of client CAs
48SSL_get_current_cipherget SSL_CIPHER of a connection
49SSL_get_default_timeoutget default session timeout value
50SSL_get_errorobtain result code for TLS/SSL I/O operation
51SSL_get_ex_data_X509_STORE_CTX_idxget ex_data index to access SSL structure from X509_STORE_CTX
52SSL_get_ex_new_indexinternal application specific data functions
53SSL_get_fdget file descriptor linked to an SSL object
54SSL_get_peer_cert_chainget the X509 certificate chain of the peer
55SSL_get_peer_certificateget the X509 certificate of the peer
56SSL_get_psk_identityget PSK client identity and hint
57SSL_get_rbioget BIO linked to an SSL object
58SSL_get_sessionretrieve TLS/SSL session data
59SSL_get_SSL_CTXget the SSL_CTX from which an SSL is created
60SSL_get_verify_resultget result of peer certificate verification
61SSL_get_versionget the protocol version of a connection.
62SSL_library_initinitialize SSL library by registering algorithms
63SSL_load_client_CA_fileload certificate names from file
64SSL_newcreate a new SSL structure for a connection
65SSL_pendingobtain number of readable bytes buffered in an SSL object
66SSL_readread bytes from a TLS/SSL connection.
67SSL_rstate_stringget textual description of state of an SSL object during read operation
68SSL_SESSION_freefree an allocated SSL_SESSION structure
69SSL_SESSION_get_ex_new_indexinternal application specific data functions
70SSL_SESSION_get_timeretrieve and manipulate session time and timeout settings
71SSL_session_reusedquery whether a reused session was negotiated during handshake
72SSL_set_bioconnect the SSL object with a BIO
73SSL_set_connect_stateprepare SSL object to work in client or server mode
74SSL_set_fdconnect the SSL object with a file descriptor
75SSL_set_sessionset a TLS/SSL session to be used during TLS/SSL connect
76SSL_set_shutdownmanipulate shutdown state of an SSL connection
77SSL_set_verify_resultoverride result of peer certificate verification
78SSL_shutdownshut down a TLS/SSL connection
79SSL_state_stringget textual description of state of an SSL object
80SSL_wantobtain state information TLS/SSL I/O operation
81SSL_writewrite bytes to a TLS/SSL connection.

OpenSSL Logo