1.\" $OpenBSD: SSL_set_session.3,v 1.4 2018/03/27 17:35:50 schwarze Exp $ 2.\" OpenSSL 05ea606a May 20 20:52:46 2016 -0400 3.\" 4.\" This file was written by Lutz Jaenicke <jaenicke@openssl.org>. 5.\" Copyright (c) 2000, 2001, 2016 The OpenSSL Project. All rights reserved. 6.\" 7.\" Redistribution and use in source and binary forms, with or without 8.\" modification, are permitted provided that the following conditions 9.\" are met: 10.\" 11.\" 1. Redistributions of source code must retain the above copyright 12.\" notice, this list of conditions and the following disclaimer. 13.\" 14.\" 2. Redistributions in binary form must reproduce the above copyright 15.\" notice, this list of conditions and the following disclaimer in 16.\" the documentation and/or other materials provided with the 17.\" distribution. 18.\" 19.\" 3. All advertising materials mentioning features or use of this 20.\" software must display the following acknowledgment: 21.\" "This product includes software developed by the OpenSSL Project 22.\" for use in the OpenSSL Toolkit. (http://www.openssl.org/)" 23.\" 24.\" 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to 25.\" endorse or promote products derived from this software without 26.\" prior written permission. For written permission, please contact 27.\" openssl-core@openssl.org. 28.\" 29.\" 5. Products derived from this software may not be called "OpenSSL" 30.\" nor may "OpenSSL" appear in their names without prior written 31.\" permission of the OpenSSL Project. 32.\" 33.\" 6. Redistributions of any form whatsoever must retain the following 34.\" acknowledgment: 35.\" "This product includes software developed by the OpenSSL Project 36.\" for use in the OpenSSL Toolkit (http://www.openssl.org/)" 37.\" 38.\" THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY 39.\" EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 40.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 41.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR 42.\" ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 43.\" SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 44.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 45.\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 46.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 47.\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 48.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED 49.\" OF THE POSSIBILITY OF SUCH DAMAGE. 50.\" 51.Dd $Mdocdate: March 27 2018 $ 52.Dt SSL_SET_SESSION 3 53.Os 54.Sh NAME 55.Nm SSL_set_session 56.Nd set a TLS/SSL session to be used during TLS/SSL connect 57.Sh SYNOPSIS 58.In openssl/ssl.h 59.Ft int 60.Fn SSL_set_session "SSL *ssl" "SSL_SESSION *session" 61.Sh DESCRIPTION 62.Fn SSL_set_session 63sets 64.Fa session 65to be used when the TLS/SSL connection is to be established. 66.Fn SSL_set_session 67is only useful for TLS/SSL clients. 68When the session is set, the reference count of 69.Fa session 70is incremented 71by 1. 72If the session is not reused, the reference count is decremented again during 73.Fn SSL_connect . 74Whether the session was reused can be queried with the 75.Xr SSL_session_reused 3 76call. 77.Pp 78If there is already a session set inside 79.Fa ssl 80(because it was set with 81.Fn SSL_set_session 82before or because the same 83.Fa ssl 84was already used for a connection), 85.Xr SSL_SESSION_free 3 86will be called for that session. 87.Pp 88.Vt SSL_SESSION 89objects keep internal link information about the session cache list when being 90inserted into one 91.Vt SSL_CTX 92object's session cache. 93One 94.Vt SSL_SESSION 95object, regardless of its reference count, must therefore only be used with one 96.Vt SSL_CTX 97object (and the 98.Vt SSL 99objects created from this 100.Vt SSL_CTX 101object). 102.Sh RETURN VALUES 103The following return values can occur: 104.Bl -tag -width Ds 105.It 0 106The operation failed; check the error stack to find out the reason. 107.It 1 108The operation succeeded. 109.El 110.Sh SEE ALSO 111.Xr ssl 3 , 112.Xr SSL_CTX_set_session_cache_mode 3 , 113.Xr SSL_get_session 3 , 114.Xr SSL_SESSION_free 3 , 115.Xr SSL_session_reused 3 116.Sh HISTORY 117.Fn SSL_set_session 118first appeared in SSLeay 0.5.2 and has been available since 119.Ox 2.4 . 120