Class swarmauri_keyprovider_hierarchical.HierarchicalKeyProvider.HierarchicalKeyProvider

swarmauri_keyprovider_hierarchical.HierarchicalKeyProvider.HierarchicalKeyProvider

HierarchicalKeyProvider(
    providers,
    *,
    create_policy=None,
    import_policy=None,
    index_file=None,
    randomness_provider=None,
    derivation_provider=None,
)

Bases: KeyProviderBase

A policy-driven composite IKeyProvider.

Responsibilities

• Route create/import to child providers according to CreateRule policy.
• Maintain a kid → provider-name index (in-memory; optional JSON persistence).
• Forward rotate/destroy/get/list/jwks/hkdf/random to the owning (or designated) provider.
• Merge JWKS from all children.

Notes

• On get_key(kid, ...) for an unknown kid, this class will probe children (in order) until it finds it, then caches kid→provider in the index.
• For random_bytes/hkdf, you can specify a designated provider; defaults to the first.

Source code in swarmauri_keyprovider_hierarchical/HierarchicalKeyProvider.py

def __init__(
    self,
    providers: Mapping[str, IKeyProvider],
    *,
    create_policy: Iterable[CreateRule] | None = None,
    import_policy: Iterable[CreateRule] | None = None,
    index_file: str | os.PathLike | None = None,
    randomness_provider: str | None = None,
    derivation_provider: str | None = None,
) -> None:
    super().__init__()
    if not providers:
        raise ValueError(
            "HierarchicalKeyProvider requires at least one child provider"
        )

    # child providers, keyed by a stable name
    self._children: Dict[str, IKeyProvider] = dict(providers)

    # ordered routing policies
    self._create_rules: Tuple[CreateRule, ...] = tuple(
        CreateRule(
            provider=r.provider,
            klass=r.klass,
            algs=_normalize_iter(r.algs),
            uses=_normalize_iter(r.uses),
            export_policies=_normalize_iter(r.export_policies),
        )
        for r in (create_policy or ())
    )
    self._import_rules: Tuple[CreateRule, ...] = tuple(
        CreateRule(
            provider=r.provider,
            klass=r.klass,
            algs=_normalize_iter(r.algs),
            uses=_normalize_iter(r.uses),
            export_policies=_normalize_iter(r.export_policies),
        )
        for r in (import_policy or ())
    )

    # where to persist kid→provider index (optional)
    self._index_path: Optional[Path] = Path(index_file) if index_file else None
    self._kid_index: Dict[str, str] = {}
    self._mutex = threading.RLock()

    # designate providers for random/hkdf if desired
    self._rand_name = randomness_provider or next(iter(self._children.keys()))
    self._hkdf_name = derivation_provider or self._rand_name

    # load existing index if present
    if self._index_path and self._index_path.exists():
        try:
            data = json.loads(self._index_path.read_text())
            if isinstance(data, dict):
                # validate only known providers
                self._kid_index = {
                    k: v for k, v in data.items() if v in self._children
                }
        except Exception:
            # ignore corrupted index; start fresh
            self._kid_index = {}

type class-attribute instance-attribute

type = 'HierarchicalKeyProvider'

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_keyprovider_hierarchical/HierarchicalKeyProvider.py

def supports(self) -> Mapping[str, Iterable[str]]:
    # Union of capabilities with a couple of meta flags
    out: Dict[str, set] = {
        "class": set(),
        "algs": set(),
        "features": {"hierarchical"},
    }
    for prov in self._children.values():
        caps = prov.supports()
        for k in ("class", "algs", "features"):
            if k in caps:
                out.setdefault(k, set()).update(caps[k])  # type: ignore[arg-type]
    if self._index_path:
        out.setdefault("features", set()).add("index_persistence")
    return {k: tuple(v) for k, v in out.items()}  # type: ignore[return-value]

create_key async

create_key(spec)

Source code in swarmauri_keyprovider_hierarchical/HierarchicalKeyProvider.py

async def create_key(self, spec: KeySpec) -> KeyRef:
    with self._mutex:
        prov = self._pick_by_policy(spec, self._create_rules)
    ref = await prov.create_key(spec)
    with self._mutex:
        self._record_owner_unlocked(ref.kid, self._resolve_name(prov))
    return ref

import_key async

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

Source code in swarmauri_keyprovider_hierarchical/HierarchicalKeyProvider.py

