Class swarmauri_certs_x509.X509CertService.X509CertService

swarmauri_certs_x509.X509CertService.X509CertService

Bases: CertServiceBase

CSR/X.509 issuance & verification using cryptography

type class-attribute instance-attribute

type = 'CertServiceBase'

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

resource class-attribute instance-attribute

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

version class-attribute instance-attribute

version = '0.1.0'

supports

supports()

Source code in swarmauri_certs_x509/X509CertService.py

def supports(self) -> Mapping[str, Iterable[str]]:
    return {
        "key_algs": ("Ed25519", "RSA-2048", "RSA-3072", "EC-P256"),
        "sig_algs": ("Ed25519", "RSA-PSS-SHA256", "ECDSA-P256-SHA256"),
        "features": (
            "csr",
            "self_signed",
            "sign_from_csr",
            "verify",
            "parse",
            "san",
            "eku",
            "key_usage",
            "akid",
            "skid",
        ),
        "profiles": (
            "server",
            "client",
            "code_signing",
            "email_protection",
        ),
    }

create_csr async

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

Source code in swarmauri_certs_x509/X509CertService.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:
    if not key.material:
        raise ValueError("create_csr requires KeyRef.material")
    sk = _load_priv(key.material)
    plan = _plan_from_inputs(key, sig_alg)

    builder = x509.CertificateSigningRequestBuilder().subject_name(
        _to_x509_name(subject)
    )

    san_ext = _mk_san(san)
    if san_ext:
        builder = builder.add_extension(san_ext, critical=False)

    if challenge_password:
        builder = builder.add_attribute(
            x509.oid.AttributeOID.CHALLENGE_PASSWORD,
            challenge_password.encode("utf-8"),
        )

    csr = _sign(builder, plan, sk)
    return _pem_or_der(csr, output_der)

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,
)

Source code in swarmauri_certs_x509/X509CertService.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:
    if not key.material:
        raise ValueError("create_self_signed requires KeyRef.material")
    sk = _load_priv(key.material)
    pub = sk.public_key()
    plan = _plan_from_inputs(key, sig_alg)
    nbf, naf = _now_bounds(not_before, not_after)

    builder = (
        x509.CertificateBuilder()
        .subject_name(_to_x509_name(subject))
        .issuer_name(_to_x509_name(subject))
        .public_key(pub)
        .serial_number(serial or x509.random_serial_number())
        .not_valid_before(datetime.datetime.fromtimestamp(nbf, datetime.UTC))
        .not_valid_after(datetime.datetime.fromtimestamp(naf, datetime.UTC))
    )

    if extensions is None:
        extensions = {
            "basic_constraints": {"ca": False},
            "subject_key_identifier": True,
            "authority_key_identifier": False,
        }

    builder = _apply_extensions(builder, extensions, pub, issuer_cert=None)
    cert = _sign(builder, plan, sk)
    return _pem_or_der(cert, output_der)

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,
)

Source code in swarmauri_certs_x509/X509CertService.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:
    if not ca_key.material:
        raise ValueError("sign_cert requires CA KeyRef.material")

    try:
        try:
            _csr = x509.load_pem_x509_csr(csr)
        except ValueError:
            _csr = x509.load_der_x509_csr(csr)
    except Exception as e:  # pragma: no cover
        raise ValueError(f"Invalid CSR: {e}") from e

    if not _csr.is_signature_valid:
        raise ValueError("CSR signature invalid")

    issuer_cert_obj: Optional[x509.Certificate] = None
    if ca_cert:
        try:
            try:
                issuer_cert_obj = x509.load_pem_x509_certificate(ca_cert)
            except ValueError:
                issuer_cert_obj = x509.load_der_x509_certificate(ca_cert)
        except Exception as e:  # pragma: no cover
            raise ValueError(f"Invalid ca_cert: {e}") from e

    issuer_name = (
        _to_x509_name(issuer)
        if issuer
        else (issuer_cert_obj.subject if issuer_cert_obj else _csr.subject)
    )

    sk = _load_priv(ca_key.material)
    plan = _plan_from_inputs(ca_key, sig_alg)
    nbf, naf = _now_bounds(not_before, not_after)

    builder = (
        x509.CertificateBuilder()
        .subject_name(_csr.subject)
        .issuer_name(issuer_name)
        .public_key(_csr.public_key())
        .serial_number(serial or x509.random_serial_number())
        .not_valid_before(datetime.datetime.fromtimestamp(nbf, datetime.UTC))
        .not_valid_after(datetime.datetime.fromtimestamp(naf, datetime.UTC))
    )

    try:
        san_req = _csr.extensions.get_extension_for_class(
            x509.SubjectAlternativeName
        )
        builder = builder.add_extension(san_req.value, critical=False)
    except x509.ExtensionNotFound:
        pass

    if extensions is None:
        extensions = {
            "basic_constraints": {"ca": False},
            "subject_key_identifier": True,
            "authority_key_identifier": True,
        }
    builder = _apply_extensions(
        builder, extensions, _csr.public_key(), issuer_cert=issuer_cert_obj
    )

    cert = _sign(builder, plan, sk)
    return _pem_or_der(cert, output_der)

verify_cert async

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

