diff options
author | Rich Salz <rsalz@akamai.com> | 2019-11-01 12:29:34 -0400 |
---|---|---|
committer | Tomas Mraz <tmraz@fedoraproject.org> | 2019-11-06 19:38:32 +0100 |
commit | ccd9e70d4efeb2c7a258ba0a567b898174286b13 (patch) | |
tree | 968d4d55b5e53f0e78674f489552b44715eb43bc | |
parent | 98ca37e4aa2a79b59a3378faee4ff3d6e05188cd (diff) |
Strip much out of ssl.pod
Reviewed-by: Matt Caswell <matt@openssl.org>
Reviewed-by: Tomas Mraz <tmraz@fedoraproject.org>
(Merged from https://github.com/openssl/openssl/pull/10208)
-rw-r--r-- | doc/man7/ssl.pod | 108 |
1 files changed, 11 insertions, 97 deletions
diff --git a/doc/man7/ssl.pod b/doc/man7/ssl.pod index ae40dac084..7aff45c5cc 100644 --- a/doc/man7/ssl.pod +++ b/doc/man7/ssl.pod @@ -10,9 +10,11 @@ See the individual manual pages for details. =head1 DESCRIPTION -The OpenSSL B<ssl> library implements the Secure Sockets Layer (SSL v2/v3) and -Transport Layer Security (TLS v1) protocols. It provides a rich API which is -documented here. +The OpenSSL B<ssl> library implements several versions of the +Secure Sockets Layer, Transport Layer Security, and Datagram Transport Layer +Security protocols. +This page gives a brief overview of the extensive API and data types +provided by the library. An B<SSL_CTX> object is created as a framework to establish TLS/SSL enabled connections (see L<SSL_CTX_new(3)>). @@ -35,8 +37,7 @@ TLS/SSL connection. =head1 DATA STRUCTURES -Currently the OpenSSL B<ssl> library functions deals with the following data -structures: +Here are some of the main data structures in the library. =over 4 @@ -73,7 +74,6 @@ links to mostly all other structures. =back - =head1 HEADER FILES Currently the OpenSSL B<ssl> library provides the following C header files @@ -81,115 +81,29 @@ containing the prototypes for the data structures and functions: =over 4 -=item B<ssl.h> +=item F<< <openssl/ssl.h> >> This is the common header file for the SSL/TLS API. Include it into your program to make the API of the B<ssl> library available. It internally includes both more private SSL headers and headers from the B<crypto> library. Whenever you need hard-core details on the internals of the SSL API, look inside this header file. +This file also includes the others listed below. -=item B<ssl2.h> +=item F<< <openssl/ssl2.h> >> Unused. Present for backwards compatibility only. -=item B<ssl3.h> +=item F<< <openssl/ssl3.h> >> This is the sub header file dealing with the SSLv3 protocol only. -I<Usually you don't have to include it explicitly because -it's already included by ssl.h>. -=item B<tls1.h> +=item F<< <openssl/tls1.h> >> This is the sub header file dealing with the TLSv1 protocol only. -I<Usually you don't have to include it explicitly because -it's already included by ssl.h>. =back -=head1 SEE ALSO - -L<openssl(1)>, L<crypto(7)>, -L<CRYPTO_get_ex_new_index(3)>, -L<SSL_accept(3)>, L<SSL_clear(3)>, -L<SSL_connect(3)>, -L<SSL_CIPHER_get_name(3)>, -L<SSL_COMP_add_compression_method(3)>, -L<SSL_CTX_add_extra_chain_cert(3)>, -L<SSL_CTX_add_session(3)>, -L<SSL_CTX_ctrl(3)>, -L<SSL_CTX_flush_sessions(3)>, -L<SSL_CTX_get_verify_mode(3)>, -L<SSL_CTX_load_verify_locations(3)> -L<SSL_CTX_new(3)>, -L<SSL_CTX_sess_number(3)>, -L<SSL_CTX_sess_set_cache_size(3)>, -L<SSL_CTX_sess_set_get_cb(3)>, -L<SSL_CTX_sessions(3)>, -L<SSL_CTX_set_cert_store(3)>, -L<SSL_CTX_set_cert_verify_callback(3)>, -L<SSL_CTX_set_cipher_list(3)>, -L<SSL_CTX_set_client_CA_list(3)>, -L<SSL_CTX_set_client_cert_cb(3)>, -L<SSL_CTX_set_default_passwd_cb(3)>, -L<SSL_CTX_set_generate_session_id(3)>, -L<SSL_CTX_set_info_callback(3)>, -L<SSL_CTX_set_max_cert_list(3)>, -L<SSL_CTX_set_mode(3)>, -L<SSL_CTX_set_msg_callback(3)>, -L<SSL_CTX_set_options(3)>, -L<SSL_CTX_set_quiet_shutdown(3)>, -L<SSL_CTX_set_read_ahead(3)>, -L<SSL_CTX_set_security_level(3)>, -L<SSL_CTX_set_session_cache_mode(3)>, -L<SSL_CTX_set_session_id_context(3)>, -L<SSL_CTX_set_srp_password(3)>, -L<SSL_CTX_set_ssl_version(3)>, -L<SSL_CTX_set_timeout(3)>, -L<SSL_CTX_set_tmp_dh_callback(3)>, -L<SSL_CTX_set_tmp_ecdh(3)>, -L<SSL_CTX_set_verify(3)>, -L<SSL_CTX_use_certificate(3)>, -L<SSL_alert_type_string(3)>, -L<SSL_do_handshake(3)>, -L<SSL_enable_ct(3)>, -L<SSL_get_SSL_CTX(3)>, -L<SSL_get_ciphers(3)>, -L<SSL_get_client_CA_list(3)>, -L<SSL_get_default_timeout(3)>, -L<SSL_get_error(3)>, -L<SSL_get_ex_data_X509_STORE_CTX_idx(3)>, -L<SSL_get_fd(3)>, -L<SSL_get_peer_cert_chain(3)>, -L<SSL_get_rbio(3)>, -L<SSL_get_session(3)>, -L<SSL_get_verify_result(3)>, -L<SSL_get_version(3)>, -L<SSL_load_client_CA_file(3)>, -L<SSL_new(3)>, -L<SSL_pending(3)>, -L<SSL_read_ex(3)>, -L<SSL_read(3)>, -L<SSL_rstate_string(3)>, -L<SSL_session_reused(3)>, -L<SSL_set_bio(3)>, -L<SSL_set_connect_state(3)>, -L<SSL_set_fd(3)>, -L<SSL_set_session(3)>, -L<SSL_set_shutdown(3)>, -L<SSL_shutdown(3)>, -L<SSL_state_string(3)>, -L<SSL_want(3)>, -L<SSL_write_ex(3)>, -L<SSL_write(3)>, -L<SSL_SESSION_free(3)>, -L<SSL_SESSION_get_time(3)>, -L<d2i_SSL_SESSION(3)>, -L<SSL_CTX_set_psk_client_callback(3)>, -L<SSL_CTX_use_psk_identity_hint(3)>, -L<SSL_get_psk_identity(3)>, -L<DTLSv1_listen(3)> - =head1 COPYRIGHT Copyright 2000-2018 The OpenSSL Project Authors. All Rights Reserved. |