xref: /freebsd/secure/lib/libcrypto/man/man3/SSL_CTX_set_min_proto_version.3 (revision d4033e6d37747f5213bb245c8e605406703a8766)
-*- mode: troff; coding: utf-8 -*-
Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)

Standard preamble:
========================================================================
..
..
.. \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
. ds C` "" . ds C' "" 'br\} . ds C` . ds C' 'br\}
Escape single quotes in literal strings from groff's Unicode transform.

If the F register is >0, we'll generate index entries on stderr for
titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
entries marked with X<> in POD. Of course, you'll have to process the
output yourself in some meaningful fashion.

Avoid warning from groff about undefined register 'F'.
.. .nr rF 0 . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF ========================================================================

Title "SSL_CTX_SET_MIN_PROTO_VERSION 3ossl"
SSL_CTX_SET_MIN_PROTO_VERSION 3ossl 2025-09-30 3.5.4 OpenSSL
For nroff, turn off justification. Always turn off hyphenation; it makes
way too many mistakes in technical documents.
NAME
SSL_CTX_set_min_proto_version, SSL_CTX_set_max_proto_version, SSL_CTX_get_min_proto_version, SSL_CTX_get_max_proto_version, SSL_set_min_proto_version, SSL_set_max_proto_version, SSL_get_min_proto_version, SSL_get_max_proto_version - Get and set minimum and maximum supported protocol version
SYNOPSIS
Header "SYNOPSIS" .Vb 1 #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_CTX_get_min_proto_version(SSL_CTX *ctx); int SSL_CTX_get_max_proto_version(SSL_CTX *ctx); \& int SSL_set_min_proto_version(SSL *ssl, int version); int SSL_set_max_proto_version(SSL *ssl, int version); int SSL_get_min_proto_version(SSL *ssl); int SSL_get_max_proto_version(SSL *ssl); .Ve
DESCRIPTION
Header "DESCRIPTION" The functions get or set the minimum and maximum supported protocol versions for the ctx or ssl. This works in combination with the options set via \fBSSL_CTX_set_options\|(3) that also make it possible to disable specific protocol versions. Use these functions instead of disabling specific protocol versions.

Setting the minimum or maximum version to 0 (default), will enable protocol versions down to the lowest version, or up to the highest version supported by the library, respectively. The supported versions might be controlled by system configuration.

Getters return 0 in case ctx or ssl have been configured to automatically use the lowest or highest version supported by the library.

Currently supported versions are SSL3_VERSION, TLS1_VERSION, \fBTLS1_1_VERSION, TLS1_2_VERSION, TLS1_3_VERSION for TLS and \fBDTLS1_VERSION, DTLS1_2_VERSION for DTLS.

In the current version of OpenSSL only QUICv1 is supported in conjunction with TLSv1.3. Calling these functions on a QUIC object has no effect.

"RETURN VALUES"
Header "RETURN VALUES" These setter functions return 1 on success and 0 on failure. The getter functions return the configured version or 0 for auto-configuration of lowest or highest protocol, respectively.
NOTES
Header "NOTES" All these functions are implemented using macros.
"SEE ALSO"
Header "SEE ALSO" \fBssl\|(7), \fBSSL_CTX_set_options\|(3), SSL_CONF_cmd\|(3)
HISTORY
Header "HISTORY" The setter functions were added in OpenSSL 1.1.0. The getter functions were added in OpenSSL 1.1.1.
COPYRIGHT
Header "COPYRIGHT" Copyright 2016-2025 The OpenSSL Project Authors. All Rights Reserved.

Licensed under the Apache License 2.0 (the "License"). You may not use this file except in compliance with the License. You can obtain a copy in the file LICENSE in the source distribution or at <https://www.openssl.org/source/license.html>.