Source code in swarmauri_certs_x509/X509CertService.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]:
    try:
        try:
            leaf = x509.load_pem_x509_certificate(cert)
        except ValueError:
            leaf = x509.load_der_x509_certificate(cert)
    except Exception as e:  # pragma: no cover
        raise ValueError(f"Invalid certificate: {e}") from e

    now = int(time.time()) if check_time is None else int(check_time)
    if now < int(leaf.not_valid_before_utc.timestamp()):
        return {"valid": False, "reason": "not_yet_valid"}
    if now > int(leaf.not_valid_after_utc.timestamp()):
        return {"valid": False, "reason": "expired"}

    if not trust_roots:
        try:
            leaf.public_key().verify(
                leaf.signature,
                leaf.tbs_certificate_bytes,
                padding.PKCS1v15()
                if isinstance(leaf.public_key(), rsa.RSAPublicKey)
                else ec.ECDSA(leaf.signature_hash_algorithm)
                if isinstance(leaf.public_key(), ec.EllipticCurvePublicKey)
                else None,
                leaf.signature_hash_algorithm
                if not isinstance(leaf.public_key(), ed25519.Ed25519PublicKey)
                else None,
            )
            return {
                "valid": True,
                "reason": None,
                "chain_len": 1,
                "is_ca": _is_ca(leaf),
                "issuer": _name_to_str(leaf.issuer),
                "subject": _name_to_str(leaf.subject),
                "not_before": int(leaf.not_valid_before_utc.timestamp()),
                "not_after": int(leaf.not_valid_after_utc.timestamp()),
            }
        except Exception:
            return {"valid": False, "reason": "untrusted_without_roots"}

    chain_pool: Dict[str, x509.Certificate] = {}
    for pem in intermediates or []:
        c = _load_cert_any(pem)
        chain_pool[_name_to_str(c.subject)] = c
    roots = [_load_cert_any(b) for b in (trust_roots or [])]

    cur = leaf
    length = 1
    while True:
        issuer_dn = _name_to_str(cur.issuer)
        subj_dn = _name_to_str(cur.subject)
        maybe_root = next(
            (r for r in roots if _name_to_str(r.subject) == issuer_dn), None
        )
        if maybe_root:
            _verify_signed_by(cur, maybe_root)
            _verify_self_signed(maybe_root)
            length += 1 if subj_dn != issuer_dn else 0
            return {
                "valid": True,
                "reason": None,
                "chain_len": length,
                "is_ca": _is_ca(leaf),
                "issuer": _name_to_str(leaf.issuer),
                "subject": _name_to_str(leaf.subject),
                "not_before": int(leaf.not_valid_before_utc.timestamp()),
                "not_after": int(leaf.not_valid_after_utc.timestamp()),
                "revocation_checked": False if not check_revocation else False,
            }
        inter = chain_pool.get(issuer_dn)
        if not inter:
            return {"valid": False, "reason": "incomplete_chain"}
        _verify_signed_by(cur, inter)
        cur = inter
        length += 1

parse_cert async

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

Source code in swarmauri_certs_x509/X509CertService.py

async def parse_cert(
    self,
    cert: CertBytes,
    *,
    include_extensions: bool = True,
    opts: Optional[Dict[str, Any]] = None,
) -> Dict[str, Any]:
    c = _load_cert_any(cert)
    out: Dict[str, Any] = {
        "tbs_version": c.version.value,
        "serial": int(c.serial_number),
        "sig_alg": str(c.signature_hash_algorithm.name)
        if c.signature_hash_algorithm
        else "ed25519",
        "issuer": _name_to_mapping(c.issuer),
        "subject": _name_to_mapping(c.subject),
        "not_before": int(c.not_valid_before_utc.timestamp()),
        "not_after": int(c.not_valid_after_utc.timestamp()),
        "is_ca": _is_ca(c),
    }
    if include_extensions:
        try:
            skid = c.extensions.get_extension_for_class(
                x509.SubjectKeyIdentifier
            ).value.digest
            out["skid"] = skid.hex(":")
        except x509.ExtensionNotFound:
            pass
        try:
            akid = c.extensions.get_extension_for_class(
                x509.AuthorityKeyIdentifier
            ).value.key_identifier
            if akid:
                out["akid"] = akid.hex(":")
        except x509.ExtensionNotFound:
            pass
        try:
            san = c.extensions.get_extension_for_class(
                x509.SubjectAlternativeName
            ).value
            out["san"] = {
                "dns": [x.value for x in san.get_values_for_type(x509.DNSName)],
                "ip": [str(x) for x in san.get_values_for_type(x509.IPAddress)],
                "uri": [
                    x.value
                    for x in san.get_values_for_type(x509.UniformResourceIdentifier)
                ],
                "email": [
                    x.value for x in san.get_values_for_type(x509.RFC822Name)
                ],
            }
        except x509.ExtensionNotFound:
            pass
        try:
            eku = c.extensions.get_extension_for_class(x509.ExtendedKeyUsage).value
            out["eku"] = [str(oid.dotted_string) for oid in eku]
        except x509.ExtensionNotFound:
            pass
        try:
            ku = c.extensions.get_extension_for_class(x509.KeyUsage).value
            out["key_usage"] = {
                "digital_signature": ku.digital_signature,
                "content_commitment": ku.content_commitment,
                "key_encipherment": ku.key_encipherment,
                "data_encipherment": ku.data_encipherment,
                "key_agreement": ku.key_agreement,
                "key_cert_sign": ku.key_cert_sign,
                "crl_sign": ku.crl_sign,
                "encipher_only": ku.encipher_only,
                "decipher_only": ku.decipher_only,
            }
        except x509.ExtensionNotFound:
            pass
    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