Skip to content

Class swarmauri_certs_x509verify.X509VerifyService.X509VerifyService

swarmauri_certs_x509verify.X509VerifyService.X509VerifyService

Bases: CertServiceBase

Verify and parse X.509 certificates.

ATTRIBUTE DESCRIPTION
type

Component type identifier.

TYPE: Literal['CertServiceBase']

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

Return supported algorithms and features.

Source code in swarmauri_certs_x509verify/X509VerifyService.py
31
32
33
34
35
36
37
def supports(self) -> Mapping[str, Iterable[str]]:
    """Return supported algorithms and features."""
    return {
        "key_algs": ("RSA", "EC", "Ed25519"),
        "sig_algs": ("RSA-PSS-SHA256", "ECDSA-P256-SHA256", "Ed25519"),
        "features": ("verify", "parse"),
    }

verify_cert async

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

Validate a certificate against trust material.

PARAMETER DESCRIPTION
cert

DER or PEM encoded certificate to verify.

TYPE: bytes

trust_roots

Root certificates.

TYPE: Optional[Sequence[bytes]] DEFAULT: None

intermediates

Intermediate certs.

TYPE: Optional[Sequence[bytes]] DEFAULT: None

check_time

Override of verification time in UTC seconds since the epoch. Defaults to current time.

TYPE: Optional[int] DEFAULT: None

check_revocation

Placeholder for revocation checking. Not implemented.

TYPE: bool DEFAULT: False

opts

Additional options (unused).

TYPE: Optional[Dict[str, Any]] DEFAULT: None

RETURNS DESCRIPTION
Dict[str, Any]

Dict[str, Any]: Structured validation result.

Source code in swarmauri_certs_x509verify/X509VerifyService.py
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
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 = False,
    opts: Optional[Dict[str, Any]] = None,
) -> Dict[str, Any]:
    """Validate a certificate against trust material.

    Args:
        cert (bytes): DER or PEM encoded certificate to verify.
        trust_roots (Optional[Sequence[bytes]]): Root certificates.
        intermediates (Optional[Sequence[bytes]]): Intermediate certs.
        check_time (Optional[int]): Override of verification time in UTC
            seconds since the epoch. Defaults to current time.
        check_revocation (bool): Placeholder for revocation checking. Not
            implemented.
        opts (Optional[Dict[str, Any]]): Additional options (unused).

    Returns:
        Dict[str, Any]: Structured validation result.
    """
    now = (
        datetime.datetime.utcfromtimestamp(check_time)
        if check_time
        else datetime.datetime.utcnow()
    )

    cert_obj = (
        x509.load_pem_x509_certificate(cert, default_backend())
        if b"-----BEGIN" in cert
        else x509.load_der_x509_certificate(cert, default_backend())
    )

    roots = [
        x509.load_pem_x509_certificate(root, default_backend())
        if b"-----BEGIN" in root
        else x509.load_der_x509_certificate(root, default_backend())
        for root in trust_roots or []
    ]

    inters = [
        x509.load_pem_x509_certificate(icert, default_backend())
        if b"-----BEGIN" in icert
        else x509.load_der_x509_certificate(icert, default_backend())
        for icert in intermediates or []
    ]

    valid_time = cert_obj.not_valid_before <= now <= cert_obj.not_valid_after

    chain_ok = False
    for candidate in roots + inters:
        if cert_obj.issuer == candidate.subject:
            try:
                pub = candidate.public_key()
                if isinstance(pub, rsa.RSAPublicKey):
                    pub.verify(
                        cert_obj.signature,
                        cert_obj.tbs_certificate_bytes,
                        padding.PKCS1v15(),
                        cert_obj.signature_hash_algorithm,
                    )
                elif isinstance(pub, ec.EllipticCurvePublicKey):
                    pub.verify(
                        cert_obj.signature,
                        cert_obj.tbs_certificate_bytes,
                        ec.ECDSA(cert_obj.signature_hash_algorithm),
                    )
                else:
                    pub.verify(
                        cert_obj.signature,
                        cert_obj.tbs_certificate_bytes,
                    )
                chain_ok = True
                break
            except Exception:  # pragma: no cover - best effort
                pass

    return {
        "valid": valid_time and chain_ok,
        "reason": None if (valid_time and chain_ok) else "invalid_chain_or_time",
        "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()),
        "is_ca": any(
            ext.value.ca
            for ext in cert_obj.extensions
            if isinstance(ext.value, x509.BasicConstraints)
        ),
        "chain_len": 1 + len(inters),
        "revocation_checked": False,
    }

parse_cert async

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

Parse an X.509 certificate into metadata.

PARAMETER DESCRIPTION
cert

DER or PEM encoded certificate.

TYPE: bytes

include_extensions

Whether to parse SAN and EKU.

TYPE: bool DEFAULT: True

opts

Additional options (unused).

TYPE: Optional[Dict[str, Any]] DEFAULT: None

RETURNS DESCRIPTION
Dict[str, Any]

Dict[str, Any]: Parsed certificate information.

Source code in swarmauri_certs_x509verify/X509VerifyService.py
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
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 into metadata.

    Args:
        cert (bytes): DER or PEM encoded certificate.
        include_extensions (bool): Whether to parse SAN and EKU.
        opts (Optional[Dict[str, Any]]): Additional options (unused).

    Returns:
        Dict[str, Any]: Parsed certificate information.
    """
    cert_obj: Certificate = (
        x509.load_pem_x509_certificate(cert, default_backend())
        if b"-----BEGIN" in cert
        else x509.load_der_x509_certificate(cert, default_backend())
    )

    info: Dict[str, Any] = {
        "serial": cert_obj.serial_number,
        "issuer": cert_obj.issuer.rfc4514_string(),
        "subject": cert_obj.subject.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:
        for ext in cert_obj.extensions:
            if isinstance(ext.value, x509.SubjectAlternativeName):
                info["san"] = {"dns": ext.value.get_values_for_type(x509.DNSName)}
            if isinstance(ext.value, x509.ExtendedKeyUsage):
                info["eku"] = [oid._name or oid.dotted_string for oid in ext.value]

    return info

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
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
@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
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
@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
12
13
14
15
16
17
18
19
20
21
22
23
24
@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
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
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
11
12
13
14
15
16
17
18
19
20
21
22
23
@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
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
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
23
24
25
26
27
28
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
21
22
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
25
26
27
28
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
31
32
async def sign_cert(self, *a, **kw):
    raise NotImplementedError("sign_cert() must be implemented by subclass")