Dependencies: Permit installation with urllib3 2.0

amotl · amotl · commit c276159bb1d6 · 2023-09-13T04:51:17.000-07:00
diff --git a/CHANGES.txt b/CHANGES.txt
@@ -7,6 +7,15 @@ Unreleased
 
 - Properly handle Python-native UUID types in SQL parameters
 - SQLAlchemy: Fix handling URL parameters ``timeout`` and ``pool_size``
+- Permit installation with urllib3 v2, see also `urllib3 v2.0 roadmap`_
+  and `urllib3 v2.0 migration guide`_. You can optionally retain support
+  for TLS 1.0 and TLS 1.1, but a few other outdated use-cases of X.509
+  certificate details are immanent, like no longer accepting the long
+  deprecated ``commonName`` attribute. Instead, going forward, only the
+  ``subjectAltName`` attribute will be used.
+
+.. _urllib3 v2.0 migration guide: https://urllib3.readthedocs.io/en/latest/v2-migration-guide.html
+.. _urllib3 v2.0 roadmap: https://urllib3.readthedocs.io/en/stable/v2-roadmap.html
 
 
 2023/07/17 0.33.0
diff --git a/docs/by-example/https.rst b/docs/by-example/https.rst
@@ -110,3 +110,18 @@ The connection will also fail when providing an invalid CA certificate:
     Traceback (most recent call last):
     ...
     crate.client.exceptions.ConnectionError: Server not available, exception: HTTPSConnectionPool...
+
+
+Relaxing minimum SSL version
+============================
+
+urrlib3 v2 dropped support for TLS 1.0 and TLS 1.1 by default, see `Modern security by default -
+HTTPS requires TLS 1.2+`_. If you need to re-enable it, use the ``ssl_relax_minimum_version`` flag,
+which will configure ``kwargs["ssl_minimum_version"] = ssl.TLSVersion.MINIMUM_SUPPORTED``.
+
+    >>> client = HttpClient([crate_host], ssl_relax_minimum_version=True, verify_ssl_cert=False)
+    >>> client.server_infos(crate_host)
+    ('https://localhost:65534', 'test', '0.0.0')
+
+
+.. _Modern security by default - HTTPS requires TLS 1.2+: https://urllib3.readthedocs.io/en/latest/v2-migration-guide.html#https-requires-tls-1-2
diff --git a/docs/connect.rst b/docs/connect.rst
@@ -139,6 +139,16 @@ Here, replace ``<CERT_FILE>`` with the path to the client certificate file, and
     verification. In such circumstances, you can combine the two methods above
     to do both at once.
 
+Relaxing minimum SSL version
+............................
+
+urrlib3 v2 dropped support for TLS 1.0 and TLS 1.1 by default, see `Modern security by default -
+HTTPS requires TLS 1.2+`_. If you need to re-enable it, use the ``ssl_relax_minimum_version`` flag,
+which will configure ``kwargs["ssl_minimum_version"] = ssl.TLSVersion.MINIMUM_SUPPORTED``.
+
+    >>> connection = client.connect(..., ssl_relax_minimum_version=True)
+
+
 Timeout
 -------
 
@@ -268,6 +278,7 @@ Once you're connected, you can :ref:`query CrateDB <query>`.
 
 
 .. _client-side random load balancing: https://en.wikipedia.org/wiki/Load_balancing_(computing)#Client-side_random_load_balancing
+.. _Modern security by default - HTTPS requires TLS 1.2+: https://urllib3.readthedocs.io/en/latest/v2-migration-guide.html#https-requires-tls-1-2
 .. _Python Database API Specification v2.0: https://www.python.org/dev/peps/pep-0249/
 .. _round-robin DNS: https://en.wikipedia.org/wiki/Round-robin_DNS
 .. _sample application: https://github.com/crate/crate-sample-apps/tree/main/python-flask
diff --git a/setup.py b/setup.py
@@ -58,7 +58,7 @@ def read(path):
             'crate = crate.client.sqlalchemy:CrateDialect'
         ]
     },
