summaryrefslogtreecommitdiff
path: root/src/lib/libssl/src/doc/ssl/SSL_CTX_new.pod
diff options
context:
space:
mode:
Diffstat (limited to 'src/lib/libssl/src/doc/ssl/SSL_CTX_new.pod')
-rw-r--r--src/lib/libssl/src/doc/ssl/SSL_CTX_new.pod93
1 files changed, 0 insertions, 93 deletions
diff --git a/src/lib/libssl/src/doc/ssl/SSL_CTX_new.pod b/src/lib/libssl/src/doc/ssl/SSL_CTX_new.pod
deleted file mode 100644
index 023be38c0a..0000000000
--- a/src/lib/libssl/src/doc/ssl/SSL_CTX_new.pod
+++ /dev/null
@@ -1,93 +0,0 @@
1=pod
2
3=head1 NAME
4
5SSL_CTX_new, SSLv3_method, SSLv3_server_method, SSLv3_client_method,
6TLSv1_method, TLSv1_server_method, TLSv1_client_method,
7TLSv1_1_method, TLSv1_1_server_method, TLSv1_1_client_method, SSLv23_method,
8SSLv23_server_method, SSLv23_client_method - create a new SSL_CTX object as framework for TLS/SSL enabled functions
9
10=head1 SYNOPSIS
11
12 #include <openssl/ssl.h>
13
14 SSL_CTX *SSL_CTX_new(const SSL_METHOD *method);
15
16=head1 DESCRIPTION
17
18SSL_CTX_new() creates a new B<SSL_CTX> object as framework to establish
19TLS/SSL enabled connections.
20
21=head1 NOTES
22
23The SSL_CTX object uses B<method> as connection method. The methods exist
24in a generic type (for client and server use), a server only type, and a
25client only type. B<method> can be of the following types:
26
27=over 4
28
29=item SSLv3_method(void), SSLv3_server_method(void), SSLv3_client_method(void)
30
31A TLS/SSL connection established with these methods will only understand the
32SSLv3 protocol. A client will send out SSLv3 client hello messages
33and will indicate that it only understands SSLv3. A server will only understand
34SSLv3 client hello messages. This especially means, that it will
35not understand SSLv2 client hello messages which are widely used for
36compatibility reasons, see SSLv23_*_method().
37
38=item TLSv1_method(void), TLSv1_server_method(void), TLSv1_client_method(void)
39
40A TLS/SSL connection established with these methods will only understand the
41TLSv1 protocol. A client will send out TLSv1 client hello messages
42and will indicate that it only understands TLSv1. A server will only understand
43TLSv1 client hello messages. This especially means, that it will
44not understand SSLv2 client hello messages which are widely used for
45compatibility reasons, see SSLv23_*_method(). It will also not understand
46SSLv3 client hello messages.
47
48=item SSLv23_method(void), SSLv23_server_method(void), SSLv23_client_method(void)
49
50A TLS/SSL connection established with these methods may understand the
51SSLv3, TLSv1, TLSv1.1 and TLSv1.2 protocols.
52
53A client will send out TLSv1 client hello messages including extensions and
54will indicate that it also understands TLSv1.1, TLSv1.2 and permits a
55fallback to SSLv3. A server will support SSLv3, TLSv1, TLSv1.1 and TLSv1.2
56protocols. This is the best choice when compatibility is a concern.
57
58=back
59
60The list of protocols available can later be limited using the
61SSL_OP_NO_SSLv3, SSL_OP_NO_TLSv1, SSL_OP_NO_TLSv1_1 and SSL_OP_NO_TLSv1_2
62options of the SSL_CTX_set_options() or SSL_set_options() functions.
63Using these options it is possible to choose e.g. SSLv23_server_method() and
64be able to negotiate with all possible clients, but to only allow newer
65protocols like TLSv1, TLSv1.1 or TLS v1.2.
66
67SSL_CTX_new() initializes the list of ciphers, the session cache setting,
68the callbacks, the keys and certificates and the options to its default
69values.
70
71=head1 RETURN VALUES
72
73The following return values can occur:
74
75=over 4
76
77=item NULL
78
79The creation of a new SSL_CTX object failed. Check the error stack to
80find out the reason.
81
82=item Pointer to an SSL_CTX object
83
84The return value points to an allocated SSL_CTX object.
85
86=back
87
88=head1 SEE ALSO
89
90L<SSL_CTX_free(3)|SSL_CTX_free(3)>, L<SSL_accept(3)|SSL_accept(3)>,
91L<ssl(3)|ssl(3)>, L<SSL_set_connect_state(3)|SSL_set_connect_state(3)>
92
93=cut