@keri-ts/verifier 0.0.0-stage → 2.0.0

package/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.

package/README.md

@@ -1,3 +1,77 @@
-# Temporary Holding Version
+# @keri-ts/verifier
 
-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.
+Credential verifier application policy, webhook projection and workflow storage.
+The package borrows public `keri-ts/runtime`, `keri-ts/db` and `cesr-ts` operations;
+it does not start a host, open protocol stores, register CLI commands or own
+protocol acceptance. The agent retains its legacy credential/TEL workflow and optionally composes
+`AcdcV2Verifier` for authenticated ACDC v2 Grant views.
+
+```ts
+import { createVerifierCueBaser, VerifierAgent } from "@keri-ts/verifier";
+```
+
+Composition supplies the Habery, Reger, protocol processor, application cue Deck,
+scoped HTTP client and epoch-millisecond clock. The caller owns scheduling and
+closes the cue sidecar before its enclosing protocol stores. `VerifierAgent`
+keeps pending/ready issuance and revocation webhook work in `VerifierCueBaser`;
+HTTP success markers are local workflow history, not KERI receipts or business
+acknowledgements. Schema-specific validators decide business policy separately
+from authenticated protocol evidence.
+
+`tufa verifier run` remains the CLI composition. `@keri-ts/hosting` exposes
+the concrete HTTP host; verifier applications import this package directly.
+
+Run `deno task check`, `deno task test` and `deno task build:npm` from this directory.
+Licensed under Apache-2.0; see the repository's `LICENSE`.
+
+## ACDC v2 retained views and current use
+
+`AcdcV2Verifier(hby, hab, exc, registrar, http, options)` borrows the actual Exchanger,
+public evidence acceptor, local query signer and ordinary runtime HTTP client.
+Options select one HTTPS observer cache URL (`source`), maximum observation age,
+finite request deadline and a clock. The runtime's normal certificate trust and
+URL hostname verification authenticate HTTPS; requests refuse redirects. The URL
+must have no credentials, query or fragment. Queries never trigger registrar acquisition.
+KEL/TEL proof authentication remains
+independent of response-source authentication. Matching source/head/age establishes
+only recent observation from that configured endpoint, never global latest state.
+
+`inspectHistorical(grant)` authenticates the retained exact-route Grant through
+historical inspection, returning its unchanged origin and view references without
+queries, graph approval, current-standing claims, cues or reporting writes.
+`verifyCurrent(grant)` acquires current public evidence, requires an issued origin
+and the shared graph evaluator's explicit true with current per-node states.
+A legitimately revoked far node is known False and may satisfy NOR/NAND; missing,
+malformed or opaque evidence remains unresolved. Authenticated current public
+openings are transient proof inputs, never enrichment of retained credential views.
+
+Pass this concrete owner as `VerifierAgentOptions.acdcV2`. ACDC v2 workflow rows
+reuse the existing cue tables keyed by Grant SAID, keeping partial/full views of
+the same credential distinct. Every attempted ACDC v2 delivery rechecks current
+policy: a previously ready webhook cannot bypass a later opaque head. Historical
+accepted views and delivered markers remain history after revocation. ACDC v2
+payloads identify the Grant, presenter, verifier and configured observations.
+Transport failures retain ordinary pending webhook work; genuine cleanup/storage
+failures remain visible. No exactly-once delivery is claimed.
+
+`tufa verifier run --acdc-v2 --alias NAME --config verifier.json --hook URL`
+composes this owner with `runtime.http`. Observation selection and freshness are
+application policy in the existing schema-policy configuration:
+
+```json
+{
+  "observation": {
+    "url": "https://observer.example/",
+    "maximumAgeMs": 15000,
+    "requestTimeoutMs": 5000
+  },
+  "requireKnownSchemas": false,
+  "schemas": {}
+}
+```
+
+ACDC v2 requires `observation.url`. Omitted durations retain the 15,000 ms age
+and 5,000 ms deadline defaults; supplied durations must be finite and positive.
+Configure HTTPS trust through the runtime/platform trust settings. A missing or
+expired observation cannot approve current use; unrelated cancellation, cleanup
+and storage failures remain visible. Omitting `--acdc-v2` preserves the legacy lane.

package/esm/package.json

@@ -0,0 +1,3 @@
+{
+  "type": "module"
+}

package/esm/verifier/npm/src/mod.js

@@ -0,0 +1,5 @@
+/** Verifier application package entrypoint. */
+export { AcdcV2Verifier, } from "./src/acdc-v2.js";
+export { VerifierAgent } from "./src/agent.js";
+export { createVerifierCueBaser, VerifierCueBaser, } from "./src/cue-store.js";
+export { validatorsFromVerifierConfig, } from "./src/policy.js";

package/esm/verifier/npm/src/src/acdc-v2.js

