odm-cert-generator 0.1.0__tar.gz

odm_cert_generator-0.1.0/.gitignore

@@ -0,0 +1,18 @@
+__pycache__/
+*.py[cod]
+.pytest_cache/
+build/
+dist/
+*.egg-info/
+.venv/
+venv/
+
+# Rendered certificates. Every one carries a real unit's serial number, work
+# order and the name of whoever signed it -- this package exists to put them
+# there. A certificate committed by accident is a disclosure of exactly the data
+# the audit tool refuses to hold, published from the repository that holds it.
+# Nothing here is written by the suite; the tests render into a temporary
+# directory. Anything landing here was produced deliberately.
+certificates/
+*.certificate.json
+*.certificate.pdf

odm_cert_generator-0.1.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 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 [yyyy] [name of copyright owner]
+
+   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.

odm_cert_generator-0.1.0/NOTICE

@@ -0,0 +1,39 @@
+odm-cert-generator
+Copyright 2026 James Sheen
+
+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.
+
+DEPENDENCIES
+
+This project consumes two packages and is a part of neither:
+
+    bmc-sensor-audit  Apache-2.0  -- its shipped attestation validator is the
+                                     only surface of it this package touches
+    fpdf2             LGPL-3.0-only -- read from the installed distribution's
+                                     own License-Expression, not assumed. Used
+                                     as an unmodified library through its public
+                                     API, imported at render time and neither
+                                     vendored nor altered.
+
+REDISTRIBUTED THIRD-PARTY CONTENT
+
+None. `examples/attestation.json` and `examples/coverage.json` were produced by
+running bmc-sensor-audit 0.1.0 against its own mock BMC in this repository; they
+are outputs of a dependency, not copies of anyone's source. `examples/README.md`
+records exactly how, and which two volatile fields were replaced.
+
+NOT AFFILIATED
+
+This project renders documents describing hardware audited against OpenBMC
+`entity-manager` declarations and the DMTF Redfish API. It is not affiliated
+with, endorsed by, or part of the OpenBMC project or DMTF. A certificate it
+produces is a record of what one tool checked; it is not a certification issued
+by any standards body.

odm_cert_generator-0.1.0/PKG-INFO

