Class swarmauri_certs_remote_ca.RemoteCaCertService.RemoteCaCertService

swarmauri_certs_remote_ca.RemoteCaCertService.RemoteCaCertService

RemoteCaCertService(
    endpoint, *, auth=None, timeout_s=10.0, ca_chain=None
)

Bases: CertServiceBase

Bridge to a remote Certificate Authority over HTTP.

The service forwards certificate signing requests (CSRs) to a remote endpoint and returns the issued certificate. It follows X.509 concepts (RFC 5280) and Enrollment over Secure Transport (EST, RFC 7030).

PARAMETER	DESCRIPTION
endpoint	Base URL of the remote CA sign endpoint. TYPE: str
auth	Authentication headers or an httpx.Auth instance used for each request. TYPE: Mapping[str, str] | Auth DEFAULT: None
timeout_s	HTTP timeout in seconds. Defaults to 10.0. TYPE: float DEFAULT: 10.0
ca_chain	Cached trust anchors exposed when verifying or parsing certificates. TYPE: Sequence[CertBytes] DEFAULT: None

Notes

This service does not generate CSRs; pair it with X509CertService or CsrOnlyService. By default it assumes a JSON API with the request body {"csr": "<base64-PEM-or-DER>"} and response {"cert": "<base64-PEM-or-DER>"}. These mappings can be overridden via opts.

Source code in swarmauri_certs_remote_ca/RemoteCaCertService.py

def __init__(
    self,
    endpoint: str,
    *,
    auth: Optional[Mapping[str, str]] = None,
    timeout_s: float = 10.0,
    ca_chain: Optional[Sequence[CertBytes]] = None,
) -> None:
    super().__init__()
    self._endpoint = endpoint
    self._auth = auth or {}
    self._timeout = timeout_s
    self._ca_chain = ca_chain or []
    self._client: Optional[httpx.AsyncClient] = None

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

Describe capabilities advertised by the service.

RETURNS	DESCRIPTION
Mapping[str, Iterable[str]]	Mapping[str, Iterable[str]]: Supported algorithms, features and
Mapping[str, Iterable[str]]	profiles.

Source code in swarmauri_certs_remote_ca/RemoteCaCertService.py

def supports(self) -> Mapping[str, Iterable[str]]:
    """Describe capabilities advertised by the service.

    Returns:
        Mapping[str, Iterable[str]]: Supported algorithms, features and
        profiles.
    """

    return {
        "key_algs": ("RSA-2048", "RSA-3072", "EC-P256", "Ed25519"),
        "sig_algs": ("RSA-PSS-SHA256", "ECDSA-P256-SHA256", "Ed25519"),
        "features": ("sign_from_csr", "verify", "parse"),
        "profiles": ("server", "client"),
    }

aclose async

aclose()

Close the underlying HTTP client if it exists.

Source code in swarmauri_certs_remote_ca/RemoteCaCertService.py

async def aclose(self) -> None:
    """Close the underlying HTTP client if it exists."""

    if self._client:
        await self._client.aclose()
        self._client = None

create_csr async

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

Unsupported CSR creation operation.

RAISES	DESCRIPTION
NotImplementedError	Always raised since this service cannot create CSRs directly.

Source code in swarmauri_certs_remote_ca/RemoteCaCertService.py

