Deleted Added
full compact
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, unsigned char **pp, long length);
12 int i2d_SSL_SESSION(SSL_SESSION *in, unsigned char **pp);
13
14=head1 DESCRIPTION
15
16d2i_SSL_SESSION() transforms the external ASN1 representation of an SSL/TLS
17session, stored as binary data at location B<pp> with length B<length>, into
18an SSL_SESSION object.
19
20i2d_SSL_SESSION() transforms the SSL_SESSION object B<in> into the ASN1
21representation and stores it into the memory location pointed to by B<pp>.
22The length of the resulting ASN1 representation is returned. If B<pp> is
23the NULL pointer, only the length is calculated and returned.
24
25=head1 NOTES
26
27The SSL_SESSION object is built from several malloc()ed parts, it can
28therefore not be moved, copied or stored directly. In order to store
29session data on disk or into a database, it must be transformed into
30a binary ASN1 representation.
31
32When using d2i_SSL_SESSION(), the SSL_SESSION object is automatically
33allocated.
34
35When using i2d_SSL_SESSION(), the memory location pointed to by B<pp> must be
36large enough to hold the binary representation of the session. There is no
37known limit on the size of the created ASN1 representation, so the necessary
38amount of space should be obtained by first calling i2d_SSL_SESSION() with
39B<pp=NULL>, and obtain the size needed, then allocate the memory and
40call i2d_SSL_SESSION() again.
41
42=head1 RETURN VALUES
43
44d2i_SSL_SESSION() returns a pointer to the newly allocated SSL_SESSION
45object. In case of failure the NULL-pointer is returned and the error message
46can be retrieved from the error stack.
47
48i2d_SSL_SESSION() returns the size of the ASN1 representation in bytes.
49When the session is not valid, B<0> is returned and no operation is performed.
50
51=head1 SEE ALSO
52
53L<ssl(3)|ssl(3)>,
54L<SSL_CTX_sess_set_get_cb(3)|SSL_CTX_sess_set_get_cb(3)>
55
56=cut