hyper-sdk 2.2.1__tar.gz → 2.3.0__tar.gz

{hyper_sdk-2.2.1 → hyper_sdk-2.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: hyper_sdk
-Version: 2.2.1
+Version: 2.3.0
 Summary: Hyper Solutions Python SDK
 License: MIT License
         

{hyper_sdk-2.2.1 → hyper_sdk-2.3.0}/hyper_sdk/akamai_input.py

@@ -27,7 +27,8 @@ class DynamicInput:
 
 
 class SbsdInput:
-    def __init__(self, user_agent: str, uuid: str, page_url: str, o_cookie: str, script: str, acceptLanguage: str, ip: str):
+    def __init__(self, index: int, user_agent: str, uuid: str, page_url: str, o_cookie: str, script: str, acceptLanguage: str, ip: str):
+        self.index = index
         self.user_agent = user_agent
         self.uuid = uuid
         self.page_url = page_url

{hyper_sdk-2.2.1 → hyper_sdk-2.3.0}/hyper_sdk/session.py

@@ -1,4 +1,4 @@
-from typing import Optional, Dict, Any
+from typing import Optional, Dict, Any, Tuple
 from urllib.parse import quote
 
 import requests
@@ -9,6 +9,7 @@ from .akamai_input import SensorInput, PixelInput, DynamicInput, SbsdInput
 from .kasada_input import KasadaPowInput, KasadaPayloadInput
 from .datadome_input import DataDomeSliderInput, DataDomeInterstitialInput, DataDomeTagsInput
 from .incapsula_input import UtmvcInput, ReeseInput
+from .trustdecision_input import PayloadInput, DecodeInput, SignatureInput
 
 
 class Session:
@@ -84,6 +85,7 @@ class Session:
             'script': input_data.script,
             'acceptLanguage': input_data.acceptLanguage,
             'ip': input_data.ip,
+            'index': input_data.index,
         })
 
     def parse_v3_dynamic(self, input_data: DynamicInput) -> str:
@@ -195,7 +197,6 @@ class Session:
 
         return response_data["payload"], response_data["swhanedl"]
 
-
     def generate_kasada_pow(self, input_data: KasadaPowInput) -> str:
         """
             Returns the x-kpsdk-cd value using the Hyper Solutions API.
@@ -285,6 +286,83 @@ class Session:
         """
         return self._send_request("https://datadome.hypersolutions.co/tags", input_data.to_dict())
 
