xref: /freebsd/crypto/openssl/doc/man3/SSL_SESSION_has_ticket.pod (revision bdd1243df58e60e85101c09001d9812a789b6bc4)
1=pod
2
3=head1 NAME
4
5SSL_SESSION_get0_ticket,
6SSL_SESSION_has_ticket, SSL_SESSION_get_ticket_lifetime_hint
7- get details about the ticket associated with a session
8
9=head1 SYNOPSIS
10
11 #include <openssl/ssl.h>
12
13 int SSL_SESSION_has_ticket(const SSL_SESSION *s);
14 unsigned long SSL_SESSION_get_ticket_lifetime_hint(const SSL_SESSION *s);
15 void SSL_SESSION_get0_ticket(const SSL_SESSION *s, const unsigned char **tick,
16                              size_t *len);
17
18=head1 DESCRIPTION
19
20SSL_SESSION_has_ticket() returns 1 if there is a Session Ticket associated with
21this session, and 0 otherwise.
22
23SSL_SESSION_get_ticket_lifetime_hint returns the lifetime hint in seconds
24associated with the session ticket.
25
26SSL_SESSION_get0_ticket obtains a pointer to the ticket associated with a
27session. The length of the ticket is written to B<*len>. If B<tick> is non
28NULL then a pointer to the ticket is written to B<*tick>. The pointer is only
29valid while the connection is in use. The session (and hence the ticket pointer)
30may also become invalid as a result of a call to SSL_CTX_flush_sessions().
31
32=head1 RETURN VALUES
33
34SSL_SESSION_has_ticket() returns 1 if session ticket exists or 0 otherwise.
35
36SSL_SESSION_get_ticket_lifetime_hint() returns the number of seconds.
37
38=head1 SEE ALSO
39
40L<ssl(7)>,
41L<d2i_SSL_SESSION(3)>,
42L<SSL_SESSION_get_time(3)>,
43L<SSL_SESSION_free(3)>
44
45=head1 HISTORY
46
47The SSL_SESSION_has_ticket(), SSL_SESSION_get_ticket_lifetime_hint()
48and SSL_SESSION_get0_ticket() functions were added in OpenSSL 1.1.0.
49
50=head1 COPYRIGHT
51
52Copyright 2015-2018 The OpenSSL Project Authors. All Rights Reserved.
53
54Licensed under the OpenSSL license (the "License").  You may not use
55this file except in compliance with the License.  You can obtain a copy
56in the file LICENSE in the source distribution or at
57L<https://www.openssl.org/source/license.html>.
58
59=cut
60