Source code for pyeudiw.trust.interface

from typing import Any, Callable

from satosa.context import Context
from satosa.response import Response




class TrustEvaluator:
    """
    TrustEvaluator is an interface that defined the expected behaviour of a
    class that, as the very core, can:
    (1) obtain the cryptographic material of an issuer, which might or might not be trusted according to some trust model
    (2) obtain the meta information about an issuer that is defined according to some trust model
    """



    def initialize_istance(self, issuer: str) -> None:
        """
        Initialize the cryptographic material of the issuer, according to some
        trust model.
        """

        raise NotImplementedError




    def get_public_keys(self, issuer: str) -> list[dict]:
        """
        yields the public cryptographic material of the issuer

        :returns: a list of jwk(s); note that those key are _not_ necessarely identified by a kid claim
        """

        raise NotImplementedError




    def get_metadata(self, issuer: str) -> dict:
        """
        yields a dictionary of metadata about an issuer, according to some
        trust model.
        """

        raise NotImplementedError




    def build_metadata_endpoints(
        self, base_path: str
    ) -> list[
        tuple[str, Callable[[Context, Any], Response]]
    ]:
        """
        Return metadata endpoints for this trust evaluator (e.g. keys, config, policies).

        Each item must be a tuple (regex: str, handler: Callable[[Context, Any], Response])
        compatible with satosa.backend.BackendModule.register_endpoints.

        base_path is the module base path and can be used when building the routes.
        Return an empty list if there are no endpoints to expose.
        """

        return []




    def is_revoked(self, issuer: str) -> bool:
        """
        yield if the trust toward the issuer was revoked according to some trust model;
        this asusmed that  the isser exists, is valid, but is not trusted.
        """

        raise NotImplementedError




    def get_policies(self, issuer: str) -> dict:
        raise NotImplementedError("reserved for future uses")




    def get_jwt_header_trust_parameters(self) -> dict:
        raise NotImplementedError