xref: /minix3/crypto/external/bsd/openssl/dist/doc/ssl/SSL_new.pod (revision ebfedea0ce5bbe81e252ddf32d732e40fb633fae)
1*ebfedea0SLionel Sambuc=pod
2*ebfedea0SLionel Sambuc
3*ebfedea0SLionel Sambuc=head1 NAME
4*ebfedea0SLionel Sambuc
5*ebfedea0SLionel SambucSSL_new - create a new SSL structure for a connection
6*ebfedea0SLionel Sambuc
7*ebfedea0SLionel Sambuc=head1 SYNOPSIS
8*ebfedea0SLionel Sambuc
9*ebfedea0SLionel Sambuc #include <openssl/ssl.h>
10*ebfedea0SLionel Sambuc
11*ebfedea0SLionel Sambuc SSL *SSL_new(SSL_CTX *ctx);
12*ebfedea0SLionel Sambuc
13*ebfedea0SLionel Sambuc=head1 DESCRIPTION
14*ebfedea0SLionel Sambuc
15*ebfedea0SLionel SambucSSL_new() creates a new B<SSL> structure which is needed to hold the
16*ebfedea0SLionel Sambucdata for a TLS/SSL connection. The new structure inherits the settings
17*ebfedea0SLionel Sambucof the underlying context B<ctx>: connection method (SSLv2/v3/TLSv1),
18*ebfedea0SLionel Sambucoptions, verification settings, timeout settings.
19*ebfedea0SLionel Sambuc
20*ebfedea0SLionel Sambuc=head1 RETURN VALUES
21*ebfedea0SLionel Sambuc
22*ebfedea0SLionel SambucThe following return values can occur:
23*ebfedea0SLionel Sambuc
24*ebfedea0SLionel Sambuc=over 4
25*ebfedea0SLionel Sambuc
26*ebfedea0SLionel Sambuc=item NULL
27*ebfedea0SLionel Sambuc
28*ebfedea0SLionel SambucThe creation of a new SSL structure failed. Check the error stack to
29*ebfedea0SLionel Sambucfind out the reason.
30*ebfedea0SLionel Sambuc
31*ebfedea0SLionel Sambuc=item Pointer to an SSL structure
32*ebfedea0SLionel Sambuc
33*ebfedea0SLionel SambucThe return value points to an allocated SSL structure.
34*ebfedea0SLionel Sambuc
35*ebfedea0SLionel Sambuc=back
36*ebfedea0SLionel Sambuc
37*ebfedea0SLionel Sambuc=head1 SEE ALSO
38*ebfedea0SLionel Sambuc
39*ebfedea0SLionel SambucL<SSL_free(3)|SSL_free(3)>, L<SSL_clear(3)|SSL_clear(3)>,
40*ebfedea0SLionel SambucL<SSL_CTX_set_options(3)|SSL_CTX_set_options(3)>,
41*ebfedea0SLionel SambucL<SSL_get_SSL_CTX(3)|SSL_get_SSL_CTX(3)>,
42*ebfedea0SLionel SambucL<ssl(3)|ssl(3)>
43*ebfedea0SLionel Sambuc
44*ebfedea0SLionel Sambuc=cut
45