pangea-sdk 3.8.0b1__py3-none-any.whl → 5.4.0b1__py3-none-any.whl

pangea/services/vault/models/keys.py

@@ -0,0 +1,94 @@
+from __future__ import annotations
+
+from typing import Literal, Optional, Union
+
+from pangea.response import APIRequestModel, PangeaDateTime
+from pangea.services.vault.models.asymmetric import (
+    AsymmetricKeyEncryptionAlgorithm,
+    AsymmetricKeyJwtAlgorithm,
+    AsymmetricKeyPkiAlgorithm,
+    AsymmetricKeyPurpose,
+    AsymmetricKeySigningAlgorithm,
+)
+from pangea.services.vault.models.common import (
+    ItemType,
+    Metadata,
+    RequestManualRotationState,
+    RequestRotationState,
+    Tags,
+)
+from pangea.services.vault.models.symmetric import (
+    SymmetricKeyEncryptionAlgorithm,
+    SymmetricKeyFpeAlgorithm,
+    SymmetricKeyJwtAlgorithm,
+    SymmetricKeyPurpose,
+)
+
+
+class CommonGenerateRequest(APIRequestModel):
+    type: Literal[ItemType.ASYMMETRIC_KEY, ItemType.SYMMETRIC_KEY]
+    purpose: Union[AsymmetricKeyPurpose, SymmetricKeyPurpose]
+    algorithm: Union[
+        AsymmetricKeySigningAlgorithm,
+        AsymmetricKeyEncryptionAlgorithm,
+        AsymmetricKeyJwtAlgorithm,
+        AsymmetricKeyPkiAlgorithm,
+        SymmetricKeyEncryptionAlgorithm,
+        SymmetricKeyJwtAlgorithm,
+        SymmetricKeyFpeAlgorithm,
+    ]
+    name: Optional[str] = None
+    folder: Optional[str] = None
+    metadata: Optional[Metadata] = None
+    tags: Optional[Tags] = None
+    rotation_frequency: Optional[str] = None
+    rotation_state: Optional[RequestRotationState] = RequestRotationState.INHERITED
+    disabled_at: Optional[PangeaDateTime] = None
+    exportable: bool = False
+
+
+class KeyStoreRequest(APIRequestModel):
+    # Required.
+    type: Literal[ItemType.ASYMMETRIC_KEY, ItemType.SYMMETRIC_KEY]
+    purpose: Union[AsymmetricKeyPurpose, SymmetricKeyPurpose]
+    algorithm: Union[
+        AsymmetricKeySigningAlgorithm,
+        AsymmetricKeyEncryptionAlgorithm,
+        AsymmetricKeyJwtAlgorithm,
+        AsymmetricKeyPkiAlgorithm,
+        SymmetricKeyEncryptionAlgorithm,
+        SymmetricKeyJwtAlgorithm,
+        SymmetricKeyFpeAlgorithm,
+    ]
+
+    # Asymmetric.
+    public_key: Optional[str] = None
+    private_key: Optional[str] = None
+
+    # Symmetric.
+    key: Optional[str] = None
+
+    # Optional.
+    name: Optional[str] = None
+    folder: Optional[str] = None
+    metadata: Optional[Metadata] = None
+    tags: Optional[Tags] = None
+    rotation_frequency: Optional[str] = None
+    rotation_state: Optional[RequestRotationState] = RequestRotationState.INHERITED
+    disabled_at: Optional[PangeaDateTime] = None
+    exportable: bool = False
+
+
+class KeyRotateRequest(APIRequestModel):
+    # Required.
+    id: str
+
+    # Asymmetric.
+    public_key: Optional[str] = None
+    private_key: Optional[str] = None
+
+    # Symmetric.
+    key: Optional[str] = None
+
+    # Optional.
+    rotation_state: RequestManualRotationState = RequestManualRotationState.DEACTIVATED

pangea/services/vault/models/secret.py

@@ -1,15 +1,39 @@
 # Copyright 2022 Pangea Cyber Corporation
 # Author: Pangea Cyber Corporation
+from typing import Optional
+
+from typing_extensions import Literal
+
+from pangea.response import APIRequestModel, PangeaDateTime
 from pangea.services.vault.models.common import (
     CommonRotateRequest,
     CommonRotateResult,
-    CommonStoreRequest,
     CommonStoreResult,
+    Metadata,
+    Tags,
 )
 
 
