Class swarmauri_keyproviders_mirrored.MirroredKeyProvider.MirroredKeyProvider

swarmauri_keyproviders_mirrored.MirroredKeyProvider.MirroredKeyProvider

MirroredKeyProvider(
    primary,
    secondary,
    *,
    mirror_mode="public_only",
    fail_open_reads=True,
)

Bases: KeyProviderBase

Mirror/Failover key provider.

Primary is the system of record. Secondary is best-effort replication: - mirror_mode="full" → replicate private material when policy allows - mirror_mode="public_only" → replicate only public JWK/PEM (verification) - mirror_mode="none" → no replication, but reads may failover

Reads

• get_key/get_public_jwk: primary first; on failure (or missing), try secondary
• jwks(): union (primary dominates on kid collisions)

Writes

• create/import/rotate/destroy: do primary first; if ok, attempt to mirror and record (kid,version) → (sec_kid,sec_version) mapping. Mapping is used for destroy/version lookups on the secondary.

Notes

• We never require secrets from primary to mirror. If policy forbids export, we still mirror public material (when available).
• list_versions() comes from primary. If primary is unavailable, we try secondary (best effort).
• This class is process-memory stateful (mapping). Persist externally if you need cross-process coherence.

Source code in swarmauri_keyproviders_mirrored/MirroredKeyProvider.py

def __init__(
    self,
    primary: IKeyProvider,
    secondary: IKeyProvider,
    *,
    mirror_mode: Literal["full", "public_only", "none"] = "public_only",
    fail_open_reads: bool = True,
) -> None:
    super().__init__()
    self._p = primary
    self._s = secondary
    self._mode = mirror_mode
    self._fail_open_reads = fail_open_reads
    # {(kid -> {version -> _ShadowRef})}
    self._shadow: Dict[str, Dict[int, _ShadowRef]] = {}

type class-attribute instance-attribute

type = 'MirroredKeyProvider'

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

Combine capabilities from primary and secondary.

Source code in swarmauri_keyproviders_mirrored/MirroredKeyProvider.py

def supports(self) -> Mapping[str, Iterable[str]]:
    """Combine capabilities from primary and secondary."""
    try:
        p = self._p.supports()
    except Exception:
        p = {}
    try:
        s = self._s.supports()
    except Exception:
        s = {}

    def _u(k: str) -> Tuple[str, ...]:
        up = tuple(map(str, p.get(k, ())))
        us = tuple(map(str, s.get(k, ())))
        return tuple(dict.fromkeys([*up, *us]))

    feats = list(
        dict.fromkeys([*(p.get("features", ())), *(s.get("features", ()))])
    )
    feats.extend(["mirror", f"mirror:{self._mode}", "failover"])
    return {
        "class": _u("class"),
        "algs": _u("algs"),
        "features": tuple(dict.fromkeys(feats)),
    }

create_key async

create_key(spec)

Source code in swarmauri_keyproviders_mirrored/MirroredKeyProvider.py

async def create_key(self, spec: KeySpec) -> KeyRef:
    pref = await self._p.create_key(spec)
    material: Optional[bytes] = None
    try:
        if spec.export_policy == ExportPolicy.SECRET_WHEN_ALLOWED:
            got = await self._p.get_key(pref.kid, pref.version, include_secret=True)
            material = got.material
    except Exception:
        material = None
    await self._mirror_created(spec, pref, imported_material=material)
    return pref

import_key async

import_key(spec, material, *, public=None)

Source code in swarmauri_keyproviders_mirrored/MirroredKeyProvider.py

async def import_key(
    self, spec: KeySpec, material: bytes, *, public: Optional[bytes] = None
) -> KeyRef:
    pref = await self._p.import_key(spec, material, public=public)
    await self._mirror_created(spec, pref, imported_material=material)
    return pref

rotate_key async

rotate_key(kid, *, spec_overrides=None)

Source code in swarmauri_keyproviders_mirrored/MirroredKeyProvider.py

async def rotate_key(
    self, kid: str, *, spec_overrides: Optional[dict] = None
) -> KeyRef:
    pref = await self._p.rotate_key(kid, spec_overrides=spec_overrides)
    material: Optional[bytes] = None
    try:
        got = await self._p.get_key(pref.kid, pref.version, include_secret=True)
        material = got.material
    except Exception:
        material = None
    await self._mirror_created(
        KeySpec(
            klass=KeyClass.symmetric
            if pref.public is None
            else KeyClass.asymmetric,
            alg=KeyAlg(pref.tags["alg"]),
            size_bits=(spec_overrides or {}).get("size_bits")
            if spec_overrides
            else None,
            label=pref.tags.get("label"),
            export_policy=pref.export_policy,
            uses=tuple(pref.uses),
            tags=pref.tags,
        ),
        pref,
        imported_material=material,
    )
    return pref

destroy_key async

destroy_key(kid, version=None)

Source code in swarmauri_keyproviders_mirrored/MirroredKeyProvider.py

async def destroy_key(self, kid: str, version: Optional[int] = None) -> bool:
    ok = await self._p.destroy_key(kid, version)
    if version is None:
        for v, sref in list(self._shadow.get(kid, {}).items()):
            try:
                await self._s.destroy_key(sref.sec_kid, sref.sec_version)
            except Exception:
                pass
        self._shadow.pop(kid, None)
    else:
        shadow = self._get_shadow(kid, version)
        if shadow:
            try:
                await self._s.destroy_key(shadow.sec_kid, shadow.sec_version)
            except Exception:
                pass
            self._shadow.get(kid, {}).pop(version, None)
            if not self._shadow.get(kid):
                self._shadow.pop(kid, None)
    return ok

