pbom 0.1.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.
- pbom-0.1.0/LICENSE +201 -0
- pbom-0.1.0/PKG-INFO +139 -0
- pbom-0.1.0/README.md +113 -0
- pbom-0.1.0/pyproject.toml +48 -0
- pbom-0.1.0/setup.cfg +4 -0
- pbom-0.1.0/src/pbom/__init__.py +30 -0
- pbom-0.1.0/src/pbom/canonical.py +157 -0
- pbom-0.1.0/src/pbom/chain.py +188 -0
- pbom-0.1.0/src/pbom/cli.py +245 -0
- pbom-0.1.0/src/pbom/commitment.py +80 -0
- pbom-0.1.0/src/pbom/emitter.py +574 -0
- pbom-0.1.0/src/pbom/exceptions.py +69 -0
- pbom-0.1.0/src/pbom/hashing.py +34 -0
- pbom-0.1.0/src/pbom/schema.py +467 -0
- pbom-0.1.0/src/pbom/skill/SKILL.md +162 -0
- pbom-0.1.0/src/pbom/validator.py +194 -0
- pbom-0.1.0/src/pbom.egg-info/PKG-INFO +139 -0
- pbom-0.1.0/src/pbom.egg-info/SOURCES.txt +29 -0
- pbom-0.1.0/src/pbom.egg-info/dependency_links.txt +1 -0
- pbom-0.1.0/src/pbom.egg-info/entry_points.txt +2 -0
- pbom-0.1.0/src/pbom.egg-info/requires.txt +7 -0
- pbom-0.1.0/src/pbom.egg-info/top_level.txt +1 -0
- pbom-0.1.0/tests/test_canonical.py +146 -0
- pbom-0.1.0/tests/test_chain.py +282 -0
- pbom-0.1.0/tests/test_cli.py +239 -0
- pbom-0.1.0/tests/test_commitment.py +123 -0
- pbom-0.1.0/tests/test_emitter.py +391 -0
- pbom-0.1.0/tests/test_hashing.py +37 -0
- pbom-0.1.0/tests/test_integration.py +93 -0
- pbom-0.1.0/tests/test_schema.py +230 -0
- pbom-0.1.0/tests/test_validator.py +345 -0
pbom-0.1.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
|
|
95
|
+
Derivative 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 [yyyy] [name of copyright owner]
|
|
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.
|
pbom-0.1.0/PKG-INFO
ADDED
|
@@ -0,0 +1,139 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: pbom
|
|
3
|
+
Version: 0.1.0
|
|
4
|
+
Summary: Open-source reference implementation of the PBOM format.
|
|
5
|
+
Author: Eqo
|
|
6
|
+
License: Apache-2.0
|
|
7
|
+
Classifier: Development Status :: 3 - Alpha
|
|
8
|
+
Classifier: Intended Audience :: Developers
|
|
9
|
+
Classifier: License :: OSI Approved :: Apache Software License
|
|
10
|
+
Classifier: Programming Language :: Python :: 3
|
|
11
|
+
Classifier: Programming Language :: Python :: 3.10
|
|
12
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
13
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
14
|
+
Classifier: Topic :: Software Development :: Libraries
|
|
15
|
+
Classifier: Typing :: Typed
|
|
16
|
+
Requires-Python: >=3.10
|
|
17
|
+
Description-Content-Type: text/markdown
|
|
18
|
+
License-File: LICENSE
|
|
19
|
+
Requires-Dist: pydantic>=2.0
|
|
20
|
+
Requires-Dist: click
|
|
21
|
+
Provides-Extra: dev
|
|
22
|
+
Requires-Dist: pytest; extra == "dev"
|
|
23
|
+
Requires-Dist: pytest-cov; extra == "dev"
|
|
24
|
+
Requires-Dist: ruff; extra == "dev"
|
|
25
|
+
Dynamic: license-file
|
|
26
|
+
|
|
27
|
+
# PBOM
|
|
28
|
+
|
|
29
|
+
PBOM is the open standard for tamper-evident LLM audit trails. This package is the reference implementation.
|
|
30
|
+
|
|
31
|
+
[](LICENSE)
|
|
32
|
+

