tba-bases-jose 0.4.0.dev2__tar.gz

tba_bases_jose-0.4.0.dev2/PKG-INFO

@@ -0,0 +1,21 @@
+Metadata-Version: 2.4
+Name: tba-bases-jose
+Version: 0.4.0.dev2
+Summary: Base classes for Tigrbl JOSE providers.
+License-Expression: Apache-2.0
+Requires-Python: >=3.10,<3.15
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Requires-Dist: tba-bases-protected-envelope (==0.4.0.dev2)
+Requires-Dist: tba-bases-token (==0.4.0.dev2)
+Requires-Dist: tba-contracts-identity (==0.4.0.dev2)
+Description-Content-Type: text/markdown
+
+# tba-bases-jose
+
+Base classes connecting JOSE providers to provider-neutral contracts.
+

tba_bases_jose-0.4.0.dev2/README.md

@@ -0,0 +1,3 @@
+# tba-bases-jose
+
+Base classes connecting JOSE providers to provider-neutral contracts.

tba_bases_jose-0.4.0.dev2/pyproject.toml

@@ -0,0 +1,19 @@
+[project]
+name = "tba-bases-jose"
+version = "0.4.0.dev2"
+description = "Base classes for Tigrbl JOSE providers."
+readme = "README.md"
+requires-python = ">=3.10,<3.15"
+license = "Apache-2.0"
+dependencies = [
+    "tba-contracts-identity==0.4.0.dev2",
+    "tba-bases-protected-envelope==0.4.0.dev2",
+    "tba-bases-token==0.4.0.dev2",
+]
+
+[build-system]
+requires = ["poetry-core>=1.0.0"]
+build-backend = "poetry.core.masonry.api"
+
+[tool.poetry]
+packages = [{ include = "tba_bases_jose", from = "src" }]

tba_bases_jose-0.4.0.dev2/src/tba_bases_jose/__init__.py

@@ -0,0 +1,149 @@
+"""Base classes for JOSE providers."""
+
+from abc import ABC
+from typing import Any, Iterable, Mapping
+
+from tba_contracts_identity.jose import (
+    JoseKeySetPort,
+    JwePolicyPort,
+    JwtCoderPort,
+    KeyRotationAdministrationPort,
+    KeyRotationPolicyPort,
+)
+from tba_bases_protected_envelope import (
+    ProtectedEnvelopeIssuerBase,
+    ProtectedEnvelopeVerifierBase,
+)
+from tba_bases_token import ProfiledTokenIssuerBase, ProfiledTokenVerifierBase
+
+
+class JoseEnvelopeIssuerBase(ProtectedEnvelopeIssuerBase):
+    """Issue a protected envelope constrained to a JOSE serialization."""
+
+
+class JoseEnvelopeVerifierBase(ProtectedEnvelopeVerifierBase):
+    """Verify a protected envelope constrained to a JOSE serialization."""
+
+
+class JwtTokenIssuerBase(ProfiledTokenIssuerBase):
+    """Issue tokens constrained to an explicit JWT profile."""
+
+
+class JwtTokenVerifierBase(ProfiledTokenVerifierBase):
+    """Verify tokens constrained to an explicit JWT profile."""
+
+
+class JwtCoderBase(JwtCoderPort, ABC):
+    def sign(self, **kwargs: Any) -> str:
+        raise NotImplementedError
+
+    def verify(self, token: str, **kwargs: Any) -> Mapping[str, Any]:
+        raise NotImplementedError
+
+    def decode(self, token: str, **kwargs: Any) -> Mapping[str, Any]:
+        raise NotImplementedError
+
+
+class JoseKeySetBase(JoseKeySetPort, ABC):
+    @property
+    def keys(self) -> Mapping[str, Any]:
+        raise NotImplementedError
+
+    def add(self, key: Any) -> Any:
+        raise NotImplementedError
+
+    def rotate(self, **kwargs: Any) -> Any:
+        raise NotImplementedError
+
+
+class JwePolicyBase(JwePolicyPort, ABC):
+    def as_header(
+        self, *, typ: str | None = None, cty: str | None = None
+    ) -> Mapping[str, str]:
+        raise NotImplementedError
+
+
+class KeyRotationPolicyBase(KeyRotationPolicyPort, ABC):
+    @property
+    def versions(self) -> Mapping[tuple[str, str], Any]:
+        raise NotImplementedError
+
+    def create_policy_version(
+        self, policy_id: str, version_id: str, **kwargs: Any
+    ) -> Any:
+        raise NotImplementedError
+
+    def approve_policy_version(
+        self, policy_id: str, version_id: str, *, actor: str
+    ) -> Any:
+        raise NotImplementedError
+
+    def publish_policy_version(
+        self, policy_id: str, version_id: str, *, actor: str
+    ) -> Any:
+        raise NotImplementedError
+
+    def effective_policy(self, **scope: str) -> Any | None:
+        raise NotImplementedError
+
+
+class KeyRotationAdministrationBase(KeyRotationAdministrationPort, ABC):
+    @property
+    def audit_records(self) -> Iterable[Any]:
+        raise NotImplementedError
+
+    def view_effective_policy(self, **scope: str) -> Any:
+        raise NotImplementedError
+
+    def execute_rotation(self, **kwargs: Any) -> Any:
+        raise NotImplementedError
+
+
+class SdJwtCoderBase(ABC):
+    def encode_sd_jwt(self, claims: Mapping[str, Any], **kwargs: Any) -> str:
+        raise NotImplementedError
+
+
+class SdJwtDisclosureVerifierBase(ABC):
+    def verify_disclosures(
+        self, token: str, disclosures: Iterable[str], /
+    ) -> Mapping[str, Any]:
+        raise NotImplementedError
+
+
+class SdJwtKeyBindingVerifierBase(ABC):
+    def verify_key_binding(
+        self, key_binding_jwt: str, **kwargs: Any
+    ) -> Mapping[str, Any]:
+        raise NotImplementedError
+
+
+class SetCoderBase(JwtCoderBase):
+    """JWT coder constrained to the RFC 8417 Security Event Token profile."""
+
+
+class EatJwtCoderBase(JwtCoderBase):
+    """JWT coder constrained to an EAT profile."""
+
+
+class WalletAttestationJwtVerifierBase(JwtCoderBase):
+    """JWT verifier constrained to a wallet-attestation profile."""
+
+
+__all__ = [
+    "EatJwtCoderBase",
+    "JoseEnvelopeIssuerBase",
+    "JoseEnvelopeVerifierBase",
+    "JoseKeySetBase",
+    "JwePolicyBase",
+    "JwtCoderBase",
+    "JwtTokenIssuerBase",
+    "JwtTokenVerifierBase",
+    "KeyRotationAdministrationBase",
+    "KeyRotationPolicyBase",
+    "SdJwtCoderBase",
+    "SdJwtDisclosureVerifierBase",
+    "SdJwtKeyBindingVerifierBase",
+    "SetCoderBase",
+    "WalletAttestationJwtVerifierBase",
+]