diff options
Diffstat (limited to 'src/lib/libssl/doc/SSL_CTX_flush_sessions.3')
-rw-r--r-- | src/lib/libssl/doc/SSL_CTX_flush_sessions.3 | 57 |
1 files changed, 0 insertions, 57 deletions
diff --git a/src/lib/libssl/doc/SSL_CTX_flush_sessions.3 b/src/lib/libssl/doc/SSL_CTX_flush_sessions.3 deleted file mode 100644 index 9d3c52cdd5..0000000000 --- a/src/lib/libssl/doc/SSL_CTX_flush_sessions.3 +++ /dev/null | |||
@@ -1,57 +0,0 @@ | |||
1 | .\" | ||
2 | .\" $OpenBSD: SSL_CTX_flush_sessions.3,v 1.2 2014/12/02 14:11:01 jmc Exp $ | ||
3 | .\" | ||
4 | .Dd $Mdocdate: December 2 2014 $ | ||
5 | .Dt SSL_CTX_FLUSH_SESSIONS 3 | ||
6 | .Os | ||
7 | .Sh NAME | ||
8 | .Nm SSL_CTX_flush_sessions , | ||
9 | .Nm SSL_flush_sessions | ||
10 | .Nd remove expired sessions | ||
11 | .Sh SYNOPSIS | ||
12 | .In openssl/ssl.h | ||
13 | .Ft void | ||
14 | .Fn SSL_CTX_flush_sessions "SSL_CTX *ctx" "long tm" | ||
15 | .Ft void | ||
16 | .Fn SSL_flush_sessions "SSL_CTX *ctx" "long tm" | ||
17 | .Sh DESCRIPTION | ||
18 | .Fn SSL_CTX_flush_sessions | ||
19 | causes a run through the session cache of | ||
20 | .Fa ctx | ||
21 | to remove sessions expired at time | ||
22 | .Fa tm . | ||
23 | .Pp | ||
24 | .Fn SSL_flush_sessions | ||
25 | is a synonym for | ||
26 | .Fn SSL_CTX_flush_sessions . | ||
27 | .Sh NOTES | ||
28 | If enabled, the internal session cache will collect all sessions established | ||
29 | up to the specified maximum number (see | ||
30 | .Fn SSL_CTX_sess_set_cache_size ) . | ||
31 | As sessions will not be reused ones they are expired, they should be | ||
32 | removed from the cache to save resources. | ||
33 | This can either be done automatically whenever 255 new sessions were | ||
34 | established (see | ||
35 | .Xr SSL_CTX_set_session_cache_mode 3 ) | ||
36 | or manually by calling | ||
37 | .Fn SSL_CTX_flush_sessions . | ||
38 | .Pp | ||
39 | The parameter | ||
40 | .Fa tm | ||
41 | specifies the time which should be used for the | ||
42 | expiration test, in most cases the actual time given by | ||
43 | .Fn time 0 | ||
44 | will be used. | ||
45 | .Pp | ||
46 | .Fn SSL_CTX_flush_sessions | ||
47 | will only check sessions stored in the internal cache. | ||
48 | When a session is found and removed, the | ||
49 | .Va remove_session_cb | ||
50 | is however called to synchronize with the external cache (see | ||
51 | .Xr SSL_CTX_sess_set_get_cb 3 ) . | ||
52 | .Sh RETURN VALUES | ||
53 | .Sh SEE ALSO | ||
54 | .Xr ssl 3 , | ||
55 | .Xr SSL_CTX_sess_set_get_cb 3 , | ||
56 | .Xr SSL_CTX_set_session_cache_mode 3 , | ||
57 | .Xr SSL_CTX_set_timeout 3 | ||