@openvtc/trust-tasks 0.20.7 → 0.21.0

package/src/auth/passkey/revoke/finish/0.2/payload.ts

@@ -0,0 +1,379 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/auth/passkey/revoke/finish/0.2/payload.schema.json
+ */
+
+import type { AuthenticatorAssertionResponseLogin, Ext } from "../../../../../_shared/components.js";
+
+
+/**
+ * Submit the user-verification assertion that completes a passkey revocation. On success the auth service unbinds the credential named at start. The payload carries no target — the revocationId is bound to it server-side.
+ */
+export interface AuthPasskeyRevokeFinish {
+  /**
+   * The revocationId issued by the matching auth/passkey/revoke/start response. Echoed verbatim.
+   */
+  revocationId: string;
+  /**
+   * AuthenticatorAssertionResponse as returned by navigator.credentials.get over the uvOptions from start. Binary fields base64url-encoded.
+   */
+  uvCredential: AuthenticatorAssertionResponseLogin;
+  /**
+   * Ecosystem-defined extension members per SPEC.md §4.5.1.
+   */
+  ext?: Ext;
+}
+/**
+ * Acknowledgement of the removed credential. Carried in a Trust Task document whose type is https://trusttasks.org/spec/auth/passkey/revoke/finish/0.2#response.
+ */
+export interface AuthPasskeyRevokeFinishResponsePayload {
+  /**
+   * The credential that was removed. Echoed from the server-side binding rather than from the request, so the producer can confirm the ceremony destroyed what they intended.
+   */
+  credentialId: string;
+  /**
+   * New in 0.2. The VID the revoked credential was bound to.
+   */
+  subject: string;
+  /**
+   * New in 0.2. What the revoked credential authenticated. `remaining` counts the subject's credentials of this purpose.
+   */
+  purpose: "session" | "stepUp";
+  /**
+   * When the credential was unbound.
+   */
+  revokedAt: string;
+  /**
+   * How many credentials of the revoked credential's purpose the subject still has. For a session credential never zero — the last-credential guard guarantees it; for a step-up credential it may be zero. Present so whoever just pruned an estate knows what is left without a second round-trip.
+   */
+  remaining: number;
+  /**
+   * 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, Ext };
+
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/auth/passkey/revoke/finish/0.2" as const;
+
+/** Stable alias for this specification's request payload shape. */
+export type Payload = AuthPasskeyRevokeFinish;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/auth/passkey/revoke/finish/0.2#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = AuthPasskeyRevokeFinishResponsePayload;
+
+/**
+ * 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/revoke/finish/0.2",
+  "title": "Auth — Passkey Revoke (finish)",
+  "description": "Submit the user-verification assertion that completes a passkey revocation. On success the auth service unbinds the credential named at start. The payload carries no target — the revocationId is bound to it server-side.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "revocationId",
+    "uvCredential"
+  ],
+  "properties": {
+    "revocationId": {
+      "type": "string",
+      "minLength": 1,
+      "description": "The revocationId issued by the matching auth/passkey/revoke/start response. Echoed verbatim."
+    },
+    "uvCredential": {
+      "$ref": "#/$defs/AssertionResponse",
+      "description": "AuthenticatorAssertionResponse as returned by navigator.credentials.get over the uvOptions from start. Binary fields base64url-encoded."
+    },
+    "ext": {
+      "$ref": "#/$defs/Ext",
+      "description": "Ecosystem-defined extension members per SPEC.md §4.5.1."
+    }
+  },
+  "$defs": {
+    "Response": {
+      "$anchor": "response",
+      "title": "Auth Passkey Revoke Finish — response payload",
+      "description": "Acknowledgement of the removed credential. Carried in a Trust Task document whose type is https://trusttasks.org/spec/auth/passkey/revoke/finish/0.2#response.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "credentialId",
+        "revokedAt",
+        "remaining",
+        "subject",
+        "purpose"
+      ],
+      "properties": {
+        "credentialId": {
+          "type": "string",
+          "minLength": 1,
+          "description": "The credential that was removed. Echoed from the server-side binding rather than from the request, so the producer can confirm the ceremony destroyed what they intended."
+        },
+        "subject": {
+          "type": "string",
+          "minLength": 1,
+          "description": "New in 0.2. The VID the revoked credential was bound to."
+        },
+        "purpose": {
+          "type": "string",
+          "enum": [
+            "session",
+            "stepUp"
+          ],
+          "description": "New in 0.2. What the revoked credential authenticated. `remaining` counts the subject's credentials of this purpose."
+        },
+        "revokedAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "When the credential was unbound."
+        },
+        "remaining": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "How many credentials of the revoked credential's purpose the subject still has. For a session credential never zero — the last-credential guard guarantees it; for a step-up credential it may be zero. Present so whoever just pruned an estate knows what is left without a second round-trip."
+        },
+        "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"
+        }
+      }
+    }
+  }
+} 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 Revoke Finish — response payload",
+      "description": "Acknowledgement of the removed credential. Carried in a Trust Task document whose type is https://trusttasks.org/spec/auth/passkey/revoke/finish/0.2#response.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "credentialId",
+        "revokedAt",
+        "remaining",
+        "subject",
+        "purpose"
+      ],
+      "properties": {
+        "credentialId": {
+          "type": "string",
+          "minLength": 1,
+          "description": "The credential that was removed. Echoed from the server-side binding rather than from the request, so the producer can confirm the ceremony destroyed what they intended."
+        },
+        "subject": {
+          "type": "string",
+          "minLength": 1,
+          "description": "New in 0.2. The VID the revoked credential was bound to."
+        },
+        "purpose": {
+          "type": "string",
+          "enum": [
+            "session",
+            "stepUp"
+          ],
+          "description": "New in 0.2. What the revoked credential authenticated. `remaining` counts the subject's credentials of this purpose."
+        },
+        "revokedAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "When the credential was unbound."
+        },
+        "remaining": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "How many credentials of the revoked credential's purpose the subject still has. For a session credential never zero — the last-credential guard guarantees it; for a step-up credential it may be zero. Present so whoever just pruned an estate knows what is left without a second round-trip."
+        },
+        "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"
+        }
+      }
+    }
+  }
+} 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;