tba-protocol-credential-iso-mdoc 0.4.0.dev2__tar.gz

tba_protocol_credential_iso_mdoc-0.4.0.dev2/PKG-INFO

@@ -0,0 +1,18 @@
+Metadata-Version: 2.4
+Name: tba-protocol-credential-iso-mdoc
+Version: 0.4.0.dev2
+Summary: 
+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-digital-credential (==0.4.0.dev2)
+Requires-Dist: tba-concrete-mdoc (==0.4.0.dev2)
+Requires-Dist: tba-concrete-mdoc-credential (==0.4.0.dev2)
+Requires-Dist: tba-contracts-identity (==0.4.0.dev2)
+Requires-Dist: tba-provider-mdoc-issuer (==0.4.0.dev2)
+Requires-Dist: tba-provider-mdoc-verifier (==0.4.0.dev2)

tba_protocol_credential_iso_mdoc-0.4.0.dev2/pyproject.toml

@@ -0,0 +1,11 @@
+[project]
+name="tba-protocol-credential-iso-mdoc"
+version="0.4.0.dev2"
+requires-python=">=3.10,<3.15"
+license="Apache-2.0"
+dependencies=["tba-concrete-mdoc==0.4.0.dev2","tba-concrete-mdoc-credential==0.4.0.dev2", "tba-bases-digital-credential==0.4.0.dev2", "tba-contracts-identity==0.4.0.dev2", "tba-provider-mdoc-issuer==0.4.0.dev2", "tba-provider-mdoc-verifier==0.4.0.dev2"]
+[build-system]
+requires=["poetry-core>=1.0.0"]
+build-backend="poetry.core.masonry.api"
+[tool.poetry]
+packages=[{include="tba_protocol_credential_iso_mdoc",from="src"}]

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

@@ -0,0 +1,69 @@
+from .compatibility import IsoMdocCompatibility, compatibility
+from .features import FEATURES_BY_VERSION, supports
+from .errors import IsoMdocProtocolError
+from .migrations import migrate_document
+from .issuance import MdocIssuerProvider
+from .schemas import (
+    DeviceRequest,
+    DeviceResponse,
+    DeviceResponseStatus,
+    DocRequest,
+    IssuerSigned,
+    IssuerSignedItem,
+    ItemsRequest,
+    Mdoc,
+    MobileSecurityObject,
+    SessionTranscript,
+    ValidityInfo,
+    parse_device_request,
+    parse_device_response,
+    parse_issuer_signed,
+    parse_mdoc,
+    parse_mdoc_credential,
+    parse_mobile_security_object,
+)
+from .versions import (
+    CURRENT_VERSION,
+    VERSION_HISTORY,
+    IsoMdocRevision,
+    IsoMdocVersion,
+    select_version,
+)
+from .verification import MdocVerifierProvider
+
+__all__ = [
+    "CURRENT_VERSION",
+    "CAPABILITY_REQUIREMENTS",
+    "DeviceRequest",
+    "DeviceResponse",
+    "DeviceResponseStatus",
+    "DocRequest",
+    "FEATURES_BY_VERSION",
+    "IssuerSigned",
+    "IssuerSignedItem",
+    "ItemsRequest",
+    "Mdoc",
+    "MdocIssuerProvider",
+    "MdocVerifierProvider",
+    "MobileSecurityObject",
+    "SessionTranscript",
+    "VERSION_HISTORY",
+    "ValidityInfo",
+    "IsoMdocCompatibility",
+    "IsoMdocProtocolError",
+    "IsoMdocRevision",
+    "IsoMdocVersion",
+    "compatibility",
+    "migrate_document",
+    "namespace_claims",
+    "parse_device_request",
+    "parse_device_response",
+    "parse_issuer_signed",
+    "parse_mdoc",
+    "parse_mdoc_credential",
+    "parse_mobile_security_object",
+    "select_version",
+    "supports",
+]
+from .bindings import CAPABILITY_REQUIREMENTS
+from .claims import namespace_claims

tba_protocol_credential_iso_mdoc-0.4.0.dev2/src/tba_protocol_credential_iso_mdoc/bindings.py

@@ -0,0 +1,9 @@
+"""Capability bindings required by the ISO mdoc protocol owner."""
+
+CAPABILITY_REQUIREMENTS = (
+    "credential.issue.mdoc",
+    "credential.verify.mdoc",
+    "presentation.verify.mdoc",
+)
+
+__all__ = ["CAPABILITY_REQUIREMENTS"]

tba_protocol_credential_iso_mdoc-0.4.0.dev2/src/tba_protocol_credential_iso_mdoc/claims.py

