1.\" $OpenBSD: SSL_SESSION_set1_id_context.3,v 1.4 2018/03/24 00:55:37 schwarze Exp $ 2.\" full merge up to: 3.\" OpenSSL SSL_SESSION_get0_id_context b31db505 Mar 24 16:01:50 2017 4.\" 5.\" This file was written by Matt Caswell <matt@openssl.org> 6.\" Copyright (c) 2017 The OpenSSL Project. All rights reserved. 7.\" 8.\" Redistribution and use in source and binary forms, with or without 9.\" modification, are permitted provided that the following conditions 10.\" are met: 11.\" 12.\" 1. Redistributions of source code must retain the above copyright 13.\" notice, this list of conditions and the following disclaimer. 14.\" 15.\" 2. Redistributions in binary form must reproduce the above copyright 16.\" notice, this list of conditions and the following disclaimer in 17.\" the documentation and/or other materials provided with the 18.\" distribution. 19.\" 20.\" 3. All advertising materials mentioning features or use of this 21.\" software must display the following acknowledgment: 22.\" "This product includes software developed by the OpenSSL Project 23.\" for use in the OpenSSL Toolkit. (http://www.openssl.org/)" 24.\" 25.\" 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to 26.\" endorse or promote products derived from this software without 27.\" prior written permission. For written permission, please contact 28.\" openssl-core@openssl.org. 29.\" 30.\" 5. Products derived from this software may not be called "OpenSSL" 31.\" nor may "OpenSSL" appear in their names without prior written 32.\" permission of the OpenSSL Project. 33.\" 34.\" 6. Redistributions of any form whatsoever must retain the following 35.\" acknowledgment: 36.\" "This product includes software developed by the OpenSSL Project 37.\" for use in the OpenSSL Toolkit (http://www.openssl.org/)" 38.\" 39.\" THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY 40.\" EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 41.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 42.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR 43.\" ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 44.\" SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 45.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 46.\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 47.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 48.\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 49.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED 50.\" OF THE POSSIBILITY OF SUCH DAMAGE. 51.\" 52.Dd $Mdocdate: March 24 2018 $ 53.Dt SSL_SESSION_SET1_ID_CONTEXT 3 54.Os 55.Sh NAME 56.Nm SSL_SESSION_get0_id_context , 57.Nm SSL_SESSION_set1_id_context 58.Nd get and set the SSL ID context associated with a session 59.Sh SYNOPSIS 60.In openssl/ssl.h 61.Ft const unsigned char * 62.Fo SSL_SESSION_get0_id_context 63.Fa "const SSL_SESSION *s" 64.Fa "unsigned int *len" 65.Fc 66.Ft int 67.Fo SSL_SESSION_set1_id_context 68.Fa "SSL_SESSION *s" 69.Fa "const unsigned char *sid_ctx" 70.Fa "unsigned int sid_ctx_len" 71.Fc 72.Sh DESCRIPTION 73.Fn SSL_SESSION_get0_id_context 74returns the ID context associated with 75.Fa s . 76The length of the ID context in bytes is written to 77.Pf * Fa len 78if 79.Fa len 80is not 81.Dv NULL . 82.Pp 83.Fn SSL_SESSION_set1_id_context 84takes a copy of the provided ID context given in 85.Fa sid_ctx 86and associates it with the session 87.Fa s . 88The length of the ID context is given by 89.Fa sid_ctx_len 90which must not exceed 91.Dv SSL_MAX_SID_CTX_LENGTH 92bytes. 93.Sh RETURN VALUES 94.Fn SSL_SESSION_get0_id_context 95returns an internal pointer to an object maintained within 96.Fa s 97that should not be freed by the caller. 98.Pp 99.Fn SSL_SESSION_set1_id_context 100returns 1 on success or 0 on error. 101.Sh SEE ALSO 102.Xr ssl 3 , 103.Xr SSL_CTX_set_session_id_context 3 , 104.Xr SSL_get_session 3 , 105.Xr SSL_SESSION_new 3 106.Sh HISTORY 107.Fn SSL_SESSION_set1_id_context 108first appeared in OpenSSL 1.0.1 and has been available since 109.Ox 5.3 . 110.Pp 111.Fn SSL_SESSION_get0_id_context 112first appeared in OpenSSL 1.1.0 and has been available since 113.Ox 6.3 . 114