Class swarmauri_certs_crlverifyservice.CrlVerifyService.CrlVerifyService

swarmauri_certs_crlverifyservice.CrlVerifyService.CrlVerifyService

Bases: CertServiceBase

Certificate Revocation List (CRL) verification service.

Implements verify_cert and parse_cert against CRLs, following RFC 5280. This service does not issue or sign certificates (CSR, self-signed, and sign-cert methods remain NotImplemented).

Capabilities

• verify_cert(cert, trust_roots, crls=...): check validity window, issuer match, and revocation against provided CRLs.
• parse_cert(cert): extract minimal metadata for inspection.

type class-attribute instance-attribute

type = 'CrlVerifyService'

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_crlverifyservice/CrlVerifyService.py

def supports(self) -> Mapping[str, Iterable[str]]:
    return {"features": ("verify", "parse", "crl")}

verify_cert async

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

Verify an X.509 certificate against CRLs.

PARAMETER	DESCRIPTION
cert	The certificate data in PEM or DER encoding. TYPE: bytes
trust_roots	Trusted root certificates used for chain validation. Defaults to None. TYPE: Optional[Sequence[bytes]] DEFAULT: None
intermediates	Intermediate certificates for building the chain. Defaults to None. TYPE: Optional[Sequence[bytes]] DEFAULT: None
check_time	Unix timestamp used to evaluate the certificate validity period. Defaults to current time. TYPE: Optional[int] DEFAULT: None
check_revocation	Whether to verify revocation status. Defaults to True. TYPE: bool DEFAULT: True
crls	CRLs to check for revocation status. Defaults to None. TYPE: Optional[Sequence[bytes]] DEFAULT: None
opts	Implementation-specific options. TYPE: Optional[Dict[str, Any]] DEFAULT: None

RETURNS	DESCRIPTION
Dict[str, Any]	Dict[str, Any]: A dictionary describing the verification result,
Dict[str, Any]	including validity and revocation status.

Source code in swarmauri_certs_crlverifyservice/CrlVerifyService.py

async def verify_cert(
    self,
    cert: bytes,
    *,
    trust_roots: Optional[Sequence[bytes]] = None,
    intermediates: Optional[Sequence[bytes]] = None,
    check_time: Optional[int] = None,
    check_revocation: bool = True,
    crls: Optional[Sequence[bytes]] = None,
    opts: Optional[Dict[str, Any]] = None,
) -> Dict[str, Any]:
    """Verify an X.509 certificate against CRLs.

    Args:
        cert (bytes): The certificate data in PEM or DER encoding.
        trust_roots (Optional[Sequence[bytes]]): Trusted root certificates
            used for chain validation. Defaults to ``None``.
        intermediates (Optional[Sequence[bytes]]): Intermediate
            certificates for building the chain. Defaults to ``None``.
        check_time (Optional[int]): Unix timestamp used to evaluate the
            certificate validity period. Defaults to current time.
        check_revocation (bool): Whether to verify revocation status.
            Defaults to ``True``.
        crls (Optional[Sequence[bytes]]): CRLs to check for revocation
            status. Defaults to ``None``.
        opts (Optional[Dict[str, Any]]): Implementation-specific options.

    Returns:
        Dict[str, Any]: A dictionary describing the verification result,
        including validity and revocation status.
    """
    now = datetime.datetime.utcfromtimestamp(
        check_time or datetime.datetime.utcnow().timestamp()
    )

    cert_obj: Certificate = x509.load_pem_x509_certificate(cert, default_backend())
    out: Dict[str, Any] = {
        "valid": True,
        "reason": None,
        "subject": cert_obj.subject.rfc4514_string(),
        "issuer": cert_obj.issuer.rfc4514_string(),
        "not_before": int(cert_obj.not_valid_before.timestamp()),
        "not_after": int(cert_obj.not_valid_after.timestamp()),
        "revoked": False,
    }

    if now < cert_obj.not_valid_before or now > cert_obj.not_valid_after:
        out["valid"] = False
        out["reason"] = "expired_or_not_yet_valid"

    if check_revocation and crls:
        for crl_bytes in crls:
            try:
                crl = x509.load_pem_x509_crl(crl_bytes, default_backend())
            except ValueError:
                crl = x509.load_der_x509_crl(crl_bytes, default_backend())
            if crl.issuer == cert_obj.issuer:
                if crl.get_revoked_certificate_by_serial_number(
                    cert_obj.serial_number
                ):
                    out["valid"] = False
                    out["revoked"] = True
                    out["reason"] = "revoked"
                    break

    return out

parse_cert async

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

Parse an X.509 certificate and extract metadata.

PARAMETER	DESCRIPTION
cert	The certificate data in PEM encoding. TYPE: bytes
include_extensions	Whether to include common extensions in the output. Defaults to True. TYPE: bool DEFAULT: True
opts	Additional options for parsing. TYPE: Optional[Dict[str, Any]] DEFAULT: None

RETURNS	DESCRIPTION
Dict[str, Any]	Dict[str, Any]: Metadata extracted from the certificate such as
Dict[str, Any]	subject, issuer, validity window, and optional extensions.

Source code in swarmauri_certs_crlverifyservice/CrlVerifyService.py

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

    Args:
        cert (bytes): The certificate data in PEM encoding.
        include_extensions (bool): Whether to include common extensions in
            the output. Defaults to ``True``.
        opts (Optional[Dict[str, Any]]): Additional options for parsing.

    Returns:
        Dict[str, Any]: Metadata extracted from the certificate such as
        subject, issuer, validity window, and optional extensions.
    """
    cert_obj: Certificate = x509.load_pem_x509_certificate(cert, default_backend())
    out: Dict[str, Any] = {
        "serial": cert_obj.serial_number,
        "subject": cert_obj.subject.rfc4514_string(),
        "issuer": cert_obj.issuer.rfc4514_string(),
        "not_before": int(cert_obj.not_valid_before.timestamp()),
        "not_after": int(cert_obj.not_valid_after.timestamp()),
        "sig_alg": cert_obj.signature_algorithm_oid._name,
    }

    if include_extensions:
        try:
            bc = cert_obj.extensions.get_extension_for_oid(
                ExtensionOID.BASIC_CONSTRAINTS
            ).value
            out["basic_constraints"] = {"ca": bc.ca, "path_len": bc.path_length}
        except ExtensionNotFound:
            pass

        try:
            ku = cert_obj.extensions.get_extension_for_oid(
                ExtensionOID.KEY_USAGE
            ).value
            out["key_usage"] = {
                "digital_signature": ku.digital_signature,
                "key_encipherment": ku.key_encipherment,
                "key_cert_sign": ku.key_cert_sign,
            }
        except 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

create_csr async

create_csr(*a, **kw)

Source code in swarmauri_base/certs/CertServiceBase.py

async def create_csr(self, *a, **kw):
    raise NotImplementedError("create_csr() must be implemented by subclass")

create_self_signed async

create_self_signed(*a, **kw)

Source code in swarmauri_base/certs/CertServiceBase.py

async def create_self_signed(self, *a, **kw):
    raise NotImplementedError(
        "create_self_signed() must be implemented by subclass"
    )

sign_cert async

sign_cert(*a, **kw)

Source code in swarmauri_base/certs/CertServiceBase.py

async def sign_cert(self, *a, **kw):
    raise NotImplementedError("sign_cert() must be implemented by subclass")