Debian Codegraph @

upstream/debian-unstable/man3/SSL_set_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_SET_SESSION 3SSL"
58 .TH SSL_SET_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_set_session \- set a TLS/SSL session to be used during TLS/SSL connect
65 .SH SYNOPSIS
66 .IX Header "SYNOPSIS"
67 .Vb 1
68 \& #include <openssl/ssl.h>
69 \&
70 \& int SSL_set_session(SSL *ssl, SSL_SESSION *session);
71 .Ve
72 .SH DESCRIPTION
73 .IX Header "DESCRIPTION"
74 \&\fBSSL_set_session()\fR sets \fBsession\fR to be used when the TLS/SSL connection
75 is to be established. \fBSSL_set_session()\fR is only useful for TLS/SSL clients.
76 When the session is set, the reference count of \fBsession\fR is incremented
77 by 1. If the session is not reused, the reference count is decremented
78 again during \fBSSL_connect()\fR. Whether the session was reused can be queried
79 with the \fBSSL_session_reused\fR\|(3) call.
80 .PP
81 If there is already a session set inside \fBssl\fR (because it was set with
82 \&\fBSSL_set_session()\fR before or because the same \fBssl\fR was already used for
83 a connection), \fBSSL_SESSION_free()\fR will be called for that session.
84 This is also the case when \fBsession\fR is a NULL pointer. If that old
85 session is still \fBopen\fR, it is considered bad and will be removed from the
86 session cache (if used). A session is considered open, if \fBSSL_shutdown\fR\|(3) was
87 not called for the connection (or at least \fBSSL_set_shutdown\fR\|(3) was used to
88 set the SSL_SENT_SHUTDOWN state).
89 .SH NOTES
90 .IX Header "NOTES"
91 SSL_SESSION objects keep internal link information about the session cache
92 list, when being inserted into one SSL_CTX object's session cache.
93 One SSL_SESSION object, regardless of its reference count, must therefore
94 only be used with one SSL_CTX object (and the SSL objects created
95 from this SSL_CTX object).
96 .SH "RETURN VALUES"
97 .IX Header "RETURN VALUES"
98 The following return values can occur:
99 .IP 0 4
100 The operation failed; check the error stack to find out the reason.
101 .IP 1 4
102 .IX Item "1"
103 The operation succeeded.
104 .SH "SEE ALSO"
105 .IX Header "SEE ALSO"
106 \&\fBssl\fR\|(7), \fBSSL_SESSION_free\fR\|(3),
107 \&\fBSSL_get_session\fR\|(3),
108 \&\fBSSL_session_reused\fR\|(3),
109 \&\fBSSL_CTX_set_session_cache_mode\fR\|(3)
110 .SH COPYRIGHT
111 .IX Header "COPYRIGHT"
112 Copyright 2000\-2022 The OpenSSL Project Authors. All Rights Reserved.
113 .PP
114 Licensed under the Apache License 2.0 (the "License"). You may not use
115 this file except in compliance with the License. You can obtain a copy
116 in the file LICENSE in the source distribution or at
117 <https://www.openssl.org/source/license.html>.