pangea-sdk 3.8.0b4__py3-none-any.whl → 3.9.0__py3-none-any.whl

pangea/services/authz.py

@@ -20,10 +20,10 @@ class ItemOrder(str, enum.Enum):
 
 
 class TupleOrderBy(str, enum.Enum):
-    RESOURCE_NAMESPACE = "resource_namespace"
+    RESOURCE_TYPE = "resource_type"
     RESOURCE_ID = "resource_id"
     RELATION = "relation"
-    SUBJECT_NAMESPACE = "subject_namespace"
+    SUBJECT_TYPE = "subject_type"
     SUBJECT_ID = "subject_id"
     SUBJECT_ACTION = "subject_action"
 
@@ -35,12 +35,12 @@ class TupleOrderBy(str, enum.Enum):
 
 
 class Resource(PangeaResponseResult):
-    namespace: str
+    type: str
     id: Optional[str] = None
 
 
 class Subject(PangeaResponseResult):
-    namespace: str
+    type: str
     id: Optional[str] = None
     action: Optional[str] = None
 
@@ -60,18 +60,18 @@ class TupleCreateResult(PangeaResponseResult):
 
 
 class TupleListFilter(APIRequestModel):
-    resource_namespace: Optional[str] = None
-    resource_namespace__contains: Optional[List[str]] = None
-    resource_namespace__in: Optional[List[str]] = None
+    resource_type: Optional[str] = None
+    resource_type__contains: Optional[List[str]] = None
+    resource_type__in: Optional[List[str]] = None
     resource_id: Optional[str] = None
     resource_id__contains: Optional[List[str]] = None
     resource_id__in: Optional[List[str]] = None
     relation: Optional[str] = None
     relation__contains: Optional[List[str]] = None
     relation__in: Optional[List[str]] = None
-    subject_namespace: Optional[str] = None
-    subject_namespace__contains: Optional[List[str]] = None
-    subject_namespace__in: Optional[List[str]] = None
+    subject_type: Optional[str] = None
+    subject_type__contains: Optional[List[str]] = None
+    subject_type__in: Optional[List[str]] = None
     subject_id: Optional[str] = None
     subject_id__contains: Optional[List[str]] = None
     subject_id__in: Optional[List[str]] = None
@@ -111,7 +111,7 @@ class CheckRequest(APIRequestModel):
 
 
 class DebugPath(APIResponseModel):
-    namespace: str
+    type: str
     id: str
     action: Optional[str]
 
@@ -129,7 +129,7 @@ class CheckResult(PangeaResponseResult):
 
 
 class ListResourcesRequest(APIRequestModel):
-    namespace: str
+    type: str
     action: str
     subject: Subject
 
@@ -148,12 +148,11 @@ class ListSubjectsResult(PangeaResponseResult):
 
 
 class AuthZ(ServiceBase):
-    """AuthZ service client. (Beta)
+    """AuthZ service client.
 
     Provides methods to interact with the Pangea AuthZ Service.
     Documentation for the AuthZ Service API can be found at
-    <https://pangea.cloud/docs/api/authz>. Note that this service is in Beta and
-    is subject to change.
+    <https://pangea.cloud/docs/api/authz>.
 
     Examples:
         import os
@@ -174,11 +173,10 @@ class AuthZ(ServiceBase):
         super().__init__(token, config, logger_name, config_id=config_id)
 
     def tuple_create(self, tuples: List[Tuple]) -> PangeaResponse[TupleCreateResult]:
-        """Create tuples. (Beta)
+        """Create tuples.
 
         Create tuples in the AuthZ Service. The request will fail if there is no schema
         or the tuples do not validate against the schema.
