In ssl.h rev. 1.154 2018/03/20 15:28:12, tb@ provided

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

1 files changed, 37 insertions, 9 deletions

diff --git a/src/lib/libssl/man/SSL_SESSION_get_id.3 b/src/lib/libssl/man/SSL_SESSION_get_id.3
index 795effb948..7d2549e234 100644
--- a/src/lib/libssl/man/SSL_SESSION_get_id.3
+++ b/src/lib/libssl/man/SSL_SESSION_get_id.3
@@ -1,8 +1,10 @@
-.\"     $OpenBSD: SSL_SESSION_get_id.3,v 1.3 2018/03/17 18:19:49 schwarze Exp $
-.\"     OpenSSL SSL_SESSION_set1_id.pod b31db505 Mar 24 16:01:50 2017 +0000
+.\" $OpenBSD: SSL_SESSION_get_id.3,v 1.4 2018/03/20 16:37:00 schwarze Exp $
+.\" full merge up to:
+.\" OpenSSL SSL_SESSION_set1_id 17b60280 Dec 21 09:08:25 2017 +0100
 .\"
-.\" This file was written by Matt Caswell <matt@openssl.org>
-.\" Copyright (c) 2017 The OpenSSL Project.  All rights reserved.
+.\" This file was written by Remi Gacogne <rgacogne-github@coredump.fr>
+.\" and Matt Caswell <matt@openssl.org>.
+.\" Copyright (c) 2016, 2017 The OpenSSL Project.  All rights reserved.
 .\"
 .\" Redistribution and use in source and binary forms, with or without
 .\" modification, are permitted provided that the following conditions
@@ -48,12 +50,13 @@
 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
 .\" OF THE POSSIBILITY OF SUCH DAMAGE.
 .\"
-.Dd $Mdocdate: March 17 2018 $
+.Dd $Mdocdate: March 20 2018 $
 .Dt SSL_SESSION_GET_ID 3
 .Os
 .Sh NAME
-.Nm SSL_SESSION_get_id
-.Nd get the SSL session ID
+.Nm SSL_SESSION_get_id ,
+.Nm SSL_SESSION_set1_id
+.Nd get and set the SSL session ID
 .Sh SYNOPSIS
 .In openssl/ssl.h
 .Ft const unsigned char *
@@ -61,14 +64,36 @@
 .Fa "const SSL_SESSION *s"
 .Fa "unsigned int *len"
 .Fc
+.Ft int
+.Fo SSL_SESSION_set1_id
+.Fa "SSL_SESSION *s"
+.Fa "const unsigned char *sid"
+.Fa "unsigned int sid_len"
+.Fc
 .Sh DESCRIPTION
 .Fn SSL_SESSION_get_id
-returns a pointer to the internal session id value for the session
+returns a pointer to the internal session ID value for the session
 .Fa s .
-The length of the id in bytes is stored in
+The length of the ID in bytes is stored in
 .Pf * Fa len .
 The length may be 0.
 The caller should not free the returned pointer directly.
+.Pp
+.Fn SSL_SESSION_set1_id
+sets the session ID for
+.Fa s
+to a copy of the
+.Fa sid
+of length
+.Fa sid_len .
+.Sh RETURN VALUES
+.Fn SSL_SESSION_get_id
+returns a pointer to the session ID value.
+.Pp
+.Fn SSL_SESSION_set1_id
+returns 1 for success and 0 for failure,
+for example if the supplied session ID length exceeds
+.Dv SSL_MAX_SSL_SESSION_ID_LENGTH .
 .Sh SEE ALSO
 .Xr ssl 3 ,
 .Xr SSL_copy_session_id 3 ,
@@ -77,3 +102,6 @@ The caller should not free the returned pointer directly.
 .Xr SSL_SESSION_get_protocol_version 3 ,
 .Xr SSL_SESSION_has_ticket 3 ,
 .Xr SSL_SESSION_new 3
+.Sh HISTORY
+.Fn SSL_SESSION_set1_id
+first appeared in OpenSSL 1.1.0.