Class swarmauri_certservice_gcpkms.GcpKmsCertService.GcpKmsCertService

swarmauri_certservice_gcpkms.GcpKmsCertService.GcpKmsCertService

GcpKmsCertService(*, client=None)

Bases: CertServiceBase

Certificate service using Google Cloud KMS for key operations.

Initialize the service.

client: Optional KMS client instance.

Source code in swarmauri_certservice_gcpkms/GcpKmsCertService.py

def __init__(self, *, client=None) -> None:
    """Initialize the service.

    client: Optional KMS client instance.
    """

    super().__init__()
    self._client = client

resource class-attribute instance-attribute

resource = Field(default=CRYPTO.value, frozen=True)

type class-attribute instance-attribute

type = 'GcpKmsCertService'

model_config class-attribute instance-attribute

model_config = ConfigDict(
    extra="allow", arbitrary_types_allowed=True
)

id class-attribute instance-attribute

id = Field(default_factory=generate_id)

members class-attribute instance-attribute

members = None

owners class-attribute instance-attribute

owners = None

host class-attribute instance-attribute

host = None

default_logger class-attribute

default_logger = None

logger class-attribute instance-attribute

logger = None

name class-attribute instance-attribute

name = None

version class-attribute instance-attribute

version = '0.1.0'

supports

supports()

Describe supported algorithms and features.

RETURNS (Mapping[str, Iterable[str]]): Keys for categories with supported values.

Source code in swarmauri_certservice_gcpkms/GcpKmsCertService.py

def supports(self) -> Mapping[str, Iterable[str]]:
    """Describe supported algorithms and features.

    RETURNS (Mapping[str, Iterable[str]]): Keys for categories with supported values.
    """

    return {
        "key_algs": ("RSA-2048", "EC-P256", "Ed25519"),
        "sig_algs": ("RSA-PKCS1-SHA256", "ECDSA-P256-SHA256", "Ed25519"),
        "features": ("csr", "self_signed", "sign_from_csr", "verify", "parse"),
    }

create_csr async

create_csr(
    key,
    subject,
    *,
    san=None,
    extensions=None,
    sig_alg=None,
    challenge_password=None,
    output_der=False,
    opts=None,
)

Create a certificate signing request.

key (KeyRef): Reference to the private key in KMS. subject (SubjectSpec): Subject specification for the CSR. san (Optional[AltNameSpec]): Subject alternative names. extensions (Optional[CertExtensionSpec]): Additional certificate extensions. sig_alg (Optional[str]): Signature algorithm to use. challenge_password (Optional[str]): Password to embed in the CSR. output_der (bool): Return DER bytes if True; otherwise PEM. opts (Optional[Dict[str, Any]]): Extra backend options.

RETURNS (CsrBytes): The generated CSR bytes.

Source code in swarmauri_certservice_gcpkms/GcpKmsCertService.py

async def create_csr(
    self,
    key: KeyRef,
    subject: SubjectSpec,
    *,
    san: Optional[AltNameSpec] = None,
    extensions: Optional[CertExtensionSpec] = None,
    sig_alg: Optional[str] = None,
    challenge_password: Optional[str] = None,
    output_der: bool = False,
    opts: Optional[Dict[str, Any]] = None,
) -> CsrBytes:
    """Create a certificate signing request.

    key (KeyRef): Reference to the private key in KMS.
    subject (SubjectSpec): Subject specification for the CSR.
    san (Optional[AltNameSpec]): Subject alternative names.
    extensions (Optional[CertExtensionSpec]): Additional certificate extensions.
    sig_alg (Optional[str]): Signature algorithm to use.
    challenge_password (Optional[str]): Password to embed in the CSR.
    output_der (bool): Return DER bytes if ``True``; otherwise PEM.
    opts (Optional[Dict[str, Any]]): Extra backend options.

    RETURNS (CsrBytes): The generated CSR bytes.
    """

    client = self._client_or_new()
    version = _key_version_from_keyref(key)
    kms_priv = _make_kms_private_key(client, version)

    builder = x509.CertificateSigningRequestBuilder()
    builder = builder.subject_name(_subject_from_spec(subject))
    builder = _add_san(builder, san)
    if challenge_password:
        builder = builder.add_attribute(
            NameOID.CHALLENGE_PASSWORD, challenge_password.encode("utf-8")
        )
    csr = builder.sign(kms_priv, hashes.SHA256())
    return csr.public_bytes(
        serialization.Encoding.DER if output_der else serialization.Encoding.PEM
    )