async def create_csr(
    self,
    key: KeyRef,
    subject: SubjectSpec,
    *,
    san: Optional[Dict[str, Any]] = 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:
    """Unsupported CSR creation operation.

    Raises:
        NotImplementedError: Always raised since this service cannot create
            CSRs directly.
    """

    raise NotImplementedError("RemoteCaCertService does not create CSRs directly.")

create_self_signed async

create_self_signed(*a, **kw)

Unsupported self-signed certificate operation.

RAISES	DESCRIPTION
NotImplementedError	Always raised since this service cannot self-sign certificates.

Source code in swarmauri_certs_remote_ca/RemoteCaCertService.py

async def create_self_signed(self, *a, **kw) -> CertBytes:
    """Unsupported self-signed certificate operation.

    Raises:
        NotImplementedError: Always raised since this service cannot
            self-sign certificates.
    """

    raise NotImplementedError(
        "RemoteCaCertService does not self-sign certificates."
    )

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

Request certificate issuance from the remote CA.

PARAMETER	DESCRIPTION
csr	CSR bytes to forward to the remote CA. TYPE: CsrBytes
ca_key	Ignored; present for interface compatibility. TYPE: KeyRef
issuer	Ignored. TYPE: SubjectSpec DEFAULT: None
ca_cert	Ignored. TYPE: CertBytes DEFAULT: None
serial	Ignored. TYPE: int DEFAULT: None
not_before	Ignored. TYPE: int DEFAULT: None
not_after	Ignored. TYPE: int DEFAULT: None
extensions	Extension values to merge into the request. TYPE: CertExtensionSpec DEFAULT: None
sig_alg	Signature algorithm hint. TYPE: str DEFAULT: None
output_der	Whether to return DER instead of PEM. TYPE: bool DEFAULT: False
opts	Extra request options merged into the JSON body under "extra". TYPE: Dict[str, Any] DEFAULT: None

RETURNS	DESCRIPTION
CertBytes	Certificate returned by the remote CA. TYPE: CertBytes

Source code in swarmauri_certs_remote_ca/RemoteCaCertService.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:
    """Request certificate issuance from the remote CA.

    Args:
        csr (CsrBytes): CSR bytes to forward to the remote CA.
        ca_key (KeyRef): Ignored; present for interface compatibility.
        issuer (SubjectSpec, optional): Ignored.
        ca_cert (CertBytes, optional): Ignored.
        serial (int, optional): Ignored.
        not_before (int, optional): Ignored.
        not_after (int, optional): Ignored.
        extensions (CertExtensionSpec, optional): Extension values to merge
            into the request.
        sig_alg (str, optional): Signature algorithm hint.
        output_der (bool, optional): Whether to return DER instead of PEM.
        opts (Dict[str, Any], optional): Extra request options merged into
            the JSON body under ``"extra"``.

    Returns:
        CertBytes: Certificate returned by the remote CA.
    """

    client = await self._get_client()

    # Default: POST JSON with base64 PEM
    payload = {"csr": base64.b64encode(csr).decode("ascii")}
    if opts and "extra" in opts:
        payload.update(opts["extra"])

    resp = await client.post(self._endpoint, json=payload)
    resp.raise_for_status()

    try:
        data = resp.json()
        cert_b64 = data.get("cert")
        if not cert_b64:
            raise ValueError("Remote CA response missing 'cert'")
        cert = base64.b64decode(cert_b64)
    except Exception:
        # fallback: raw body is cert
        cert = resp.content

    return cert

verify_cert async

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

Stub certificate verification.

PARAMETER	DESCRIPTION
cert	Certificate to verify. TYPE: CertBytes
trust_roots	Trusted root certificates. TYPE: Sequence[CertBytes] DEFAULT: None
intermediates	Intermediate certificates. TYPE: Sequence[CertBytes] DEFAULT: None
check_time	Verification time as a UNIX timestamp. TYPE: int DEFAULT: None
check_revocation	Whether to perform revocation checks. TYPE: bool DEFAULT: False
opts	Additional verification options. TYPE: Dict[str, Any] DEFAULT: None

RETURNS	DESCRIPTION
Dict[str, Any]	Dict[str, Any]: Always returns an unsupported verification result.

Source code in swarmauri_certs_remote_ca/RemoteCaCertService.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]:
    """Stub certificate verification.

    Args:
        cert (CertBytes): Certificate to verify.
        trust_roots (Sequence[CertBytes], optional): Trusted root
            certificates.
        intermediates (Sequence[CertBytes], optional): Intermediate
            certificates.
        check_time (int, optional): Verification time as a UNIX timestamp.
        check_revocation (bool, optional): Whether to perform revocation
            checks.
        opts (Dict[str, Any], optional): Additional verification options.

    Returns:
        Dict[str, Any]: Always returns an unsupported verification result.
    """

    # For now: defer to X509CertService or external verifier
    # Here we just acknowledge we can't fully verify.
    return {"valid": False, "reason": "verify_not_supported", "active": False}

parse_cert async

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

Extract minimal information from a certificate.

PARAMETER	DESCRIPTION
cert	Certificate to parse. TYPE: CertBytes
include_extensions	Whether to include extension data in the result. TYPE: bool DEFAULT: True
opts	Reserved for future options. TYPE: Dict[str, Any] DEFAULT: None

RETURNS	DESCRIPTION
Dict[str, Any]	Dict[str, Any]: Length and base64 snippet of the certificate.

Source code in swarmauri_certs_remote_ca/RemoteCaCertService.py

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

    Args:
        cert (CertBytes): Certificate to parse.
        include_extensions (bool, optional): Whether to include extension
            data in the result.
        opts (Dict[str, Any], optional): Reserved for future options.

    Returns:
        Dict[str, Any]: Length and base64 snippet of the certificate.
    """

    # Minimal parse: just length and base64 snippet
    return {
        "len": len(cert),
        "pem_snippet": base64.b64encode(cert[:40]).decode("ascii"),
    }

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