diff options
Diffstat (limited to 'secure/lib/libcrypto/man/SSL_CTX_set_session_ticket_cb.3')
| -rw-r--r-- | secure/lib/libcrypto/man/SSL_CTX_set_session_ticket_cb.3 | 58 |
1 files changed, 31 insertions, 27 deletions
diff --git a/secure/lib/libcrypto/man/SSL_CTX_set_session_ticket_cb.3 b/secure/lib/libcrypto/man/SSL_CTX_set_session_ticket_cb.3 index b31566c3208f4..4b48d0b138d94 100644 --- a/secure/lib/libcrypto/man/SSL_CTX_set_session_ticket_cb.3 +++ b/secure/lib/libcrypto/man/SSL_CTX_set_session_ticket_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_SET_SESSION_TICKET_CB 3" -.TH SSL_CTX_SET_SESSION_TICKET_CB 3 "2018-11-20" "1.1.1a" "OpenSSL" +.TH SSL_CTX_SET_SESSION_TICKET_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 @@ -156,15 +160,15 @@ SSL_CTX_set_session_ticket_cb, SSL_SESSION_get0_ticket_appdata, SSL_SESSION_set1 .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" -\&\fISSL_CTX_set_set_session_ticket_cb()\fR sets the application callbacks \fBgen_cb\fR +\&\fBSSL_CTX_set_set_session_ticket_cb()\fR sets the application callbacks \fBgen_cb\fR and \fBdec_cb\fR that are used by a server to set and get application data stored with a session, and placed into a session ticket. Either callback function may be set to \s-1NULL.\s0 The value of \fBarg\fR is passed to the callbacks. .PP \&\fBgen_cb\fR is the application defined callback invoked when a session ticket is -about to be created. The application can call \fISSL_SESSION_set1_ticket_appdata()\fR +about to be created. The application can call \fBSSL_SESSION_set1_ticket_appdata()\fR at this time to add application data to the session ticket. The value of \fBarg\fR -is the same as that given to \fISSL_CTX_set_session_ticket_cb()\fR. The \fBgen_cb\fR +is the same as that given to \fBSSL_CTX_set_session_ticket_cb()\fR. The \fBgen_cb\fR callback is defined as type \fBSSL_CTX_generate_session_ticket_fn\fR. .PP \&\fBdec_cb\fR is the application defined callback invoked after session ticket @@ -173,22 +177,22 @@ available. If ticket decryption was successful then the \fBss\fR argument contai the session data. The \fBkeyname\fR and \fBkeyname_len\fR arguments identify the key used to decrypt the session ticket. The \fBstatus\fR argument is the result of the ticket decryption. See the \s-1NOTES\s0 section below for further details. The value -of \fBarg\fR is the same as that given to \fISSL_CTX_set_session_ticket_cb()\fR. The +of \fBarg\fR is the same as that given to \fBSSL_CTX_set_session_ticket_cb()\fR. The \&\fBdec_cb\fR callback is defined as type \fBSSL_CTX_decrypt_session_ticket_fn\fR. .PP -\&\fISSL_SESSION_set1_ticket_appdata()\fR sets the application data specified by +\&\fBSSL_SESSION_set1_ticket_appdata()\fR sets the application data specified by \&\fBdata\fR and \fBlen\fR into \fBss\fR which is then placed into any generated session tickets. It can be called at any time before a session ticket is created to update the data placed into the session ticket. However, given that sessions and tickets are created by the handshake, the \fBgen_cb\fR is provided to notify the application that a session ticket is about to be generated. .PP -\&\fISSL_SESSION_get0_ticket_appdata()\fR assigns \fBdata\fR to the session ticket +\&\fBSSL_SESSION_get0_ticket_appdata()\fR assigns \fBdata\fR to the session ticket application data and assigns \fBlen\fR to the length of the session ticket application data from \fBss\fR. The application data can be set via -\&\fISSL_SESSION_set1_ticket_appdata()\fR or by a session ticket. \s-1NULL\s0 will be assigned +\&\fBSSL_SESSION_set1_ticket_appdata()\fR or by a session ticket. \s-1NULL\s0 will be assigned to \fBdata\fR and 0 will be assigned to \fBlen\fR if there is no session ticket -application data. \fISSL_SESSION_get0_ticket_appdata()\fR can be called any time +application data. \fBSSL_SESSION_get0_ticket_appdata()\fR can be called any time after a session has been created. The \fBdec_cb\fR is provided to notify the application that a session ticket has just been decrypted. .SH "NOTES" @@ -258,21 +262,21 @@ If \fBstatus\fR has the value \fB\s-1SSL_TICKET_EMPTY\s0\fR or \fB\s-1SSL_TICKET no session data will be available and the callback must not use the \fBss\fR argument. If \fBstatus\fR has the value \fB\s-1SSL_TICKET_SUCCESS\s0\fR or \&\fB\s-1SSL_TICKET_SUCCESS_RENEW\s0\fR then the application can call -\&\fISSL_SESSION_get0_ticket_appdata()\fR using the session provided in the \fBss\fR +\&\fBSSL_SESSION_get0_ticket_appdata()\fR using the session provided in the \fBss\fR argument to retrieve the application data. .PP -When the \fBgen_cb\fR callback is invoked, the \fISSL_get_session()\fR function can be -used to retrieve the \s-1SSL_SESSION\s0 for \fISSL_SESSION_set1_ticket_appdata()\fR. +When the \fBgen_cb\fR callback is invoked, the \fBSSL_get_session()\fR function can be +used to retrieve the \s-1SSL_SESSION\s0 for \fBSSL_SESSION_set1_ticket_appdata()\fR. .PP By default, in TLSv1.2 and below, a new session ticket is not issued on a successful resumption and therefore \fBgen_cb\fR will not be called. In TLSv1.3 the default behaviour is to always issue a new ticket on resumption. In both cases this behaviour can be changed if a ticket key callback is in use (see -\&\fISSL_CTX_set_tlsext_ticket_key_cb\fR\|(3)). +\&\fBSSL_CTX_set_tlsext_ticket_key_cb\fR\|(3)). .SH "RETURN VALUES" .IX Header "RETURN VALUES" -The \fISSL_CTX_set_session_ticket_cb()\fR, \fISSL_SESSION_set1_ticket_appdata()\fR and -\&\fISSL_SESSION_get0_ticket_appdata()\fR functions return 1 on success and 0 on +The \fBSSL_CTX_set_session_ticket_cb()\fR, \fBSSL_SESSION_set1_ticket_appdata()\fR and +\&\fBSSL_SESSION_get0_ticket_appdata()\fR functions return 1 on success and 0 on failure. .PP The \fBgen_cb\fR callback must return 1 to continue the connection. A return of 0 @@ -281,12 +285,12 @@ will terminate the connection with an \s-1INTERNAL_ERROR\s0 alert. The \fBdec_cb\fR callback must return a value as described in \s-1NOTES\s0 above. .SH "SEE ALSO" .IX Header "SEE ALSO" -\&\fIssl\fR\|(7), -\&\fISSL_get_session\fR\|(3) +\&\fBssl\fR\|(7), +\&\fBSSL_get_session\fR\|(3) .SH "HISTORY" .IX Header "HISTORY" -\&\fISSL_CTX_set_session_ticket_cb()\fR, \fISSSL_SESSION_set1_ticket_appdata()\fR and -\&\fISSL_SESSION_get_ticket_appdata()\fR were added to OpenSSL 1.1.1. +The \fBSSL_CTX_set_session_ticket_cb()\fR, \fBSSSL_SESSION_set1_ticket_appdata()\fR +and \fBSSL_SESSION_get_ticket_appdata()\fR functions were added in OpenSSL 1.1.1. .SH "COPYRIGHT" .IX Header "COPYRIGHT" Copyright 2017\-2018 The OpenSSL Project Authors. All Rights Reserved. |