summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorschwarze <>2019-06-12 09:03:43 +0000
committerschwarze <>2019-06-12 09:03:43 +0000
commit96142c1560e4499792efbbedf916fc57c69b733e (patch)
tree41833b315f81ac963e44317144cbb930c1e06d68
parent6be28dc6a94d5924375aa3d5124cd3437ce39e7b (diff)
downloadopenbsd-96142c1560e4499792efbbedf916fc57c69b733e.tar.gz
openbsd-96142c1560e4499792efbbedf916fc57c69b733e.tar.bz2
openbsd-96142c1560e4499792efbbedf916fc57c69b733e.zip
List all 17 SSL pages that were missing.
Split some excessively long lists into useful sub-categories. Add a new, very short subsection "Obsolete functions" at the end. OK tb@ jmc@
-rw-r--r--src/lib/libssl/man/ssl.3140
1 files changed, 89 insertions, 51 deletions
diff --git a/src/lib/libssl/man/ssl.3 b/src/lib/libssl/man/ssl.3
index 4877342ba1..7683599652 100644
--- a/src/lib/libssl/man/ssl.3
+++ b/src/lib/libssl/man/ssl.3
@@ -1,4 +1,4 @@
1.\" $OpenBSD: ssl.3,v 1.15 2019/04/05 18:29:43 schwarze Exp $ 1.\" $OpenBSD: ssl.3,v 1.16 2019/06/12 09:03:43 schwarze Exp $
2.\" full merge up to: OpenSSL e330f55d Nov 11 00:51:04 2016 +0100 2.\" full merge up to: OpenSSL e330f55d Nov 11 00:51:04 2016 +0100
3.\" selective merge up to: OpenSSL cbade361 Dec 12 13:14:45 2017 +0100 3.\" selective merge up to: OpenSSL cbade361 Dec 12 13:14:45 2017 +0100
4.\" 4.\"
@@ -51,7 +51,7 @@
51.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED 51.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
52.\" OF THE POSSIBILITY OF SUCH DAMAGE. 52.\" OF THE POSSIBILITY OF SUCH DAMAGE.
53.\" 53.\"
54.Dd $Mdocdate: April 5 2019 $ 54.Dd $Mdocdate: June 12 2019 $
55.Dt SSL 3 55.Dt SSL 3
56.Os 56.Os
57.Sh NAME 57.Sh NAME
@@ -191,50 +191,77 @@ objects:
191The following pages describe functions acting on 191The following pages describe functions acting on
192.Vt SSL_CTX 192.Vt SSL_CTX
193objects. 193objects.
194Many of these pages also document variants providing similar
195functionality for individual connection objects.
196.Pp 194.Pp
197Constructors and destructors: 195Constructors and destructors:
198.Xr SSL_CTX_new 3 , 196.Xr SSL_CTX_new 3 ,
199.Xr SSL_CTX_set_ssl_version 3 , 197.Xr SSL_CTX_set_ssl_version 3 ,
200.Xr SSL_CTX_free 3 198.Xr SSL_CTX_free 3
201.Pp 199.Pp
202Configuration functions: 200Certificate configuration:
203.Xr SSL_CTX_add1_chain_cert 3 ,
204.Xr SSL_CTX_add_extra_chain_cert 3 , 201.Xr SSL_CTX_add_extra_chain_cert 3 ,
205.Xr SSL_CTX_ctrl 3 , 202.Xr SSL_CTX_get0_certificate 3 ,
206.Xr SSL_CTX_flush_sessions 3 ,
207.Xr SSL_CTX_get_verify_mode 3 ,
208.Xr SSL_CTX_load_verify_locations 3 , 203.Xr SSL_CTX_load_verify_locations 3 ,
209.Xr SSL_CTX_sess_set_get_cb 3 ,
210.Xr SSL_CTX_set_alpn_select_cb 3 ,
211.Xr SSL_CTX_set_cert_store 3 , 204.Xr SSL_CTX_set_cert_store 3 ,
212.Xr SSL_CTX_set_cert_verify_callback 3 , 205.Xr SSL_CTX_set_cert_verify_callback 3 ,
213.Xr SSL_CTX_set_cipher_list 3 ,
214.Xr SSL_CTX_set_client_CA_list 3 ,
215.Xr SSL_CTX_set_client_cert_cb 3 , 206.Xr SSL_CTX_set_client_cert_cb 3 ,
216.Xr SSL_CTX_set_default_passwd_cb 3 , 207.Xr SSL_CTX_set_default_passwd_cb 3 ,
217.Xr SSL_CTX_set_generate_session_id 3 , 208.Xr SSL_CTX_set_tlsext_status_cb 3
218.Xr SSL_CTX_set_info_callback 3 , 209.Pp
210Session configuration:
211.Xr SSL_CTX_add_session 3 ,
212.Xr SSL_CTX_flush_sessions 3 ,
213.Xr SSL_CTX_sess_number 3 ,
214.Xr SSL_CTX_sess_set_cache_size 3 ,
215.Xr SSL_CTX_sess_set_get_cb 3 ,
216.Xr SSL_CTX_sessions 3 ,
217.Xr SSL_CTX_set_session_cache_mode 3 ,
218.Xr SSL_CTX_set_timeout 3 ,
219.Xr SSL_CTX_set_tlsext_ticket_key_cb 3
220.Pp
221Various configuration:
222.Xr SSL_CTX_get_ex_new_index 3 ,
223.Xr SSL_CTX_set_tlsext_servername_callback 3
224.Ss Common configuration of contexts and connections
225The functions on the following pages each come in two variants:
226one to directly configure a single
227.Vt SSL
228connection and another to be called on an
229.Vt SSL_CTX
230object, to set up defaults for all future
231.Vt SSL
232connections created from that context.
233.Pp
234Protocol and algorithm configuration:
235.Xr SSL_CTX_set_alpn_select_cb 3 ,
236.Xr SSL_CTX_set_cipher_list 3 ,
219.Xr SSL_CTX_set_min_proto_version 3 , 237.Xr SSL_CTX_set_min_proto_version 3 ,
220.Xr SSL_CTX_set_msg_callback 3 ,
221.Xr SSL_CTX_set_options 3 , 238.Xr SSL_CTX_set_options 3 ,
222.Xr SSL_CTX_set_quiet_shutdown 3 , 239.Xr SSL_CTX_set_tlsext_use_srtp 3 ,
223.Xr SSL_CTX_set_read_ahead 3 ,
224.Xr SSL_CTX_set_session_id_context 3 ,
225.Xr SSL_CTX_set_timeout 3 ,
226.Xr SSL_CTX_set_tmp_dh_callback 3 , 240.Xr SSL_CTX_set_tmp_dh_callback 3 ,
227.Xr SSL_CTX_set_tmp_rsa_callback 3 , 241.Xr SSL_CTX_set1_groups 3
242.Pp
243Certificate configuration:
244.Xr SSL_CTX_add1_chain_cert 3 ,
245.Xr SSL_CTX_get_verify_mode 3 ,
246.Xr SSL_CTX_set_client_CA_list 3 ,
247.Xr SSL_CTX_set_max_cert_list 3 ,
228.Xr SSL_CTX_set_verify 3 , 248.Xr SSL_CTX_set_verify 3 ,
229.Xr SSL_CTX_set1_groups 3 ,
230.Xr SSL_CTX_use_certificate 3 , 249.Xr SSL_CTX_use_certificate 3 ,
231.Xr SSL_set_tmp_ecdh 3 , 250.Xr SSL_get_client_CA_list 3
232.Xr SSL_set1_param 3 251.Xr SSL_set1_param 3
233.Pp 252.Pp
234Accessors: 253Session configuration:
235.Xr SSL_CTX_get_ex_new_index 3 , 254.Xr SSL_CTX_set_generate_session_id 3 ,
236.Xr SSL_CTX_sessions 3 , 255.Xr SSL_CTX_set_session_id_context 3
237.Xr SSL_get_client_CA_list 3 256.Pp
257Various configuration:
258.Xr SSL_CTX_ctrl 3 ,
259.Xr SSL_CTX_set_info_callback 3 ,
260.Xr SSL_CTX_set_mode 3 ,
261.Xr SSL_CTX_set_msg_callback 3 ,
262.Xr SSL_CTX_set_quiet_shutdown 3 ,
263.Xr SSL_CTX_set_read_ahead 3 ,
264.Xr SSL_set_max_send_fragment 3
238.Ss Sessions 265.Ss Sessions
239The following pages describe functions acting on 266The following pages describe functions acting on
240.Vt SSL_SESSION 267.Vt SSL_SESSION
@@ -258,11 +285,6 @@ Encoding and decoding:
258.Xr d2i_SSL_SESSION 3 , 285.Xr d2i_SSL_SESSION 3 ,
259.Xr PEM_read_SSL_SESSION 3 , 286.Xr PEM_read_SSL_SESSION 3 ,
260.Xr SSL_SESSION_print 3 287.Xr SSL_SESSION_print 3
261.Pp
262Use by other objects:
263.Xr SSL_CTX_add_session 3 ,
264.Xr SSL_set_session 3 ,
265.Xr SSL_get_session 3
266.Ss Connections 288.Ss Connections
267The following pages describe functions acting on 289The following pages describe functions acting on
268.Vt SSL 290.Vt SSL
@@ -270,15 +292,28 @@ connection objects:
270.Pp 292.Pp
271Constructors and destructors: 293Constructors and destructors:
272.Xr SSL_new 3 , 294.Xr SSL_new 3 ,
273.Xr SSL_set_connect_state 3 ,
274.Xr SSL_dup 3 , 295.Xr SSL_dup 3 ,
296.Xr SSL_free 3 ,
297.Xr BIO_f_ssl 3
298.Pp
299To change the configuration:
300.Xr SSL_clear 3 ,
301.Xr SSL_copy_session_id 3 ,
275.Xr SSL_set_bio 3 , 302.Xr SSL_set_bio 3 ,
303.Xr SSL_set_connect_state 3 ,
276.Xr SSL_set_fd 3 , 304.Xr SSL_set_fd 3 ,
277.Xr BIO_f_ssl 3 , 305.Xr SSL_set_session 3 ,
278.Xr SSL_clear 3 , 306.Xr SSL_set_verify_result 3
279.Xr SSL_free 3
280.Pp 307.Pp
281I/O: 308To inspect the configuration:
309.Xr SSL_get_certificate 3 ,
310.Xr SSL_get_default_timeout 3 ,
311.Xr SSL_get_ex_new_index 3 ,
312.Xr SSL_get_fd 3 ,
313.Xr SSL_get_rbio 3 ,
314.Xr SSL_get_SSL_CTX 3
315.Pp
316To transmit data:
282.Xr DTLSv1_listen 3 , 317.Xr DTLSv1_listen 3 ,
283.Xr SSL_accept 3 , 318.Xr SSL_accept 3 ,
284.Xr SSL_connect 3 , 319.Xr SSL_connect 3 ,
@@ -288,35 +323,38 @@ I/O:
288.Xr SSL_shutdown 3 , 323.Xr SSL_shutdown 3 ,
289.Xr SSL_write 3 324.Xr SSL_write 3
290.Pp 325.Pp
291Accessors: 326To inspect the state after a connection is established:
292.Xr SSL_copy_session_id 3 ,
293.Xr SSL_export_keying_material 3 , 327.Xr SSL_export_keying_material 3 ,
294.Xr SSL_get_SSL_CTX 3 ,
295.Xr SSL_get_certificate 3 ,
296.Xr SSL_get_client_random 3 , 328.Xr SSL_get_client_random 3 ,
297.Xr SSL_get_default_timeout 3 ,
298.Xr SSL_get_error 3 ,
299.Xr SSL_get_ex_data_X509_STORE_CTX_idx 3 , 329.Xr SSL_get_ex_data_X509_STORE_CTX_idx 3 ,
300.Xr SSL_get_ex_new_index 3 ,
301.Xr SSL_get_fd 3 ,
302.Xr SSL_get_peer_cert_chain 3 , 330.Xr SSL_get_peer_cert_chain 3 ,
303.Xr SSL_get_peer_certificate 3 , 331.Xr SSL_get_peer_certificate 3 ,
304.Xr SSL_get_rbio 3 , 332.Xr SSL_get_server_tmp_key 3 ,
333.Xr SSL_get_servername 3 ,
334.Xr SSL_get_session 3 ,
305.Xr SSL_get_shared_ciphers 3 , 335.Xr SSL_get_shared_ciphers 3 ,
306.Xr SSL_get_state 3 ,
307.Xr SSL_get_verify_result 3 , 336.Xr SSL_get_verify_result 3 ,
308.Xr SSL_get_version 3 , 337.Xr SSL_get_version 3 ,
338.Xr SSL_session_reused 3
339.Pp
340To inspect the state during ongoing communication:
341.Xr SSL_get_error 3 ,
342.Xr SSL_get_shutdown 3 ,
343.Xr SSL_get_state 3 ,
344.Xr SSL_num_renegotiations 3 ,
309.Xr SSL_pending 3 , 345.Xr SSL_pending 3 ,
310.Xr SSL_rstate_string 3 , 346.Xr SSL_rstate_string 3 ,
311.Xr SSL_set_shutdown 3 ,
312.Xr SSL_set_verify_result 3 ,
313.Xr SSL_state_string 3 , 347.Xr SSL_state_string 3 ,
314.Xr SSL_want 3 348.Xr SSL_want 3
315.Pp 349.Ss Utility functions
316Utility functions:
317.Xr SSL_alert_type_string 3 , 350.Xr SSL_alert_type_string 3 ,
318.Xr SSL_dup_CA_list 3 , 351.Xr SSL_dup_CA_list 3 ,
319.Xr SSL_load_client_CA_file 3 352.Xr SSL_load_client_CA_file 3
353.Ss Obsolete functions
354.Xr OPENSSL_init_ssl 3 ,
355.Xr SSL_COMP_add_compression_method 3 ,
356.Xr SSL_CTX_set_tmp_rsa_callback 3 ,
357.Xr SSL_set_tmp_ecdh 3
320.Sh SEE ALSO 358.Sh SEE ALSO
321.Xr openssl 1 , 359.Xr openssl 1 ,
322.Xr crypto 3 , 360.Xr crypto 3 ,