async def import_key(
    self, spec: KeySpec, material: bytes, *, public: Optional[bytes] = None
) -> KeyRef:
    with self._mutex:
        # choose provider using import policy if provided; else reuse create policy
        rules = self._import_rules if self._import_rules else self._create_rules
        prov = self._pick_by_policy(spec, rules)
    ref = await prov.import_key(spec, material, public=public)
    with self._mutex:
        self._record_owner_unlocked(ref.kid, self._resolve_name(prov))
    return ref

rotate_key async

rotate_key(kid, *, spec_overrides=None)

Source code in swarmauri_keyprovider_hierarchical/HierarchicalKeyProvider.py

async def rotate_key(
    self, kid: str, *, spec_overrides: Optional[dict] = None
) -> KeyRef:
    with self._mutex:
        prov = self._owner_unlocked(kid)
    if prov is None:
        # probe children to discover ownership
        prov = await self._probe_owner(kid)
    new_ref = await prov.rotate_key(kid, spec_overrides=spec_overrides)
    # rotation keeps same kid; owner unchanged
    return new_ref

destroy_key async

destroy_key(kid, version=None)

Source code in swarmauri_keyprovider_hierarchical/HierarchicalKeyProvider.py

async def destroy_key(self, kid: str, version: Optional[int] = None) -> bool:
    with self._mutex:
        prov = self._owner_unlocked(kid)
    if prov is None:
        # best effort: try all children
        ok_any = False
        for p in self._children.values():
            try:
                ok = await p.destroy_key(kid, version)
                ok_any = ok_any or ok
            except Exception:
                continue
        if ok_any and version is None:
            with self._mutex:
                self._kid_index.pop(kid, None)
                self._persist_index_unlocked()
        return ok_any
    ok = await prov.destroy_key(kid, version)
    if ok and version is None:
        with self._mutex:
            self._kid_index.pop(kid, None)
            self._persist_index_unlocked()
    return ok

get_key async

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

Source code in swarmauri_keyprovider_hierarchical/HierarchicalKeyProvider.py

async def get_key(
    self, kid: str, version: Optional[int] = None, *, include_secret: bool = False
) -> KeyRef:
    with self._mutex:
        prov = self._owner_unlocked(kid)
    if prov is None:
        prov = await self._probe_owner(kid)
    return await prov.get_key(kid, version, include_secret=include_secret)

list_versions async

list_versions(kid)

Source code in swarmauri_keyprovider_hierarchical/HierarchicalKeyProvider.py

async def list_versions(self, kid: str) -> Tuple[int, ...]:
    with self._mutex:
        prov = self._owner_unlocked(kid)
    if prov is None:
        prov = await self._probe_owner(kid)
    return await prov.list_versions(kid)

get_public_jwk async

get_public_jwk(kid, version=None)

Source code in swarmauri_keyprovider_hierarchical/HierarchicalKeyProvider.py

async def get_public_jwk(self, kid: str, version: Optional[int] = None) -> dict:
    with self._mutex:
        prov = self._owner_unlocked(kid)
    if prov is None:
        prov = await self._probe_owner(kid)
    return await prov.get_public_jwk(kid, version)

jwks async

jwks(*, prefix_kids=None)

Source code in swarmauri_keyprovider_hierarchical/HierarchicalKeyProvider.py

async def jwks(self, *, prefix_kids: Optional[str] = None) -> dict:
    # Merge all children JWKS; keep order stable by provider name
    keys = []
    for name in sorted(self._children.keys()):
        try:
            jwks = await self._children[name].jwks(prefix_kids=prefix_kids)  # type: ignore[arg-type]
        except TypeError:
            # Some providers may not accept prefix_kids; call without it
            jwks = await self._children[name].jwks()
        kid_set = set()
        for k in jwks.get("keys", []):
            # Dedup by kid if multiple providers expose the same public
            kid = k.get("kid")
            if kid and kid not in kid_set:
                keys.append(k)
                kid_set.add(kid)
    return {"keys": keys}

random_bytes async

random_bytes(n)

Source code in swarmauri_keyprovider_hierarchical/HierarchicalKeyProvider.py

async def random_bytes(self, n: int) -> bytes:
    prov = self._children[self._rand_name]
    return await prov.random_bytes(n)

hkdf async

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

Source code in swarmauri_keyprovider_hierarchical/HierarchicalKeyProvider.py

async def hkdf(self, ikm: bytes, *, salt: bytes, info: bytes, length: int) -> bytes:
    prov = self._children[self._hkdf_name]
    return await prov.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")