pangea-sdk 3.9.0__py3-none-any.whl → 4.1.0__py3-none-any.whl

pangea/services/authz.py

@@ -113,7 +113,7 @@ class CheckRequest(APIRequestModel):
 class DebugPath(APIResponseModel):
     type: str
     id: str
-    action: Optional[str]
+    action: Optional[str] = None
 
 
 class Debug(APIResponseModel):
@@ -202,7 +202,7 @@ class AuthZ(ServiceBase):
         """
 
         input_data = TupleCreateRequest(tuples=tuples)
-        return self.request.post("v1/tuple/create", TupleCreateResult, data=input_data.dict(exclude_none=True))
+        return self.request.post("v1/tuple/create", TupleCreateResult, data=input_data.model_dump(exclude_none=True))
 
     def tuple_list(
         self,
@@ -237,9 +237,9 @@ class AuthZ(ServiceBase):
             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
+            filter=filter.model_dump(exclude_none=True), size=size, last=last, order=order, order_by=order_by
         )
-        return self.request.post("v1/tuple/list", TupleListResult, data=input_data.dict(exclude_none=True))
+        return self.request.post("v1/tuple/list", TupleListResult, data=input_data.model_dump(exclude_none=True))
 
     def tuple_delete(self, tuples: List[Tuple]) -> PangeaResponse[TupleDeleteResult]:
         """Delete tuples.
@@ -270,7 +270,7 @@ class AuthZ(ServiceBase):
         """
 
         input_data = TupleDeleteRequest(tuples=tuples)
-        return self.request.post("v1/tuple/delete", TupleDeleteResult, data=input_data.dict(exclude_none=True))
+        return self.request.post("v1/tuple/delete", TupleDeleteResult, data=input_data.model_dump(exclude_none=True))
 
     def check(
         self,
@@ -309,7 +309,7 @@ class AuthZ(ServiceBase):
         """
 
         input_data = CheckRequest(resource=resource, action=action, subject=subject, debug=debug, attributes=attributes)
-        return self.request.post("v1/check", CheckResult, data=input_data.dict(exclude_none=True))
+        return self.request.post("v1/check", CheckResult, data=input_data.model_dump(exclude_none=True))
 
     def list_resources(self, type: str, action: str, subject: Subject) -> PangeaResponse[ListResourcesResult]:
         """List resources.
@@ -339,7 +339,9 @@ class AuthZ(ServiceBase):
         """
 
         input_data = ListResourcesRequest(type=type, action=action, subject=subject)
-        return self.request.post("v1/list-resources", ListResourcesResult, data=input_data.dict(exclude_none=True))
+        return self.request.post(
+            "v1/list-resources", ListResourcesResult, data=input_data.model_dump(exclude_none=True)
+        )
 
     def list_subjects(self, resource: Resource, action: str) -> PangeaResponse[ListSubjectsResult]:
         """List subjects.
@@ -367,4 +369,4 @@ class AuthZ(ServiceBase):
         """
 
         input_data = ListSubjectsRequest(resource=resource, action=action)
-        return self.request.post("v1/list-subjects", ListSubjectsResult, data=input_data.dict(exclude_none=True))
+        return self.request.post("v1/list-subjects", ListSubjectsResult, data=input_data.model_dump(exclude_none=True))

pangea/services/embargo.py

@@ -103,7 +103,7 @@ class Embargo(ServiceBase):
             response = embargo.ip_check("190.6.64.94")
         """
         input = IPCheckRequest(ip=ip)
-        return self.request.post("v1/ip/check", EmbargoResult, data=input.dict())
+        return self.request.post("v1/ip/check", EmbargoResult, data=input.model_dump())
 
     def iso_check(self, iso_code: str) -> PangeaResponse[EmbargoResult]:
         """
