@zanii/certify 0.0.0-stage → 0.6.0

package/LICENSE

@@ -0,0 +1,159 @@
+                                 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; 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.
+
+   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.
+
+   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.
+
+   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.
+
+   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.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2026 Zanii
+
+   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.

package/README.md

@@ -1,3 +1,145 @@
-# Temporary Holding Version
+# @zanii/certify
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+TypeScript SDK and `certify` CLI for Zanii Certify fingerprints, signed certificates,
+status, evidence sharing, runtime assurance and scheme governance. The package uses
+ES modules and requires Node.js 24 or newer. Every public function is exported from the
+package root; the signed formats are defined in the Zanii Certify specification (`spec/`).
+
+## Install
+
+```sh
+npm install @zanii/certify
+npx certify verify cert.json --online https://lab.zanii.agency
+```
+
+Paths in backticks below (`spec/...`, `conformance/...`) are files of the Zanii Certify source repository, which is private; the specification documents are available from Zanii on request (info@zanii.agency).
+
+## Use this checkout
+
+From the repository root, with the pnpm version declared in the root `package.json`:
+
+```sh
+pnpm install --frozen-lockfile
+node packages/certify/src/cli.ts --help-v2
+```
+
+The workspace package resolves directly to TypeScript source. Save the following as
+`example.mjs` at the repository root and run `node example.mjs`. It needs no server,
+network access or signing key:
+
+```js
+import {
+  buildFingerprint, checkFingerprint, promptSha256,
+  runtimeRequestHash, sha256Bytes,
+} from "@zanii/certify";
+
+const fingerprint = buildFingerprint({
+  model: "example-model@1",
+  prompt: promptSha256("Answer using the approved policy."),
+  tools: null,
+  policy: null,
+  knowledge: null,
+});
+if (!checkFingerprint(fingerprint)) throw new Error("Invalid fingerprint");
+console.log(fingerprint.id);
+
+// Commit the exact request body bytes; this hash alone grants no permission.
+const body = '{"amount_minor":100,"currency":"USD"}';
+console.log(runtimeRequestHash({
+  method: "POST",
+  url: "https://bank.example/payments",
+  body_sha256: sha256Bytes(body),
+}));
+```
+
+Fingerprint fields contain hashes or `null`, rather than raw prompts/documents.
+Keep the original bytes: changing whitespace can change a commitment.
+
+## Verification policy
+
+`await verifyCertificate(certificate, options)` returns a structured check with
+`ok` and `reasons`. Optional checks run when their inputs/policies are supplied;
+an `ok` result alone does not mean every relying-party requirement was checked.
+
+- Supply fresh signed `status` and `revocationList`, the expected `fingerprint`,
+  and an explicit verification time (`now`) when reproducibility is required.
+- Supply an independently approved `issuerPolicy` and the corresponding `issuerDoc`.
+  A downloaded document cannot choose its own trusted keys. Changed keys/PQ metadata
+  require local policy review; `allowNoPq` cannot override this pinned policy.
+- Supply `pq`/`statusPq` when required. For Level 3, supply the audit plus trusted
+  bodies or an independently rooted body register. Add witness, licence and release
+  policies where the relying party requires them. Strict withdrawal checking needs
+  the withdrawal log and `releases.rejectWithdrawn: true`.
+
+The complete option types are in certificate.ts (`packages/certify/src/certificate.ts`), and executable
+positive/negative policy examples are in verification-policy.test.ts (`packages/certify/src/verification-policy.test.ts`).
+Legacy optional behavior is retained for compatibility; select your policy explicitly.
+Offline evidence cannot reveal an undisclosed newer checkpoint or revocation.
+
+The CLI is offline by default. `--help-v2` lists current audit, witness, release and
+strict-policy inputs. `--online` enables bounded retrieval, including required PQ
+material. A relying party requiring every CLI check should accept only exit code 0;
+exit code 2 means not fully checked. See the CLI contract (`spec/cli.md`).
+
+## Contracts and limits
+
+| Area | Contract |
+| --- | --- |
+| Fingerprints and certificate verification | Fingerprint (`spec/fingerprint.md`), certificate and pinned policy (`spec/certificate.md`) |
+| Status and freshness | Status v1/v2 (`spec/status.md`), witness checkpoints (`spec/witness.md`), Bitstring Status List (`spec/bitstring-status.md`), assurance withdrawal (`spec/assurance-status.md`) |
+| Runtime releases, mandates, leases and knowledge proofs | Runtime assurance (`spec/runtime.md`) |
+| Scheme releases, exact text and transitions | Scheme (`spec/scheme.md`), immutable text (`spec/scheme-text.md`), checkpointed log (`spec/scheme-log.md`) |
+| Redacted evidence and inclusion proofs | Evidence sharing (`spec/evidence-share.md`) |
+
+Builders and verifiers enforce format-specific byte/count limits. Read each contract
+before choosing workload sizes or persisting freshness watermarks. A valid inclusion
+proof establishes commitment to supplied data; it does not establish content truth,
+ACL permission or quality. The Node package also exposes Nitro verification, a runtime
+reporter and a reference gateway; those host integrations are not Python SDK equivalents.
+
+## Beacon reporting
+
+`startBeacon` sends immediately, then waits the configured interval after each completed
+operation. Intervals must be between 1,000 and 2,147,483,647 milliseconds. Each client allows
+one underlying operation; concurrent `send()` calls return a busy failure without queuing.
+The full operation has a ten second deadline, including fingerprint collection, signing and
+reading the response. Replies are capped at 32KiB; redirects and credentialed URLs are refused.
+
+`stop()` disables automatic reporting and aborts the active request. Manual `send()` remains
+available. An injected callback that ignores cancellation keeps its slot until it returns;
+late callbacks cannot submit a report. Result observer exceptions do not interrupt reporting.
+
+`startBeacon`, `createRuntimeReporter` and `createRuntimeGateway` accept optional
+`transportKey: process.env.CERTIFY_TRANSPORT_KEY`. Use an agent-bound `ctk_` admission
+credential issued by the owner/admin transport-key controls, never a management API key.
+It travels only in the authority's Authorization header, outside signed documents and
+hashes. The gateway never forwards it to a protected backend. Invalid prefixes and
+non-HTTPS beacon endpoints are refused before I/O, except literal loopback/localhost
+for local development. Runtime reporter/gateway authority URLs keep their existing
+HTTPS requirement. Anonymous signed clients still work; transport admission does not
+replace signatures, approved workload binding or replay checks. Redirects remain refused.
+Callback error messages and beacon response echoes redact the supplied credential.
+
+The reporter handles challenge/evidence and the gateway handles consume. Lease request
+builders produce signed documents; this package does not provide a general HTTP lease
+acquisition or management client. Injected transports must keep credentials private and
+honor the same redirect/deadline contract.
+
+The package root also exports `JsonFetchResult`, `logPositionOk`,
+`RUNTIME_NITRO_MAX_BYTES` and `RUNTIME_NITRO_MAX_SKEW_SECONDS` for callers validating
+issuer responses, status log positions and raw runtime attestations.
+
+## Check changes
+
+Run from the repository root:
+
+```sh
+pnpm typecheck
+pnpm --filter @zanii/certify test
+node --test packages/certify/src/verification-policy.test.ts
+```
+
+Shared vectors (`spec/vectors`) and conformance tests (`conformance`)
+check the common TypeScript/Python wire formats. New versioned formats preserve the
+old signed bytes. Local SDK tests do not qualify deployment security or capacity;
+see the readiness report (`docs/readiness-report.md`).