create_self_signed async

create_self_signed(
    key,
    subject,
    *,
    serial=None,
    not_before=None,
    not_after=None,
    extensions=None,
    sig_alg=None,
    output_der=False,
    opts=None,
)

Create a self-signed certificate.

key (KeyRef): Reference to the private key in KMS. subject (SubjectSpec): Subject specification for the certificate. serial (Optional[int]): Serial number of the certificate. not_before (Optional[int]): Validity start time as a Unix timestamp. not_after (Optional[int]): Validity end time as a Unix timestamp. extensions (Optional[CertExtensionSpec]): Additional certificate extensions. sig_alg (Optional[str]): Signature algorithm to use. output_der (bool): Return DER bytes if True; otherwise PEM. opts (Optional[Dict[str, Any]]): Extra backend options.

RETURNS (CertBytes): The generated certificate bytes.

Source code in swarmauri_certservice_gcpkms/GcpKmsCertService.py

async def create_self_signed(
    self,
    key: KeyRef,
    subject: SubjectSpec,
    *,
    serial: Optional[int] = None,
    not_before: Optional[int] = None,
    not_after: Optional[int] = None,
    extensions: Optional[CertExtensionSpec] = None,
    sig_alg: Optional[str] = None,
    output_der: bool = False,
    opts: Optional[Dict[str, Any]] = None,
) -> CertBytes:
    """Create a self-signed certificate.

    key (KeyRef): Reference to the private key in KMS.
    subject (SubjectSpec): Subject specification for the certificate.
    serial (Optional[int]): Serial number of the certificate.
    not_before (Optional[int]): Validity start time as a Unix timestamp.
    not_after (Optional[int]): Validity end time as a Unix timestamp.
    extensions (Optional[CertExtensionSpec]): Additional certificate extensions.
    sig_alg (Optional[str]): Signature algorithm to use.
    output_der (bool): Return DER bytes if ``True``; otherwise PEM.
    opts (Optional[Dict[str, Any]]): Extra backend options.

    RETURNS (CertBytes): The generated certificate bytes.
    """

    client = self._client_or_new()
    version = _key_version_from_keyref(key)
    kms_priv = _make_kms_private_key(client, version)
    pub_pem = client.get_public_key(request={"name": version}).pem.encode("utf-8")

    subject_name = _subject_from_spec(subject)
    builder = x509.CertificateBuilder()
    builder = builder.subject_name(subject_name).issuer_name(subject_name)
    builder = builder.serial_number(serial or x509.random_serial_number())
    nbf = _secs(not_before, default=-300)
    naf = _secs(not_after, default=365 * 24 * 3600)
    builder = builder.not_valid_before(nbf).not_valid_after(naf)
    builder = builder.public_key(load_pem_public_key(pub_pem))
    builder = _apply_extensions(
        builder,
        extensions,
        issuer_pub=pub_pem,
        subject_pub=pub_pem,
        is_self_signed=True,
    )
    cert = builder.sign(kms_priv, hashes.SHA256())
    return cert.public_bytes(
        serialization.Encoding.DER if output_der else serialization.Encoding.PEM
    )

sign_cert async

sign_cert(
    csr,
    ca_key,
    *,
    issuer=None,
    ca_cert=None,
    serial=None,
    not_before=None,
    not_after=None,
    extensions=None,
    sig_alg=None,
    output_der=False,
    opts=None,
)

Sign a certificate from a CSR.

