xref: /freebsd/crypto/openssl/doc/man3/SSL_CTX_sessions.pod (revision 5ca8e32633c4ffbbcd6762e5888b6a4ba0708c6c)
1=pod
2
3=head1 NAME
4
5SSL_CTX_sessions - access internal session cache
6
7=head1 SYNOPSIS
8
9 #include <openssl/ssl.h>
10
11 LHASH_OF(SSL_SESSION) *SSL_CTX_sessions(SSL_CTX *ctx);
12
13=head1 DESCRIPTION
14
15SSL_CTX_sessions() returns a pointer to the lhash databases containing the
16internal session cache for B<ctx>.
17
18=head1 NOTES
19
20The sessions in the internal session cache are kept in an
21L<LHASH(3)> type database. It is possible to directly
22access this database e.g. for searching. In parallel, the sessions
23form a linked list which is maintained separately from the
24L<LHASH(3)> operations, so that the database must not be
25modified directly but by using the
26L<SSL_CTX_add_session(3)> family of functions.
27
28=head1 RETURN VALUES
29
30SSL_CTX_sessions() returns a pointer to the lhash of B<SSL_SESSION>.
31
32=head1 SEE ALSO
33
34L<ssl(7)>, L<LHASH(3)>,
35L<SSL_CTX_add_session(3)>,
36L<SSL_CTX_set_session_cache_mode(3)>
37
38=head1 COPYRIGHT
39
40Copyright 2001-2021 The OpenSSL Project Authors. All Rights Reserved.
41
42Licensed under the Apache License 2.0 (the "License").  You may not use
43this file except in compliance with the License.  You can obtain a copy
44in the file LICENSE in the source distribution or at
45L<https://www.openssl.org/source/license.html>.
46
47=cut
48