SSL_SESSION_up_ref (3)

Leading comments

Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35)

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

(The comments found at the beginning of the groff file "man3/SSL_SESSION_up_ref.3ssl".)

NAME

SSL_SESSION_new, SSL_SESSION_up_ref, SSL_SESSION_free - create, free and manage SSL_SESSION structures

SYNOPSIS

 #include <openssl/ssl.h>

 SSL_SESSION *SSL_SESSION_new(void);
 int SSL_SESSION_up_ref(SSL_SESSION *ses);
 void SSL_SESSION_free(SSL_SESSION *session);

DESCRIPTION

SSL_SESSION_new() creates a new structure and returns a pointer to it.

SSL_SESSION_up_ref() increments the reference count on the given

structure.

SSL_SESSION_free() decrements the reference count of session and removes the

structure pointed to by session and frees up the allocated memory, if the reference count has reached 0. If session is nothing is done.

NOTES

objects are allocated, when a handshake operation is successfully completed. Depending on the settings, see SSL_CTX_set_session_cache_mode(3), the objects are internally referenced by the and linked into its session cache. objects may be using the object; as a session may be reused, several objects may be using one object at the same time. It is therefore crucial to keep the reference count (usage information) correct and not delete a 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 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 SSL_CTX_flush_sessions(3) operation.

SSL_SESSION_free() must only be called for

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

RETURN VALUES

SSL_SESSION_new returns a pointer to the newly allocated structure or on error.

SSL_SESSION_up_ref returns 1 on success or 0 on error.

SEE ALSO

ssl(3), SSL_get_session(3), SSL_CTX_set_session_cache_mode(3), SSL_CTX_flush_sessions(3), d2i_SSL_SESSION(3)

COPYRIGHT

Copyright 2000-2016 The OpenSSL Project Authors. All Rights Reserved.

Licensed under the OpenSSL license (the ``License''). You may not use this file except in compliance with the License. You can obtain a copy in the file

in the source distribution or at <www.openssl.org/source/license.html>.