tba-protocol-attestation-corim 0.4.0.dev2__tar.gz

tba_protocol_attestation_corim-0.4.0.dev2/PKG-INFO

@@ -0,0 +1,14 @@
+Metadata-Version: 2.4
+Name: tba-protocol-attestation-corim
+Version: 0.4.0.dev2
+Summary: Versioned CoRIM-family protocol profile and capability mapping.
+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-concrete-corim (==0.4.0.dev2)
+Requires-Dist: tba-contracts-identity (==0.4.0.dev2)

tba_protocol_attestation_corim-0.4.0.dev2/pyproject.toml

@@ -0,0 +1,17 @@
+[project]
+name = "tba-protocol-attestation-corim"
+version = "0.4.0.dev2"
+description = "Versioned CoRIM-family protocol profile and capability mapping."
+requires-python = ">=3.10,<3.15"
+license = "Apache-2.0"
+dependencies = [
+    "tba-concrete-corim==0.4.0.dev2",
+    "tba-contracts-identity==0.4.0.dev2",
+]
+
+[build-system]
+requires = ["poetry-core>=1.0.0"]
+build-backend = "poetry.core.masonry.api"
+
+[tool.poetry]
+packages = [{ include = "tba_protocol_attestation_corim", from = "src" }]

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

@@ -0,0 +1,63 @@
+"""Versioned CoRIM-family reference-material profile ownership."""
+
+from tba_contracts_identity.protocol_processing import (
+    build_protocol_capability_report,
+)
+
+from .bindings import CAPABILITY_REQUIREMENTS
+from .claims import CORIM_CLAIM_CLASSES, CORIM_MAP_FIELDS
+from .compatibility import COMPATIBILITY_PATHS, CorimCompatibility, compatibility
+from .errors import (
+    CorimProtocolError,
+    CorimReferenceIntegrityError,
+    UnsupportedCorimMediaTypeError,
+)
+from .features import FEATURES_BY_VERSION, supports
+from .migrations import migrate_document
+from .schemas import (
+    CORIM_CARRIERS,
+    CORIM_SIGNED_CARRIER,
+    CORIM_UNSIGNED_CARRIER,
+    CorimCarrier,
+    select_carrier,
+)
+from .versions import CURRENT_VERSION, VERSION_HISTORY, CorimVersion, select_version
+
+
+def capability_report() -> dict[str, object]:
+    report = build_protocol_capability_report(
+        protocol="corim",
+        revision=CURRENT_VERSION.identifier,
+        features=tuple(FEATURES_BY_VERSION[CURRENT_VERSION.identifier]),
+        evidence_links=("tests/unit/test_corim_protocol_versioning.py",),
+        extra_requirements=CAPABILITY_REQUIREMENTS,
+        include_default_artifact_requirements=False,
+    )
+    report["status"] = CURRENT_VERSION.status
+    return report
+
+
+__all__ = [
+    "CAPABILITY_REQUIREMENTS",
+    "COMPATIBILITY_PATHS",
+    "CORIM_CARRIERS",
+    "CORIM_CLAIM_CLASSES",
+    "CORIM_MAP_FIELDS",
+    "CORIM_SIGNED_CARRIER",
+    "CORIM_UNSIGNED_CARRIER",
+    "CURRENT_VERSION",
+    "FEATURES_BY_VERSION",
+    "VERSION_HISTORY",
+    "CorimCarrier",
+    "CorimCompatibility",
+    "CorimProtocolError",
+    "CorimReferenceIntegrityError",
+    "CorimVersion",
+    "UnsupportedCorimMediaTypeError",
+    "capability_report",
+    "compatibility",
+    "migrate_document",
+    "select_carrier",
+    "select_version",
+    "supports",
+]

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

@@ -0,0 +1,56 @@
+"""CoRIM artifact operations mapped to semantic capabilities."""
+
+from tba_contracts_identity.capabilities import ProtocolCapabilityRequirement
+
+from .versions import CURRENT_VERSION
+
+CAPABILITY_REQUIREMENTS = (
+    ProtocolCapabilityRequirement(
+        "corim",
+        CURRENT_VERSION.identifier,
+        "corim-cbor-decode",
+        "signed or unsigned CoRIM CBOR",
+        "artifact.processing",
+        "decode",
+        "corim-reference-manifest",
+    ),
+    ProtocolCapabilityRequirement(
+        "corim",
+        CURRENT_VERSION.identifier,
+        "corim-validation",
+        "CoRIM/CoMID/CoSWID/CoTL/CoTS",
+        "artifact.processing",
+        "validate",
+        "validated-reference-manifest",
+    ),
+    ProtocolCapabilityRequirement(
+        "corim",
+        CURRENT_VERSION.identifier,
+        "corim-cbor-encode",
+        "signed or unsigned CoRIM CBOR",
+        "artifact.processing",
+        "encode",
+        "corim",
+    ),
+    ProtocolCapabilityRequirement(
+        "corim",
+        CURRENT_VERSION.identifier,
+        "corim-reference-resolution",
+        "tag-identity",
+        "attestation.appraisal",
+        "resolve_reference_material",
+        "attestation-reference-manifest",
+    ),
+    ProtocolCapabilityRequirement(
+        "corim",
+        CURRENT_VERSION.identifier,
+        "corim-appraisal-consumption",
+        "reference values and endorsements",
+        "attestation.appraisal",
+        "appraise",
+        "attestation-appraisal-result",
+        required=False,
+    ),
+)
+
+__all__ = ["CAPABILITY_REQUIREMENTS"]

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

