Remove outdated info from man7/ssl
[openssl.git] / doc / man7 / ssl.pod
1 =pod
2
3 =head1 NAME
4
5 ssl - OpenSSL SSL/TLS library
6
7 =head1 SYNOPSIS
8
9 See the individual manual pages for details.
10
11 =head1 DESCRIPTION
12
13 The OpenSSL B<ssl> library implements the Secure Sockets Layer (SSL v2/v3) and
14 Transport Layer Security (TLS v1) protocols. It provides a rich API which is
15 documented here.
16
17 An B<SSL_CTX> object is created as a framework to establish
18 TLS/SSL enabled connections (see L<SSL_CTX_new(3)>).
19 Various options regarding certificates, algorithms etc. can be set
20 in this object.
21
22 When a network connection has been created, it can be assigned to an
23 B<SSL> object. After the B<SSL> object has been created using
24 L<SSL_new(3)>, L<SSL_set_fd(3)> or
25 L<SSL_set_bio(3)> can be used to associate the network
26 connection with the object.
27
28 When the TLS/SSL handshake is performed using
29 L<SSL_accept(3)> or L<SSL_connect(3)>
30 respectively.
31 L<SSL_read_ex(3)>, L<SSL_read(3)>, L<SSL_write_ex(3)> and L<SSL_write(3)> are
32 used to read and write data on the TLS/SSL connection.
33 L<SSL_shutdown(3)> can be used to shut down the
34 TLS/SSL connection.
35
36 =head1 DATA STRUCTURES
37
38 Currently the OpenSSL B<ssl> library functions deals with the following data
39 structures:
40
41 =over 4
42
43 =item B<SSL_METHOD> (SSL Method)
44
45 This is a dispatch structure describing the internal B<ssl> library
46 methods/functions which implement the various protocol versions (SSLv3
47 TLSv1, ...). It's needed to create an B<SSL_CTX>.
48
49 =item B<SSL_CIPHER> (SSL Cipher)
50
51 This structure holds the algorithm information for a particular cipher which
52 are a core part of the SSL/TLS protocol. The available ciphers are configured
53 on a B<SSL_CTX> basis and the actual ones used are then part of the
54 B<SSL_SESSION>.
55
56 =item B<SSL_CTX> (SSL Context)
57
58 This is the global context structure which is created by a server or client
59 once per program life-time and which holds mainly default values for the
60 B<SSL> structures which are later created for the connections.
61
62 =item B<SSL_SESSION> (SSL Session)
63
64 This is a structure containing the current TLS/SSL session details for a
65 connection: B<SSL_CIPHER>s, client and server certificates, keys, etc.
66
67 =item B<SSL> (SSL Connection)
68
69 This is the main SSL/TLS structure which is created by a server or client per
70 established connection. This actually is the core structure in the SSL API.
71 At run-time the application usually deals with this structure which has
72 links to mostly all other structures.
73
74 =back
75
76
77 =head1 HEADER FILES
78
79 Currently the OpenSSL B<ssl> library provides the following C header files
80 containing the prototypes for the data structures and functions:
81
82 =over 4
83
84 =item B<ssl.h>
85
86 This is the common header file for the SSL/TLS API.  Include it into your
87 program to make the API of the B<ssl> library available. It internally
88 includes both more private SSL headers and headers from the B<crypto> library.
89 Whenever you need hard-core details on the internals of the SSL API, look
90 inside this header file.
91
92 =item B<ssl2.h>
93
94 Unused. Present for backwards compatibility only.
95
96 =item B<ssl3.h>
97
98 This is the sub header file dealing with the SSLv3 protocol only.
99 I<Usually you don't have to include it explicitly because
100 it's already included by ssl.h>.
101
102 =item B<tls1.h>
103
104 This is the sub header file dealing with the TLSv1 protocol only.
105 I<Usually you don't have to include it explicitly because
106 it's already included by ssl.h>.
107
108 =back
109
110 =head1 SEE ALSO
111
112 L<openssl(1)>, L<crypto(7)>,
113 L<CRYPTO_get_ex_new_index(3)>,
114 L<SSL_accept(3)>, L<SSL_clear(3)>,
115 L<SSL_connect(3)>,
116 L<SSL_CIPHER_get_name(3)>,
117 L<SSL_COMP_add_compression_method(3)>,
118 L<SSL_CTX_add_extra_chain_cert(3)>,
119 L<SSL_CTX_add_session(3)>,
120 L<SSL_CTX_ctrl(3)>,
121 L<SSL_CTX_flush_sessions(3)>,
122 L<SSL_CTX_get_verify_mode(3)>,
123 L<SSL_CTX_load_verify_locations(3)>
124 L<SSL_CTX_new(3)>,
125 L<SSL_CTX_sess_number(3)>,
126 L<SSL_CTX_sess_set_cache_size(3)>,
127 L<SSL_CTX_sess_set_get_cb(3)>,
128 L<SSL_CTX_sessions(3)>,
129 L<SSL_CTX_set_cert_store(3)>,
130 L<SSL_CTX_set_cert_verify_callback(3)>,
131 L<SSL_CTX_set_cipher_list(3)>,
132 L<SSL_CTX_set_client_CA_list(3)>,
133 L<SSL_CTX_set_client_cert_cb(3)>,
134 L<SSL_CTX_set_default_passwd_cb(3)>,
135 L<SSL_CTX_set_generate_session_id(3)>,
136 L<SSL_CTX_set_info_callback(3)>,
137 L<SSL_CTX_set_max_cert_list(3)>,
138 L<SSL_CTX_set_mode(3)>,
139 L<SSL_CTX_set_msg_callback(3)>,
140 L<SSL_CTX_set_options(3)>,
141 L<SSL_CTX_set_quiet_shutdown(3)>,
142 L<SSL_CTX_set_read_ahead(3)>,
143 L<SSL_CTX_set_security_level(3)>,
144 L<SSL_CTX_set_session_cache_mode(3)>,
145 L<SSL_CTX_set_session_id_context(3)>,
146 L<SSL_CTX_set_srp_password(3)>,
147 L<SSL_CTX_set_ssl_version(3)>,
148 L<SSL_CTX_set_timeout(3)>,
149 L<SSL_CTX_set_tmp_dh_callback(3)>,
150 L<SSL_CTX_set_tmp_ecdh(3)>,
151 L<SSL_CTX_set_verify(3)>,
152 L<SSL_CTX_use_certificate(3)>,
153 L<SSL_alert_type_string(3)>,
154 L<SSL_do_handshake(3)>,
155 L<SSL_enable_ct(3)>,
156 L<SSL_get_SSL_CTX(3)>,
157 L<SSL_get_ciphers(3)>,
158 L<SSL_get_client_CA_list(3)>,
159 L<SSL_get_default_timeout(3)>,
160 L<SSL_get_error(3)>,
161 L<SSL_get_ex_data_X509_STORE_CTX_idx(3)>,
162 L<SSL_get_fd(3)>,
163 L<SSL_get_peer_cert_chain(3)>,
164 L<SSL_get_rbio(3)>,
165 L<SSL_get_session(3)>,
166 L<SSL_get_verify_result(3)>,
167 L<SSL_get_version(3)>,
168 L<SSL_load_client_CA_file(3)>,
169 L<SSL_new(3)>,
170 L<SSL_pending(3)>,
171 L<SSL_read_ex(3)>,
172 L<SSL_read(3)>,
173 L<SSL_rstate_string(3)>,
174 L<SSL_session_reused(3)>,
175 L<SSL_set_bio(3)>,
176 L<SSL_set_connect_state(3)>,
177 L<SSL_set_fd(3)>,
178 L<SSL_set_session(3)>,
179 L<SSL_set_shutdown(3)>,
180 L<SSL_shutdown(3)>,
181 L<SSL_state_string(3)>,
182 L<SSL_want(3)>,
183 L<SSL_write_ex(3)>,
184 L<SSL_write(3)>,
185 L<SSL_SESSION_free(3)>,
186 L<SSL_SESSION_get_time(3)>,
187 L<d2i_SSL_SESSION(3)>,
188 L<SSL_CTX_set_psk_client_callback(3)>,
189 L<SSL_CTX_use_psk_identity_hint(3)>,
190 L<SSL_get_psk_identity(3)>,
191 L<DTLSv1_listen(3)>
192
193 =head1 COPYRIGHT
194
195 Copyright 2000-2018 The OpenSSL Project Authors. All Rights Reserved.
196
197 Licensed under the Apache License 2.0 (the "License").  You may not use
198 this file except in compliance with the License.  You can obtain a copy
199 in the file LICENSE in the source distribution or at
200 L<https://www.openssl.org/source/license.html>.
201
202 =cut