pangea-sdk 3.7.0__py3-none-any.whl → 3.8.0__py3-none-any.whl

pangea/services/audit/models.py

@@ -1,8 +1,10 @@
 # Copyright 2022 Pangea Cyber Corporation
 # Author: Pangea Cyber Corporation
+from __future__ import annotations
+
 import datetime
 import enum
-from typing import Any, Dict, List, Optional, Union
+from typing import Any, Dict, List, Optional, Sequence, Union
 
 from pangea.response import APIRequestModel, APIResponseModel, PangeaResponseResult
 
@@ -19,14 +21,14 @@ class EventVerification(str, enum.Enum):
         return str(self.value)
 
 
-class Event(dict):
+class Event(Dict[str, Any]):
     """
     Event to perform an auditable activity
 
     Auxiliary class to be compatible with older SDKs
     """
 
-    def __init__(self, **data):
+    def __init__(self, **data) -> None:
         super().__init__(**data)
 
     @property
@@ -206,7 +208,7 @@ class SearchRestriction(APIResponseModel):
     Arguments:
     actor -- List of actors to include in search. If empty include all.
     action -- List of action to include in search. If empty include all.
-    source -- List of sourcers to include in search. If empty include all.
+    source -- List of sources to include in search. If empty include all.
     status -- List of status to include in search. If empty include all.
     target -- List of targets to include in search. If empty include all.
     """
@@ -279,7 +281,7 @@ class SearchRequest(APIRequestModel):
     end: Optional[str] = None
     limit: Optional[int] = None
     max_results: Optional[int] = None
-    search_restriction: Optional[dict] = None
+    search_restriction: Optional[Dict[str, Sequence[str]]] = None
     verbose: Optional[bool] = None
 
 
@@ -373,7 +375,24 @@ class SearchEvent(APIResponseModel):
     signature_verification: EventVerification = EventVerification.NONE
 
 
-class SearchOutput(PangeaResponseResult):
+class SearchResultOutput(PangeaResponseResult):
+    """
+    Return class after a pagination search
+
+    Arguments:
+    count -- The total number of results that were returned by the search.
+    events -- A list of matching audit records.
+    root -- A root of a Merkle Tree.
+    unpublished_root -- Root of a unpublished Merkle Tree
+    """
+
+    count: int
+    events: List[SearchEvent]
+    root: Optional[Root] = None
+    unpublished_root: Optional[Root] = None
+
+
+class SearchOutput(SearchResultOutput):
     """
     Result class after an audit search action
 
@@ -386,12 +405,8 @@ class SearchOutput(PangeaResponseResult):
     unpublished_root -- Root of a unpublished Merkle Tree
     """
 
-    count: int
-    events: List[SearchEvent]
     id: str
     expires_at: datetime.datetime
-    root: Optional[Root] = None
-    unpublished_root: Optional[Root] = None
 
 
 class SearchResultRequest(APIRequestModel):
@@ -402,25 +417,72 @@ class SearchResultRequest(APIRequestModel):
     id -- A search results identifier returned by the search call.
     limit -- Number of audit records to include from the first page of the results.
     offset -- Offset from the start of the result set to start returning results from.
+    assert_search_restriction -- Assert the requested search results were queried with the exact same search restrictions, to ensure the results comply to the expected restrictions.
     """
 
     id: str
     limit: Optional[int] = 20
     offset: Optional[int] = 0
+    assert_search_restriction: Optional[Dict[str, Sequence[str]]] = None
 
 
-class SearchResultOutput(PangeaResponseResult):
+class DownloadFormat(str, enum.Enum):
+    JSON = "json"
+    """JSON."""
+
+    CSV = "csv"
+    """CSV."""
+
+    def __str__(self):
+        return str(self.value)
+
+    def __repr__(self):
+        return str(self.value)
+
+
+class DownloadRequest(APIRequestModel):
+    request_id: Optional[str] = None
+    """ID returned by the export API."""
+
+    result_id: Optional[str] = None
+    """ID returned by the search API."""
+
+    format: Optional[str] = None
+    """Format for the records."""
+
+
+class DownloadResult(PangeaResponseResult):
+    dest_url: str
+    """URL where search results can be downloaded."""
+
+    expires_at: str
+    """
+    The time when the results will no longer be available to page through via
+    the results API.
     """
