BIO_s_accept.pod: add documentation for the new macros

[openssl.git] / doc / man3 / SSL_SESSION_set1_id.pod

diff --git a/doc/man3/SSL_SESSION_set1_id.pod b/doc/man3/SSL_SESSION_set1_id.pod
index c75bb4be903dded81049dc13713527391769570a..f0b131d6a1f6f791957b5a30d30a846ce2b0aa3e 100644 (file)
--- a/doc/man3/SSL_SESSION_set1_id.pod
+++ b/doc/man3/SSL_SESSION_set1_id.pod
@@ -2,22 +2,31 @@
 
 =head1 NAME
 
-SSL_SESSION_set1_id - set the SSL session ID
+SSL_SESSION_get_id,
+SSL_SESSION_set1_id
+- get and set the SSL session ID
 
 =head1 SYNOPSIS
 
  #include <openssl/ssl.h>
 
+ const unsigned char *SSL_SESSION_get_id(const SSL_SESSION *s,
+                                         unsigned int *len)
  int SSL_SESSION_set1_id(SSL_SESSION *s, const unsigned char *sid,
                          unsigned int sid_len);
 
 =head1 DESCRIPTION
 
-SSL_SESSION_set1_id() sets the the session ID for the B<ssl> SSL/TLS session
+SSL_SESSION_get_id() returns a pointer to the internal session id value for the
+session B<s>. The length of the id in bytes is stored in B<*len>. The length may
+be 0. The caller should not free the returned pointer directly.
+
+SSL_SESSION_set1_id() sets the session ID for the B<ssl> SSL/TLS session
 to B<sid> of length B<sid_len>.
 
 =head1 RETURN VALUES
 
+SSL_SESSION_get_id() returns a pointer to the session id value.
 SSL_SESSION_set1_id() returns 1 for success and 0 for failure, for example
 if the supplied session ID length exceeds B<SSL_MAX_SSL_SESSION_ID_LENGTH>.