297 lines
13 KiB
Groff
Executable File
297 lines
13 KiB
Groff
Executable File
.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.16)
|
|
.\"
|
|
.\" Standard preamble:
|
|
.\" ========================================================================
|
|
.de Sp \" Vertical space (when we can't use .PP)
|
|
.if t .sp .5v
|
|
.if n .sp
|
|
..
|
|
.de Vb \" Begin verbatim text
|
|
.ft CW
|
|
.nf
|
|
.ne \\$1
|
|
..
|
|
.de Ve \" End verbatim text
|
|
.ft R
|
|
.fi
|
|
..
|
|
.\" Set up some character translations and predefined strings. \*(-- will
|
|
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
|
|
.\" double quote, and \*(R" will give a right double quote. \*(C+ will
|
|
.\" give a nicer C++. Capital omega is used to do unbreakable dashes and
|
|
.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
|
|
.\" nothing in troff, for use with C<>.
|
|
.tr \(*W-
|
|
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
|
|
.ie n \{\
|
|
. ds -- \(*W-
|
|
. ds PI pi
|
|
. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
|
|
. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
|
|
. ds L" ""
|
|
. ds R" ""
|
|
. ds C` ""
|
|
. ds C' ""
|
|
'br\}
|
|
.el\{\
|
|
. ds -- \|\(em\|
|
|
. ds PI \(*p
|
|
. ds L" ``
|
|
. ds R" ''
|
|
'br\}
|
|
.\"
|
|
.\" Escape single quotes in literal strings from groff's Unicode transform.
|
|
.ie \n(.g .ds Aq \(aq
|
|
.el .ds Aq '
|
|
.\"
|
|
.\" If the F register is turned on, we'll generate index entries on stderr for
|
|
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
|
|
.\" entries marked with X<> in POD. Of course, you'll have to process the
|
|
.\" output yourself in some meaningful fashion.
|
|
.ie \nF \{\
|
|
. de IX
|
|
. tm Index:\\$1\t\\n%\t"\\$2"
|
|
..
|
|
. nr % 0
|
|
. rr F
|
|
.\}
|
|
.el \{\
|
|
. de IX
|
|
..
|
|
.\}
|
|
.\"
|
|
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
|
|
.\" Fear. Run. Save yourself. No user-serviceable parts.
|
|
. \" fudge factors for nroff and troff
|
|
.if n \{\
|
|
. ds #H 0
|
|
. ds #V .8m
|
|
. ds #F .3m
|
|
. ds #[ \f1
|
|
. ds #] \fP
|
|
.\}
|
|
.if t \{\
|
|
. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
|
|
. ds #V .6m
|
|
. ds #F 0
|
|
. ds #[ \&
|
|
. ds #] \&
|
|
.\}
|
|
. \" simple accents for nroff and troff
|
|
.if n \{\
|
|
. ds ' \&
|
|
. ds ` \&
|
|
. ds ^ \&
|
|
. ds , \&
|
|
. ds ~ ~
|
|
. ds /
|
|
.\}
|
|
.if t \{\
|
|
. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
|
|
. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
|
|
. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
|
|
. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
|
|
. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
|
|
. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
|
|
.\}
|
|
. \" troff and (daisy-wheel) nroff accents
|
|
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
|
|
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
|
|
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
|
|
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
|
|
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
|
|
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
|
|
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
|
|
.ds ae a\h'-(\w'a'u*4/10)'e
|
|
.ds Ae A\h'-(\w'A'u*4/10)'E
|
|
. \" corrections for vroff
|
|
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
|
|
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
|
|
. \" for low resolution devices (crt and lpr)
|
|
.if \n(.H>23 .if \n(.V>19 \
|
|
\{\
|
|
. ds : e
|
|
. ds 8 ss
|
|
. ds o a
|
|
. ds d- d\h'-1'\(ga
|
|
. ds D- D\h'-1'\(hy
|
|
. ds th \o'bp'
|
|
. ds Th \o'LP'
|
|
. ds ae ae
|
|
. ds Ae AE
|
|
.\}
|
|
.rm #[ #] #H #V #F C
|
|
.\" ========================================================================
|
|
.\"
|
|
.IX Title "SSL_CTX_SET_SESSION_TICKET_CB 3"
|
|
.TH SSL_CTX_SET_SESSION_TICKET_CB 3 "2020-03-02" "3.0.0-dev" "OpenSSL"
|
|
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
|
|
.\" way too many mistakes in technical documents.
|
|
.if n .ad l
|
|
.nh
|
|
.SH "NAME"
|
|
SSL_CTX_set_session_ticket_cb,
|
|
SSL_SESSION_get0_ticket_appdata,
|
|
SSL_SESSION_set1_ticket_appdata,
|
|
SSL_CTX_generate_session_ticket_fn,
|
|
SSL_CTX_decrypt_session_ticket_fn \- manage session ticket application data
|
|
.SH "SYNOPSIS"
|
|
.IX Header "SYNOPSIS"
|
|
.Vb 1
|
|
\& #include <openssl/ssl.h>
|
|
\&
|
|
\& typedef int (*SSL_CTX_generate_session_ticket_fn)(SSL *s, void *arg);
|
|
\& typedef SSL_TICKET_RETURN (*SSL_CTX_decrypt_session_ticket_fn)(SSL *s, SSL_SESSION *ss,
|
|
\& const unsigned char *keyname,
|
|
\& size_t keyname_len,
|
|
\& SSL_TICKET_STATUS status,
|
|
\& void *arg);
|
|
\& int SSL_CTX_set_session_ticket_cb(SSL_CTX *ctx,
|
|
\& SSL_CTX_generate_session_ticket_fn gen_cb,
|
|
\& SSL_CTX_decrypt_session_ticket_fn dec_cb,
|
|
\& void *arg);
|
|
\& int SSL_SESSION_set1_ticket_appdata(SSL_SESSION *ss, const void *data, size_t len);
|
|
\& int SSL_SESSION_get0_ticket_appdata(SSL_SESSION *ss, void **data, size_t *len);
|
|
.Ve
|
|
.SH "DESCRIPTION"
|
|
.IX Header "DESCRIPTION"
|
|
\&\fISSL_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
|
|
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
|
|
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
|
|
decryption has been attempted and any session ticket application data is
|
|
available. If ticket decryption was successful then the \fBss\fR argument contains
|
|
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 \*(L"\s-1NOTES\s0\*(R" 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
|
|
\&\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
|
|
\&\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
|
|
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
|
|
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
|
|
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"
|
|
.IX Header "NOTES"
|
|
When the \fBdec_cb\fR callback is invoked, the \s-1SSL_SESSION\s0 \fBss\fR has not yet been
|
|
assigned to the \s-1SSL\s0 \fBs\fR. The \fBstatus\fR indicates the result of the ticket
|
|
decryption. The callback must check the \fBstatus\fR value before performing any
|
|
action, as it is called even if ticket decryption fails.
|
|
.PP
|
|
The \fBkeyname\fR and \fBkeyname_len\fR arguments to \fBdec_cb\fR may be used to identify
|
|
the key that was used to encrypt the session ticket.
|
|
.PP
|
|
The \fBstatus\fR argument can be any of these values:
|
|
.IP "\s-1SSL_TICKET_EMPTY\s0" 4
|
|
.IX Item "SSL_TICKET_EMPTY"
|
|
Empty ticket present. No ticket data will be used and a new ticket should be
|
|
sent to the client. This only occurs in TLSv1.2 or below. In TLSv1.3 it is not
|
|
valid for a client to send an empty ticket.
|
|
.IP "\s-1SSL_TICKET_NO_DECRYPT\s0" 4
|
|
.IX Item "SSL_TICKET_NO_DECRYPT"
|
|
The ticket couldn't be decrypted. No ticket data will be used and a new ticket
|
|
should be sent to the client.
|
|
.IP "\s-1SSL_TICKET_SUCCESS\s0" 4
|
|
.IX Item "SSL_TICKET_SUCCESS"
|
|
A ticket was successfully decrypted, any session ticket application data should
|
|
be available. A new ticket should not be sent to the client.
|
|
.IP "\s-1SSL_TICKET_SUCCESS_RENEW\s0" 4
|
|
.IX Item "SSL_TICKET_SUCCESS_RENEW"
|
|
Same as \fB\s-1SSL_TICKET_SUCCESS\s0\fR, but a new ticket should be sent to the client.
|
|
.PP
|
|
The return value can be any of these values:
|
|
.IP "\s-1SSL_TICKET_RETURN_ABORT\s0" 4
|
|
.IX Item "SSL_TICKET_RETURN_ABORT"
|
|
The handshake should be aborted, either because of an error or because of some
|
|
policy. Note that in TLSv1.3 a client may send more than one ticket in a single
|
|
handshake. Therefore just because one ticket is unacceptable it does not mean
|
|
that all of them are. For this reason this option should be used with caution.
|
|
.IP "\s-1SSL_TICKET_RETURN_IGNORE\s0" 4
|
|
.IX Item "SSL_TICKET_RETURN_IGNORE"
|
|
Do not use a ticket (if one was available). Do not send a renewed ticket to the
|
|
client.
|
|
.IP "\s-1SSL_TICKET_RETURN_IGNORE_RENEW\s0" 4
|
|
.IX Item "SSL_TICKET_RETURN_IGNORE_RENEW"
|
|
Do not use a ticket (if one was available). Send a renewed ticket to the client.
|
|
.Sp
|
|
If the callback does not wish to change the default ticket behaviour then it
|
|
should return this value if \fBstatus\fR is \fB\s-1SSL_TICKET_EMPTY\s0\fR or
|
|
\&\fB\s-1SSL_TICKET_NO_DECRYPT\s0\fR.
|
|
.IP "\s-1SSL_TICKET_RETURN_USE\s0" 4
|
|
.IX Item "SSL_TICKET_RETURN_USE"
|
|
Use the ticket. Do not send a renewed ticket to the client. It is an error for
|
|
the callback to return this value if \fBstatus\fR has a value other than
|
|
\&\fB\s-1SSL_TICKET_SUCCESS\s0\fR or \fB\s-1SSL_TICKET_SUCCESS_RENEW\s0\fR.
|
|
.Sp
|
|
If the callback does not wish to change the default ticket behaviour then it
|
|
should return this value if \fBstatus\fR is \fB\s-1SSL_TICKET_SUCCESS\s0\fR.
|
|
.IP "\s-1SSL_TICKET_RETURN_USE_RENEW\s0" 4
|
|
.IX Item "SSL_TICKET_RETURN_USE_RENEW"
|
|
Use the ticket. Send a renewed ticket to the client. It is an error for the
|
|
callback to return this value if \fBstatus\fR has a value other than
|
|
\&\fB\s-1SSL_TICKET_SUCCESS\s0\fR or \fB\s-1SSL_TICKET_SUCCESS_RENEW\s0\fR.
|
|
.Sp
|
|
If the callback does not wish to change the default ticket behaviour then it
|
|
should return this value if \fBstatus\fR is \fB\s-1SSL_TICKET_SUCCESS_RENEW\s0\fR.
|
|
.PP
|
|
If \fBstatus\fR has the value \fB\s-1SSL_TICKET_EMPTY\s0\fR or \fB\s-1SSL_TICKET_NO_DECRYPT\s0\fR then
|
|
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
|
|
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.
|
|
.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)).
|
|
.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
|
|
failure.
|
|
.PP
|
|
The \fBgen_cb\fR callback must return 1 to continue the connection. A return of 0
|
|
will terminate the connection with an \s-1INTERNAL_ERROR\s0 alert.
|
|
.PP
|
|
The \fBdec_cb\fR callback must return a value as described in \*(L"\s-1NOTES\s0\*(R" above.
|
|
.SH "SEE ALSO"
|
|
.IX Header "SEE ALSO"
|
|
\&\fIssl\fR\|(7),
|
|
\&\fISSL_get_session\fR\|(3)
|
|
.SH "HISTORY"
|
|
.IX Header "HISTORY"
|
|
The \fISSL_CTX_set_session_ticket_cb()\fR, \fISSSL_SESSION_set1_ticket_appdata()\fR
|
|
and \fISSL_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.
|
|
.PP
|
|
Licensed under the Apache License 2.0 (the \*(L"License\*(R"). You may not use
|
|
this file except in compliance with the License. You can obtain a copy
|
|
in the file \s-1LICENSE\s0 in the source distribution or at
|
|
<https://www.openssl.org/source/license.html>.
|