$NetBSD: SSL_SESSION_free.3,v 1.25 2024/09/08 13:08:33 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_SESSION_free 3" For nroff, turn off justification. Always turn off hyphenation; it makes
way too many mistakes in technical documents.
SSL_SESSION_new, SSL_SESSION_dup, SSL_SESSION_up_ref, SSL_SESSION_free - create, free and manage SSL_SESSION structures Header "SYNOPSIS" .Vb 1 #include <openssl/ssl.h> \& SSL_SESSION *SSL_SESSION_new(void); SSL_SESSION *SSL_SESSION_dup(const SSL_SESSION *src); int SSL_SESSION_up_ref(SSL_SESSION *ses); void SSL_SESSION_free(SSL_SESSION *session); .Ve Header "DESCRIPTION" \fBSSL_SESSION_new() creates a new SSL_SESSION structure and returns a pointer to it.

\fBSSL_SESSION_dup() creates a new SSL_SESSION structure that is a copy of src. The copy is not owned by any cache that src may have been in.

\fBSSL_SESSION_up_ref() increments the reference count on the given SSL_SESSION structure.

\fBSSL_SESSION_free() decrements the reference count of session and removes the SSL_SESSION structure pointed to by session and frees up the allocated memory, if the reference count has reached 0. If session is NULL nothing is done.

Header "NOTES" SSL_SESSION objects are allocated, when a TLS/SSL handshake operation is successfully completed. Depending on the settings, see \fBSSL_CTX_set_session_cache_mode\|(3), the SSL_SESSION objects are internally referenced by the SSL_CTX and linked into its session cache. SSL objects may be using the SSL_SESSION object; as a session may be reused, several SSL objects may be using one SSL_SESSION object at the same time. It is therefore crucial to keep the reference count (usage information) correct and not delete a SSL_SESSION object that is still used, as this may lead to program failures due to dangling pointers. These failures may also appear delayed, e.g. when an SSL_SESSION object was completely freed as the reference count incorrectly became 0, but it is still referenced in the internal session cache and the cache list is processed during a \fBSSL_CTX_flush_sessions\|(3) operation.

\fBSSL_SESSION_free() must only be called for SSL_SESSION objects, for which the reference count was explicitly incremented (e.g. by calling SSL_get1_session(), see SSL_get_session\|(3)) or when the SSL_SESSION object was generated outside a TLS handshake operation, e.g. by using d2i_SSL_SESSION\|(3). It must not be called on other SSL_SESSION objects, as this would cause incorrect reference counts and therefore program failures.

Header "RETURN VALUES" SSL_SESSION_new returns a pointer to the newly allocated SSL_SESSION structure or NULL on error.

SSL_SESSION_dup returns a pointer to the new copy or NULL on error.

SSL_SESSION_up_ref returns 1 on success or 0 on error.

Header "SEE ALSO" \fBssl\|(7), SSL_get_session\|(3), \fBSSL_CTX_set_session_cache_mode\|(3), \fBSSL_CTX_flush_sessions\|(3), \fBd2i_SSL_SESSION\|(3) Header "HISTORY" The SSL_SESSION_dup() function was added in OpenSSL 1.1.1. Header "COPYRIGHT" Copyright 2000-2023 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>.