SSL_get1_session (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_get1_session.3ssl".)

NAME

SSL_get_session, SSL_get0_session, SSL_get1_session - retrieve TLS/SSL session data

SYNOPSIS

 #include <openssl/ssl.h>

 SSL_SESSION *SSL_get_session(const SSL *ssl);
 SSL_SESSION *SSL_get0_session(const SSL *ssl);
 SSL_SESSION *SSL_get1_session(SSL *ssl);

DESCRIPTION

SSL_get_session() returns a pointer to the actually used in ssl. The reference count of the is not incremented, so that the pointer can become invalid by other operations.

SSL_get0_session() is the same as SSL_get_session().

SSL_get1_session() is the same as SSL_get_session(), but the reference count of the

is incremented by one.

NOTES

The ssl session contains all information required to re-establish the connection without a new handshake.

SSL_get0_session() returns a pointer to the actual session. As the reference counter is not incremented, the pointer is only valid while the connection is in use. If SSL_clear(3) or SSL_free(3) is called, the session may be removed completely (if considered bad), and the pointer obtained will become invalid. Even if the session is valid, it can be removed at any time due to timeout during SSL_CTX_flush_sessions(3).

If the data is to be kept, SSL_get1_session() will increment the reference count, so that the session will not be implicitly removed by other operations but stays in memory. In order to remove the session SSL_SESSION_free(3) must be explicitly called once to decrement the reference count again.

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

RETURN VALUES

The following return values can occur:

NULL

There is no session available in ssl.

Pointer to an

SSL_SESSION

The return value points to the data of an

SSL

session.

SEE ALSO

ssl(3), SSL_free(3), SSL_clear(3), SSL_SESSION_free(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>.