-    Return class after a pagination search
 
-    Arguments:
-    count -- The total number of results that were returned by the search.
-    events -- A list of matching audit records.
-    root -- A root of a Merkle Tree.
-    unpublished_root -- Root of a unpublished Merkle Tree
+
+class ExportRequest(APIRequestModel):
+    format: DownloadFormat = DownloadFormat.CSV
+    """Format for the records."""
+
+    start: Optional[datetime.datetime] = None
+    """The start of the time range to perform the search on."""
+
+    end: Optional[datetime.datetime] = None
+    """
+    The end of the time range to perform the search on. If omitted, then all
+    records up to the latest will be searched.
     """
 
-    count: int
-    events: List[SearchEvent]
-    root: Optional[Root] = None
-    unpublished_root: Optional[Root] = None
+    order_by: Optional[str] = None
+    """Name of column to sort the results by."""
+
+    order: Optional[SearchOrder] = None
+    """Specify the sort order of the response."""
+
+    verbose: bool = True
+    """
+    Whether or not to include the root hash of the tree and the membership proof
+    for each record.
+    """

pangea/services/audit/signing.py

@@ -7,6 +7,7 @@ from cryptography import exceptions
 from cryptography.hazmat.primitives import serialization
 from cryptography.hazmat.primitives.asymmetric import ed25519
 from cryptography.hazmat.primitives.asymmetric.types import PrivateKeyTypes, PublicKeyTypes
+
 from pangea.exceptions import PangeaException
 from pangea.services.audit.util import b64decode, b64decode_ascii, b64encode_ascii
 from pangea.services.vault.models.common import AsymmetricAlgorithm

pangea/services/audit/util.py

@@ -10,6 +10,7 @@ from hashlib import sha256
 from typing import Dict, List, Optional
 
 import requests
+
 from pangea.services.audit.models import Event, EventEnvelope, PublishedRoot
 from pangea.utils import default_encoder, format_datetime
 

pangea/services/authn/authn.py

@@ -1,9 +1,11 @@
 # Copyright 2022 Pangea Cyber Corporation
 # Author: Pangea Cyber Corporation
+from __future__ import annotations
 
 from typing import Dict, List, Optional, Union
 
 import pangea.services.authn.models as m
+from pangea.config import PangeaConfig
 from pangea.response import PangeaResponse
 from pangea.services.base import ServiceBase
 
@@ -37,10 +39,24 @@ class AuthN(ServiceBase):
 
     def __init__(
         self,
-        token,
-        config=None,
-        logger_name="pangea",
-    ):
+        token: str,
+        config: PangeaConfig | None = None,
+        logger_name: str = "pangea",
+    ) -> None:
+        """
+        AuthN client
+
+        Initializes a new AuthN client.
+
+        Args:
+            token: Pangea API token.
+            config: Configuration.
+            logger_name: Logger name.
+
+        Examples:
+             config = PangeaConfig(domain="pangea_domain")
+             authn = AuthN(token="pangea_token", config=config)
+        """
         super().__init__(token, config, logger_name=logger_name)
         self.user = AuthN.User(token, config, logger_name=logger_name)
         self.flow = AuthN.Flow(token, config, logger_name=logger_name)
@@ -113,6 +129,10 @@ class AuthN(ServiceBase):
             Examples:
                 response = authn.session.list()
             """
+
+            if isinstance(filter, dict):
+                filter = m.SessionListFilter(**filter)
+
             input = m.SessionListRequest(filter=filter, last=last, order=order, order_by=order_by, size=size)
             return self.request.post("v2/session/list", m.SessionListResults, data=input.dict(exclude_none=True))
 
@@ -267,6 +287,10 @@ class AuthN(ServiceBase):
                         token="ptu_wuk7tvtpswyjtlsx52b7yyi2l7zotv4a",
                     )
                 """
+
+                if isinstance(filter, dict):
+                    filter = m.SessionListFilter(**filter)
+
                 input = m.ClientSessionListRequest(
                     token=token, filter=filter, last=last, order=order, order_by=order_by, size=size
                 )
