Debian Codegraph @

upstream/debian-unstable/man3/SSL_CTX_set_timeout.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_CTX_SET_TIMEOUT 3SSL"
58 .TH SSL_CTX_SET_TIMEOUT 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_CTX_set_timeout, SSL_CTX_get_timeout \- manipulate timeout values for session caching
65 .SH SYNOPSIS
66 .IX Header "SYNOPSIS"
67 .Vb 1
68 \& #include <openssl/ssl.h>
69 \&
70 \& long SSL_CTX_set_timeout(SSL_CTX *ctx, long t);
71 \& long SSL_CTX_get_timeout(SSL_CTX *ctx);
72 .Ve
73 .SH DESCRIPTION
74 .IX Header "DESCRIPTION"
75 \&\fBSSL_CTX_set_timeout()\fR sets the timeout for newly created sessions for
76 \&\fBctx\fR to \fBt\fR. The timeout value \fBt\fR must be given in seconds.
77 .PP
78 \&\fBSSL_CTX_get_timeout()\fR returns the currently set timeout value for \fBctx\fR.
79 .SH NOTES
80 .IX Header "NOTES"
81 Whenever a new session is created, it is assigned a maximum lifetime. This
82 lifetime is specified by storing the creation time of the session and the
83 timeout value valid at this time. If the actual time is later than creation
84 time plus timeout, the session is not reused.
85 .PP
86 Due to this realization, all sessions behave according to the timeout value
87 valid at the time of the session negotiation. Changes of the timeout value
88 do not affect already established sessions.
89 .PP
90 The expiration time of a single session can be modified using the
91 \&\fBSSL_SESSION_get_time\fR\|(3) family of functions.
92 .PP
93 Expired sessions are removed from the internal session cache, whenever
94 \&\fBSSL_CTX_flush_sessions\fR\|(3) is called, either
95 directly by the application or automatically (see
96 \&\fBSSL_CTX_set_session_cache_mode\fR\|(3))
97 .PP
98 The default value for session timeout is decided on a per protocol
99 basis, see \fBSSL_get_default_timeout\fR\|(3).
100 All currently supported protocols have the same default timeout value
101 of 300 seconds.
102 .PP
103 This timeout value is used as the ticket lifetime hint for stateless session
104 tickets. It is also used as the timeout value within the ticket itself.
105 .PP
106 For TLSv1.3, RFC8446 limits transmission of this value to 1 week (604800
107 seconds).
108 .PP
109 For TLSv1.2, tickets generated during an initial handshake use the value
110 as specified. Tickets generated during a resumed handshake have a value
111 of 0 for the ticket lifetime hint.
112 .SH "RETURN VALUES"
113 .IX Header "RETURN VALUES"
114 \&\fBSSL_CTX_set_timeout()\fR returns the previously set timeout value.
115 .PP
116 \&\fBSSL_CTX_get_timeout()\fR returns the currently set timeout value.
117 .SH "SEE ALSO"
118 .IX Header "SEE ALSO"
119 \&\fBssl\fR\|(7),
120 \&\fBSSL_CTX_set_session_cache_mode\fR\|(3),
121 \&\fBSSL_SESSION_get_time\fR\|(3),
122 \&\fBSSL_CTX_flush_sessions\fR\|(3),
123 \&\fBSSL_get_default_timeout\fR\|(3)
124 .SH COPYRIGHT
125 .IX Header "COPYRIGHT"
126 Copyright 2001\-2022 The OpenSSL Project Authors. All Rights Reserved.
127 .PP
128 Licensed under the Apache License 2.0 (the "License"). You may not use
129 this file except in compliance with the License. You can obtain a copy
130 in the file LICENSE in the source distribution or at
131 <https://www.openssl.org/source/license.html>.