get_key async

get_key(kid, version=None, *, include_secret=False)

Source code in swarmauri_keyproviders_mirrored/MirroredKeyProvider.py

async def get_key(
    self, kid: str, version: Optional[int] = None, *, include_secret: bool = False
) -> KeyRef:
    try:
        return await self._p.get_key(kid, version, include_secret=include_secret)
    except Exception as e:
        if not self._fail_open_reads:
            raise
        log.warning(
            "MirroredKeyProvider: primary get_key failed for %s.%s (%s); failing over",
            kid,
            version,
            e,
        )
        if version is not None:
            sref = self._get_shadow(kid, version)
            if sref:
                return await self._s.get_key(
                    sref.sec_kid, sref.sec_version, include_secret=include_secret
                )
        return await self._s.get_key(kid, version, include_secret=include_secret)

list_versions async

list_versions(kid)

Source code in swarmauri_keyproviders_mirrored/MirroredKeyProvider.py

async def list_versions(self, kid: str) -> Tuple[int, ...]:
    try:
        return await self._p.list_versions(kid)
    except Exception as e:
        if not self._fail_open_reads:
            raise
        log.warning(
            "MirroredKeyProvider: primary list_versions failed for %s (%s); trying secondary",
            kid,
            e,
        )
        return await self._s.list_versions(kid)

get_public_jwk async

get_public_jwk(kid, version=None)

Source code in swarmauri_keyproviders_mirrored/MirroredKeyProvider.py

async def get_public_jwk(self, kid: str, version: Optional[int] = None) -> dict:
    try:
        return await self._p.get_public_jwk(kid, version)
    except Exception as e:
        if not self._fail_open_reads:
            raise
        log.warning(
            "MirroredKeyProvider: primary get_public_jwk failed for %s.%s (%s); failing over",
            kid,
            version,
            e,
        )
        if version is not None:
            sref = self._get_shadow(kid, version)
            if sref:
                return await self._s.get_public_jwk(sref.sec_kid, sref.sec_version)
        return await self._s.get_public_jwk(kid, version)

jwks async

jwks(*, prefix_kids=None)

Source code in swarmauri_keyproviders_mirrored/MirroredKeyProvider.py

async def jwks(self, *, prefix_kids: Optional[str] = None) -> dict:
    try:
        p = await self._p.jwks(prefix_kids=prefix_kids)  # type: ignore[arg-type]
    except TypeError:
        p = await self._p.jwks()
    except Exception as e:
        if not self._fail_open_reads:
            raise
        log.warning(
            "MirroredKeyProvider: primary jwks failed (%s); using secondary only", e
        )
        try:
            s = await self._s.jwks(prefix_kids=prefix_kids)  # type: ignore[arg-type]
        except TypeError:
            s = await self._s.jwks()
        return s
    try:
        s = await self._s.jwks(prefix_kids=prefix_kids)  # type: ignore[arg-type]
    except TypeError:
        s = await self._s.jwks()
    except Exception:
        return p
    by_kid: Dict[str, dict] = {}
    for jwk in s.get("keys", []):
        kid = jwk.get("kid")
        if kid:
            by_kid[kid] = jwk
    for jwk in p.get("keys", []):
        kid = jwk.get("kid")
        if kid:
            by_kid[kid] = jwk
    return {"keys": list(by_kid.values())}

random_bytes async

random_bytes(n)

Source code in swarmauri_keyproviders_mirrored/MirroredKeyProvider.py

async def random_bytes(self, n: int) -> bytes:
    try:
        return await self._p.random_bytes(n)
    except Exception as e:
        if not self._fail_open_reads:
            raise
        log.warning(
            "MirroredKeyProvider: primary random_bytes failed (%s); using secondary",
            e,
        )
        return await self._s.random_bytes(n)

hkdf async

hkdf(ikm, *, salt, info, length)

Source code in swarmauri_keyproviders_mirrored/MirroredKeyProvider.py

async def hkdf(self, ikm: bytes, *, salt: bytes, info: bytes, length: int) -> bytes:
    try:
        return await self._p.hkdf(ikm, salt=salt, info=info, length=length)
    except Exception as e:
        if not self._fail_open_reads:
            raise
        log.warning(
            "MirroredKeyProvider: primary hkdf failed (%s); using secondary",
            e,
        )
        return await self._s.hkdf(ikm, salt=salt, info=info, length=length)

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

get_key_by_ref async

get_key_by_ref(key_ref, *, include_secret=False)

Resolve simple URI-style key references into :class:KeyRef objects.

Subclasses must implement provider-specific resolution logic.

Source code in swarmauri_base/keys/KeyProviderBase.py

async def get_key_by_ref(
    self,
    key_ref: str,
    *,
    include_secret: bool = False,
) -> KeyRef:
    """Resolve simple URI-style key references into :class:`KeyRef` objects.

    Subclasses must implement provider-specific resolution logic.
    """

    raise NotImplementedError("get_key_by_ref must be implemented by subclasses")