pangea-sdk 1.4.0__py3-none-any.whl → 1.5.0__py3-none-any.whl

pangea/__init__.py

@@ -1,4 +1,4 @@
-__version__ = "1.4.0"
+__version__ = "1.5.0"
 
 from pangea.config import PangeaConfig
 from pangea.request import PangeaRequest

pangea/deep_verify.py

@@ -12,7 +12,7 @@ from itertools import groupby
 import pangea.services.audit.util as audit_util
 from pangea.services import Audit
 from pangea.services.audit.models import EventEnvelope
-from pangea.tools_util import Event, SequenceFollower, exit_with_error, file_events, init_audit, print_progress_bar
+from pangea.tools import Event, SequenceFollower, exit_with_error, file_events, init_audit, print_progress_bar
 
 
 class Errors(t.TypedDict):
@@ -161,7 +161,7 @@ def deep_verify(audit: Audit, file: io.TextIOWrapper) -> Errors:
     }
 
     events = file_events(root_hashes, file)
-    events_by_idx: list[Event] | t.Iterator[Event]
+    events_by_idx: t.Union[list[Event], t.Iterator[Event]]
     cold_indexes = SequenceFollower()
     for leaf_index, events_by_idx in groupby(events, lambda event: event.get("leaf_index")):
         events_by_idx = list(events_by_idx)

pangea/dump_audit.py

@@ -11,21 +11,15 @@ from datetime import datetime
 import dateutil.parser
 from pangea.response import PangeaResponse
 from pangea.services import Audit
-from pangea.tools_util import (
-    filter_deep_none,
-    get_script_name,
-    init_audit,
-    json_defaults,
-    make_aware_datetime,
-    print_progress_bar,
-)
+from pangea.tools import filter_deep_none, get_script_name, init_audit, make_aware_datetime, print_progress_bar
+from pangea.utils import default_encoder
 
 
 def dump_event(output: io.TextIOWrapper, row: dict, resp: PangeaResponse):
     row_data = filter_deep_none(row.dict())
     if resp.result.root:
         row_data["tree_size"] = resp.result.root.size
-    output.write(json.dumps(row_data, default=json_defaults) + "\n")
+    output.write(json.dumps(row_data, default=default_encoder) + "\n")
 
 
 def dump_audit(audit: Audit, output: io.TextIOWrapper, start: datetime, end: datetime) -> int:

pangea/exceptions.py

@@ -27,11 +27,18 @@ class PangeaAPIException(PangeaException):
     def errors(self) -> List[ErrorField]:
         return self.response.errors
 
+    def __repr__(self) -> str:
+        ret = f"Summary: {self.response.summary}\n"
+        if self.response.errors:
+            ret += "Errors: \n"
+            for ef in self.response.errors:
+                ret += f"\t {ef.detail}\n"
+        return ret
+
     def __str__(self) -> str:
-        ret = "\n"
-        ret += f"Summary: {self.response.summary}\n"
+        ret = f"Summary: {self.response.summary}\n"
         if self.response.errors:
-            ret += "Errors:\n"
+            ret += "Errors: \n"
             for ef in self.response.errors:
                 ret += f"\t {ef.detail}\n"
         return ret
@@ -85,8 +92,12 @@ class ProviderErrorException(PangeaAPIException):
     """Downstream provider error"""
 
 
-class InternalServiceErrorException(PangeaAPIException):
-    """A pangea service error"""
+class InternalServerError(PangeaAPIException):
+    """A pangea server error"""
+
+    def __init__(self, response: PangeaResponse):
+        message = f"summary: {response.summary}. request_id: {response.request_id}. request_time: {response.request_time}. response_time: ${response.response_time}"
+        super().__init__(message, response)
 
 
 class ServiceNotAvailableException(PangeaAPIException):
@@ -112,3 +123,21 @@ class TreeNotFoundException(AuditAPIException):
 
 class BadOffsetException(AuditAPIException):
     """Bad offset in results search"""
