summaryrefslogtreecommitdiff
path: root/lib/libssl/man/SSL_get_default_timeout.3
diff options
context:
space:
mode:
authorIngo Schwarze <schwarze@cvs.openbsd.org>2016-11-05 15:32:21 +0000
committerIngo Schwarze <schwarze@cvs.openbsd.org>2016-11-05 15:32:21 +0000
commitd57388548c41c92b1975971f9afcd6409f3ead39 (patch)
tree337ba880a20405e5906bb0983c0f3dad584babd6 /lib/libssl/man/SSL_get_default_timeout.3
parent634855ee12cbdf58bb29b7938837bce9cdb3602f (diff)
move manual pages from doc/ to man/ for consistency with other
libraries, in particular considering that there are unrelated files in doc/; requested by jsing@ and beck@
Diffstat (limited to 'lib/libssl/man/SSL_get_default_timeout.3')
-rw-r--r--lib/libssl/man/SSL_get_default_timeout.336
1 files changed, 36 insertions, 0 deletions
diff --git a/lib/libssl/man/SSL_get_default_timeout.3 b/lib/libssl/man/SSL_get_default_timeout.3
new file mode 100644
index 00000000000..a14d8041e2b
--- /dev/null
+++ b/lib/libssl/man/SSL_get_default_timeout.3
@@ -0,0 +1,36 @@
+.\"
+.\" $OpenBSD: SSL_get_default_timeout.3,v 1.1 2016/11/05 15:32:20 schwarze Exp $
+.\"
+.Dd $Mdocdate: November 5 2016 $
+.Dt SSL_GET_DEFAULT_TIMEOUT 3
+.Os
+.Sh NAME
+.Nm SSL_get_default_timeout
+.Nd get default session timeout value
+.Sh SYNOPSIS
+.In openssl/ssl.h
+.Ft long
+.Fn SSL_get_default_timeout "const SSL *ssl"
+.Sh DESCRIPTION
+.Fn SSL_get_default_timeout
+returns the default timeout value assigned to
+.Vt SSL_SESSION
+objects negotiated for the protocol valid for
+.Fa ssl .
+.Sh 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
+.Xr SSL_CTX_set_timeout 3 ,
+the hardcoded default timeout for the protocol will be used.
+.Pp
+.Fn SSL_get_default_timeout
+return this hardcoded value, which is 300 seconds for all currently supported
+protocols (SSLv2, SSLv3, and TLSv1).
+.Sh RETURN VALUES
+See description.
+.Sh SEE ALSO
+.Xr ssl 3 ,
+.Xr SSL_CTX_flush_sessions 3 ,
+.Xr SSL_CTX_set_session_cache_mode 3 ,
+.Xr SSL_SESSION_get_time 3