|
|
33
|
+
[](https://github.com/eqo/pbom-spec/actions/workflows/ci.yml)
|
|
34
|
+
|
|
35
|
+
## What is PBOM?
|
|
36
|
+
|
|
37
|
+
PBOM (Prompt Bill of Materials) is an open JSON-LD format for recording LLM interactions as tamper-evident records. Each record captures identity, prompt fingerprints, model metadata, response fingerprints, telemetry, and hash links to prior records.
|
|
38
|
+
|
|
39
|
+
**Security model.** PBOM provides tamper-evidence *relative to an external anchor*. Chain linking makes in-place modification and mid-chain deletion detectable on their own; detecting deliberate rewriting or truncation of the chain requires holding one record hash outside the `.pbom/` directory. Records are unsigned in v1.0.0 — the chain proves linkage, not authorship. See [Security model](docs/spec.md#12-security-model) in the specification for the full treatment.
|
|
40
|
+
|
|
41
|
+
The goal is: make LLM interactions auditable without locking teams into one provider or one runtime. PBOM gives you verifiable evidence about what was sent and what came back, while keeping storage mode flexible (`fingerprint` vs `forensic`) and extension-friendly.
|
|
42
|
+
|
|
43
|
+
## Why PBOM?
|
|
44
|
+
|
|
45
|
+
Software supply chains have the SBOM. Machine-learning systems have the ML-BOM. Both inventory *static* artifacts — code dependencies, model weights, datasets — and neither captures the thing that actually shaped a given LLM output: the prompt, the model version, and the parameters at inference time.
|
|
46
|
+
|
|
47
|
+
That layer usually lives only in application logs, if it's recorded at all — raw text, often PII-heavy, with no integrity guarantee and no link from one call to the next. When you later need to answer "what exactly did we send, which model answered, and has this record been altered since," logs can't prove it.
|
|
48
|
+
|
|
49
|
+
PBOM fills that gap at the inference boundary: a per-call record that fingerprints the prompt and response, pins the model, and hash-links to the record before it — so the audit trail is verifiable, not just present.
|
|
50
|
+
|
|
51
|
+
## Quick Start
|
|
52
|
+
|
|
53
|
+
```bash
|
|
54
|
+
pip install pbom
|
|
55
|
+
pbom init
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
```python
|
|
59
|
+
from pbom import PBOMEmitter
|
|
60
|
+
emitter = PBOMEmitter(application_id="demo-app", storage_mode="fingerprint")
|
|
61
|
+
with emitter.commit(system_prompt="You are concise.", user_prompt="Summarize PBOM.") as commit:
|
|
62
|
+
response_text = call_your_llm() # your LLM client call
|
|
63
|
+
record = commit.complete(response_text=response_text, model_id="gpt-4.1")
|
|
64
|
+
print(record.identity.entry_id)
|
|
65
|
+
print(record.commitment.commitment_verified)
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
```bash
|
|
69
|
+
pbom validate .pbom/
|
|
70
|
+
```
|
|
71
|
+
|
|
72
|
+
## The Two APIs
|
|
73
|
+
|
|
74
|
+
- **API 1: `PBOMEmitter.commit(...)` (context manager)**
|
|
75
|
+
Pre-inference commitment flow. You commit prompt material before model execution, then complete the record after receiving the response.
|
|
76
|
+
- **API 2: `PBOMEmitter.record(...)` (single call)**
|
|
77
|
+
Post-hoc record creation. Useful for existing pipelines, but it does **not** provide pre-inference guarantees.
|
|
78
|
+
|
|
79
|
+
See the specification and examples for full semantics and edge cases.
|
|
80
|
+
|
|
81
|
+
## CLI Commands
|
|
82
|
+
|
|
83
|
+
| Command | Purpose |
|
|
84
|
+
| --- | --- |
|
|
85
|
+
| `pbom init` | Create and initialize a local PBOM chain directory. |
|
|
86
|
+
| `pbom validate <dir>` | Validate chain integrity and commitment status for a PBOM directory. |
|
|
87
|
+
| `pbom status <dir>` | Show chain status summary (record count, head info). |
|
|
88
|
+
| `pbom export-schema <path>` | Export the PBOM JSON Schema to a file. |
|
|
89
|
+
| `pbom install-skill [--force]` | Install the pbom skill file into `.claude/skills/pbom/` and add a pbom grounding note to `CLAUDE.md`. |
|
|
90
|
+
|
|
91
|
+
`pbom install-skill` is for teams using an agentic coding tool (like Claude Code) to instrument pbom. It writes two things into your project: the skill file at `.claude/skills/pbom/SKILL.md`, and a short grounding note appended to `CLAUDE.md` (created if absent). Both operations are safe to re-run: the skill file is not overwritten unless you pass `--force`, and the `CLAUDE.md` note is only added once.
|
|
92
|
+
|
|
93
|
+
## What's Captured
|
|
94
|
+
|
|
95
|
+
| Section | What it captures | Presence |
|
|
96
|
+
| --- | --- | --- |
|
|
97
|
+
| `identity` | Record ID, chain sequence, timestamps, previous hash pointer | Always present |
|
|
98
|
+
| `principal` | Emitting application and SDK identity/version | Always present |
|
|
99
|
+
| `commitment` | Commitment mode, nonce, commitment hash, verification timing | Always present |
|
|
100
|
+
| `prompt` | Prompt hashes, token counts, optional raw prompt text | Always present |
|
|
101
|
+
| `inference` | Model ID and optional runtime inference settings | Always present |
|
|
102
|
+
| `response` | Response hash, token counts, stop reason, optional raw text | Always present |
|
|
103
|
+
| `telemetry` | Optional end-to-end and inference latency measurements | Always present |
|
|
104
|
+
| `context_management` | Optional history/cache metadata | Optional (nullable) |
|
|
105
|
+
| `provider_metadata` | Optional provider request metadata | Optional (nullable) |
|
|
106
|
+
| `structural_analysis` | Optional machine-readable output analysis | Optional (nullable) |
|
|
107
|
+
| `action_primitives` | Canonical action detections with confidence/evidence | Optional (empty list default) |
|
|
108
|
+
| `extensions` | Implementation-specific metadata outside core PBOM fields | Always present |
|
|
109
|
+
| `storage_mode` | Whether raw content is omitted (`fingerprint`) or retained (`forensic`) | Always present |
|
|
110
|
+
|
|
111
|
+
## What This Package Is NOT
|
|
112
|
+
|
|
113
|
+
- **Not an LLM client wrapper**
|
|
114
|
+
You call your model/provider SDK directly, then call PBOM to commit/record results.
|
|
115
|
+
- **Not a policy engine**
|
|
116
|
+
No gating or risk-scoring decisions are performed here. If you want that layer, build it separately and store outputs in `extensions`.
|
|
117
|
+
- **Not a hosted service**
|
|
118
|
+
PBOM records are local JSON files. You own storage, transport, and retention.
|
|
119
|
+
|
|
120
|
+
If you want all-in-one model routing, enforcement, and hosted analytics today, this is not that.
|
|
121
|
+
|
|
122
|
+
## Documentation
|
|
123
|
+
|
|
124
|
+
- [PBOM specification (`docs/spec.md`)](docs/spec.md)
|
|
125
|
+
- [Field-by-field guide (`docs/fields.md`)](docs/fields.md)
|
|
126
|
+
- [Converting message lists (`docs/canonical.md`)](docs/canonical.md)
|
|
127
|
+
- [Examples (`examples/`)](examples/)
|
|
128
|
+
|
|
129
|
+
## Contributing
|
|
130
|
+
|
|
131
|
+
See [CONTRIBUTING.md](CONTRIBUTING.md).
|
|
132
|
+
|
|
133
|
+
## License
|
|
134
|
+
|
|
135
|
+
Apache 2.0. See [LICENSE](LICENSE).
|
|
136
|
+
|
|
137
|
+
---
|
|
138
|
+
|
|
139
|
+
Built and maintained by Eqo. PBOM is an open standard; anyone may implement it.
|
pbom-0.1.0/README.md
ADDED
|
@@ -0,0 +1,113 @@
|
|
|
1
|
+
# PBOM
|
|
2
|
+
|
|
3
|
+
PBOM is the open standard for tamper-evident LLM audit trails. This package is the reference implementation.
|
|
4
|
+
|
|
5
|
+
[](LICENSE)
|
|
6
|
+

|
|
7
|
+
[](https://github.com/eqo/pbom-spec/actions/workflows/ci.yml)
|
|
8
|
+
|
|
9
|
+
## What is PBOM?
|
|
10
|
+
|
|
11
|
+
PBOM (Prompt Bill of Materials) is an open JSON-LD format for recording LLM interactions as tamper-evident records. Each record captures identity, prompt fingerprints, model metadata, response fingerprints, telemetry, and hash links to prior records.
|
|
12
|
+
|
|
13
|
+
**Security model.** PBOM provides tamper-evidence *relative to an external anchor*. Chain linking makes in-place modification and mid-chain deletion detectable on their own; detecting deliberate rewriting or truncation of the chain requires holding one record hash outside the `.pbom/` directory. Records are unsigned in v1.0.0 — the chain proves linkage, not authorship. See [Security model](docs/spec.md#12-security-model) in the specification for the full treatment.
|
|
14
|
+
|
|
15
|
+
The goal is: make LLM interactions auditable without locking teams into one provider or one runtime. PBOM gives you verifiable evidence about what was sent and what came back, while keeping storage mode flexible (`fingerprint` vs `forensic`) and extension-friendly.
|
|
16
|
+
|
|
17
|
+
## Why PBOM?
|
|
18
|
+
|
|
19
|
+
Software supply chains have the SBOM. Machine-learning systems have the ML-BOM. Both inventory *static* artifacts — code dependencies, model weights, datasets — and neither captures the thing that actually shaped a given LLM output: the prompt, the model version, and the parameters at inference time.
|
|
20
|
+
|
|
21
|
+
That layer usually lives only in application logs, if it's recorded at all — raw text, often PII-heavy, with no integrity guarantee and no link from one call to the next. When you later need to answer "what exactly did we send, which model answered, and has this record been altered since," logs can't prove it.
|
|
22
|
+
|
|
23
|
+
PBOM fills that gap at the inference boundary: a per-call record that fingerprints the prompt and response, pins the model, and hash-links to the record before it — so the audit trail is verifiable, not just present.
|
|
24
|
+
|
|
25
|
+
## Quick Start
|
|
26
|
+
|
|
27
|
+
```bash
|
|
28
|
+
pip install pbom
|
|
29
|
+
pbom init
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
```python
|
|
33
|
+
from pbom import PBOMEmitter
|
|
34
|
+
emitter = PBOMEmitter(application_id="demo-app", storage_mode="fingerprint")
|
|
35
|
+
with emitter.commit(system_prompt="You are concise.", user_prompt="Summarize PBOM.") as commit:
|
|
36
|
+
response_text = call_your_llm() # your LLM client call
|
|
37
|
+
record = commit.complete(response_text=response_text, model_id="gpt-4.1")
|
|
38
|
+
print(record.identity.entry_id)
|
|
39
|
+
print(record.commitment.commitment_verified)
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
```bash
|
|
43
|
+
pbom validate .pbom/
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
## The Two APIs
|
|
47
|
+
|
|
48
|
+
- **API 1: `PBOMEmitter.commit(...)` (context manager)**
|
|
49
|
+
Pre-inference commitment flow. You commit prompt material before model execution, then complete the record after receiving the response.
|
|
50
|
+
- **API 2: `PBOMEmitter.record(...)` (single call)**
|
|
51
|
+
Post-hoc record creation. Useful for existing pipelines, but it does **not** provide pre-inference guarantees.
|
|
52
|
+
|
|
53
|
+
See the specification and examples for full semantics and edge cases.
|
|
54
|
+
|
|
55
|
+
## CLI Commands
|
|
56
|
+
|
|
57
|
+
| Command | Purpose |
|
|
58
|
+
| --- | --- |
|
|
59
|
+
| `pbom init` | Create and initialize a local PBOM chain directory. |
|
|
60
|
+
| `pbom validate <dir>` | Validate chain integrity and commitment status for a PBOM directory. |
|
|
61
|
+
| `pbom status <dir>` | Show chain status summary (record count, head info). |
|
|
62
|
+
| `pbom export-schema <path>` | Export the PBOM JSON Schema to a file. |
|
|
63
|
+
| `pbom install-skill [--force]` | Install the pbom skill file into `.claude/skills/pbom/` and add a pbom grounding note to `CLAUDE.md`. |
|
|
64
|
+
|
|
65
|
+
`pbom install-skill` is for teams using an agentic coding tool (like Claude Code) to instrument pbom. It writes two things into your project: the skill file at `.claude/skills/pbom/SKILL.md`, and a short grounding note appended to `CLAUDE.md` (created if absent). Both operations are safe to re-run: the skill file is not overwritten unless you pass `--force`, and the `CLAUDE.md` note is only added once.
|
|
66
|
+
|
|
67
|
+
## What's Captured
|
|
68
|
+
|
|
69
|
+
| Section | What it captures | Presence |
|
|
70
|
+
| --- | --- | --- |
|
|
71
|
+
| `identity` | Record ID, chain sequence, timestamps, previous hash pointer | Always present |
|
|
72
|
+
| `principal` | Emitting application and SDK identity/version | Always present |
|
|
73
|
+
| `commitment` | Commitment mode, nonce, commitment hash, verification timing | Always present |
|
|
74
|
+
| `prompt` | Prompt hashes, token counts, optional raw prompt text | Always present |
|
|
75
|
+
| `inference` | Model ID and optional runtime inference settings | Always present |
|
|
76
|
+
| `response` | Response hash, token counts, stop reason, optional raw text | Always present |
|
|
77
|
+
| `telemetry` | Optional end-to-end and inference latency measurements | Always present |
|
|
78
|
+
| `context_management` | Optional history/cache metadata | Optional (nullable) |
|
|
79
|
+
| `provider_metadata` | Optional provider request metadata | Optional (nullable) |
|
|
80
|
+
| `structural_analysis` | Optional machine-readable output analysis | Optional (nullable) |
|
|
81
|
+
| `action_primitives` | Canonical action detections with confidence/evidence | Optional (empty list default) |
|
|
82
|
+
| `extensions` | Implementation-specific metadata outside core PBOM fields | Always present |
|
|
83
|
+
| `storage_mode` | Whether raw content is omitted (`fingerprint`) or retained (`forensic`) | Always present |
|
|
84
|
+
|
|
85
|
+
## What This Package Is NOT
|
|
86
|
+
|
|
87
|
+
- **Not an LLM client wrapper**
|
|
88
|
+
You call your model/provider SDK directly, then call PBOM to commit/record results.
|
|
89
|
+
- **Not a policy engine**
|
|
90
|
+
No gating or risk-scoring decisions are performed here. If you want that layer, build it separately and store outputs in `extensions`.
|
|
91
|
+
- **Not a hosted service**
|
|
92
|
+
PBOM records are local JSON files. You own storage, transport, and retention.
|
|
93
|
+
|
|
94
|
+
If you want all-in-one model routing, enforcement, and hosted analytics today, this is not that.
|
|
95
|
+
|
|
96
|
+
## Documentation
|
|
97
|
+
|
|
98
|
+
- [PBOM specification (`docs/spec.md`)](docs/spec.md)
|
|
99
|
+
- [Field-by-field guide (`docs/fields.md`)](docs/fields.md)
|
|
100
|
+
- [Converting message lists (`docs/canonical.md`)](docs/canonical.md)
|
|
101
|
+
- [Examples (`examples/`)](examples/)
|
|
102
|
+
|
|
103
|
+
## Contributing
|
|
104
|
+
|
|
105
|
+
See [CONTRIBUTING.md](CONTRIBUTING.md).
|
|
106
|
+
|
|
107
|
+
## License
|
|
108
|
+
|
|
109
|
+
Apache 2.0. See [LICENSE](LICENSE).
|
|
110
|
+
|
|
111
|
+
---
|
|
112
|
+
|
|
113
|
+
Built and maintained by Eqo. PBOM is an open standard; anyone may implement it.
|
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
[build-system]
|
|
2
|
+
requires = ["setuptools>=68", "wheel"]
|
|
3
|
+
build-backend = "setuptools.build_meta"
|
|
4
|
+
|
|
5
|
+
[project]
|
|
6
|
+
name = "pbom"
|
|
7
|
+
version = "0.1.0"
|
|
8
|
+
description = "Open-source reference implementation of the PBOM format."
|
|
9
|
+
readme = "README.md"
|
|
10
|
+
requires-python = ">=3.10"
|
|
11
|
+
license = { text = "Apache-2.0" }
|
|
12
|
+
authors = [
|
|
13
|
+
{ name = "Eqo" }
|
|
14
|
+
]
|
|
15
|
+
dependencies = [
|
|
16
|
+
"pydantic>=2.0",
|
|
17
|
+
"click"
|
|
18
|
+
]
|
|
19
|
+
classifiers = [
|
|
20
|
+
"Development Status :: 3 - Alpha",
|
|
21
|
+
"Intended Audience :: Developers",
|
|
22
|
+
"License :: OSI Approved :: Apache Software License",
|
|
23
|
+
"Programming Language :: Python :: 3",
|
|
24
|
+
"Programming Language :: Python :: 3.10",
|
|
25
|
+
"Programming Language :: Python :: 3.11",
|
|
26
|
+
"Programming Language :: Python :: 3.12",
|
|
27
|
+
"Topic :: Software Development :: Libraries",
|
|
28
|
+
"Typing :: Typed"
|
|
29
|
+
]
|
|
30
|
+
|
|
31
|
+
[project.optional-dependencies]
|
|
32
|
+
dev = [
|
|
33
|
+
"pytest",
|
|
34
|
+
"pytest-cov",
|
|
35
|
+
"ruff"
|
|
36
|
+
]
|
|
37
|
+
|
|
38
|
+
[project.scripts]
|
|
39
|
+
pbom = "pbom.cli:main"
|
|
40
|
+
|
|
41
|
+
[tool.setuptools]
|
|
42
|
+
package-dir = { "" = "src" }
|
|
43
|
+
|
|
44
|
+
[tool.setuptools.package-data]
|
|
45
|
+
pbom = ["skill/SKILL.md"]
|
|
46
|
+
|
|
47
|
+
[tool.setuptools.packages.find]
|
|
48
|
+
where = ["src"]
|
pbom-0.1.0/setup.cfg
ADDED
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
"""Public API surface for the PBOM package."""
|
|
2
|
+
|
|
3
|
+
from .canonical import canonicalize_messages
|
|
4
|
+
from .exceptions import UnsupportedMessageShapeError
|
|
5
|
+
from pbom.emitter import PBOMEmitter
|
|
6
|
+
from pbom.exceptions import (
|
|
7
|
+
ChainCorruptedError,
|
|
8
|
+
InvalidCommitmentError,
|
|
9
|
+
PBOMError,
|
|
10
|
+
SchemaValidationError,
|
|
11
|
+
)
|
|
12
|
+
from pbom.schema import PBOMRecord
|
|
13
|
+
from pbom.validator import ValidationResult, validate_chain, validate_commitment
|
|
14
|
+
|
|
15
|
+
__version__ = "0.1.0"
|
|
16
|
+
|
|
17
|
+
__all__ = [
|
|
18
|
+
"ChainCorruptedError",
|
|
19
|
+
"InvalidCommitmentError",
|
|
20
|
+
"PBOMEmitter",
|
|
21
|
+
"PBOMError",
|
|
22
|
+
"PBOMRecord",
|
|
23
|
+
"UnsupportedMessageShapeError",
|
|
24
|
+
"SchemaValidationError",
|
|
25
|
+
"ValidationResult",
|
|
26
|
+
"__version__",
|
|
27
|
+
"canonicalize_messages",
|
|
28
|
+
"validate_chain",
|
|
29
|
+
"validate_commitment",
|
|
30
|
+
]
|