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

pangea/services/vault/models/common.py

@@ -0,0 +1,337 @@
+# Copyright 2022 Pangea Cyber Corporation
+# Author: Pangea Cyber Corporation
+import datetime
+import enum
+from typing import Any, Dict, List, NewType, Optional, Union
+
+from pangea.response import APIRequestModel, 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
+EncodedPublicKey = NewType("EncodedPublicKey", str)
+
+# EncodedPrivateKey is a PEM private key, with no further encoding (i.e. no base64).
+# It may be used for example in openssh with no further processing
+EncodedPrivateKey = NewType("EncodedPrivateKey", str)
+
+# EncodedSymmetricKey is a base64 encoded key
+EncodedSymmetricKey = NewType("EncodedSymmetricKey", str)
+
+
+class KeyPurpose(str, enum.Enum):
+    SIGNING = "signing"
+    ENCRYPTION = "encryption"
+    JWT = "jwt"
+
+    def __str__(self):
+        return str(self.value)
+
+    def __repr__(self):
+        return str(self.value)
+
+
+class AsymmetricAlgorithm(str, enum.Enum):
+    Ed25519 = "ed25519"
+    RSA = "rsa"
+    ES256 = "es256"
+    ES384 = "es384"
+    ES512 = "es512"
+
+    def __str__(self):
+        return str(self.value)
+
+    def __repr__(self):
+        return str(self.value)
+
+
+class SymmetricAlgorithm(str, enum.Enum):
+    AES = "aes"
+    HS256 = "hs256"
+    HS384 = "hs384"
+    HS512 = "hs512"
+
+    def __str__(self):
+        return str(self.value)
+
+    def __repr__(self):
+        return str(self.value)
+
+
+Metadata = NewType("Metadata", Dict[str, str])
+Tags = NewType("Tags", List[str])
+
+
+class ItemOrder(str, enum.Enum):
+    ASC = "asc"
+    DESC = "desc"
+
+    def __str__(self):
+        return str(self.value)
+
+    def __repr__(self):
+        return str(self.value)
+
+
+class ItemOrderBy(str, enum.Enum):
+    TYPE = "type"
+    CREATED_AT = "created_at"
+    DESTROYED_AT = "destroyed_at"
+    IDENTITY = "identity"
+    PURPOSE = "purpose"
+    EXPIRATION = "expiration"
+    LAST_ROTATED = "last_rotated"
+    NEXT_ROTATION = "next_rotation"
+    NAME = "name"
+    FOLDER = "folder"
+    VERSION = "version"
+
+    def __str__(self):
+        return str(self.value)
+
+    def __repr__(self):
+        return str(self.value)
+
+
+class ItemType(str, enum.Enum):
+    ASYMMETRIC_KEY = "asymmetric_key"
+    SYMMETRIC_KEY = "symmetric_key"
+    SECRET = "secret"
+    PANGEA_TOKEN = "pangea_token"
+
+    def __str__(self):
+        return str(self.value)
+
+    def __repr__(self):
+        return str(self.value)
+
+
+class ItemVersionState(str, enum.Enum):
+    ACTIVE = "active"
+    DEACTIVATED = "deactivated"
+    SUSPENDED = "suspended"
+    COMPROMISED = "compromised"
+    DESTROYED = "destroyed"
+
+    def __str__(self):
+        return str(self.value)
+
+    def __repr__(self):
+        return str(self.value)
+
+
+class ItemState(str, enum.Enum):
+    ENABLED = "enabled"
+    DISABLED = "disabled"
+
+    def __str__(self):
+        return str(self.value)
+
+    def __repr__(self):
+        return str(self.value)
+
+
+class CommonStoreRequest(APIRequestModel):
+    type: ItemType
+    name: str
+    folder: Optional[str] = None
+    metadata: Optional[Metadata] = None
+    tags: Optional[Tags] = None
+    rotation_frequency: Optional[str] = None
+    rotation_state: Optional[ItemVersionState] = None
+    expiration: Optional[datetime.datetime] = None
+
+
+class CommonStoreResult(PangeaResponseResult):
+    id: str
+    type: str
+    version: int
+
+
+class CommonGenerateRequest(APIRequestModel):
+    type: ItemType
+    name: str
+    folder: Optional[str] = None
+    metadata: Optional[Metadata] = None
+    tags: Optional[Tags] = None
+    rotation_frequency: Optional[str] = None
+    rotation_state: Optional[ItemVersionState] = None
+    expiration: Optional[datetime.datetime] = None
+
+
+class CommonGenerateResult(PangeaResponseResult):
+    type: str
+    version: int
+    id: str
+
+
+class GetRequest(APIRequestModel):
+    id: str
+    version: Optional[Union[str, int]] = None
+    verbose: Optional[bool] = None
+    version_state: Optional[ItemVersionState] = None
+
+
+class ItemVersionData(PangeaResponseResult):
+    version: int
+    state: str
+    created_at: str
+    destroy_at: Optional[str] = None
+    public_key: Optional[EncodedPublicKey] = None
+    secret: Optional[str] = None
+
+
+class ItemData(PangeaResponseResult):
+    type: str
+    id: Optional[str] = None
+    item_state: Optional[str] = None
+    current_version: Optional[ItemVersionData] = None
+    name: Optional[str] = None
+    folder: Optional[str] = None
+    metadata: Optional[Metadata] = None
+    tags: Optional[Tags] = None
+    rotation_frequency: Optional[str] = None
+    rotation_state: Optional[str] = None
+    last_rotated: Optional[str] = None
+    next_rotation: Optional[str] = None
+    expiration: Optional[str] = None
+    created_at: Optional[str] = None
+    algorithm: Optional[str] = None
+    purpose: Optional[str] = None
+
+
+class GetResult(ItemData):
+    versions: List[ItemVersionData] = []
+    rotation_grace_period: Optional[str] = None
+
+
+class ListItemData(ItemData):
+    compromised_versions: Optional[List[ItemVersionData]] = None
+
+
+class ListResult(PangeaResponseResult):
+    items: List[ListItemData] = []
+    count: int
+    last: Optional[str]
+
+
+class ListRequest(APIRequestModel):
+    filter: Optional[Dict[str, str]] = None
+    size: Optional[int] = None
+    order: Optional[ItemOrder] = None
+    order_by: Optional[ItemOrderBy] = None
+    last: Optional[str] = None
+
+
+class CommonRotateRequest(APIRequestModel):
+    id: str
+    rotation_state: Optional[ItemVersionState] = None
+
+
+class CommonRotateResult(PangeaResponseResult):
+    id: str
+    version: int
+    type: str
+
+
+class KeyRotateRequest(CommonRotateRequest):
+    key: Optional[str] = None
+    public_key: Optional[EncodedPublicKey] = None
+    private_key: Optional[EncodedPrivateKey] = None
+
+
+class KeyRotateResult(CommonRotateResult):
+    public_key: Optional[EncodedPublicKey] = None
+    algorithm: str
+    purpose: str
+
+
+class DeleteRequest(APIRequestModel):
+    id: str
+
+
+class DeleteResult(PangeaResponseResult):
+    id: str
+
+
+class UpdateRequest(APIRequestModel):
+    id: str
+    name: Optional[str] = None
+    folder: Optional[str] = None
+    metadata: Optional[Metadata] = None
+    tags: Optional[Tags] = None
+    rotation_frequency: Optional[str] = None
+    rotation_state: Optional[ItemVersionState] = None
+    rotation_grace_period: Optional[str] = None
+    expiration: Optional[datetime.datetime] = None
+    item_state: Optional[ItemState] = None
+
+
+class UpdateResult(APIRequestModel):
+    id: str
+
+
+class JWKGetRequest(APIRequestModel):
+    id: str
+    version: Optional[str] = None
+
+
+class JWKHeader(PangeaResponseResult):
+    alg: str
+    kid: Optional[str] = None
+    kty: str
+    use: Optional[str] = None
+
+
+class JWK(JWKHeader):
+    # Generic JWK
+    pass
+
+
+class JWKec(JWKHeader):
+    # Eliptyc curve JWK
+    crv: str
+    d: Optional[str] = None
+    x: str
+    y: str
+
+
+class JWKrsa(JWKHeader):
+    # RSA JWK
+    n: str
+    e: str
+    d: Optional[str] = None
+
+
+class JWKGetResult(PangeaResponseResult):
+    keys: List[Union[JWKec, JWKrsa, JWK]]
+
+
+class JWTVerifyRequest(APIRequestModel):
+    jws: str
+
+
+class JWTVerifyResult(PangeaResponseResult):
+    valid_signature: bool
+
+
+class JWTSignRequest(APIRequestModel):
+    id: str
+    payload: str
+
+
+class JWTSignResult(PangeaResponseResult):
+    jws: str
+
+
+class StateChangeRequest(APIRequestModel):
+    id: str
+    state: ItemVersionState
+    version: Optional[int] = None
+    destroy_period: Optional[str] = None
+
+
+class StateChangeResult(PangeaResponseResult):
+    id: str
+    version: int
+    state: str
+    destroy_at: Optional[str] = None