package/dist/appliance-execution.d.ts

@@ -0,0 +1,18 @@
+export interface ApplianceExportIdentity {
+    v: 1;
+    type: "certify.appliance-export-identity";
+    appliance: string;
+    source_run: string;
+    recipient: string;
+}
+export interface ApplianceExecution {
+    v: 1;
+    type: "certify.appliance-execution";
+    appliance: string;
+    source_run: string;
+    source_bundle: string;
+    export: string;
+    attestation: "quote_verified" | "not_verified";
+}
+export declare function applianceExportIdentity(value: unknown): ApplianceExportIdentity;
+export declare function applianceExecution(value: unknown): ApplianceExecution;

package/dist/appliance-execution.js

@@ -0,0 +1,12 @@
+import { isDid, isObj, isSha } from "./shared.js";
+const run = (value) => typeof value === "string" && /^[A-Za-z0-9._:-]{1,128}$/.test(value);
+export function applianceExportIdentity(value) {
+    if (!isObj(value) || Object.keys(value).length !== 5 || value.v !== 1 || value.type !== "certify.appliance-export-identity" || !isDid(value.appliance) || !run(value.source_run) || !isSha(value.recipient))
+        throw new Error("invalid appliance export identity (v1)");
+    return { v: 1, type: "certify.appliance-export-identity", appliance: value.appliance, source_run: value.source_run, recipient: value.recipient };
+}
+export function applianceExecution(value) {
+    if (!isObj(value) || Object.keys(value).length !== 7 || value.v !== 1 || value.type !== "certify.appliance-execution" || !isDid(value.appliance) || !run(value.source_run) || !isSha(value.source_bundle) || !isSha(value.export) || typeof value.attestation !== "string" || !["quote_verified", "not_verified"].includes(value.attestation))
+        throw new Error("invalid appliance execution provenance (v1)");
+    return { v: 1, type: "certify.appliance-execution", appliance: value.appliance, source_run: value.source_run, source_bundle: value.source_bundle, export: value.export, attestation: value.attestation };
+}

package/dist/appliance.d.ts

