Commit 52129c0b authored by Lutz Jänicke's avatar Lutz Jänicke
Browse files

More details about session timeout settings.

parent a52877a2

doc/ssl/SSL_CTX_set_timeout.pod

+6 −2
Original line number Diff line number Diff line
@@ -37,7 +37,10 @@ L<SSL_CTX_flush_sessions(3)|SSL_CTX_flush_sessions(3)> is called, either 
directly by the application or automatically (see

L<SSL_CTX_set_session_cache_mode(3)|SSL_CTX_set_session_cache_mode(3)>)



The default value for session timeout is 300 seconds.

The default value for session timeout is decided on a per protocol

basis, see L<SSL_get_default_timeout(3)|SSL_get_default_timeout(3)>.

All currently supported protocols have the same default timeout value

of 300 seconds.



=head1 RETURN VALUES
@@ -50,6 +53,7 @@ SSL_CTX_get_timeout() returns the currently set timeout value. 
L<ssl(3)|ssl(3)>,

L<SSL_CTX_set_session_cache_mode(3)|SSL_CTX_set_session_cache_mode(3)>,

L<SSL_SESSION_get_time(3)|SSL_SESSION_get_time(3)>,

L<SSL_CTX_flush_sessions(3)|SSL_CTX_flush_sessions(3)>

L<SSL_CTX_flush_sessions(3)|SSL_CTX_flush_sessions(3)>,

L<SSL_get_default_timeout(3)|SSL_get_default_timeout(3)>



=cut

doc/ssl/SSL_SESSION_get_time.pod

+2 −1
Original line number Diff line number Diff line
@@ -58,6 +58,7 @@ If any of the function is passed the NULL pointer for the session B<s>, 
=head1 SEE ALSO



L<ssl(3)|ssl(3)>,

L<SSL_CTX_set_timeout(3)|SSL_CTX_set_timeout(3)>

L<SSL_CTX_set_timeout(3)|SSL_CTX_set_timeout(3)>,

L<SSL_get_default_timeout(3)|SSL_get_default_timeout(3)>



=cut

doc/ssl/SSL_get_default_timeout.pod

0 → 100644
+41 −0
Original line number Diff line number Diff line 
=pod



=head1 NAME



SSL_get_default_timeout - get default session timeout value



=head1 SYNOPSIS



 #include <openssl/ssl.h>



 long SSL_get_default_timeout(SSL *ssl);



=head1 DESCRIPTION



SSL_get_default_timeout() returns the default timeout value assigned to

SSL_SESSION objects negotiated for the protocol valid for B<ssl>.



=head1 NOTES



Whenever a new session is negotiated, it is assigned a timeout value,

after which it will not be accepted for session reuse. If the timeout

value was not explicitly set using

L<SSL_CTX_set_timeout(3)|SSL_CTX_set_timeout(3)>, the hardcoded default

timeout for the protocol will be used.



SSL_get_default_timeout() return this hardcoded value, which is 300 seconds

for all currently supported protocols (SSLv2, SSLv3, and TLSv1).



=head1 RETURN VALUES



See description.



=head1 SEE ALSO



L<ssl(3)|ssl(3)>,

L<SSL_CTX_set_session_cache_mode(3)|SSL_CTX_set_session_cache_mode(3)>,

L<SSL_SESSION_get_time(3)|SSL_SESSION_get_time(3)>,

L<SSL_CTX_flush_sessions(3)|SSL_CTX_flush_sessions(3)>,

L<SSL_get_default_timeout(3)|SSL_get_default_timeout(3)>



=cut

doc/ssl/ssl.pod

+1 −0
Original line number Diff line number Diff line
@@ -679,6 +679,7 @@ L<SSL_CTX_use_certificate(3)|SSL_CTX_use_certificate(3)>, 
L<SSL_get_SSL_CTX(3)|SSL_get_SSL_CTX(3)>,

L<SSL_get_ciphers(3)|SSL_get_ciphers(3)>,

L<SSL_get_client_CA_list(3)|SSL_get_client_CA_list(3)>,

L<SSL_get_default_timeout(3)|SSL_get_default_timeout(3)>,

L<SSL_get_error(3)|SSL_get_error(3)>,

L<SSL_get_ex_data_X509_STORE_CTX_idx(3)|SSL_get_ex_data_X509_STORE_CTX_idx(3)>,

L<SSL_get_ex_new_index(3)|SSL_get_ex_new_index(3)>,