Blame doc/man3/SSL_CTX_set_num_tickets.pod

Packit c4476c
=pod
Packit c4476c
Packit c4476c
=head1 NAME
Packit c4476c
Packit c4476c
SSL_set_num_tickets,
Packit c4476c
SSL_get_num_tickets,
Packit c4476c
SSL_CTX_set_num_tickets,
Packit c4476c
SSL_CTX_get_num_tickets
Packit c4476c
- control the number of TLSv1.3 session tickets that are issued
Packit c4476c
Packit c4476c
=head1 SYNOPSIS
Packit c4476c
Packit c4476c
 #include <openssl/ssl.h>
Packit c4476c
Packit c4476c
 int SSL_set_num_tickets(SSL *s, size_t num_tickets);
Packit c4476c
 size_t SSL_get_num_tickets(SSL *s);
Packit c4476c
 int SSL_CTX_set_num_tickets(SSL_CTX *ctx, size_t num_tickets);
Packit c4476c
 size_t SSL_CTX_get_num_tickets(SSL_CTX *ctx);
Packit c4476c
Packit c4476c
=head1 DESCRIPTION
Packit c4476c
Packit c4476c
SSL_CTX_set_num_tickets() and SSL_set_num_tickets() can be called for a server
Packit c4476c
application and set the number of TLSv1.3 session tickets that will be sent to
Packit c4476c
the client after a full handshake. Set the desired value (which could be 0) in
Packit c4476c
the B<num_tickets> argument. Typically these functions should be called before
Packit c4476c
the start of the handshake.
Packit c4476c
Packit c4476c
The default number of tickets is 2; the default number of tickets sent following
Packit c4476c
a resumption handshake is 1 but this cannot be changed using these functions.
Packit c4476c
The number of tickets following a resumption handshake can be reduced to 0 using
Packit c4476c
custom session ticket callbacks (see L<SSL_CTX_set_session_ticket_cb(3)>).
Packit c4476c
Packit c4476c
Tickets are also issued on receipt of a post-handshake certificate from the
Packit c4476c
client following a request by the server using
Packit c4476c
L<SSL_verify_client_post_handshake(3)>. These new tickets will be associated
Packit c4476c
with the updated client identity (i.e. including their certificate and
Packit c4476c
verification status). The number of tickets issued will normally be the same as
Packit c4476c
was used for the initial handshake. If the initial handshake was a full
Packit c4476c
handshake then SSL_set_num_tickets() can be called again prior to calling
Packit c4476c
SSL_verify_client_post_handshake() to update the number of tickets that will be
Packit c4476c
sent.
Packit c4476c
Packit c4476c
SSL_CTX_get_num_tickets() and SSL_get_num_tickets() return the number of
Packit c4476c
tickets set by a previous call to SSL_CTX_set_num_tickets() or
Packit c4476c
SSL_set_num_tickets(), or 2 if no such call has been made.
Packit c4476c
Packit c4476c
=head1 RETURN VALUES
Packit c4476c
Packit c4476c
SSL_CTX_set_num_tickets() and SSL_set_num_tickets() return 1 on success or 0 on
Packit c4476c
failure.
Packit c4476c
Packit c4476c
SSL_CTX_get_num_tickets() and SSL_get_num_tickets() return the number of tickets
Packit c4476c
that have been previously set.
Packit c4476c
Packit c4476c
=head1 HISTORY
Packit c4476c
Packit c4476c
These functions were added in OpenSSL 1.1.1.
Packit c4476c
Packit c4476c
=head1 COPYRIGHT
Packit c4476c
Packit c4476c
Copyright 2018 The OpenSSL Project Authors. All Rights Reserved.
Packit c4476c
Packit c4476c
Licensed under the OpenSSL license (the "License").  You may not use
Packit c4476c
this file except in compliance with the License.  You can obtain a copy
Packit c4476c
in the file LICENSE in the source distribution or at
Packit c4476c
L<https://www.openssl.org/source/license.html>.
Packit c4476c
Packit c4476c
=cut