Add socks4,5 proxy support

changelogs/fragments/78142-add-socks5-proxy-support.yml

@@ -0,0 +1,3 @@
+---
+minor_changes:
+  - urls.py - Added support for socks4 and socks5 proxy

lib/ansible/module_utils/urls.py

@@ -823,7 +823,45 @@ class Request:
                     if username and password:
                         headers["Authorization"] = basic_auth_header(username, password)
 
-        if not use_proxy:
+        if use_proxy:
+            proxies = urllib.request.getproxies()
+            request_type = generic_urlparse(urlparse(url)).get('scheme')
+
+            # More specific proxy goes first
+            suitable_proxy = proxies.get(request_type) or proxies.get('all')
+            if suitable_proxy:
+                proxy_parts = generic_urlparse(urlparse(suitable_proxy))
+                proxy_hostname = proxy_parts.get('hostname', None)
+                proxy_scheme = proxy_parts.get('scheme', None)
+
+                if proxy_hostname is None or proxy_scheme is None:
+                    raise ProxyError(
+                        "Failed to parse proxy environment variable."
+                        " Please make sure you export proxy as '{http|https|all}_proxy=<SCHEME>://<IP_ADDRESS>:<PORT>'")
+
+                if proxy_scheme in ['socks4', 'socks4a', 'socks5', 'socks5h']:
+                    try:
+                        import socks
+                        from sockshandler import SocksiPyHandler
+                    except ImportError as ex:
+                        imp_err_msg = missing_required_lib('PySocks')
+                        raise MissingModuleError(imp_err_msg, import_traceback=traceback.format_exc()) from ex
+
+                    proxy_type = None
+                    if proxy_scheme.startswith('socks4'):
+                        proxy_type = socks.SOCKS4
+                    else:
+                        proxy_type = socks.SOCKS5
+
+                    proxy_rdns = False
+                    if proxy_scheme[-1] == 'h':
+                        proxy_rdns = True
+
+                    handlers.append(
+                        SocksiPyHandler(proxy_type, proxy_hostname, proxy_parts.get('port', 1080), rdns=proxy_rdns))
+                    proxyhandler = urllib.request.ProxyHandler({})
+                    handlers.append(proxyhandler)
+        else:
             proxyhandler = urllib.request.ProxyHandler({})
             handlers.append(proxyhandler)
 

test/lib/ansible_test/_util/controller/sanity/mypy/ansible-core.ini

@@ -117,3 +117,9 @@ ignore_missing_imports = True
 
 [mypy-jinja2.nativetypes]
 ignore_missing_imports = True
+
+[mypy-socks]
+ignore_missing_imports = True
+
+[mypy-sockshandler]
+ignore_missing_imports = True

test/lib/ansible_test/_util/controller/sanity/mypy/modules.ini

@@ -93,3 +93,9 @@ ignore_missing_imports = True
 
 [mypy-http.*]
 ignore_missing_imports = True
+
+[mypy-socks]
+ignore_missing_imports = True
+
+[mypy-sockshandler]
+ignore_missing_imports = True