mkp-contracts 0.2.0__tar.gz

mkp_contracts-0.2.0/.gitignore

@@ -0,0 +1,43 @@
+# Python
+__pycache__/
+*.py[cod]
+.venv/
+venv/
+*.egg-info/
+dist/
+build/
+.mypy_cache/
+.ruff_cache/
+.pytest_cache/
+.coverage
+htmlcov/
+
+# Node (web/)
+node_modules/
+.next/
+.turbo/
+
+# Local config and secrets — never tracked
+.env
+.env.*
+!.env.example
+deploy/.local/
+deploy/secrets/
+# Database dumps written by the pg-backup sidecar on the host
+deploy/backups/
+*.pem
+*.key
+!**/*.pub.key
+# age identities generated for laptop bring-up
+*.age
+
+# Runtime state
+.mklang-platform/
+*.db
+*.sqlite3
+run-artifacts/
+
+# Editors / OS
+.DS_Store
+.idea/
+.vscode/

mkp_contracts-0.2.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 Gianluca
+
+   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.

mkp_contracts-0.2.0/PKG-INFO

@@ -0,0 +1,9 @@
+Metadata-Version: 2.4
+Name: mkp-contracts
+Version: 0.2.0
+Summary: The cross-boundary contracts as code: canonical form, digests, schema validation
+License-Expression: Apache-2.0
+License-File: LICENSE
+Requires-Python: <3.14,>=3.11
+Requires-Dist: jsonschema>=4.21
+Requires-Dist: pyyaml>=6.0

mkp_contracts-0.2.0/README.md

@@ -0,0 +1,66 @@
+# mkp-contracts
+
+The contracts that cross component boundaries, as code. [`schema/`](../../schema/)
+holds them as data; this holds the rules a JSON Schema cannot express.
+
+A library: no CLI, no side effects, no I/O beyond reading a document it was handed.
+
+| Module         | What it owns                                                                            |
+| -------------- | --------------------------------------------------------------------------------------- |
+| `canonical.py` | The canonical form of a manifest, therefore its digest, therefore a bundle's identity   |
+| `schemas.py`   | Locating the schemas, deciding which contract a document is against, validating it      |
+| `errors.py`    | `Failure` and `Report` — reporting every rule a document breaks rather than the first   |
+| `roles.py`     | The four role **names**, which the API, `mkctl`, the console and the glossary all spell |
+
+## Why it is not inside the builder
+
+Because "what is this bundle" must have one answer, and neither side of the question
+owns it.
+
+`mkbundle` computes a digest when it builds. The control plane recomputes it when the
+bundle is registered, because a digest asserted by the caller and never checked makes
+every later reference — the environment pointer, the run's pinned revision, the audit
+trail — a claim rather than a fact. If those two computed it separately they would
+agree until they did not, and the day they stopped agreeing would be the day a bundle
+had two identities.
+
+Putting it in the builder and having the service import from it would work, and would
+say that the control plane is downstream of a CLI, which is not true. Both depend on
+this instead.
+
+## The one rule worth knowing
+
+Identity excludes `created`, `source`, and `signature`.
+
+`created` is a build timestamp: inside the digest, identical content would get two
+identities and promote-by-digest would be false. `source` is documented in
+`bundle.schema.json` as informational. A `signature` cannot be inside the bytes it
+signs. The signature covers exactly the canonical bytes the digest is taken over, so
+there is one canonical form and not two — which is why signing a bundle does not move
+its digest.
+
+## Development
+
+```
+uv sync
+uv run pytest -q
+uv run --with ruff ruff check .
+```
+
+## What is tested here, and what is not
+
+The split follows the same line as the package itself. `tools/mkbundle/tests` and
+`services/api/tests` test what each side _does_ with a digest — builds one, recomputes
+one on registration, checks a signature against one. What is tested here is what a
+digest **is**, because that is the thing neither of them owns and neither of them was
+asserting.
+
+The load-bearing one is `test_the_canonical_encoding_is_frozen`: a digest computed once,
+written down, and compared against — not recomputed by the test from the code under
+test. Four independent choices decide those bytes (sorted keys, no whitespace,
+`ensure_ascii=False`, and the exclusion set), each of them changeable by an edit that
+looks like tidying, and each of them changing **every digest at once**. The blast radius
+is not a wrong answer somewhere: every environment pointer and every run's pinned
+revision would name a bundle that no longer exists under that name. That is not a defect
+a downstream test can catch, because downstream everything still agrees — it agrees on
+the new answer.

mkp_contracts-0.2.0/pyproject.toml

@@ -0,0 +1,61 @@
+[project]
+name = "mkp-contracts"
+version = "0.2.0"
+description = "The cross-boundary contracts as code: canonical form, digests, schema validation"
+license = "Apache-2.0"
+license-files = ["LICENSE"]
+requires-python = ">=3.11,<3.14"
+dependencies = ["jsonschema>=4.21", "pyyaml>=6.0"]
+
+[dependency-groups]
+# `types-*` are development dependencies of *this* project rather than flags on the
+# check command: which stubs a package needs is a fact about what it imports.
+dev = ["pytest>=8.0", "types-PyYAML", "types-jsonschema"]
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build.targets.wheel]
+# `src/mkp_contracts/py.typed` ships with it (PEP 561). Without that marker a consumer's
+# type checker treats every symbol this package exports as `Any` — which is the opposite
+# of what a package named "contracts" is for, and is how `workloads/nate` was reading
+# `mkp_contracts.gates` until 2026-08-04.
+packages = ["src/mkp_contracts"]
+
+[tool.ruff]
+line-length = 100
+
+[tool.ruff.lint]
+select = ["E", "F", "I", "UP", "B", "SIM", "RUF", "S"]
+
+[tool.ruff.lint.per-file-ignores]
+# Project rule: no inline noqa — exemptions live here with the reason. signature.py
+# runs `minisign` with a fixed argv and no shell.
+"src/mkp_contracts/signature.py" = ["S603", "S607"]
+# `S` reads production code. In a test the same rules are noise with a cost: a test that
+# asserts is doing its job (S101), a fixture's fake credential is a literal on purpose
+# (S105-S107), and a query built to set up a fixture is not a query an attacker reaches
+# (S608). Ignored by path rather than by line, because there would be one line per test.
+"tests/**" = ["S101", "S105", "S106", "S107", "S608"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+
+[tool.mypy]
+# The same settings `mklang` checks with, so a contract crossing the two repositories is
+# read the same way on both sides. `warn_unused_ignores` earns its place immediately: it
+# is what would have caught the eight suppressions in `web/bff` that named a mypy error
+# code in a repository where mypy had never run.
+files = ["src"]
+python_version = "3.11"
+check_untyped_defs = true
+disallow_incomplete_defs = true
+strict_equality = true
+no_implicit_reexport = true
+warn_redundant_casts = true
+warn_unused_ignores = true
+
+[tool.pyright]
+typeCheckingMode = "basic"
+exclude = [".venv"]

mkp_contracts-0.2.0/src/mkp_contracts/__init__.py

@@ -0,0 +1,12 @@
+"""The contracts that cross component boundaries, as code.
+
+`schema/` holds them as data; this holds the rules a schema cannot express — what a
+bundle's canonical form is, therefore what its digest is, therefore what its identity
+is. Both the builder and the control plane depend on this rather than on each other,
+because "what is this bundle" must have one answer and neither of them owns it.
+
+A library, deliberately: no CLI, no side effects, no I/O beyond reading a document it
+was handed.
+"""
+
+__version__ = "0.1.0"

mkp_contracts-0.2.0/src/mkp_contracts/archive.py

@@ -0,0 +1,70 @@
+"""What is inside a bundle archive, and whether it is what it claims to be.
+
+Here for the same reason `canonical.py` is: **a bundle's identity is the digest of its
+manifest, not the hash of its archive**, so "does this archive belong under this
+digest?" is not a question either the builder or the control plane can answer alone
+without one of them defining the answer for the other.
+
+The distinction bites the first time someone stores an archive. Two builds of identical
+content produce byte-identical archives — that is what the `filename=""` in the gzip
+header exists for — but the archive is still not the identity: the manifest inside it
+is, and it is the manifest that `signature` covers and that `created` is excluded from.
+An implementation that filed archives under `sha256(bytes)` would be filing them under a
+name nothing else in the system uses.
+"""
+
+from __future__ import annotations
+
+import io
+import json
+import tarfile
+from typing import Any
+
+from .canonical import manifest_digest
+from .errors import ContractError
+
+MANIFEST_NAME = "manifest.json"
+
+# A bundle is workflows, machines and small assets. Refusing to expand beyond this is
+# what stops a crafted archive turning a read into a memory exhaustion — the check
+# happens before the tar is walked, on a number the header states rather than on what
+# it actually contains.
+MAX_ARCHIVE_BYTES = 64 * 1024 * 1024
+
+
+def manifest_of(archive: bytes) -> dict[str, Any]:
+    """The manifest at the root of an archive."""
+    if len(archive) > MAX_ARCHIVE_BYTES:
+        raise ContractError(f"archive is larger than {MAX_ARCHIVE_BYTES} bytes")
+    try:
+        with tarfile.open(fileobj=io.BytesIO(archive), mode="r:gz") as tar:
+            member = tar.extractfile(MANIFEST_NAME)
+            if member is None:
+                raise ContractError(f"no {MANIFEST_NAME} at the root of the archive")
+            return json.loads(member.read())
+    except tarfile.TarError as exc:
+        raise ContractError(f"not a readable bundle archive: {exc}") from exc
+    except ValueError as exc:
+        raise ContractError(f"{MANIFEST_NAME} is not JSON: {exc}") from exc
+
+
+def digest_of(archive: bytes) -> str:
+    """The bundle identity this archive carries.
+
+    Read off the manifest inside, never off the bytes: the archive is a container and
+    the manifest is the thing with a name.
+    """
+    return manifest_digest(manifest_of(archive))
+
+
+def belongs_under(archive: bytes, digest: str) -> bool:
+    return digest_of(archive) == digest
+
+
+__all__ = [
+    "MANIFEST_NAME",
+    "MAX_ARCHIVE_BYTES",
+    "belongs_under",
+    "digest_of",
+    "manifest_of",
+]

mkp_contracts-0.2.0/src/mkp_contracts/canonical.py

@@ -0,0 +1,42 @@
+"""Canonical form and digests.
+
+A bundle's identity is the digest of its content (ADR 0008), which only works if
+building the same content twice produces the same digest. Three manifest fields
+are therefore outside the canonical form:
+
+- `created` is a build timestamp; including it would give identical content two
+  identities and defeat the whole model — promote-by-digest, "nothing is rebuilt",
+  and "a superseded bundle is retained until no run references it" all rest on
+  content and identity being the same thing.
+- `source` is documented in `bundle.schema.json` as informational: "identity is
+  the content digest, not this".
+- `signature` cannot be inside the bytes it signs.
+
+The signature covers exactly these canonical bytes, so there is one canonical
+form and not two.
+"""
+
+from __future__ import annotations
+
+import hashlib
+import json
+from typing import Any
+
+EXCLUDED_FROM_IDENTITY = ("created", "source", "signature")
+
+
+def canonical_bytes(document: dict[str, Any]) -> bytes:
+    """The bytes a digest and a signature are both computed over."""
+    stripped = {k: v for k, v in document.items() if k not in EXCLUDED_FROM_IDENTITY}
+    return json.dumps(stripped, sort_keys=True, separators=(",", ":"), ensure_ascii=False).encode(
+        "utf-8"
+    )
+
+
+def manifest_digest(manifest: dict[str, Any]) -> str:
+    """The bundle's identity: sha256 over the canonical manifest, bare hex."""
+    return hashlib.sha256(canonical_bytes(manifest)).hexdigest()
+
+
+def file_digest(data: bytes) -> str:
+    return hashlib.sha256(data).hexdigest()

mkp_contracts-0.2.0/src/mkp_contracts/cli_versions.py

@@ -0,0 +1,34 @@
+"""The CLI versions the control plane serves (ADR 0014, `C33`).
+
+Here rather than in the api, because this package is where wire compatibility
+already lives: the PR that changes a canonical form is the PR that moves
+`CLI_MINIMUM`, reviewed as one change. `CLI_LATEST` moves in the commit that tags a
+CLI release — `release-cli.yml` fails when the tag disagrees, so the two cannot
+drift silently.
+"""
+
+from __future__ import annotations
+
+# The oldest mkctl the wire still serves. Raised deliberately, in the same PR as the
+# change that stops serving older ones — never as housekeeping.
+CLI_MINIMUM = "0.1.0"
+
+# What `mkctl upgrade` and the login advisory point at. 0.4.0 is the first version on
+# PyPI: before it, `mkbundle` and this package shipped as `0.1.0` in three different
+# GitHub releases, which is three builds behind one number — fine for assets fetched by
+# tag, wrong for an index where a version is permanent.
+CLI_LATEST = "0.4.0"
+
+
+def parse(version: str) -> tuple[int, ...] | None:
+    """`"0.2.0"` → `(0, 2, 0)`; anything else → None.
+
+    None means "do not gate": a User-Agent this module cannot read belongs to a
+    client this contract does not cover, and refusing what you cannot parse would
+    gate curl and every future tool along with it.
+    """
+    parts = version.strip().split(".")
+    try:
+        return tuple(int(part) for part in parts)
+    except ValueError:
+        return None

mkp_contracts-0.2.0/src/mkp_contracts/errors.py

@@ -0,0 +1,69 @@
+"""Failures, reported as data rather than raised one at a time.
+
+A build reports every rule a bundle breaks, not the first. Fixing one problem
+only to be told about the next is what makes a validator feel like an obstacle
+instead of a tool.
+"""
+
+from __future__ import annotations
+
+from dataclasses import dataclass, field
+
+
+@dataclass(frozen=True)
+class Failure:
+    """One broken rule, attributable to one place."""
+
+    rule: str
+    """Stable id, e.g. `machine-missing`. Cited in messages and in tests."""
+
+    message: str
+
+    path: str = ""
+    """Bundle-relative path of the document at fault, when there is one."""
+
+    location: str = ""
+    """Where inside the document, e.g. `steps[2].idempotency_key`."""
+
+    def __str__(self) -> str:
+        where = self.path or "<bundle>"
+        if self.location:
+            where = f"{where}:{self.location}"
+        return f"{where}: [{self.rule}] {self.message}"
+
+    def as_dict(self) -> dict[str, str]:
+        return {
+            "rule": self.rule,
+            "message": self.message,
+            "path": self.path,
+            "location": self.location,
+        }
+
+
+@dataclass
+class Report:
+    """The outcome of a validation or a build."""
+
+    failures: list[Failure] = field(default_factory=list)
+    skipped_rules: list[str] = field(default_factory=list)
+    """Rules that could not run. Never silent: a build says what it did not check."""
+
+    @property
+    def ok(self) -> bool:
+        return not self.failures
+
+    def fail(self, rule: str, message: str, path: str = "", location: str = "") -> None:
+        self.failures.append(Failure(rule, message, path, location))
+
+    def extend(self, other: Report) -> None:
+        self.failures.extend(other.failures)
+        self.skipped_rules.extend(other.skipped_rules)
+
+
+class ContractError(Exception):
+    """A document cannot be read or placed against a contract at all.
+
+    Distinct from a `Failure`: a failure is a rule a document breaks, reported
+    alongside every other one. This is the case where there is nothing to report
+    on — an unparseable file, a missing schema, a document of no known kind.
+    """