@openvtc/trust-tasks 0.22.5 → 0.22.7

package/src/auth/step-up/approver/redeem/finish/0.1/payload.ts

@@ -0,0 +1,337 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/auth/step-up/approver/redeem/finish/0.1/payload.schema.json
+ */
+
+import type { Approver, ApproverDid, ApproverLabel, AttestStatement, EnrolledVia, Ext } from "../../../../../../_shared/components.js";
+
+
+/**
+ * The invited subject, signing as their own DID, names the step-up approver to bind and carries its signed enrolment statement over the ceremony's challenge; the relying party binds the approver and consumes the invite. The outer document members (id, type, issuer, recipient, issuedAt, expiresAt, proof) are owned by the framework — SPEC §6.3.
+ */
+export interface AuthStepUpApproverRedeemFinishPayload {
+  /**
+   * The enrollmentId from auth/step-up/approver/redeem/start, echoed verbatim. Also the `boundTo` of the statement.
+   */
+  enrollmentId: string;
+  /**
+   * The step-up approver to bind. MUST equal the statement's issuer.
+   */
+  approverDid: ApproverDid;
+  /**
+   * A name for where the approver lives. Overrides the inviter's suggestion.
+   */
+  label?: ApproverLabel;
+  /**
+   * The approver's complete, signed auth/step-up/approver/attest/0.1 document with `purpose: enrol`, `boundTo` equal to `enrollmentId`, over the start's `challenge` — the proof of possession of the approver key. Verified as received.
+   */
+  statement: AttestStatement;
+  ext?: Ext;
+}
+/**
+ * The binding as stored.
+ */
+export interface AuthStepUpApproverRedeemFinishResponsePayload {
+  approver: Approver;
+  ext?: Ext;
+}
+
+/** Shared definitions this specification references, re-exported under the names it used to declare them with. */
+export type { Approver, ApproverDid, ApproverLabel, AttestStatement, EnrolledVia, Ext };
+
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/auth/step-up/approver/redeem/finish/0.1" as const;
+
+/** Stable alias for this specification's request payload shape. */
+export type Payload = AuthStepUpApproverRedeemFinishPayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/auth/step-up/approver/redeem/finish/0.1#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = AuthStepUpApproverRedeemFinishResponsePayload;
+
+/**
+ * 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/step-up/approver/redeem/finish/0.1",
+  "title": "Auth — Step-up Approver Redeem (finish) — payload",
+  "description": "The invited subject, signing as their own DID, names the step-up approver to bind and carries its signed enrolment statement over the ceremony's challenge; the relying party binds the approver and consumes the invite. The outer document members (id, type, issuer, recipient, issuedAt, expiresAt, proof) are owned by the framework — SPEC §6.3.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "enrollmentId",
+    "approverDid",
+    "statement"
+  ],
+  "properties": {
+    "enrollmentId": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 256,
+      "description": "The enrollmentId from auth/step-up/approver/redeem/start, echoed verbatim. Also the `boundTo` of the statement."
+    },
+    "approverDid": {
+      "$ref": "#/$defs/ApproverDid",
+      "description": "The step-up approver to bind. MUST equal the statement's issuer."
+    },
+    "label": {
+      "$ref": "#/$defs/ApproverLabel",
+      "description": "A name for where the approver lives. Overrides the inviter's suggestion."
+    },
+    "statement": {
+      "$ref": "#/$defs/AttestStatement",
+      "description": "The approver's complete, signed auth/step-up/approver/attest/0.1 document with `purpose: enrol`, `boundTo` equal to `enrollmentId`, over the start's `challenge` — the proof of possession of the approver key. Verified as received."
+    },
+    "ext": {
+      "$ref": "#/$defs/Ext"
+    }
+  },
+  "$defs": {
+    "Response": {
+      "$anchor": "response",
+      "title": "Auth — Step-up Approver Redeem (finish) — response payload",
+      "description": "The binding as stored.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "approver"
+      ],
+      "properties": {
+        "approver": {
+          "$ref": "#/$defs/Approver"
+        },
+        "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-]+)+$"
+      }
+    },
+    "Approver": {
+      "title": "Approver",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "approverDid",
+        "subject",
+        "enrolledAt",
+        "enrolledVia"
+      ],
+      "description": "One step-up approver binding, as its subject or an administrator sees it. The binding confers nothing of its own: it is read only when the relying party checks the evidence of a step-up asked of `subject`.",
+      "properties": {
+        "approverDid": {
+          "$ref": "#/$defs/ApproverDid"
+        },
+        "subject": {
+          "type": "string",
+          "pattern": "^did:",
+          "minLength": 5,
+          "maxLength": 2048,
+          "description": "The one subject DID this approver is bound to. An approver DID is bound to at most one subject at a relying party."
+        },
+        "label": {
+          "$ref": "#/$defs/ApproverLabel"
+        },
+        "enrolledAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "When the binding was written."
+        },
+        "enrolledVia": {
+          "$ref": "#/$defs/EnrolledVia"
+        },
+        "lastUsedAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "When a statement by this approver last satisfied a step-up. Absent when it never has."
+        }
+      }
+    },
+    "EnrolledVia": {
+      "title": "EnrolledVia",
+      "type": "string",
+      "enum": [
+        "install",
+        "invite",
+        "selfService",
+        "offline"
+      ],
+      "description": "The anchor the binding rested on, recorded so an incident review can see how each factor came to exist. `install`: claimed with the community's install token (vtc/install/claim/finish/0.3). `invite`: redeemed from an administrator's invite (auth/step-up/approver/redeem/finish/0.1). `selfService`: added by the subject behind a factor they already held (auth/step-up/approver/enroll/0.1). `offline`: redeemed from an invite minted by the operator with host access while the service was stopped — an `invite`-shaped redemption whose issuer was the host rather than an administrator."
+    },
+    "ApproverLabel": {
+      "title": "ApproverLabel",
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 64,
+      "description": "A human-readable name for where the approver lives — e.g. `Browser plugin — work laptop`. Chosen by the subject (or suggested by an inviter), untrusted, and attributed to its author wherever it is rendered. Absent rather than invented when none was chosen."
+    },
+    "ApproverDid": {
+      "title": "ApproverDid",
+      "type": "string",
+      "minLength": 16,
+      "maxLength": 128,
+      "pattern": "^did:key:z6Mk[1-9A-HJ-NP-Za-km-z]+$",
+      "description": "A step-up approver, as an Ed25519 `did:key` (`z6Mk…`). `did:key` only, because its document is a function of the key and resolves with no network, so verifying an approver's statement never depends on a fetch, and a key whose DID document could be rewritten after enrolment would not be the key that was enrolled. Distinct from the subject's DID, from every verification method in the subject's DID document, and from every key the subject can sign operations with at the relying party."
+    },
+    "AttestStatement": {
+      "title": "AttestStatement",
+      "type": "object",
+      "minProperties": 1,
+      "description": "A complete, signed auth/step-up/approver/attest/0.1 Trust Task document — envelope, payload and proof — issued by the approver. Deliberately an open object here rather than a typed one: the consumer verifies it as a document in its own right (envelope, proof and payload against that specification's schemas), and verifies its proof over the members exactly as received, which a binding that narrowed it to a typed struct and re-serialised it could silently break."
+    }
+  }
+} 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 — Step-up Approver Redeem (finish) — response payload",
+      "description": "The binding as stored.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "approver"
+      ],
+      "properties": {
+        "approver": {
+          "$ref": "#/$defs/Approver"
+        },
+        "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-]+)+$"
+      }
+    },
+    "Approver": {
+      "title": "Approver",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "approverDid",
+        "subject",
+        "enrolledAt",
+        "enrolledVia"
+      ],
+      "description": "One step-up approver binding, as its subject or an administrator sees it. The binding confers nothing of its own: it is read only when the relying party checks the evidence of a step-up asked of `subject`.",
+      "properties": {
+        "approverDid": {
+          "$ref": "#/$defs/ApproverDid"
+        },
+        "subject": {
+          "type": "string",
+          "pattern": "^did:",
+          "minLength": 5,
+          "maxLength": 2048,
+          "description": "The one subject DID this approver is bound to. An approver DID is bound to at most one subject at a relying party."
+        },
+        "label": {
+          "$ref": "#/$defs/ApproverLabel"
+        },
+        "enrolledAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "When the binding was written."
+        },
+        "enrolledVia": {
+          "$ref": "#/$defs/EnrolledVia"
+        },
+        "lastUsedAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "When a statement by this approver last satisfied a step-up. Absent when it never has."
+        }
+      }
+    },
+    "EnrolledVia": {
+      "title": "EnrolledVia",
+      "type": "string",
+      "enum": [
+        "install",
+        "invite",
+        "selfService",
+        "offline"
+      ],
+      "description": "The anchor the binding rested on, recorded so an incident review can see how each factor came to exist. `install`: claimed with the community's install token (vtc/install/claim/finish/0.3). `invite`: redeemed from an administrator's invite (auth/step-up/approver/redeem/finish/0.1). `selfService`: added by the subject behind a factor they already held (auth/step-up/approver/enroll/0.1). `offline`: redeemed from an invite minted by the operator with host access while the service was stopped — an `invite`-shaped redemption whose issuer was the host rather than an administrator."
+    },
+    "ApproverLabel": {
+      "title": "ApproverLabel",
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 64,
+      "description": "A human-readable name for where the approver lives — e.g. `Browser plugin — work laptop`. Chosen by the subject (or suggested by an inviter), untrusted, and attributed to its author wherever it is rendered. Absent rather than invented when none was chosen."
+    },
+    "ApproverDid": {
+      "title": "ApproverDid",
+      "type": "string",
+      "minLength": 16,
+      "maxLength": 128,
+      "pattern": "^did:key:z6Mk[1-9A-HJ-NP-Za-km-z]+$",
+      "description": "A step-up approver, as an Ed25519 `did:key` (`z6Mk…`). `did:key` only, because its document is a function of the key and resolves with no network, so verifying an approver's statement never depends on a fetch, and a key whose DID document could be rewritten after enrolment would not be the key that was enrolled. Distinct from the subject's DID, from every verification method in the subject's DID document, and from every key the subject can sign operations with at the relying party."
+    },
+    "AttestStatement": {
+      "title": "AttestStatement",
+      "type": "object",
+      "minProperties": 1,
+      "description": "A complete, signed auth/step-up/approver/attest/0.1 Trust Task document — envelope, payload and proof — issued by the approver. Deliberately an open object here rather than a typed one: the consumer verifies it as a document in its own right (envelope, proof and payload against that specification's schemas), and verifies its proof over the members exactly as received, which a binding that narrowed it to a typed struct and re-serialised it could silently break."
+    }
+  }
+} 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: false,
+  isRecipientRequired: true,
+  isIssuedAtRequired: true,
+  payloadSchema: RESPONSE_PAYLOAD_SCHEMA,
+} as const;

package/src/auth/step-up/approver/redeem/start/0.1/payload.ts

@@ -0,0 +1,241 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/auth/step-up/approver/redeem/start/0.1/payload.schema.json
+ */
+
+import type { Ext } from "../../../../../../_shared/components.js";
+
+
+/**
+ * The invited subject, signing as their own DID, presents an auth/step-up/approver/invite token and its claim code, and the relying party opens an enrolment ceremony with a challenge for the approver to sign. The outer document members (id, type, issuer, recipient, issuedAt, expiresAt, proof) are owned by the framework — SPEC §6.3.
+ */
+export interface AuthStepUpApproverRedeemStartPayload {
+  /**
+   * The invite token, as carried in the invite URL.
+   */
+  token: string;
+  /**
+   * The claim code the administrator delivered separately. Never logged; compared with its stored hash.
+   */
+  claimCode: string;
+  ext?: Ext;
+}
+/**
+ * The enrolment ceremony the invite authorises: what the approver's enrolment statement is to be made over.
+ */
+export interface AuthStepUpApproverRedeemStartResponsePayload {
+  /**
+   * Opaque, single-use handle for this ceremony. Echoed in redeem/finish, and the `boundTo` of the approver's enrolment statement.
+   */
+  enrollmentId: string;
+  /**
+   * A fresh challenge (≥128 bits) the approver signs over in its auth/step-up/approver/attest/0.1 statement with `purpose: enrol`.
+   */
+  challenge: string;
+  /**
+   * The relying party's DID, which the statement names as its `audience` and `recipient`.
+   */
+  audience: string;
+  /**
+   * When this ceremony lapses (not the invite). No later than the invite's own expiry.
+   */
+  expiresAt: string;
+  ext?: Ext;
+}
+
+/** 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/step-up/approver/redeem/start/0.1" as const;
+
+/** Stable alias for this specification's request payload shape. */
+export type Payload = AuthStepUpApproverRedeemStartPayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/auth/step-up/approver/redeem/start/0.1#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = AuthStepUpApproverRedeemStartResponsePayload;
+
+/**
+ * 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/step-up/approver/redeem/start/0.1",
+  "title": "Auth — Step-up Approver Redeem (start) — payload",
+  "description": "The invited subject, signing as their own DID, presents an auth/step-up/approver/invite token and its claim code, and the relying party opens an enrolment ceremony with a challenge for the approver to sign. The outer document members (id, type, issuer, recipient, issuedAt, expiresAt, proof) are owned by the framework — SPEC §6.3.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "token",
+    "claimCode"
+  ],
+  "properties": {
+    "token": {
+      "type": "string",
+      "minLength": 16,
+      "maxLength": 512,
+      "description": "The invite token, as carried in the invite URL."
+    },
+    "claimCode": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 64,
+      "description": "The claim code the administrator delivered separately. Never logged; compared with its stored hash."
+    },
+    "ext": {
+      "$ref": "#/$defs/Ext"
+    }
+  },
+  "$defs": {
+    "Response": {
+      "$anchor": "response",
+      "title": "Auth — Step-up Approver Redeem (start) — response payload",
+      "description": "The enrolment ceremony the invite authorises: what the approver's enrolment statement is to be made over.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "enrollmentId",
+        "challenge",
+        "audience",
+        "expiresAt"
+      ],
+      "properties": {
+        "enrollmentId": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 256,
+          "description": "Opaque, single-use handle for this ceremony. Echoed in redeem/finish, and the `boundTo` of the approver's enrolment statement."
+        },
+        "challenge": {
+          "type": "string",
+          "minLength": 16,
+          "maxLength": 512,
+          "description": "A fresh challenge (≥128 bits) the approver signs over in its auth/step-up/approver/attest/0.1 statement with `purpose: enrol`."
+        },
+        "audience": {
+          "type": "string",
+          "pattern": "^did:",
+          "minLength": 5,
+          "maxLength": 2048,
+          "description": "The relying party's DID, which the statement names as its `audience` and `recipient`."
+        },
+        "expiresAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "When this ceremony lapses (not the invite). No later than the invite's own expiry."
+        },
+        "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-]+)+$"
+      }
+    }
+  }
+} 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 — Step-up Approver Redeem (start) — response payload",
+      "description": "The enrolment ceremony the invite authorises: what the approver's enrolment statement is to be made over.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "enrollmentId",
+        "challenge",
+        "audience",
+        "expiresAt"
+      ],
+      "properties": {
+        "enrollmentId": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 256,
+          "description": "Opaque, single-use handle for this ceremony. Echoed in redeem/finish, and the `boundTo` of the approver's enrolment statement."
+        },
+        "challenge": {
+          "type": "string",
+          "minLength": 16,
+          "maxLength": 512,
+          "description": "A fresh challenge (≥128 bits) the approver signs over in its auth/step-up/approver/attest/0.1 statement with `purpose: enrol`."
+        },
+        "audience": {
+          "type": "string",
+          "pattern": "^did:",
+          "minLength": 5,
+          "maxLength": 2048,
+          "description": "The relying party's DID, which the statement names as its `audience` and `recipient`."
+        },
+        "expiresAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "When this ceremony lapses (not the invite). No later than the invite's own expiry."
+        },
+        "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-]+)+$"
+      }
+    }
+  }
+} 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: false,
+  isRecipientRequired: true,
+  isIssuedAtRequired: true,
+  payloadSchema: RESPONSE_PAYLOAD_SCHEMA,
+} as const;