doc/man3/SSL_new.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 SSL_dup, SSL_new, SSL_up_ref - create an SSL structure for a connection
   6
   7 =head1 SYNOPSIS
   8
   9  #include <openssl/ssl.h>
  10
  11  SSL *SSL_dup(SSL *s);
  12  SSL *SSL_new(SSL_CTX *ctx);
  13  int SSL_up_ref(SSL *s);
  14
  15 =head1 DESCRIPTION
  16
  17 SSL_new() creates a new B<SSL> structure which is needed to hold the
  18 data for a TLS/SSL connection. The new structure inherits the settings
  19 of the underlying context B<ctx>: connection method,
  20 options, verification settings, timeout settings. An B<SSL> structure is
  21 reference counted. Creating an B<SSL> structure for the first time increments
  22 the reference count. Freeing it (using SSL_free) decrements it. When the
  23 reference count drops to zero, any memory or resources allocated to the B<SSL>
  24 structure are freed.
  25
  26 SSL_up_ref() increments the reference count for an
  27 existing B<SSL> structure.
  28
  29 SSL_dup() duplicates an existing B<SSL> structure into a new allocated one
  30 or just increments the reference count if the connection is active. All
  31 settings are inherited from the original B<SSL> structure. Dynamic data (i.e.
  32 existing connection details) are not copied, the new B<SSL> is set into an
  33 initial accept (server) or connect (client) state.
  34
  35 SSL_dup() allows applications to configure an SSL handle for use in multiple
  36 SSL connections, and then duplicate it prior to initiating each connection
  37 with the duplicated handle.  Use of SSL_dup() avoids the need to repeat
  38 the configuration of the handles for each connection.
  39
  40 For SSL_dup() to work, the connection MUST be in its initial state and
  41 MUST NOT have not yet have started the SSL handshake.  For connections
  42 that are not in their initial state SSL_dup() just increments an internal
  43 reference count and returns the I<same> handle.  It may be possible to
  44 use L<SSL_clear(3)> to recycle an SSL handle that is not in its initial
  45 state for re-use, but this is best avoided.  Instead, save and restore
  46 the session, if desired, and construct a fresh handle for each connection.
  47
  48 =head1 RETURN VALUES
  49
  50 The following return values can occur:
  51
  52 =over 4
  53
  54 =item NULL
  55
  56 The creation of a new SSL structure failed. Check the error stack to
  57 find out the reason.
  58
  59 =item Pointer to an SSL structure
  60
  61 The return value points to an allocated SSL structure.
  62
  63 SSL_up_ref() returns 1 for success and 0 for failure.
  64
  65 =back
  66
  67 =head1 SEE ALSO
  68
  69 L<SSL_free(3)>, L<SSL_clear(3)>,
  70 L<SSL_CTX_set_options(3)>,
  71 L<SSL_get_SSL_CTX(3)>,
  72 L<ssl(7)>
  73
  74 =head1 COPYRIGHT
  75
  76 Copyright 2000-2017 The OpenSSL Project Authors. All Rights Reserved.
  77
  78 Licensed under the Apache License 2.0 (the "License").  You may not use
  79 this file except in compliance with the License.  You can obtain a copy
  80 in the file LICENSE in the source distribution or at
  81 L<https://www.openssl.org/source/license.html>.
  82
  83 =cut