1.\" $OpenBSD: SSL_new.3,v 1.7 2022/07/13 22:05:53 schwarze Exp $ 2.\" full merge up to: OpenSSL 1c7ae3dd Mar 29 19:17:55 2017 +1000 3.\" 4.\" This file was written by Richard Levitte <levitte@openssl.org> 5.\" and Matt Caswell <matt@openssl.org>. 6.\" Copyright (c) 2000, 2016 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: July 13 2022 $ 53.Dt SSL_NEW 3 54.Os 55.Sh NAME 56.Nm SSL_new , 57.Nm SSL_up_ref 58.Nd create a new SSL structure for a connection 59.Sh SYNOPSIS 60.In openssl/ssl.h 61.Ft SSL * 62.Fn SSL_new "SSL_CTX *ctx" 63.Ft int 64.Fn SSL_up_ref "SSL *ssl" 65.Sh DESCRIPTION 66.Fn SSL_new 67creates a new 68.Vt SSL 69structure which is needed to hold the data for a TLS/SSL connection. 70The new structure inherits the settings of the underlying context 71.Fa ctx : 72connection method, options, verification settings, 73timeout settings, security level. 74The reference count of the new structure is set to 1. 75.Pp 76.Fn SSL_up_ref 77increments the reference count of 78.Fa ssl 79by 1. 80.Sh RETURN VALUES 81The following return values can occur: 82.Bl -tag -width Ds 83.It Dv NULL 84The creation of a new 85.Vt SSL 86structure failed. 87Check the error stack to find out the reason. 88.It Pointer to an Vt SSL No structure 89The return value points to an allocated 90.Vt SSL 91structure. 92.El 93.Pp 94.Fn SSL_up_ref 95returns 1 for success or 0 for failure. 96.Sh SEE ALSO 97.Xr ssl 3 , 98.Xr SSL_clear 3 , 99.Xr SSL_CTX_set_options 3 , 100.Xr SSL_CTX_set_security_level 3 , 101.Xr SSL_free 3 , 102.Xr SSL_get_SSL_CTX 3 103.Sh HISTORY 104.Fn SSL_new 105appeared in SSLeay 0.4 or earlier and has been available since 106.Ox 2.4 . 107.Pp 108.Fn SSL_up_ref 109first appeared in OpenSSL 1.1.0 and has been available since 110.Ox 6.3 . 111