+    def generate_trustdecision_payload(self, input_data: PayloadInput) -> Tuple[str, str, str]:
+        """
+        Generates TrustDecision payload that should be posted to TrustDecision's fingerprinting endpoint.
+        Also returns timezone and clientId required for subsequent operations.
+
+        Args:
+            input_data (PayloadInput): An instance of PayloadInput containing the necessary data for generating the payload.
+
+        Returns:
+            Tuple[str, str, str]: A tuple containing:
+                - payload (str): The generated TrustDecision payload for posting to the fingerprinting endpoint
+                - timeZone (str): The timezone to use in the tz header for subsequent requests
+                - clientId (str): The client ID required for generating session signatures
+        """
+        if not self.api_key:
+            raise ValueError("Missing API key")
+
+        headers = {
+            'Content-Type': 'application/json',
+            'x-api-key': self.api_key
+        }
+
+        if self.jwt_key:
+            signature = self.generate_signature()
+            headers['x-signature'] = signature
+
+        response = self.client.post("https://trustdecision.hypersolutions.co/payload", headers=headers, json={
+            'userAgent': input_data.user_agent,
+            'pageUrl': input_data.page_url,
+            'fpUrl': input_data.fp_url,
+            'ip': input_data.ip,
+            'acceptLanguage': input_data.accept_language,
+            'script': input_data.script,
+        })
+
+        response_data = response.json()
+
+        if "error" in response_data and response_data["error"]:
+            raise Exception(f"API returned with error: {response_data['error']}")
+
+        if response.status_code != 200:
+            raise Exception(f"API returned with status code: {response.status_code}")
+
+        return response_data["payload"], response_data["timeZone"], response_data["clientId"]
+
+    def decode_trustdecision_session_key(self, input_data: DecodeInput) -> str:
+        """
+        Decodes the result and requestId from TrustDecision's fingerprinting endpoint
+        to generate the td-session-key header value.
+
+        Args:
+            input_data (DecodeInput): An instance of DecodeInput containing the result and requestId.
+
+        Returns:
+            str: The decoded session key value for use in the td-session-key header
+        """
+        return self._send_request("https://trustdecision.hypersolutions.co/decode", {
+            'result': input_data.result,
+            'requestId': input_data.request_id,
+        })
+
+    def generate_trustdecision_signature(self, input_data: SignatureInput) -> str:
+        """
+        Generates a unique td-session-sign header value for each API request.
+        This signature can only be used once and must be regenerated for every request.
+
+        Args:
+            input_data (SignatureInput): An instance of SignatureInput containing the clientId and path.
+
+        Returns:
+            str: The generated signature value for use in the td-session-sign header (single-use only)
+        """
+        return self._send_request("https://trustdecision.hypersolutions.co/sign", {
+            'clientId': input_data.client_id,
+            'path': input_data.path,
+        })
+
     def generate_signature(self) -> str:
         claims = {
             "key": self.api_key,

hyper_sdk-2.3.0/hyper_sdk/trustdecision_input.py

@@ -0,0 +1,45 @@
+class PayloadInput:
+    def __init__(self, user_agent: str, page_url: str, fp_url: str, ip: str, accept_language: str, script: str):
+        """
+        Creates a new PayloadInput instance for generating TrustDecision payloads.
+
+        Args:
+            user_agent (str): The userAgent that you're using for the entire session
+            page_url (str): The target page URL where TrustDecision protection is active
+            fp_url (str): The td-fp URL where the payload is posted
+            ip (str): The IP address that will be used to post the sensor data to the target site
+            accept_language (str): Your accept-language header value
+            script (str): The TrustDecision fingerprinting script source code obtained from the fm.js endpoint
+        """
+        self.user_agent = user_agent
+        self.page_url = page_url
+        self.fp_url = fp_url
+        self.ip = ip
+        self.accept_language = accept_language
+        self.script = script
+
+
+class DecodeInput:
+    def __init__(self, result: str, request_id: str):
+        """
+        Creates a new DecodeInput instance for decoding TrustDecision session keys.
+
+        Args:
+            result (str): The result field from TrustDecision's fingerprinting endpoint response
+            request_id (str): The requestId field from TrustDecision's fingerprinting endpoint response
+        """
+        self.result = result
+        self.request_id = request_id
+
+
+class SignatureInput:
+    def __init__(self, client_id: str, path: str):
+        """
+        Creates a new SignatureInput instance for generating TrustDecision session signatures.
+
+        Args:
+            client_id (str): The client ID returned from the payload generation endpoint
+            path (str): The API endpoint path that will be called. This should match the value used in the td-session-path header of your actual request.
+        """
+        self.client_id = client_id
+        self.path = path

{hyper_sdk-2.2.1 → hyper_sdk-2.3.0}/hyper_sdk.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: hyper_sdk
-Version: 2.2.1
+Version: 2.3.0
 Summary: Hyper Solutions Python SDK
 License: MIT License
         

{hyper_sdk-2.2.1 → hyper_sdk-2.3.0}/hyper_sdk.egg-info/SOURCES.txt

@@ -7,6 +7,7 @@ hyper_sdk/datadome_input.py
 hyper_sdk/incapsula_input.py
 hyper_sdk/kasada_input.py
 hyper_sdk/session.py
+hyper_sdk/trustdecision_input.py
 hyper_sdk.egg-info/PKG-INFO
 hyper_sdk.egg-info/SOURCES.txt
 hyper_sdk.egg-info/dependency_links.txt

{hyper_sdk-2.2.1 → hyper_sdk-2.3.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "hyper_sdk"
-version = "2.2.1"
+version = "2.3.0"
 description = "Hyper Solutions Python SDK"
 readme = "README.md"
 requires-python = ">=3.6"