$NetBSD: SSL_set_session.3,v 1.25 2024/09/08 13:08:35 christos Exp $

-*- mode: troff; coding: utf-8 -*-
Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)

Standard preamble:
========================================================================
..

..

.. \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
. ds C` "" . ds C' "" 'br\} . ds C` . ds C' 'br\}
Escape single quotes in literal strings from groff's Unicode transform.

If the F register is >0, we'll generate index entries on stderr for
titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
entries marked with X<> in POD. Of course, you'll have to process the
output yourself in some meaningful fashion.

Avoid warning from groff about undefined register 'F'.
.. .nr rF 0 . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF ========================================================================

Title "SSL_set_session 3" For nroff, turn off justification. Always turn off hyphenation; it makes
way too many mistakes in technical documents.
SSL_set_session - set a TLS/SSL session to be used during TLS/SSL connect Header "SYNOPSIS" .Vb 1 #include <openssl/ssl.h> \& int SSL_set_session(SSL *ssl, SSL_SESSION *session); .Ve Header "DESCRIPTION" \fBSSL_set_session() sets session to be used when the TLS/SSL connection is to be established. SSL_set_session() is only useful for TLS/SSL clients. When the session is set, the reference count of session is incremented by 1. If the session is not reused, the reference count is decremented again during SSL_connect(). Whether the session was reused can be queried with the SSL_session_reused\|(3) call.

If there is already a session set inside ssl (because it was set with \fBSSL_set_session() before or because the same ssl was already used for a connection), SSL_SESSION_free() will be called for that session. This is also the case when session is a NULL pointer. If that old session is still open, it is considered bad and will be removed from the session cache (if used). A session is considered open, if SSL_shutdown\|(3) was not called for the connection (or at least SSL_set_shutdown\|(3) was used to set the SSL_SENT_SHUTDOWN state).

Header "NOTES" SSL_SESSION objects keep internal link information about the session cache list, when being inserted into one SSL_CTX object's session cache. One SSL_SESSION object, regardless of its reference count, must therefore only be used with one SSL_CTX object (and the SSL objects created from this SSL_CTX object). Header "RETURN VALUES" The following return values can occur: The operation failed; check the error stack to find out the reason. Item "1" The operation succeeded. Header "SEE ALSO" \fBssl\|(7), SSL_SESSION_free\|(3), \fBSSL_get_session\|(3), \fBSSL_session_reused\|(3), \fBSSL_CTX_set_session_cache_mode\|(3) Header "COPYRIGHT" Copyright 2000-2022 The OpenSSL Project Authors. All Rights Reserved.

Licensed under the Apache License 2.0 (the "License"). You may not use this file except in compliance with the License. You can obtain a copy in the file LICENSE in the source distribution or at <https://www.openssl.org/source/license.html>.