-    install_requires=['urllib3>=1.9,<2'],
+    install_requires=['urllib3<2.1'],
     extras_require=dict(
         sqlalchemy=['sqlalchemy>=1.0,<2.1',
                     'geojson>=2.5.0,<4',
diff --git a/src/crate/client/connection.py b/src/crate/client/connection.py
@@ -38,6 +38,7 @@ def __init__(self,
                  error_trace=False,
                  cert_file=None,
                  key_file=None,
+                 ssl_relax_minimum_version=False,
                  username=None,
                  password=None,
                  schema=None,
@@ -138,6 +139,7 @@ def __init__(self,
                                  error_trace=error_trace,
                                  cert_file=cert_file,
                                  key_file=key_file,
+                                 ssl_relax_minimum_version=ssl_relax_minimum_version,
                                  username=username,
                                  password=password,
                                  schema=schema,
diff --git a/src/crate/client/http.py b/src/crate/client/http.py
@@ -37,6 +37,7 @@
 from decimal import Decimal
 from uuid import UUID
 
+import urllib3
 from urllib3 import connection_from_url
 from urllib3.connection import HTTPConnection
 from urllib3.exceptions import (
@@ -48,6 +49,8 @@
     SSLError,
 )
 from urllib3.util.retry import Retry
+
+from crate.client._pep440 import Version
 from crate.client.exceptions import (
     ConnectionError,
     BlobLocationNotFoundException,
@@ -274,6 +277,19 @@ def _remove_certs_for_non_https(server, kwargs):
     return kwargs
 
 
+def _update_pool_kwargs_for_ssl_minimum_version(server, kwargs):
+    """
+    On urllib3 v2, re-add support for TLS 1.0 and TLS 1.1.
+
+    https://urllib3.readthedocs.io/en/latest/v2-migration-guide.html#https-requires-tls-1-2
+    """
+    if Version(urllib3.__version__) >= Version("2"):
+        from urllib3.util import parse_url
+        scheme, _, host, port, *_ = parse_url(server)
+        if scheme == "https":
+            kwargs["ssl_minimum_version"] = ssl.TLSVersion.MINIMUM_SUPPORTED
+
+
 def _create_sql_payload(stmt, args, bulk_args):
     if not isinstance(stmt, str):
         raise ValueError('stmt is not a string')
@@ -304,7 +320,7 @@ def _get_socket_opts(keepalive=True,
     # always use TCP keepalive
     opts = [(socket.SOL_SOCKET, socket.SO_KEEPALIVE, 1)]
 
-    # hasattr check because some of the options depend on system capabilities
+    # hasattr check because some options depend on system capabilities
     # see https://docs.python.org/3/library/socket.html#socket.SOMAXCONN
     if hasattr(socket, 'TCP_KEEPIDLE') and tcp_keepidle is not None:
         opts.append((socket.IPPROTO_TCP, socket.TCP_KEEPIDLE, tcp_keepidle))
@@ -340,6 +356,7 @@ def __init__(self,
                  error_trace=False,
                  cert_file=None,
                  key_file=None,
+                 ssl_relax_minimum_version=False,
                  username=None,
                  password=None,
                  schema=None,
@@ -380,6 +397,7 @@ def __init__(self,
             'socket_tcp_keepintvl': socket_tcp_keepintvl,
             'socket_tcp_keepcnt': socket_tcp_keepcnt,
         })
+        self.ssl_relax_minimum_version = ssl_relax_minimum_version
         self.backoff_factor = backoff_factor
         self.server_pool = {}
         self._update_server_pool(servers, **pool_kw)
@@ -400,6 +418,10 @@ def close(self):
 
     def _create_server(self, server, **pool_kw):
         kwargs = _remove_certs_for_non_https(server, pool_kw)
+        # After updating to urllib3 v2, optionally retain support for TLS 1.0 and TLS 1.1,
+        # in order to support connectivity to older versions of CrateDB.
+        if self.ssl_relax_minimum_version:
+            _update_pool_kwargs_for_ssl_minimum_version(server, kwargs)
         self.server_pool[server] = Server(server, **kwargs)
 
     def _update_server_pool(self, servers, **pool_kw):

Original file line number	Diff line number	Diff line change
`@@ -58,7 +58,7 @@ def read(path):`
`58`	`58`	`'crate = crate.client.sqlalchemy:CrateDialect'`
`59`	`59`	`]`
`60`	`60`	`},`
`61`		`- install_requires=['urllib3>=1.9,<2'],`
	`61`	`+ install_requires=['urllib3<2.1'],`
`62`	`62`	`extras_require=dict(`
`63`	`63`	`sqlalchemy=['sqlalchemy>=1.0,<2.1',`
`64`	`64`	`'geojson>=2.5.0,<4',`