xref: /openssl/doc/man3/d2i_SSL_SESSION.pod (revision 0f77b6f1)
1=pod
2
3=head1 NAME
4
5d2i_SSL_SESSION, d2i_SSL_SESSION_ex, i2d_SSL_SESSION - convert SSL_SESSION object from/to ASN1 representation
6
7=head1 SYNOPSIS
8
9 #include <openssl/ssl.h>
10
11 SSL_SESSION *d2i_SSL_SESSION(SSL_SESSION **a, const unsigned char **pp,
12                              long length);
13 SSL_SESSION *d2i_SSL_SESSION_ex(SSL_SESSION **a, const unsigned char **pp,
14                                 long length, OSSL_LIB_CTX *libctx,
15                                 const char *propq);
16 int i2d_SSL_SESSION(SSL_SESSION *in, unsigned char **pp);
17
18=head1 DESCRIPTION
19
20These functions decode and encode an SSL_SESSION object.
21For encoding details see L<d2i_X509(3)>.
22
23SSL_SESSION objects keep internal link information about the session cache
24list, when being inserted into one SSL_CTX object's session cache.
25One SSL_SESSION object, regardless of its reference count, must therefore
26only be used with one SSL_CTX object (and the SSL objects created
27from this SSL_CTX object).
28
29=head1 RETURN VALUES
30
31d2i_SSL_SESSION() and d2i_SSL_SESSION_ex() return a pointer to the newly
32allocated SSL_SESSION object.
33In case of failure the NULL-pointer is returned and the error message
34can be retrieved from the error stack.
35
36i2d_SSL_SESSION() returns the size of the ASN1 representation in bytes.
37When the session is not valid, B<0> is returned and no operation is performed.
38
39=head1 SEE ALSO
40
41L<ssl(7)>, L<SSL_SESSION_free(3)>,
42L<SSL_CTX_sess_set_get_cb(3)>,
43L<d2i_X509(3)>
44
45=head1 HISTORY
46
47The function d2i_SSL_SESSION_ex() was added in OpenSSL 3.2.
48
49=head1 COPYRIGHT
50
51Copyright 2001-2024 The OpenSSL Project Authors. All Rights Reserved.
52
53Licensed under the Apache License 2.0 (the "License").  You may not use
54this file except in compliance with the License.  You can obtain a copy
55in the file LICENSE in the source distribution or at
56L<https://www.openssl.org/source/license.html>.
57
58=cut
59