diff options
Diffstat (limited to 'src/lib/libssl/doc/SSL_CTX_add_session.3')
-rw-r--r-- | src/lib/libssl/doc/SSL_CTX_add_session.3 | 90 |
1 files changed, 0 insertions, 90 deletions
diff --git a/src/lib/libssl/doc/SSL_CTX_add_session.3 b/src/lib/libssl/doc/SSL_CTX_add_session.3 deleted file mode 100644 index 073b919dc1..0000000000 --- a/src/lib/libssl/doc/SSL_CTX_add_session.3 +++ /dev/null | |||
@@ -1,90 +0,0 @@ | |||
1 | .\" | ||
2 | .\" $OpenBSD: SSL_CTX_add_session.3,v 1.2 2014/12/02 14:11:01 jmc Exp $ | ||
3 | .\" | ||
4 | .Dd $Mdocdate: December 2 2014 $ | ||
5 | .Dt SSL_CTX_ADD_SESSION 3 | ||
6 | .Os | ||
7 | .Sh NAME | ||
8 | .Nm SSL_CTX_add_session , | ||
9 | .Nm SSL_add_session , | ||
10 | .Nm SSL_CTX_remove_session , | ||
11 | .Nm SSL_remove_session | ||
12 | .Nd manipulate session cache | ||
13 | .Sh SYNOPSIS | ||
14 | .In openssl/ssl.h | ||
15 | .Ft int | ||
16 | .Fn SSL_CTX_add_session "SSL_CTX *ctx" "SSL_SESSION *c" | ||
17 | .Ft int | ||
18 | .Fn SSL_add_session "SSL_CTX *ctx" "SSL_SESSION *c" | ||
19 | .Ft int | ||
20 | .Fn SSL_CTX_remove_session "SSL_CTX *ctx" "SSL_SESSION *c" | ||
21 | .Ft int | ||
22 | .Fn SSL_remove_session "SSL_CTX *ctx" "SSL_SESSION *c" | ||
23 | .Sh DESCRIPTION | ||
24 | .Fn SSL_CTX_add_session | ||
25 | adds the session | ||
26 | .Fa c | ||
27 | to the context | ||
28 | .Fa ctx . | ||
29 | The reference count for session | ||
30 | .Fa c | ||
31 | is incremented by 1. | ||
32 | If a session with the same session id already exists, | ||
33 | the old session is removed by calling | ||
34 | .Xr SSL_SESSION_free 3 . | ||
35 | .Pp | ||
36 | .Fn SSL_CTX_remove_session | ||
37 | removes the session | ||
38 | .Fa c | ||
39 | from the context | ||
40 | .Fa ctx . | ||
41 | .Xr SSL_SESSION_free 3 | ||
42 | is called once for | ||
43 | .Fa c . | ||
44 | .Pp | ||
45 | .Fn SSL_add_session | ||
46 | and | ||
47 | .Fn SSL_remove_session | ||
48 | are synonyms for their | ||
49 | .Fn SSL_CTX_* | ||
50 | counterparts. | ||
51 | .Sh NOTES | ||
52 | When adding a new session to the internal session cache, it is examined | ||
53 | whether a session with the same session id already exists. | ||
54 | In this case it is assumed that both sessions are identical. | ||
55 | If the same session is stored in a different | ||
56 | .Vt SSL_SESSION | ||
57 | object, the old session is removed and replaced by the new session. | ||
58 | If the session is actually identical (the | ||
59 | .Vt SSL_SESSION | ||
60 | object is identical), | ||
61 | .Fn SSL_CTX_add_session | ||
62 | is a no-op, and the return value is 0. | ||
63 | .Pp | ||
64 | If a server | ||
65 | .Vt SSL_CTX | ||
66 | is configured with the | ||
67 | .Dv SSL_SESS_CACHE_NO_INTERNAL_STORE | ||
68 | flag then the internal cache will not be populated automatically by new | ||
69 | sessions negotiated by the SSL/TLS implementation, even though the internal | ||
70 | cache will be searched automatically for session-resume requests (the | ||
71 | latter can be suppressed by | ||
72 | .Dv SSL_SESS_CACHE_NO_INTERNAL_LOOKUP ) . | ||
73 | So the application can use | ||
74 | .Fn SSL_CTX_add_session | ||
75 | directly to have full control over the sessions that can be resumed if desired. | ||
76 | .Sh RETURN VALUES | ||
77 | The following values are returned by all functions: | ||
78 | .Bl -tag -width Ds | ||
79 | .It 0 | ||
80 | The operation failed. | ||
81 | In case of the add operation, it was tried to add the same (identical) session | ||
82 | twice. | ||
83 | In case of the remove operation, the session was not found in the cache. | ||
84 | .It 1 | ||
85 | The operation succeeded. | ||
86 | .El | ||
87 | .Sh SEE ALSO | ||
88 | .Xr ssl 3 , | ||
89 | .Xr SSL_CTX_set_session_cache_mode 3 , | ||
90 | .Xr SSL_SESSION_free 3 | ||