1SSL_SET_SESSION(3) OpenSSL SSL_SET_SESSION(3)
2
3
4
6 SSL_set_session - set a TLS/SSL session to be used during TLS/SSL
7 connect
8
10 #include <openssl/ssl.h>
11
12 int SSL_set_session(SSL *ssl, SSL_SESSION *session);
13
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. If
25 that old session is still open, it is considered bad and will be
26 removed from the session cache (if used). A session is considered open,
27 if SSL_shutdown(3) was not called for the connection (or at least
28 SSL_set_shutdown(3) was used to set the SSL_SENT_SHUTDOWN state).
29
31 SSL_SESSION objects keep internal link information about the session
32 cache list, when being inserted into one SSL_CTX object's session
33 cache. One SSL_SESSION object, regardless of its reference count, must
34 therefore only be used with one SSL_CTX object (and the SSL objects
35 created from this SSL_CTX object).
36
38 The following return values can occur:
39
40 0 The operation failed; check the error stack to find out the reason.
41
42 1 The operation succeeded.
43
45 ssl(7), SSL_SESSION_free(3), SSL_get_session(3), SSL_session_reused(3),
46 SSL_CTX_set_session_cache_mode(3)
47
49 Copyright 2000-2016 The OpenSSL Project Authors. All Rights Reserved.
50
51 Licensed under the OpenSSL license (the "License"). You may not use
52 this file except in compliance with the License. You can obtain a copy
53 in the file LICENSE in the source distribution or at
54 <https://www.openssl.org/source/license.html>.
55
56
57
581.1.1q 2022-07-07 SSL_SET_SESSION(3)