Small script to re-encode files that need it to UTF-8
[openssl.git] / doc / ssl / SSL_SESSION_has_ticket.pod
1 =pod
2
3 =head1 NAME
4
5 SSL_SESSION_has_ticket, SSL_SESSION_get_ticket_lifetime_hint, SSL_SESSION_get_ticket - get details about the ticket associated with a session
6
7 =head1 SYNOPSIS
8
9  #include <openssl/ssl.h>
10
11  int SSL_SESSION_has_ticket(const SSL_SESSION *s);
12  unsigned long SSL_SESSION_get_ticket_lifetime_hint(const SSL_SESSION *s);
13  void SSL_SESSION_get0_ticket(const SSL_SESSION *s, unsigned char **tick,
14                             size_t *len);
15
16 =head1 DESCRIPTION
17
18 SSL_SESSION_has_ticket() returns 1 if there is a Session Ticket associated with
19 this session, and 0 otherwise.
20
21 SSL_SESSION_get_ticket_lifetime_hint returns the lifetime hint in seconds
22 associated with the session ticket.
23
24 SSL_SESSION_get0_ticket obtains a pointer to the ticket associated with a
25 session. The length of the ticket is written to B<*len>. If B<tick> is non
26 NULL then a pointer to the ticket is written to B<*tick>. The pointer is only
27 valid while the connection is in use. The session (and hence the ticket pointer)
28 may also become invalid as a result of a call to SSL_CTX_flush_sessions().
29
30 =head1 SEE ALSO
31
32 L<ssl(3)|ssl(3)>,
33 L<d2i_SSL_SESSION(3)|d2i_SSL_SESSION(3)>,
34 L<SSL_SESSION_get_time(3)|SSL_SESSION_get_time(3)>,
35 L<SSL_SESSION_free(3)|SSL_SESSION_free(3)>
36
37 =head1 HISTORY
38
39 SSL_SESSION_has_ticket, SSL_SESSION_get_ticket_lifetime_hint and
40 SSL_SESSION_get0_ticket were added in OpenSSL 1.1.0.
41
42 =cut