+
+
+# Vault SDK specific exceptions
+class VaultException(PangeaException):
+    """Vault SDK specific exceptions"""
+
+
+# Vault API specific exceptions
+class VaultAPIException(PangeaAPIException):
+    """Vault service specific exceptions"""
+
+
+class ForbiddenVaultOperation(VaultAPIException):
+    """Forbiden Vault operation"""
+
+
+class VaultItemNotFound(VaultAPIException):
+    """Vault item not found"""

pangea/request.py

@@ -4,13 +4,14 @@
 import json
 import logging
 import time
-from typing import Optional
+from typing import Dict, Union
 
 import pangea
 import requests
 from pangea import exceptions
 from pangea.config import PangeaConfig
 from pangea.response import PangeaResponse, ResponseStatus
+from pangea.utils import default_encoder
 from requests.adapters import HTTPAdapter, Retry
 
 
@@ -76,7 +77,7 @@ class PangeaRequest(object):
 
         return self._queued_retry_enabled
 
-    def post(self, endpoint: str = "", data: dict = {}) -> PangeaResponse:
+    def post(self, endpoint: str = "", data: Union[str, Dict] = {}) -> PangeaResponse:
         """Makes the POST call to a Pangea Service endpoint.
 
         If queued_support mode is enabled, progress checks will be made for
@@ -92,14 +93,21 @@ class PangeaRequest(object):
                various properties to retrieve individual fields
         """
         url = self._url(endpoint)
-        data_send = json.dumps(data)
-
-        self.logger.debug(json.dumps({"service": self.service, "action": "post", "url": url, "data": data}))
+        data_send = json.dumps(data, default=default_encoder) if isinstance(data, dict) else data
+        self.logger.debug(
+            json.dumps({"service": self.service, "action": "post", "url": url, "data": data}, default=default_encoder)
+        )
 
         requests_response = self.session.post(url, headers=self._headers(), data=data_send)
 
         if self._queued_retry_enabled and requests_response.status_code == 202:
             response_json = requests_response.json()
+            self.logger.debug(
+                json.dumps(
+                    {"service": self.service, "action": "post", "url": url, "response": response_json},
+                    default=default_encoder,
+                )
+            )
             request_id = response_json.get("request_id", None)
 
             if not request_id:
@@ -109,6 +117,12 @@ class PangeaRequest(object):
         else:
             pangea_response = PangeaResponse(requests_response)
 
+        self.logger.debug(
+            json.dumps(
+                {"service": self.service, "action": "post", "url": url, "result": pangea_response.raw_result},
+                default=default_encoder,
+            )
+        )
         self._check_response(pangea_response)
         return pangea_response
 
@@ -126,9 +140,16 @@ class PangeaRequest(object):
         url = self._url(f"{endpoint}/{path}")
 
         self.logger.debug(json.dupms({"service": self.service, "action": "get", "url": url}))
-
         requests_response = self.session.get(url, headers=self._headers())
+
         pangea_response = PangeaResponse(requests_response)
+
+        self.logger.debug(
+            json.dumps(
+                {"service": self.service, "action": "post", "url": url, "result": pangea_response.raw_result},
+                default=default_encoder,
+            )
+        )
         self._check_response(pangea_response)
         return pangea_response
 
@@ -189,7 +210,13 @@ class PangeaRequest(object):
 
         self.logger.error(
             json.dumps(
-                {"service": self.service, "action": "api_error", "summary": summary, "result": response.raw_result}
+                {
+                    "service": self.service,
+                    "action": "api_error",
+                    "url": response.raw_response.url,
+                    "summary": summary,
+                    "result": response.raw_result,
+                }
             )
         )
 
@@ -215,6 +242,12 @@ class PangeaRequest(object):
             raise exceptions.IPNotFoundException(summary)
         elif status == ResponseStatus.BAD_OFFSET.value:
             raise exceptions.BadOffsetException(summary, response)