@@ -589,6 +613,10 @@ class AuthN(ServiceBase):
             Examples:
                 response = authn.user.list()
             """
+
+            if isinstance(filter, dict):
+                filter = m.UserListFilter(**filter)
+
             input = m.UserListRequest(
                 filter=filter,
                 last=last,
@@ -638,6 +666,9 @@ class AuthN(ServiceBase):
                 Examples:
                     response = authn.user.invites.list()
                 """
+                if isinstance(filter, dict):
+                    filter = m.UserInviteListFilter(**filter)
+
                 input = m.UserInviteListRequest(filter=filter, last=last, order=order, order_by=order_by, size=size)
                 return self.request.post(
                     "v2/user/invite/list", m.UserInviteListResult, data=input.dict(exclude_none=True)
@@ -1061,6 +1092,9 @@ class AuthN(ServiceBase):
                 response = authn.agreements.list()
             """
 
+            if isinstance(filter, dict):
+                filter = m.AgreementListFilter(**filter)
+
             input = m.AgreementListRequest(filter=filter, last=last, order=order, order_by=order_by, size=size)
             return self.request.post("v2/agreements/list", m.AgreementListResult, data=input.dict(exclude_none=True))
 

pangea/services/authn/models.py

@@ -51,7 +51,7 @@ class Intelligence(PangeaResponseResult):
     user_intel: bool
 
 
-class SessionToken(APIResponseModel):
+class SessionToken(PangeaResponseResult):
     id: str
     type: str
     life: int
@@ -68,8 +68,8 @@ class LoginToken(SessionToken):
     token: str
 
 
-class ClientTokenCheckResult(LoginToken):
-    pass
+class ClientTokenCheckResult(SessionToken):
+    token: Optional[str]
 
 
 class IDProvider(str, enum.Enum):
@@ -234,7 +234,7 @@ class UserListFilter(APIRequestModel):
 
 
 class UserListRequest(APIRequestModel):
-    filter: Optional[Union[Dict, UserListFilter]] = None
+    filter: Optional[UserListFilter] = None
     last: Optional[str] = None
     order: Optional[ItemOrder] = None
     order_by: Optional[UserListOrderBy] = None
@@ -289,7 +289,7 @@ class UserInviterOrderBy(enum.Enum):
 
 
 class UserInviteListFilter(APIRequestModel):
-    callback: Optional[str] = None
+    callback: Optional[str]
     callback__contains: Optional[List[str]] = None
     callback__in: Optional[List[str]] = None
     created_at: Optional[str] = None
@@ -322,7 +322,7 @@ class UserInviteListFilter(APIRequestModel):
 
 
 class UserInviteListRequest(APIRequestModel):
-    filter: Optional[Union[Dict, UserInviteListFilter]] = None
+    filter: Optional[UserInviteListFilter] = None
     last: Optional[str] = None
     order: Optional[ItemOrder] = None
     order_by: Optional[UserInviterOrderBy] = None
@@ -607,7 +607,7 @@ class SessionListFilter(APIRequestModel):
 
 class ClientSessionListRequest(APIRequestModel):
     token: str
-    filter: Optional[Union[Dict, SessionListFilter]] = None
+    filter: Optional[SessionListFilter] = None
     last: Optional[str] = None
     order: Optional[ItemOrder] = None
     order_by: Optional[SessionListOrderBy] = None
@@ -663,7 +663,7 @@ class SessionInvalidateResult(PangeaResponseResult):
 
 
 class SessionListRequest(APIRequestModel):
-    filter: Optional[Union[Dict, SessionListFilter]] = None
+    filter: Optional[SessionListFilter] = None
     last: Optional[str] = None
     order: Optional[ItemOrder] = None
     order_by: Optional[SessionListOrderBy] = None
@@ -760,7 +760,7 @@ class AgreementListFilter(APIRequestModel):
 
 
 class AgreementListRequest(APIRequestModel):
-    filter: Optional[Union[Dict, AgreementListFilter]] = None
+    filter: Optional[AgreementListFilter] = None
     last: Optional[str] = None
     order: Optional[ItemOrder] = None
     order_by: Optional[AgreementListOrderBy] = None