voltry-evidence-schema 1.0.0__tar.gz

voltry_evidence_schema-1.0.0/.gitignore

@@ -0,0 +1,50 @@
+# --- OS / editor ---
+.DS_Store
+*.swp
+.idea/
+.vscode/
+
+# --- Python ---
+__pycache__/
+*.py[cod]
+*.egg-info/
+.eggs/
+.pytest_cache/
+.ruff_cache/
+.mypy_cache/
+.coverage
+.coverage.*
+coverage.xml
+htmlcov/
+.venv/
+venv/
+dist/
+build/
+
+# --- Node / TS ---
+node_modules/
+.next/
+.turbo/
+*.tsbuildinfo
+out/
+
+# --- Generated token outputs are committed? No — regenerated in CI ---
+packages/tokens/dist/
+apps/web/.next/
+
+# --- Local secrets (never committed; enforced by hooks) ---
+.env
+.env.*
+*.pem
+*.key
+
+# --- SBOM / scan artifacts (regenerated in CI) ---
+sbom*.json
+sbom*.xml
+trivy-results.*
+
+# Next.js generated
+next-env.d.ts
+
+# hypothesis example database
+.hypothesis/

voltry_evidence_schema-1.0.0/CHANGELOG.md

@@ -0,0 +1,19 @@
+# Changelog
+
+All notable changes to `voltry-evidence-schema` are documented here. The
+format follows Keep a Changelog; versioning is semantic, and the distribution
+version is the schema version.
+
+## [1.0.0] - 2026-07-02
+
+First public release.
+
+- Typed evidence bundle models (identity, measured, functional, raw reads,
+  environment, provenance, signature), captured wide.
+- RFC 8785 (JCS) canonical serialization as the single path to signable bytes.
+- ECDSA P-384 / SHA-384 sign and verify over canonical bytes.
+- Generated JSON Schema for cross-language consumers
+  (`evidence-schema-jsonschema`).
+- Python 3.10 through 3.13. Typed (`py.typed`).
+- Distribution renamed to `voltry-evidence-schema`; the import name remains
+  `evidence_schema`.

voltry_evidence_schema-1.0.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or Derivative
+          Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 Voltry
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

voltry_evidence_schema-1.0.0/PKG-INFO

@@ -0,0 +1,76 @@
+Metadata-Version: 2.4
+Name: voltry-evidence-schema
+Version: 1.0.0
+Summary: Voltry evidence bundle — THE contract. Typed models, RFC 8785 canonical serialization, ECDSA P-384 sign/verify, generated JSON Schema.
+License-Expression: Apache-2.0
+License-File: LICENSE
+Classifier: Operating System :: OS Independent
+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: Typing :: Typed
+Requires-Python: >=3.10
+Requires-Dist: cryptography<50,>=44
+Requires-Dist: pydantic<3,>=2.11
+Requires-Dist: rfc8785<0.2,>=0.1.4
+Description-Content-Type: text/markdown
+
+# voltry-evidence-schema
+
+The Voltry evidence bundle: the signed contract behind every Voltry Probe scan
+and certificate.
+
+Note the naming: the PyPI distribution is `voltry-evidence-schema`, the Python
+package you import is `evidence_schema`.
+
+```bash
+pip install voltry-evidence-schema
+```
+
+```python
+import evidence_schema
+```
+
+## What it provides
+
+- Typed pydantic v2 models (`EvidenceBundle` and its blocks). Measured facts
+  and modeled estimates are distinct types by construction; there is no single
+  score anywhere in the schema, and no price field exists.
+- One canonical serializer: RFC 8785 (JCS) over the bundle minus its
+  signature. This is the only path to signable bytes.
+- ECDSA P-384 (secp384r1) with SHA-384 sign and verify over those canonical
+  bytes.
+- A generated JSON Schema for cross-language consumers.
+
+## Quick start
+
+```python
+import json
+from evidence_schema import EvidenceBundle, verify_bundle
+
+bundle = EvidenceBundle.model_validate(json.load(open("bundle.json")))
+print(verify_bundle(bundle))  # True only if the signature covers these exact bytes
+```
+
+Command line:
+
+```bash
+# Round-trip demo: build, canonicalize, sign, verify, tamper, verify fails
+python -m evidence_schema.demo
+
+# Emit the JSON Schema for non-Python consumers
+evidence-schema-jsonschema -o evidence_bundle.schema.json
+```
+
+## Stability
+
+The schema is versioned semantically and the 1.x line is frozen wide: a bundle
+captured today remains valid and replayable indefinitely. Additive fields are
+minor versions; anything breaking is a major version with a migration path.
+Canonical bytes are covered by golden-vector tests on every supported Python
+version (3.10 through 3.13).
+
+## License
+
+Apache-2.0.