@@ -0,0 +1,135 @@
+import { type QuoteVerifier } from "@zanii/attest";
+import { type HybridKemKeypair, type HybridSealed } from "@zanii/pq";
+import { type ApplianceExportBundle, type ResultBundle } from "./bundle.ts";
+import { type Signer } from "./signer.ts";
+export interface ApplianceCheck {
+    ok: boolean;
+    reasons: string[];
+}
+export interface ApplianceEnrolment {
+    v: 1;
+    type: "certify.appliance-enrolment";
+    appliance: string;
+    customer: {
+        name: string;
+        country: string;
+    };
+    measurements: string[];
+    enrolled_at: string;
+    valid_until: string;
+    signer: string;
+    sig: string;
+}
+/** Section 1: the central lab enrols an appliance key and the code measurements it may run. */
+export declare function buildApplianceEnrolment(f: {
+    appliance: string;
+    customer: {
+        name: string;
+        country: string;
+    };
+    measurements: readonly string[];
+    enrolledAt: string;
+    validUntil: string;
+}, signer: Signer): Promise<ApplianceEnrolment>;
+export interface EvidenceHead {
+    chain: string;
+    head: string;
+    size: number;
+}
+/** Section 2: the transcripts, sealed to the central lab's hybrid key, and that key's hash. */
+export interface SealedTranscripts {
+    recipient: string;
+    sealed: HybridSealed;
+}
+export interface ApplianceAttestation {
+    v: 1;
+    platform: string;
+    measurement: string;
+    quote_hash: string;
+    /** `applianceChallenge` of the export. */
+    nonce: string;
+    attested_at: string;
+}
+export interface ApplianceExport {
+    v: 1;
+    type: "certify.appliance-export";
+    appliance: string;
+    enrolment: ApplianceEnrolment;
+    attestation: ApplianceAttestation;
+    bundle: ResultBundle | ApplianceExportBundle;
+    evidence: EvidenceHead[];
+    transcripts: SealedTranscripts;
+    exported_at: string;
+    signer: string;
+    sig: string;
+}
+/** Section 2: the hash of the central lab's public key, `{x25519, mlkem}` hex. */
+export declare const labKeyId: (key: HybridKemKeypair["publicKey"]) => string;
+/** Section 2: seal the transcripts (any JSON value) to the central lab: its canonical bytes, hybrid sealed. */
+export declare function sealTranscripts(transcripts: unknown, labKey: HybridKemKeypair["publicKey"]): SealedTranscripts;
+/** Section 2: the report data the appliance's attestation quote binds. */
+export declare const applianceChallenge: (f: {
+    appliance: string;
+    bundle: string;
+    evidence: readonly EvidenceHead[];
+    transcripts: SealedTranscripts;
+    exportedAt: string;
+}) => string;
+export interface ApplianceExportInput {
+    enrolment: ApplianceEnrolment;
+    attestation: ApplianceAttestation;
+    bundle: ResultBundle | ApplianceExportBundle;
+    evidence: readonly EvidenceHead[];
+    transcripts: SealedTranscripts;
+    exportedAt: string;
+}
+/** Section 2: the export, signed by the appliance key (`signer`, the enrolled appliance). */
+export declare function buildApplianceExport(f: ApplianceExportInput, signer: Signer): Promise<ApplianceExport>;
+/**
+ * Section 3: signed by its appliance, enrolled by a trusted central lab (`labs`) for the time of
+ * export, attested for this export with an enrolled measurement, sealed to `labKey` when given, and
+ * (with `verifyQuote`) the attestation quote verified by the injected platform verifier.
+ */
+export declare function verifyApplianceExport(doc: unknown, opts?: {
+    labs?: readonly string[];
+    labKey?: HybridKemKeypair["publicKey"];
+    now?: string;
+    verifyQuote?: QuoteVerifier;
+}): Promise<ApplianceCheck & {
+    attested: boolean | null;
+}>;
+/** Section 4: the central lab opens the transcripts with its secret key; throws on a wrong key or tampering. */
+export declare function openApplianceExport(doc: ApplianceExport, secretKey: HybridKemKeypair["secretKey"]): unknown;
+export interface ApplianceUpdate {
+    v: 1;
+    type: "certify.appliance-update";
+    version: string;
+    sha256: string;
+    /** jcsHash of the enrolment of the one appliance the update is for. */
+    enrolment: string;
+    released_at: string;
+    notes: {
+        en: string;
+        ar: string;
+    };
+    signer: string;
+    sig: string;
+}
+/** Section 5: an offline update bundle's manifest for one enrolled appliance (`enrolment`, the jcsHash of its enrolment), signed by the lab release key. */
+export declare function buildApplianceUpdate(f: {
+    version: string;
+    sha256: string;
+    enrolment: string;
+    releasedAt: string;
+    notes: {
+        en: string;
+        ar: string;
+    };
+}, signer: Signer): Promise<ApplianceUpdate>;
+/** Section 5: signed by a trusted release key (`keys`), for `content` when given, for the appliance whose enrolment hash is `enrolment`, and newer than `installed` when given. */
+export declare function verifyApplianceUpdate(doc: unknown, opts?: {
+    keys?: readonly string[];
+    content?: Uint8Array;
+    installed?: string;
+    enrolment?: string;
+}): ApplianceCheck;