@@ -0,0 +1,12 @@
+"""ISO mdoc namespace claim material."""
+
+from collections.abc import Mapping
+
+
+def namespace_claims(value: Mapping[str, object]) -> dict[str, object]:
+    """Normalize one namespace without assigning issuer trust."""
+
+    return {str(name): claim for name, claim in value.items()}
+
+
+__all__ = ["namespace_claims"]

tba_protocol_credential_iso_mdoc-0.4.0.dev2/src/tba_protocol_credential_iso_mdoc/compatibility.py

@@ -0,0 +1,21 @@
+from dataclasses import dataclass
+
+from .versions import CURRENT_VERSION
+
+
+@dataclass(frozen=True, slots=True)
+class IsoMdocCompatibility:
+    source: str
+    target: str
+    compatible: bool
+
+
+def compatibility(
+    source: str, target: str = CURRENT_VERSION.value
+) -> IsoMdocCompatibility:
+    return IsoMdocCompatibility(
+        source, target, source == target == CURRENT_VERSION.value
+    )
+
+
+__all__ = ["IsoMdocCompatibility", "compatibility"]

tba_protocol_credential_iso_mdoc-0.4.0.dev2/src/tba_protocol_credential_iso_mdoc/device_request.py

@@ -0,0 +1,10 @@
+"""Versioned ISO mdoc protocol exports backed by deterministic layer-10 models."""
+
+from tba_concrete_mdoc.device_request import (
+    DeviceRequest,
+    DocRequest,
+    ItemsRequest,
+    parse_device_request,
+)
+
+__all__ = ["DeviceRequest", "DocRequest", "ItemsRequest", "parse_device_request"]

tba_protocol_credential_iso_mdoc-0.4.0.dev2/src/tba_protocol_credential_iso_mdoc/device_response.py

@@ -0,0 +1,9 @@
+"""Versioned ISO mdoc protocol exports backed by deterministic layer-10 models."""
+
+from tba_concrete_mdoc.device_response import (
+    DeviceResponse,
+    DeviceResponseStatus,
+    parse_device_response,
+)
+
+__all__ = ["DeviceResponse", "DeviceResponseStatus", "parse_device_response"]

tba_protocol_credential_iso_mdoc-0.4.0.dev2/src/tba_protocol_credential_iso_mdoc/errors.py

@@ -0,0 +1,8 @@
+"""ISO mdoc protocol errors."""
+
+
+class IsoMdocProtocolError(ValueError):
+    """Raised when an ISO mdoc structure violates the selected revision."""
+
+
+__all__ = ["IsoMdocProtocolError"]

tba_protocol_credential_iso_mdoc-0.4.0.dev2/src/tba_protocol_credential_iso_mdoc/features.py

@@ -0,0 +1,15 @@
+from .versions import CURRENT_VERSION, IsoMdocVersion
+
+
+FEATURES_BY_VERSION = {
+    IsoMdocVersion.ISO_18013_5_2021.value: frozenset(
+        {"issuer-signed", "device-signed", "session-transcript", "cbor", "cose"}
+    )
+}
+
+
+def supports(feature: str, version: IsoMdocVersion = CURRENT_VERSION) -> bool:
+    return feature in FEATURES_BY_VERSION[version.value]
+
+
+__all__ = ["FEATURES_BY_VERSION", "supports"]

tba_protocol_credential_iso_mdoc-0.4.0.dev2/src/tba_protocol_credential_iso_mdoc/issuance.py

@@ -0,0 +1,5 @@
+"""Protocol export for the injected ISO mdoc issuance provider."""
+
+from tba_provider_mdoc_issuer import CanonicalCborEncoder, MdocIssuerProvider
+
+__all__ = ["CanonicalCborEncoder", "MdocIssuerProvider"]

tba_protocol_credential_iso_mdoc-0.4.0.dev2/src/tba_protocol_credential_iso_mdoc/issuer_signed.py

@@ -0,0 +1,9 @@
+"""Versioned ISO mdoc protocol exports backed by deterministic layer-10 models."""
+
+from tba_concrete_mdoc.issuer_signed import (
+    IssuerSigned,
+    IssuerSignedItem,
+    parse_issuer_signed,
+)
+
+__all__ = ["IssuerSigned", "IssuerSignedItem", "parse_issuer_signed"]

tba_protocol_credential_iso_mdoc-0.4.0.dev2/src/tba_protocol_credential_iso_mdoc/mdoc.py

@@ -0,0 +1,8 @@
+"""Versioned ISO mdoc protocol exports backed by deterministic layer-10 models."""
+
+from tba_concrete_mdoc.mdoc import (
+    Mdoc,
+    parse_mdoc,
+)
+
+__all__ = ["Mdoc", "parse_mdoc"]

tba_protocol_credential_iso_mdoc-0.4.0.dev2/src/tba_protocol_credential_iso_mdoc/migrations.py