+        elif status == ResponseStatus.FORBIDDEN_VAULT_OPERATION.value:
+            raise exceptions.ForbiddenVaultOperation(summary, response)
+        elif status == ResponseStatus.VAULT_ITEM_NOT_FOUND.value:
+            raise exceptions.VaultItemNotFound(summary, response)
         elif status == ResponseStatus.NOT_FOUND.value:
             raise exceptions.NotFound(response.raw_response.url if response.raw_response is not None else "", response)
+        elif status == ResponseStatus.INTERNAL_SERVER_ERROR.value:
+            raise exceptions.InternalServerError(response)
         raise exceptions.PangeaAPIException(f"{summary} ", response)

pangea/response.py

@@ -1,9 +1,11 @@
 # Copyright 2022 Pangea Cyber Corporation
 # Author: Pangea Cyber Corporation
+import datetime
 import enum
 from typing import Any, Dict, Generic, List, Optional, TypeVar
 
 import requests
+from pangea.utils import format_datetime
 from pydantic import BaseModel
 
 T = TypeVar("T")
@@ -21,6 +23,9 @@ class APIResponseModel(BaseModel):
 class APIRequestModel(BaseModel):
     class Config:
         arbitrary_types_allowed = True
+        json_encoders = {
+            datetime.datetime: format_datetime,
+        }
 
 
 class PangeaResponseResult(APIResponseModel):
@@ -63,7 +68,10 @@ class ResponseStatus(str, enum.Enum):
     TREE_NOT_FOUND = "TreeNotFound"
     IP_NOT_FOUND = "IPNotFound"
     BAD_OFFSET = "BadOffset"
+    FORBIDDEN_VAULT_OPERATION = "ForbiddenVaultOperation"
+    VAULT_ITEM_NOT_FOUND = "VaultItemNotFound"
     NOT_FOUND = "NotFound"
+    INTERNAL_SERVER_ERROR = "InternalError"
 
 
 class ResponseHeader(APIResponseModel):

pangea/services/__init__.py

@@ -2,3 +2,4 @@ from .audit.audit import Audit
 from .embargo import Embargo
 from .intel import DomainIntel, FileIntel, IpIntel, UrlIntel
 from .redact import Redact
+from .vault.vault import Vault

pangea/services/audit/audit.py

@@ -1,10 +1,30 @@
 # Copyright 2022 Pangea Cyber Corporation
 # Author: Pangea Cyber Corporation
+import datetime
 from typing import Dict, Optional, Union
 
 from pangea.response import PangeaResponse
 from pangea.services.audit.exceptions import AuditException, EventCorruption