@@ -0,0 +1,216 @@
+Metadata-Version: 2.5
+Name: odm-cert-generator
+Version: 0.1.0
+Summary: Render a QC certificate from a bmc-sensor-audit attestation.
+Project-URL: Homepage, https://github.com/james-sheen/cert-generator
+Project-URL: Source, https://github.com/james-sheen/cert-generator
+Project-URL: Issues, https://github.com/james-sheen/cert-generator/issues
+Author: James Sheen
+License-Expression: Apache-2.0
+License-File: LICENSE
+License-File: NOTICE
+Keywords: attestation,bmc,certificate,manufacturing,odm,openbmc,qa,quality-control
+Requires-Python: >=3.10
+Requires-Dist: bmc-sensor-audit<0.2,>=0.1.0
+Requires-Dist: fpdf2<3,>=2.7
+Provides-Extra: dev
+Requires-Dist: pytest>=7; extra == 'dev'
+Provides-Extra: verify
+Requires-Dist: pypdf>=4; extra == 'verify'
+Description-Content-Type: text/markdown
+
+# cert-generator
+
+Render a QC certificate from a [`bmc-sensor-audit`](https://github.com/james-sheen/bmc-sensor-audit)
+attestation.
+
+**Released — 0.1.0**, tagged `v0.1.0`, Apache-2.0, on PyPI as
+`odm-cert-generator`.
+
+**The distribution and the command differ, and the reason is worth one line.**
+PyPI ultranormalises a name by stripping its separators, so `cert-generator`
+becomes `certgenerator` — which an unrelated project holds — and the upload is
+refused as *too similar to an existing project*. So this publishes as
+`odm-cert-generator` and installs a command still called `cert-generator`. A
+certificate records the **distribution** name, because that is the one that
+resolves on an index.
+
+```
+pip install odm-cert-generator
+
+cert-generator render \
+    --attestation attestation.json \
+    --identity identity.json \
+    --coverage coverage.json \
+    --out-json certificate.json \
+    --out-pdf certificate.pdf
+```
+
+## What it is for
+
+The audit tool judges a machine and deliberately keeps the machine's identity out
+of everything it writes. A certificate has the opposite job: it has to name the
+unit. This renders one from the other, and holds the serial number on its own side
+of the line.
+
+Two trust domains, split on purpose. The referee cannot leak what it never sees.
+The certificate can say what a certificate must.
+
+## The certificate never claims a flat pass
+
+It will not print "100 % match". It prints the denominator:
+
+```
+6 invariant(s) checked over 3 entit(ies); 1 finding(s) recorded;
+3 check(s) declined and therefore not judged
+```
+
+...and then a section headed **Not part of this judgment**, which is emitted even
+when every list in it is empty — because an absent section reads as *nothing was
+left out*, and that is a claim.
+
+That section carries:
+
+| | |
+|---|---|
+| the declines | each with the engine's machine-readable reason |
+| `unattested` | problem types the engine would not attest |
+| `unread_feeds` | data that was read and not used |
+| the declaration diff | declared vs. present, when supplied — see below |
+| the engine's boundary | quoted verbatim, not paraphrased |
+
+A certificate showing what was *not* checked is one an incoming-inspection team
+can act on. The denominator is the point, not a concession.
+
+## The declaration diff is a second, optional input
+
+`attestation/1` records what the engine judged. It does not record what was
+*declared and never showed up*. Run the audit tool against a board declaring four
+sensors where one is absent and the artifact reads `checked: {entities: 3}` — three,
+with nothing on it saying three of four.
+
+So `--coverage` takes the JSON from `bmc-sensor-audit coverage --json`, which does
+carry the diff. Supply it and the certificate states declared-vs-present and names
+the absent sensor. Leave it out and the certificate says, on the page:
+
+> no declaration diff was supplied, so this certificate cannot state how many
+> declared sensors were present; the attestation counts only entities that reached
+> the engine
+
+It is optional because requiring it would make a certificate impossible for anyone
+holding only an attestation. It is *stated* because the smaller denominator must
+not pass for the whole picture.
+
+**That coverage artifact is written for a CI log, not a customer.** It names the
+BMC by URL and the configuration by filesystem path. Both are dropped here before
+anything is rendered; see `tests/test_privacy.py`.
+
+## The PDF is a projection of the JSON
+
+No number appears in the PDF that is absent from the certificate JSON. The JSON is
+the record; the PDF is how it looks. Anyone holding both can check one against the
+other without trusting this code:
+
+```
+cert-generator verify --certificate certificate.json --pdf certificate.pdf
+```
+
+Shipped rather than kept in a CI script, for the same reason the audit tool ships
+its attestation validator: the person who *receives* the document is the one who
+needs to check it.
+
+The suite checks the same property with poppler's `pdftotext` — a reader nobody
+here wrote.
+
+## Identity goes one way
+
+Identity flows *into* the certificate and never back toward the audit inputs. This
+package does not construct walks, configurations or supplemental declarations, and
+has no HTTP client. `tests/test_boundary.py` enforces it by parsing this package's
+own imports, because a rule kept by review lasts exactly as long as the reviewer's
+attention.
+
+The only thing it may reach for in the audit tool is `validate_attestation` — the
+tool's *shipped* validator, not a second copy of its rules. A shapeless artifact is
+refused, not decorated.
+
+## Exit codes
+
+The family's contract, not this tool's invention:
+
+| | |
+|---|---|
+| `0` | certificate written; nothing recorded against the unit |
+| `1` | certificate written; findings, or a declared sensor absent |
+| `2` | could not complete — nothing was judged |
+
+Precedence is `max`, copied from the audit tool. A run that both found something
+and failed to finish reports `2`, because `2` is the statement about the
+denominator and `1` would let a reader conclude the rest was checked.
+
+A certificate is still written when the verdict is `1`. A QC record for a unit that
+failed is a valid document.
+
+## A certificate is not the pipeline's verdict
+
+Two records run in parallel and neither contains the other. This one certifies what
+the referee established about a unit: the attestation, the identity, and the
+declaration diff when one is supplied. Conformance and fault injection are not in
+it. Those meet in `odm-qa-pipeline aggregate`, which answers a different question —
+did all four gates run, and what is the worst thing any of them found.
+
+Worth stating because reading either as the other goes wrong in both directions: a
+clean certificate says nothing about whether the injection gate ran, and a clean
+pipeline verdict is not a document anyone can hand to a customer.
+
+## The identity block
+
+```json
+{
+  "serial": "SN-A17-000482",
+  "work_order": "WO-2026-08-1174",
+  "station": "FCT-3",
+  "signer": "L. Okonkwo",
+  "part_number": "PN-88213-B",
+  "customer": "Example Hyperscale Inc.",
+  "line": "Kaohsiung 2"
+}
+```
+
+The first four are required. The rest are optional and rendered when present.
+Nothing is inferred, and an unrecognised key is **refused** rather than dropped —
+a typo would otherwise vanish silently, and nobody reads a certificate looking for
+the field that is not on it.
+
+## Known limits, written down rather than implied
+
+- **Latin-1 only.** The built-in PDF fonts cannot draw characters outside it. An
+  identity field containing them is refused, not transliterated: a serial number
+  silently rewritten is worse than a failed render. Shipping a Unicode font would
+  lift this; it has not been done.
+- **`verify` needs a PDF reader.** poppler's `pdftotext` if it is on `PATH`,
+  otherwise `pip install 'odm-cert-generator[verify]'` for pypdf. If neither is
+  present the command exits `2` — not finding a reader is not a pass.
+- **Nothing here re-audits the machine.** `verify` proves the page matches the
+  record. The record's authority comes from the attestation, and the
+  attestation's from the engine.
+- **One page.** Automatic page breaks are off on purpose, so a certificate that
+  overflows is visible as overflow rather than quietly paginated. A unit with very
+  many findings will need the JSON.
+
+## Where it sits
+
+```
+arbiter-engine        the invariant envelope
+  ^ pinned >=0.1.6,<0.2
+bmc-sensor-audit      the referee: declaration diff, liveness, attestation
+  ^ pinned >=0.1.0,<0.2
+cert-generator        this: identity, and the honest certificate
+```
+
+`qa-orchestrator` sits beside this one, injecting faults and checking the referee
+caught them. `odm-qa-pipeline` composes all of them.
+
+## Licence
+
+Apache-2.0.

odm_cert_generator-0.1.0/README.md

@@ -0,0 +1,195 @@
+# cert-generator
+
+Render a QC certificate from a [`bmc-sensor-audit`](https://github.com/james-sheen/bmc-sensor-audit)
+attestation.
+
+**Released — 0.1.0**, tagged `v0.1.0`, Apache-2.0, on PyPI as
+`odm-cert-generator`.
+
+**The distribution and the command differ, and the reason is worth one line.**
+PyPI ultranormalises a name by stripping its separators, so `cert-generator`
+becomes `certgenerator` — which an unrelated project holds — and the upload is
+refused as *too similar to an existing project*. So this publishes as
+`odm-cert-generator` and installs a command still called `cert-generator`. A
+certificate records the **distribution** name, because that is the one that
+resolves on an index.
+
+```
+pip install odm-cert-generator
+
+cert-generator render \
+    --attestation attestation.json \
+    --identity identity.json \
+    --coverage coverage.json \
+    --out-json certificate.json \
+    --out-pdf certificate.pdf
+```
+
+## What it is for
+
+The audit tool judges a machine and deliberately keeps the machine's identity out
+of everything it writes. A certificate has the opposite job: it has to name the
+unit. This renders one from the other, and holds the serial number on its own side
+of the line.
+
+Two trust domains, split on purpose. The referee cannot leak what it never sees.
+The certificate can say what a certificate must.
+
+## The certificate never claims a flat pass
+
+It will not print "100 % match". It prints the denominator:
+
+```
+6 invariant(s) checked over 3 entit(ies); 1 finding(s) recorded;
+3 check(s) declined and therefore not judged
+```
+
+...and then a section headed **Not part of this judgment**, which is emitted even
+when every list in it is empty — because an absent section reads as *nothing was
+left out*, and that is a claim.
+
+That section carries:
+
+| | |
+|---|---|
+| the declines | each with the engine's machine-readable reason |
+| `unattested` | problem types the engine would not attest |
+| `unread_feeds` | data that was read and not used |
+| the declaration diff | declared vs. present, when supplied — see below |
+| the engine's boundary | quoted verbatim, not paraphrased |
+
+A certificate showing what was *not* checked is one an incoming-inspection team
+can act on. The denominator is the point, not a concession.
+
+## The declaration diff is a second, optional input
+
+`attestation/1` records what the engine judged. It does not record what was
+*declared and never showed up*. Run the audit tool against a board declaring four
+sensors where one is absent and the artifact reads `checked: {entities: 3}` — three,
+with nothing on it saying three of four.
+
+So `--coverage` takes the JSON from `bmc-sensor-audit coverage --json`, which does
+carry the diff. Supply it and the certificate states declared-vs-present and names
+the absent sensor. Leave it out and the certificate says, on the page:
+
+> no declaration diff was supplied, so this certificate cannot state how many
+> declared sensors were present; the attestation counts only entities that reached
+> the engine
+
+It is optional because requiring it would make a certificate impossible for anyone
+holding only an attestation. It is *stated* because the smaller denominator must
+not pass for the whole picture.
+
+**That coverage artifact is written for a CI log, not a customer.** It names the
+BMC by URL and the configuration by filesystem path. Both are dropped here before
+anything is rendered; see `tests/test_privacy.py`.
+
+## The PDF is a projection of the JSON
+
+No number appears in the PDF that is absent from the certificate JSON. The JSON is
+the record; the PDF is how it looks. Anyone holding both can check one against the
+other without trusting this code:
+
+```
+cert-generator verify --certificate certificate.json --pdf certificate.pdf
+```
+
+Shipped rather than kept in a CI script, for the same reason the audit tool ships
+its attestation validator: the person who *receives* the document is the one who
+needs to check it.
+
+The suite checks the same property with poppler's `pdftotext` — a reader nobody
+here wrote.
+
+## Identity goes one way
+
+Identity flows *into* the certificate and never back toward the audit inputs. This
+package does not construct walks, configurations or supplemental declarations, and
+has no HTTP client. `tests/test_boundary.py` enforces it by parsing this package's
+own imports, because a rule kept by review lasts exactly as long as the reviewer's
+attention.
+
+The only thing it may reach for in the audit tool is `validate_attestation` — the
+tool's *shipped* validator, not a second copy of its rules. A shapeless artifact is
+refused, not decorated.
+
+## Exit codes
+
+The family's contract, not this tool's invention:
+
+| | |
+|---|---|
+| `0` | certificate written; nothing recorded against the unit |
+| `1` | certificate written; findings, or a declared sensor absent |
+| `2` | could not complete — nothing was judged |
+
+Precedence is `max`, copied from the audit tool. A run that both found something
+and failed to finish reports `2`, because `2` is the statement about the
+denominator and `1` would let a reader conclude the rest was checked.
+
+A certificate is still written when the verdict is `1`. A QC record for a unit that
+failed is a valid document.
+
+## A certificate is not the pipeline's verdict
+
+Two records run in parallel and neither contains the other. This one certifies what
+the referee established about a unit: the attestation, the identity, and the
+declaration diff when one is supplied. Conformance and fault injection are not in
+it. Those meet in `odm-qa-pipeline aggregate`, which answers a different question —
+did all four gates run, and what is the worst thing any of them found.
+
+Worth stating because reading either as the other goes wrong in both directions: a
+clean certificate says nothing about whether the injection gate ran, and a clean
+pipeline verdict is not a document anyone can hand to a customer.
+
+## The identity block
+
+```json
+{
+  "serial": "SN-A17-000482",
+  "work_order": "WO-2026-08-1174",
+  "station": "FCT-3",
+  "signer": "L. Okonkwo",
+  "part_number": "PN-88213-B",
+  "customer": "Example Hyperscale Inc.",
+  "line": "Kaohsiung 2"
+}
+```
+
+The first four are required. The rest are optional and rendered when present.
+Nothing is inferred, and an unrecognised key is **refused** rather than dropped —
+a typo would otherwise vanish silently, and nobody reads a certificate looking for
+the field that is not on it.
+
+## Known limits, written down rather than implied
+
+- **Latin-1 only.** The built-in PDF fonts cannot draw characters outside it. An
+  identity field containing them is refused, not transliterated: a serial number
+  silently rewritten is worse than a failed render. Shipping a Unicode font would
+  lift this; it has not been done.
+- **`verify` needs a PDF reader.** poppler's `pdftotext` if it is on `PATH`,
+  otherwise `pip install 'odm-cert-generator[verify]'` for pypdf. If neither is
+  present the command exits `2` — not finding a reader is not a pass.
+- **Nothing here re-audits the machine.** `verify` proves the page matches the
+  record. The record's authority comes from the attestation, and the
+  attestation's from the engine.
+- **One page.** Automatic page breaks are off on purpose, so a certificate that
+  overflows is visible as overflow rather than quietly paginated. A unit with very
+  many findings will need the JSON.
+
+## Where it sits
+
+```
+arbiter-engine        the invariant envelope
+  ^ pinned >=0.1.6,<0.2
+bmc-sensor-audit      the referee: declaration diff, liveness, attestation
+  ^ pinned >=0.1.0,<0.2
+cert-generator        this: identity, and the honest certificate
+```
+
+`qa-orchestrator` sits beside this one, injecting faults and checking the referee
+caught them. `odm-qa-pipeline` composes all of them.
+
+## Licence
+
+Apache-2.0.