.\" $OpenBSD: SSL_SESSION_get_id.3,v 1.6 2018/03/24 00:55:37 schwarze Exp $
.\" full merge up to:
.\" OpenSSL SSL_SESSION_set1_id 17b60280 Dec 21 09:08:25 2017 +0100
.\"
.\" 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
.\" are met:
.\"
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\"
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in
.\"    the documentation and/or other materials provided with the
.\"    distribution.
.\"
.\" 3. All advertising materials mentioning features or use of this
.\"    software must display the following acknowledgment:
.\"    "This product includes software developed by the OpenSSL Project
.\"    for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
.\"
.\" 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
.\"    endorse or promote products derived from this software without
.\"    prior written permission. For written permission, please contact
.\"    openssl-core@openssl.org.
.\"
.\" 5. Products derived from this software may not be called "OpenSSL"
.\"    nor may "OpenSSL" appear in their names without prior written
.\"    permission of the OpenSSL Project.
.\"
.\" 6. Redistributions of any form whatsoever must retain the following
.\"    acknowledgment:
.\"    "This product includes software developed by the OpenSSL Project
.\"    for use in the OpenSSL Toolkit (http://www.openssl.org/)"
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
.\" EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
.\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
.\" ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
.\" SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
.\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
.\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
.\" OF THE POSSIBILITY OF SUCH DAMAGE.
.\"
.Dd $Mdocdate: March 24 2018 $
.Dt SSL_SESSION_GET_ID 3
.Os
.Sh NAME
.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 *
.Fo SSL_SESSION_get_id
.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
.Fa s .
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 ,
.Xr SSL_get_session 3 ,
.Xr SSL_SESSION_get_compress_id 3 ,
.Xr SSL_SESSION_get_protocol_version 3 ,
.Xr SSL_SESSION_has_ticket 3 ,
.Xr SSL_SESSION_new 3
.Sh HISTORY
.Fn SSL_SESSION_get_id
first appeared in OpenSSL 0.9.8 and has been available since
.Ox 4.5 .
.Pp
.Fn SSL_SESSION_set1_id
first appeared in OpenSSL 1.1.0 and has been available since
.Ox 6.3 .