Allow unverified SSL and additional HTTP headers

tcms_api/__init__.py

@@ -119,10 +119,17 @@
 
 
 class _ConnectionProxy:
-    def __init__(self, config):
+    def __init__(
+        self,
+        config,
+        allow_unverified_ssl: bool = False,
+        extra_headers: list[tuple[str, str]] = [],
+    ):
         self.__connected_since = datetime(2024, 1, 1, 0, 0)
         self.__connection = None
         self.__config = config
+        self.__allow_unverified_ssl = allow_unverified_ssl
+        self.__extra_headers = extra_headers
 
     @staticmethod
     def server_url(config):
@@ -169,6 +176,8 @@ def create_connection(self):
                     config["tcms"]["username"],
                     config["tcms"]["password"],
                     server_url,
+                    allow_unverified_ssl=self.__allow_unverified_ssl,
+                    extra_headers=self.__extra_headers,
                 )
             except KeyError as err:
                 raise RuntimeError(f"username/password required in '{path}'") from err
@@ -206,7 +215,14 @@ class TCMS:  # pylint: disable=too-few-public-methods
     parses user configuration using a utilities class!
     """
 
-    def __init__(self, url=None, username=None, password=None):
+    def __init__(
+        self,
+        url=None,
+        username=None,
+        password=None,
+        allow_unverified_ssl: bool = False,
+        extra_headers: list[tuple[str, str]] = [],
+    ):
         self.config = {
             "tcms": {
                 "url": url,
@@ -215,6 +231,9 @@ def __init__(self, url=None, username=None, password=None):
             }
         }
 
+        self.allow_unverified_ssl = allow_unverified_ssl
+        self.extra_headers = extra_headers
+
     @property
     def exec(self):
         """
@@ -230,4 +249,8 @@ def exec(self):
             Starting with tcms-api v12.9.1 this property is automatically refreshed
             every 4 minutes to avoid SSL connection timeout errors!
         """
-        return _ConnectionProxy(self.config)
+        return _ConnectionProxy(
+            config=self.config,
+            allow_unverified_ssl=self.allow_unverified_ssl,
+            extra_headers=self.extra_headers,
+        )

tcms_api/xmlrpc.py

@@ -1,6 +1,8 @@
 # pylint: disable=protected-access,too-few-public-methods
 
+import ssl
 import sys
+from typing import Optional
 import urllib.parse
 
 from base64 import b64encode
@@ -114,7 +116,14 @@ class TCMSXmlrpc:
     session_cookie_name = "sessionid"
     transport = None
 
-    def __init__(self, username, password, url):
+    def __init__(
+        self,
+        username,
+        password,
+        url,
+        allow_unverified_ssl: bool = False,
+        extra_headers: list[tuple[str, str]] = [],
+    ):
         if self.transport is None:
             if url.startswith("https://"):
                 self.transport = SafeCookieTransport()
@@ -123,6 +132,12 @@ def __init__(self, username, password, url):
             else:
                 raise RuntimeError("Unrecognized URL scheme")
 
+        if allow_unverified_ssl:
+            ssl._create_default_https_context = ssl._create_unverified_context
+
+        if len(extra_headers) > 0:
+            self.transport._headers += extra_headers
+
         self.server = TCMSProxy(
             url, transport=self.transport, verbose=VERBOSE, allow_none=1
         )