1SSL_SET_SESSION(3ossl)              OpenSSL             SSL_SET_SESSION(3ossl)
2
3
4

NAME

6       SSL_set_session - set a TLS/SSL session to be used during TLS/SSL
7       connect
8

SYNOPSIS

10        #include <openssl/ssl.h>
11
12        int SSL_set_session(SSL *ssl, SSL_SESSION *session);
13

DESCRIPTION

15       SSL_set_session() sets session to be used when the TLS/SSL connection
16       is to be established. SSL_set_session() is only useful for TLS/SSL
17       clients.  When the session is set, the reference count of session is
18       incremented by 1. If the session is not reused, the reference count is
19       decremented again during SSL_connect(). Whether the session was reused
20       can be queried with the SSL_session_reused(3) call.
21
22       If there is already a session set inside ssl (because it was set with
23       SSL_set_session() before or because the same ssl was already used for a
24       connection), SSL_SESSION_free() will be called for that session.  This
25       is also the case when session is a NULL pointer. If that old session is
26       still open, it is considered bad and will be removed from the session
27       cache (if used). A session is considered open, if SSL_shutdown(3) was
28       not called for the connection (or at least SSL_set_shutdown(3) was used
29       to set the SSL_SENT_SHUTDOWN state).
30

NOTES

32       SSL_SESSION objects keep internal link information about the session
33       cache list, when being inserted into one SSL_CTX object's session
34       cache.  One SSL_SESSION object, regardless of its reference count, must
35       therefore only be used with one SSL_CTX object (and the SSL objects
36       created from this SSL_CTX object).
37

RETURN VALUES

39       The following return values can occur:
40
41       0   The operation failed; check the error stack to find out the reason.
42
43       1   The operation succeeded.
44

SEE ALSO

46       ssl(7), SSL_SESSION_free(3), SSL_get_session(3), SSL_session_reused(3),
47       SSL_CTX_set_session_cache_mode(3)
48

50       Copyright 2000-2022 The OpenSSL Project Authors. All Rights Reserved.
51
52       Licensed under the Apache License 2.0 (the "License").  You may not use
53       this file except in compliance with the License.  You can obtain a copy
54       in the file LICENSE in the source distribution or at
55       <https://www.openssl.org/source/license.html>.
56
57
58
593.1.1                             2023-08-31            SSL_SET_SESSION(3ossl)
Impressum