@@ -130,4 +130,4 @@ class Embargo(ServiceBase):
             response = embargo.iso_check("CU")
         """
         input = ISOCheckRequest(iso_code=iso_code)
-        return self.request.post("v1/iso/check", result_class=EmbargoResult, data=input.dict())
+        return self.request.post("v1/iso/check", result_class=EmbargoResult, data=input.model_dump())

pangea/services/file_scan.py

@@ -142,7 +142,7 @@ class FileScan(ServiceBase):
             transfer_method=transfer_method,
             source_url=source_url,
         )
-        data = input.dict(exclude_none=True)
+        data = input.model_dump(exclude_none=True)
         return self.request.post("v1/scan", FileScanResult, data=data, files=files, poll_result=sync_call)
 
     def request_upload_url(
@@ -164,7 +164,7 @@ class FileScan(ServiceBase):
             input.sha256 = params.sha256_hex
             input.size = params.size
 
-        data = input.dict(exclude_none=True)
+        data = input.model_dump(exclude_none=True)
         return self.request.request_presigned_url("v1/scan", FileScanResult, data=data)
 
 

pangea/services/intel.py

@@ -524,7 +524,7 @@ class FileIntel(ServiceBase):
             )
         """
         input = FileReputationRequest(hash=hash, hash_type=hash_type, verbose=verbose, raw=raw, provider=provider)
