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

pangea/services/vault/vault.py

@@ -1,8 +1,11 @@
 # Copyright 2022 Pangea Cyber Corporation
 # Author: Pangea Cyber Corporation
+from __future__ import annotations
+
 import datetime
 from typing import Dict, Optional, Union
 
+from pangea.config import PangeaConfig
 from pangea.response import PangeaResponse
 from pangea.services.base import ServiceBase
 from pangea.services.vault.models.asymmetric import (
@@ -48,8 +51,8 @@ from pangea.services.vault.models.common import (
     StateChangeRequest,
     StateChangeResult,
     SymmetricAlgorithm,
-    TDict,
     Tags,
+    TDict,
     UpdateRequest,
     UpdateResult,
 )
@@ -91,17 +94,31 @@ class Vault(ServiceBase):
         vault_config = PangeaConfig(domain="pangea.cloud")
 
         # Setup Pangea Vault service
-        vault = Vault(token=PANGEA_VAULT_TOKEN, config=audit_config)
+        vault = Vault(token=PANGEA_VAULT_TOKEN, config=vault_config)
     """
 
     service_name = "vault"
 
     def __init__(
         self,
-        token,
-        config=None,
-        logger_name="pangea",
-    ):
+        token: str,
+        config: PangeaConfig | None = None,
+        logger_name: str = "pangea",
+    ) -> None:
+        """
+        Vault client
+
+        Initializes a new Vault client.
+
+        Args:
+            token: Pangea API token.
+            config: Configuration.
+            logger_name: Logger name.
+
+        Examples:
+             config = PangeaConfig(domain="pangea_domain")
+             vault = Vault(token="pangea_token", config=config)
+        """
         super().__init__(token, config, logger_name)
 
     # Delete endpoint
@@ -866,8 +883,8 @@ class Vault(ServiceBase):
 
                 Default is `deactivated`.
             public_key (EncodedPublicKey, optional): The public key (in PEM format)
-            private_key: (EncodedPrivateKey, optional): The private key (in PEM format)
-            key: (EncodedSymmetricKey, optional): The key material (in base64)
+            private_key (EncodedPrivateKey, optional): The private key (in PEM format)
+            key (EncodedSymmetricKey, optional): The key material (in base64)
 
         Raises:
             PangeaAPIException: If an API Error happens
@@ -1216,7 +1233,7 @@ class Vault(ServiceBase):
         Args:
             id (str): The item ID.
             structured_data (dict): Structured data for applying bulk operations.
-            filter (str, optional): A filter expression for applying bulk operations to the data field.
+            filter (str): A filter expression for applying bulk operations to the data field.
             version (int, optional): The item version. Defaults to the current version.
             additional_data (str, optional): User provided authentication data.
 
@@ -1237,7 +1254,7 @@ class Vault(ServiceBase):
             )
         """
 
-        input = EncryptStructuredRequest(
+        input: EncryptStructuredRequest[TDict] = EncryptStructuredRequest(
             id=id, structured_data=structured_data, filter=filter, version=version, additional_data=additional_data
         )
         return self.request.post(
@@ -1265,7 +1282,7 @@ class Vault(ServiceBase):
         Args:
             id (str): The item ID.
             structured_data (dict): Structured data to decrypt.
-            filter (str, optional): A filter expression for applying bulk operations to the data field.
+            filter (str): A filter expression for applying bulk operations to the data field.
             version (int, optional): The item version. Defaults to the current version.
             additional_data (str, optional): User provided authentication data.
 
@@ -1286,7 +1303,7 @@ class Vault(ServiceBase):
             )
         """
 
-        input = EncryptStructuredRequest(
+        input: EncryptStructuredRequest[TDict] = EncryptStructuredRequest(
             id=id, structured_data=structured_data, filter=filter, version=version, additional_data=additional_data
         )
         return self.request.post(

pangea/utils.py

@@ -3,7 +3,6 @@ import copy
 import datetime
 import io
 import json
-from binascii import hexlify
 from collections import OrderedDict
 from hashlib import new, sha1, sha256, sha512
 
@@ -31,8 +30,8 @@ def default_encoder(obj) -> str:
         return str(obj)
 
 
-def str2str_b64(data: str):
-    return base64.b64encode(data.encode("ascii")).decode("ascii")
+def str2str_b64(data: str, encoding: str = "utf-8") -> str:
+    return base64.b64encode(data.encode(encoding)).decode("ascii")
 
 
 def dict_order_keys(data: dict) -> OrderedDict:

{pangea_sdk-3.6.1.dist-info → pangea_sdk-3.8.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pangea-sdk
-Version: 3.6.1
+Version: 3.8.0
 Summary: Pangea API SDK
 Home-page: https://pangea.cloud/docs/sdk/python/
 License: MIT
@@ -17,15 +17,15 @@ Classifier: Programming Language :: Python :: 3.11
 Classifier: Topic :: Software Development
 Classifier: Topic :: Software Development :: Libraries
 Requires-Dist: aiohttp (>=3.8.6,<4.0.0)
-Requires-Dist: alive-progress (>=2.4.1,<3.0.0)
 Requires-Dist: asyncio (>=3.4.3,<4.0.0)
-Requires-Dist: cryptography (>=41.0.6,<42.0.0)
-Requires-Dist: deprecated (>=1.2.13,<2.0.0)
+Requires-Dist: cryptography (>=42.0.7,<43.0.0)
+Requires-Dist: deprecated (>=1.2.14,<2.0.0)
 Requires-Dist: google-crc32c (>=1.5.0,<2.0.0)
-Requires-Dist: pydantic (>=1.10.2,<2.0.0)
-Requires-Dist: python-dateutil (>=2.8.2,<3.0.0)
+Requires-Dist: pydantic (>=1.10.15,<2.0.0)
+Requires-Dist: python-dateutil (>=2.9.0,<3.0.0)
 Requires-Dist: requests (>=2.31.0,<3.0.0)
-Requires-Dist: schema (>=0.7.5,<0.8.0)
+Requires-Dist: requests-toolbelt (>=1.0.0,<2.0.0)
+Requires-Dist: typing-extensions (>=4.7.1,<5.0.0)
 Project-URL: Repository, https://github.com/pangeacyber/pangea-python/tree/main/packages/pangea-sdk
 Description-Content-Type: text/markdown
 
@@ -40,10 +40,13 @@ Description-Content-Type: text/markdown
 
 # Pangea Python SDK
 
-A Python SDK for integrating with Pangea services.
+A Python SDK for integrating with Pangea services. Supports Python v3.7 and
+above.
 
 ## Installation
 
+#### GA releases
+
 Via pip:
 
 ```bash
@@ -56,10 +59,32 @@ Via poetry:
 $ poetry add pangea-sdk
 ```
 
+<a name="beta-releases"></a>
+
+#### Beta releases
+
+Pre-release versions may be available with the `b` (beta) denotation in the
+version number. These releases serve to preview beta services and APIs. Per
+Semantic Versioning, they are considered unstable and do not carry the same
+compatibility guarantees as stable releases. [Beta changelog](https://github.com/pangeacyber/pangea-python/blob/beta/CHANGELOG.md).
+
+Via pip:
+
+```bash
+$ pip3 install pangea-sdk==3.8.0b2
+```
+
+Via poetry:
+
+```bash
+$ poetry add pangea-sdk==3.8.0b2
+```
+
 ## Usage
 
 - [Documentation][]
-- [Examples][]
+- [GA Examples][]
+- [Beta Examples][]
 
 General usage would be to create a token for a service through the
 [Pangea Console][] and then construct an API client for that respective service.
@@ -203,7 +228,8 @@ It accepts multiple file formats:
 
 
    [Documentation]: https://pangea.cloud/docs/sdk/python/
-   [Examples]: https://github.com/pangeacyber/pangea-python/tree/main/examples
+   [GA Examples]: https://github.com/pangeacyber/pangea-python/tree/main/examples
+   [Beta Examples]: https://github.com/pangeacyber/pangea-python/tree/beta/examples
    [Pangea Console]: https://console.pangea.cloud/
    [Slack]: https://pangea.cloud/join-slack/
    [Secure Audit Log]: https://pangea.cloud/docs/audit

pangea_sdk-3.8.0.dist-info/RECORD

@@ -0,0 +1,46 @@
+pangea/__init__.py,sha256=Nq9RV-L96OLvLWJH-nk0U5j6zZHQQSfqGSn6nkvmzWM,200
+pangea/asyncio/request.py,sha256=uvx9d1hmYhGKvbI4ecj6kIagGhPn_4bKmHN062Zz35c,17089
+pangea/asyncio/services/__init__.py,sha256=hmySN2LoXYpHzSKLVSdVjMbpGXi5Z5iNx-fJ2Fc8W6I,320
+pangea/asyncio/services/audit.py,sha256=laWnkT9WHBmwiaoGhNxJcdDBuqZ6Ce3wz8ujdavZgfM,24866
+pangea/asyncio/services/authn.py,sha256=ubxpxCwv6ON9JWYVPCX3FYp-YzHqIuLvE9IsYPQS3-8,44760
+pangea/asyncio/services/authz.py,sha256=z4HrcxjPGZ1X5akXo-nUQ3MWge6reirwdi7d8HHAMyQ,9745
+pangea/asyncio/services/base.py,sha256=4FtKtlq74NmE9myrgIt9HMA6JDnP4mPZ6krafWr286o,2663
+pangea/asyncio/services/embargo.py,sha256=8WguyWZUaGVwGpNzic5h8QzLueirA9WpBBik4mpCTeA,3056
+pangea/asyncio/services/file_scan.py,sha256=WIKYjUNCIx6jF0vQ-KnsKYBcZh53Q5rmccTlsTPP_rY,6301
+pangea/asyncio/services/intel.py,sha256=-0xAfnlAgNH774XRHX1-zIv2nr1Xra7X8tLhuCArQhE,37647
+pangea/asyncio/services/redact.py,sha256=3yuLD-TBiaqDa3OA0PRjvG3kXAifLyrENw8j2Na64-c,5665
+pangea/asyncio/services/vault.py,sha256=m851lZLN9DHp3_r_-1onmecZoFxNHCRCi4N_j288HUY,47836
+pangea/audit_logger.py,sha256=gRkCfUUT5LDNaycwxkhZUySgY47jDfn1ZeKOul4XCQI,3842
+pangea/config.py,sha256=mQUu8GX_6weIuv3vjNdG5plppXskXYASmxMWtFQh-hc,1662
+pangea/deep_verify.py,sha256=mocaGbC6XLbMTVWxTpMv4oJtXGPWpT-SbFqT3obpiZs,8443
+pangea/deprecated.py,sha256=IjFYEVvY1E0ld0SMkEYC1o62MAleX3nnT1If2dFVbHo,608
+pangea/dump_audit.py,sha256=8KrTOP64D28RFv1mvOOxe0fxlRZi8PtwnEZfvabglNA,7019
+pangea/exceptions.py,sha256=OBtzUECpNa6vNp8ySkHC-tm4QjFRCOAHBkMHqzAlOu8,5656
+pangea/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+pangea/request.py,sha256=ZcK49SgCPvGwPGrY63UmiTo-xELu2ryPvALmPxPXkGI,24298
+pangea/response.py,sha256=egyLcl0FxEDmTrbRjHuB_DvxipfTXG0ExUS1yLBss-M,6828
+pangea/services/__init__.py,sha256=iAIa1kk_C0EHBsSn2XP3QT-bOZNGwMBPUcO2JoI-9cE,278
+pangea/services/audit/audit.py,sha256=TLGs4ALMEFpQSxC49SMVwRGRxUCslstHMBmSiDpC6mY,38006
+pangea/services/audit/exceptions.py,sha256=bhVuYe4ammacOVxwg98CChxvwZf5FKgR2DcgqILOcwc,471
+pangea/services/audit/models.py,sha256=IViO_WsDz_N8YjPD8pcAcPHWpf2aatd0-VJVl_o_8G4,13953
+pangea/services/audit/signing.py,sha256=pOjw60BIYDcg3_5YKDCMWZUaapsEZpCHaFhyFu7TEgc,5567
+pangea/services/audit/util.py,sha256=C6KAdu6qhValmNrIMUPLdAW0SCiLwcDd5euXti_63Og,7596
+pangea/services/authn/authn.py,sha256=C_u34ASbi3Ul3C6D6f4fqdajcGNPX2CfxKmcLjE016w,43750
+pangea/services/authn/models.py,sha256=FZ5kRBZQ-Pr2YD3jFZ4HvJI22ObbXaBb6HStjcN7-D0,18104
+pangea/services/authz.py,sha256=7bhTJFI4A2mnogLgBPETRabywPolgk1vI0qZJuIxoTw,12424
+pangea/services/base.py,sha256=lwhHoe5Juy28Ir3Mfj2lHdM58gxZRaxa2SRFi4_DBRw,3453
+pangea/services/embargo.py,sha256=WFqBreGU1FPgOSabIIkWCrXBvquYN958Un7h9P1aHSI,3885
+pangea/services/file_scan.py,sha256=tWR4D672Lxk_btSA1NcuUFkajbEhiCGMoTMm2bGtCj4,6942
+pangea/services/intel.py,sha256=t8SksNsh-r1JjLN3if4yNmx711hNjQ_1YzCX-96_xv0,51645
+pangea/services/redact.py,sha256=y_jZxUY4wmEQL2AbCOZLiV14GIweSJ1TUBnyHust80M,8298
+pangea/services/vault/models/asymmetric.py,sha256=ac2Exc66elXxO-HxBqtvLPQWNI7y_00kb6SVqBPKecA,1450
+pangea/services/vault/models/common.py,sha256=Ks6reIlWx3PU1lD0UlorcAlZV8U9T3j711iOsb6qp3o,11120
+pangea/services/vault/models/secret.py,sha256=cLgEj-_BeGkB4-pmSeTkWVyasFbaJwcEltIEcOyf1U8,481
+pangea/services/vault/models/symmetric.py,sha256=5N2n6FDStB1CLPfpd4p-6Ig__Nt-EyurhjCWfEyws2k,1330
+pangea/services/vault/vault.py,sha256=s_qGLDlk-LOSsODpnvo_VPtH_4HGgwCOprSCKCNaCfY,47619
+pangea/tools.py,sha256=sa2pSz-L8tB6GcZg6lghsmm8w0qMQAIkzqcv7dilU6Q,6429
+pangea/utils.py,sha256=nTrw0lcw4s0R2m_LFIoypFU4ilsBfjV1eCf_bTjJ-Lo,3489
+pangea/verify_audit.py,sha256=QthhKzFlIQwoEyjBLojcX4uHGaN3EEGomx-IC5e3L0E,10756
+pangea_sdk-3.8.0.dist-info/METADATA,sha256=Lc1OJgV2dQvDx9HmppMIjctCA4b2aKmFzFQ2r-pPPKQ,7464
+pangea_sdk-3.8.0.dist-info/WHEEL,sha256=Zb28QaM1gQi8f4VCBhsUklF61CTlNYfs9YAZn-TOGFk,88
+pangea_sdk-3.8.0.dist-info/RECORD,,

pangea_sdk-3.6.1.dist-info/RECORD

@@ -1,44 +0,0 @@
-pangea/__init__.py,sha256=BJZKp3TRjFRK2FejbgZkPIXoKJ2bJY9tDn_L9tZOpPw,200
-pangea/asyncio/request.py,sha256=iu9B9TUd2Cs1Jo7OqhtkXjcizXXx6zsLYdqlWea0QtU,13319
-pangea/asyncio/services/__init__.py,sha256=_CEDza6E9VmEs6d_vubWetfeqTogH7UxT7XrTVRw4Mo,290
-pangea/asyncio/services/audit.py,sha256=mGkNNLpE6IIKOdvTEp2GTgtoTteP0NxU8lFZKtDXw9U,16549
-pangea/asyncio/services/authn.py,sha256=HssvrZ3fr2oP5sgYBj1Rr5Yf-fKiHhrWTue5LOAeyOk,43288
-pangea/asyncio/services/base.py,sha256=we0iDbtkjP6lX-qSEFdqaNHxc2sgZ9-U2519sxsbgt8,2358
-pangea/asyncio/services/embargo.py,sha256=8WguyWZUaGVwGpNzic5h8QzLueirA9WpBBik4mpCTeA,3056
-pangea/asyncio/services/file_scan.py,sha256=741p2GW6jWX5nEOrBOdr9sozHrd3AtfXlUqM5zlYZtg,6253
-pangea/asyncio/services/intel.py,sha256=NyJPzDsBejpzItZ2C89olTbOae-paaPdzYG_U2ti42o,37643
-pangea/asyncio/services/redact.py,sha256=W9eKMw1XyY6tgRudRrtuCpyQYhgttvmsYngoiMld0C4,5152
-pangea/asyncio/services/vault.py,sha256=_kPQJWJTwKYXhPnEfxhnjOgFaC78rb0f385X6R6ksjA,47274
-pangea/audit_logger.py,sha256=gRkCfUUT5LDNaycwxkhZUySgY47jDfn1ZeKOul4XCQI,3842
-pangea/config.py,sha256=kFu9mLMkFpkM7wdT8Ymvskx6DGLfRZKeKfQRVZTgbyA,1670
-pangea/deep_verify.py,sha256=mocaGbC6XLbMTVWxTpMv4oJtXGPWpT-SbFqT3obpiZs,8443
-pangea/deprecated.py,sha256=IjFYEVvY1E0ld0SMkEYC1o62MAleX3nnT1If2dFVbHo,608
-pangea/dump_audit.py,sha256=WI5T9cUAxb_EfoPHxFYgDDW56w_HuycTMvv_OTG_7CU,7018
-pangea/exceptions.py,sha256=auw_zXkNCUBE0fWABoWXCErI378cnShIHTbkpUlmgQ0,5489
-pangea/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-pangea/request.py,sha256=y7OTGROZlnlaq1rQDd8dIiJYm_vl6xGqwASXq5w_EFw,21227
-pangea/response.py,sha256=wyClAgow0s_plDE352mad0yF1TKB3wT4D8nRHfyiqLU,5669
-pangea/services/__init__.py,sha256=auqKaEAOLiazHCzOQVwrUwd2ABFw_bF-ptoOq1bpa68,253
-pangea/services/audit/audit.py,sha256=CmndP2eSPj5XZaC8oF0EdqNFihq2CodhSJOT9XMyixk,31013
-pangea/services/audit/exceptions.py,sha256=CVdaQZCvQKx1n-iIjWz5wnStUGU6cXDwKqe7MoijAXk,451
-pangea/services/audit/models.py,sha256=Q9DyLl9wywisPFveQwtO_OKB-eVD0jUySscEbPW9I5Y,12263
-pangea/services/audit/signing.py,sha256=_28Es7gAOqhp2ebRtRZ7ZnZUoGY5mCTccWtz-LYOddk,5566
-pangea/services/audit/util.py,sha256=9alRcJbWhrrj_4phjrKd-lm4_Z48lmZ1mfjkhpFTDWw,7595
-pangea/services/authn/authn.py,sha256=sGQUPQ8VLEMtu8AkEhWPyY6Q6AxCsfrX-XNUzkC-o1M,42774
-pangea/services/authn/models.py,sha256=DuOqlwWaliyZOH5rt8c-_tvBY9NDzkHFD5fSU_3mm0U,18154
-pangea/services/base.py,sha256=Y6tzk5FkDK9bswafoxvLk5KO2bH-xdjzBo8A3d3ZmFA,2846
-pangea/services/embargo.py,sha256=F3jx7SbElnjhbDEUR3oHfWsQ8G8zf_kfp6_q1_vmOIc,3871
-pangea/services/file_scan.py,sha256=alIL4PdQXpfnC69HJyHeFT0-nPizpRVpgvZKs0q1GlU,6908
-pangea/services/intel.py,sha256=3L8WZhxCvMSLF0Oa2CRyavxruiHD84BHkEOUSutPZh4,51623
-pangea/services/redact.py,sha256=LHnFUhivLIZ5O2Ss8tYOfYxqQVY4rgdw4WUSxgFyAB0,7758
-pangea/services/vault/models/asymmetric.py,sha256=ac2Exc66elXxO-HxBqtvLPQWNI7y_00kb6SVqBPKecA,1450
-pangea/services/vault/models/common.py,sha256=-GleGqN3O4SFuPDXVeJG_Yh6axQMboIqZfKxqYDGtv0,9986
-pangea/services/vault/models/secret.py,sha256=cLgEj-_BeGkB4-pmSeTkWVyasFbaJwcEltIEcOyf1U8,481
-pangea/services/vault/models/symmetric.py,sha256=5N2n6FDStB1CLPfpd4p-6Ig__Nt-EyurhjCWfEyws2k,1330
-pangea/services/vault/vault.py,sha256=wjXPAJDRgQy3dfPBWv3tMo2XGXiMxP411lLZuajDrxs,47104
-pangea/tools.py,sha256=sa2pSz-L8tB6GcZg6lghsmm8w0qMQAIkzqcv7dilU6Q,6429
-pangea/utils.py,sha256=VUHCt2qxhobn4PsvrsqhOhOGVWR6N8sYjPZBpKxFbrI,3485
-pangea/verify_audit.py,sha256=QthhKzFlIQwoEyjBLojcX4uHGaN3EEGomx-IC5e3L0E,10756
-pangea_sdk-3.6.1.dist-info/METADATA,sha256=byKg3_B0dCPXbTsjvDupGdC5N1nft4qN7cfmd7Afi9Q,6761
-pangea_sdk-3.6.1.dist-info/WHEEL,sha256=Zb28QaM1gQi8f4VCBhsUklF61CTlNYfs9YAZn-TOGFk,88
-pangea_sdk-3.6.1.dist-info/RECORD,,