stackit-kms 0.0.1__py3-none-any.whl

stackit/kms/models/verified_data.py

@@ -0,0 +1,81 @@
+# coding: utf-8
+
+"""
+    STACKIT Key Management Service API
+
+    This API provides endpoints for managing keys and key rings. 
+
+    The version of the OpenAPI document: 1beta.0.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501 docstring might be too long
+
+from __future__ import annotations
+
+import json
+import pprint
+from typing import Any, ClassVar, Dict, List, Optional, Set
+
+from pydantic import BaseModel, ConfigDict, Field, StrictBool
+from typing_extensions import Self
+
+
+class VerifiedData(BaseModel):
+    """
+    VerifiedData
+    """
+
+    valid: StrictBool = Field(description="Whether or not the data has a valid signature.")
+    __properties: ClassVar[List[str]] = ["valid"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of VerifiedData from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of VerifiedData from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({"valid": obj.get("valid")})
+        return _obj

stackit/kms/models/verify_payload.py

@@ -0,0 +1,82 @@
+# coding: utf-8
+
+"""
+    STACKIT Key Management Service API
+
+    This API provides endpoints for managing keys and key rings. 
+
+    The version of the OpenAPI document: 1beta.0.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501 docstring might be too long
+
+from __future__ import annotations
+
+import json
+import pprint
+from typing import Any, ClassVar, Dict, List, Optional, Set, Union
+
+from pydantic import BaseModel, ConfigDict, Field, StrictBytes, StrictStr
+from typing_extensions import Self
+
+
+class VerifyPayload(BaseModel):
+    """
+    VerifyPayload
+    """
+
+    data: Union[StrictBytes, StrictStr] = Field(description="The data to be verified. Encoded in base64.")
+    signature: Union[StrictBytes, StrictStr] = Field(description="The signature of the data. Encoded in base64.")
+    __properties: ClassVar[List[str]] = ["data", "signature"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of VerifyPayload from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of VerifyPayload from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({"data": obj.get("data"), "signature": obj.get("signature")})
+        return _obj

stackit/kms/models/version.py

@@ -0,0 +1,138 @@
+# coding: utf-8
+
+"""
+    STACKIT Key Management Service API
+
+    This API provides endpoints for managing keys and key rings. 
+
+    The version of the OpenAPI document: 1beta.0.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501 docstring might be too long
+
+from __future__ import annotations
+
+import json
+import pprint
+from datetime import datetime
+from typing import Any, ClassVar, Dict, List, Optional, Set
+
+from pydantic import (
+    BaseModel,
+    ConfigDict,
+    Field,
+    StrictBool,
+    StrictInt,
+    StrictStr,
+    field_validator,
+)
+from typing_extensions import Self
+
+
+class Version(BaseModel):
+    """
+    Version
+    """
+
+    created_at: datetime = Field(
+        description="The date and time the creation of the key was triggered.", alias="createdAt"
+    )
+    destroy_date: Optional[datetime] = Field(
+        default=None,
+        description="The scheduled date when a version's key material will be erased completely from the backend",
+        alias="destroyDate",
+    )
+    disabled: Optional[StrictBool] = Field(default=False, description="States whether versions is enabled or disabled.")
+    key_id: StrictStr = Field(description="The unique id of the key this version is assigned to.", alias="keyId")
+    key_ring_id: StrictStr = Field(
+        description="The unique id of the key ring the key of this version is assigned to.", alias="keyRingId"
+    )
+    number: StrictInt = Field(description="A sequential number which identifies the key versions.")
+    public_key: Optional[StrictStr] = Field(
+        default=None,
+        description="The public key of the key version. Only present in asymmetric keys.",
+        alias="publicKey",
+    )
+    state: StrictStr = Field(description="The current state of the key.")
+    __properties: ClassVar[List[str]] = [
+        "createdAt",
+        "destroyDate",
+        "disabled",
+        "keyId",
+        "keyRingId",
+        "number",
+        "publicKey",
+        "state",
+    ]
+
+    @field_validator("state")
+    def state_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(["active", "key_material_not_ready", "key_material_invalid", "disabled", "destroyed"]):
+            raise ValueError(
+                "must be one of enum values ('active', 'key_material_not_ready', 'key_material_invalid', 'disabled', 'destroyed')"
+            )
+        return value
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of Version from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of Version from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {
+                "createdAt": obj.get("createdAt"),
+                "destroyDate": obj.get("destroyDate"),
+                "disabled": obj.get("disabled") if obj.get("disabled") is not None else False,
+                "keyId": obj.get("keyId"),
+                "keyRingId": obj.get("keyRingId"),
+                "number": obj.get("number"),
+                "publicKey": obj.get("publicKey"),
+                "state": obj.get("state"),
+            }
+        )
+        return _obj

stackit/kms/models/version_list.py

@@ -0,0 +1,96 @@
+# coding: utf-8
+
+"""
+    STACKIT Key Management Service API
+
+    This API provides endpoints for managing keys and key rings. 
+
+    The version of the OpenAPI document: 1beta.0.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501 docstring might be too long
+
+from __future__ import annotations
+
+import json
+import pprint
+from typing import Any, ClassVar, Dict, List, Optional, Set
+
+from pydantic import BaseModel, ConfigDict
+from typing_extensions import Self
+
+from stackit.kms.models.version import Version
+
+
+class VersionList(BaseModel):
+    """
+    VersionList
+    """
+
+    versions: List[Version]
+    __properties: ClassVar[List[str]] = ["versions"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of VersionList from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of each item in versions (list)
+        _items = []
+        if self.versions:
+            for _item in self.versions:
+                if _item:
+                    _items.append(_item.to_dict())
+            _dict["versions"] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of VersionList from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {
+                "versions": (
+                    [Version.from_dict(_item) for _item in obj["versions"]] if obj.get("versions") is not None else None
+                )
+            }
+        )
+        return _obj

stackit/kms/models/wrapping_algorithm.py

@@ -0,0 +1,42 @@
+# coding: utf-8
+
+"""
+    STACKIT Key Management Service API
+
+    This API provides endpoints for managing keys and key rings. 
+
+    The version of the OpenAPI document: 1beta.0.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501 docstring might be too long
+
+from __future__ import annotations
+
+import json
+from enum import Enum
+
+from typing_extensions import Self
+
+
+class WrappingAlgorithm(str, Enum):
+    """
+    The wrapping algorithm used to wrap the key to import.
+    """
+
+    """
+    allowed enum values
+    """
+    RSA_2048_OAEP_SHA256 = "rsa_2048_oaep_sha256"
+    RSA_3072_OAEP_SHA256 = "rsa_3072_oaep_sha256"
+    RSA_4096_OAEP_SHA256 = "rsa_4096_oaep_sha256"
+    RSA_4096_OAEP_SHA512 = "rsa_4096_oaep_sha512"
+    RSA_2048_OAEP_SHA256_AES_256_KEY_WRAP = "rsa_2048_oaep_sha256_aes_256_key_wrap"
+    RSA_3072_OAEP_SHA256_AES_256_KEY_WRAP = "rsa_3072_oaep_sha256_aes_256_key_wrap"
+    RSA_4096_OAEP_SHA256_AES_256_KEY_WRAP = "rsa_4096_oaep_sha256_aes_256_key_wrap"
+    RSA_4096_OAEP_SHA512_AES_256_KEY_WRAP = "rsa_4096_oaep_sha512_aes_256_key_wrap"
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of WrappingAlgorithm from a JSON string"""
+        return cls(json.loads(json_str))

stackit/kms/models/wrapping_key.py

@@ -0,0 +1,139 @@
+# coding: utf-8
+
+"""
+    STACKIT Key Management Service API
+
+    This API provides endpoints for managing keys and key rings. 
+
+    The version of the OpenAPI document: 1beta.0.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501 docstring might be too long
+
+from __future__ import annotations
+
+import json
+import pprint
+from datetime import datetime
+from typing import Any, ClassVar, Dict, List, Optional, Set
+
+from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator
+from typing_extensions import Annotated, Self
+
+from stackit.kms.models.backend import Backend
+from stackit.kms.models.wrapping_algorithm import WrappingAlgorithm
+from stackit.kms.models.wrapping_purpose import WrappingPurpose
+
+
+class WrappingKey(BaseModel):
+    """
+    WrappingKey
+    """
+
+    algorithm: WrappingAlgorithm
+    backend: Backend
+    created_at: datetime = Field(
+        description="The date and time the creation of the wrapping key was triggered.", alias="createdAt"
+    )
+    description: Optional[Annotated[str, Field(strict=True, max_length=256)]] = Field(
+        default=None, description="A user chosen description to distinguish multiple wrapping keys."
+    )
+    display_name: Annotated[str, Field(strict=True, max_length=64)] = Field(
+        description="The display name to distinguish multiple wrapping keys.", alias="displayName"
+    )
+    expires_at: datetime = Field(description="The date and time the wrapping key will expire.", alias="expiresAt")
+    id: StrictStr = Field(description="A auto generated unique id which identifies the wrapping keys.")
+    key_ring_id: StrictStr = Field(
+        description="The unique id of the key ring this wrapping key is assigned to.", alias="keyRingId"
+    )
+    public_key: Optional[StrictStr] = Field(
+        default=None, description="The public key of the wrapping key.", alias="publicKey"
+    )
+    purpose: WrappingPurpose
+    state: StrictStr = Field(description="The current state of the wrapping key.")
+    __properties: ClassVar[List[str]] = [
+        "algorithm",
+        "backend",
+        "createdAt",
+        "description",
+        "displayName",
+        "expiresAt",
+        "id",
+        "keyRingId",
+        "publicKey",
+        "purpose",
+        "state",
+    ]
+
+    @field_validator("state")
+    def state_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(["active", "key_material_not_ready", "expired", "deleting"]):
+            raise ValueError("must be one of enum values ('active', 'key_material_not_ready', 'expired', 'deleting')")
+        return value
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of WrappingKey from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of WrappingKey from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {
+                "algorithm": obj.get("algorithm"),
+                "backend": obj.get("backend"),
+                "createdAt": obj.get("createdAt"),
+                "description": obj.get("description"),
+                "displayName": obj.get("displayName"),
+                "expiresAt": obj.get("expiresAt"),
+                "id": obj.get("id"),
+                "keyRingId": obj.get("keyRingId"),
+                "publicKey": obj.get("publicKey"),
+                "purpose": obj.get("purpose"),
+                "state": obj.get("state"),
+            }
+        )
+        return _obj

stackit/kms/models/wrapping_key_list.py

@@ -0,0 +1,98 @@
+# coding: utf-8
+
+"""
+    STACKIT Key Management Service API
+
+    This API provides endpoints for managing keys and key rings. 
+
+    The version of the OpenAPI document: 1beta.0.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501 docstring might be too long
+
+from __future__ import annotations
+
+import json
+import pprint
+from typing import Any, ClassVar, Dict, List, Optional, Set
+
+from pydantic import BaseModel, ConfigDict, Field
+from typing_extensions import Self
+
+from stackit.kms.models.wrapping_key import WrappingKey
+
+
+class WrappingKeyList(BaseModel):
+    """
+    WrappingKeyList
+    """
+
+    wrapping_keys: List[WrappingKey] = Field(alias="wrappingKeys")
+    __properties: ClassVar[List[str]] = ["wrappingKeys"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of WrappingKeyList from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of each item in wrapping_keys (list)
+        _items = []
+        if self.wrapping_keys:
+            for _item in self.wrapping_keys:
+                if _item:
+                    _items.append(_item.to_dict())
+            _dict["wrappingKeys"] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of WrappingKeyList from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {
+                "wrappingKeys": (
+                    [WrappingKey.from_dict(_item) for _item in obj["wrappingKeys"]]
+                    if obj.get("wrappingKeys") is not None
+                    else None
+                )
+            }
+        )
+        return _obj