diff options
Diffstat (limited to 'src/lib/libssl/doc/SSL_CTX_set_timeout.3')
-rw-r--r-- | src/lib/libssl/doc/SSL_CTX_set_timeout.3 | 65 |
1 files changed, 0 insertions, 65 deletions
diff --git a/src/lib/libssl/doc/SSL_CTX_set_timeout.3 b/src/lib/libssl/doc/SSL_CTX_set_timeout.3 deleted file mode 100644 index 6454c4616f..0000000000 --- a/src/lib/libssl/doc/SSL_CTX_set_timeout.3 +++ /dev/null | |||
@@ -1,65 +0,0 @@ | |||
1 | .\" | ||
2 | .\" $OpenBSD: SSL_CTX_set_timeout.3,v 1.2 2014/12/02 14:11:01 jmc Exp $ | ||
3 | .\" | ||
4 | .Dd $Mdocdate: December 2 2014 $ | ||
5 | .Dt SSL_CTX_SET_TIMEOUT 3 | ||
6 | .Os | ||
7 | .Sh NAME | ||
8 | .Nm SSL_CTX_set_timeout , | ||
9 | .Nm SSL_CTX_get_timeout | ||
10 | .Nd manipulate timeout values for session caching | ||
11 | .Sh SYNOPSIS | ||
12 | .In openssl/ssl.h | ||
13 | .Ft long | ||
14 | .Fn SSL_CTX_set_timeout "SSL_CTX *ctx" "long t" | ||
15 | .Ft long | ||
16 | .Fn SSL_CTX_get_timeout "SSL_CTX *ctx" | ||
17 | .Sh DESCRIPTION | ||
18 | .Fn SSL_CTX_set_timeout | ||
19 | sets the timeout for newly created sessions for | ||
20 | .Fa ctx | ||
21 | to | ||
22 | .Fa t . | ||
23 | The timeout value | ||
24 | .Fa t | ||
25 | must be given in seconds. | ||
26 | .Pp | ||
27 | .Fn SSL_CTX_get_timeout | ||
28 | returns the currently set timeout value for | ||
29 | .Fa ctx . | ||
30 | .Sh NOTES | ||
31 | Whenever a new session is created, it is assigned a maximum lifetime. | ||
32 | This lifetime is specified by storing the creation time of the session and the | ||
33 | timeout value valid at this time. | ||
34 | If the actual time is later than creation time plus timeout, | ||
35 | the session is not reused. | ||
36 | .Pp | ||
37 | Due to this realization, all sessions behave according to the timeout value | ||
38 | valid at the time of the session negotiation. | ||
39 | Changes of the timeout value do not affect already established sessions. | ||
40 | .Pp | ||
41 | The expiration time of a single session can be modified using the | ||
42 | .Xr SSL_SESSION_get_time 3 | ||
43 | family of functions. | ||
44 | .Pp | ||
45 | Expired sessions are removed from the internal session cache, whenever | ||
46 | .Xr SSL_CTX_flush_sessions 3 | ||
47 | is called, either directly by the application or automatically (see | ||
48 | .Xr SSL_CTX_set_session_cache_mode 3 ) . | ||
49 | .Pp | ||
50 | The default value for session timeout is decided on a per-protocol basis; see | ||
51 | .Xr SSL_get_default_timeout 3 . | ||
52 | All currently supported protocols have the same default timeout value of 300 | ||
53 | seconds. | ||
54 | .Sh RETURN VALUES | ||
55 | .Fn SSL_CTX_set_timeout | ||
56 | returns the previously set timeout value. | ||
57 | .Pp | ||
58 | .Fn SSL_CTX_get_timeout | ||
59 | returns the currently set timeout value. | ||
60 | .Sh SEE ALSO | ||
61 | .Xr ssl 3 , | ||
62 | .Xr SSL_CTX_flush_sessions 3 , | ||
63 | .Xr SSL_CTX_set_session_cache_mode 3 , | ||
64 | .Xr SSL_get_default_timeout 3 , | ||
65 | .Xr SSL_SESSION_get_time 3 | ||