SSL_CTX_set_min_proto_version.pod 2.3 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273
  1. =pod
  2. =head1 NAME
  3. SSL_CTX_set_min_proto_version, SSL_CTX_set_max_proto_version,
  4. SSL_CTX_get_min_proto_version, SSL_CTX_get_max_proto_version,
  5. SSL_set_min_proto_version, SSL_set_max_proto_version,
  6. SSL_get_min_proto_version, SSL_get_max_proto_version - Get and set minimum
  7. and maximum supported protocol version
  8. =head1 SYNOPSIS
  9. #include <openssl/ssl.h>
  10. int SSL_CTX_set_min_proto_version(SSL_CTX *ctx, int version);
  11. int SSL_CTX_set_max_proto_version(SSL_CTX *ctx, int version);
  12. int SSL_CTX_get_min_proto_version(SSL_CTX *ctx);
  13. int SSL_CTX_get_max_proto_version(SSL_CTX *ctx);
  14. int SSL_set_min_proto_version(SSL *ssl, int version);
  15. int SSL_set_max_proto_version(SSL *ssl, int version);
  16. int SSL_get_min_proto_version(SSL *ssl);
  17. int SSL_get_max_proto_version(SSL *ssl);
  18. =head1 DESCRIPTION
  19. The functions get or set the minimum and maximum supported protocol versions
  20. for the B<ctx> or B<ssl>.
  21. This works in combination with the options set via
  22. L<SSL_CTX_set_options(3)> that also make it possible to disable
  23. specific protocol versions.
  24. Use these functions instead of disabling specific protocol versions.
  25. Setting the minimum or maximum version to 0, will enable protocol
  26. versions down to the lowest version, or up to the highest version
  27. supported by the library, respectively.
  28. Getters return 0 in case B<ctx> or B<ssl> have been configured to
  29. automatically use the lowest or highest version supported by the library.
  30. Currently supported versions are B<SSL3_VERSION>, B<TLS1_VERSION>,
  31. B<TLS1_1_VERSION>, B<TLS1_2_VERSION>, B<TLS1_3_VERSION> for TLS and
  32. B<DTLS1_VERSION>, B<DTLS1_2_VERSION> for DTLS.
  33. =head1 RETURN VALUES
  34. These setter functions return 1 on success and 0 on failure. The getter
  35. functions return the configured version or 0 for auto-configuration of
  36. lowest or highest protocol, respectively.
  37. =head1 NOTES
  38. All these functions are implemented using macros.
  39. =head1 HISTORY
  40. The setter functions were added in OpenSSL 1.1.0. The getter functions
  41. were added in OpenSSL 1.1.1.
  42. =head1 SEE ALSO
  43. L<SSL_CTX_set_options(3)>, L<SSL_CONF_cmd(3)>
  44. =head1 COPYRIGHT
  45. Copyright 2016 The OpenSSL Project Authors. All Rights Reserved.
  46. Licensed under the OpenSSL license (the "License"). You may not use
  47. this file except in compliance with the License. You can obtain a copy
  48. in the file LICENSE in the source distribution or at
  49. L<https://www.openssl.org/source/license.html>.
  50. =cut