Class swarmauri_keyprovider_remote_jwks.RemoteJwksKeyProvider.RemoteJwksKeyProvider

swarmauri_keyprovider_remote_jwks.RemoteJwksKeyProvider.RemoteJwksKeyProvider

RemoteJwksKeyProvider(
    jwks_url=None,
    *,
    issuer=None,
    cache_ttl_s=300,
    request_timeout_s=5,
    user_agent="RemoteJwksKeyProvider/1.0",
)

Bases: KeyProviderBase

Key provider backed by a remote JWKS with local key management support.

Features

• Accepts either a direct JWKS URL or an OIDC issuer URL.
• Resolves OIDC discovery: /.well-known/openid-configuration → jwks_uri.
• Caches the JWKS in-memory with TTL; thread-safe refresh with ETag/If-Modified-Since.
• Exposes get_public_jwk() and jwks() to verifiers (e.g., JWTTokenService.verify()).
• Supports local key creation/rotation/import/destroy via an in-memory provider.
• Provides random_bytes() and hkdf() for convenience (local ops).

Constructor

RemoteJwksKeyProvider( jwks_url: Optional[str] = None, *, issuer: Optional[str] = None, cache_ttl_s: int = 300, request_timeout_s: int = 5, user_agent: str = "RemoteJwksKeyProvider/1.0", )

Notes

• If both issuer and jwks_url are provided, jwks_url wins.
• KIDs may include version suffixes like "kid.version" to match your codebase.
• Remote keys remain verification-only; locally created keys are stored in-memory.

Source code in swarmauri_keyprovider_remote_jwks/RemoteJwksKeyProvider.py

def __init__(
    self,
    jwks_url: Optional[str] = None,
    *,
    issuer: Optional[str] = None,
    cache_ttl_s: int = 300,
    request_timeout_s: int = 5,
    user_agent: str = "RemoteJwksKeyProvider/1.0",
) -> None:
    super().__init__()
    if not jwks_url and not issuer:
        raise ValueError("Provide either jwks_url or issuer")
    self._jwks_url = jwks_url
    self._issuer = issuer.rstrip("/") if issuer else None
    self._cache_ttl_s = int(cache_ttl_s)
    self._request_timeout_s = int(request_timeout_s)
    self._ua = user_agent

    # Resolve issuer → jwks_uri on init if needed (lazy fallback on first use if fails)
    if self._jwks_url is None and self._issuer:
        try:
            self._jwks_url = self._resolve_jwks_uri(self._issuer)
        except Exception:
            # Defer to first use; do not fail constructor for transient network issues
            pass

type class-attribute instance-attribute

type = 'RemoteJwksKeyProvider'

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_remote_jwks/RemoteJwksKeyProvider.py

def supports(self) -> Mapping[str, Iterable[str]]:
    return {
        "class": ("sym", "asym"),
        "algs": ("RSA", "EC", "OKP", "oct"),  # JWKS kty families we may encounter
        "features": ("create", "import", "rotate", "destroy", "jwks", "refresh"),
    }

create_key async

create_key(spec)

Source code in swarmauri_keyprovider_remote_jwks/RemoteJwksKeyProvider.py

async def create_key(self, spec: KeySpec) -> KeyRef:
    return await self._local.create_key(spec)

import_key async

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

Source code in swarmauri_keyprovider_remote_jwks/RemoteJwksKeyProvider.py

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

rotate_key async

rotate_key(kid, *, spec_overrides=None)

Source code in swarmauri_keyprovider_remote_jwks/RemoteJwksKeyProvider.py

async def rotate_key(
    self, kid: str, *, spec_overrides: Optional[dict] = None
) -> KeyRef:
    return await self._local.rotate_key(kid, spec_overrides=spec_overrides)

destroy_key async

destroy_key(kid, version=None)

Source code in swarmauri_keyprovider_remote_jwks/RemoteJwksKeyProvider.py

async def destroy_key(self, kid: str, version: Optional[int] = None) -> bool:
    return await self._local.destroy_key(kid, version)

get_key async

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

Return a KeyRef for the given kid(.version) if present in JWKS. Secrets are never exported; material=None.

Source code in swarmauri_keyprovider_remote_jwks/RemoteJwksKeyProvider.py