-from pangea.services.audit.models import *
+from pangea.services.audit.models import (
+    Event,
+    EventEnvelope,
+    EventSigning,
+    EventVerification,
+    LogRequest,
+    LogResult,
+    PublishedRoot,
+    Root,
+    RootRequest,
+    RootResult,
+    RootSource,
+    SearchEvent,
+    SearchOrder,
+    SearchOrderBy,
+    SearchOutput,
+    SearchRequest,
+    SearchResultOutput,
+    SearchResultRequest,
+)
 from pangea.services.audit.signing import Signer, Verifier
 from pangea.services.audit.util import (
     b64encode_ascii,
@@ -99,6 +119,7 @@ class Audit(ServiceBase):
             verify (bool, optional): True to verify logs consistency after response.
             signing (bool, optional): True to sign event.
             verbose (bool, optional): True to get a more verbose response.
+            tenant_id (string, optional): Used to record the tenant associated with this activity.
         Raises:
             AuditException: If an audit based api exception happens
             PangeaAPIException: If an API Error happens
@@ -169,7 +190,7 @@ class Audit(ServiceBase):
                 # verify event hash
                 if response.result.hash and not verify_envelope_hash(response.result.envelope, response.result.hash):
                     # it's a extreme case, it's OK to raise an exception
-                    raise EventCorruption(f"Error: Event hash failed.", response.result.envelope)
+                    raise EventCorruption("Error: Event hash failed.", response.result.envelope)
 
                 response.result.signature_verification = self.verify_signature(response.result.envelope)
 

pangea/services/audit/models.py

@@ -173,6 +173,12 @@ class SearchOrder(str, enum.Enum):
     ASC = "desc"
     DESC = "asc"
 
+    def __str__(self):
+        return str(self.value)
+
+    def __repr__(self):
+        return str(self.value)
+
 
 class SearchOrderBy(str, enum.Enum):
     ACTOR = "actor"
@@ -184,6 +190,12 @@ class SearchOrderBy(str, enum.Enum):
     TARGET = "target"
     TIMESTAMP = "timestamp"
 
+    def __str__(self):
+        return str(self.value)
+
+    def __repr__(self):
+        return str(self.value)
+
 
 class SearchRequest(APIRequestModel):
     """

pangea/services/audit/util.py

@@ -13,6 +13,7 @@ from typing import Dict, List, Optional
 
 import requests
 from pangea.services.audit.models import Event, EventEnvelope, PublishedRoot
+from pangea.utils import format_datetime
 
 Hash = bytes
 
@@ -140,7 +141,11 @@ def format_datetime(dt: datetime):
     """
     Format a datetime in ISO format, using Z instead of +00:00
     """
-    return dt.isoformat().replace("+00:00", "Z")
+    ret = dt.isoformat()
+    if dt.tzinfo is not None:
+        return ret.replace("+00:00", "Z")
+    else:
+        return ret + "Z"
 
 
 def normalize_log(audit: dict) -> dict:

pangea/services/intel.py

@@ -297,7 +297,7 @@ class FileIntel(ServiceBase):
         raw: Optional[bool] = None,
     ) -> PangeaResponse[FileReputationResult]:
         """
-        File reputation
+        Reputation check
 
         Retrieve hash-based file reputation from a provider, including an optional detailed report.
 
@@ -332,7 +332,7 @@ class FileIntel(ServiceBase):
         raw: Optional[bool] = None,
     ) -> PangeaResponse[FileReputationResult]:
         """
-        File reputation
+        Reputation check
 
         Retrieve hash-based file reputation from a provider, including an optional detailed report.
 
@@ -368,7 +368,7 @@ class FileIntel(ServiceBase):
         raw: Optional[bool] = None,
     ) -> PangeaResponse[FileReputationResult]:
         """
-        File reputation, from filepath
+        Reputation, from filepath
 
         Retrieve hash-based file reputation from a provider, including an optional detailed report.
 
@@ -405,7 +405,7 @@ class FileIntel(ServiceBase):
         raw: Optional[bool] = None,
     ) -> PangeaResponse[FileReputationResult]:
         """
-        File reputation, from filepath
+        Reputation, from filepath
 
         Retrieve hash-based file reputation from a provider, including an optional detailed report.
         This function take care of calculate filepath hash and make the request to service
@@ -468,7 +468,7 @@ class DomainIntel(ServiceBase):
         self, domain: str, verbose: Optional[bool] = None, raw: Optional[bool] = None, provider: Optional[str] = None
     ) -> PangeaResponse[DomainReputationResult]:
         """
-        Domain reputation
+        Reputation check
 
         Retrieve reputation for a domain from a provider, including an optional detailed report.
 
@@ -497,7 +497,7 @@ class DomainIntel(ServiceBase):
         self, domain: str, verbose: Optional[bool] = None, raw: Optional[bool] = None, provider: Optional[str] = None
     ) -> PangeaResponse[DomainReputationResult]:
         """
-        Domain reputation
+        Reputation check
 
         Retrieve reputation for a domain from a provider, including an optional detailed report.
 
@@ -555,7 +555,7 @@ class IpIntel(ServiceBase):
         self, ip: str, verbose: Optional[bool] = None, raw: Optional[bool] = None, provider: Optional[str] = None
     ) -> PangeaResponse[IPReputationResult]:
         """
-        IP reputation
+        Reputation
 
         Retrieve a reputation score for an IP address from a provider, including an optional detailed report.
 
