| 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. All
|
|---|
| 30 | settings are inherited from the original B<SSL> structure. Dynamic data (i.e.
|
|---|
| 31 | existing connection details) are not copied, the new B<SSL> is set into an
|
|---|
| 32 | initial accept (server) or connect (client) state.
|
|---|
| 33 |
|
|---|
| 34 | =head1 RETURN VALUES
|
|---|
| 35 |
|
|---|
| 36 | The following return values can occur:
|
|---|
| 37 |
|
|---|
| 38 | =over 4
|
|---|
| 39 |
|
|---|
| 40 | =item NULL
|
|---|
| 41 |
|
|---|
| 42 | The creation of a new SSL structure failed. Check the error stack to
|
|---|
| 43 | find out the reason.
|
|---|
| 44 |
|
|---|
| 45 | =item Pointer to an SSL structure
|
|---|
| 46 |
|
|---|
| 47 | The return value points to an allocated SSL structure.
|
|---|
| 48 |
|
|---|
| 49 | SSL_up_ref() returns 1 for success and 0 for failure.
|
|---|
| 50 |
|
|---|
| 51 | =back
|
|---|
| 52 |
|
|---|
| 53 | =head1 SEE ALSO
|
|---|
| 54 |
|
|---|
| 55 | L<SSL_free(3)>, L<SSL_clear(3)>,
|
|---|
| 56 | L<SSL_CTX_set_options(3)>,
|
|---|
| 57 | L<SSL_get_SSL_CTX(3)>,
|
|---|
| 58 | L<ssl(7)>
|
|---|
| 59 |
|
|---|
| 60 | =head1 COPYRIGHT
|
|---|
| 61 |
|
|---|
| 62 | Copyright 2000-2017 The OpenSSL Project Authors. All Rights Reserved.
|
|---|
| 63 |
|
|---|
| 64 | Licensed under the OpenSSL license (the "License"). You may not use
|
|---|
| 65 | this file except in compliance with the License. You can obtain a copy
|
|---|
| 66 | in the file LICENSE in the source distribution or at
|
|---|
| 67 | L<https://www.openssl.org/source/license.html>.
|
|---|
| 68 |
|
|---|
| 69 | =cut
|
|---|
