SSL_dup, SSL_new, SSL_up_ref - create an SSL structure for a connection
#include <openssl/ssl.h>
SSL *SSL_dup(SSL *s); SSL *SSL_new(SSL_CTX *ctx); int SSL_up_ref(SSL *s);
SSL_new()
creates a new SSL structure which is needed to hold the
data for a TLS/SSL connection. The new structure inherits the settings
of the underlying context ctx: connection method,
options, verification settings, timeout settings. An SSL structure is
reference counted. Creating an SSL structure for the first time increments
the reference count. Freeing it (using SSL_free) decrements it. When the
reference count drops to zero, any memory or resources allocated to the SSL
structure are freed.
SSL_up_ref()
increments the reference count for an
existing SSL structure.
The function SSL_dup()
creates and returns a new SSL structure from the same
SSL_CTX that was used to create s. It additionally duplicates a subset of
the settings in s into the new SSL object.
For SSL_dup()
to work, the connection MUST be in its initial state and
MUST NOT have yet started the SSL handshake. For connections that are not in
their initial state SSL_dup()
just increments an internal
reference count and returns the same handle. It may be possible to
use SSL_clear(3) to recycle an SSL handle that is not in its initial
state for reuse, but this is best avoided. Instead, save and restore
the session, if desired, and construct a fresh handle for each connection.
The subset of settings in s that are duplicated are:
The following return values can occur:
The creation of a new SSL structure failed. Check the error stack to find out the reason.
The return value points to an allocated SSL structure.
SSL_up_ref()
returns 1 for success and 0 for failure.
SSL_free(3), SSL_clear(3), SSL_CTX_set_options(3), SSL_get_SSL_CTX(3), ssl(7)
Copyright 2000-2023 The OpenSSL Project Authors. All Rights Reserved.
Licensed under the Apache License 2.0 (the "License"). You may not use this file except in compliance with the License. You can obtain a copy in the file LICENSE in the source distribution or at https://www.openssl.org/source/license.html.