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