feat: Make TLS/SSL certificate verification optional (#126)

Author: santhoshramaraj

examples/general/disable_cert_verify.py

@@ -0,0 +1,11 @@
+"""Example to demonstrate disabling TLS/SSL certificate verification for connections"""
+
+from nisystemlink.clients.core import HttpConfigurationManager
+from nisystemlink.clients.file import FileClient
+
+# explicitly get the http config and set the verify option
+http_config = HttpConfigurationManager.get_configuration()
+http_config.verify = False
+
+client = FileClient(configuration=http_config)
+print(client.api_info())

nisystemlink/clients/core/_http_configuration.py

@@ -23,6 +23,7 @@ def __init__(
         password: Optional[str] = None,
         cert_path: Optional[pathlib.Path] = None,
         workspace: Optional[str] = None,
+        verify: bool = True,
     ) -> None:
         """Initialize a configuration.
 
@@ -40,6 +41,7 @@ def __init__(
             password: The user's password to use when authorization is required.
             cert_path: Local path to an SSL certificate file.
             workspace: ID of workspace to use for client operations.
+            verify: Verify the security certificate for connection
 
         Raises:
             ValueError: if ``server_uri`` is missing scheme or host information.
@@ -73,6 +75,17 @@ def __init__(
 
         self._workspace = workspace
 
+        self._verify = verify
+
+    @property
+    def verify(self) -> bool:
+        """Verify the security certificate for connection."""
+        return self._verify
+
+    @verify.setter
+    def verify(self, value: bool) -> None:
+        self._verify = value
+
     @property
     def timeout_milliseconds(self) -> int:  # noqa: D401
         """The number of milliseconds before a request times out with an error.

nisystemlink/clients/core/_uplink/_base_client.py

@@ -3,6 +3,7 @@
 from json import loads
 from typing import Any, Callable, Dict, get_origin, Optional, Type, Union
 
+import requests
 from nisystemlink.clients import core
 from pydantic import parse_obj_as
 from requests import JSONDecodeError, Response
@@ -79,10 +80,14 @@ def __init__(self, configuration: core.HttpConfiguration, base_path: str = ""):
             configuration: Defines the web server to connect to and information about how to connect.
             base_path: The base path for all API calls.
         """
+        session = requests.Session()
+        session.verify = configuration.verify
+
         super().__init__(
             base_url=configuration.server_uri + base_path,
             converter=_JsonModelConverter(),
             hooks=[_handle_http_status],
+            client=session,
         )
         if configuration.api_keys:
             self.session.headers.update(configuration.api_keys)