voltry_evidence_schema-1.0.0/README.md

@@ -0,0 +1,58 @@
+# voltry-evidence-schema
+
+The Voltry evidence bundle: the signed contract behind every Voltry Probe scan
+and certificate.
+
+Note the naming: the PyPI distribution is `voltry-evidence-schema`, the Python
+package you import is `evidence_schema`.
+
+```bash
+pip install voltry-evidence-schema
+```
+
+```python
+import evidence_schema
+```
+
+## What it provides
+
+- Typed pydantic v2 models (`EvidenceBundle` and its blocks). Measured facts
+  and modeled estimates are distinct types by construction; there is no single
+  score anywhere in the schema, and no price field exists.
+- One canonical serializer: RFC 8785 (JCS) over the bundle minus its
+  signature. This is the only path to signable bytes.
+- ECDSA P-384 (secp384r1) with SHA-384 sign and verify over those canonical
+  bytes.
+- A generated JSON Schema for cross-language consumers.
+
+## Quick start
+
+```python
+import json
+from evidence_schema import EvidenceBundle, verify_bundle
+
+bundle = EvidenceBundle.model_validate(json.load(open("bundle.json")))
+print(verify_bundle(bundle))  # True only if the signature covers these exact bytes
+```
+
+Command line:
+
+```bash
+# Round-trip demo: build, canonicalize, sign, verify, tamper, verify fails
+python -m evidence_schema.demo
+
+# Emit the JSON Schema for non-Python consumers
+evidence-schema-jsonschema -o evidence_bundle.schema.json
+```
+
+## Stability
+
+The schema is versioned semantically and the 1.x line is frozen wide: a bundle
+captured today remains valid and replayable indefinitely. Additive fields are
+minor versions; anything breaking is a major version with a migration path.
+Canonical bytes are covered by golden-vector tests on every supported Python
+version (3.10 through 3.13).
+
+## License
+
+Apache-2.0.

voltry_evidence_schema-1.0.0/evidence_schema/__init__.py

