SSL(3) | Library Functions Manual | SSL(3) |
ssl
— OpenSSL
SSL/TLS library
The OpenSSL ssl
library implements the
Transport Layer Security (TLS v1) protocols.
At first the library must be initialized; see SSL_library_init(3).
Then an SSL_CTX object is created as a framework to establish TLS/SSL 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 SSL object. After the SSL object has been created using SSL_new(3), SSL_set_fd(3) or SSL_set_bio(3) can be used to associate the network connection with the object.
Then the TLS/SSL handshake is performed using SSL_accept(3) or SSL_connect(3) respectively. SSL_read(3) and SSL_write(3) are used to read and write data on the TLS/SSL connection. SSL_shutdown(3) can be used to shut down the TLS/SSL connection.
Currently the OpenSSL ssl
library
functions deal with the following data structures:
ssl
library methods/functions which implement the
various protocol versions. It's needed to create an
SSL_CTX. See
TLS_method(3) for
constructors.Currently the OpenSSL ssl
library provides
the following C header files containing the prototypes for the data
structures and functions:
ssl
library
available. It internally includes both more private SSL headers and
headers from the
crypto library.
Whenever you need hardcore details on the internals of the SSL API, look
inside this header file.The following pages describe functions acting on SSL_CIPHER objects: SSL_get_ciphers(3), SSL_get_current_cipher(3), SSL_CIPHER_get_name(3)
The following pages describe functions acting on SSL_CTX objects. Many of these pages also document variants providing similar functionality for individual connection objects.
Constructors and destructors: SSL_CTX_new(3), SSL_CTX_set_ssl_version(3), SSL_CTX_free(3)
Configuration functions: SSL_CTX_add_extra_chain_cert(3), SSL_CTX_ctrl(3), SSL_CTX_flush_sessions(3), SSL_CTX_get_verify_mode(3), SSL_CTX_load_verify_locations(3), SSL_CTX_sess_set_cache_size(3), SSL_CTX_sess_set_get_cb(3), SSL_CTX_set_alpn_select_cb(3), SSL_CTX_set_cert_store(3), SSL_CTX_set_cert_verify_callback(3), SSL_CTX_set_cipher_list(3), SSL_CTX_set_client_CA_list(3), SSL_CTX_set_client_cert_cb(3), SSL_CTX_set_default_passwd_cb(3), SSL_CTX_set_generate_session_id(3), SSL_CTX_set_info_callback(3), SSL_CTX_set_max_cert_list(3), SSL_CTX_set_mode(3), SSL_CTX_set_msg_callback(3), SSL_CTX_set_options(3), SSL_CTX_set_quiet_shutdown(3), SSL_CTX_set_read_ahead(3), SSL_CTX_set_session_cache_mode(3), SSL_CTX_set_session_id_context(3), SSL_CTX_set_timeout(3), SSL_CTX_set_tlsext_status_cb(3), SSL_CTX_set_tlsext_ticket_key_cb(3), SSL_CTX_set_tmp_dh_callback(3), SSL_CTX_set_tmp_rsa_callback(3), SSL_CTX_set_verify(3), SSL_CTX_use_certificate(3), SSL_set1_param(3), SSL_set_max_send_fragment(3)
Accessors: SSL_CTX_get_ex_new_index(3), SSL_CTX_sess_number(3), SSL_CTX_sessions(3), SSL_get_client_CA_list(3)
The following pages describe functions acting on SSL_SESSION objects.
Constructors and destructors: SSL_SESSION_new(3), SSL_SESSION_free(3)
Accessors: SSL_SESSION_get_ex_new_index(3), SSL_SESSION_get_time(3)
Encoding and decoding: d2i_SSL_SESSION(3), PEM_read_SSL_SESSION(3), SSL_SESSION_print(3)
Use by other objects: SSL_CTX_add_session(3), SSL_set_session(3), SSL_get_session(3)
The following pages describe functions acting on SSL connection objects:
Constructors and destructors: SSL_new(3), SSL_set_connect_state(3), SSL_dup(3), SSL_set_bio(3), SSL_set_fd(3), BIO_f_ssl(3), SSL_clear(3), SSL_free(3)
I/O: DTLSv1_listen(3), SSL_accept(3), SSL_connect(3), SSL_do_handshake(3), SSL_read(3), SSL_renegotiate(3), SSL_shutdown(3), SSL_write(3)
Accessors: SSL_copy_session_id(3), SSL_get_SSL_CTX(3), SSL_get_certificate(3), SSL_get_default_timeout(3), SSL_get_error(3), SSL_get_ex_data_X509_STORE_CTX_idx(3), SSL_get_ex_new_index(3), SSL_get_fd(3), SSL_get_peer_cert_chain(3), SSL_get_peer_certificate(3), SSL_get_rbio(3), SSL_get_shared_ciphers(3), SSL_get_state(3), SSL_get_verify_result(3), SSL_get_version(3), SSL_num_renegotiations(3), SSL_pending(3), SSL_rstate_string(3), SSL_session_reused(3), SSL_set_shutdown(3), SSL_set_verify_result(3), SSL_state_string(3), SSL_want(3)
Utility functions: SSL_alert_type_string(3), SSL_dup_CA_list(3), SSL_load_client_CA_file(3)
The ssl
document appeared in OpenSSL
0.9.2.
December 16, 2016 | OpenBSD-6.1 |