Debian Codegraph @

upstream/debian-unstable/man3/SSL_CTX_add_session.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_ADD_SESSION 3SSL"
58 .TH SSL_CTX_ADD_SESSION 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_add_session, SSL_CTX_remove_session \- manipulate session cache
65 .SH SYNOPSIS
66 .IX Header "SYNOPSIS"
67 .Vb 1
68 \& #include <openssl/ssl.h>
69 \&
70 \& int SSL_CTX_add_session(SSL_CTX *ctx, SSL_SESSION *c);
71 \&
72 \& int SSL_CTX_remove_session(SSL_CTX *ctx, SSL_SESSION *c);
73 .Ve
74 .SH DESCRIPTION
75 .IX Header "DESCRIPTION"
76 \&\fBSSL_CTX_add_session()\fR adds the session \fBc\fR to the context \fBctx\fR. The
77 reference count for session \fBc\fR is incremented by 1. If a session with
78 the same session id already exists, the old session is removed by calling
79 \&\fBSSL_SESSION_free\fR\|(3).
80 .PP
81 \&\fBSSL_CTX_remove_session()\fR removes the session \fBc\fR from the context \fBctx\fR and
82 marks it as non-resumable. \fBSSL_SESSION_free\fR\|(3) is called once for \fBc\fR.
83 .SH NOTES
84 .IX Header "NOTES"
85 When adding a new session to the internal session cache, it is examined
86 whether a session with the same session id already exists. In this case
87 it is assumed that both sessions are identical. If the same session is
88 stored in a different SSL_SESSION object, The old session is
89 removed and replaced by the new session. If the session is actually
90 identical (the SSL_SESSION object is identical), \fBSSL_CTX_add_session()\fR
91 is a no-op, and the return value is 0.
92 .PP
93 If a server SSL_CTX is configured with the SSL_SESS_CACHE_NO_INTERNAL_STORE
94 flag then the internal cache will not be populated automatically by new
95 sessions negotiated by the SSL/TLS implementation, even though the internal
96 cache will be searched automatically for session-resume requests (the
97 latter can be suppressed by SSL_SESS_CACHE_NO_INTERNAL_LOOKUP). So the
98 application can use \fBSSL_CTX_add_session()\fR directly to have full control
99 over the sessions that can be resumed if desired.
100 .SH "RETURN VALUES"
101 .IX Header "RETURN VALUES"
102 The following values are returned by all functions:
103 .IP 0 4
104 The operation failed. In case of the add operation, it was tried to add
105 the same (identical) session twice. In case of the remove operation, the
106 session was not found in the cache.
107 .IP 1 4
108 .IX Item "1"
109 The operation succeeded.
110 .SH "SEE ALSO"
111 .IX Header "SEE ALSO"
112 \&\fBssl\fR\|(7),
113 \&\fBSSL_CTX_set_session_cache_mode\fR\|(3),
114 \&\fBSSL_SESSION_free\fR\|(3)
115 .SH COPYRIGHT
116 .IX Header "COPYRIGHT"
117 Copyright 2001\-2016 The OpenSSL Project Authors. All Rights Reserved.
118 .PP
119 Licensed under the Apache License 2.0 (the "License"). You may not use
120 this file except in compliance with the License. You can obtain a copy
121 in the file LICENSE in the source distribution or at
122 <https://www.openssl.org/source/license.html>.