diff options
author | Kurt Roeckx <kurt@roeckx.be> | 2015-12-06 17:56:41 +0100 |
---|---|---|
committer | Viktor Dukhovni <openssl-users@dukhovni.org> | 2016-01-02 10:47:52 -0500 |
commit | 7946ab33cecce60afcc00afc8fc18f31f9e66bff (patch) | |
tree | fa178fbc42a649e87e201820cc11796dc3c7d6de /doc/ssl/SSL_CTX_set_min_proto_version.pod | |
parent | 1e0784ff95cd69090e26e2205bfec6305038db56 (diff) |
Add support for minimum and maximum protocol version
Reviewed-by: Viktor Dukhovni <viktor@openssl.org>
Diffstat (limited to 'doc/ssl/SSL_CTX_set_min_proto_version.pod')
-rw-r--r-- | doc/ssl/SSL_CTX_set_min_proto_version.pod | 42 |
1 files changed, 42 insertions, 0 deletions
diff --git a/doc/ssl/SSL_CTX_set_min_proto_version.pod b/doc/ssl/SSL_CTX_set_min_proto_version.pod new file mode 100644 index 0000000000..4cb4c43a2d --- /dev/null +++ b/doc/ssl/SSL_CTX_set_min_proto_version.pod @@ -0,0 +1,42 @@ +=pod + +=head1 NAME + +SSL_CTX_set_min_proto_version, SSL_CTX_set_max_proto_version, SSL_set_min_proto_version, SSL_set_max_proto_version - Set minimum and maximum supported protocol version + +=head1 SYNOPSIS + + #include <openssl/ssl.h> + + int SSL_CTX_set_min_proto_version(SSL_CTX *ctx, int version); + int SSL_CTX_set_max_proto_version(SSL_CTX *ctx, int version); + int SSL_set_min_proto_version(SSL *ssl, int version); + int SSL_set_max_proto_version(SSL *ssl, int version); + +=head1 DESCRIPTION + +The functions set the minimum and maximum supported portocol versions for the B<ctx> or B<ssl>. +This works in combination with the options set via SSL_CTX_set_options() that allows to disable specific protocol versions. +You should use these functions instead of disabling a specific protocol version. + +When setting the minimum or maximum version to 0 it will use the lowest or highest supported version, respectively, by the library. + +Currently supported versions are B<SSL3_VERSION>, B<TLS1_VERSION>, B<TLS1_1_VERSION>, B<TLS1_2_VERSION>, B<DTLS1_VERSION> and B<DTLS1_2_VERSION>. + +=head1 RETURN VALUES + +The function returns 1 on success and 0 on failure. + +=head1 NOTES + +All these functions are implemented using macros. + +=head1 HISTORY + +The functions were added in OpenSSL 1.1.0 + +=head1 SEE ALSO + +L<SSL_CTX_set_options(3)>, L<SSL_CONF_cmd(3)> + +=cut |