async def get_key(
    self, kid: str, version: Optional[int] = None, *, include_secret: bool = False
) -> KeyRef:
    """
    Return a KeyRef for the given kid(.version) if present in JWKS.
    Secrets are never exported; material=None.
    """
    try:
        return await self._local.get_key(
            kid, version, include_secret=include_secret
        )
    except KeyError:
        pass
    jwk = await self._find_jwk(kid, version)
    if jwk is None:
        raise KeyError(f"Unknown key id: {kid!r} (version={version!r})")

    # For compatibility with your KeyRef, we put the public JWK bytes into 'public'
    # (wire consumers typically use jwks() directly; this is mainly for parity).
    public_bytes = json.dumps(jwk, separators=(",", ":"), sort_keys=True).encode(
        "utf-8"
    )
    parsed_kid, parsed_ver = self._split_kid_version(jwk.get("kid", ""))

    return _RemoteKeyRef(
        kid=parsed_kid or kid,
        version=parsed_ver or (version if version is not None else 1),
        type="OPAQUE",
        uses=(KeyUse.VERIFY,),  # verification only
        export_policy=ExportPolicy.PUBLIC_ONLY,
        public=public_bytes,
        material=None,
        tags={"kty": jwk.get("kty"), "alg": jwk.get("alg")},
        fingerprint=self._fingerprint(public=public_bytes, kid=parsed_kid or kid),
    )

list_versions async

list_versions(kid)

Returns any discovered versions for the kid when keys are of the form 'kid.version'. If no version suffixes are found, returns (1,) when the base kid exists, else ().

Source code in swarmauri_keyprovider_remote_jwks/RemoteJwksKeyProvider.py

async def list_versions(self, kid: str) -> Tuple[int, ...]:
    """
    Returns any discovered versions for the kid when keys are of the form 'kid.version'.
    If no version suffixes are found, returns (1,) when the base kid exists, else ().
    """
    try:
        return await self._local.list_versions(kid)
    except KeyError:
        pass
    keys = await self._get_jwks_keys()
    versions: set[int] = set()
    found_plain = False
    for jwk in keys:
        k = jwk.get("kid") or ""
        base, ver = self._split_kid_version(k)
        if base == kid:
            if ver is None:
                found_plain = True
            else:
                versions.add(ver)
    if versions:
        return tuple(sorted(versions))
    return (1,) if found_plain else tuple()

get_public_jwk async

get_public_jwk(kid, version=None)

Source code in swarmauri_keyprovider_remote_jwks/RemoteJwksKeyProvider.py

async def get_public_jwk(self, kid: str, version: Optional[int] = None) -> dict:
    try:
        return await self._local.get_public_jwk(kid, version)
    except Exception:
        pass
    jwk = await self._find_jwk(kid, version)
    if jwk is None:
        raise KeyError(f"Unknown key id: {kid!r} (version={version!r})")
    return jwk

jwks async

jwks(*, prefix_kids=None)

Source code in swarmauri_keyprovider_remote_jwks/RemoteJwksKeyProvider.py

async def jwks(self, *, prefix_kids: Optional[str] = None) -> dict:
    keys: list[dict] = []
    try:
        local = await self._local.jwks(prefix_kids=prefix_kids)
        keys.extend(local.get("keys", []))
    except Exception:
        pass
    remote = await self._get_jwks_keys()
    if prefix_kids:
        remote = [k for k in remote if (k.get("kid") or "").startswith(prefix_kids)]
    existing = {k.get("kid") for k in keys}
    for jwk in remote:
        if jwk.get("kid") not in existing:
            keys.append(jwk)
    return {"keys": keys}

random_bytes async

random_bytes(n)

Source code in swarmauri_keyprovider_remote_jwks/RemoteJwksKeyProvider.py

async def random_bytes(self, n: int) -> bytes:
    return secrets.token_bytes(n)

hkdf async

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

Source code in swarmauri_keyprovider_remote_jwks/RemoteJwksKeyProvider.py

async def hkdf(self, ikm: bytes, *, salt: bytes, info: bytes, length: int) -> bytes:
    return HKDF(
        algorithm=hashes.SHA256(), length=length, salt=salt, info=info
    ).derive(ikm)

refresh

refresh(*, force=False)

Synchronous refresh of JWKS cache. Safe to call before latency-sensitive paths.

Source code in swarmauri_keyprovider_remote_jwks/RemoteJwksKeyProvider.py

def refresh(self, *, force: bool = False) -> None:
    """
    Synchronous refresh of JWKS cache. Safe to call before latency-sensitive paths.
    """
    with self._lock:
        self._ensure_jwks_locked(force=force)

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