mkbundle 0.2.0__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- mkbundle-0.2.0/.gitignore +43 -0
- mkbundle-0.2.0/LICENSE +201 -0
- mkbundle-0.2.0/PKG-INFO +9 -0
- mkbundle-0.2.0/README.md +157 -0
- mkbundle-0.2.0/pyproject.toml +68 -0
- mkbundle-0.2.0/src/mkbundle/__init__.py +12 -0
- mkbundle-0.2.0/src/mkbundle/build.py +286 -0
- mkbundle-0.2.0/src/mkbundle/catalog.py +48 -0
- mkbundle-0.2.0/src/mkbundle/cli.py +202 -0
- mkbundle-0.2.0/src/mkbundle/errors.py +17 -0
- mkbundle-0.2.0/src/mkbundle/py.typed +0 -0
- mkbundle-0.2.0/src/mkbundle/rules.py +417 -0
- mkbundle-0.2.0/src/mkbundle/signing.py +87 -0
- mkbundle-0.2.0/src/mkbundle/source.py +107 -0
- mkbundle-0.2.0/src/mkbundle/toolchain.py +86 -0
- mkbundle-0.2.0/tests/__init__.py +0 -0
- mkbundle-0.2.0/tests/conftest.py +48 -0
- mkbundle-0.2.0/tests/fixtures/connectors/microsoft-graph/connector.yaml +41 -0
- mkbundle-0.2.0/tests/fixtures/connectors/slack/connector.yaml +41 -0
- mkbundle-0.2.0/tests/fixtures/valid/bundle.yaml +17 -0
- mkbundle-0.2.0/tests/fixtures/valid/machines/triage.mkl +32 -0
- mkbundle-0.2.0/tests/fixtures/valid/workflows/triage.yaml +59 -0
- mkbundle-0.2.0/tests/test_build.py +95 -0
- mkbundle-0.2.0/tests/test_rules.py +371 -0
- mkbundle-0.2.0/tests/test_signing.py +157 -0
- mkbundle-0.2.0/tests/test_validate.py +56 -0
- mkbundle-0.2.0/tests/test_version.py +20 -0
- mkbundle-0.2.0/uv.lock +283 -0
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
# Python
|
|
2
|
+
__pycache__/
|
|
3
|
+
*.py[cod]
|
|
4
|
+
.venv/
|
|
5
|
+
venv/
|
|
6
|
+
*.egg-info/
|
|
7
|
+
dist/
|
|
8
|
+
build/
|
|
9
|
+
.mypy_cache/
|
|
10
|
+
.ruff_cache/
|
|
11
|
+
.pytest_cache/
|
|
12
|
+
.coverage
|
|
13
|
+
htmlcov/
|
|
14
|
+
|
|
15
|
+
# Node (web/)
|
|
16
|
+
node_modules/
|
|
17
|
+
.next/
|
|
18
|
+
.turbo/
|
|
19
|
+
|
|
20
|
+
# Local config and secrets — never tracked
|
|
21
|
+
.env
|
|
22
|
+
.env.*
|
|
23
|
+
!.env.example
|
|
24
|
+
deploy/.local/
|
|
25
|
+
deploy/secrets/
|
|
26
|
+
# Database dumps written by the pg-backup sidecar on the host
|
|
27
|
+
deploy/backups/
|
|
28
|
+
*.pem
|
|
29
|
+
*.key
|
|
30
|
+
!**/*.pub.key
|
|
31
|
+
# age identities generated for laptop bring-up
|
|
32
|
+
*.age
|
|
33
|
+
|
|
34
|
+
# Runtime state
|
|
35
|
+
.mklang-platform/
|
|
36
|
+
*.db
|
|
37
|
+
*.sqlite3
|
|
38
|
+
run-artifacts/
|
|
39
|
+
|
|
40
|
+
# Editors / OS
|
|
41
|
+
.DS_Store
|
|
42
|
+
.idea/
|
|
43
|
+
.vscode/
|
mkbundle-0.2.0/LICENSE
ADDED
|
@@ -0,0 +1,201 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or Derivative
|
|
95
|
+
Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
+
|
|
180
|
+
To apply the Apache License to your work, attach the following
|
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
182
|
+
replaced with your own identifying information. (Don't include
|
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
+
comment syntax for the file format. We also recommend that a
|
|
185
|
+
file or class name and description of purpose be included on the
|
|
186
|
+
same "printed page" as the copyright notice for easier
|
|
187
|
+
identification within third-party archives.
|
|
188
|
+
|
|
189
|
+
Copyright 2026 Gianluca
|
|
190
|
+
|
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
|
+
you may not use this file except in compliance with the License.
|
|
193
|
+
You may obtain a copy of the License at
|
|
194
|
+
|
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
196
|
+
|
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
200
|
+
See the License for the specific language governing permissions and
|
|
201
|
+
limitations under the License.
|
mkbundle-0.2.0/PKG-INFO
ADDED
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: mkbundle
|
|
3
|
+
Version: 0.2.0
|
|
4
|
+
Summary: Build, validate and sign bundles (ADR 0008)
|
|
5
|
+
License-Expression: Apache-2.0
|
|
6
|
+
License-File: LICENSE
|
|
7
|
+
Requires-Python: <3.14,>=3.11
|
|
8
|
+
Requires-Dist: mkp-contracts>=0.2.0
|
|
9
|
+
Requires-Dist: pyyaml>=6.0
|
mkbundle-0.2.0/README.md
ADDED
|
@@ -0,0 +1,157 @@
|
|
|
1
|
+
# mkbundle — bundle build and validation
|
|
2
|
+
|
|
3
|
+
The gate between authoring and everything downstream. A bundle that fails here never
|
|
4
|
+
becomes a deployment candidate ([ADR 0008](../../docs/adr/0008-bundles-and-pull-based-deployment.md)).
|
|
5
|
+
|
|
6
|
+
```
|
|
7
|
+
mkbundle validate <path>... a workflow, connector manifest, or bundle manifest
|
|
8
|
+
mkbundle build <src> -o <out> validate a source tree and archive it
|
|
9
|
+
mkbundle inspect <archive> the manifest and digest of a built bundle
|
|
10
|
+
mkbundle verify <archive> its signature, and its files against the manifest
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
`--format json` on any of them, for CI.
|
|
14
|
+
|
|
15
|
+
## A bundle source tree
|
|
16
|
+
|
|
17
|
+
```
|
|
18
|
+
src/
|
|
19
|
+
bundle.yaml project, pinned connector versions, requires
|
|
20
|
+
workflows/*.yaml one workflow definition each
|
|
21
|
+
machines/*.mkl the machines those workflows commission
|
|
22
|
+
assets/** templates, prompts, fixtures
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
`bundle.yaml` declares **intent**: project, `lock.connectors`, `requires`, and optional
|
|
26
|
+
`source` provenance. Everything the build **observes** — the file inventory, their
|
|
27
|
+
digests, the mklang and spec versions actually used, the build time — is an output, and
|
|
28
|
+
declaring one is an error rather than an override. A declared version can disagree with
|
|
29
|
+
what actually validated the bundle; an observed one cannot.
|
|
30
|
+
|
|
31
|
+
## Identity
|
|
32
|
+
|
|
33
|
+
A bundle's identity is the sha256 of its canonicalized manifest. Three fields are
|
|
34
|
+
outside that canonical form:
|
|
35
|
+
|
|
36
|
+
| Field | Why |
|
|
37
|
+
| ----------- | --------------------------------------------------------------------------------------- |
|
|
38
|
+
| `created` | A build timestamp. Inside the digest, identical content would get two identities |
|
|
39
|
+
| `source` | `bundle.schema.json` calls it informational: "identity is the content digest, not this" |
|
|
40
|
+
| `signature` | Cannot be inside the bytes it signs |
|
|
41
|
+
|
|
42
|
+
That is what makes promote-by-digest real: building the same tree twice gives the same
|
|
43
|
+
digest, so "nothing is rebuilt between dev and production" is checkable rather than
|
|
44
|
+
asserted. The signature (F4) covers exactly these canonical bytes, so there is one
|
|
45
|
+
canonical form and not two.
|
|
46
|
+
|
|
47
|
+
The archive is a deterministic `tar.gz` — sorted entries, zeroed mtimes and ownership,
|
|
48
|
+
no filename in the gzip header — so identical content also produces identical bytes.
|
|
49
|
+
|
|
50
|
+
## Rules
|
|
51
|
+
|
|
52
|
+
Schema validation is the shape. These are the rules, and they are build-time because
|
|
53
|
+
each is answerable from the bundle alone (`schema/README.md`):
|
|
54
|
+
|
|
55
|
+
| Rule | What it catches |
|
|
56
|
+
| ---------------------------- | -------------------------------------------------------- |
|
|
57
|
+
| `missing-idempotency-key` | An `effect: write` action with no key — see below |
|
|
58
|
+
| `machine-missing` | An mklang step pointing outside the bundle |
|
|
59
|
+
| `machine-check` | A machine `mklang check` rejects |
|
|
60
|
+
| `spec-mismatch` | Machines targeting different language spec versions |
|
|
61
|
+
| `undeclared-connection` | A connection used but not in `requires` |
|
|
62
|
+
| `undeclared-secret` | A secretRef used but not in `requires` |
|
|
63
|
+
| `unknown-connector` | A connector not pinned in `lock.connectors` |
|
|
64
|
+
| `connector-version-mismatch` | A pin that disagrees with the catalog |
|
|
65
|
+
| `unknown-action` | An action the connector manifest does not have |
|
|
66
|
+
| `duplicate-step-id` | Two steps sharing an id within a workflow |
|
|
67
|
+
| `wait-declares-both` | A `wait` with both `duration` and `until_event` |
|
|
68
|
+
| `wait-declares-nothing` | A `wait` with neither, so nothing says what it waits for |
|
|
69
|
+
| `machine-gate-unresolvable` | A machine gating on a hook the platform cannot answer |
|
|
70
|
+
| `duplicate-workflow-name` | Two workflows sharing a name within the bundle |
|
|
71
|
+
| `schema` | A document that does not match its contract |
|
|
72
|
+
|
|
73
|
+
`missing-idempotency-key` is the one that matters most. Durable execution is
|
|
74
|
+
at-least-once for external effects ([ADR 0009](../../docs/adr/0009-durable-execution-engine.md)
|
|
75
|
+
Amendment 1), so the idempotency key is the mechanism that makes an effect happen once.
|
|
76
|
+
A write step without one is not untidy — it is a duplicate email waiting for the first
|
|
77
|
+
crash, an ordinary retry, or a second runner.
|
|
78
|
+
|
|
79
|
+
`machine-gate-unresolvable` is the newest and the one that reaches furthest outside this
|
|
80
|
+
tool. A gate in a `.mkl` may carry `hook: <name>`, mklang resolves that name against a
|
|
81
|
+
registry the host supplies, and a name it cannot resolve **halts the run when the gate is
|
|
82
|
+
reached** — not at load, not at the first state, but when that gate is reached, which may be
|
|
83
|
+
one model call later and only for some inputs. What a gate may name is
|
|
84
|
+
[ADR 0011](../../docs/adr/0011-gates-are-data.md): a closed declarative vocabulary, defined in
|
|
85
|
+
`mkp_contracts.gates` so that this tool and the runner cannot disagree. A gate cannot name a
|
|
86
|
+
Python predicate, because ADR 0003 runs machines in the runner process _because_ "there is no
|
|
87
|
+
customer code in a `.mkl`, only data", and a bundle carrying code for its gates would take
|
|
88
|
+
that reason away.
|
|
89
|
+
|
|
90
|
+
The two `wait-*` rules are newer and exist for a narrower reason (`D1`). The schema declares
|
|
91
|
+
`duration`, `until_event` and `deadline` as three independent optional fields, so all four
|
|
92
|
+
combinations of the first two validate — including the two nothing can execute. One sleeps
|
|
93
|
+
for a fixed time and the other holds until something arrives; a step carrying both is a
|
|
94
|
+
document whose author meant one of them, and a builder that picked would be deciding what a
|
|
95
|
+
workflow does. The interpreter refuses the same two shapes, because a bundle built before
|
|
96
|
+
these rules existed is still loadable.
|
|
97
|
+
|
|
98
|
+
The rules needing **tenant** state are deploy-time and deliberately absent: budgets
|
|
99
|
+
against a tenant's constraints, connections against a target environment. A builder has
|
|
100
|
+
no tenant.
|
|
101
|
+
|
|
102
|
+
Three rules need a connector catalog (`--connectors`, defaulting to `connectors/` when
|
|
103
|
+
it holds manifests). Without one they cannot run, and the build says so on stderr rather
|
|
104
|
+
than reporting a clean pass over checks it never made.
|
|
105
|
+
|
|
106
|
+
## Signing
|
|
107
|
+
|
|
108
|
+
```
|
|
109
|
+
minisign -G -W -s build.key -p build.pub
|
|
110
|
+
mkbundle build src -o out/ --sign-key build.key --public-key build.pub
|
|
111
|
+
mkbundle verify out/acme-support-4529b6a34b4e.tar.gz --public-key build.pub
|
|
112
|
+
```
|
|
113
|
+
|
|
114
|
+
The signature covers exactly the canonical manifest bytes, and `signature` is outside
|
|
115
|
+
that form — so a bundle's digest is the same before and after it is signed. Signing
|
|
116
|
+
adds provenance to an identity; it does not create a new one.
|
|
117
|
+
|
|
118
|
+
`signature.value` holds the whole `.minisig` file, base64-encoded, so it round-trips to
|
|
119
|
+
bytes minisign verifies as-is. `signature.key_id` is minisign's key id, **not** the
|
|
120
|
+
public key: a verifier looks that id up in a trust store it already holds. Taking the
|
|
121
|
+
key from the artifact it authenticates would prove only that the artifact signed itself.
|
|
122
|
+
|
|
123
|
+
`mkbundle verify` also re-hashes every file against the digest the manifest records. A
|
|
124
|
+
signature over a manifest is worth exactly the file digests inside it.
|
|
125
|
+
|
|
126
|
+
Build keys must be unencrypted (`-W`) — minisign prompts on a terminal otherwise, which
|
|
127
|
+
a build does not have. Treat one as a credential: the whole point is that a runner can
|
|
128
|
+
tell our bundles from anyone else's. `verify-at-load` is the runner's job (C3); this
|
|
129
|
+
command exists so the tool can prove its own output rather than assert it.
|
|
130
|
+
|
|
131
|
+
## Install
|
|
132
|
+
|
|
133
|
+
Python 3.11 to 3.13. `mklang` and `minisign` are not Python dependencies — they must be
|
|
134
|
+
on PATH, and the tool says so when they are not.
|
|
135
|
+
|
|
136
|
+
```bash
|
|
137
|
+
pipx install mkbundle
|
|
138
|
+
mkbundle --version
|
|
139
|
+
```
|
|
140
|
+
|
|
141
|
+
Versions before `0.2.0` were never on an index: they are wheels on a `cli-v*` release of
|
|
142
|
+
a private repository, fetched with `gh release download --repo gianlucamazza/mklang-platform`.
|
|
143
|
+
|
|
144
|
+
## Development
|
|
145
|
+
|
|
146
|
+
```
|
|
147
|
+
uv sync
|
|
148
|
+
uv run pytest
|
|
149
|
+
uv run --with ruff ruff check .
|
|
150
|
+
```
|
|
151
|
+
|
|
152
|
+
`mklang` must be on PATH: the build shells out to `mklang check` rather than
|
|
153
|
+
reimplementing it, and reads `lock.mklang` off `mklang --version`.
|
|
154
|
+
|
|
155
|
+
Fixtures live in `tests/fixtures/`. The negative cases are the valid bundle with exactly
|
|
156
|
+
one thing changed, built in `conftest.py`, so each test shows its own delta instead of
|
|
157
|
+
hiding it in a near-duplicate directory.
|
|
@@ -0,0 +1,68 @@
|
|
|
1
|
+
[project]
|
|
2
|
+
name = "mkbundle"
|
|
3
|
+
version = "0.2.0"
|
|
4
|
+
description = "Build, validate and sign bundles (ADR 0008)"
|
|
5
|
+
license = "Apache-2.0"
|
|
6
|
+
license-files = ["LICENSE"]
|
|
7
|
+
requires-python = ">=3.11,<3.14"
|
|
8
|
+
# `pyyaml` comes with `mkp-contracts` and is declared anyway: `rules.py` imports it to read
|
|
9
|
+
# a machine's gates (`C21`), and a direct import that relies on somebody else's dependency
|
|
10
|
+
# is one that breaks when that somebody stops needing it.
|
|
11
|
+
dependencies = ["mkp-contracts>=0.2.0", "pyyaml>=6.0"]
|
|
12
|
+
|
|
13
|
+
[project.scripts]
|
|
14
|
+
mkbundle = "mkbundle.cli:main"
|
|
15
|
+
|
|
16
|
+
[dependency-groups]
|
|
17
|
+
dev = ["pytest>=8.0", "types-PyYAML"]
|
|
18
|
+
|
|
19
|
+
[tool.uv.sources]
|
|
20
|
+
mkp-contracts = { path = "../../packages/mkp-contracts", editable = true }
|
|
21
|
+
|
|
22
|
+
[build-system]
|
|
23
|
+
requires = ["hatchling"]
|
|
24
|
+
build-backend = "hatchling.build"
|
|
25
|
+
|
|
26
|
+
[tool.hatch.build.targets.wheel]
|
|
27
|
+
packages = ["src/mkbundle"]
|
|
28
|
+
|
|
29
|
+
[tool.ruff]
|
|
30
|
+
line-length = 100
|
|
31
|
+
|
|
32
|
+
[tool.ruff.lint]
|
|
33
|
+
select = ["E", "F", "I", "UP", "B", "SIM", "RUF", "S"]
|
|
34
|
+
|
|
35
|
+
[tool.ruff.lint.per-file-ignores]
|
|
36
|
+
# Production exemptions with their reason, declared once (project rule: no inline
|
|
37
|
+
# noqa). The toolchain and signing modules shell out to `mklang` and `minisign` by
|
|
38
|
+
# name from PATH with fixed argv and no shell — that the version reported is the one
|
|
39
|
+
# PATH serves is the point (S603, S607).
|
|
40
|
+
"src/mkbundle/toolchain.py" = ["S603", "S607"]
|
|
41
|
+
"src/mkbundle/signing.py" = ["S603", "S607"]
|
|
42
|
+
# `S` reads production code. In a test the same rules are noise with a cost: a test that
|
|
43
|
+
# asserts is doing its job (S101), a fixture's fake credential is a literal on purpose
|
|
44
|
+
# (S105-S107), and a query built to set up a fixture is not a query an attacker reaches
|
|
45
|
+
# (S608), and a suite that shells out to the real `minisign`, `age` or `mklang` rather
|
|
46
|
+
# than skipping is this repository's rule and not an oversight (S603, S607). Ignored by
|
|
47
|
+
# path rather than by line, because there would be one line per test.
|
|
48
|
+
"tests/**" = ["S101", "S105", "S106", "S107", "S603", "S607", "S608"]
|
|
49
|
+
|
|
50
|
+
[tool.pytest.ini_options]
|
|
51
|
+
testpaths = ["tests"]
|
|
52
|
+
|
|
53
|
+
[tool.mypy]
|
|
54
|
+
# Same settings as `mklang` and `packages/mkp-contracts` — see the note there on why
|
|
55
|
+
# `warn_unused_ignores` is the one that earns its place first. Scope matches mklang too:
|
|
56
|
+
# what ships. Extending it over the test suites is a separate, larger piece of work.
|
|
57
|
+
files = ["src"]
|
|
58
|
+
python_version = "3.11"
|
|
59
|
+
check_untyped_defs = true
|
|
60
|
+
disallow_incomplete_defs = true
|
|
61
|
+
strict_equality = true
|
|
62
|
+
no_implicit_reexport = true
|
|
63
|
+
warn_redundant_casts = true
|
|
64
|
+
warn_unused_ignores = true
|
|
65
|
+
|
|
66
|
+
[tool.pyright]
|
|
67
|
+
typeCheckingMode = "basic"
|
|
68
|
+
exclude = [".venv"]
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
"""mkbundle — build and validate the artifacts this platform deploys.
|
|
2
|
+
|
|
3
|
+
Bundles are immutable, content-addressed and signed (ADR 0008). A bundle that
|
|
4
|
+
fails validation never becomes a deployment candidate, so this tool is the gate
|
|
5
|
+
between authoring and everything downstream.
|
|
6
|
+
|
|
7
|
+
Named for what it makes rather than for the platform: `mkp` is the platform, and
|
|
8
|
+
that name belongs to its roles, its settings and its services rather than to one of
|
|
9
|
+
its tools.
|
|
10
|
+
"""
|
|
11
|
+
|
|
12
|
+
__version__ = "0.1.0"
|