@t3b/hub-guard 0.6.0 → 0.7.0

package/README.md

@@ -216,21 +216,57 @@ export async function GET(req: Request) {
    - `at`: ISO 8601 in UTC at your database's full precision (Postgres: `to_char(at at time zone 'UTC',
      'YYYY-MM-DD"T"HH24:MI:SS.US"Z"')`), and compare `before.at` at that same precision - a coarser time skips lines.
    - `person`: the Hub person's id (the pass gave it to you); `actor` instead, for a line no person made
-     ("International Orders, on its own").
+     ("International Orders, on its own"). An app that records people by name reads the Hub's `person_name`
+     from the address to filter (`q.person` is the id).
    - `store`: the Hub's store key; a module serving one store answers nothing when asked for another.
    - The Hub drops a line out of shape (`cleanActivityLine`) and cuts long words: `what` 200, `detail` 400,
      `actor`/`place` 60 characters. It waits 5 seconds; an app that does not answer is named on the page.
 
+## Packing station: pack for the Hub's station (0.7.0, WORKFLOWS §17)
+
+The packer scans an invoice at the Packing app; the Hub has already checked that station's key, then asks every app
+that names a station door, with its own 60-second pass for `station`. Your app answers whether the order is its own and
+what to scan; on the last scan the Hub sends the scans and your app packs exactly as its own station does.
+
+1. **Name the door** in the manifest and in the health answer (`station: "/api/hub/station"`, and
+   `healthResponse(req, check, { ...cfg, station: "/api/hub/station" })`).
+2. **Answer it** - the Hub's pass first, then your own rules:
+
+```ts
+// GET  ?code=<digits from the invoice QR>  ->  { mine:false } | { mine:true, ok:true, order } | { mine:true, ok:false, reason, reason_ar }
+// POST { orderId, scans:[...] }             ->  { ok:true, name } | { ok:false, reason, reason_ar, missing, extra }
+import { verifyStationCall, stationRefusal, stationJson } from "@t3b/hub-guard";
+export async function POST(req: Request) {
+  const raw = new Uint8Array(await req.arrayBuffer());          // the pass covers these exact bytes
+  const v = await verifyStationCall(req, raw, cfg);              // GET: verifyStationCall(req, null, cfg)
+  if (!v.ok) return stationRefusal(v.reason);
+  const body = JSON.parse(new TextDecoder().decode(raw));
+  // ... check every scan again against the order as Shopify has it now, then fulfil; record it under v.station.name
+  return stationJson({ ok: true, name: "#KW1100" });
+}
+```
+
+   - `order.kind`: `"kuwait"` (local delivery - the screen shows the Kuwait flag) or `"international"` (the globe),
+     with `country` `{ code, ar, en }`.
+   - `items[]`: `title` (Arabic), `title_en`, `sku`, `qty`, `barcode`, `image` (Shopify's CDN only), `offer`
+     (`{ title, qty }` from `lineItemGroup` when the line came from a bundle).
+   - `mine:true, ok:false` puts the order aside: say why in the words the manager needs (`reason`, `reason_ar`).
+   - Answer 200 for every case once the pass is good; the Hub waits 5 seconds and treats anything else as no answer.
+
 ## What it enforces
 
 - `/hub/enter?ticket=…`: an EdDSA ticket signed by the Hub's published key, for this module, from this environment's Hub, 60 seconds, single use → sets the module session (HttpOnly, Secure, SameSite=Strict) and answers a short "Opening …" page that moves on to the page (0.4.0: a SameSite=Strict cookie set on a redirect ending a navigation from another site is not sent on it). `appName` names the app on that page; `landing(path)` maps the pass's page (e.g. `"/"` → `"/app"`), never off the module's own address.
 - Every other request: no session → 403 (HTML for browsers, JSON for APIs), on **every host** the module answers on. Idle 180 minutes (0.5.0), absolute 8 hours. Every 15 minutes the Hub is asked (with the app's Vercel ID) whether the person's session still stands. A Hub blip keeps the session until the next check.
 - Open paths (`/hub/enter`, `/api/hub/manifest`, `/api/hub/health`, `/api/hub/activity` and what you add) never need a session — they carry their own locks (the Hub's pass, a cron secret).
 - Cloudflare Access proof checked first when the team and audience are set.
-- `verifyRelay`, `manifestResponse`, `healthResponse`, `activityResponse`: the Hub's pass, for this module, for this purpose, from this environment's Hub; a relay also for these exact bytes and at most 5 minutes old; a call at most 60 seconds old.
+- `verifyRelay`, `manifestResponse`, `healthResponse`, `activityResponse`, `verifyStationCall`: the Hub's pass, for this module, for this purpose, from this environment's Hub; a relay and a station pack also for these exact bytes; a relay at most 5 minutes old; a call at most 60 seconds old.
 
 ## Changes
 
+- **0.7.0** (WORKFLOWS §17): the packing station - `verifyStationCall` checks the Hub's pass for `station` (naming the
+  station; on a pack, bound to the exact body), `stationRefusal`, `stationJson` and the answer types; `healthResponse(...,
+  { station })` names the door so the Hub reads the manifest again by itself. Nothing else changes; a module on 0.6.0 keeps
+  working.
 - **0.6.0** (WORKFLOWS §16): Activity - `activityResponse` answers the module's own change log to the Hub's pass for
   `activity` (`readActivityQuery`, `cleanActivityLine`, `ActivityLine`, `ActivityQuery`); `healthResponse(..., { activity })`
   names the door so the Hub reads the manifest again by itself. Nothing else changes; a module on 0.5.0 keeps working.

package/dist/hub-client.d.ts

@@ -92,7 +92,7 @@ export type Connection = {
     store?: string | null;
 };
 /** 8.4 / 7.6: the health answer's shape. `ok` is false when any connection is red; the Hub shows each connection as its own line. */
-export declare function healthAnswer(check: () => Promise<Connection[]> | Connection[], pages?: PageDef[], activity?: string): Promise<{
+export declare function healthAnswer(check: () => Promise<Connection[]> | Connection[], pages?: PageDef[], activity?: string, station?: string): Promise<{
     status: number;
     body: {
         ok: boolean;
@@ -101,12 +101,14 @@ export declare function healthAnswer(check: () => Promise<Connection[]> | Connec
         checked_at: string;
         pages?: string;
         activity?: string;
+        station?: string;
     };
 }>;
 /** 8b.4: the health answer, in full, only to the Hub; anyone else gets 401 and nothing. */
 export declare function healthResponse(req: Request, check: () => Promise<Connection[]> | Connection[], cfg: Omit<AnswerConfig, "token"> & {
     pages?: PageDef[];
     activity?: string;
+    station?: string;
 }): Promise<Response>;
 /** One change, worded by the app for the Hub's Activity page (English, like the Hub). */
 export type ActivityLine = {

package/dist/hub-client.js

@@ -124,7 +124,7 @@ export async function manifestResponse(req, manifest, cfg) {
     return jsonResponse(200, manifest, { [APP_ID_HEADER]: own });
 }
 /** 8.4 / 7.6: the health answer's shape. `ok` is false when any connection is red; the Hub shows each connection as its own line. */
-export async function healthAnswer(check, pages, activity) {
+export async function healthAnswer(check, pages, activity, station) {
     let connections;
     try {
         connections = await check();
@@ -144,6 +144,8 @@ export async function healthAnswer(check, pages, activity) {
             ...(pages ? { pages: await pagesFingerprint(pages) } : {}),
             // §16: the app's Activity door; when it differs from the one the Hub holds, the Hub reads the manifest again
             ...(activity ? { activity } : {}),
+            // §17: the app's packing-station door; when it differs from the one the Hub holds, the Hub reads the manifest again
+            ...(station ? { station } : {}),
         },
     };
 }
@@ -152,7 +154,7 @@ export async function healthResponse(req, check, cfg) {
     const v = await verifyHubCall(req, { moduleId: cfg.moduleId, keys: cfg.keys, use: "health", now: cfg.now, environment: cfg.environment });
     if (!v.ok)
         return jsonResponse(401, { error: "hub_only", reason: v.reason });
-    const a = await healthAnswer(check, cfg.pages, cfg.activity);
+    const a = await healthAnswer(check, cfg.pages, cfg.activity, cfg.station);
     return jsonResponse(a.status, a.body);
 }
 export const ACTIVITY_AT_RE = /^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{1,6})?Z$/;

package/dist/index.d.ts

@@ -5,6 +5,7 @@ export { readSession, signSession, cookieHeader, clearCookieHeader, cookieValue,
 export { sessionCheck, sessionCheckPages, tokenBroker, audit, alert, verifyHubCall, manifestResponse, healthResponse, healthAnswer, activityResponse, readActivityQuery, cleanActivityLine, ACTIVITY_AT_RE, ACTIVITY_ID_RE, ACTIVITY_MAX_LIMIT, type ActivityLine, type ActivityQuery, type HubClientConfig, type HubCallCheck, type AnswerConfig, type BrokerToken, type Connection, } from "./hub-client.js";
 export { checkCloudflareAccess } from "./cf-access.js";
 export { verifyRelay, RELAY_HEADERS, RELAY_MAX_AGE_S, type RelayCheck } from "./relay.js";
+export { verifyStationCall, stationRefusal, stationJson, STATION_ID_RE, STATION_NAME_MAX, type StationCheck, type StationAnswer, type StationOrder, type StationItem, type PackAnswer, } from "./station.js";
 export { ownVercelToken, ownEnvironment, hubKeys, APP_ID_HEADER, OIDC_HEADER, type TokenProvider } from "./identity.js";
 /**
  * Reads the guard's settings from a module's environment. Nothing secret: the Hub's address

package/dist/index.js

@@ -5,6 +5,7 @@ export { readSession, signSession, cookieHeader, clearCookieHeader, cookieValue,
 export { sessionCheck, sessionCheckPages, tokenBroker, audit, alert, verifyHubCall, manifestResponse, healthResponse, healthAnswer, activityResponse, readActivityQuery, cleanActivityLine, ACTIVITY_AT_RE, ACTIVITY_ID_RE, ACTIVITY_MAX_LIMIT, } from "./hub-client.js";
 export { checkCloudflareAccess } from "./cf-access.js";
 export { verifyRelay, RELAY_HEADERS, RELAY_MAX_AGE_S } from "./relay.js";
+export { verifyStationCall, stationRefusal, stationJson, STATION_ID_RE, STATION_NAME_MAX, } from "./station.js";
 export { ownVercelToken, ownEnvironment, hubKeys, APP_ID_HEADER, OIDC_HEADER } from "./identity.js";
 /**
  * Reads the guard's settings from a module's environment. Nothing secret: the Hub's address

package/dist/station.d.ts

@@ -0,0 +1,82 @@
+import { type JWTVerifyGetKey } from "jose";
+export declare const STATION_ID_RE: RegExp;
+export declare const STATION_NAME_MAX = 60;
+export type StationCheck = {
+    ok: true;
+    station: {
+        id: string;
+        name: string;
+    };
+} | {
+    ok: false;
+    reason: "missing" | "bad_signature" | "expired" | "wrong_module" | "wrong_use" | "wrong_environment" | "body_changed";
+};
+/**
+ * Is this the Hub asking for a packing station? `body` is the request's raw bytes for a POST (read it with
+ * `await req.arrayBuffer()` before parsing - the pass covers the exact bytes) and null for a GET.
+ */
+export declare function verifyStationCall(req: Request, body: Uint8Array | string | null, opts: {
+    moduleId: string;
+    keys: JWTVerifyGetKey;
+    now?: Date;
+    environment?: string;
+}): Promise<StationCheck>;
+/** The refusal every Hub door answers with: 401 and only the reason word (the Hub turns it into the owner's words). */
+export declare function stationRefusal(reason: Extract<StationCheck, {
+    ok: false;
+}>["reason"]): Response;
+/** One line of an order to scan, as an app answers it (the Hub checks the shape again - an app's words are data). */
+export type StationItem = {
+    title: string;
+    title_en?: string | null;
+    sku?: string | null;
+    qty: number;
+    barcode: string;
+    image?: string | null;
+    offer?: {
+        title: string;
+        qty: number;
+    } | null;
+};
+/** An order the app owns and can be packed now. `kind` decides the flag (kuwait) or the globe (international). */
+export type StationOrder = {
+    id: string;
+    name: string;
+    kind: "kuwait" | "international";
+    country: {
+        code: string;
+        ar: string;
+        en: string;
+    };
+    items: StationItem[];
+};
+/** The three answers to the Hub's GET (always 200 once the pass is good). */
+export type StationAnswer = {
+    mine: false;
+} | {
+    mine: true;
+    ok: true;
+    order: StationOrder;
+} | {
+    mine: true;
+    ok: false;
+    name?: string | null;
+    reason: string;
+    reason_ar?: string | null;
+};
+/** The two answers to the Hub's POST (200 once the pass is good). */
+export type PackAnswer = {
+    ok: true;
+    name: string;
+} | {
+    ok: false;
+    reason: string;
+    reason_ar?: string | null;
+    missing?: {
+        sku: string | null;
+        title: string;
+        need: number;
+    }[];
+    extra?: string[];
+};
+export declare function stationJson(body: StationAnswer | PackAnswer): Response;

package/dist/station.js

@@ -0,0 +1,55 @@
+import { jwtVerify } from "jose";
+import { HUB_ISSUER, TYP } from "./identity.js";
+import { b64urlEncode, constantTimeEqual, sha256 } from "./webcrypto.js";
+// WORKFLOWS §17 (SPEC C-25, D-065): the packing station. A scan reaches an app only through the Hub:
+// the Hub has checked the station's key, then asks each app with a station door, with its own
+// 60-second pass for "station" naming the station. On the pack (POST) the pass also carries the
+// SHA-256 of the exact body, so a pass cannot be lifted onto another order or other scans.
+export const STATION_ID_RE = /^[A-Za-z0-9_-]{1,64}$/;
+export const STATION_NAME_MAX = 60;
+/**
+ * Is this the Hub asking for a packing station? `body` is the request's raw bytes for a POST (read it with
+ * `await req.arrayBuffer()` before parsing - the pass covers the exact bytes) and null for a GET.
+ */
+export async function verifyStationCall(req, body, opts) {
+    const auth = req.headers.get("authorization") ?? "";
+    const token = auth.startsWith("Bearer ") ? auth.slice(7).trim() : "";
+    if (!token || token.length > 4096)
+        return { ok: false, reason: "missing" };
+    let p;
+    try {
+        ({ payload: p } = await jwtVerify(token, opts.keys, { issuer: HUB_ISSUER, audience: opts.moduleId, algorithms: ["EdDSA"], typ: TYP.call, currentDate: opts.now, clockTolerance: 5, maxTokenAge: 65 }));
+    }
+    catch (e) {
+        const code = e.code ?? "";
+        if (code === "ERR_JWT_EXPIRED")
+            return { ok: false, reason: "expired" };
+        if (code === "ERR_JWT_CLAIM_VALIDATION_FAILED" && /"aud"/.test(e.message))
+            return { ok: false, reason: "wrong_module" };
+        if (code === "ERR_JWT_CLAIM_VALIDATION_FAILED")
+            return { ok: false, reason: "expired" };
+        return { ok: false, reason: "bad_signature" };
+    }
+    if (p.use !== "station")
+        return { ok: false, reason: "wrong_use" };
+    if (opts.environment && p.env !== opts.environment)
+        return { ok: false, reason: "wrong_environment" };
+    const id = typeof p.station_id === "string" ? p.station_id : "";
+    const name = typeof p.station_name === "string" ? p.station_name.trim() : "";
+    if (!STATION_ID_RE.test(id) || !name || name.length > STATION_NAME_MAX)
+        return { ok: false, reason: "bad_signature" };
+    if (body !== null) {
+        const want = typeof p.body_sha256 === "string" ? p.body_sha256 : "";
+        const bytes = typeof body === "string" ? new TextEncoder().encode(body) : body;
+        if (!want || !constantTimeEqual(b64urlEncode(await sha256(bytes)), want))
+            return { ok: false, reason: "body_changed" };
+    }
+    return { ok: true, station: { id, name } };
+}
+/** The refusal every Hub door answers with: 401 and only the reason word (the Hub turns it into the owner's words). */
+export function stationRefusal(reason) {
+    return new Response(JSON.stringify({ error: "hub_only", reason }), { status: 401, headers: { "Content-Type": "application/json", "Cache-Control": "no-store" } });
+}
+export function stationJson(body) {
+    return new Response(JSON.stringify(body), { status: 200, headers: { "Content-Type": "application/json", "Cache-Control": "no-store" } });
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@t3b/hub-guard",
-  "version": "0.6.0",
+  "version": "0.7.0",
   "description": "The3Beez Hub guard: a module opens only by a Hub-signed ticket and refuses everything else. No key from the Hub: towards the Hub the app shows its own Vercel ID; from the Hub it accepts only what is signed by the key the Hub publishes. Entry route, refusal page, module session, idle rule, 15-minute re-check, Cloudflare Access proof, broker and audit clients, manifest and health answers for the Hub only. Web Crypto only: runs in Node 20+ and in edge runtimes.",
   "license": "UNLICENSED",
   "type": "module",