Document when a session gets removed from cache

Document the fact that if a session is not closed down cleanly then the
session gets removed from the cache and marked as non-resumable.

Fixes #4720

Reviewed-by: Rich Salz <rsalz@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/6054)

(cherry picked from commit 0abb903b7618ad404c83ac9b44b2c1bf162b90de)
This commit is contained in:
Matt Caswell 2018-04-23 11:23:43 +01:00
parent 279bf3e0a0
commit 9668efbcf3

View File

@ -28,6 +28,11 @@ count of the B<SSL_SESSION> is incremented by one.
The ssl session contains all information required to re-establish the The ssl session contains all information required to re-establish the
connection without a new handshake. connection without a new handshake.
A session will be automatically removed from the session cache and marked as
non-resumable if the connection is not closed down cleanly, e.g. if a fatal
error occurs on the connection or L<SSL_shutdown(3)> is not called prior to
L<SSL_free(3)>.
SSL_get0_session() returns a pointer to the actual session. As the SSL_get0_session() returns a pointer to the actual session. As the
reference counter is not incremented, the pointer is only valid while reference counter is not incremented, the pointer is only valid while
the connection is in use. If L<SSL_clear(3)|SSL_clear(3)> or the connection is in use. If L<SSL_clear(3)|SSL_clear(3)> or