@@ -0,0 +1,16 @@
+"""CoRIM family map-field ownership.
+
+CoRIM does not register JWT/CWT claims. Its concise map fields describe
+reference values, endorsements, trust lists, and trust stores.
+"""
+
+CORIM_CLAIM_CLASSES: tuple[type, ...] = ()
+CORIM_MAP_FIELDS = (
+    "tag-identity",
+    "profile",
+    "tags",
+    "validity",
+    "entities",
+)
+
+__all__ = ["CORIM_CLAIM_CLASSES", "CORIM_MAP_FIELDS"]

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

@@ -0,0 +1,42 @@
+"""CoRIM draft compatibility paths."""
+
+from dataclasses import dataclass
+
+from .versions import CURRENT_VERSION, VERSION_HISTORY
+
+
+@dataclass(frozen=True, slots=True)
+class CorimCompatibility:
+    source: str
+    target: str
+    compatible: bool
+    migration_required: bool
+
+
+COMPATIBILITY_PATHS = (
+    CorimCompatibility(
+        VERSION_HISTORY[0].identifier,
+        CURRENT_VERSION.identifier,
+        True,
+        True,
+    ),
+    CorimCompatibility(
+        CURRENT_VERSION.identifier,
+        CURRENT_VERSION.identifier,
+        True,
+        False,
+    ),
+)
+
+
+def compatibility(
+    source: str,
+    target: str = CURRENT_VERSION.identifier,
+) -> CorimCompatibility:
+    for path in COMPATIBILITY_PATHS:
+        if path.source == source and path.target == target:
+            return path
+    return CorimCompatibility(source, target, False, False)
+
+
+__all__ = ["COMPATIBILITY_PATHS", "CorimCompatibility", "compatibility"]

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

@@ -0,0 +1,20 @@
+"""CoRIM protocol/profile mapping errors."""
+
+
+class CorimProtocolError(ValueError):
+    """Base error for a selected CoRIM draft mapping."""
+
+
+class UnsupportedCorimMediaTypeError(CorimProtocolError):
+    """Raised when no selected signed/unsigned CoRIM carrier applies."""
+
+
+class CorimReferenceIntegrityError(CorimProtocolError):
+    """Raised when reference material fails integrity/profile validation."""
+
+
+__all__ = [
+    "CorimProtocolError",
+    "CorimReferenceIntegrityError",
+    "UnsupportedCorimMediaTypeError",
+]

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

@@ -0,0 +1,16 @@
+FEATURES_BY_VERSION = {
+    "draft-ietf-rats-corim-10": frozenset({"corim", "comid", "coswid"}),
+    "draft-ietf-rats-corim-11": frozenset(
+        {"corim", "comid", "coswid", "cotl", "cots", "reference-values", "endorsements"}
+    ),
+}
+
+
+def supports(version: str, feature: str) -> bool:
+    try:
+        return feature in FEATURES_BY_VERSION[version]
+    except KeyError as exc:
+        raise ValueError(f"unsupported CoRIM version: {version}") from exc
+
+
+__all__ = ["FEATURES_BY_VERSION", "supports"]

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

@@ -0,0 +1,19 @@
+from collections.abc import Mapping
+
+
+def migrate_document(
+    document: Mapping[str, object], *, from_version: str, to_version: str
+) -> dict[str, object]:
+    if from_version == to_version:
+        return dict(document)
+    if (from_version, to_version) == (
+        "draft-ietf-rats-corim-10",
+        "draft-ietf-rats-corim-11",
+    ):
+        migrated = dict(document)
+        migrated.setdefault("profile", "tag:ietf.org,2025:corim")
+        return migrated
+    raise ValueError(f"unsupported CoRIM migration: {from_version} -> {to_version}")
+
+
+__all__ = ["migrate_document"]

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

@@ -0,0 +1 @@
+

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

@@ -0,0 +1,32 @@
+"""CoRIM family carrier descriptors."""
+
+from dataclasses import dataclass
+
+from .errors import UnsupportedCorimMediaTypeError
+
+
+@dataclass(frozen=True, slots=True)
+class CorimCarrier:
+    media_type: str
+    signed: bool
+
+
+CORIM_UNSIGNED_CARRIER = CorimCarrier("application/corim-unsigned+cbor", False)
+CORIM_SIGNED_CARRIER = CorimCarrier("application/corim-signed+cbor", True)
+CORIM_CARRIERS = (CORIM_UNSIGNED_CARRIER, CORIM_SIGNED_CARRIER)
+
+
+def select_carrier(media_type: str) -> CorimCarrier:
+    for carrier in CORIM_CARRIERS:
+        if carrier.media_type == media_type:
+            return carrier
+    raise UnsupportedCorimMediaTypeError(f"unsupported CoRIM media type: {media_type}")
+
+
+__all__ = [
+    "CORIM_CARRIERS",
+    "CORIM_SIGNED_CARRIER",
+    "CORIM_UNSIGNED_CARRIER",
+    "CorimCarrier",
+    "select_carrier",
+]

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

@@ -0,0 +1,25 @@
+from dataclasses import dataclass
+
+
+@dataclass(frozen=True, slots=True)
+class CorimVersion:
+    identifier: str
+    status: str
+    published: str
+
+
+VERSION_HISTORY = (
+    CorimVersion("draft-ietf-rats-corim-10", "superseded-draft", "2024-07"),
+    CorimVersion("draft-ietf-rats-corim-11", "active-draft", "2025-03"),
+)
+CURRENT_VERSION = VERSION_HISTORY[-1]
+
+
+def select_version(identifier: str = CURRENT_VERSION.identifier) -> CorimVersion:
+    for version in VERSION_HISTORY:
+        if version.identifier == identifier:
+            return version
+    raise ValueError(f"unsupported CoRIM version: {identifier}")
+
+
+__all__ = ["CURRENT_VERSION", "VERSION_HISTORY", "CorimVersion", "select_version"]