]>
Commit | Line | Data |
---|---|---|
f2baac27 MC |
1 | =pod |
2 | ||
3 | =head1 NAME | |
4 | ||
c952780c | 5 | SSL_SESSION_get0_ticket, |
3ba4dac6 | 6 | SSL_SESSION_has_ticket, SSL_SESSION_get_ticket_lifetime_hint |
c952780c | 7 | - get details about the ticket associated with a session |
f2baac27 MC |
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); | |
48593cb1 | 15 | void SSL_SESSION_get0_ticket(const SSL_SESSION *s, const unsigned char **tick, |
c952780c | 16 | size_t *len); |
f2baac27 MC |
17 | |
18 | =head1 DESCRIPTION | |
19 | ||
20 | SSL_SESSION_has_ticket() returns 1 if there is a Session Ticket associated with | |
21 | this session, and 0 otherwise. | |
22 | ||
23 | SSL_SESSION_get_ticket_lifetime_hint returns the lifetime hint in seconds | |
24 | associated with the session ticket. | |
25 | ||
b7c9187b MC |
26 | SSL_SESSION_get0_ticket obtains a pointer to the ticket associated with a |
27 | session. The length of the ticket is written to B<*len>. If B<tick> is non | |
28 | NULL then a pointer to the ticket is written to B<*tick>. The pointer is only | |
29 | valid while the connection is in use. The session (and hence the ticket pointer) | |
30 | may also become invalid as a result of a call to SSL_CTX_flush_sessions(). | |
31 | ||
1f13ad31 PY |
32 | =head1 RETURN VALUES |
33 | ||
34 | SSL_SESSION_has_ticket() returns 1 if session ticket exists or 0 otherwise. | |
35 | ||
36 | SSL_SESSION_get_ticket_lifetime_hint() returns the number of seconds. | |
37 | ||
f2baac27 MC |
38 | =head1 SEE ALSO |
39 | ||
b97fdb57 | 40 | L<ssl(7)>, |
9b86974e RS |
41 | L<d2i_SSL_SESSION(3)>, |
42 | L<SSL_SESSION_get_time(3)>, | |
43 | L<SSL_SESSION_free(3)> | |
f2baac27 MC |
44 | |
45 | =head1 HISTORY | |
46 | ||
fc5ecadd DMSP |
47 | The SSL_SESSION_has_ticket(), SSL_SESSION_get_ticket_lifetime_hint() |
48 | and SSL_SESSION_get0_ticket() functions were added in OpenSSL 1.1.0. | |
f2baac27 | 49 | |
e2f92610 RS |
50 | =head1 COPYRIGHT |
51 | ||
61f805c1 | 52 | Copyright 2015-2018 The OpenSSL Project Authors. All Rights Reserved. |
e2f92610 | 53 | |
4746f25a | 54 | Licensed under the Apache License 2.0 (the "License"). You may not use |
e2f92610 RS |
55 | this file except in compliance with the License. You can obtain a copy |
56 | in the file LICENSE in the source distribution or at | |
57 | L<https://www.openssl.org/source/license.html>. | |
58 | ||
59 | =cut |