docs: add new openssl tls methods

pyca · Dec 21, 2020 · 740a1cf · 740a1cf
1 parent 5191827
commit 740a1cf
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 3 deletions.
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -16,6 +16,9 @@ Deprecations:
 Changes:
 ^^^^^^^^
 
+- Added ``OpenSSL.SSL.Context.set_min_proto_version`` and ``OpenSSL.SSL.Context.set_max_proto_version``
+  to set the minimum and maximum supported TLS version `#985 <https://github.com/pyca/pyopenssl/pull/985>`_.
+
 20.0.1 (2020-12-15)
 -------------------
 

diff --git a/doc/api/ssl.rst b/doc/api/ssl.rst
@@ -10,19 +10,32 @@
 This module handles things specific to SSL. There are two objects defined:
 Context, Connection.
 
-.. py:data:: SSLv2_METHOD
+.. py:data:: TLS_METHOD
+             TLS_SERVER_METHOD
+             TLS_CLIENT_METHOD
+             SSLv2_METHOD
              SSLv3_METHOD
              SSLv23_METHOD
              TLSv1_METHOD
              TLSv1_1_METHOD
              TLSv1_2_METHOD
 
     These constants represent the different SSL methods to use when creating a
-    context object.  If the underlying OpenSSL build is missing support for any
-    of these protocols, constructing a :py:class:`Context` using the
+    context object. New code should only use ``TLS_METHOD``, ``TLS_SERVER_METHOD``,
+    or ``TLS_CLIENT_METHOD``. If the underlying OpenSSL build is missing support
+    for any of these protocols, constructing a :py:class:`Context` using the
     corresponding :py:const:`*_METHOD` will raise an exception.
 
 
+.. py:data:: SSL3_VERSION
+             TLS1_VERSION
+             TLS1_1_VERSION
+             TLS1_2_VERSION
+             TLS1_3_VERSION
+
+    These constants represent the different TLS versions to use when
+    setting the minimum or maximum TLS version.
+
 .. py:data:: VERIFY_NONE
              VERIFY_PEER
              VERIFY_FAIL_IF_NO_PEER_CERT