@@ -585,7 +585,7 @@ class IpIntel(ServiceBase):
         self, ip: str, verbose: Optional[bool] = None, raw: Optional[bool] = None, provider: Optional[str] = None
     ) -> PangeaResponse[IPReputationResult]:
         """
-        IP reputation
+        Reputation
 
         Retrieve a reputation score for an IP address from a provider, including an optional detailed report.
 
@@ -614,13 +614,13 @@ class IpIntel(ServiceBase):
         self, ip: str, verbose: Optional[bool] = None, raw: Optional[bool] = None, provider: Optional[str] = None
     ) -> PangeaResponse[IPGeolocateResult]:
         """
-        Geolocate an IP
+        Geolocate
 
         Retrieve information about the location of an IP address.
 
         Args:
             ip (str): IP address to be geolocated
-            provider (str, optional): Use geolocation data from this provider ("digitalenvoy"). Default provider defined by the configuration.
+            provider (str, optional): Use geolocation data from this provider ("digitalelement"). Default provider defined by the configuration.
             verbose (bool, optional): Echo the API parameters in the response
             raw (bool, optional): Include raw data from this provider
 
@@ -632,7 +632,7 @@ class IpIntel(ServiceBase):
                 response.result field.  Available response fields can be found in our [API documentation](/docs/api/ip-intel)
 
         Examples:
-            response = ip_intel.geolocate(ip="93.231.182.110", provider="digitalenvoy")
+            response = ip_intel.geolocate(ip="93.231.182.110", provider="digitalelement")
         """
         input = IPGeolocateRequest(ip=ip, verbose=verbose, raw=raw, provider=provider)
         response = self.request.post("geolocate", data=input.dict(exclude_none=True))
@@ -643,13 +643,13 @@ class IpIntel(ServiceBase):
         self, ip: str, verbose: Optional[bool] = None, raw: Optional[bool] = None, provider: Optional[str] = None
     ) -> PangeaResponse[IPDomainResult]:
         """
-        Look up domain for an IP
+        Domain
 
         Retrieve the domain name associated with an IP address.
 
         Args:
             ip (str): IP address to be geolocated
-            provider (str, optional): Use geolocation data from this provider ("digitalenvoy"). Default provider defined by the configuration.
+            provider (str, optional): Use geolocation data from this provider ("digitalelement"). Default provider defined by the configuration.
             verbose (bool, optional): Echo the API parameters in the response
             raw (bool, optional): Include raw data from this provider
 
@@ -661,7 +661,7 @@ class IpIntel(ServiceBase):
                 response.result field.  Available response fields can be found in our [API documentation](/docs/api/ip-intel)
 
         Examples:
-            response = ip_intel.get_domain(ip="93.231.182.110", provider="digitalenvoy")
+            response = ip_intel.get_domain(ip="93.231.182.110", provider="digitalelement")
         """
         input = IPDomainRequest(ip=ip, verbose=verbose, raw=raw, provider=provider)
         response = self.request.post("domain", data=input.dict(exclude_none=True))
@@ -672,13 +672,13 @@ class IpIntel(ServiceBase):
         self, ip: str, verbose: Optional[bool] = None, raw: Optional[bool] = None, provider: Optional[str] = None
     ) -> PangeaResponse[IPVPNResult]:
         """
-        Check if an IP is a VPN
+        VPN
 
         Determine if an IP address is provided by a VPN service.
 
         Args:
             ip (str): IP address to be geolocated
-            provider (str, optional): Use geolocation data from this provider ("digitalenvoy"). Default provider defined by the configuration.
+            provider (str, optional): Use geolocation data from this provider ("digitalelement"). Default provider defined by the configuration.
             verbose (bool, optional): Echo the API parameters in the response
             raw (bool, optional): Include raw data from this provider
 
@@ -690,7 +690,7 @@ class IpIntel(ServiceBase):
                 response.result field.  Available response fields can be found in our [API documentation](/docs/api/ip-intel)
 
         Examples:
