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