@@ -0,0 +1,107 @@
+"""Voltry evidence-schema — the signed evidence-bundle contract.
+
+Public API: the typed models, the single canonical serializer, and ECDSA P-384
+sign/verify. Everything that produces or consumes a bundle imports from here and never
+re-implements the contract.
+"""
+
+from __future__ import annotations
+
+from .canonicalize import CanonicalizationError, canonical_bytes, canonical_json, canonical_payload
+from .enums import (
+    AttestationVerdict,
+    GateResult,
+    History,
+    IdentityScheme,
+    RunMode,
+    Tier,
+)
+from .jsonschema import generate_json_schema, json_schema_str
+from .models import (
+    SPARE_ROW_CAP,
+    AgentInfo,
+    Attestation,
+    ClockPower,
+    DeterministicGates,
+    EccCounters,
+    EnvironmentBlock,
+    EvidenceBundle,
+    FunctionalBlock,
+    IdentityBlock,
+    MeasuredBlock,
+    NvLinkStatus,
+    PageRetirement,
+    PcieStatus,
+    ProvenanceBlock,
+    RawPayload,
+    RawReads,
+    Sanitization,
+    Signature,
+    SpareRows,
+    StabilitySignals,
+    Thermals,
+    XidEvent,
+)
+from .sign import (
+    generate_keypair,
+    load_public_key_spki_b64,
+    public_key_to_spki_b64,
+    sign_bundle,
+    verify_bundle,
+)
+from .version import CANONICALIZATION_SCHEME, SCHEMA_VERSION, SIGNATURE_ALGORITHM
+
+__version__ = SCHEMA_VERSION
+
+__all__ = [
+    # version
+    "SCHEMA_VERSION",
+    "CANONICALIZATION_SCHEME",
+    "SIGNATURE_ALGORITHM",
+    "__version__",
+    # enums
+    "Tier",
+    "History",
+    "IdentityScheme",
+    "RunMode",
+    "GateResult",
+    "AttestationVerdict",
+    # models
+    "SPARE_ROW_CAP",
+    "EvidenceBundle",
+    "AgentInfo",
+    "DeterministicGates",
+    "Attestation",
+    "IdentityBlock",
+    "EccCounters",
+    "XidEvent",
+    "PageRetirement",
+    "SpareRows",
+    "StabilitySignals",
+    "Thermals",
+    "ClockPower",
+    "NvLinkStatus",
+    "PcieStatus",
+    "MeasuredBlock",
+    "Sanitization",
+    "FunctionalBlock",
+    "RawPayload",
+    "RawReads",
+    "EnvironmentBlock",
+    "ProvenanceBlock",
+    "Signature",
+    # canonicalize
+    "canonical_bytes",
+    "canonical_json",
+    "canonical_payload",
+    "CanonicalizationError",
+    # sign
+    "generate_keypair",
+    "sign_bundle",
+    "verify_bundle",
+    "public_key_to_spki_b64",
+    "load_public_key_spki_b64",
+    # jsonschema
+    "generate_json_schema",
+    "json_schema_str",
+]

voltry_evidence_schema-1.0.0/evidence_schema/canonicalize.py

@@ -0,0 +1,60 @@
+"""The single canonical serializer — the **only** path to signable bytes.
+
+Canonicalization scheme: **RFC 8785 (JSON Canonicalization Scheme)** applied to the
+bundle's JSON projection with the ``signature`` field excluded. RFC 8785 fixes object
+key ordering (lexicographic on UTF-16 code units), number formatting (shortest
+round-trip ECMAScript form), string escaping, and whitespace — so the same logical
+bundle yields identical bytes across runs, processes, and languages.
+
+Frozen rules (recorded in ``docs/adr/0002-evidence-schema-freeze.md``):
+
+1. Serialize ``EvidenceBundle.model_dump(mode="json", exclude={"signature"})`` — i.e.
+   the full schema projection (defaults included, nulls included) minus the signature.
+2. Feed that to ``rfc8785.dumps`` to obtain the canonical bytes.
+3. Sign/verify operate on these bytes only. Bare ``json.dumps`` in the signing path is
+   forbidden (and blocked by a hook).
+
+The signature is excluded because a signature cannot cover itself; everything else in
+the bundle is covered, so tampering with any other field changes the canonical bytes
+and breaks verification.
+"""
+
+from __future__ import annotations
+
+import rfc8785
+
+from .models import EvidenceBundle
+
+
+class CanonicalizationError(ValueError):
+    """Raised when a bundle cannot be canonicalized (e.g. an out-of-domain number)."""
+
+
+def canonical_payload(bundle: EvidenceBundle) -> dict:
+    """The JSON projection that gets canonicalized: full schema minus the signature."""
+    return bundle.model_dump(mode="json", exclude={"signature"})
+
+
+def canonical_bytes(bundle: EvidenceBundle) -> bytes:
+    """Return the canonical (RFC 8785) bytes of ``bundle`` — the signable representation.
+
+    Raises :class:`CanonicalizationError` if the bundle contains a value outside the
+    RFC 8785 domain (notably an integer above 2**53 that slipped past the typed
+    bounds — such data must be captured verbatim in ``raw_reads`` instead).
+    """
+    payload = canonical_payload(bundle)
+    try:
+        return rfc8785.dumps(payload)
+    except Exception as exc:  # noqa: BLE001 — re-raised as a typed, explicit error.
+        raise CanonicalizationError(
+            f"bundle is not canonicalizable under RFC 8785: {exc}. "
+            "Large/opaque values must be captured verbatim in raw_reads, not as JSON numbers."
+        ) from exc
+
+
+def canonical_json(bundle: EvidenceBundle) -> str:
+    """The canonical bytes decoded as a UTF-8 string (for debugging/inspection only)."""
+    return canonical_bytes(bundle).decode("utf-8")
+
+
+__all__ = ["CanonicalizationError", "canonical_payload", "canonical_bytes", "canonical_json"]

