Debian Codegraph @

upstream/debian-unstable/man3/SSL_SESSION_has_ticket.3ssl

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\" ========================================================================
56 .\"
57 .IX Title "SSL_SESSION_HAS_TICKET 3SSL"
58 .TH SSL_SESSION_HAS_TICKET 3SSL 2026-04-07 3.6.2 OpenSSL
59 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
60 .\" way too many mistakes in technical documents.
61 .if n .ad l
62 .nh
63 .SH NAME
64 SSL_SESSION_get0_ticket,
65 SSL_SESSION_has_ticket, SSL_SESSION_get_ticket_lifetime_hint
66 \&\- get details about the ticket associated with a session
67 .SH SYNOPSIS
68 .IX Header "SYNOPSIS"
69 .Vb 1
70 \& #include <openssl/ssl.h>
71 \&
72 \& int SSL_SESSION_has_ticket(const SSL_SESSION *s);
73 \& unsigned long SSL_SESSION_get_ticket_lifetime_hint(const SSL_SESSION *s);
74 \& void SSL_SESSION_get0_ticket(const SSL_SESSION *s, const unsigned char **tick,
75 \& size_t *len);
76 .Ve
77 .SH DESCRIPTION
78 .IX Header "DESCRIPTION"
79 \&\fBSSL_SESSION_has_ticket()\fR returns 1 if there is a Session Ticket associated with
80 this session, and 0 otherwise.
81 .PP
82 SSL_SESSION_get_ticket_lifetime_hint returns the lifetime hint in seconds
83 associated with the session ticket.
84 .PP
85 SSL_SESSION_get0_ticket obtains a pointer to the ticket associated with a
86 session. The length of the ticket is written to \fB*len\fR. If \fBtick\fR is non
87 NULL then a pointer to the ticket is written to \fB*tick\fR. The pointer is only
88 valid while the connection is in use. The session (and hence the ticket pointer)
89 may also become invalid as a result of a call to \fBSSL_CTX_flush_sessions()\fR.
90 .SH "RETURN VALUES"
91 .IX Header "RETURN VALUES"
92 \&\fBSSL_SESSION_has_ticket()\fR returns 1 if session ticket exists or 0 otherwise.
93 .PP
94 \&\fBSSL_SESSION_get_ticket_lifetime_hint()\fR returns the number of seconds.
95 .SH "SEE ALSO"
96 .IX Header "SEE ALSO"
97 \&\fBssl\fR\|(7),
98 \&\fBd2i_SSL_SESSION\fR\|(3),
99 \&\fBSSL_SESSION_get_time\fR\|(3),
100 \&\fBSSL_SESSION_free\fR\|(3)
101 .SH HISTORY
102 .IX Header "HISTORY"
103 The \fBSSL_SESSION_has_ticket()\fR, \fBSSL_SESSION_get_ticket_lifetime_hint()\fR
104 and \fBSSL_SESSION_get0_ticket()\fR functions were added in OpenSSL 1.1.0.
105 .SH COPYRIGHT
106 .IX Header "COPYRIGHT"
107 Copyright 2015\-2018 The OpenSSL Project Authors. All Rights Reserved.
108 .PP
109 Licensed under the Apache License 2.0 (the "License"). You may not use
110 this file except in compliance with the License. You can obtain a copy
111 in the file LICENSE in the source distribution or at
112 <https://www.openssl.org/source/license.html>.