diff options
author | Rich Salz <rsalz@openssl.org> | 2016-06-07 15:49:08 -0400 |
---|---|---|
committer | Rich Salz <rsalz@openssl.org> | 2016-06-07 15:49:08 -0400 |
commit | 4692340e31985681f95008d409483d5761b6c213 (patch) | |
tree | 7617015a4bba74d8aead0fa9e04ecfb856aaefaf /doc/ssl | |
parent | fbba5d113f1294992cd99643c79860df8f64015a (diff) |
Unify d2i/i2d documentation.
Make d2i_X509 a generic d2i/i2d manpage.
Pull common stuff out of other d2i/i2d docs.
Update find-doc-nits to know about "generic" manpages.
Cleanup some overlap.
Fix up a bunch of other references.
Reviewed-by: Matt Caswell <matt@openssl.org>
Diffstat (limited to 'doc/ssl')
-rw-r--r-- | doc/ssl/d2i_SSL_SESSION.pod | 44 |
1 files changed, 4 insertions, 40 deletions
diff --git a/doc/ssl/d2i_SSL_SESSION.pod b/doc/ssl/d2i_SSL_SESSION.pod index 628c7e42b1..d6b17071f6 100644 --- a/doc/ssl/d2i_SSL_SESSION.pod +++ b/doc/ssl/d2i_SSL_SESSION.pod @@ -13,28 +13,8 @@ d2i_SSL_SESSION, i2d_SSL_SESSION - convert SSL_SESSION object from/to ASN1 repre =head1 DESCRIPTION -d2i_SSL_SESSION() transforms the external ASN1 representation of an SSL/TLS -session, stored as binary data at location B<pp> with length B<length>, into -an SSL_SESSION object. - -i2d_SSL_SESSION() transforms the SSL_SESSION object B<in> into the ASN1 -representation and stores it into the memory location pointed to by B<pp>. -The length of the resulting ASN1 representation is returned. If B<pp> is -the NULL pointer, only the length is calculated and returned. - -=head1 NOTES - -The SSL_SESSION object is built from several malloc()ed parts, it can -therefore not be moved, copied or stored directly. In order to store -session data on disk or into a database, it must be transformed into -a binary ASN1 representation. - -When using d2i_SSL_SESSION(), the SSL_SESSION object is automatically -allocated. The reference count is 1, so that the session must be -explicitly removed using L<SSL_SESSION_free(3)>, -unless the SSL_SESSION object is completely taken over, when being called -inside the get_session_cb() (see -L<SSL_CTX_sess_set_get_cb(3)>). +These functions decode and encode an SSL_SESSION object. +For encoding details see L<d2i_X509(3)>. SSL_SESSION objects keep internal link information about the session cache list, when being inserted into one SSL_CTX object's session cache. @@ -42,23 +22,6 @@ One SSL_SESSION object, regardless of its reference count, must therefore only be used with one SSL_CTX object (and the SSL objects created from this SSL_CTX object). -When using i2d_SSL_SESSION(), the memory location pointed to by B<pp> must be -large enough to hold the binary representation of the session. There is no -known limit on the size of the created ASN1 representation, so the necessary -amount of space should be obtained by first calling i2d_SSL_SESSION() with -B<pp=NULL>, and obtain the size needed, then allocate the memory and -call i2d_SSL_SESSION() again. -Note that this will advance the value contained in B<*pp> so it is necessary -to save a copy of the original allocation. -For example: - int i,j; - char *p, *temp; - i = i2d_SSL_SESSION(sess, NULL); - p = temp = malloc(i); - j = i2d_SSL_SESSION(sess, &temp); - assert(i == j); - assert(p+i == temp); - =head1 RETURN VALUES d2i_SSL_SESSION() returns a pointer to the newly allocated SSL_SESSION @@ -71,7 +34,8 @@ When the session is not valid, B<0> is returned and no operation is performed. =head1 SEE ALSO L<ssl(3)>, L<SSL_SESSION_free(3)>, -L<SSL_CTX_sess_set_get_cb(3)> +L<SSL_CTX_sess_set_get_cb(3)>, +L<d2i_X509(3)> =head1 COPYRIGHT |