-class SecretStoreRequest(CommonStoreRequest):
-    secret: str
+class SecretStoreRequest(APIRequestModel):
+    type: Literal["secret", "pangea_token", "pangea_client_secret", "pangea_platform_client_secret"]
+
+    # Secret.
+    secret: Optional[str] = None
+
+    # Pangea token.
+    token: Optional[str] = None
+
+    # Pangea client secret.
+    client_secret: Optional[str] = None
+    client_id: Optional[str] = None
+    client_secret_id: Optional[str] = None
+
+    # Optional.
+    name: Optional[str] = None
+    folder: Optional[str] = None
+    metadata: Optional[Metadata] = None
+    tags: Optional[Tags] = None
+    disabled_at: Optional[PangeaDateTime] = None
 
 
 class SecretStoreResult(CommonStoreResult):

pangea/services/vault/models/symmetric.py

@@ -1,23 +1,14 @@
 # Copyright 2022 Pangea Cyber Corporation
 # Author: Pangea Cyber Corporation
-from typing import Optional
+from __future__ import annotations
 
-from pangea.response import APIRequestModel, PangeaResponseResult
-from pangea.services.vault.models.common import (
-    CommonGenerateRequest,
-    CommonGenerateResult,
-    CommonStoreRequest,
-    CommonStoreResult,
-    EncodedSymmetricKey,
-    KeyPurpose,
-    SymmetricAlgorithm,
-)
+from enum import Enum
+from typing import List, Optional, Union
 
+from typing_extensions import Literal
 
-class SymmetricStoreRequest(CommonStoreRequest):
-    key: EncodedSymmetricKey
-    algorithm: SymmetricAlgorithm
-    purpose: KeyPurpose
+from pangea.response import APIRequestModel, PangeaResponseResult
+from pangea.services.vault.models.common import CommonGenerateResult, CommonStoreResult, ItemType, ItemVersion, Key
 
 
 class SymmetricStoreResult(CommonStoreResult):
@@ -25,11 +16,6 @@ class SymmetricStoreResult(CommonStoreResult):
     purpose: str
 
 
-class SymmetricGenerateRequest(CommonGenerateRequest):
-    algorithm: SymmetricAlgorithm
-    purpose: KeyPurpose
-
-
 class SymmetricGenerateResult(CommonGenerateResult):
     algorithm: str
     purpose: str
@@ -39,25 +25,85 @@ class EncryptRequest(APIRequestModel):
     id: str
     plain_text: str
     version: Optional[int] = None
-    additional_data: Optional[str]
+    additional_data: Optional[str] = None
 
 
 class EncryptResult(PangeaResponseResult):
     id: str
+    """The ID of the item."""
+
     version: int
+    """The item version."""
+
     algorithm: str
+    """The algorithm of the key."""
+
     cipher_text: str
+    """The encrypted message (Base64 encoded)."""
 
 
 class DecryptRequest(APIRequestModel):
     id: str
     cipher_text: str
     version: Optional[int] = None
-    additional_data: Optional[str]
+    additional_data: Optional[str] = None
 
 
 class DecryptResult(PangeaResponseResult):
     id: str
+    """The ID of the item."""
+
     version: int
+    """The item version."""
+
     algorithm: str
+    """The algorithm of the key."""
+
     plain_text: str
+    """The decrypted message."""
+
+
+class SymmetricKeyPurpose(str, Enum):
+    """The purpose of a symmetric key."""
+
+    ENCRYPTION = "encryption"
+    JWT = "jwt"
+    FPE = "fpe"
+    """Format-preserving encryption."""
+
+
+class SymmetricKeyEncryptionAlgorithm(str, Enum):
+    AES_CFB_128 = "AES-CFB-128"
+    AES_CFB_256 = "AES-CFB-256"
+    AES_GCM_256 = "AES-GCM-256"
+    AES_CBC_128 = "AES-CBC-128"
+    AES_CBC_256 = "AES-CBC-256"
+
+
+class SymmetricKeyJwtAlgorithm(str, Enum):
+    HS256 = "HS256"
+    HS384 = "HS384"
+    HS512 = "HS512"
+
+
+class SymmetricKeyFpeAlgorithm(str, Enum):
+    """The algorithm of the key for purpose=`fpe` (Format Preserving Encryption)."""
+
+    AES_FF3_1_128_BETA = "AES-FF3-1-128-BETA"
+    """128-bit encryption using the FF3-1 algorithm."""
+
+    AES_FF3_1_256_BETA = "AES-FF3-1-256-BETA"
+    """256-bit encryption using the FF3-1 algorithm."""
+
+
+SymmetricKeyAlgorithm = Union[SymmetricKeyEncryptionAlgorithm, SymmetricKeyJwtAlgorithm, SymmetricKeyFpeAlgorithm]
+"""The algorithm of a symmetric key."""
+
+
+class SymmetricKeyVersion(ItemVersion):
+    pass
+
+
+class SymmetricKey(Key):
+    type: Literal[ItemType.SYMMETRIC_KEY] = ItemType.SYMMETRIC_KEY
+    item_versions: List[SymmetricKeyVersion]