@@ -0,0 +1,12 @@
+from typing import Mapping
+
+from .versions import CURRENT_VERSION
+
+
+def migrate_document(value: Mapping[str, object], *, source: str) -> dict[str, object]:
+    if source != CURRENT_VERSION.value:
+        raise ValueError(f"no ISO mdoc migration path from {source}")
+    return dict(value)
+
+
+__all__ = ["migrate_document"]

tba_protocol_credential_iso_mdoc-0.4.0.dev2/src/tba_protocol_credential_iso_mdoc/mobile_security_object.py

@@ -0,0 +1,9 @@
+"""Versioned ISO mdoc protocol exports backed by deterministic layer-10 models."""
+
+from tba_concrete_mdoc.mobile_security_object import (
+    MobileSecurityObject,
+    ValidityInfo,
+    parse_mobile_security_object,
+)
+
+__all__ = ["MobileSecurityObject", "ValidityInfo", "parse_mobile_security_object"]

tba_protocol_credential_iso_mdoc-0.4.0.dev2/src/tba_protocol_credential_iso_mdoc/py.typed

@@ -0,0 +1 @@
+

tba_protocol_credential_iso_mdoc-0.4.0.dev2/src/tba_protocol_credential_iso_mdoc/schemas.py

@@ -0,0 +1,41 @@
+"""Versioned ISO mdoc protocol exports backed by deterministic layer-10 models."""
+
+from tba_concrete_mdoc.schemas import (
+    DeviceRequest,
+    DeviceResponse,
+    DeviceResponseStatus,
+    DocRequest,
+    IssuerSigned,
+    IssuerSignedItem,
+    ItemsRequest,
+    Mdoc,
+    MobileSecurityObject,
+    SessionTranscript,
+    ValidityInfo,
+    parse_device_request,
+    parse_device_response,
+    parse_issuer_signed,
+    parse_mdoc,
+    parse_mdoc_credential,
+    parse_mobile_security_object,
+)
+
+__all__ = [
+    "DeviceRequest",
+    "DeviceResponse",
+    "DeviceResponseStatus",
+    "DocRequest",
+    "IssuerSigned",
+    "IssuerSignedItem",
+    "ItemsRequest",
+    "Mdoc",
+    "MobileSecurityObject",
+    "SessionTranscript",
+    "ValidityInfo",
+    "parse_device_request",
+    "parse_device_response",
+    "parse_issuer_signed",
+    "parse_mdoc",
+    "parse_mdoc_credential",
+    "parse_mobile_security_object",
+]

tba_protocol_credential_iso_mdoc-0.4.0.dev2/src/tba_protocol_credential_iso_mdoc/session_transcript.py

@@ -0,0 +1,7 @@
+"""Versioned ISO mdoc protocol exports backed by deterministic layer-10 models."""
+
+from tba_concrete_mdoc.session_transcript import (
+    SessionTranscript,
+)
+
+__all__ = ["SessionTranscript"]

tba_protocol_credential_iso_mdoc-0.4.0.dev2/src/tba_protocol_credential_iso_mdoc/verification.py

@@ -0,0 +1,15 @@
+"""Protocol export for the injected ISO mdoc verification provider."""
+
+from tba_provider_mdoc_verifier import (
+    CanonicalCborEncoder,
+    CborDecoder,
+    CosePayloadDecoder,
+    MdocVerifierProvider,
+)
+
+__all__ = [
+    "CanonicalCborEncoder",
+    "CborDecoder",
+    "CosePayloadDecoder",
+    "MdocVerifierProvider",
+]

tba_protocol_credential_iso_mdoc-0.4.0.dev2/src/tba_protocol_credential_iso_mdoc/versions.py

@@ -0,0 +1,39 @@
+from dataclasses import dataclass
+from enum import StrEnum
+
+
+class IsoMdocVersion(StrEnum):
+    ISO_18013_5_2021 = "ISO/IEC 18013-5:2021"
+
+
+@dataclass(frozen=True, slots=True)
+class IsoMdocRevision:
+    identifier: str
+    status: str
+    specification: str
+
+
+CURRENT_VERSION = IsoMdocVersion.ISO_18013_5_2021
+VERSION_HISTORY = {
+    CURRENT_VERSION.value: IsoMdocRevision(
+        CURRENT_VERSION.value,
+        "international-standard",
+        "ISO/IEC 18013-5:2021",
+    )
+}
+
+
+def select_version(value: str | IsoMdocVersion) -> IsoMdocVersion:
+    version = IsoMdocVersion(value)
+    if version.value not in VERSION_HISTORY:
+        raise ValueError(f"unsupported ISO mdoc revision: {value}")
+    return version
+
+
+__all__ = [
+    "CURRENT_VERSION",
+    "VERSION_HISTORY",
+    "IsoMdocRevision",
+    "IsoMdocVersion",
+    "select_version",
+]