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