]>
Commit | Line | Data |
---|---|---|
0bc6597d LJ |
1 | =pod |
2 | ||
3 | =head1 NAME | |
4 | ||
5 | SSL_CTX_add_session, SSL_add_session, SSL_CTX_remove_session, SSL_remove_session - manipulate session cache | |
6 | ||
7 | =head1 SYNOPSIS | |
8 | ||
9 | #include <openssl/ssl.h> | |
10 | ||
11 | int SSL_CTX_add_session(SSL_CTX *ctx, SSL_SESSION *c); | |
12 | int SSL_add_session(SSL_CTX *ctx, SSL_SESSION *c); | |
13 | ||
14 | int SSL_CTX_remove_session(SSL_CTX *ctx, SSL_SESSION *c); | |
15 | int SSL_remove_session(SSL_CTX *ctx, SSL_SESSION *c); | |
16 | ||
17 | =head1 DESCRIPTION | |
18 | ||
19 | SSL_CTX_add_session() adds the session B<c> to the context B<ctx>. The | |
20 | reference count for session B<c> is incremented by 1. If a session with | |
21 | the same session id already exists, the old session is removed by calling | |
9b86974e | 22 | L<SSL_SESSION_free(3)>. |
0bc6597d LJ |
23 | |
24 | SSL_CTX_remove_session() removes the session B<c> from the context B<ctx>. | |
9b86974e | 25 | L<SSL_SESSION_free(3)> is called once for B<c>. |
0bc6597d LJ |
26 | |
27 | SSL_add_session() and SSL_remove_session() are synonyms for their | |
28 | SSL_CTX_*() counterparts. | |
29 | ||
30 | =head1 NOTES | |
31 | ||
32 | When adding a new session to the internal session cache, it is examined | |
33 | whether a session with the same session id already exists. In this case | |
34 | it is assumed that both sessions are identical. If the same session is | |
35 | stored in a different SSL_SESSION object, The old session is | |
36 | removed and replaced by the new session. If the session is actually | |
37 | identical (the SSL_SESSION object is identical), SSL_CTX_add_session() | |
38 | is a no-op, and the return value is 0. | |
39 | ||
e0db2eed GT |
40 | If a server SSL_CTX is configured with the SSL_SESS_CACHE_NO_INTERNAL_STORE |
41 | flag then the internal cache will not be populated automatically by new | |
42 | sessions negotiated by the SSL/TLS implementation, even though the internal | |
43 | cache will be searched automatically for session-resume requests (the | |
fc1d88f0 | 44 | latter can be suppressed by SSL_SESS_CACHE_NO_INTERNAL_LOOKUP). So the |
e0db2eed GT |
45 | application can use SSL_CTX_add_session() directly to have full control |
46 | over the sessions that can be resumed if desired. | |
47 | ||
0bc6597d LJ |
48 | |
49 | =head1 RETURN VALUES | |
50 | ||
51 | The following values are returned by all functions: | |
52 | ||
53 | =over 4 | |
54 | ||
c8919dde | 55 | =item Z<>0 |
0bc6597d LJ |
56 | |
57 | The operation failed. In case of the add operation, it was tried to add | |
58 | the same (identical) session twice. In case of the remove operation, the | |
59 | session was not found in the cache. | |
60 | ||
c8919dde | 61 | =item Z<>1 |
1bc74519 | 62 | |
0bc6597d LJ |
63 | The operation succeeded. |
64 | ||
65 | =back | |
66 | ||
67 | =head1 SEE ALSO | |
68 | ||
b97fdb57 | 69 | L<ssl(7)>, |
9b86974e RS |
70 | L<SSL_CTX_set_session_cache_mode(3)>, |
71 | L<SSL_SESSION_free(3)> | |
0bc6597d | 72 | |
e2f92610 RS |
73 | =head1 COPYRIGHT |
74 | ||
75 | Copyright 2001-2016 The OpenSSL Project Authors. All Rights Reserved. | |
76 | ||
77 | Licensed under the OpenSSL license (the "License"). You may not use | |
78 | this file except in compliance with the License. You can obtain a copy | |
79 | in the file LICENSE in the source distribution or at | |
80 | L<https://www.openssl.org/source/license.html>. | |
81 | ||
82 | =cut |