In ssl.h rev. 1.148 2018/03/17 14:26:13, jsing@ provided

SSL_SESSION_get0_id_context(3).
Merge the documentation from OpenSSL, tweaked by me.

1 files changed, 30 insertions, 4 deletions

diff --git a/lib/libssl/man/SSL_SESSION_set1_id_context.3 b/lib/libssl/man/SSL_SESSION_set1_id_context.3
index f7fa13ebcfe..29f08781a63 100644
--- a/lib/libssl/man/SSL_SESSION_set1_id_context.3
+++ b/lib/libssl/man/SSL_SESSION_set1_id_context.3
@@ -1,5 +1,6 @@
-.\"	$OpenBSD: SSL_SESSION_set1_id_context.3,v 1.1 2017/04/10 15:37:55 schwarze Exp $
-.\"	OpenSSL SSL_SESSION_get0_id_context.pod b31db505 Mar 24 16:01:50 2017
+.\" $OpenBSD: SSL_SESSION_set1_id_context.3,v 1.2 2018/03/18 07:57:19 schwarze Exp $
+.\" full merge up to:
+.\" OpenSSL SSL_SESSION_get0_id_context b31db505 Mar 24 16:01:50 2017
 .\"
 .\" This file was written by Matt Caswell <matt@openssl.org>
 .\" Copyright (c) 2017 The OpenSSL Project.  All rights reserved.
@@ -48,14 +49,20 @@
 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
 .\" OF THE POSSIBILITY OF SUCH DAMAGE.
 .\"
-.Dd $Mdocdate: April 10 2017 $
+.Dd $Mdocdate: March 18 2018 $
 .Dt SSL_SESSION_SET1_ID_CONTEXT 3
 .Os
 .Sh NAME
+.Nm SSL_SESSION_get0_id_context ,
 .Nm SSL_SESSION_set1_id_context
-.Nd set the SSL ID context associated with a session
+.Nd get and set the SSL ID context associated with a session
 .Sh SYNOPSIS
 .In openssl/ssl.h
+.Ft const unsigned char *
+.Fo SSL_SESSION_get0_id_context
+.Fa "const SSL_SESSION *s"
+.Fa "unsigned int *len"
+.Fc
 .Ft int
 .Fo SSL_SESSION_set1_id_context
 .Fa "SSL_SESSION *s"
@@ -63,6 +70,16 @@
 .Fa "unsigned int sid_ctx_len"
 .Fc
 .Sh DESCRIPTION
+.Fn SSL_SESSION_get0_id_context
+returns the ID context associated with
+.Fa s .
+The length of the ID context in bytes is written to
+.Pf * Fa len
+if
+.Fa len
+is not
+.Dv NULL .
+.Pp
 .Fn SSL_SESSION_set1_id_context
 takes a copy of the provided ID context given in
 .Fa sid_ctx
@@ -74,6 +91,11 @@ which must not exceed
 .Dv SSL_MAX_SID_CTX_LENGTH
 bytes.
 .Sh RETURN VALUES
+.Fn SSL_SESSION_get0_id_context
+returns an internal pointer to an object maintained within
+.Fa s
+that should not be freed by the caller.
+.Pp
 .Fn SSL_SESSION_set1_id_context
 returns 1 on success or 0 on error.
 .Sh SEE ALSO
@@ -81,3 +103,7 @@ returns 1 on success or 0 on error.
 .Xr SSL_CTX_set_session_id_context 3 ,
 .Xr SSL_get_session 3 ,
 .Xr SSL_SESSION_new 3
+.Sh HISTORY
+.Fa SSL_SESSION_get0_id_context
+first appeared in OpenSSL 1.1.0 and has been available since
+.Ox 6.3 .