@crawlcheck/sdk 1.0.6 → 1.0.7

package/README.md

@@ -37,6 +37,19 @@ await cc.get("/api/explain", { domain: "example.com", code: "NO_LLMS_TXT" });
 await cc.get("/api/explain", { website: "x" });   // compile error: not a parameter of this operation
 ```
 
+## Use the site's staple
+
+A site can serve its own signed verdict in the `CrawlCheck-Staple` header (and at `/.well-known/crawlcheck-staple.json`). `resolveFor` uses it when it verifies, with no request to CrawlCheck, and falls back to a signed lookup when it is missing, expired, for another domain or tampered:
+
+```js
+const res = await fetch("https://shop.example.com/");
+const v = await client.resolveFor("shop.example.com", { response: res });
+v.source;              // "staple" or "network"
+v.decisions.transact;  // allow | warn | require_confirmation | block | unsupported
+```
+
+`stapleCheck(record, { host, publishedKids })` does the offline check on its own. Spec: https://crawlcheck.io/spec/staple
+
 ## Do not trust the API: check the evidence yourself
 
 ```js

package/dist/index.d.ts

@@ -1,4 +1,5 @@
 import type { paths, components } from "./gen/openapi.js";
+import * as S from "./staple.js";
 export type { paths, components };
 /** One verifier check. ok: true passed, false FAILED, null could not run (why says why) - never a pass. */
 export interface VerifyCheck {
@@ -328,6 +329,33 @@ export declare const verifyWitnessToken: (token: string, sthSha256: string, jwks
     claims?: JsonObject;
 }>;
 export declare const GITHUB_OIDC_JWKS = "https://token.actions.githubusercontent.com/.well-known/jwks";
+export type StapleDecisions = {
+    read: string | null;
+    cite: string | null;
+    connect: string | null;
+    transact: string | null;
+};
+export interface StapleCheck {
+    valid: boolean;
+    reason: string | null;
+    expired: boolean;
+    record: Record<string, string> | null;
+    decisions: StapleDecisions | null;
+}
+/** Parse a ccr1 record (CrawlCheck-Staple header value or <domain>._v.crawlcheck.io TXT). */
+export declare const parseStaple: (record: string) => {
+    fields: Record<string, string>;
+    body: string;
+    sig: string;
+};
+/** The CrawlCheck-Staple header of a response (fetch Response, Headers or a plain header map), or null. */
+export declare const stapleFromResponse: (res: unknown) => string | null;
+/** Verify a staple offline: published key, signature, the record names opts.host (or a parent), fresh_until in the future. Expired or foreign staples are never valid. */
+export declare const stapleCheck: (record: string, opts: {
+    host: string;
+    publishedKids: string[];
+    now?: number;
+}) => Promise<StapleCheck>;
 export interface ClientOptions {
     /** Licence key (cc_ + 32 hex). Without one, licence-gated fields come back withheld, exactly as on the website. */
     key?: string;
@@ -369,6 +397,23 @@ export declare class CrawlCheck {
     post<P extends keyof paths>(path: P, body: BodyOf<P> | JsonObject, query?: QueryOf<P, "post">): Promise<ResponseOf<P, "post">>;
     /** The signed ResolveV1 answer: crawl policy, delivery, machine files, capabilities, entity, findings, freshness and a decision per action. */
     resolve(domain: string): Promise<ResponseOf<"/api/v1/resolve", "get">>;
+    private kidCache;
+    /** The key ids CrawlCheck publishes (/.well-known/http-message-signatures-directory), cached for an hour. */
+    publishedKids(): Promise<string[]>;
+    /**
+     * The verdict for a domain, preferring a valid staple the site sent (opts.staple, or opts.response's CrawlCheck-Staple
+     * header): no request to CrawlCheck is made when the staple verifies. An expired, foreign or invalid staple is ignored
+     * and the signed answer is fetched instead; source says which was used and staple says why.
+     */
+    resolveFor(domain: string, opts?: {
+        staple?: string | null;
+        response?: unknown;
+    }): Promise<{
+        source: "staple" | "network";
+        decisions: StapleDecisions;
+        staple: StapleCheck | null;
+        answer?: unknown;
+    }>;
     /** Up to 100 domains in one call; each answer is a full signed ResolveV1 document. */
     resolveBatch(domains: string[]): Promise<any>;
     /** Split-view check: the current head, GitHub's witness co-signature on the last witnessed head, and the chain from it down to every head this client holds. Reports the heads it holds to /api/v1/log/gossip unless report is false. */

package/dist/index.js

@@ -1,5 +1,6 @@
 import * as V from "./verify.js";
 import * as L from "./log.js";
+import * as S from "./staple.js";
 function withTrust(v, kid, published) {
     let checks = v.checks;
     let issuer = null;
@@ -76,6 +77,12 @@ export const logGossip = L.logGossip;
 /** Verify the outside witness's co-signature: a GitHub OIDC JWT (RS256) whose audience is crawlcheck-sth:<head sha256>. */
 export const verifyWitnessToken = L.verifyWitnessToken;
 export const GITHUB_OIDC_JWKS = "https://token.actions.githubusercontent.com/.well-known/jwks";
+/** Parse a ccr1 record (CrawlCheck-Staple header value or <domain>._v.crawlcheck.io TXT). */
+export const parseStaple = S.parseStaple;
+/** The CrawlCheck-Staple header of a response (fetch Response, Headers or a plain header map), or null. */
+export const stapleFromResponse = S.stapleFromResponse;
+/** Verify a staple offline: published key, signature, the record names opts.host (or a parent), fresh_until in the future. Expired or foreign staples are never valid. */
+export const stapleCheck = S.stapleCheck;
 export class CrawlCheckError extends Error {
     status;
     body;
@@ -123,6 +130,41 @@ export class CrawlCheck {
         await logObserveAnswer(this.log, a).catch(() => null); // a head that contradicts one this client already holds is recorded in this.log.forks
         return a;
     }
+    kidCache = null;
+    /** The key ids CrawlCheck publishes (/.well-known/http-message-signatures-directory), cached for an hour. */
+    async publishedKids() {
+        if (this.kidCache && Date.now() - this.kidCache.at < 3600e3)
+            return this.kidCache.kids;
+        const r = await this.f(this.base + "/.well-known/http-message-signatures-directory", { headers: { accept: "application/json" } });
+        const j = await r.json();
+        const kids = ((j && j.keys) || []).map((k) => k.kid).filter(Boolean);
+        this.kidCache = { at: Date.now(), kids };
+        return kids;
+    }
+    /**
+     * The verdict for a domain, preferring a valid staple the site sent (opts.staple, or opts.response's CrawlCheck-Staple
+     * header): no request to CrawlCheck is made when the staple verifies. An expired, foreign or invalid staple is ignored
+     * and the signed answer is fetched instead; source says which was used and staple says why.
+     */
+    async resolveFor(domain, opts = {}) {
+        const rec = opts.staple || (opts.response ? stapleFromResponse(opts.response) : null);
+        let chk = null;
+        if (rec) {
+            let kids = [];
+            try {
+                kids = await this.publishedKids();
+            }
+            catch {
+                kids = [];
+            }
+            chk = await stapleCheck(rec, { host: normalizeDomain(domain), publishedKids: kids });
+            if (chk.valid && chk.decisions)
+                return { source: "staple", decisions: chk.decisions, staple: chk };
+        }
+        const a = await this.resolve(domain);
+        const act = (k) => (a && a.actions && a.actions[k] && a.actions[k].decision) || null;
+        return { source: "network", decisions: { read: act("read"), cite: act("cite"), connect: act("connect"), transact: act("transact") }, staple: chk, answer: a };
+    }
     /** Up to 100 domains in one call; each answer is a full signed ResolveV1 document. */
     async resolveBatch(domains) {
         const r = await this.post("/api/v1/resolve", { domains });

package/dist/staple.d.ts

@@ -0,0 +1,21 @@
+/** Parse a ccr1 record ("v=ccr1;d=...;s=..."); quoted TXT strings from dig are joined. */
+export function parseStaple(record: any): {
+    fields: {};
+    body: string;
+    sig: string;
+};
+/** The staple a response carries, if any (a fetch Response, a Headers object or a plain header map). */
+export function stapleFromResponse(res: any): any;
+/**
+ * Check a staple offline. opts.host: the host the agent is talking to (required for a usable result);
+ * opts.publishedKids: the key ids CrawlCheck publishes (from /.well-known/http-message-signatures-directory);
+ * opts.now: epoch ms (default Date.now()).
+ * Returns { valid, reason, expired, record, decisions } and never throws.
+ */
+export function stapleCheck(record: any, opts?: {}): Promise<{
+    valid: boolean;
+    reason: null;
+    expired: boolean;
+    record: null;
+    decisions: null;
+}>;

package/dist/staple.js

@@ -0,0 +1,88 @@
+// Stapled Resolve and Resolve over DNS: the compact ccr1 record a site sends in the CrawlCheck-Staple header (or that
+// <domain>._v.crawlcheck.io TXT carries). Verified offline: key id = RFC 7638 thumbprint of the public key, the key is
+// one CrawlCheck publishes, the Ed25519 signature covers the record, the record names the host (or a parent domain),
+// and fresh_until is in the future. An expired or foreign staple is never used.
+const STAPLE_PREFIX = "crawlcheck-dns-v1\n";
+const te = new TextEncoder();
+function b64uToBytes(s) { s = String(s || "").replace(/-/g, "+").replace(/_/g, "/"); s += "===".slice((s.length + 3) % 4); const b = atob(s), u = new Uint8Array(b.length); for (let i = 0; i < b.length; i++)
+    u[i] = b.charCodeAt(i); return u; }
+function bytesToB64u(u) { let s = ""; for (let i = 0; i < u.length; i++)
+    s += String.fromCharCode(u[i]); return btoa(s).replace(/\+/g, "-").replace(/\//g, "_").replace(/=+$/, ""); }
+/** Parse a ccr1 record ("v=ccr1;d=...;s=..."); quoted TXT strings from dig are joined. */
+export function parseStaple(record) {
+    const t = String(record || "").trim().replace(/"\s*"/g, "").replace(/^"|"$/g, "");
+    const i = t.lastIndexOf(";s=");
+    const body = i > 0 ? t.slice(0, i) : "", sig = i > 0 ? t.slice(i + 3) : "";
+    const f = {};
+    body.split(";").forEach((p) => { const j = p.indexOf("="); if (j > 0)
+        f[p.slice(0, j)] = p.slice(j + 1); });
+    return { fields: f, body, sig };
+}
+/** The staple a response carries, if any (a fetch Response, a Headers object or a plain header map). */
+export function stapleFromResponse(res) {
+    const h = res && (res.headers || res);
+    if (!h)
+        return null;
+    if (typeof h.get === "function")
+        return h.get("crawlcheck-staple");
+    for (const k of Object.keys(h))
+        if (k.toLowerCase() === "crawlcheck-staple")
+            return h[k];
+    return null;
+}
+/**
+ * Check a staple offline. opts.host: the host the agent is talking to (required for a usable result);
+ * opts.publishedKids: the key ids CrawlCheck publishes (from /.well-known/http-message-signatures-directory);
+ * opts.now: epoch ms (default Date.now()).
+ * Returns { valid, reason, expired, record, decisions } and never throws.
+ */
+export async function stapleCheck(record, opts = {}) {
+    const out = { valid: false, reason: null, expired: false, record: null, decisions: null };
+    try {
+        const { fields: f, body, sig } = parseStaple(record);
+        out.record = f;
+        if (f.v !== "ccr1" || !f.d || !f.k || !f.x || !sig) {
+            out.reason = "not a ccr1 record";
+            return out;
+        }
+        out.decisions = { read: f.read || null, cite: f.cite || null, connect: f.connect || null, transact: f.transact || null };
+        const now = opts.now || Date.now(), fu = Date.parse(f.f || "");
+        if (!isFinite(fu) || fu <= now) {
+            out.expired = true;
+            out.reason = "expired at " + (f.f || "?") + ": ask CrawlCheck instead";
+            return out;
+        }
+        const host = String(opts.host || "").toLowerCase().replace(/^www\./, "").replace(/\.$/, "");
+        const d = String(f.d).toLowerCase();
+        if (!host) {
+            out.reason = "no host given: a staple is only valid for the host it was served by";
+            return out;
+        }
+        if (host !== d && !host.endsWith("." + d)) {
+            out.reason = "the staple names " + d + ", not " + host;
+            return out;
+        }
+        const thumb = bytesToB64u(new Uint8Array(await crypto.subtle.digest("SHA-256", te.encode(JSON.stringify({ crv: "Ed25519", kty: "OKP", x: f.x })))));
+        if (thumb !== f.k) {
+            out.reason = "key id does not match the public key";
+            return out;
+        }
+        if (!Array.isArray(opts.publishedKids) || opts.publishedKids.indexOf(f.k) < 0) {
+            out.reason = Array.isArray(opts.publishedKids) ? "key " + f.k + " is not one CrawlCheck publishes" : "no published key list given (opts.publishedKids)";
+            return out;
+        }
+        const pk = await crypto.subtle.importKey("jwk", { kty: "OKP", crv: "Ed25519", x: f.x }, { name: "Ed25519" }, false, ["verify"]);
+        const ok = await crypto.subtle.verify({ name: "Ed25519" }, pk, b64uToBytes(sig), te.encode(STAPLE_PREFIX + body));
+        if (!ok) {
+            out.reason = "signature does not verify";
+            return out;
+        }
+        out.valid = true;
+        out.reason = "valid until " + f.f;
+        return out;
+    }
+    catch (e) {
+        out.reason = "could not check: " + (e && e.message || e);
+        return out;
+    }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@crawlcheck/sdk",
-  "version": "1.0.6",
+  "version": "1.0.7",
   "description": "Typed client for the CrawlCheck API (generated from its OpenAPI document) and the zero-dependency offline verifier for evidence bundles and remediation receipts.",
   "type": "module",
   "main": "./dist/index.js",

package/test/fixtures/staple.json

@@ -0,0 +1,7 @@
+{
+ "kid": "pH8ZDz3tgRtZvHTZdqEmYHGpPI72pmDrjFpMSrNt3VA",
+ "valid": "v=ccr1;d=example.com;st=measured;read=allow;cite=warn;connect=require_confirmation;transact=block;o=2026-10-07T00:00:00.000Z;f=2099-01-01T00:00:00.000Z;l=aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa;k=pH8ZDz3tgRtZvHTZdqEmYHGpPI72pmDrjFpMSrNt3VA;x=ozx_4zIp-D-K_X4h1VRwWAMfOnzsBchF2lImNSJPMSY;s=7UNCtVpvzFOPfXFrWh1TzhjtWty_DE9CcKEQmFTRdY83b2fKPMNYLfn0aHV4-5ja8Pm0OfgkptK8wzoHSpa_Cw",
+ "expired": "v=ccr1;d=example.com;st=measured;read=allow;cite=warn;connect=require_confirmation;transact=block;o=2026-10-07T00:00:00.000Z;f=2020-01-01T00:00:00.000Z;l=aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa;k=pH8ZDz3tgRtZvHTZdqEmYHGpPI72pmDrjFpMSrNt3VA;x=ozx_4zIp-D-K_X4h1VRwWAMfOnzsBchF2lImNSJPMSY;s=cZTwNwGE2j88S1Q7em7FRQrCv66v0mATGMd1zXt55fcDX77MEmB1IJzCG88HkPtLQvy1cGv_zHg4D974Yx40DQ",
+ "foreign": "v=ccr1;d=other.example;st=measured;read=allow;cite=warn;connect=require_confirmation;transact=block;o=2026-10-07T00:00:00.000Z;f=2099-01-01T00:00:00.000Z;l=aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa;k=pH8ZDz3tgRtZvHTZdqEmYHGpPI72pmDrjFpMSrNt3VA;x=ozx_4zIp-D-K_X4h1VRwWAMfOnzsBchF2lImNSJPMSY;s=rUaiUZvO9JpJ4SJbTV_37-e5NbLhhcV0rQ7XrsQlSkjy8vzdETGIWNiohxq0BzmQ0U7vI8NeC3Gh48BBEFOSAw",
+ "tampered": "v=ccr1;d=example.com;st=measured;read=allow;cite=warn;connect=require_confirmation;transact=allow;o=2026-10-07T00:00:00.000Z;f=2099-01-01T00:00:00.000Z;l=aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa;k=pH8ZDz3tgRtZvHTZdqEmYHGpPI72pmDrjFpMSrNt3VA;x=ozx_4zIp-D-K_X4h1VRwWAMfOnzsBchF2lImNSJPMSY;s=7UNCtVpvzFOPfXFrWh1TzhjtWty_DE9CcKEQmFTRdY83b2fKPMNYLfn0aHV4-5ja8Pm0OfgkptK8wzoHSpa_Cw"
+}

package/test/staple.test.js

@@ -0,0 +1,14 @@
+import test from "node:test"; import assert from "node:assert/strict"; import fs from "node:fs";
+import { stapleCheck, stapleFromResponse, CrawlCheck } from "../dist/index.js";
+const F = JSON.parse(fs.readFileSync(new URL("./fixtures/staple.json", import.meta.url), "utf8"));
+const kids = [F.kid];
+test("valid staple verifies offline", async () => { const c = await stapleCheck(F.valid, { host: "example.com", publishedKids: kids }); assert.equal(c.valid, true); assert.equal(c.decisions.transact, "block"); });
+test("subdomain of the stapled domain is covered", async () => { assert.equal((await stapleCheck(F.valid, { host: "shop.example.com", publishedKids: kids })).valid, true); });
+test("expired staple is ignored", async () => { const c = await stapleCheck(F.expired, { host: "example.com", publishedKids: kids }); assert.equal(c.valid, false); assert.equal(c.expired, true); });
+test("staple for another domain is refused", async () => { assert.equal((await stapleCheck(F.foreign, { host: "example.com", publishedKids: kids })).valid, false); });
+test("tampered staple fails the signature", async () => { const c = await stapleCheck(F.tampered, { host: "example.com", publishedKids: kids }); assert.equal(c.valid, false); assert.match(c.reason, /signature/); });
+test("unpublished key is refused", async () => { assert.equal((await stapleCheck(F.valid, { host: "example.com", publishedKids: ["someone-else"] })).valid, false); });
+test("header is read from a response", () => { assert.equal(stapleFromResponse({ headers: new Headers({ "CrawlCheck-Staple": F.valid }) }), F.valid); assert.equal(stapleFromResponse({ "crawlcheck-staple": "x" }), "x"); });
+function mockClient(calls) { return new CrawlCheck({ fetch: async (u) => { calls.push(String(u)); if (String(u).includes("signatures-directory")) return new Response(JSON.stringify({ keys: [{ kid: F.kid }] })); return new Response(JSON.stringify({ kind: "crawlcheck-resolve", actions: { read: { decision: "warn" }, cite: { decision: "warn" }, connect: { decision: "unsupported" }, transact: { decision: "require_confirmation" } } })); } }); }
+test("resolveFor prefers a valid staple and makes no resolve request", async () => { const calls = []; const r = await mockClient(calls).resolveFor("example.com", { staple: F.valid }); assert.equal(r.source, "staple"); assert.equal(calls.some((u) => u.includes("/api/v1/resolve")), false); });
+test("resolveFor ignores an expired staple and asks CrawlCheck", async () => { const calls = []; const r = await mockClient(calls).resolveFor("example.com", { staple: F.expired }); assert.equal(r.source, "network"); assert.equal(r.decisions.read, "warn"); assert.equal(r.staple.expired, true); assert.equal(calls.some((u) => u.includes("/api/v1/resolve")), true); });