Blame doc/man3/SSL_CTX_set_min_proto_version.pod

Packit c4476c
=pod
Packit c4476c
Packit c4476c
=head1 NAME
Packit c4476c
Packit c4476c
SSL_CTX_set_min_proto_version, SSL_CTX_set_max_proto_version,
Packit c4476c
SSL_CTX_get_min_proto_version, SSL_CTX_get_max_proto_version,
Packit c4476c
SSL_set_min_proto_version, SSL_set_max_proto_version,
Packit c4476c
SSL_get_min_proto_version, SSL_get_max_proto_version - Get and set minimum
Packit c4476c
and maximum supported protocol version
Packit c4476c
Packit c4476c
=head1 SYNOPSIS
Packit c4476c
Packit c4476c
 #include <openssl/ssl.h>
Packit c4476c
Packit c4476c
 int SSL_CTX_set_min_proto_version(SSL_CTX *ctx, int version);
Packit c4476c
 int SSL_CTX_set_max_proto_version(SSL_CTX *ctx, int version);
Packit c4476c
 int SSL_CTX_get_min_proto_version(SSL_CTX *ctx);
Packit c4476c
 int SSL_CTX_get_max_proto_version(SSL_CTX *ctx);
Packit c4476c
Packit c4476c
 int SSL_set_min_proto_version(SSL *ssl, int version);
Packit c4476c
 int SSL_set_max_proto_version(SSL *ssl, int version);
Packit c4476c
 int SSL_get_min_proto_version(SSL *ssl);
Packit c4476c
 int SSL_get_max_proto_version(SSL *ssl);
Packit c4476c
Packit c4476c
=head1 DESCRIPTION
Packit c4476c
Packit c4476c
The functions get or set the minimum and maximum supported protocol versions
Packit c4476c
for the B<ctx> or B<ssl>.
Packit c4476c
This works in combination with the options set via
Packit c4476c
L<SSL_CTX_set_options(3)> that also make it possible to disable
Packit c4476c
specific protocol versions.
Packit c4476c
Use these functions instead of disabling specific protocol versions.
Packit c4476c
Packit c4476c
Setting the minimum or maximum version to 0, will enable protocol
Packit c4476c
versions down to the lowest version, or up to the highest version
Packit c4476c
supported by the library, respectively.
Packit c4476c
Packit c4476c
Getters return 0 in case B<ctx> or B<ssl> have been configured to
Packit c4476c
automatically use the lowest or highest version supported by the library.
Packit c4476c
Packit c4476c
Currently supported versions are B<SSL3_VERSION>, B<TLS1_VERSION>,
Packit c4476c
B<TLS1_1_VERSION>, B<TLS1_2_VERSION>, B<TLS1_3_VERSION> for TLS and
Packit c4476c
B<DTLS1_VERSION>, B<DTLS1_2_VERSION> for DTLS.
Packit c4476c
Packit c4476c
=head1 RETURN VALUES
Packit c4476c
Packit c4476c
These setter functions return 1 on success and 0 on failure. The getter
Packit c4476c
functions return the configured version or 0 for auto-configuration of
Packit c4476c
lowest or highest protocol, respectively.
Packit c4476c
Packit c4476c
=head1 NOTES
Packit c4476c
Packit c4476c
All these functions are implemented using macros.
Packit c4476c
Packit c4476c
=head1 SEE ALSO
Packit c4476c
Packit c4476c
L<SSL_CTX_set_options(3)>, L<SSL_CONF_cmd(3)>
Packit c4476c
Packit c4476c
=head1 HISTORY
Packit c4476c
Packit c4476c
The setter functions were added in OpenSSL 1.1.0. The getter functions
Packit c4476c
were added in OpenSSL 1.1.1.
Packit c4476c
Packit c4476c
=head1 COPYRIGHT
Packit c4476c
Packit c4476c
Copyright 2016-2019 The OpenSSL Project Authors. All Rights Reserved.
Packit c4476c
Packit c4476c
Licensed under the OpenSSL license (the "License").  You may not use
Packit c4476c
this file except in compliance with the License.  You can obtain a copy
Packit c4476c
in the file LICENSE in the source distribution or at
Packit c4476c
L<https://www.openssl.org/source/license.html>.
Packit c4476c
Packit c4476c
=cut