voltry_evidence_schema-1.0.0/evidence_schema/demo.py

@@ -0,0 +1,76 @@
+"""``python -m evidence_schema.demo`` — round-trip the contract end to end.
+
+Builds a sample bundle, canonicalizes it, signs it (ephemeral key), verifies it,
+tampers a field, verifies that verification now fails, and prints the JSON Schema. This
+is the Stage 1 "Show" deliverable; it uses only simulated data and an ephemeral key.
+"""
+
+from __future__ import annotations
+
+import sys
+from typing import TextIO
+
+from .canonicalize import canonical_bytes
+from .jsonschema import json_schema_str
+from .samples import worked_example_a_bundle
+from .sign import generate_keypair, sign_bundle, verify_bundle
+
+
+def run(out: TextIO = sys.stdout) -> bool:
+    """Run the round-trip demo, writing a narrative to ``out``. Returns True on success."""
+
+    def line(msg: str = "") -> None:
+        out.write(msg + "\n")
+
+    bundle = worked_example_a_bundle()
+    sr = bundle.measured.spare_rows
+    exposure = "ASSESSED" if bundle.provenance.exposure_assessed else "NOT ASSESSED"
+    line("Voltry evidence-schema demo")
+    line("=" * 40)
+    line(f"schema_version : {bundle.schema_version}")
+    line(f"bundle_id      : {bundle.bundle_id}")
+    line(f"device         : {bundle.identity.device_part}  ({bundle.provenance.tier})")
+    line(f"spare rows     : {sr.remaining}/{sr.cap} remaining")
+    line(f"exposure       : {exposure}")
+
+    payload = canonical_bytes(bundle)
+    line(f"\ncanonical bytes: {len(payload)} bytes")
+    line(f"canonical head : {payload[:72].decode('utf-8')}...")
+
+    private_key = generate_keypair()
+    signed = sign_bundle(bundle, private_key, signer="operator")
+    sig = signed.signature
+    line(f"\nsigned         : algorithm={sig.algorithm} canon={sig.canonicalization}")
+
+    ok = verify_bundle(signed)
+    line(f"verify         : {'PASS' if ok else 'FAIL'}")
+    if not ok:  # pragma: no cover - defensive: only fires on a contract regression
+        line("UNEXPECTED: a freshly signed bundle failed to verify")
+        return False
+
+    # Tamper: change a measured fact without re-signing → canonical bytes change → verify fails.
+    tampered = signed.model_copy(deep=True)
+    tampered.measured.spare_rows.remaining = 1
+    tampered_ok = verify_bundle(tampered)
+    line("tamper         : set spare_rows.remaining 509 -> 1")
+    line(f"verify(tamper) : {'PASS (BUG!)' if tampered_ok else 'FAIL (correct — tamper detected)'}")
+    if tampered_ok:  # pragma: no cover - defensive: only fires on a contract regression
+        line("UNEXPECTED: tampered bundle still verified")
+        return False
+
+    line("\nJSON Schema")
+    line("-" * 40)
+    line(json_schema_str())
+    return True
+
+
+def main(argv: list[str] | None = None) -> int:
+    """Entry point. Returns 0 on a successful round-trip, 1 otherwise."""
+    return 0 if run() else 1
+
+
+if __name__ == "__main__":  # pragma: no cover - script entry; main() is tested directly
+    raise SystemExit(main())
+
+
+__all__ = ["run", "main"]