@openvtc/trust-tasks 0.27.3 → 0.27.5

package/src/auth/oob/prove/0.3/payload.ts

@@ -0,0 +1,523 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/auth/oob/prove/0.3/payload.schema.json
+ */
+
+import type { Ext, OobKey, Origin, Purpose, Requester, RequestId, SameNetwork, Service, SigningScope, TaskFamily } from "../../../../_shared/components.js";
+
+
+/**
+ * The lock holder proves membership and the number on the starter's screen by carrying a signed auth/oob/identify document, and gets back the service-signed step 2. Issued and signed by the lock key `K_a`. The outer document members (id, type, issuer, recipient, issuedAt, expiresAt, parentThreadId, proof) are owned by the framework — SPEC §6.3.
+ */
+export interface AuthOOBProvePayload {
+  /**
+   * A complete, signed auth/oob/identify/0.1 Trust Task document, issued by the approving DID and signed by its VTA for `authentication`. The service verifies it as a document in its own right — envelope, proof and payload against that specification's schema — over the members exactly as received: its proof covers every member, so it is deliberately an open object here rather than a typed one a binding could narrow.
+   */
+  identify: {};
+  ext?: Ext;
+}
+/**
+ * Step 2 of the disclosure ladder, signed by the service's assertionMethod key: the step 1 members unchanged, plus the starter's key, where the request came from, which DID was identified and, optionally, the task families the starter key would sign for. The SHA-256 of its JCS canonical form, proof included, is the grant's `contextDigest`.
+ */
+export interface AuthOOBProveResponsePayloadStep2 {
+  requestId: RequestId;
+  service: Service;
+  origin: Origin;
+  purpose: Purpose;
+  /**
+   * Unchanged from step 1 (auth/oob/claim/0.2): when the decision window closes, as an RFC 3339 date-time.
+   */
+  decisionClosesAt: string;
+  /**
+   * The starter key `K_b`: the key a grant would let act as the identified DID.
+   */
+  sessionKey: OobKey;
+  requester: Requester;
+  /**
+   * The DID that issued the verified identify document. A grant must come from this DID.
+   */
+  identifiedAs: string;
+  /**
+   * The task families the service offers to let the starter key sign for, as `identifiedAs`, for the session a grant would arm (auth/oob/grant/0.3). Fixed by the service for the surface at `origin`. Absent: the grant delegates no signing.
+   */
+  signingScope?: SigningScope;
+  ext?: Ext;
+}
+
+/** Shared definitions this specification references, re-exported under the names it used to declare them with. */
+export type { Ext, OobKey, Origin, Purpose, Requester, RequestId, SameNetwork, Service, SigningScope, TaskFamily };
+
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/auth/oob/prove/0.3" as const;
+
+/** Stable alias for this specification's request payload shape. */
+export type Payload = AuthOOBProvePayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/auth/oob/prove/0.3#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = AuthOOBProveResponsePayloadStep2;
+
+/**
+ * This specification's payload schema, as a value.
+ *
+ * SPEC.md §7.2 item 2 is performed against this. It is shipped as data
+ * rather than only as a `.json` file because TypeScript types are erased
+ * at runtime: without a schema a consumer has nothing to validate, and
+ * every REQUIRED payload member is optional in practice. Cross-file
+ * `$ref`s are already inlined, so it needs no resolver.
+ */
+export const PAYLOAD_SCHEMA = {
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://trusttasks.org/spec/auth/oob/prove/0.3",
+  "title": "Auth — OOB Prove — payload",
+  "description": "The lock holder proves membership and the number on the starter's screen by carrying a signed auth/oob/identify document, and gets back the service-signed step 2. Issued and signed by the lock key `K_a`. The outer document members (id, type, issuer, recipient, issuedAt, expiresAt, parentThreadId, proof) are owned by the framework — SPEC §6.3.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "identify"
+  ],
+  "properties": {
+    "identify": {
+      "type": "object",
+      "description": "A complete, signed auth/oob/identify/0.1 Trust Task document, issued by the approving DID and signed by its VTA for `authentication`. The service verifies it as a document in its own right — envelope, proof and payload against that specification's schema — over the members exactly as received: its proof covers every member, so it is deliberately an open object here rather than a typed one a binding could narrow."
+    },
+    "ext": {
+      "$ref": "#/$defs/Ext"
+    }
+  },
+  "$defs": {
+    "Response": {
+      "$anchor": "response",
+      "title": "Auth — OOB Prove — response payload (step 2)",
+      "description": "Step 2 of the disclosure ladder, signed by the service's assertionMethod key: the step 1 members unchanged, plus the starter's key, where the request came from, which DID was identified and, optionally, the task families the starter key would sign for. The SHA-256 of its JCS canonical form, proof included, is the grant's `contextDigest`.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "requestId",
+        "service",
+        "origin",
+        "purpose",
+        "decisionClosesAt",
+        "sessionKey",
+        "requester",
+        "identifiedAs"
+      ],
+      "properties": {
+        "requestId": {
+          "$ref": "#/$defs/RequestId"
+        },
+        "service": {
+          "$ref": "#/$defs/Service"
+        },
+        "origin": {
+          "$ref": "#/$defs/Origin"
+        },
+        "purpose": {
+          "$ref": "#/$defs/Purpose"
+        },
+        "decisionClosesAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "Unchanged from step 1 (auth/oob/claim/0.2): when the decision window closes, as an RFC 3339 date-time."
+        },
+        "sessionKey": {
+          "$ref": "#/$defs/OobKey",
+          "description": "The starter key `K_b`: the key a grant would let act as the identified DID."
+        },
+        "requester": {
+          "$ref": "#/$defs/Requester"
+        },
+        "identifiedAs": {
+          "type": "string",
+          "pattern": "^did:",
+          "minLength": 5,
+          "maxLength": 2048,
+          "description": "The DID that issued the verified identify document. A grant must come from this DID."
+        },
+        "signingScope": {
+          "$ref": "#/$defs/SigningScope",
+          "description": "The task families the service offers to let the starter key sign for, as `identifiedAs`, for the session a grant would arm (auth/oob/grant/0.3). Fixed by the service for the surface at `origin`. Absent: the grant delegates no signing."
+        },
+        "ext": {
+          "$ref": "#/$defs/Ext"
+        }
+      }
+    },
+    "Ext": {
+      "title": "Ext",
+      "description": "Vendor-namespaced extension object per SPEC.md §4.5.1. Each immediate key MUST be a reverse-DNS namespace; structure under each namespace is opaque to the framework.",
+      "type": "object",
+      "minProperties": 1,
+      "additionalProperties": true,
+      "propertyNames": {
+        "pattern": "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$"
+      }
+    },
+    "SigningScope": {
+      "title": "SigningScope",
+      "type": "array",
+      "minItems": 1,
+      "maxItems": 8,
+      "uniqueItems": true,
+      "items": {
+        "$ref": "#/$defs/TaskFamily"
+      },
+      "description": "The task families a `login` grant lets the starter key sign documents for, as the approving DID, for the session the grant arms (auth/oob/grant/0.2). Offered by the service in step 2, copied unchanged into the grant, and bounded further by the exclusions auth/oob/grant/0.2 states. Absent means the starter key signs nothing beyond the family's own tasks."
+    },
+    "TaskFamily": {
+      "title": "TaskFamily",
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 128,
+      "pattern": "^[a-z][a-z0-9]*(-[a-z0-9]+)*(/[a-z][a-z0-9]*(-[a-z0-9]+)*)*$",
+      "description": "A family of Trust Tasks, named by a slug prefix of whole segments (SPEC §6.1 grammar): `vtc/directory` names every task whose slug is `vtc/directory` or begins `vtc/directory/`, at any version. A prefix matches on segment boundaries only, so `vtc/dir` names nothing under `vtc/directory`."
+    },
+    "Requester": {
+      "title": "Requester",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "location",
+        "browser",
+        "os",
+        "createdAt",
+        "sameNetwork"
+      ],
+      "properties": {
+        "location": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 128,
+          "description": "City and country of the starter's connection, from a local lookup with no third-party call, or the literal `unknown`. Never an IP address."
+        },
+        "browser": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 64,
+          "description": "Browser family of the starter (e.g. `Chrome`), never the full User-Agent; `unknown` when it cannot be told."
+        },
+        "os": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 64,
+          "description": "Operating system family of the starter (e.g. `macOS`); `unknown` when it cannot be told."
+        },
+        "createdAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "When the service accepted the starter's auth/oob/request."
+        },
+        "sameNetwork": {
+          "$ref": "#/$defs/SameNetwork"
+        }
+      },
+      "description": "What the service reports about where the request came from. Revealed only in the step 2 response, to the lock holder, after a membership and number proof. Reported by the service, signed by it, and a heuristic: a relaying attacker controls what is observed."
+    },
+    "SameNetwork": {
+      "title": "SameNetwork",
+      "oneOf": [
+        {
+          "type": "boolean"
+        },
+        {
+          "type": "string",
+          "const": "unknown"
+        }
+      ],
+      "description": "Whether the starter's request and the approver's prove came from the same egress network, as the service saw them: `true`, `false`, or the string `unknown` when the service cannot tell. The service compares addresses; it never discloses them."
+    },
+    "OobKey": {
+      "title": "OobKey",
+      "type": "string",
+      "minLength": 48,
+      "maxLength": 64,
+      "pattern": "^did:key:z6Mk[1-9A-HJ-NP-Za-km-z]+$",
+      "description": "A starter key (`K_b`) or an approver lock key (`K_a`), as an Ed25519 `did:key` (`z6Mk…`) generated for this one request and used nowhere else. Ed25519 only: a service refuses any other key type with `auth/oob:keyUnsupported` before parsing beyond the multicodec prefix."
+    },
+    "Purpose": {
+      "title": "Purpose",
+      "type": "string",
+      "enum": [
+        "login"
+      ],
+      "description": "What the request is for. A CLOSED list: each purpose has a fixed row in CONVENTIONS.md §3 stating what is revealed at each step, what the grant contains, what redeem returns and the window lengths. Version 0.1 defines `login` only. `stepUp` and `deviceEnrol` are reserved names; adding one is a new version of this component and of every task that references it, never an in-place edit."
+    },
+    "Origin": {
+      "title": "Origin",
+      "type": "string",
+      "minLength": 9,
+      "maxLength": 2048,
+      "pattern": "^https://[^/?#\\s]+$",
+      "description": "A web origin (`https://host[:port]`, no path, no trailing slash) — for `login`, the origin of the portal where the starter runs, which is the origin of the `serviceEndpoint` of the service's `SignInPortal` service in its DID document."
+    },
+    "Service": {
+      "title": "Service",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "did",
+        "name"
+      ],
+      "properties": {
+        "did": {
+          "type": "string",
+          "pattern": "^did:",
+          "minLength": 5,
+          "maxLength": 2048,
+          "description": "The service's DID: the `recipient` of every request in the family, and the `_from` of the trigger link."
+        },
+        "name": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 128,
+          "description": "The name the service calls itself. Supplied by the service: an approver shows the name from its OWN records and flags a difference from this one (VTI-LNK-104); it never shows this value as the community's name on its own authority."
+        }
+      },
+      "description": "Who the service says it is."
+    },
+    "RequestId": {
+      "title": "RequestId",
+      "type": "string",
+      "minLength": 22,
+      "maxLength": 43,
+      "pattern": "^[A-Za-z0-9_-]{22,43}$",
+      "description": "The service-generated handle of one request: 16 to 32 bytes from a cryptographically secure random source, written as unpadded base64url (22 to 43 characters; 16 bytes, 22 characters, is RECOMMENDED). It is also the nonce of the exchange, so the family needs no separate challenge, and it is the `_id` of the trigger link (VTI-LNK-033). Compared as a string. It confers no authority on its holder."
+    }
+  }
+} as const;
+
+/** As {@link PAYLOAD_SCHEMA}, for the success-response variant. */
+export const RESPONSE_PAYLOAD_SCHEMA = {
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$ref": "#/$defs/Response",
+  "$defs": {
+    "Response": {
+      "$anchor": "response",
+      "title": "Auth — OOB Prove — response payload (step 2)",
+      "description": "Step 2 of the disclosure ladder, signed by the service's assertionMethod key: the step 1 members unchanged, plus the starter's key, where the request came from, which DID was identified and, optionally, the task families the starter key would sign for. The SHA-256 of its JCS canonical form, proof included, is the grant's `contextDigest`.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "requestId",
+        "service",
+        "origin",
+        "purpose",
+        "decisionClosesAt",
+        "sessionKey",
+        "requester",
+        "identifiedAs"
+      ],
+      "properties": {
+        "requestId": {
+          "$ref": "#/$defs/RequestId"
+        },
+        "service": {
+          "$ref": "#/$defs/Service"
+        },
+        "origin": {
+          "$ref": "#/$defs/Origin"
+        },
+        "purpose": {
+          "$ref": "#/$defs/Purpose"
+        },
+        "decisionClosesAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "Unchanged from step 1 (auth/oob/claim/0.2): when the decision window closes, as an RFC 3339 date-time."
+        },
+        "sessionKey": {
+          "$ref": "#/$defs/OobKey",
+          "description": "The starter key `K_b`: the key a grant would let act as the identified DID."
+        },
+        "requester": {
+          "$ref": "#/$defs/Requester"
+        },
+        "identifiedAs": {
+          "type": "string",
+          "pattern": "^did:",
+          "minLength": 5,
+          "maxLength": 2048,
+          "description": "The DID that issued the verified identify document. A grant must come from this DID."
+        },
+        "signingScope": {
+          "$ref": "#/$defs/SigningScope",
+          "description": "The task families the service offers to let the starter key sign for, as `identifiedAs`, for the session a grant would arm (auth/oob/grant/0.3). Fixed by the service for the surface at `origin`. Absent: the grant delegates no signing."
+        },
+        "ext": {
+          "$ref": "#/$defs/Ext"
+        }
+      }
+    },
+    "Ext": {
+      "title": "Ext",
+      "description": "Vendor-namespaced extension object per SPEC.md §4.5.1. Each immediate key MUST be a reverse-DNS namespace; structure under each namespace is opaque to the framework.",
+      "type": "object",
+      "minProperties": 1,
+      "additionalProperties": true,
+      "propertyNames": {
+        "pattern": "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$"
+      }
+    },
+    "SigningScope": {
+      "title": "SigningScope",
+      "type": "array",
+      "minItems": 1,
+      "maxItems": 8,
+      "uniqueItems": true,
+      "items": {
+        "$ref": "#/$defs/TaskFamily"
+      },
+      "description": "The task families a `login` grant lets the starter key sign documents for, as the approving DID, for the session the grant arms (auth/oob/grant/0.2). Offered by the service in step 2, copied unchanged into the grant, and bounded further by the exclusions auth/oob/grant/0.2 states. Absent means the starter key signs nothing beyond the family's own tasks."
+    },
+    "TaskFamily": {
+      "title": "TaskFamily",
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 128,
+      "pattern": "^[a-z][a-z0-9]*(-[a-z0-9]+)*(/[a-z][a-z0-9]*(-[a-z0-9]+)*)*$",
+      "description": "A family of Trust Tasks, named by a slug prefix of whole segments (SPEC §6.1 grammar): `vtc/directory` names every task whose slug is `vtc/directory` or begins `vtc/directory/`, at any version. A prefix matches on segment boundaries only, so `vtc/dir` names nothing under `vtc/directory`."
+    },
+    "Requester": {
+      "title": "Requester",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "location",
+        "browser",
+        "os",
+        "createdAt",
+        "sameNetwork"
+      ],
+      "properties": {
+        "location": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 128,
+          "description": "City and country of the starter's connection, from a local lookup with no third-party call, or the literal `unknown`. Never an IP address."
+        },
+        "browser": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 64,
+          "description": "Browser family of the starter (e.g. `Chrome`), never the full User-Agent; `unknown` when it cannot be told."
+        },
+        "os": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 64,
+          "description": "Operating system family of the starter (e.g. `macOS`); `unknown` when it cannot be told."
+        },
+        "createdAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "When the service accepted the starter's auth/oob/request."
+        },
+        "sameNetwork": {
+          "$ref": "#/$defs/SameNetwork"
+        }
+      },
+      "description": "What the service reports about where the request came from. Revealed only in the step 2 response, to the lock holder, after a membership and number proof. Reported by the service, signed by it, and a heuristic: a relaying attacker controls what is observed."
+    },
+    "SameNetwork": {
+      "title": "SameNetwork",
+      "oneOf": [
+        {
+          "type": "boolean"
+        },
+        {
+          "type": "string",
+          "const": "unknown"
+        }
+      ],
+      "description": "Whether the starter's request and the approver's prove came from the same egress network, as the service saw them: `true`, `false`, or the string `unknown` when the service cannot tell. The service compares addresses; it never discloses them."
+    },
+    "OobKey": {
+      "title": "OobKey",
+      "type": "string",
+      "minLength": 48,
+      "maxLength": 64,
+      "pattern": "^did:key:z6Mk[1-9A-HJ-NP-Za-km-z]+$",
+      "description": "A starter key (`K_b`) or an approver lock key (`K_a`), as an Ed25519 `did:key` (`z6Mk…`) generated for this one request and used nowhere else. Ed25519 only: a service refuses any other key type with `auth/oob:keyUnsupported` before parsing beyond the multicodec prefix."
+    },
+    "Purpose": {
+      "title": "Purpose",
+      "type": "string",
+      "enum": [
+        "login"
+      ],
+      "description": "What the request is for. A CLOSED list: each purpose has a fixed row in CONVENTIONS.md §3 stating what is revealed at each step, what the grant contains, what redeem returns and the window lengths. Version 0.1 defines `login` only. `stepUp` and `deviceEnrol` are reserved names; adding one is a new version of this component and of every task that references it, never an in-place edit."
+    },
+    "Origin": {
+      "title": "Origin",
+      "type": "string",
+      "minLength": 9,
+      "maxLength": 2048,
+      "pattern": "^https://[^/?#\\s]+$",
+      "description": "A web origin (`https://host[:port]`, no path, no trailing slash) — for `login`, the origin of the portal where the starter runs, which is the origin of the `serviceEndpoint` of the service's `SignInPortal` service in its DID document."
+    },
+    "Service": {
+      "title": "Service",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "did",
+        "name"
+      ],
+      "properties": {
+        "did": {
+          "type": "string",
+          "pattern": "^did:",
+          "minLength": 5,
+          "maxLength": 2048,
+          "description": "The service's DID: the `recipient` of every request in the family, and the `_from` of the trigger link."
+        },
+        "name": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 128,
+          "description": "The name the service calls itself. Supplied by the service: an approver shows the name from its OWN records and flags a difference from this one (VTI-LNK-104); it never shows this value as the community's name on its own authority."
+        }
+      },
+      "description": "Who the service says it is."
+    },
+    "RequestId": {
+      "title": "RequestId",
+      "type": "string",
+      "minLength": 22,
+      "maxLength": 43,
+      "pattern": "^[A-Za-z0-9_-]{22,43}$",
+      "description": "The service-generated handle of one request: 16 to 32 bytes from a cryptographically secure random source, written as unpadded base64url (22 to 43 characters; 16 bytes, 22 characters, is RECOMMENDED). It is also the nonce of the exchange, so the family needs no separate challenge, and it is the `_id` of the trigger link (VTI-LNK-033). Compared as a string. It confers no authority on its holder."
+    }
+  }
+} as const;
+
+/**
+ * SPEC.md §7.2 policy for the request variant, from this specification's
+ * front matter. Pass to `consumeInbound` — items 5b, 7 and 8 are
+ * per-specification and cannot be derived from the document alone, and
+ * item 2 needs the schema this carries.
+ */
+export const SPEC = {
+  typeUri: TYPE_URI,
+  isBearer: false,
+  isProofRequired: true,
+  isRecipientRequired: true,
+  isIssuedAtRequired: true,
+  payloadSchema: PAYLOAD_SCHEMA,
+} as const;
+
+/**
+ * SPEC.md §7.2 policy for the success-response variant. `isRecipientRequired`
+ * tracks the *issuer* party's requirement because a response swaps the
+ * parties (§7.3 item 5).
+ */
+export const RESPONSE_SPEC = {
+  typeUri: RESPONSE_TYPE_URI,
+  isBearer: false,
+  isProofRequired: true,
+  isRecipientRequired: true,
+  isIssuedAtRequired: true,
+  payloadSchema: RESPONSE_PAYLOAD_SCHEMA,
+} as const;