@openvtc/trust-tasks 0.20.7 → 0.21.0

package/src/auth/passkey/enroll/invite/0.2/payload.ts

@@ -0,0 +1,325 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/auth/passkey/enroll/invite/0.2/payload.schema.json
+ */
+
+import type { Ext } from "../../../../../_shared/components.js";
+
+
+/**
+ * An administrator issues a single-use invite, redeemed with a separately delivered claim code, that binds a passkey to a subject who cannot yet authorise the binding themselves: their first passkey, or — for `purpose: stepUp` — a step-up-only passkey that never opens a session.
+ */
+export interface AuthPasskeyEnrollInvite {
+  /**
+   * The VID the invitee will enroll. The admin asserts this binding; the redemption ceremony verifies the invitee controls a passkey and holds the claim code, but does NOT independently verify the subject — trust flows from the admin. For `purpose: stepUp` the consumer MUST already recognise the subject (a member, say).
+   */
+  subject: string;
+  /**
+   * What the redeemed credential may authenticate. `session` (the default, and 0.1's only behaviour): it signs the subject in, with the role and scopes the invite carries. `stepUp`: it is accepted only as the user-verification evidence of a step-up bound to one operation (auth/step-up/approve-response `evidence.kind: webauthn`), never to open or elevate a session; `role` and `scopes` MUST then be absent.
+   */
+  purpose?: "session" | "stepUp";
+  /**
+   * Role the invitee receives on successful enrollment. Consumer-defined vocabulary; if absent the consumer applies its default role.
+   */
+  role?: string;
+  /**
+   * Optional scopes to attach on enrollment.
+   */
+  scopes?: string[];
+  /**
+   * Suggested label for the credential. Used as a default; the invitee MAY override during redemption.
+   */
+  deviceLabel?: string;
+  /**
+   * Seconds the invite remains valid. Consumers SHOULD pick 15 min – 24 h, and MAY cap it lower; longer windows widen the attack surface.
+   */
+  ttl?: number;
+  ext?: Ext;
+}
+/**
+ * The issued invite. Carried in a Trust Task document whose type is https://trusttasks.org/spec/auth/passkey/enroll/invite/0.2#response.
+ */
+export interface AuthPasskeyEnrollInviteResponsePayload {
+  invite: {
+    /**
+     * Opaque single-use invite token. The invitee presents it to the consumer during enrollment. ≥128 bits entropy.
+     */
+    token: string;
+    /**
+     * Operator-shareable URL that, when opened in a WebAuthn-capable browser, drives the redemption ceremony (auth/passkey/enroll/redeem/start). Carries the token. MUST NOT carry the claim code.
+     */
+    url: string;
+  };
+  /**
+   * Echo of the invitee's VID.
+   */
+  subject: string;
+  /**
+   * Echo of the purpose the redeemed credential will have.
+   */
+  purpose: "session" | "stepUp";
+  expiresAt: string;
+  ext?: Ext;
+  /**
+   * A short code the invitee types at redemption, returned exactly once. The administrator delivers it over a different channel from `url`, so that intercepting one channel is not enough to redeem. The consumer stores only a slow hash of it.
+   */
+  claimCode: string;
+}
+
+/** Shared definitions this specification references, re-exported under the names it used to declare them with. */
+export type { Ext };
+
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/auth/passkey/enroll/invite/0.2" as const;
+
+/** Stable alias for this specification's request payload shape. */
+export type Payload = AuthPasskeyEnrollInvite;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/auth/passkey/enroll/invite/0.2#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = AuthPasskeyEnrollInviteResponsePayload;
+
+/**
+ * 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/passkey/enroll/invite/0.2",
+  "title": "Auth — Passkey Enroll (invite)",
+  "description": "An administrator issues a single-use invite, redeemed with a separately delivered claim code, that binds a passkey to a subject who cannot yet authorise the binding themselves: their first passkey, or — for `purpose: stepUp` — a step-up-only passkey that never opens a session.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "subject"
+  ],
+  "properties": {
+    "subject": {
+      "type": "string",
+      "minLength": 1,
+      "description": "The VID the invitee will enroll. The admin asserts this binding; the redemption ceremony verifies the invitee controls a passkey and holds the claim code, but does NOT independently verify the subject — trust flows from the admin. For `purpose: stepUp` the consumer MUST already recognise the subject (a member, say)."
+    },
+    "purpose": {
+      "type": "string",
+      "enum": [
+        "session",
+        "stepUp"
+      ],
+      "default": "session",
+      "description": "What the redeemed credential may authenticate. `session` (the default, and 0.1's only behaviour): it signs the subject in, with the role and scopes the invite carries. `stepUp`: it is accepted only as the user-verification evidence of a step-up bound to one operation (auth/step-up/approve-response `evidence.kind: webauthn`), never to open or elevate a session; `role` and `scopes` MUST then be absent."
+    },
+    "role": {
+      "type": "string",
+      "description": "Role the invitee receives on successful enrollment. Consumer-defined vocabulary; if absent the consumer applies its default role."
+    },
+    "scopes": {
+      "type": "array",
+      "items": {
+        "type": "string",
+        "minLength": 1
+      },
+      "description": "Optional scopes to attach on enrollment."
+    },
+    "deviceLabel": {
+      "type": "string",
+      "maxLength": 256,
+      "description": "Suggested label for the credential. Used as a default; the invitee MAY override during redemption."
+    },
+    "ttl": {
+      "type": "integer",
+      "minimum": 1,
+      "description": "Seconds the invite remains valid. Consumers SHOULD pick 15 min – 24 h, and MAY cap it lower; longer windows widen the attack surface."
+    },
+    "ext": {
+      "$ref": "#/$defs/Ext"
+    }
+  },
+  "$defs": {
+    "Response": {
+      "$anchor": "response",
+      "title": "Auth Passkey Enroll Invite — response payload",
+      "description": "The issued invite. Carried in a Trust Task document whose type is https://trusttasks.org/spec/auth/passkey/enroll/invite/0.2#response.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "invite",
+        "subject",
+        "purpose",
+        "expiresAt",
+        "claimCode"
+      ],
+      "properties": {
+        "invite": {
+          "type": "object",
+          "additionalProperties": false,
+          "required": [
+            "token",
+            "url"
+          ],
+          "properties": {
+            "token": {
+              "type": "string",
+              "minLength": 16,
+              "description": "Opaque single-use invite token. The invitee presents it to the consumer during enrollment. ≥128 bits entropy."
+            },
+            "url": {
+              "type": "string",
+              "format": "uri",
+              "description": "Operator-shareable URL that, when opened in a WebAuthn-capable browser, drives the redemption ceremony (auth/passkey/enroll/redeem/start). Carries the token. MUST NOT carry the claim code."
+            }
+          }
+        },
+        "subject": {
+          "type": "string",
+          "description": "Echo of the invitee's VID."
+        },
+        "purpose": {
+          "type": "string",
+          "enum": [
+            "session",
+            "stepUp"
+          ],
+          "description": "Echo of the purpose the redeemed credential will have."
+        },
+        "expiresAt": {
+          "type": "string",
+          "format": "date-time"
+        },
+        "ext": {
+          "$ref": "#/$defs/Ext"
+        },
+        "claimCode": {
+          "type": "string",
+          "minLength": 8,
+          "maxLength": 64,
+          "description": "A short code the invitee types at redemption, returned exactly once. The administrator delivers it over a different channel from `url`, so that intercepting one channel is not enough to redeem. The consumer stores only a slow hash of it."
+        }
+      }
+    },
+    "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-]+)+$"
+      }
+    }
+  }
+} 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 Passkey Enroll Invite — response payload",
+      "description": "The issued invite. Carried in a Trust Task document whose type is https://trusttasks.org/spec/auth/passkey/enroll/invite/0.2#response.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "invite",
+        "subject",
+        "purpose",
+        "expiresAt",
+        "claimCode"
+      ],
+      "properties": {
+        "invite": {
+          "type": "object",
+          "additionalProperties": false,
+          "required": [
+            "token",
+            "url"
+          ],
+          "properties": {
+            "token": {
+              "type": "string",
+              "minLength": 16,
+              "description": "Opaque single-use invite token. The invitee presents it to the consumer during enrollment. ≥128 bits entropy."
+            },
+            "url": {
+              "type": "string",
+              "format": "uri",
+              "description": "Operator-shareable URL that, when opened in a WebAuthn-capable browser, drives the redemption ceremony (auth/passkey/enroll/redeem/start). Carries the token. MUST NOT carry the claim code."
+            }
+          }
+        },
+        "subject": {
+          "type": "string",
+          "description": "Echo of the invitee's VID."
+        },
+        "purpose": {
+          "type": "string",
+          "enum": [
+            "session",
+            "stepUp"
+          ],
+          "description": "Echo of the purpose the redeemed credential will have."
+        },
+        "expiresAt": {
+          "type": "string",
+          "format": "date-time"
+        },
+        "ext": {
+          "$ref": "#/$defs/Ext"
+        },
+        "claimCode": {
+          "type": "string",
+          "minLength": 8,
+          "maxLength": 64,
+          "description": "A short code the invitee types at redemption, returned exactly once. The administrator delivers it over a different channel from `url`, so that intercepting one channel is not enough to redeem. The consumer stores only a slow hash of it."
+        }
+      }
+    },
+    "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-]+)+$"
+      }
+    }
+  }
+} 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;