@openvtc/trust-tasks 0.20.7 → 0.21.0

package/src/auth/passkey/enroll/redeem/finish/0.1/payload.ts

@@ -0,0 +1,499 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/auth/passkey/enroll/redeem/finish/0.1/payload.schema.json
+ */
+
+import type { AuthenticatorAssertionResponseLogin, AuthenticatorAttestationResponseRegistration, Ext } from "../../../../../../_shared/components.js";
+
+
+/**
+ * The invitee returns the attestation — and, where the subject already has a credential of the same purpose, a user-verified assertion from it — and the auth service binds the new credential to the invite's subject and consumes the invite.
+ */
+export interface AuthPasskeyEnrollRedeemFinish {
+  /**
+   * The enrollmentId from auth/passkey/enroll/redeem/start. Echoed verbatim.
+   */
+  enrollmentId: string;
+  /**
+   * AuthenticatorAttestationResponse as returned by navigator.credentials.create.
+   */
+  credential: AuthenticatorAttestationResponseRegistration;
+  /**
+   * AuthenticatorAssertionResponse over the start's uvOptions. REQUIRED exactly when start returned uvOptions.
+   */
+  uvCredential?: AuthenticatorAssertionResponseLogin;
+  /**
+   * Label for the credential. Overrides the inviter's suggestion.
+   */
+  deviceLabel?: string;
+  /**
+   * Ecosystem-defined extension members per SPEC.md §4.5.1.
+   */
+  ext?: Ext;
+}
+/**
+ * The registered credential.
+ */
+export interface AuthPasskeyEnrollRedeemFinishResponsePayload {
+  /**
+   * base64url-encoded WebAuthn credential id.
+   */
+  credentialId: string;
+  /**
+   * The VID the credential is now bound to.
+   */
+  subject: string;
+  /**
+   * What the credential authenticates.
+   */
+  purpose: "session" | "stepUp";
+  /**
+   * The label persisted with the credential.
+   */
+  deviceLabel?: string;
+  registeredAt: string;
+  /**
+   * Ecosystem-defined extension members per SPEC.md §4.5.1.
+   */
+  ext?: Ext;
+}
+
+/** Shared definitions this specification references, re-exported under the names it used to declare them with. */
+export type { AuthenticatorAssertionResponseLogin, AuthenticatorAttestationResponseRegistration, Ext };
+
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/auth/passkey/enroll/redeem/finish/0.1" as const;
+
+/** Stable alias for this specification's request payload shape. */
+export type Payload = AuthPasskeyEnrollRedeemFinish;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/auth/passkey/enroll/redeem/finish/0.1#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = AuthPasskeyEnrollRedeemFinishResponsePayload;
+
+/**
+ * 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/redeem/finish/0.1",
+  "title": "Auth — Passkey Enroll (redeem, finish)",
+  "description": "The invitee returns the attestation — and, where the subject already has a credential of the same purpose, a user-verified assertion from it — and the auth service binds the new credential to the invite's subject and consumes the invite.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "enrollmentId",
+    "credential"
+  ],
+  "properties": {
+    "enrollmentId": {
+      "type": "string",
+      "minLength": 1,
+      "description": "The enrollmentId from auth/passkey/enroll/redeem/start. Echoed verbatim."
+    },
+    "credential": {
+      "$ref": "#/$defs/AttestationResponse",
+      "description": "AuthenticatorAttestationResponse as returned by navigator.credentials.create."
+    },
+    "uvCredential": {
+      "$ref": "#/$defs/AssertionResponse",
+      "description": "AuthenticatorAssertionResponse over the start's uvOptions. REQUIRED exactly when start returned uvOptions."
+    },
+    "deviceLabel": {
+      "type": "string",
+      "maxLength": 256,
+      "description": "Label for the credential. Overrides the inviter's suggestion."
+    },
+    "ext": {
+      "$ref": "#/$defs/Ext",
+      "description": "Ecosystem-defined extension members per SPEC.md §4.5.1."
+    }
+  },
+  "$defs": {
+    "Response": {
+      "$anchor": "response",
+      "title": "Auth Passkey Enroll Redeem Finish — response payload",
+      "description": "The registered credential.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "credentialId",
+        "subject",
+        "purpose",
+        "registeredAt"
+      ],
+      "properties": {
+        "credentialId": {
+          "type": "string",
+          "minLength": 1,
+          "description": "base64url-encoded WebAuthn credential id."
+        },
+        "subject": {
+          "type": "string",
+          "minLength": 1,
+          "description": "The VID the credential is now bound to."
+        },
+        "purpose": {
+          "type": "string",
+          "enum": [
+            "session",
+            "stepUp"
+          ],
+          "description": "What the credential authenticates."
+        },
+        "deviceLabel": {
+          "type": "string",
+          "maxLength": 256,
+          "description": "The label persisted with the credential."
+        },
+        "registeredAt": {
+          "type": "string",
+          "format": "date-time"
+        },
+        "ext": {
+          "$ref": "#/$defs/Ext",
+          "description": "Ecosystem-defined extension members per SPEC.md §4.5.1."
+        }
+      }
+    },
+    "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-]+)+$"
+      }
+    },
+    "AssertionResponse": {
+      "$anchor": "assertionResponse",
+      "title": "AuthenticatorAssertionResponse (login)",
+      "description": "The credential the client returns from `navigator.credentials.get`. Binary fields are base64url-encoded.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "id",
+        "rawId",
+        "type",
+        "response"
+      ],
+      "properties": {
+        "id": {
+          "type": "string"
+        },
+        "rawId": {
+          "type": "string"
+        },
+        "type": {
+          "const": "public-key"
+        },
+        "response": {
+          "type": "object",
+          "additionalProperties": false,
+          "required": [
+            "clientDataJSON",
+            "authenticatorData",
+            "signature"
+          ],
+          "properties": {
+            "clientDataJSON": {
+              "type": "string"
+            },
+            "authenticatorData": {
+              "type": "string"
+            },
+            "signature": {
+              "type": "string"
+            },
+            "userHandle": {
+              "type": [
+                "string",
+                "null"
+              ]
+            }
+          }
+        },
+        "authenticatorAttachment": {
+          "enum": [
+            "platform",
+            "cross-platform"
+          ]
+        },
+        "clientExtensionResults": {
+          "type": "object"
+        }
+      }
+    },
+    "AttestationResponse": {
+      "$anchor": "attestationResponse",
+      "title": "AuthenticatorAttestationResponse (registration)",
+      "description": "The credential the client returns from `navigator.credentials.create`. Binary fields are base64url-encoded.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "id",
+        "rawId",
+        "type",
+        "response"
+      ],
+      "properties": {
+        "id": {
+          "type": "string"
+        },
+        "rawId": {
+          "type": "string"
+        },
+        "type": {
+          "const": "public-key"
+        },
+        "response": {
+          "type": "object",
+          "additionalProperties": false,
+          "required": [
+            "clientDataJSON",
+            "attestationObject"
+          ],
+          "properties": {
+            "clientDataJSON": {
+              "type": "string"
+            },
+            "attestationObject": {
+              "type": "string"
+            },
+            "transports": {
+              "type": "array",
+              "items": {
+                "type": "string"
+              }
+            }
+          }
+        },
+        "authenticatorAttachment": {
+          "enum": [
+            "platform",
+            "cross-platform"
+          ]
+        },
+        "clientExtensionResults": {
+          "type": "object"
+        }
+      }
+    }
+  }
+} 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 Redeem Finish — response payload",
+      "description": "The registered credential.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "credentialId",
+        "subject",
+        "purpose",
+        "registeredAt"
+      ],
+      "properties": {
+        "credentialId": {
+          "type": "string",
+          "minLength": 1,
+          "description": "base64url-encoded WebAuthn credential id."
+        },
+        "subject": {
+          "type": "string",
+          "minLength": 1,
+          "description": "The VID the credential is now bound to."
+        },
+        "purpose": {
+          "type": "string",
+          "enum": [
+            "session",
+            "stepUp"
+          ],
+          "description": "What the credential authenticates."
+        },
+        "deviceLabel": {
+          "type": "string",
+          "maxLength": 256,
+          "description": "The label persisted with the credential."
+        },
+        "registeredAt": {
+          "type": "string",
+          "format": "date-time"
+        },
+        "ext": {
+          "$ref": "#/$defs/Ext",
+          "description": "Ecosystem-defined extension members per SPEC.md §4.5.1."
+        }
+      }
+    },
+    "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-]+)+$"
+      }
+    },
+    "AssertionResponse": {
+      "$anchor": "assertionResponse",
+      "title": "AuthenticatorAssertionResponse (login)",
+      "description": "The credential the client returns from `navigator.credentials.get`. Binary fields are base64url-encoded.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "id",
+        "rawId",
+        "type",
+        "response"
+      ],
+      "properties": {
+        "id": {
+          "type": "string"
+        },
+        "rawId": {
+          "type": "string"
+        },
+        "type": {
+          "const": "public-key"
+        },
+        "response": {
+          "type": "object",
+          "additionalProperties": false,
+          "required": [
+            "clientDataJSON",
+            "authenticatorData",
+            "signature"
+          ],
+          "properties": {
+            "clientDataJSON": {
+              "type": "string"
+            },
+            "authenticatorData": {
+              "type": "string"
+            },
+            "signature": {
+              "type": "string"
+            },
+            "userHandle": {
+              "type": [
+                "string",
+                "null"
+              ]
+            }
+          }
+        },
+        "authenticatorAttachment": {
+          "enum": [
+            "platform",
+            "cross-platform"
+          ]
+        },
+        "clientExtensionResults": {
+          "type": "object"
+        }
+      }
+    },
+    "AttestationResponse": {
+      "$anchor": "attestationResponse",
+      "title": "AuthenticatorAttestationResponse (registration)",
+      "description": "The credential the client returns from `navigator.credentials.create`. Binary fields are base64url-encoded.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "id",
+        "rawId",
+        "type",
+        "response"
+      ],
+      "properties": {
+        "id": {
+          "type": "string"
+        },
+        "rawId": {
+          "type": "string"
+        },
+        "type": {
+          "const": "public-key"
+        },
+        "response": {
+          "type": "object",
+          "additionalProperties": false,
+          "required": [
+            "clientDataJSON",
+            "attestationObject"
+          ],
+          "properties": {
+            "clientDataJSON": {
+              "type": "string"
+            },
+            "attestationObject": {
+              "type": "string"
+            },
+            "transports": {
+              "type": "array",
+              "items": {
+                "type": "string"
+              }
+            }
+          }
+        },
+        "authenticatorAttachment": {
+          "enum": [
+            "platform",
+            "cross-platform"
+          ]
+        },
+        "clientExtensionResults": {
+          "type": "object"
+        }
+      }
+    }
+  }
+} 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: false,
+  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;