Blame doc/man3/SSL_SESSION_has_ticket.pod

Packit Service 084de1
=pod
Packit Service 084de1
Packit Service 084de1
=head1 NAME
Packit Service 084de1
Packit Service 084de1
SSL_SESSION_get0_ticket,
Packit Service 084de1
SSL_SESSION_has_ticket, SSL_SESSION_get_ticket_lifetime_hint
Packit Service 084de1
- get details about the ticket associated with a session
Packit Service 084de1
Packit Service 084de1
=head1 SYNOPSIS
Packit Service 084de1
Packit Service 084de1
 #include <openssl/ssl.h>
Packit Service 084de1
Packit Service 084de1
 int SSL_SESSION_has_ticket(const SSL_SESSION *s);
Packit Service 084de1
 unsigned long SSL_SESSION_get_ticket_lifetime_hint(const SSL_SESSION *s);
Packit Service 084de1
 void SSL_SESSION_get0_ticket(const SSL_SESSION *s, const unsigned char **tick,
Packit Service 084de1
                              size_t *len);
Packit Service 084de1
Packit Service 084de1
=head1 DESCRIPTION
Packit Service 084de1
Packit Service 084de1
SSL_SESSION_has_ticket() returns 1 if there is a Session Ticket associated with
Packit Service 084de1
this session, and 0 otherwise.
Packit Service 084de1
Packit Service 084de1
SSL_SESSION_get_ticket_lifetime_hint returns the lifetime hint in seconds
Packit Service 084de1
associated with the session ticket.
Packit Service 084de1
Packit Service 084de1
SSL_SESSION_get0_ticket obtains a pointer to the ticket associated with a
Packit Service 084de1
session. The length of the ticket is written to B<*len>. If B<tick> is non
Packit Service 084de1
NULL then a pointer to the ticket is written to B<*tick>. The pointer is only
Packit Service 084de1
valid while the connection is in use. The session (and hence the ticket pointer)
Packit Service 084de1
may also become invalid as a result of a call to SSL_CTX_flush_sessions().
Packit Service 084de1
Packit Service 084de1
=head1 RETURN VALUES
Packit Service 084de1
Packit Service 084de1
SSL_SESSION_has_ticket() returns 1 if session ticket exists or 0 otherwise.
Packit Service 084de1
Packit Service 084de1
SSL_SESSION_get_ticket_lifetime_hint() returns the number of seconds.
Packit Service 084de1
Packit Service 084de1
=head1 SEE ALSO
Packit Service 084de1
Packit Service 084de1
L<ssl(7)>,
Packit Service 084de1
L<d2i_SSL_SESSION(3)>,
Packit Service 084de1
L<SSL_SESSION_get_time(3)>,
Packit Service 084de1
L<SSL_SESSION_free(3)>
Packit Service 084de1
Packit Service 084de1
=head1 HISTORY
Packit Service 084de1
Packit Service 084de1
The SSL_SESSION_has_ticket(), SSL_SESSION_get_ticket_lifetime_hint()
Packit Service 084de1
and SSL_SESSION_get0_ticket() functions were added in OpenSSL 1.1.0.
Packit Service 084de1
Packit Service 084de1
=head1 COPYRIGHT
Packit Service 084de1
Packit Service 084de1
Copyright 2015-2018 The OpenSSL Project Authors. All Rights Reserved.
Packit Service 084de1
Packit Service 084de1
Licensed under the OpenSSL license (the "License").  You may not use
Packit Service 084de1
this file except in compliance with the License.  You can obtain a copy
Packit Service 084de1
in the file LICENSE in the source distribution or at
Packit Service 084de1
L<https://www.openssl.org/source/license.html>.
Packit Service 084de1
Packit Service 084de1
=cut