pangea/services/vault/models/secret.py

@@ -0,0 +1,24 @@
+# Copyright 2022 Pangea Cyber Corporation
+# Author: Pangea Cyber Corporation
+from pangea.services.vault.models.common import (
+    CommonRotateRequest,
+    CommonRotateResult,
+    CommonStoreRequest,
+    CommonStoreResult,
+)
+
+
+class SecretStoreRequest(CommonStoreRequest):
+    secret: str
+
+
+class SecretStoreResult(CommonStoreResult):
+    secret: str
+
+
+class SecretRotateRequest(CommonRotateRequest):
+    secret: str
+
+
+class SecretRotateResult(CommonRotateResult):
+    secret: str

pangea/services/vault/models/symmetric.py

@@ -0,0 +1,61 @@
+# 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 (
+    CommonGenerateRequest,
+    CommonGenerateResult,
+    CommonStoreRequest,
+    CommonStoreResult,
+    EncodedSymmetricKey,
+    KeyPurpose,
+    SymmetricAlgorithm,
+)
+
+
+class SymmetricStoreRequest(CommonStoreRequest):
+    key: EncodedSymmetricKey
+    algorithm: SymmetricAlgorithm
+    purpose: KeyPurpose
+
+
+class SymmetricStoreResult(CommonStoreResult):
+    algorithm: str
+    purpose: str
+
+
+class SymmetricGenerateRequest(CommonGenerateRequest):
+    algorithm: SymmetricAlgorithm
+    purpose: KeyPurpose
+
+
+class SymmetricGenerateResult(CommonGenerateResult):
+    algorithm: str
+    purpose: str
+
+
+class EncryptRequest(APIRequestModel):
+    id: str
+    plain_text: str
+    version: Optional[int] = None
+
+
+class EncryptResult(PangeaResponseResult):
+    id: str
+    version: int
+    algorithm: str
+    cipher_text: str
+
+
+class DecryptRequest(APIRequestModel):
+    id: str
+    cipher_text: str
+    version: Optional[int] = None
+
+
+class DecryptResult(PangeaResponseResult):
+    id: str
+    version: int
+    algorithm: str
+    plain_text: str