diff options
Diffstat (limited to 'secure/lib/libcrypto/man/SSL_CTX_sess_set_get_cb.3')
| -rw-r--r-- | secure/lib/libcrypto/man/SSL_CTX_sess_set_get_cb.3 | 72 |
1 files changed, 38 insertions, 34 deletions
diff --git a/secure/lib/libcrypto/man/SSL_CTX_sess_set_get_cb.3 b/secure/lib/libcrypto/man/SSL_CTX_sess_set_get_cb.3 index 87db05672f8ef..e1f1f1a6195a6 100644 --- a/secure/lib/libcrypto/man/SSL_CTX_sess_set_get_cb.3 +++ b/secure/lib/libcrypto/man/SSL_CTX_sess_set_get_cb.3 @@ -1,4 +1,4 @@ -.\" Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35) +.\" Automatically generated by Pod::Man 4.10 (Pod::Simple 3.35) .\" .\" Standard preamble: .\" ======================================================================== @@ -54,16 +54,20 @@ .\" Avoid warning from groff about undefined register 'F'. .de IX .. -.if !\nF .nr F 0 -.if \nF>0 \{\ -. de IX -. tm Index:\\$1\t\\n%\t"\\$2" +.nr rF 0 +.if \n(.g .if rF .nr rF 1 +.if (\n(rF:(\n(.g==0)) \{\ +. if \nF \{\ +. de IX +. tm Index:\\$1\t\\n%\t"\\$2" .. -. if !\nF==2 \{\ -. nr % 0 -. nr F 2 +. if !\nF==2 \{\ +. nr % 0 +. nr F 2 +. \} . \} .\} +.rr rF .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. @@ -129,7 +133,7 @@ .\" ======================================================================== .\" .IX Title "SSL_CTX_SESS_SET_GET_CB 3" -.TH SSL_CTX_SESS_SET_GET_CB 3 "2018-11-20" "1.1.1a" "OpenSSL" +.TH SSL_CTX_SESS_SET_GET_CB 3 "2019-02-26" "1.1.1b" "OpenSSL" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l @@ -161,22 +165,22 @@ SSL_CTX_sess_set_new_cb, SSL_CTX_sess_set_remove_cb, SSL_CTX_sess_set_get_cb, SS .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" -\&\fISSL_CTX_sess_set_new_cb()\fR sets the callback function, which is automatically +\&\fBSSL_CTX_sess_set_new_cb()\fR sets the callback function, which is automatically called whenever a new session was negotiated. .PP -\&\fISSL_CTX_sess_set_remove_cb()\fR sets the callback function, which is +\&\fBSSL_CTX_sess_set_remove_cb()\fR sets the callback function, which is automatically called whenever a session is removed by the \s-1SSL\s0 engine, because it is considered faulty or the session has become obsolete because of exceeding the timeout value. .PP -\&\fISSL_CTX_sess_set_get_cb()\fR sets the callback function which is called, +\&\fBSSL_CTX_sess_set_get_cb()\fR sets the callback function which is called, whenever a \s-1SSL/TLS\s0 client proposed to resume a session but the session could not be found in the internal session cache (see -\&\fISSL_CTX_set_session_cache_mode\fR\|(3)). +\&\fBSSL_CTX_set_session_cache_mode\fR\|(3)). (\s-1SSL/TLS\s0 server only.) .PP -\&\fISSL_CTX_sess_get_new_cb()\fR, \fISSL_CTX_sess_get_remove_cb()\fR, and -\&\fISSL_CTX_sess_get_get_cb()\fR retrieve the function pointers set by the +\&\fBSSL_CTX_sess_get_new_cb()\fR, \fBSSL_CTX_sess_get_remove_cb()\fR, and +\&\fBSSL_CTX_sess_get_get_cb()\fR retrieve the function pointers set by the corresponding set callback functions. If a callback function has not been set, the \s-1NULL\s0 pointer is returned. .SH "NOTES" @@ -184,53 +188,53 @@ set, the \s-1NULL\s0 pointer is returned. In order to allow external session caching, synchronization with the internal session cache is realized via callback functions. Inside these callback functions, session can be saved to disk or put into a database using the -\&\fId2i_SSL_SESSION\fR\|(3) interface. +\&\fBd2i_SSL_SESSION\fR\|(3) interface. .PP -The \fInew_session_cb()\fR is called, whenever a new session has been negotiated +The \fBnew_session_cb()\fR is called, whenever a new session has been negotiated and session caching is enabled (see -\&\fISSL_CTX_set_session_cache_mode\fR\|(3)). -The \fInew_session_cb()\fR is passed the \fBssl\fR connection and the ssl session +\&\fBSSL_CTX_set_session_cache_mode\fR\|(3)). +The \fBnew_session_cb()\fR is passed the \fBssl\fR connection and the ssl session \&\fBsess\fR. If the callback returns \fB0\fR, the session will be immediately removed again. Note that in TLSv1.3, sessions are established after the main handshake has completed. The server decides when to send the client the session information and this may occur some time after the end of the handshake (or not -at all). This means that applications should expect the \fInew_session_cb()\fR +at all). This means that applications should expect the \fBnew_session_cb()\fR function to be invoked during the handshake (for <= TLSv1.2) or after the handshake (for TLSv1.3). It is also possible in TLSv1.3 for multiple sessions to -be established with a single connection. In these case the \fInew_session_cb()\fR +be established with a single connection. In these case the \fBnew_session_cb()\fR function will be invoked multiple times. .PP In TLSv1.3 it is recommended that each \s-1SSL_SESSION\s0 object is only used for resumption once. One way of enforcing that is for applications to call -\&\fISSL_CTX_remove_session\fR\|(3) after a session has been used. +\&\fBSSL_CTX_remove_session\fR\|(3) after a session has been used. .PP -The \fIremove_session_cb()\fR is called, whenever the \s-1SSL\s0 engine removes a session +The \fBremove_session_cb()\fR is called, whenever the \s-1SSL\s0 engine removes a session from the internal cache. This happens when the session is removed because it is expired or when a connection was not shutdown cleanly. It also happens for all sessions in the internal session cache when -\&\fISSL_CTX_free\fR\|(3) is called. The \fIremove_session_cb()\fR is passed +\&\fBSSL_CTX_free\fR\|(3) is called. The \fBremove_session_cb()\fR is passed the \fBctx\fR and the ssl session \fBsess\fR. It does not provide any feedback. .PP -The \fIget_session_cb()\fR is only called on \s-1SSL/TLS\s0 servers with the session id -proposed by the client. The \fIget_session_cb()\fR is always called, also when -session caching was disabled. The \fIget_session_cb()\fR is passed the +The \fBget_session_cb()\fR is only called on \s-1SSL/TLS\s0 servers with the session id +proposed by the client. The \fBget_session_cb()\fR is always called, also when +session caching was disabled. The \fBget_session_cb()\fR is passed the \&\fBssl\fR connection, the session id of length \fBlength\fR at the memory location \&\fBdata\fR. With the parameter \fBcopy\fR the callback can require the \&\s-1SSL\s0 engine to increment the reference count of the \s-1SSL_SESSION\s0 object, Normally the reference count is not incremented and therefore the session must not be explicitly freed with -\&\fISSL_SESSION_free\fR\|(3). +\&\fBSSL_SESSION_free\fR\|(3). .SH "RETURN VALUES" .IX Header "RETURN VALUES" -\&\fISSL_CTX_sess_get_new_cb()\fR, \fISSL_CTX_sess_get_remove_cb()\fR and \fISSL_CTX_sess_get_get_cb()\fR +\&\fBSSL_CTX_sess_get_new_cb()\fR, \fBSSL_CTX_sess_get_remove_cb()\fR and \fBSSL_CTX_sess_get_get_cb()\fR return different callback function pointers respectively. .SH "SEE ALSO" .IX Header "SEE ALSO" -\&\fIssl\fR\|(7), \fId2i_SSL_SESSION\fR\|(3), -\&\fISSL_CTX_set_session_cache_mode\fR\|(3), -\&\fISSL_CTX_flush_sessions\fR\|(3), -\&\fISSL_SESSION_free\fR\|(3), -\&\fISSL_CTX_free\fR\|(3) +\&\fBssl\fR\|(7), \fBd2i_SSL_SESSION\fR\|(3), +\&\fBSSL_CTX_set_session_cache_mode\fR\|(3), +\&\fBSSL_CTX_flush_sessions\fR\|(3), +\&\fBSSL_SESSION_free\fR\|(3), +\&\fBSSL_CTX_free\fR\|(3) .SH "COPYRIGHT" .IX Header "COPYRIGHT" Copyright 2001\-2018 The OpenSSL Project Authors. All Rights Reserved. |