-        How to install a [Beta release](https://pangea.cloud/docs/sdk/python/#beta-releases).
 
         Args:
             tuples (List[Tuple]): List of tuples to be created.
@@ -189,22 +187,22 @@ class AuthZ(ServiceBase):
         Returns:
             Pangea Response with empty result.
             Available response fields can be found in our
-            [API Documentation](https://pangea.cloud/docs/api/authz#/v1beta/tuple/create).
+            [API Documentation](https://pangea.cloud/docs/api/authz#/v1/tuple/create).
 
         Examples:
             response = authz.tuple_create(
                 tuples=[
                     Tuple(
-                        resource=Resource(namespace="file", id="file_1"),
+                        resource=Resource(type="file", id="file_1"),
                         relation="owner",
-                        subject=Subject(namespace="user", id="user_1"),
+                        subject=Subject(type="user", id="user_1"),
                     )
                 ]
             )
         """
 
         input_data = TupleCreateRequest(tuples=tuples)
-        return self.request.post("v1beta/tuple/create", TupleCreateResult, data=input_data.dict(exclude_none=True))
+        return self.request.post("v1/tuple/create", TupleCreateResult, data=input_data.dict(exclude_none=True))
 
     def tuple_list(
         self,
@@ -214,12 +212,11 @@ class AuthZ(ServiceBase):
         order: Optional[ItemOrder] = None,
         order_by: Optional[TupleOrderBy] = None,
     ) -> PangeaResponse[TupleListResult]:
-        """List tuples. (Beta)
+        """List tuples.
 
         Return a paginated list of filtered tuples. The filter is given in terms
         of a tuple. Fill out the fields that you want to filter. If the filter
         is empty it will return all the tuples.
-        How to install a [Beta release](https://pangea.cloud/docs/sdk/python/#beta-releases).
 
         Args:
             filter (TupleListFilter): The filter for listing tuples.
@@ -234,21 +231,20 @@ class AuthZ(ServiceBase):
         Returns:
             Pangea Response with a list of tuples and the last token.
             Available response fields can be found in our
-            [API Documentation](https://pangea.cloud/docs/api/authz#/v1beta/tuple/list).
+            [API Documentation](https://pangea.cloud/docs/api/authz#/v1/tuple/list).
 
         Examples:
-            authz.tuple_list(TupleListFilter(subject_namespace="user", subject_id="user_1"))
+            authz.tuple_list(TupleListFilter(subject_type="user", subject_id="user_1"))
         """
         input_data = TupleListRequest(
             filter=filter.dict(exclude_none=True), size=size, last=last, order=order, order_by=order_by
         )
-        return self.request.post("v1beta/tuple/list", TupleListResult, data=input_data.dict(exclude_none=True))
+        return self.request.post("v1/tuple/list", TupleListResult, data=input_data.dict(exclude_none=True))
 
     def tuple_delete(self, tuples: List[Tuple]) -> PangeaResponse[TupleDeleteResult]:
-        """Delete tuples. (Beta)
+        """Delete tuples.
 
         Delete tuples in the AuthZ Service.
-        How to install a [Beta release](https://pangea.cloud/docs/sdk/python/#beta-releases).
 
         Args:
             tuples (List[Tuple]): List of tuples to be deleted.
@@ -259,22 +255,22 @@ class AuthZ(ServiceBase):
         Returns:
             Pangea Response with empty result.
             Available response fields can be found in our
-            [API Documentation](https://pangea.cloud/docs/api/authz#/v1beta/tuple/delete).
+            [API Documentation](https://pangea.cloud/docs/api/authz#/v1/tuple/delete).
 
         Examples:
             response = authz.tuple_delete(
                 tuples=[
                     Tuple(
-                        resource=Resource(namespace="file", id="file_1"),
+                        resource=Resource(type="file", id="file_1"),
                         relation="owner",
-                        subject=Subject(namespace="user", id="user_1"),
+                        subject=Subject(type="user", id="user_1"),
                     )
                 ]
             )
         """
 
         input_data = TupleDeleteRequest(tuples=tuples)
-        return self.request.post("v1beta/tuple/delete", TupleDeleteResult, data=input_data.dict(exclude_none=True))
+        return self.request.post("v1/tuple/delete", TupleDeleteResult, data=input_data.dict(exclude_none=True))
 
     def check(
         self,
@@ -284,10 +280,9 @@ class AuthZ(ServiceBase):
         debug: Optional[bool] = None,
         attributes: Optional[Dict[str, Union[int, str]]] = None,
     ) -> PangeaResponse[CheckResult]:
-        """Perform a check request. (Beta)
+        """Perform a check request.
 
         Check if a subject has permission to perform an action on the resource.
-        How to install a [Beta release](https://pangea.cloud/docs/sdk/python/#beta-releases).
 
         Args:
             resource (Resource): The resource to check.
@@ -302,29 +297,28 @@ class AuthZ(ServiceBase):
         Returns:
             Pangea Response with the result of the check.
             Available response fields can be found in our
-            [API Documentation](https://pangea.cloud/docs/api/authz#/v1beta/check).
+            [API Documentation](https://pangea.cloud/docs/api/authz#/v1/check).
 
         Examples:
             response = authz.check(
-                resource=Resource(namespace="file", id="file_1"),
+                resource=Resource(type="file", id="file_1"),
                 action="update",
-                subject=Subject(namespace="user", id="user_1"),
+                subject=Subject(type="user", id="user_1"),
                 debug=True,
             )
         """
 
         input_data = CheckRequest(resource=resource, action=action, subject=subject, debug=debug, attributes=attributes)
-        return self.request.post("v1beta/check", CheckResult, data=input_data.dict(exclude_none=True))
+        return self.request.post("v1/check", CheckResult, data=input_data.dict(exclude_none=True))
 
-    def list_resources(self, namespace: str, action: str, subject: Subject) -> PangeaResponse[ListResourcesResult]:
-        """List resources. (Beta)
+    def list_resources(self, type: str, action: str, subject: Subject) -> PangeaResponse[ListResourcesResult]:
+        """List resources.
 
-        Given a namespace, action, and subject, list all the resources in the
-        namespace that the subject has access to the action with.
-        How to install a [Beta release](https://pangea.cloud/docs/sdk/python/#beta-releases).
+        Given a type, action, and subject, list all the resources in the
+        type that the subject has access to the action with.
 
         Args:
-            namespace (str): The namespace to filter resources.
+            type (str): The type to filter resources.
             action (str): The action to filter resources.
             subject (Subject): The subject to filter resources.
 
@@ -334,25 +328,24 @@ class AuthZ(ServiceBase):
         Returns:
             Pangea Response with a list of resource IDs.
             Available response fields can be found in our
-            [API Documentation](https://pangea.cloud/docs/api/authz#/v1beta/list-resources).
+            [API Documentation](https://pangea.cloud/docs/api/authz#/v1/list-resources).
 
         Examples:
             authz.list_resources(
-                namespace="file",
+                type="file",
                 action="update",
-                subject=Subject(namespace="user", id="user_1"),
+                subject=Subject(type="user", id="user_1"),
             )
         """
 
-        input_data = ListResourcesRequest(namespace=namespace, action=action, subject=subject)
-        return self.request.post("v1beta/list-resources", ListResourcesResult, data=input_data.dict(exclude_none=True))
+        input_data = ListResourcesRequest(type=type, action=action, subject=subject)
+        return self.request.post("v1/list-resources", ListResourcesResult, data=input_data.dict(exclude_none=True))
 
     def list_subjects(self, resource: Resource, action: str) -> PangeaResponse[ListSubjectsResult]:
-        """List subjects. (Beta)
+        """List subjects.
 
         Given a resource and an action, return the list of subjects who have
         access to the action for the given resource.
-        How to install a [Beta release](https://pangea.cloud/docs/sdk/python/#beta-releases).
 
         Args:
             resource (Resource): The resource to filter subjects.
@@ -364,14 +357,14 @@ class AuthZ(ServiceBase):
         Returns:
             Pangea Response with a list of subjects.
             Available response fields can be found in our
-            [API Documentation](https://pangea.cloud/docs/api/authz#/v1beta/list-subjects).
+            [API Documentation](https://pangea.cloud/docs/api/authz#/v1/list-subjects).
 
         Examples:
             response = authz.list_subjects(
-                resource=Resource(namespace="file", id="file_1"),
+                resource=Resource(type="file", id="file_1"),
                 action="update",
             )
         """
 
         input_data = ListSubjectsRequest(resource=resource, action=action)
-        return self.request.post("v1beta/list-subjects", ListSubjectsResult, data=input_data.dict(exclude_none=True))
+        return self.request.post("v1/list-subjects", ListSubjectsResult, data=input_data.dict(exclude_none=True))

pangea/services/base.py

@@ -1,23 +1,40 @@
 # Copyright 2022 Pangea Cyber Corporation
 # Author: Pangea Cyber Corporation
+from __future__ import annotations
 
 import copy
 import logging
 from typing import Dict, Optional, Type, Union
 
+from typing_extensions import TypeVar
+
 from pangea.asyncio.request import PangeaRequestAsync
 from pangea.config import PangeaConfig
 from pangea.exceptions import AcceptedRequestException
 from pangea.request import PangeaRequest
 from pangea.response import AttachedFile, PangeaResponse, PangeaResponseResult
 
+TResult = TypeVar("TResult", bound=PangeaResponseResult, default=PangeaResponseResult)
+
 
 class ServiceBase(object):
     service_name: str = "base"
 
     def __init__(
-        self, token, config: Optional[PangeaConfig] = None, logger_name: str = "pangea", config_id: Optional[str] = None
-    ):
+        self,
+        token: str,
+        config: PangeaConfig | None = None,
+        logger_name: str = "pangea",
+        config_id: str | None = None,
+    ) -> None:
+        """
+        Initializes a new Pangea service client.
+
+        Args:
+            token: Pangea API token.
+            config: Configuration.
+            logger_name: Logger name.
+        """
         if not token:
             raise Exception("No token provided")
 
@@ -30,11 +47,11 @@ class ServiceBase(object):
         self.request.set_extra_headers(extra_headers)
 
     @property
-    def token(self):
+    def token(self) -> str:
         return self._token
 
     @token.setter
-    def token(self, value):
+    def token(self, value: str) -> None:
         self._token = value
 
     @property
@@ -55,8 +72,8 @@ class ServiceBase(object):
         exception: Optional[AcceptedRequestException] = None,
         response: Optional[PangeaResponse] = None,
         request_id: Optional[str] = None,
-        result_class: Union[Type[PangeaResponseResult], Type[Dict]] = dict,
-    ) -> PangeaResponse:
+        result_class: Type[TResult] = PangeaResponseResult,  # type: ignore[assignment]
+    ) -> PangeaResponse[TResult]:
         """
         Poll result
 

pangea/services/file_scan.py

@@ -71,6 +71,7 @@ class FileScan(ServiceBase):
     """
 
     service_name = "file-scan"
+    version = "v1"
 
     def file_scan(
         self,

pangea/services/intel.py

@@ -839,7 +839,7 @@ class IpIntel(ServiceBase):
 
     def reputation_bulk(
         self, ips: List[str], verbose: Optional[bool] = None, raw: Optional[bool] = None, provider: Optional[str] = None
-    ) -> PangeaResponse[IPReputationResult]:
+    ) -> PangeaResponse[IPReputationBulkResult]:
         """
         Reputation V2
 
@@ -1195,7 +1195,7 @@ class UrlIntel(ServiceBase):
         verbose: Optional[bool] = None,
         raw: Optional[bool] = None,
         provider: Optional[str] = None,
-    ) -> PangeaResponse[URLReputationResult]:
+    ) -> PangeaResponse[URLReputationBulkResult]:
         """
         Reputation V2
 

pangea/services/redact.py

@@ -1,9 +1,11 @@
 # Copyright 2022 Pangea Cyber Corporation
 # Author: Pangea Cyber Corporation
+from __future__ import annotations
 
 import enum
 from typing import Dict, List, Optional, Union
 
+from pangea.config import PangeaConfig
 from pangea.response import APIRequestModel, APIResponseModel, PangeaResponse, PangeaResponseResult
 from pangea.services.base import ServiceBase
 
@@ -15,6 +17,44 @@ class RedactFormat(str, enum.Enum):
     """JSON format."""
 
 
+class RedactType(str, enum.Enum):
+    MASK = "mask"
+    PARTIAL_MASKING = "partial_masking"
+    REPLACEMENT = "replacement"
+    DETECT_ONLY = "detect_only"
+    HASH = "hash"
+    FPE = "fpe"
+
+
+class FPEAlphabet(str, enum.Enum):
+    NUMERIC = "numeric"
+    ALPHANUMERICLOWER = "alphanumericlower"
+    ALPHANUMERIC = "alphanumeric"
+
+
+class MaskingType(str, enum.Enum):
+    MASK = "mask"
+    UNMASK = "unmask"
+
+
+class PartialMasking(APIRequestModel):
+    masking_type: Optional[MaskingType] = None
+    unmasked_from_left: Optional[int] = None
+    unmasked_from_right: Optional[int] = None
+    masked_from_left: Optional[int] = None
+    masked_from_right: Optional[int] = None
+    chars_to_ignore: Optional[List[str]] = None
+    masking_char: Optional[List[str]] = None
+
+
+class RedactionMethodOverrides(APIRequestModel):
+    redaction_type: RedactType
+    hash: Optional[Dict] = None
+    fpe_alphabet: Optional[FPEAlphabet] = None
+    partial_masking: Optional[PartialMasking] = None
+    redaction_value: Optional[str] = None
+
+
 class RedactRequest(APIRequestModel):
     """
     Input class to make a redact request
@@ -25,6 +65,7 @@ class RedactRequest(APIRequestModel):
     rules: Optional[List[str]] = None
     rulesets: Optional[List[str]] = None
     return_result: Optional[bool] = None
+    redaction_method_overrides: Optional[RedactionMethodOverrides] = None
 
 
 class RecognizerResult(APIResponseModel):
@@ -92,6 +133,7 @@ class StructuredRequest(APIRequestModel):
     rules: Optional[List[str]] = None
     rulesets: Optional[List[str]] = None
     return_result: Optional[bool] = None
+    redaction_method_overrides: Optional[RedactionMethodOverrides] = None
 
 
 class StructuredResult(PangeaResponseResult):
@@ -105,6 +147,32 @@ class StructuredResult(PangeaResponseResult):
     report: Optional[DebugReport] = None
 
 
+class UnredactRequest(APIRequestModel):
+    """
+    Class input to unredact data request
+
+    Arguments:
+    redacted_data: Data to unredact
+    fpe_context (base64): FPE context used to decrypt and unredact data
+
+    """
+
+    redacted_data: RedactedData
+    fpe_context: str
+
+
+RedactedData = Union[str, Dict]
+
+
+class UnredactResult(PangeaResponseResult):
+    """
+    Result class after an unredact request
+
+    """
+
+    data: RedactedData
+
+
 class Redact(ServiceBase):
     """Redact service client.
 
@@ -132,7 +200,24 @@ class Redact(ServiceBase):
 
     service_name = "redact"
 
-    def __init__(self, token, config=None, logger_name="pangea", config_id: Optional[str] = None):
+    def __init__(
+        self, token: str, config: PangeaConfig | None = None, logger_name: str = "pangea", config_id: str | None = None
+    ) -> None:
+        """
+        Redact client
+
+        Initializes a new Redact client.
+
+        Args:
+            token: Pangea API token.
+            config: Configuration.
+            logger_name: Logger name.
+            config_id: Configuration ID.
+
+        Examples:
+             config = PangeaConfig(domain="pangea_domain")
+             redact = Redact(token="pangea_token", config=config)
+        """
         super().__init__(token, config, logger_name, config_id=config_id)
 
     def redact(
@@ -142,6 +227,7 @@ class Redact(ServiceBase):
         rules: Optional[List[str]] = None,
         rulesets: Optional[List[str]] = None,
         return_result: Optional[bool] = None,
+        redaction_method_overrides: Optional[RedactionMethodOverrides] = None,
     ) -> PangeaResponse[RedactResult]:
         """
         Redact
@@ -157,6 +243,7 @@ class Redact(ServiceBase):
             rules (list[str], optional): An array of redact rule short names
             rulesets (list[str], optional): An array of redact rulesets short names
             return_result(bool, optional): Setting this value to false will omit the redacted result only returning count
+            redaction_method_overrides: A set of redaction method overrides for any enabled rule. These methods override the config declared methods
 
         Raises:
             PangeaAPIException: If an API Error happens
@@ -170,7 +257,14 @@ class Redact(ServiceBase):
             response = redact.redact(text="Jenny Jenny... 555-867-5309")
         """
 
-        input = RedactRequest(text=text, debug=debug, rules=rules, rulesets=rulesets, return_result=return_result)
+        input = RedactRequest(
+            text=text,
+            debug=debug,
+            rules=rules,
+            rulesets=rulesets,
+            return_result=return_result,
+            redaction_method_overrides=redaction_method_overrides,
+        )
         return self.request.post("v1/redact", RedactResult, data=input.dict(exclude_none=True))
 
     def redact_structured(
@@ -182,6 +276,7 @@ class Redact(ServiceBase):
         rules: Optional[List[str]] = None,
         rulesets: Optional[List[str]] = None,
         return_result: Optional[bool] = None,
+        redaction_method_overrides: Optional[RedactionMethodOverrides] = None,
     ) -> PangeaResponse[StructuredResult]:
         """
         Redact structured
@@ -201,6 +296,7 @@ class Redact(ServiceBase):
             rules (list[str], optional): An array of redact rule short names
             rulesets (list[str], optional): An array of redact rulesets short names
             return_result(bool, optional): Setting this value to false will omit the redacted result only returning count
+            redaction_method_overrides: A set of redaction method overrides for any enabled rule. These methods override the config declared methods
 
         Raises:
             PangeaAPIException: If an API Error happens
@@ -227,5 +323,29 @@ class Redact(ServiceBase):
             rules=rules,
             rulesets=rulesets,
             return_result=return_result,
+            redaction_method_overrides=redaction_method_overrides,
         )
         return self.request.post("v1/redact_structured", StructuredResult, data=input.dict(exclude_none=True))
+
+    def unredact(self, redacted_data: RedactedData, fpe_context: str) -> PangeaResponse[UnredactResult]:
+        """
+        Unredact
+
+        Decrypt or unredact fpe redactions
+
+        OperationId: redact_post_v1_unredact
+
+        Args:
+            redacted_data: Data to unredact
+            fpe_context (base64): FPE context used to decrypt and unredact data
+
+        Raises:
+            PangeaAPIException: If an API Error happens
+
+        Returns:
+            Pangea Response with redacted data in the response.result field,
+                available response fields can be found in our
+                [API Documentation](https://pangea.cloud/docs/api/redact#unredact)
+        """
+        input = UnredactRequest(redacted_data=redacted_data, fpe_context=fpe_context)
+        return self.request.post("v1/unredact", UnredactResult, data=input.dict(exclude_none=True))