csr (CsrBytes): CSR to sign. ca_key (KeyRef): Reference to the CA key in KMS. issuer (Optional[SubjectSpec]): Issuer subject specification. ca_cert (Optional[CertBytes]): CA certificate used for extension defaults. serial (Optional[int]): Serial number of the certificate. not_before (Optional[int]): Validity start time as a Unix timestamp. not_after (Optional[int]): Validity end time as a Unix timestamp. extensions (Optional[CertExtensionSpec]): Additional certificate extensions. sig_alg (Optional[str]): Signature algorithm to use. output_der (bool): Return DER bytes if True; otherwise PEM. opts (Optional[Dict[str, Any]]): Extra backend options.

RETURNS (CertBytes): The signed certificate bytes.

Source code in swarmauri_certservice_gcpkms/GcpKmsCertService.py

async def sign_cert(
    self,
    csr: CsrBytes,
    ca_key: KeyRef,
    *,
    issuer: Optional[SubjectSpec] = None,
    ca_cert: Optional[CertBytes] = None,
    serial: Optional[int] = None,
    not_before: Optional[int] = None,
    not_after: Optional[int] = None,
    extensions: Optional[CertExtensionSpec] = None,
    sig_alg: Optional[str] = None,
    output_der: bool = False,
    opts: Optional[Dict[str, Any]] = None,
) -> CertBytes:
    """Sign a certificate from a CSR.

    csr (CsrBytes): CSR to sign.
    ca_key (KeyRef): Reference to the CA key in KMS.
    issuer (Optional[SubjectSpec]): Issuer subject specification.
    ca_cert (Optional[CertBytes]): CA certificate used for extension defaults.
    serial (Optional[int]): Serial number of the certificate.
    not_before (Optional[int]): Validity start time as a Unix timestamp.
    not_after (Optional[int]): Validity end time as a Unix timestamp.
    extensions (Optional[CertExtensionSpec]): Additional certificate extensions.
    sig_alg (Optional[str]): Signature algorithm to use.
    output_der (bool): Return DER bytes if ``True``; otherwise PEM.
    opts (Optional[Dict[str, Any]]): Extra backend options.

    RETURNS (CertBytes): The signed certificate bytes.
    """

    client = self._client_or_new()
    version = _key_version_from_keyref(ca_key)
    kms_priv = _make_kms_private_key(client, version)

    req = x509.load_pem_x509_csr(csr)
    subject_name = req.subject
    issuer_name = _subject_from_spec(issuer) if issuer else subject_name
    issuer_pub = client.get_public_key(request={"name": version}).pem.encode(
        "utf-8"
    )

    builder = x509.CertificateBuilder()
    builder = builder.subject_name(subject_name).issuer_name(issuer_name)
    builder = builder.serial_number(serial or x509.random_serial_number())
    builder = builder.not_valid_before(_secs(not_before, -300))
    builder = builder.not_valid_after(_secs(not_after, 365 * 24 * 3600))
    builder = builder.public_key(req.public_key())
    builder = _apply_extensions(
        builder,
        extensions,
        issuer_pub=issuer_pub,
        subject_pub=req.public_key().public_bytes(
            serialization.Encoding.PEM,
            serialization.PublicFormat.SubjectPublicKeyInfo,
        ),
        is_self_signed=False,
    )
    cert = builder.sign(kms_priv, hashes.SHA256())
    return cert.public_bytes(
        serialization.Encoding.DER if output_der else serialization.Encoding.PEM
    )

verify_cert async

verify_cert(
    cert,
    *,
    trust_roots=None,
    intermediates=None,
    check_time=None,
    check_revocation=False,
    opts=None,
)

Verify a certificate's signature and validity period.

cert (CertBytes): Certificate to verify. trust_roots (Optional[Sequence[CertBytes]]): Trusted root certificates. intermediates (Optional[Sequence[CertBytes]]): Intermediate certificates. check_time (Optional[int]): Time of verification as Unix timestamp. check_revocation (bool): Whether to check revocation status. opts (Optional[Dict[str, Any]]): Extra backend options.

