projects / thirdparty / openssl.git / blame
| Commit | Line | Data |
|---|---|---|
| 7946ab33 KR |
1 | =pod |
| 2 | ||
| 3 | =head1 NAME | |
| 4 | ||
| 57ce7b61 VD |
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 | |
| 7946ab33 KR |
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 | ||
| 24c2cd39 | 20 | The functions set the minimum and maximum supported protocol versions |
| 57ce7b61 | 21 | for the B<ctx> or B<ssl>. |
| 8106cb8b VD |
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. | |
| 57ce7b61 | 25 | Use these functions instead of disabling specific protocol versions. |
| 7946ab33 | 26 | |
| 57ce7b61 VD |
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. | |
| 7946ab33 | 30 | |
| 57ce7b61 VD |
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. | |
| 7946ab33 KR |
34 | |
| 35 | =head1 RETURN VALUES | |
| 36 | ||
| 57ce7b61 | 37 | Both functions return 1 on success and 0 on failure. |
| 7946ab33 KR |
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 | =cut | |
| e2f92610 RS |
52 | |
| 53 | =head1 COPYRIGHT | |
| 54 | ||
| 55 | Copyright 2016 The OpenSSL Project Authors. All Rights Reserved. | |
| 56 | ||
| 57 | Licensed under the OpenSSL license (the "License"). You may not use | |
| 58 | this file except in compliance with the License. You can obtain a copy | |
| 59 | in the file LICENSE in the source distribution or at | |
| 60 | L<https://www.openssl.org/source/license.html>. | |
| 61 | ||
| 62 | =cut |