zscaler-sdk-python 1.8.3__tar.gz → 1.8.5__tar.gz

{zscaler_sdk_python-1.8.3 → zscaler_sdk_python-1.8.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: zscaler-sdk-python
-Version: 1.8.3
+Version: 1.8.5
 Summary: Official Python SDK for the Zscaler Products
 Home-page: https://github.com/zscaler/zscaler-sdk-python
 License: MIT
@@ -26,9 +26,9 @@ Requires-Dist: arrow (>=1.3.0)
 Requires-Dist: cryptography (>=45.0.2)
 Requires-Dist: flatdict (>=4.0.0)
 Requires-Dist: pydash (>=8.0.3)
-Requires-Dist: pyjwt (>=2.8.0)
 Requires-Dist: python-box (>=7.3.0)
 Requires-Dist: python-dateutil (>=2.9.0)
+Requires-Dist: python-jose[cryptography] (>=3.3.0)
 Requires-Dist: pytz (>=2024.2)
 Requires-Dist: pyyaml (>=6.0.0)
 Requires-Dist: requests (>=2.32.3)
@@ -414,6 +414,7 @@ or
 
 ```
 -----BEGIN PRIVATE KEY-----
+# Example private key (not a real key)
 MIIEvQIBADANBgkqhkiG9w0BAQEFAASCBKcwggSjAgEAAoIBAQCv3krdYg3z7h0H
 60QoePJMghllQxsfPxp3mgFfYEaIbF88Z8dvPZEfhAtP19/Mv62ASjwgqzQzKHRV
 -----END PRIVATE KEY-----
@@ -554,10 +555,11 @@ query_parameters = {'page_size': 100}
 groups, resp, err = client.zia.user_management.list_groups(query_parameters)
 
 while resp.has_next():
-    more_groups, err = resp.next()
+    more_groups, resp, err = resp.next()  # Unpack all 3 return values
     if err:
         break
-    groups.extend(more_groups)
+    if more_groups:
+        groups.extend(more_groups)
 ```
 
 ### Searching and Filtering
@@ -595,12 +597,13 @@ def main():
             print(group)
 
         while resp.has_next():
-            next_page, err = resp.next()
+            next_page, resp, err = resp.next()  # Unpack all 3 return values
             if err:
                 print(f"Error fetching next page: {err}")
                 break
-            for group in next_page:
-                print(group)
+            if next_page:
+                for group in next_page:
+                    print(group)
 
         try:
             resp.next()  # Will raise StopIteration if no more data
@@ -613,18 +616,21 @@ if __name__ == "__main__":
 
 ### Pagination Limits and Controls
 
-Each Zscaler service has its own pagination requiremens and max page size:
-
-| Service | Default Page Size | Max Page Size |             Notes                               |
-|---------|-------------------|---------------|-------------------------------------------------|
-| ZCC     | Varies            | Varies        | Uses `pageSize` (camelCase)                     |
-| ZDX     | 10                | Varies        | Uses `limit` + `offset`, similar to cursor API  |
-| ZIA     | 100               | Varies        | Uses `pageSize` (camelCase)                     |
-| ZPA     | 100               | 500           | Uses `pagesize` (lowercase)                     |
-| ZTW     | 100               | Varies        | Uses `pageSize` (camelCase)                     |
-| ZWA     | Varies            | Varies        | Uses `pageSize` (camelCase)                     |
-
-⚠️ **Note:** Always use `snake_case` for all parameter names, even when the API expects camelCase.The SDK handles conversion internally.
+Each Zscaler service has its own pagination requirements and limits. The SDK automatically respects these API defaults when no `page_size` is provided:
+
+| Service | API Default Page Size | Max Page Size | Pagination Parameters                           |
+|---------|-----------------------|---------------|-------------------------------------------------|
+| ZCC     | Varies by endpoint    | Varies        | Uses `page`, `pageSize`                         |
+| ZDX     | 10                    | Varies        | Uses `limit` + `offset` (cursor-based)          |
+| ZIA     | 100                   | 1000          | Uses `page`, `pageSize`                         |
+| ZPA     | 20                    | 500           | Uses `page`, `pagesize`                         |
+| ZTW     | 100                   | Varies        | Uses `page`, `pageSize`                         |
+| ZWA     | Varies by endpoint    | Varies        | Uses `page`, `pageSize`                         |
+
+**Important Notes:**
+- ✅ The SDK automatically uses each API's default page size when no `page_size` is specified
+- ✅ Always use `snake_case` for parameter names (e.g., `page_size`). The SDK handles conversion internally
+- ✅ Pagination stops automatically when fewer results than the page size are returned
 
 
 You can control how many total items or pages the SDK will fetch even if more data is available.

{zscaler_sdk_python-1.8.3 → zscaler_sdk_python-1.8.5}/README.md

@@ -375,6 +375,7 @@ or
 
 ```
 -----BEGIN PRIVATE KEY-----
+# Example private key (not a real key)
 MIIEvQIBADANBgkqhkiG9w0BAQEFAASCBKcwggSjAgEAAoIBAQCv3krdYg3z7h0H
 60QoePJMghllQxsfPxp3mgFfYEaIbF88Z8dvPZEfhAtP19/Mv62ASjwgqzQzKHRV
 -----END PRIVATE KEY-----
@@ -515,10 +516,11 @@ query_parameters = {'page_size': 100}
 groups, resp, err = client.zia.user_management.list_groups(query_parameters)
 
 while resp.has_next():
-    more_groups, err = resp.next()
+    more_groups, resp, err = resp.next()  # Unpack all 3 return values
     if err:
         break
-    groups.extend(more_groups)
+    if more_groups:
+        groups.extend(more_groups)
 ```
 
 ### Searching and Filtering
@@ -556,12 +558,13 @@ def main():
             print(group)
 
         while resp.has_next():
-            next_page, err = resp.next()
+            next_page, resp, err = resp.next()  # Unpack all 3 return values
             if err:
                 print(f"Error fetching next page: {err}")
                 break
-            for group in next_page:
-                print(group)
+            if next_page:
+                for group in next_page:
+                    print(group)
 
         try:
             resp.next()  # Will raise StopIteration if no more data
@@ -574,18 +577,21 @@ if __name__ == "__main__":
 
 ### Pagination Limits and Controls
 
-Each Zscaler service has its own pagination requiremens and max page size:
-
-| Service | Default Page Size | Max Page Size |             Notes                               |
-|---------|-------------------|---------------|-------------------------------------------------|
-| ZCC     | Varies            | Varies        | Uses `pageSize` (camelCase)                     |
-| ZDX     | 10                | Varies        | Uses `limit` + `offset`, similar to cursor API  |
-| ZIA     | 100               | Varies        | Uses `pageSize` (camelCase)                     |
-| ZPA     | 100               | 500           | Uses `pagesize` (lowercase)                     |
-| ZTW     | 100               | Varies        | Uses `pageSize` (camelCase)                     |
-| ZWA     | Varies            | Varies        | Uses `pageSize` (camelCase)                     |
-
-⚠️ **Note:** Always use `snake_case` for all parameter names, even when the API expects camelCase.The SDK handles conversion internally.
+Each Zscaler service has its own pagination requirements and limits. The SDK automatically respects these API defaults when no `page_size` is provided:
+
+| Service | API Default Page Size | Max Page Size | Pagination Parameters                           |
+|---------|-----------------------|---------------|-------------------------------------------------|
+| ZCC     | Varies by endpoint    | Varies        | Uses `page`, `pageSize`                         |
+| ZDX     | 10                    | Varies        | Uses `limit` + `offset` (cursor-based)          |
+| ZIA     | 100                   | 1000          | Uses `page`, `pageSize`                         |
+| ZPA     | 20                    | 500           | Uses `page`, `pagesize`                         |
+| ZTW     | 100                   | Varies        | Uses `page`, `pageSize`                         |
+| ZWA     | Varies by endpoint    | Varies        | Uses `page`, `pageSize`                         |
+
+**Important Notes:**
+- ✅ The SDK automatically uses each API's default page size when no `page_size` is specified
+- ✅ Always use `snake_case` for parameter names (e.g., `page_size`). The SDK handles conversion internally
+- ✅ Pagination stops automatically when fewer results than the page size are returned
 
 
 You can control how many total items or pages the SDK will fetch even if more data is available.

{zscaler_sdk_python-1.8.3 → zscaler_sdk_python-1.8.5}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "zscaler-sdk-python"
-version = "1.8.3"
+version = "1.8.5"
 description = "Official Python SDK for the Zscaler Products"
 authors = ["Zscaler, Inc. <devrel@zscaler.com>"]
 license = "MIT"
@@ -36,7 +36,7 @@ pytz = ">=2024.2"
 python-box = ">=7.3.0"
 python-dateutil = ">=2.9.0"
 flatdict = ">=4.0.0"
-pyjwt = ">=2.8.0"
+python-jose = {extras = ["cryptography"], version = ">=3.3.0"}
 aenum = ">=3.1.11"
 pydash = ">=8.0.3"
 arrow = ">=1.3.0"

{zscaler_sdk_python-1.8.3 → zscaler_sdk_python-1.8.5}/zscaler/__init__.py

@@ -29,7 +29,7 @@ __license__ = "MIT"
 __contributors__ = [
     "William Guilherme",
 ]
-__version__ = "1.8.3"
+__version__ = "1.8.5"
 
 
 from zscaler.oneapi_client import Client as ZscalerClient  # noqa

{zscaler_sdk_python-1.8.3 → zscaler_sdk_python-1.8.5}/zscaler/constants.py

@@ -15,7 +15,7 @@ ZPA_BASE_URLS = {
 DEV_AUTH_URL = "https://authn1.dev.zpath.net/authn/v1/oauth/token"
 
 
-RETRYABLE_STATUS_CODES = {408, 409, 412, 429, 500, 502, 503, 504}
+RETRYABLE_STATUS_CODES = {429, 500, 502, 503, 504}
 MAX_RETRIES = 5
 BACKOFF_FACTOR = 1
 BACKOFF_BASE_DURATION = 2

{zscaler_sdk_python-1.8.3 → zscaler_sdk_python-1.8.5}/zscaler/errors/response_checker.py

@@ -7,6 +7,7 @@ from zscaler.exceptions import exceptions
 
 logger = logging.getLogger(__name__)
 
+
 # @staticmethod
 def check_response_for_error(url, response_details, response_body):
     """

{zscaler_sdk_python-1.8.3 → zscaler_sdk_python-1.8.5}/zscaler/exceptions/exceptions.py

@@ -2,6 +2,7 @@ import json
 
 raise_exception = False
 
+
 # Zscaler Base Exceptions
 class ZscalerBaseException(Exception):
     def __init__(self, url, response, response_body):
@@ -85,6 +86,7 @@ class TokenRefreshError(Exception):
 class HeaderUpdateError(Exception):
     pass
 
+
 class RetryTooLong(Exception):
     """Raised when backoff time exceeds maxRetrySeconds configuration."""
     pass

{zscaler_sdk_python-1.8.3 → zscaler_sdk_python-1.8.5}/zscaler/helpers.py

@@ -47,13 +47,14 @@ def to_snake_case(string):
         "dnsResolutionOnTransparentProxyIPv6UrlCategories": "dns_resolution_on_transparent_proxy_ipv6_url_categories",
         "dnsResolutionOnTransparentProxyIPv6Apps": "dns_resolution_on_transparent_proxy_ipv6_apps",
         "enableIPv6DnsOptimizationOnAllTransparentProxy": "enable_ipv6_dns_optimization_on_all_transparent_proxy",
-        "dnsResolutionOnTransparentProxyIPv6ExemptUrlCategories": "dns_resolution_on_transparent_proxy_ipv6_exempt_url_categories",
+        "dnsResolutionOnTransparentProxyIPv6ExemptUrlCategories":
+            "dns_resolution_on_transparent_proxy_ipv6_exempt_url_categories",
         "endPointDLPLogType": "end_point_dlp_log_type",
         "emailDLPLogType": "email_dlp_log_type",
         "extranetDNSList": "extranet_dns_list",
         "primaryDNSServer": "primary_dns_server",
         "secondaryDNSServer": "secondary_dns_server",
-        
+
         # ZCC Edge Case Attributes
         "enableUDPTransportSelection": "enable_udp_transport_selection",
         "interceptZIATrafficAllAdapters": "intercept_zia_traffic_all_adapters",
@@ -118,7 +119,7 @@ def to_snake_case(string):
         "enableZCCRevert": "enable_zcc_revert",
         "enableZiaDR": "enable_zia_dr",
         "purgeKerberosPreferredDCCache": "purge_kerberos_preferred_dc_cache",
-        
+
         # ZPA Edge Cases
         "serverGroupDTOs": "server_group_dtos",
         "extranetDTO": "extranet_dto",
@@ -126,7 +127,7 @@ def to_snake_case(string):
         "locationDTO": "location_dto",
         "predefinedADPControls": "predefined_adp_controls",
         "runtimeOS": "runtime_os",
-        
+
         # ZIdentity Edge Cases
         # "clientJWKsUrl": "clientJWKsUrl",
     }
@@ -184,14 +185,16 @@ def to_lower_camel_case(string):
         "dns_resolution_on_transparent_proxy_ipv6_exempt_apps": "dnsResolutionOnTransparentProxyIPv6ExemptApps",
         "dns_resolution_on_transparent_proxy_ipv6_url_categories": "dnsResolutionOnTransparentProxyIPv6UrlCategories",
         "dns_resolution_on_transparent_proxy_ipv6_apps": "dnsResolutionOnTransparentProxyIPv6Apps",
-        "enable_ipv6_dns_optimization_on_all_transparent_proxy": "enableIPv6DnsOptimizationOnAllTransparentProxy",
-        "dns_resolution_on_transparent_proxy_ipv6_exempt_url_categories": "dnsResolutionOnTransparentProxyIPv6ExemptUrlCategories",
+        "enable_ipv6_dns_optimization_on_all_transparent_proxy":
+            "enableIPv6DnsOptimizationOnAllTransparentProxy",
+        "dns_resolution_on_transparent_proxy_ipv6_exempt_url_categories":
+            "dnsResolutionOnTransparentProxyIPv6ExemptUrlCategories",
         "end_point_dlp_log_type": "endPointDLPLogType",
         "email_dlp_log_type": "emailDLPLogType",
         "extranet_dns_list": "extranetDNSList",
         "primary_dns_server": "primaryDNSServer",
         "secondary_dns_server": "secondaryDNSServer",
-        
+
         # ZCC Edge Case Attributes
         "enable_udp_transport_selection": "enableUDPTransportSelection",
         "intercept_zia_traffic_all_adapters": "interceptZIATrafficAllAdapters",
@@ -255,7 +258,7 @@ def to_lower_camel_case(string):
         "delete_dhcp_option121_routes": "deleteDHCPOption121Routes",
         "enableZiaDR": "enable_zia_dr",
         "purgeKerberosPreferredDCCache": "purge_kerberos_preferred_dc_cache",
-        
+
         # ZPA Edge Cases
         "server_group_dtos": "serverGroupDTOs",
         "extranet_dto": "extranetDTO",
@@ -321,17 +324,17 @@ def convert_keys_to_camel_case_selective(data, preserve_snake_case_keys=None):
     Recursively convert keys to camelCase while preserving specific snake_case keys.
     This function allows users to use snake_case for all attributes, and only converts
     to camelCase if the attribute is NOT in the preserve_snake_case_keys set.
-    
+
     Args:
         data: Dictionary or list to convert
         preserve_snake_case_keys: Set of keys that should remain in snake_case
-    
+
     Returns:
         Converted data with selective key preservation
     """
     if preserve_snake_case_keys is None:
         preserve_snake_case_keys = set()
-    
+
     if isinstance(data, dict):
         result = {}
         for k, v in data.items():

{zscaler_sdk_python-1.8.3 → zscaler_sdk_python-1.8.5}/zscaler/logger.py

@@ -7,6 +7,85 @@ from http.client import HTTPConnection
 
 LOG_FORMAT = "%(asctime)s - %(name)s - %(module)s - %(levelname)s - %(message)s"
 
+# Fields to sanitize in logs (case-insensitive matching)
+SENSITIVE_FIELDS = {
+    "password", "api_key", "apiKey", "apikey", 
+    "clientSecret", "client_secret", "clientsecret",
+    "authorization", "Authorization",
+    "access_token", "accessToken", "accesstoken",
+    "refresh_token", "refreshToken", "refreshtoken",
+    "secret", "Secret",
+    "privateKey", "private_key", "privatekey",
+    "token", "Token",
+    "key", "Key",
+}
+
+# Sensitive header keys (case-insensitive)
+SENSITIVE_HEADERS = {
+    "authorization", "x-api-key", "apikey", "api-key",
+    "clientsecret", "client-secret", "access-token", 
+    "refresh-token", "x-auth-token",
+}
+
+
+def _sanitize_for_logging(data):
+    """
+    Recursively mask sensitive fields in dicts/lists for logging.
+    
+    Args:
+        data: The data structure to sanitize (dict, list, or other)
+    
+    Returns:
+        Sanitized copy of the data with sensitive fields masked
+    """
+    if isinstance(data, dict):
+        return {
+            k: "***REDACTED***" if k in SENSITIVE_FIELDS or k.lower() in SENSITIVE_FIELDS 
+            else _sanitize_for_logging(v)
+            for k, v in data.items()
+        }
+    elif isinstance(data, list):
+        return [_sanitize_for_logging(item) for item in data]
+    else:
+        return data
+
+
+def _sanitize_plaintext_for_logging(text):
+    """
+    Scan and mask sensitive keywords in plaintext strings.
+    
+    Args:
+        text (str): Plain text that might contain sensitive data
+    
+    Returns:
+        str: Text with sensitive patterns masked
+    """
+    import re
+    
+    if not isinstance(text, str):
+        return text
+    
+    # Patterns to match common sensitive data formats in plain text
+    # Match patterns like "password":"value", "password": "value", password=value, etc.
+    patterns = [
+        (r'("password"\s*:\s*")[^"]*(")', r'\1***REDACTED***\2'),
+        (r'("api_key"\s*:\s*")[^"]*(")', r'\1***REDACTED***\2'),
+        (r'("apiKey"\s*:\s*")[^"]*(")', r'\1***REDACTED***\2'),
+        (r'("clientSecret"\s*:\s*")[^"]*(")', r'\1***REDACTED***\2'),
+        (r'("client_secret"\s*:\s*")[^"]*(")', r'\1***REDACTED***\2'),
+        (r'("access_token"\s*:\s*")[^"]*(")', r'\1***REDACTED***\2'),
+        (r'("refresh_token"\s*:\s*")[^"]*(")', r'\1***REDACTED***\2'),
+        (r'("token"\s*:\s*")[^"]*(")', r'\1***REDACTED***\2'),
+        (r'("secret"\s*:\s*")[^"]*(")', r'\1***REDACTED***\2'),
+        (r'("privateKey"\s*:\s*")[^"]*(")', r'\1***REDACTED***\2'),
+    ]
+    
+    sanitized_text = text
+    for pattern, replacement in patterns:
+        sanitized_text = re.sub(pattern, replacement, sanitized_text, flags=re.IGNORECASE)
+    
+    return sanitized_text
+
 
 def setup_logging(logger_name="zscaler-sdk-python", enabled=None, verbose=None):
     """
@@ -66,12 +145,20 @@ def setup_logging(logger_name="zscaler-sdk-python", enabled=None, verbose=None):
 
 
 def dump_request(logger, url: str, method: str, json, params, headers, request_uuid: str, body=True):
-    request_headers_filtered = {key: value for key, value in headers.items() if key != "Authorization"}
+    # Mask sensitive header values (e.g., Authorization, X-Api-Key, etc.)
+    request_headers_filtered = {
+        key: "***REDACTED***" if key.lower() in SENSITIVE_HEADERS else value 
+        for key, value in headers.items()
+    }
+    
     # Log the request details before sending the request
     log_lines = []
     request_body = ""
-    if body:
-        request_body = jsonp.dumps(json)
+    if body and json:
+        # Sanitize request body before logging
+        sanitized_json = _sanitize_for_logging(json)
+        request_body = jsonp.dumps(sanitized_json)
+    
     log_lines.append(f"\n---[ ZSCALER SDK REQUEST | ID:{request_uuid} ]-------------------------------")
     full_url = url
     if params:
@@ -100,8 +187,13 @@ def dump_response(
     duration_seconds = end_time - start_time
     # Convert the duration to milliseconds
     duration_ms = duration_seconds * 1000
-    # Convert the headers to a regular dictionary
-    response_headers_dict = dict(resp.headers)
+    
+    # Mask sensitive headers in response
+    response_headers_dict = {
+        key: "***REDACTED***" if key.lower() in SENSITIVE_HEADERS else value
+        for key, value in dict(resp.headers).items()
+    }
+    
     full_url = url
     if params:
         full_url += "?" + urlencode(params)
@@ -116,10 +208,20 @@ def dump_response(
     log_lines.append(f"{method} {full_url}")
     for key, value in response_headers_dict.items():
         log_lines.append(f"{key}: {value}")
+    
     response_body = ""
     if resp.text:
         response_body = resp.text
+        # Try to sanitize response body if it's JSON
+        try:
+            parsed_body = jsonp.loads(response_body)
+            sanitized_body = _sanitize_for_logging(parsed_body)
+            response_body = jsonp.dumps(sanitized_body)
+        except (jsonp.JSONDecodeError, ValueError):
+            # If not JSON, sanitize sensitive keywords in plaintext
+            response_body = _sanitize_plaintext_for_logging(response_body)
+    
     if response_body and response_body != "" and response_body != "null":
         log_lines.append(f"\n{response_body}")
     log_lines.append("-" * 68)
-    logger.info("\n".join(log_lines))
+    logger.info("\n".join(log_lines))

{zscaler_sdk_python-1.8.3 → zscaler_sdk_python-1.8.5}/zscaler/oneapi_client.py

@@ -259,7 +259,7 @@ class Client:
         if self._zidentity is None:
             self._zidentity = ZIdentityService(self._request_executor)
         return self._zidentity
-    
+
     def __enter__(self):
         """
         Automatically create and set session within context manager.
@@ -276,7 +276,7 @@ class Client:
         if hasattr(self, "_session"):
             self._session.close()
             self.logger.debug("Session closed.")
-        
+
         # Clean up Zscaler authentication session
         if hasattr(self, '_request_executor'):
             # For legacy clients, use their deauthenticate method
@@ -291,7 +291,7 @@ class Client:
                 service_type = getattr(self._request_executor, '_last_service_type', None)
                 if not service_type:
                     service_type = self._config.get("client", {}).get("service", "zia")
-                
+
                 if service_type.lower() in ["zia", "ztw"]:
                     # For ZIA, deauthenticate only if mutations occurred; executor will decide.
                     self.logger.debug(f"Deauthenticating Zscaler session for {service_type} service.")