RETURNS (Dict[str, Any]): Verification result and certificate metadata.

Source code in swarmauri_certservice_gcpkms/GcpKmsCertService.py

async def verify_cert(
    self,
    cert: CertBytes,
    *,
    trust_roots: Optional[Sequence[CertBytes]] = None,
    intermediates: Optional[Sequence[CertBytes]] = None,
    check_time: Optional[int] = None,
    check_revocation: bool = False,
    opts: Optional[Dict[str, Any]] = None,
) -> Dict[str, Any]:
    """Verify a certificate's signature and validity period.

    cert (CertBytes): Certificate to verify.
    trust_roots (Optional[Sequence[CertBytes]]): Trusted root certificates.
    intermediates (Optional[Sequence[CertBytes]]): Intermediate certificates.
    check_time (Optional[int]): Time of verification as Unix timestamp.
    check_revocation (bool): Whether to check revocation status.
    opts (Optional[Dict[str, Any]]): Extra backend options.

    RETURNS (Dict[str, Any]): Verification result and certificate metadata.
    """

    crt = x509.load_pem_x509_certificate(cert)
    now = _secs(check_time, 0)
    if now < crt.not_valid_before.replace(
        tzinfo=_dt.timezone.utc
    ) or now > crt.not_valid_after.replace(tzinfo=_dt.timezone.utc):
        return {
            "valid": False,
            "reason": "time_window",
            "not_before": int(crt.not_valid_before.timestamp()),
            "not_after": int(crt.not_valid_after.timestamp()),
        }
    if trust_roots:
        issuer = x509.load_pem_x509_certificate(trust_roots[0])
        pub = issuer.public_key()
        try:
            if isinstance(pub, rsa.RSAPublicKey):
                pub.verify(
                    crt.signature,
                    crt.tbs_certificate_bytes,
                    padding.PKCS1v15(),
                    crt.signature_hash_algorithm,
                )
            else:
                pub.verify(
                    crt.signature,
                    crt.tbs_certificate_bytes,
                    crt.signature_hash_algorithm,
                )
        except Exception:
            return {"valid": False, "reason": "signature_mismatch"}
    return {
        "valid": True,
        "issuer": crt.issuer.rfc4514_string(),
        "subject": crt.subject.rfc4514_string(),
        "not_before": int(crt.not_valid_before.timestamp()),
        "not_after": int(crt.not_valid_after.timestamp()),
    }

parse_cert async

parse_cert(cert, *, include_extensions=True, opts=None)

Parse certificate metadata.

cert (CertBytes): Certificate to parse. include_extensions (bool): Include extension information if True. opts (Optional[Dict[str, Any]]): Extra backend options.

RETURNS (Dict[str, Any]): Parsed certificate fields.

Source code in swarmauri_certservice_gcpkms/GcpKmsCertService.py

async def parse_cert(
    self,
    cert: CertBytes,
    *,
    include_extensions: bool = True,
    opts: Optional[Dict[str, Any]] = None,
) -> Dict[str, Any]:
    """Parse certificate metadata.

    cert (CertBytes): Certificate to parse.
    include_extensions (bool): Include extension information if ``True``.
    opts (Optional[Dict[str, Any]]): Extra backend options.

    RETURNS (Dict[str, Any]): Parsed certificate fields.
    """

    c = x509.load_pem_x509_certificate(cert)
    out: Dict[str, Any] = {
        "tbs_version": c.version.value,
        "serial": c.serial_number,
        "sig_alg": c.signature_hash_algorithm.name,
        "issuer": c.issuer.rfc4514_string(),
        "subject": c.subject.rfc4514_string(),
        "not_before": int(c.not_valid_before.timestamp()),
        "not_after": int(c.not_valid_after.timestamp()),
    }
    if include_extensions:
        try:
            bc = c.extensions.get_extension_for_class(x509.BasicConstraints).value
            out["is_ca"] = bool(bc.ca)
        except x509.ExtensionNotFound:
            out["is_ca"] = False
    return out

