splitio-client 10.0.1__tar.gz → 10.1.0rc2__tar.gz

{splitio_client-10.0.1 → splitio_client-10.1.0rc2}/PKG-INFO

@@ -1,12 +1,12 @@
 Metadata-Version: 2.1
 Name: splitio_client
-Version: 10.0.1
+Version: 10.1.0rc2
 Summary: Split.io Python Client
 Home-page: https://github.com/splitio/python-client
 Author: Patricio Echague, Sebastian Arrubia
 Author-email: pato@split.io, sebastian@split.io
 License: Apache License 2.0
-Download-URL: https://github.com/splitio/python-client/tarball/10.0.1
+Download-URL: https://github.com/splitio/python-client/tarball/10.1.0rc2
 Description: # Split Python SDK
         ![Build Status](https://github.com/splitio/python-client/actions/workflows/ci.yml/badge.svg?branch=master)
         
@@ -98,3 +98,4 @@ Provides-Extra: redis
 Provides-Extra: uwsgi
 Provides-Extra: cpphash
 Provides-Extra: asyncio
+Provides-Extra: kerberos

{splitio_client-10.0.1 → splitio_client-10.1.0rc2}/setup.py

@@ -16,7 +16,8 @@ TESTS_REQUIRES = [
     'attrs==22.1.0',
     'pytest-asyncio==0.21.0',
     'aiohttp>=3.8.4',
-    'aiofiles>=23.1.0'
+    'aiofiles>=23.1.0',
+    'requests-kerberos>=0.15.0'
 ]
 
 INSTALL_REQUIRES = [
@@ -46,7 +47,8 @@ setup(
         'redis': ['redis>=2.10.5'],
         'uwsgi': ['uwsgi>=2.0.0'],
         'cpphash': ['mmh3cffi==0.2.1'],
-        'asyncio': ['aiohttp>=3.8.4', 'aiofiles>=23.1.0']
+        'asyncio': ['aiohttp>=3.8.4', 'aiofiles>=23.1.0'],
+        'kerberos': ['requests-kerberos>=0.15.0']
     },
     setup_requires=['pytest-runner', 'pluggy==1.0.0;python_version<"3.8"'],
     classifiers=[

{splitio_client-10.0.1 → splitio_client-10.1.0rc2}/splitio/api/client.py

@@ -5,7 +5,11 @@ import urllib
 import abc
 import logging
 import json
+import threading
+from urllib3.util import parse_url
 
+from splitio.optional.loaders import HTTPKerberosAuth, OPTIONAL
+from splitio.client.config import AuthenticateScheme
 from splitio.optional.loaders import aiohttp
 from splitio.util.time import get_current_epoch_time_ms
 
@@ -67,6 +71,24 @@ class HttpClientException(Exception):
         """
         Exception.__init__(self, message)
 
+class HTTPAdapterWithProxyKerberosAuth(requests.adapters.HTTPAdapter):
+    """HTTPAdapter override for Kerberos Proxy auth"""
+
+    def __init__(self, principal=None, password=None):
+        requests.adapters.HTTPAdapter.__init__(self)
+        self._principal = principal
+        self._password = password
+
+    def proxy_headers(self, proxy):
+        headers = {}
+        if self._principal is not None:
+            auth = HTTPKerberosAuth(principal=self._principal, password=self._password)
+        else:
+            auth = HTTPKerberosAuth()
+        negotiate_details = auth.generate_request_header(None, parse_url(proxy).host, is_preemptive=True)
+        headers['Proxy-Authorization'] = negotiate_details
+        return headers
+
 class HttpClientBase(object, metaclass=abc.ABCMeta):
     """HttpClient wrapper template."""
 
@@ -91,11 +113,16 @@ class HttpClientBase(object, metaclass=abc.ABCMeta):
         self._telemetry_runtime_producer = telemetry_runtime_producer
         self._metric_name = metric_name
 
+    def _get_headers(self, extra_headers, sdk_key):
+        headers = _build_basic_headers(sdk_key)
+        if extra_headers is not None:
+            headers.update(extra_headers)
+        return headers
 
 class HttpClient(HttpClientBase):
     """HttpClient wrapper."""
 
-    def __init__(self, timeout=None, sdk_url=None, events_url=None, auth_url=None, telemetry_url=None):
+    def __init__(self, timeout=None, sdk_url=None, events_url=None, auth_url=None, telemetry_url=None, authentication_scheme=None, authentication_params=None):
         """
         Class constructor.
 
@@ -110,8 +137,12 @@ class HttpClient(HttpClientBase):
         :param telemetry_url: Optional alternative telemetry URL.
         :type telemetry_url: str
         """
+        _LOGGER.debug("Initializing httpclient")
         self._timeout = timeout/1000 if timeout else None # Convert ms to seconds.
         self._urls = _construct_urls(sdk_url, events_url, auth_url, telemetry_url)
+        self._authentication_scheme = authentication_scheme
+        self._authentication_params = authentication_params
+        self._lock = threading.RLock()
 
     def get(self, server, path, sdk_key, query=None, extra_headers=None):  # pylint: disable=too-many-arguments
         """
@@ -131,23 +162,22 @@ class HttpClient(HttpClientBase):
         :return: Tuple of status_code & response text
         :rtype: HttpResponse
         """
-        headers = _build_basic_headers(sdk_key)
-        if extra_headers is not None:
-            headers.update(extra_headers)
-
-        start = get_current_epoch_time_ms()
-        try:
-            response = requests.get(
-                _build_url(server, path, self._urls),
-                params=query,
-                headers=headers,
-                timeout=self._timeout
-            )
-            self._record_telemetry(response.status_code, get_current_epoch_time_ms() - start)
-            return HttpResponse(response.status_code, response.text, response.headers)
-
-        except Exception as exc:  # pylint: disable=broad-except
-            raise HttpClientException('requests library is throwing exceptions') from exc
+        with self._lock:
+            start = get_current_epoch_time_ms()
+            with requests.Session() as session:
+                self._set_authentication(session)
+                try:
+                    response = session.get(
+                        _build_url(server, path, self._urls),
+                        params=query,
+                        headers=self._get_headers(extra_headers, sdk_key),
+                        timeout=self._timeout
+                    )
+                    self._record_telemetry(response.status_code, get_current_epoch_time_ms() - start)
+                    return HttpResponse(response.status_code, response.text, response.headers)
+
+                except Exception as exc:  # pylint: disable=broad-except
+                    raise HttpClientException('requests library is throwing exceptions') from exc
 
     def post(self, server, path, sdk_key, body, query=None, extra_headers=None):  # pylint: disable=too-many-arguments
         """
@@ -169,25 +199,37 @@ class HttpClient(HttpClientBase):
         :return: Tuple of status_code & response text
         :rtype: HttpResponse
         """
-        headers = _build_basic_headers(sdk_key)
-
-        if extra_headers is not None:
-            headers.update(extra_headers)
-
-        start = get_current_epoch_time_ms()
-        try:
-            response = requests.post(
-                _build_url(server, path, self._urls),
-                json=body,
-                params=query,
-                headers=headers,
-                timeout=self._timeout
-            )
-            self._record_telemetry(response.status_code, get_current_epoch_time_ms() - start)
-            return HttpResponse(response.status_code, response.text, response.headers)
+        with self._lock:
+            start = get_current_epoch_time_ms()
+            with requests.Session() as session:
+                self._set_authentication(session)
+                try:
+                    response = session.post(
+                        _build_url(server, path, self._urls),
+                        json=body,
+                        params=query,
+                        headers=self._get_headers(extra_headers, sdk_key),
+                        timeout=self._timeout,
+                    )
+                    self._record_telemetry(response.status_code, get_current_epoch_time_ms() - start)
+                    return HttpResponse(response.status_code, response.text, response.headers)
+                except Exception as exc:  # pylint: disable=broad-except
+                    raise HttpClientException('requests library is throwing exceptions') from exc
+
+    def _set_authentication(self, session):
+        if self._authentication_scheme == AuthenticateScheme.KERBEROS_SPNEGO:
+            _LOGGER.debug("Using Kerberos Spnego Authentication")
+            if self._authentication_params != [None, None]:
+                session.auth = HTTPKerberosAuth(principal=self._authentication_params[0], password=self._authentication_params[1], mutual_authentication=OPTIONAL)
+            else:
+                session.auth = HTTPKerberosAuth(mutual_authentication=OPTIONAL)
+        elif self._authentication_scheme == AuthenticateScheme.KERBEROS_PROXY:
+            _LOGGER.debug("Using Kerberos Proxy Authentication")
+            if self._authentication_params != [None, None]:
+                session.mount('https://', HTTPAdapterWithProxyKerberosAuth(principal=self._authentication_params[0], password=self._authentication_params[1]))
+            else:
+                session.mount('https://', HTTPAdapterWithProxyKerberosAuth())
 
-        except Exception as exc:  # pylint: disable=broad-except
-            raise HttpClientException('requests library is throwing exceptions') from exc
 
     def _record_telemetry(self, status_code, elapsed):
         """
@@ -203,8 +245,8 @@ class HttpClient(HttpClientBase):
         if 200 <= status_code < 300:
             self._telemetry_runtime_producer.record_successful_sync(self._metric_name, get_current_epoch_time_ms())
             return
-        self._telemetry_runtime_producer.record_sync_error(self._metric_name, status_code)
 
+        self._telemetry_runtime_producer.record_sync_error(self._metric_name, status_code)
 
 class HttpClientAsync(HttpClientBase):
     """HttpClientAsync wrapper."""
@@ -243,10 +285,8 @@ class HttpClientAsync(HttpClientBase):
         :return: Tuple of status_code & response text
         :rtype: HttpResponse
         """
-        headers = _build_basic_headers(apikey)
-        if extra_headers is not None:
-            headers.update(extra_headers)
         start = get_current_epoch_time_ms()
+        headers = self._get_headers(extra_headers, apikey)
         try:
             url = _build_url(server, path, self._urls)
             _LOGGER.debug("GET request: %s", url)
@@ -286,9 +326,7 @@ class HttpClientAsync(HttpClientBase):
         :return: Tuple of status_code & response text
         :rtype: HttpResponse
         """
-        headers = _build_basic_headers(apikey)
-        if extra_headers is not None:
-            headers.update(extra_headers)
+        headers = self._get_headers(extra_headers, apikey)
         start = get_current_epoch_time_ms()
         try:
             headers['Accept-Encoding'] = 'gzip'
@@ -333,4 +371,4 @@ class HttpClientAsync(HttpClientBase):
 
     async def close_session(self):
         if not self._session.closed:
-            await self._session.close()
+            await self._session.close()

{splitio_client-10.0.1 → splitio_client-10.1.0rc2}/splitio/client/config.py

@@ -1,6 +1,7 @@
 """Default settings for the Split.IO SDK Python client."""
 import os.path
 import logging
+from enum import Enum
 
 from splitio.engine.impressions import ImpressionsMode
 from splitio.client.input_validator import validate_flag_sets
@@ -8,6 +9,12 @@ from splitio.client.input_validator import validate_flag_sets
 _LOGGER = logging.getLogger(__name__)
 DEFAULT_DATA_SAMPLING = 1
 
+class AuthenticateScheme(Enum):
+    """Authentication Scheme."""
+    NONE = 'NONE'
+    KERBEROS_SPNEGO = 'KERBEROS_SPNEGO'
+    KERBEROS_PROXY = 'KERBEROS_PROXY'
+
 DEFAULT_CONFIG = {
     'operationMode': 'standalone',
     'connectionTimeout': 1500,
@@ -59,7 +66,10 @@ DEFAULT_CONFIG = {
     'storageWrapper': None,
     'storagePrefix': None,
     'storageType': None,
-    'flagSetsFilter': None
+    'flagSetsFilter': None,
+    'httpAuthenticateScheme': AuthenticateScheme.NONE,
+    'kerberosPrincipalUser': None,
+    'kerberosPrincipalPassword': None
 }
 
 def _parse_operation_mode(sdk_key, config):
@@ -148,4 +158,14 @@ def sanitize(sdk_key, config):
     else:
         processed['flagSetsFilter'] = sorted(validate_flag_sets(processed['flagSetsFilter'], 'SDK Config')) if processed['flagSetsFilter'] is not None else None
 
+    if config.get('httpAuthenticateScheme') is not None:
+        try:
+            authenticate_scheme = AuthenticateScheme(config['httpAuthenticateScheme'].upper())
+        except (ValueError, AttributeError):
+            authenticate_scheme = AuthenticateScheme.NONE
+            _LOGGER.warning('You passed an invalid HttpAuthenticationScheme, HttpAuthenticationScheme should be ' \
+                            'one of the following values: `none`, `kerberos_proxy` or `kerberos_spnego`. '
+                            ' Defaulting to `none` mode.')
+        processed["httpAuthenticateScheme"] = authenticate_scheme
+
     return processed

{splitio_client-10.0.1 → splitio_client-10.1.0rc2}/splitio/client/factory.py

@@ -7,8 +7,8 @@ from enum import Enum
 from splitio.optional.loaders import asyncio
 from splitio.client.client import Client, ClientAsync
 from splitio.client import input_validator
+from splitio.client.config import sanitize as sanitize_config, DEFAULT_DATA_SAMPLING, AuthenticateScheme
 from splitio.client.manager import SplitManager, SplitManagerAsync
-from splitio.client.config import sanitize as sanitize_config, DEFAULT_DATA_SAMPLING
 from splitio.client import util
 from splitio.client.listener import ImpressionListenerWrapper, ImpressionListenerWrapperAsync
 from splitio.engine.impressions.impressions import Manager as ImpressionsManager
@@ -508,12 +508,19 @@ def _build_in_memory_factory(api_key, cfg, sdk_url=None, events_url=None,  # pyl
     telemetry_evaluation_producer = telemetry_producer.get_telemetry_evaluation_producer()
     telemetry_init_producer = telemetry_producer.get_telemetry_init_producer()
 
+    authentication_params = None
+    if cfg.get("httpAuthenticateScheme") in [AuthenticateScheme.KERBEROS_SPNEGO, AuthenticateScheme.KERBEROS_PROXY]:
+        authentication_params = [cfg.get("kerberosPrincipalUser"),
+                                 cfg.get("kerberosPrincipalPassword")]
+
     http_client = HttpClient(
         sdk_url=sdk_url,
         events_url=events_url,
         auth_url=auth_api_base_url,
         telemetry_url=telemetry_api_base_url,
-        timeout=cfg.get('connectionTimeout')
+        timeout=cfg.get('connectionTimeout'),
+        authentication_scheme = cfg.get("httpAuthenticateScheme"),
+        authentication_params = authentication_params
     )
 
     sdk_metadata = util.get_metadata(cfg)

{splitio_client-10.0.1 → splitio_client-10.1.0rc2}/splitio/optional/loaders.py

@@ -14,5 +14,17 @@ except ImportError:
     asyncio = missing_asyncio_dependencies
     aiofiles = missing_asyncio_dependencies
 
+try:
+    from requests_kerberos import HTTPKerberosAuth, OPTIONAL
+except ImportError:
+    def missing_auth_dependencies(*_, **__):
+        """Fail if missing dependencies are used."""
+        raise NotImplementedError(
+            'Missing kerberos auth dependency. '
+            'Please use `pip install splitio_client[kerberos]` to install the sdk with kerberos auth support'
+        )
+    HTTPKerberosAuth = missing_auth_dependencies
+    OPTIONAL = missing_auth_dependencies
+
 async def _anext(it):
     return await it.__anext__()

splitio_client-10.1.0rc2/splitio/version.py

@@ -0,0 +1 @@
+__version__ = '10.1.0rc2'

{splitio_client-10.0.1 → splitio_client-10.1.0rc2}/splitio_client.egg-info/PKG-INFO

@@ -1,12 +1,12 @@
 Metadata-Version: 2.1
 Name: splitio-client
-Version: 10.0.1
+Version: 10.1.0rc2
 Summary: Split.io Python Client
 Home-page: https://github.com/splitio/python-client
 Author: Patricio Echague, Sebastian Arrubia
 Author-email: pato@split.io, sebastian@split.io
 License: Apache License 2.0
-Download-URL: https://github.com/splitio/python-client/tarball/10.0.1
+Download-URL: https://github.com/splitio/python-client/tarball/10.1.0rc2
 Description: # Split Python SDK
         ![Build Status](https://github.com/splitio/python-client/actions/workflows/ci.yml/badge.svg?branch=master)
         
@@ -98,3 +98,4 @@ Provides-Extra: redis
 Provides-Extra: uwsgi
 Provides-Extra: cpphash
 Provides-Extra: asyncio
+Provides-Extra: kerberos

{splitio_client-10.0.1 → splitio_client-10.1.0rc2}/splitio_client.egg-info/requires.txt

@@ -13,6 +13,9 @@ aiofiles>=23.1.0
 [cpphash]
 mmh3cffi==0.2.1
 
+[kerberos]
+requests-kerberos>=0.15.0
+
 [redis]
 redis>=2.10.5
 
@@ -29,6 +32,7 @@ attrs==22.1.0
 pytest-asyncio==0.21.0
 aiohttp>=3.8.4
 aiofiles>=23.1.0
+requests-kerberos>=0.15.0
 
 [uwsgi]
 uwsgi>=2.0.0

splitio_client-10.0.1/splitio/version.py

@@ -1 +0,0 @@
-__version__ = '10.0.1'