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