Fix grammar error in SSL_CTX_set_min_proto_version
[openssl.git] / doc / ssl / SSL_CTX_set_min_proto_version.pod
1 =pod
2
3 =head1 NAME
4
5 SSL_CTX_set_min_proto_version, SSL_CTX_set_max_proto_version,
6 SSL_set_min_proto_version, SSL_set_max_proto_version - Set minimum
7 and maximum supported protocol version
8
9 =head1 SYNOPSIS
10
11  #include <openssl/ssl.h>
12
13  int SSL_CTX_set_min_proto_version(SSL_CTX *ctx, int version);
14  int SSL_CTX_set_max_proto_version(SSL_CTX *ctx, int version);
15  int SSL_set_min_proto_version(SSL *ssl, int version);
16  int SSL_set_max_proto_version(SSL *ssl, int version);
17
18 =head1 DESCRIPTION
19
20 The functions set the minimum and maximum supported protocol versions
21 for the B<ctx> or B<ssl>.
22 This works in combination with the options set via
23 L<SSL_CTX_set_options(3)> that also make it possible to disable
24 specific protocol versions.
25 Use these functions instead of disabling specific protocol versions.
26
27 Setting the minimum or maximum version to 0, will enable protocol
28 versions down to the lowest version, or up to the highest version
29 supported by the library, respectively.
30
31 Currently supported versions are B<SSL3_VERSION>, B<TLS1_VERSION>,
32 B<TLS1_1_VERSION>, B<TLS1_2_VERSION> for TLS and B<DTLS1_VERSION>,
33 B<DTLS1_2_VERSION> for DTLS.
34
35 =head1 RETURN VALUES
36
37 These functions return 1 on success and 0 on failure.
38
39 =head1 NOTES
40
41 All these functions are implemented using macros.
42
43 =head1 HISTORY
44
45 The functions were added in OpenSSL 1.1.0
46
47 =head1 SEE ALSO
48
49 L<SSL_CTX_set_options(3)>, L<SSL_CONF_cmd(3)>
50
51 =head1 COPYRIGHT
52
53 Copyright 2016 The OpenSSL Project Authors. All Rights Reserved.
54
55 Licensed under the OpenSSL license (the "License").  You may not use
56 this file except in compliance with the License.  You can obtain a copy
57 in the file LICENSE in the source distribution or at
58 L<https://www.openssl.org/source/license.html>.
59
60 =cut