-            response = ip_intel.is_vpn(ip="93.231.182.110", provider="digitalenvoy")
+            response = ip_intel.is_vpn(ip="93.231.182.110", provider="digitalelement")
         """
         input = IPVPNRequest(ip=ip, verbose=verbose, raw=raw, provider=provider)
         response = self.request.post("vpn", data=input.dict(exclude_none=True))
@@ -701,13 +701,13 @@ class IpIntel(ServiceBase):
         self, ip: str, verbose: Optional[bool] = None, raw: Optional[bool] = None, provider: Optional[str] = None
     ) -> PangeaResponse[IPProxyResult]:
         """
-        Check for proxied IPs
+        Proxy
 
         Determine if an IP address is provided by a proxy service.
 
         Args:
             ip (str): IP address to be geolocated
-            provider (str, optional): Use geolocation data from this provider ("digitalenvoy"). Default provider defined by the configuration.
+            provider (str, optional): Use geolocation data from this provider ("digitalelement"). Default provider defined by the configuration.
             verbose (bool, optional): Echo the API parameters in the response
             raw (bool, optional): Include raw data from this provider
 
@@ -719,7 +719,7 @@ class IpIntel(ServiceBase):
                 response.result field.  Available response fields can be found in our [API documentation](/docs/api/ip-intel)
 
         Examples:
-            response = ip_intel.is_proxy(ip="93.231.182.110", provider="digitalenvoy")
+            response = ip_intel.is_proxy(ip="93.231.182.110", provider="digitalelement")
         """
         input = IPProxyRequest(ip=ip, verbose=verbose, raw=raw, provider=provider)
         response = self.request.post("proxy", data=input.dict(exclude_none=True))
@@ -759,7 +759,7 @@ class UrlIntel(ServiceBase):
         self, url: str, verbose: Optional[bool] = None, raw: Optional[bool] = None, provider: Optional[str] = None
     ) -> PangeaResponse[URLReputationResult]:
         """
-        URL reputation
+        Reputation check
 
         Retrieve URL address reputation from a provider.
 
@@ -789,7 +789,7 @@ class UrlIntel(ServiceBase):
         self, url: str, verbose: Optional[bool] = None, raw: Optional[bool] = None, provider: Optional[str] = None
     ) -> PangeaResponse[URLReputationResult]:
         """
-        URL reputation
+        Reputation check
 
         Retrieve URL address reputation from a provider.
 

pangea/services/vault/models/asymmetric.py

@@ -0,0 +1,67 @@
+# Copyright 2022 Pangea Cyber Corporation
+# Author: Pangea Cyber Corporation
+from typing import Optional
+
+from pangea.response import APIRequestModel, PangeaResponseResult
+from pangea.services.vault.models.common import (
+    AsymmetricAlgorithm,
+    CommonGenerateRequest,
+    CommonGenerateResult,
+    CommonStoreRequest,
+    CommonStoreResult,
+    EncodedPrivateKey,
+    EncodedPublicKey,
+    KeyPurpose,
+)
+
+
+class AsymmetricGenerateRequest(CommonGenerateRequest):
+    algorithm: AsymmetricAlgorithm
+    purpose: KeyPurpose
+
+
+class AsymmetricGenerateResult(CommonGenerateResult):
+    algorithm: str
+    purpose: str
+    public_key: EncodedPublicKey
+
+
+class AsymmetricStoreRequest(CommonStoreRequest):
+    algorithm: AsymmetricAlgorithm
+    public_key: EncodedPublicKey
+    private_key: EncodedPrivateKey
+    purpose: KeyPurpose
+
+
+class AsymmetricStoreResult(CommonStoreResult):
+    algorithm: str
+    purpose: str
+    public_key: EncodedPublicKey
+
+
+class SignRequest(APIRequestModel):
+    id: str
+    message: str
+    version: Optional[int] = None
+
+
+class SignResult(PangeaResponseResult):
+    id: str
+    version: int
+    algorithm: str
+    signature: str
+    public_key: Optional[EncodedPublicKey] = None
+
+
+class VerifyRequest(APIRequestModel):
+    id: str
+    message: str
+    signature: str
+    version: Optional[int] = None
+
+
+class VerifyResult(PangeaResponseResult):
+    id: str
+    version: int
+    algorithm: str
+    valid_signature: bool