register_model classmethod

register_model()

Decorator to register a base model in the unified registry.

RETURNS	DESCRIPTION
Callable	A decorator function that registers the model class. TYPE: Callable[[Type[BaseModel]], Type[BaseModel]]

Source code in swarmauri_base/DynamicBase.py

@classmethod
def register_model(cls) -> Callable[[Type[BaseModel]], Type[BaseModel]]:
    """
    Decorator to register a base model in the unified registry.

    Returns:
        Callable: A decorator function that registers the model class.
    """

    def decorator(model_cls: Type[BaseModel]):
        """Register ``model_cls`` as a base model."""
        model_name = model_cls.__name__
        if model_name in cls._registry:
            glogger.warning(
                "Model '%s' is already registered; skipping duplicate.", model_name
            )
            return model_cls

        cls._registry[model_name] = {"model_cls": model_cls, "subtypes": {}}
        glogger.debug("Registered base model '%s'.", model_name)
        DynamicBase._recreate_models()
        return model_cls

    return decorator

register_type classmethod

register_type(resource_type=None, type_name=None)

Decorator to register a subtype under one or more base models in the unified registry.

PARAMETER	DESCRIPTION
resource_type	The base model(s) under which to register the subtype. If None, all direct base classes (except DynamicBase) are used. TYPE: Optional[Union[Type[T], List[Type[T]]]] DEFAULT: None
type_name	An optional custom type name for the subtype. TYPE: Optional[str] DEFAULT: None

RETURNS	DESCRIPTION
Callable	A decorator function that registers the subtype. TYPE: Callable[[Type[DynamicBase]], Type[DynamicBase]]

Source code in swarmauri_base/DynamicBase.py

@classmethod
def register_type(
    cls,
    resource_type: Optional[Union[Type[T], List[Type[T]]]] = None,
    type_name: Optional[str] = None,
) -> Callable[[Type["DynamicBase"]], Type["DynamicBase"]]:
    """
    Decorator to register a subtype under one or more base models in the unified registry.

    Parameters:
        resource_type (Optional[Union[Type[T], List[Type[T]]]]):
            The base model(s) under which to register the subtype. If None, all direct base classes (except DynamicBase)
            are used.
        type_name (Optional[str]): An optional custom type name for the subtype.

    Returns:
        Callable: A decorator function that registers the subtype.
    """

    def decorator(subclass: Type["DynamicBase"]):
        """Register ``subclass`` as a subtype."""
        if resource_type is None:
            resource_types = [
                base for base in subclass.__bases__ if base is not cls
            ]
        elif not isinstance(resource_type, list):
            resource_types = [resource_type]
        else:
            resource_types = resource_type

        for rt in resource_types:
            if not issubclass(subclass, rt):
                raise TypeError(
                    f"'{subclass.__name__}' must be a subclass of '{rt.__name__}'."
                )
            final_type_name = type_name or getattr(
                subclass, "_type", subclass.__name__
            )
            base_model_name = rt.__name__

            if base_model_name not in cls._registry:
                cls._registry[base_model_name] = {"model_cls": rt, "subtypes": {}}
                glogger.debug(
                    "Created new registry entry for base model '%s'.",
                    base_model_name,
                )

            subtypes_dict = cls._registry[base_model_name]["subtypes"]
            if final_type_name in subtypes_dict:
                glogger.warning(
                    "Type '%s' already exists under '%s'; skipping duplicate.",
                    final_type_name,
                    base_model_name,
                )
                continue

            subtypes_dict[final_type_name] = subclass
            glogger.debug(
                "Registered '%s' as '%s' under '%s'.",
                subclass.__name__,
                final_type_name,
                base_model_name,
            )

        DynamicBase._recreate_models()
        return subclass

    return decorator

model_validate_toml classmethod

model_validate_toml(toml_data)

Validate a model from a TOML string.

Source code in swarmauri_base/TomlMixin.py