-        return self.request.post("v1/reputation", FileReputationResult, data=input.dict(exclude_none=True))
+        return self.request.post("v1/reputation", FileReputationResult, data=input.model_dump(exclude_none=True))
 
     def hash_reputation_bulk(
         self,
@@ -563,7 +563,7 @@ class FileIntel(ServiceBase):
         input = FileReputationBulkRequest(  # type: ignore[call-arg]
             hashes=hashes, hash_type=hash_type, verbose=verbose, raw=raw, provider=provider
         )
-        return self.request.post("v2/reputation", FileReputationBulkResult, data=input.dict(exclude_none=True))
+        return self.request.post("v2/reputation", FileReputationBulkResult, data=input.model_dump(exclude_none=True))
 
     def filepath_reputation(
         self,
@@ -708,7 +708,7 @@ class DomainIntel(ServiceBase):
             )
         """
         input = DomainReputationRequest(domain=domain, verbose=verbose, provider=provider, raw=raw)
-        return self.request.post("v1/reputation", DomainReputationResult, data=input.dict(exclude_none=True))
+        return self.request.post("v1/reputation", DomainReputationResult, data=input.model_dump(exclude_none=True))
 
     def reputation_bulk(
         self,
@@ -744,7 +744,7 @@ class DomainIntel(ServiceBase):
             )
         """
         input = DomainReputationBulkRequest(domains=domains, verbose=verbose, provider=provider, raw=raw)
-        return self.request.post("v2/reputation", DomainReputationBulkResult, data=input.dict(exclude_none=True))
+        return self.request.post("v2/reputation", DomainReputationBulkResult, data=input.model_dump(exclude_none=True))
 
     def who_is(
         self, domain: str, verbose: Optional[bool] = None, raw: Optional[bool] = None, provider: Optional[str] = None
@@ -776,7 +776,7 @@ class DomainIntel(ServiceBase):
             )
         """
         input = DomainWhoIsRequest(domain=domain, verbose=verbose, provider=provider, raw=raw)  # type: ignore[call-arg]
-        return self.request.post("v1/whois", DomainWhoIsResult, data=input.dict(exclude_none=True))
+        return self.request.post("v1/whois", DomainWhoIsResult, data=input.model_dump(exclude_none=True))
 
 
 class IpIntel(ServiceBase):
@@ -835,7 +835,7 @@ class IpIntel(ServiceBase):
             )
         """
         input = IPReputationRequest(ip=ip, verbose=verbose, raw=raw, provider=provider)
-        return self.request.post("v1/reputation", IPReputationResult, data=input.dict(exclude_none=True))
+        return self.request.post("v1/reputation", IPReputationResult, data=input.model_dump(exclude_none=True))
 
     def reputation_bulk(
         self, ips: List[str], verbose: Optional[bool] = None, raw: Optional[bool] = None, provider: Optional[str] = None
@@ -867,7 +867,7 @@ class IpIntel(ServiceBase):
             )
         """
         input = IPReputationBulkRequest(ips=ips, verbose=verbose, raw=raw, provider=provider)
-        return self.request.post("v2/reputation", IPReputationBulkResult, data=input.dict(exclude_none=True))
+        return self.request.post("v2/reputation", IPReputationBulkResult, data=input.model_dump(exclude_none=True))
 
     def geolocate(
         self, ip: str, verbose: Optional[bool] = None, raw: Optional[bool] = None, provider: Optional[str] = None
@@ -899,7 +899,7 @@ class IpIntel(ServiceBase):
             )
         """
         input = IPGeolocateRequest(ip=ip, verbose=verbose, raw=raw, provider=provider)
-        return self.request.post("v1/geolocate", IPGeolocateResult, data=input.dict(exclude_none=True))
+        return self.request.post("v1/geolocate", IPGeolocateResult, data=input.model_dump(exclude_none=True))
 
     def geolocate_bulk(
         self, ips: List[str], verbose: Optional[bool] = None, raw: Optional[bool] = None, provider: Optional[str] = None
@@ -931,7 +931,7 @@ class IpIntel(ServiceBase):
             )
         """
         input = IPGeolocateBulkRequest(ips=ips, verbose=verbose, raw=raw, provider=provider)
-        return self.request.post("v2/geolocate", IPGeolocateBulkResult, data=input.dict(exclude_none=True))
+        return self.request.post("v2/geolocate", IPGeolocateBulkResult, data=input.model_dump(exclude_none=True))
 
     def get_domain(
         self, ip: str, verbose: Optional[bool] = None, raw: Optional[bool] = None, provider: Optional[str] = None
@@ -963,7 +963,7 @@ class IpIntel(ServiceBase):
             )
         """
         input = IPDomainRequest(ip=ip, verbose=verbose, raw=raw, provider=provider)
-        return self.request.post("v1/domain", IPDomainResult, data=input.dict(exclude_none=True))
+        return self.request.post("v1/domain", IPDomainResult, data=input.model_dump(exclude_none=True))
 
     def get_domain_bulk(
         self, ips: List[str], verbose: Optional[bool] = None, raw: Optional[bool] = None, provider: Optional[str] = None
@@ -995,7 +995,7 @@ class IpIntel(ServiceBase):
             )
         """
         input = IPDomainBulkRequest(ips=ips, verbose=verbose, raw=raw, provider=provider)
-        return self.request.post("v2/domain", IPDomainBulkResult, data=input.dict(exclude_none=True))
+        return self.request.post("v2/domain", IPDomainBulkResult, data=input.model_dump(exclude_none=True))
 
     def is_vpn(
         self, ip: str, verbose: Optional[bool] = None, raw: Optional[bool] = None, provider: Optional[str] = None
@@ -1027,7 +1027,7 @@ class IpIntel(ServiceBase):
             )
         """
         input = IPVPNRequest(ip=ip, verbose=verbose, raw=raw, provider=provider)
-        return self.request.post("v1/vpn", IPVPNResult, data=input.dict(exclude_none=True))
+        return self.request.post("v1/vpn", IPVPNResult, data=input.model_dump(exclude_none=True))
 
     def is_vpn_bulk(
         self, ips: List[str], verbose: Optional[bool] = None, raw: Optional[bool] = None, provider: Optional[str] = None
@@ -1059,7 +1059,7 @@ class IpIntel(ServiceBase):
             )
         """
         input = IPVPNBulkRequest(ips=ips, verbose=verbose, raw=raw, provider=provider)
-        return self.request.post("v2/vpn", IPVPNBulkResult, data=input.dict(exclude_none=True))
+        return self.request.post("v2/vpn", IPVPNBulkResult, data=input.model_dump(exclude_none=True))
 
     def is_proxy(
         self, ip: str, verbose: Optional[bool] = None, raw: Optional[bool] = None, provider: Optional[str] = None
@@ -1091,7 +1091,7 @@ class IpIntel(ServiceBase):
             )
         """
         input = IPProxyRequest(ip=ip, verbose=verbose, raw=raw, provider=provider)
-        return self.request.post("v1/proxy", IPProxyResult, data=input.dict(exclude_none=True))
+        return self.request.post("v1/proxy", IPProxyResult, data=input.model_dump(exclude_none=True))
 
     def is_proxy_bulk(
         self, ips: List[str], verbose: Optional[bool] = None, raw: Optional[bool] = None, provider: Optional[str] = None
@@ -1123,7 +1123,7 @@ class IpIntel(ServiceBase):
             )
         """
         input = IPProxyBulkRequest(ips=ips, verbose=verbose, raw=raw, provider=provider)
-        return self.request.post("v2/proxy", IPProxyBulkResult, data=input.dict(exclude_none=True))
+        return self.request.post("v2/proxy", IPProxyBulkResult, data=input.model_dump(exclude_none=True))
 
 
 class UrlIntel(ServiceBase):
@@ -1187,7 +1187,7 @@ class UrlIntel(ServiceBase):
         """
 
         input = URLReputationRequest(url=url, provider=provider, verbose=verbose, raw=raw)
-        return self.request.post("v1/reputation", URLReputationResult, data=input.dict(exclude_none=True))
+        return self.request.post("v1/reputation", URLReputationResult, data=input.model_dump(exclude_none=True))
 
     def reputation_bulk(
         self,
@@ -1224,7 +1224,7 @@ class UrlIntel(ServiceBase):
         """
 
         input = URLReputationBulkRequest(urls=urls, provider=provider, verbose=verbose, raw=raw)
-        return self.request.post("v2/reputation", URLReputationBulkResult, data=input.dict(exclude_none=True))
+        return self.request.post("v2/reputation", URLReputationBulkResult, data=input.model_dump(exclude_none=True))
 
 
 class UserBreachedRequest(IntelCommonRequest):
@@ -1431,7 +1431,7 @@ class UserIntel(ServiceBase):
             verbose=verbose,
             raw=raw,
         )
-        return self.request.post("v1/user/breached", UserBreachedResult, data=input.dict(exclude_none=True))
+        return self.request.post("v1/user/breached", UserBreachedResult, data=input.model_dump(exclude_none=True))
 
     def user_breached_bulk(
         self,
@@ -1490,7 +1490,7 @@ class UserIntel(ServiceBase):
             verbose=verbose,
             raw=raw,
         )
-        return self.request.post("v2/user/breached", UserBreachedBulkResult, data=input.dict(exclude_none=True))
+        return self.request.post("v2/user/breached", UserBreachedBulkResult, data=input.model_dump(exclude_none=True))
 
     def password_breached(
         self,
@@ -1532,7 +1532,9 @@ class UserIntel(ServiceBase):
         input = UserPasswordBreachedRequest(
             hash_type=hash_type, hash_prefix=hash_prefix, provider=provider, verbose=verbose, raw=raw
         )
-        return self.request.post("v1/password/breached", UserPasswordBreachedResult, data=input.dict(exclude_none=True))
+        return self.request.post(
+            "v1/password/breached", UserPasswordBreachedResult, data=input.model_dump(exclude_none=True)
+        )
 
     def password_breached_bulk(
         self,
@@ -1575,7 +1577,7 @@ class UserIntel(ServiceBase):
             hash_type=hash_type, hash_prefixes=hash_prefixes, provider=provider, verbose=verbose, raw=raw
         )
         return self.request.post(
-            "v2/password/breached", UserPasswordBreachedBulkResult, data=input.dict(exclude_none=True)
+            "v2/password/breached", UserPasswordBreachedBulkResult, data=input.model_dump(exclude_none=True)
         )
 
     class PasswordStatus(enum.Enum):

pangea/services/redact.py

@@ -265,7 +265,7 @@ class Redact(ServiceBase):
             return_result=return_result,
             redaction_method_overrides=redaction_method_overrides,
         )
-        return self.request.post("v1/redact", RedactResult, data=input.dict(exclude_none=True))
+        return self.request.post("v1/redact", RedactResult, data=input.model_dump(exclude_none=True))
 
     def redact_structured(
         self,
@@ -325,7 +325,7 @@ class Redact(ServiceBase):
             return_result=return_result,
             redaction_method_overrides=redaction_method_overrides,
         )
-        return self.request.post("v1/redact_structured", StructuredResult, data=input.dict(exclude_none=True))
+        return self.request.post("v1/redact_structured", StructuredResult, data=input.model_dump(exclude_none=True))
 
     def unredact(self, redacted_data: RedactedData, fpe_context: str) -> PangeaResponse[UnredactResult]:
         """
@@ -348,4 +348,4 @@ class Redact(ServiceBase):
                 [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))
+        return self.request.post("v1/unredact", UnredactResult, data=input.model_dump(exclude_none=True))

pangea/services/vault/models/asymmetric.py

@@ -18,6 +18,7 @@ from pangea.services.vault.models.common import (
 class AsymmetricGenerateRequest(CommonGenerateRequest):
     algorithm: AsymmetricAlgorithm
     purpose: KeyPurpose
+    exportable: Optional[bool] = None
 
 
 class AsymmetricGenerateResult(CommonGenerateResult):
@@ -31,6 +32,7 @@ class AsymmetricStoreRequest(CommonStoreRequest):
     public_key: EncodedPublicKey
     private_key: EncodedPrivateKey
     purpose: KeyPurpose
+    exportable: Optional[bool] = None
 
 
 class AsymmetricStoreResult(CommonStoreResult):

pangea/services/vault/models/common.py

@@ -1,10 +1,10 @@
 # Copyright 2022 Pangea Cyber Corporation
 # Author: Pangea Cyber Corporation
-import datetime
+
 import enum
 from typing import Dict, Generic, List, NewType, Optional, TypeVar, Union
 
-from pangea.response import APIRequestModel, PangeaResponseResult
+from pangea.response import APIRequestModel, PangeaDateTime, PangeaResponseResult
 
 # EncodedPublicKey is a PEM public key, with no further encoding (i.e. no base64)
 # It may be used for example in openssh with no further processing
@@ -173,6 +173,19 @@ class ItemState(str, enum.Enum):
         return str(self.value)
 
 
+class ExportEncryptionAlgorithm(str, enum.Enum):
+    """Algorithm of an exported public key."""
+
+    RSA4096_OAEP_SHA512 = "RSA-OAEP-4096-SHA512"
+    """RSA 4096-bit key, OAEP padding, SHA512 digest."""
+
+    def __str__(self):
+        return str(self.value)
+
+    def __repr__(self):
+        return str(self.value)
+
+
 class CommonStoreRequest(APIRequestModel):
     type: ItemType
     name: str
@@ -181,7 +194,7 @@ class CommonStoreRequest(APIRequestModel):
     tags: Optional[Tags] = None
     rotation_frequency: Optional[str] = None
     rotation_state: Optional[ItemVersionState] = None
-    expiration: Optional[datetime.datetime] = None
+    expiration: Optional[PangeaDateTime] = None
 
 
 class CommonStoreResult(PangeaResponseResult):
@@ -198,7 +211,7 @@ class CommonGenerateRequest(APIRequestModel):
     tags: Optional[Tags] = None
     rotation_frequency: Optional[str] = None
     rotation_state: Optional[ItemVersionState] = None
-    expiration: Optional[datetime.datetime] = None
+    expiration: Optional[PangeaDateTime] = None
 
 
 class CommonGenerateResult(PangeaResponseResult):
@@ -240,6 +253,8 @@ class ItemData(PangeaResponseResult):
     created_at: Optional[str] = None
     algorithm: Optional[str] = None
     purpose: Optional[str] = None
+    exportable: Optional[bool] = None
+    """Whether the key is exportable or not."""
 
 
 class InheritedSettings(PangeaResponseResult):
@@ -261,7 +276,7 @@ class ListItemData(ItemData):
 class ListResult(PangeaResponseResult):
     items: List[ListItemData] = []
     count: int
-    last: Optional[str]
+    last: Optional[str] = None
 
 
 class ListRequest(APIRequestModel):
@@ -312,7 +327,7 @@ class UpdateRequest(APIRequestModel):
     rotation_frequency: Optional[str] = None
     rotation_state: Optional[ItemVersionState] = None
     rotation_grace_period: Optional[str] = None
-    expiration: Optional[datetime.datetime] = None
+    expiration: Optional[PangeaDateTime] = None
     item_state: Optional[ItemState] = None
 
 
@@ -542,3 +557,49 @@ class DecryptTransformResult(PangeaResponseResult):
 
     plain_text: str
     """Decrypted message."""
+
+
+class ExportRequest(APIRequestModel):
+    id: str
+    """The ID of the item."""
+
+    version: Optional[int] = None
+    """The item version."""
+
+    encryption_key: Optional[str] = None
+    """Public key in pem format used to encrypt exported key(s)."""
+
+    encryption_algorithm: Optional[ExportEncryptionAlgorithm] = None
+    """The algorithm of the public key."""
+
+
+class ExportResult(PangeaResponseResult):
+    id: str
+    """The ID of the item."""
+
+    version: int
+    """The item version."""
+
+    type: str
+    """The type of the key."""
+
+    item_state: str
+    """The state of the item."""
+
+    algorithm: str
+    """The algorithm of the key."""
+
+    public_key: Optional[str] = None
+    """The public key (in PEM format)."""
+
+    private_key: Optional[str] = None
+    """The private key (in PEM format)."""
+
+    key: Optional[str] = None
+    """The key material."""
+
+    encrypted: bool
+    """
+    Whether exported key(s) are encrypted with encryption_key sent on the request or not.
+    If encrypted, the result is sent in base64, any other case they are in PEM format plain text.
+    """

pangea/services/vault/models/symmetric.py

@@ -18,6 +18,8 @@ class SymmetricStoreRequest(CommonStoreRequest):
     key: EncodedSymmetricKey
     algorithm: SymmetricAlgorithm
     purpose: KeyPurpose
+    exportable: Optional[bool] = None
+    """Whether the key is exportable or not."""
 
 
 class SymmetricStoreResult(CommonStoreResult):
@@ -28,6 +30,8 @@ class SymmetricStoreResult(CommonStoreResult):
 class SymmetricGenerateRequest(CommonGenerateRequest):
     algorithm: SymmetricAlgorithm
     purpose: KeyPurpose
+    exportable: Optional[bool] = None
+    """Whether the key is exportable or not."""
 
 
 class SymmetricGenerateResult(CommonGenerateResult):
@@ -39,7 +43,7 @@ class EncryptRequest(APIRequestModel):
     id: str
     plain_text: str
     version: Optional[int] = None
-    additional_data: Optional[str]
+    additional_data: Optional[str] = None
 
 
 class EncryptResult(PangeaResponseResult):
@@ -53,7 +57,7 @@ class DecryptRequest(APIRequestModel):
     id: str
     cipher_text: str
     version: Optional[int] = None
-    additional_data: Optional[str]
+    additional_data: Optional[str] = None
 
 
 class DecryptResult(PangeaResponseResult):