@@ -0,0 +1,239 @@
+import { BlindState, BoundState, bytesEqual, concatBytes, Counter, Diger, Vrsn_2_0 } from "cesr-ts";
+import { call } from "effection";
+import { loadNests } from "keri-ts/db";
+import { acceptedRegistryEvidence, authenticateIpexNode, envelopeFromFrame, evaluateChain, isCesrContentType, issuedNodeVerdict, query, timestampMicros, TransportError, ValidationError, vetBinds, walkIpexGraph, } from "keri-ts/runtime";
+/** Borrow accepted exchange/public evidence owners; acquire no stores, parser or background worker. */
+export class AcdcV2Verifier {
+    constructor(hby, hab, exc, evidence, http, options) {
+        Object.defineProperty(this, "hby", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: hby
+        });
+        Object.defineProperty(this, "hab", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: hab
+        });
+        Object.defineProperty(this, "exc", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: exc
+        });
+        Object.defineProperty(this, "evidence", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: evidence
+        });
+        Object.defineProperty(this, "http", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: http
+        });
+        Object.defineProperty(this, "options", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: options
+        });
+        if (exc.hby !== hby || hab.db !== hby.db || evidence.processor.kvy.db !== hby.db) {
+            throw new ValidationError("ACDC v2 verifier requires its actual local evidence owners.");
+        }
+        if (![options.maximumAgeMs, options.requestTimeoutMs].every(value => Number.isFinite(value) && value > 0)) {
+            throw new ValidationError("Source age and request timeout must be finite and positive.");
+        }
+        const source = new URL(options.source);
+        if (source.protocol !== "https:" || source.username || source.password || source.search || source.hash) {
+            throw new ValidationError("Observation source must be HTTPS without credentials, query or fragment.");
+        }
+    }
+    /** Inspect the immutable retained nested material without querying, reporting or applying graph policy. */
+    inspectHistorical(grant) {
+        const body = this.hby.db.exns.get([grant]);
+        if (!body || body.route !== "/ipex/grant" || body.pvrsn.major !== 2
+            || !this.exc.verifyAccepted(grant, "/ipex/grant", { historical: true }))
+            throw new ValidationError("Authenticated retained ACDC v2 Grant is required.");
+        const nodes = loadNests(this.hby.db, grant), origins = body.sad.a.o;
+        if (!Array.isArray(origins) || origins.length > 1) {
+            throw new ValidationError("Verifier requires zero or one retained origin.");
+        }
+        const credential = origins.length ? nodes.find(node => node.body.said === origins[0])?.body : null;
+        if (origins.length && !credential)
+            throw new ValidationError("Retained origin is missing.");
+        return {
+            purpose: "historical-evidence",
+            proofValidity: "valid",
+            currentStanding: "not-evaluated",
+            grant,
+            credential: credential,
+            recordedRegistryStates: [...this.hby.db.exrs.getTopItemIter([grant])]
+                .filter(([keys]) => nodes.some((node) => node.body.said === keys[1]))
+                .map(([keys, { regid, said, sn, state, stamp }]) => ({ node: keys[1], regid, said, sn, state, stamp })),
+            views: nodes.map(node => ({
+                credential: node.body.said,
+                view: new Diger({ raw: Diger.digest(node.body.raw, "E"), code: "E" }).qb64,
+            })),
+        };
+    }
+    /** Authenticate one complete source response and its exact accepted head, never infer global latest state. */
+    *observe(regid) {
+        const { source, maximumAgeMs, requestTimeoutMs, now } = this.options;
+        const wire = this.hab.endorse(query("tels", { i: regid }, { pre: this.hab.pre, version: Vrsn_2_0 }), {
+            gvrsn: Vrsn_2_0,
+        });
+        const deadline = new AbortController(), expired = new Error("Observation request deadline expired");
+        const timer = setTimeout(() => deadline.abort(expired), requestTimeoutMs);
+        let response;
+        try {
+            response = yield* this.http.request(source, {
+                method: "POST",
+                headers: { "Content-Type": "application/cesr" },
+                body: wire,
+                redirect: "error",
+                signal: deadline.signal,
+            });
+        }
+        catch (error) {
+            if (error instanceof TransportError || (deadline.signal.aborted && error === expired))
+                return null;
+            throw error;
+        }
+        finally {
+            clearTimeout(timer);
+        }
+        const stamp = response.headers.get("Observer-Observed-At"), head = response.headers.get("Observer-Registry-Head");
+        const micros = timestampMicros(stamp), age = micros === null ? NaN : now() - Number(micros) / 1000;
+        if (response.status !== 200 || !isCesrContentType(response.headers.get("content-type"))
+            || response.headers.get("Observer-Evidence-State") !== "fresh" || !stamp || !Number.isFinite(age) || age < 0
+            || age > maximumAgeMs || !head)
+            return null;
+        const result = yield* call(() => this.evidence.ingest(concatBytes(Counter.makeGVC(Vrsn_2_0), response.body)));
+        if (Object.keys(result.pending).length || Object.keys(result.rejected).length || result.heads[regid] !== head
+            || this.evidence.store.head(regid)?.qb64 !== head)
+            return null;
+        return { registry: regid, source, head, observedAt: stamp };
+    }
+    /** Require shared graph approval and full current standing over the exact retained credential views. */
+    *verifyCurrent(grant) {
+        const inspected = this.inspectHistorical(grant), observations = [];
+        const result = (kind) => ({
+            kind,
+            credential: inspected.credential,
+            observations,
+        });
+        if (!inspected.credential)
+            return result("refused");
+        const graph = walkIpexGraph(inspected.credential.said, loadNests(this.hby.db, grant), true);
+        if (!graph)
+            return result("refused");
+        const registrations = new Map();
+        const verdicts = new Map();
+        const missing = () => ({
+            kind: "unknown",
+            retryable: true,
+            reason: "Missing current registry evidence.",
+            schemas: [],
+        });
+        const registries = new Set();
+        for (const { body } of graph.nodes.values()) {
+            if (body.regid)
+                registries.add(body.regid);
+            // W06's attribute declaration is already authenticated by the IPEX handler; aggregate pairs are data.
+            const attrs = body.attrib;
+            if (body.regid && attrs && typeof attrs === "object" && !Array.isArray(attrs)
+                && typeof attrs.rd === "string"
+                && typeof attrs.i === "string")
+                registries.add(attrs.rd);
+        }
+        const unavailable = new Set();
+        for (const regid of registries) {
+            const observation = yield* this.observe(regid);
+            if (observation)
+                observations.push(observation);
+            else
+                unavailable.add(regid);
+        }
+        for (const [said, node] of graph.nodes) {
+            const auth = authenticateIpexNode(node.body, envelopeFromFrame(node), this.hby.db, this.evidence.store, true);
+            verdicts.set(said, issuedNodeVerdict(auth));
+            if (auth.kind !== "authenticated" || !node.body.regid)
+                continue;
+            if (unavailable.has(node.body.regid)) {
+                verdicts.set(said, missing());
+                continue;
+            }
+            const chain = acceptedRegistryEvidence(this.evidence.store, node.body.regid);
+            if (!chain) {
+                verdicts.set(said, missing());
+                continue;
+            }
+            const envelope = envelopeFromFrame(node), proofs = new Map();
+            for (const proof of [...envelope.bsqs, ...envelope.bsss])
+                proofs.set(proof.d.nonce, proof);
+            const encoded = (proof) => "bn" in proof ? BoundState.qb64b(proof) : BlindState.qb64b(proof);
+            // Public source proofs may establish current standing; retained node bytes and historical selection stay unchanged.
+            let conflict = false;
+            for (const event of chain.updates) {
+                const proof = this.evidence.store.publicOpening(event.said);
+                if (!proof)
+                    continue;
+                const previous = proofs.get(proof.d.nonce);
+                if (previous && !bytesEqual(encoded(previous), encoded(proof)))
+                    conflict = true;
+                proofs.set(proof.d.nonce, proof);
+            }
+            if (conflict) {
+                verdicts.set(said, { kind: "invalid" });
+                continue;
+            }
+            const state = vetBinds({
+                ...chain,
+                db: this.hby.db,
+                blinders: [...proofs.values()],
+                target: node.body.said,
+                acdc: node.body,
+            });
+            if (state.kind !== "verified") {
+                verdicts.set(said, state.kind === "missing" ? missing() : { kind: "invalid" });
+                continue;
+            }
+            registrations.set(said, state.state);
+            verdicts.set(said, issuedNodeVerdict({ kind: "authenticated", registration: state.state }));
+        }
+        // Freshness failures belong to their node, so an optional branch can remain unused.
+        for (const observation of observations) {
+            const age = this.options.now() - Number(timestampMicros(observation.observedAt)) / 1000;
+            if (age < 0 || age > this.options.maximumAgeMs
+                || this.evidence.store.head(observation.registry)?.qb64 !== observation.head)
+                unavailable.add(observation.registry);
+        }
+        for (const [said, { body }] of graph.nodes) {
+            const attrs = body.attrib;
+            const presentation = attrs && typeof attrs === "object" && !Array.isArray(attrs)
+                ? attrs.rd
+                : null;
+            if ((body.regid && unavailable.has(body.regid))
+                || (typeof presentation === "string" && unavailable.has(presentation))) {
+                if (registrations.has(said) || verdicts.get(said)?.kind !== "invalid")
+                    verdicts.set(said, missing());
+            }
+        }
+        const truth = evaluateChain(graph, verdicts, this.hby.db);
+        const rootState = registrations.get(inspected.credential.said)?.state;
+        if (!truth)
+            return result("refused");
+        if (rootState === "revoked" && verdicts.get(inspected.credential.said)?.kind === "invalid") {
+            return result("revoked");
+        }
+        if (truth.kind === "valid")
+            return result("issued");
+        if (truth.kind === "unknown")
+            return result("missing");
+        return result("refused");
+    }
+}