@classmethod
def model_validate_toml(cls, toml_data: str):
    """Validate a model from a TOML string."""
    try:
        # Parse TOML into a Python dictionary
        toml_content = tomllib.loads(toml_data)

        # Convert the dictionary to JSON and validate using Pydantic
        return cls.model_validate_json(json.dumps(toml_content))
    except tomllib.TOMLDecodeError as e:
        raise ValueError(f"Invalid TOML data: {e}")
    except ValidationError as e:
        raise ValueError(f"Validation failed: {e}")

model_dump_toml

model_dump_toml(
    fields_to_exclude=None, api_key_placeholder=None
)

Return a TOML representation of the model.

Source code in swarmauri_base/TomlMixin.py

def model_dump_toml(self, fields_to_exclude=None, api_key_placeholder=None):
    """Return a TOML representation of the model."""
    if fields_to_exclude is None:
        fields_to_exclude = []

    # Load the JSON string into a Python dictionary
    json_data = json.loads(self.model_dump_json())

    # Function to recursively remove specific keys and handle api_key placeholders
    def process_fields(data, fields_to_exclude):
        """Recursively filter fields and apply placeholders."""
        if isinstance(data, dict):
            return {
                key: (
                    api_key_placeholder
                    if key == "api_key" and api_key_placeholder is not None
                    else process_fields(value, fields_to_exclude)
                )
                for key, value in data.items()
                if key not in fields_to_exclude
            }
        elif isinstance(data, list):
            return [process_fields(item, fields_to_exclude) for item in data]
        else:
            return data

    # Filter the JSON data
    filtered_data = process_fields(json_data, fields_to_exclude)

    # Convert the filtered data into TOML
    return toml.dumps(filtered_data)

model_validate_yaml classmethod

model_validate_yaml(yaml_data)

Validate a model from a YAML string.

Source code in swarmauri_base/YamlMixin.py

@classmethod
def model_validate_yaml(cls, yaml_data: str):
    """Validate a model from a YAML string."""
    try:
        # Parse YAML into a Python dictionary
        yaml_content = yaml.safe_load(yaml_data)

        # Convert the dictionary to JSON and validate using Pydantic
        return cls.model_validate_json(json.dumps(yaml_content))
    except yaml.YAMLError as e:
        raise ValueError(f"Invalid YAML data: {e}")
    except ValidationError as e:
        raise ValueError(f"Validation failed: {e}")

model_dump_yaml

model_dump_yaml(
    fields_to_exclude=None, api_key_placeholder=None
)

Return a YAML representation of the model.

Source code in swarmauri_base/YamlMixin.py

def model_dump_yaml(self, fields_to_exclude=None, api_key_placeholder=None):
    """Return a YAML representation of the model."""
    if fields_to_exclude is None:
        fields_to_exclude = []

    # Load the JSON string into a Python dictionary
    json_data = json.loads(self.model_dump_json())

    # Function to recursively remove specific keys and handle api_key placeholders
    def process_fields(data, fields_to_exclude):
        """Recursively filter fields and apply placeholders."""
        if isinstance(data, dict):
            return {
                key: (
                    api_key_placeholder
                    if key == "api_key" and api_key_placeholder is not None
                    else process_fields(value, fields_to_exclude)
                )
                for key, value in data.items()
                if key not in fields_to_exclude
            }
        elif isinstance(data, list):
            return [process_fields(item, fields_to_exclude) for item in data]
        else:
            return data

    # Filter the JSON data
    filtered_data = process_fields(json_data, fields_to_exclude)

    # Convert the filtered data into YAML using safe mode
    return yaml.safe_dump(filtered_data, default_flow_style=False)

model_post_init

model_post_init(logger=None)

Assign a logger instance after model initialization.

Source code in swarmauri_base/LoggerMixin.py

def model_post_init(self, logger: Optional[FullUnion[LoggerBase]] = None) -> None:
    """Assign a logger instance after model initialization."""

    # Directly assign the provided FullUnion[LoggerBase] or fallback to the
    # class-level default.
    self.logger = self.logger or logger or self.default_logger