@openvtc/trust-tasks 0.28.1 → 0.28.3

package/src/vtc/install/claim/passkey/finish/0.1/payload.ts

@@ -0,0 +1,228 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vtc/install/claim/passkey/finish/0.1/payload.schema.json
+ */
+
+import type { Ext } from "../../../../../../_shared/components.js";
+
+
+/**
+ * Complete first-administrator enrolment with a passkey: submit the WebAuthn registration and one assertion proving possession of the registered key, from whose credential public key — Ed25519 or P-256 — the administrator's did:key is derived, and receive a setup-session token. The passkey ceremony of vtc/install/claim/finish 0.2, widened from Ed25519 alone to P-256. The outer document members (id, type, issuer, recipient, issuedAt, expiresAt, proof) are owned by the framework — SPEC §6.3.
+ */
+export interface VTCInstallClaimPasskeyFinishPayload {
+  /**
+   * The install JWT the claim was started with.
+   */
+  installToken: string;
+  /**
+   * From vtc/install/claim/passkey/start.
+   */
+  registrationId: string;
+  /**
+   * RegisterPublicKeyCredential from navigator.credentials.create() (opaque here). Its credential public key is a COSE key for EdDSA/Ed25519 (alg -8) or ES256/P-256 (alg -7); any other is refused with unsupportedAlgorithm.
+   */
+  webauthnResponse: {};
+  /**
+   * PublicKeyCredential from navigator.credentials.get() (opaque here): one assertion by the credential just registered, over the assertion challenge vtc/install/claim/passkey/start issued. Verified against the key the administrator's DID is derived from; it is the proof of possession, whatever the registration's attestation format.
+   */
+  webauthnAssertion: {};
+  ext?: Ext;
+}
+export interface VTCInstallClaimPasskeyFinishResponsePayload {
+  /**
+   * The administrator's DID: the did:key of the passkey credential's own public key — Ed25519 (multicodec 0xed01, did:key:z6Mk…) or P-256, compressed (multicodec 0x1200, did:key:zDn…). Derived by the community from the registered key, never taken from the install token.
+   */
+  adminDid: string;
+  /**
+   * EdDSA JWT (aud=vtc-install-session, 5min TTL) consumed by admin/bootstrap.
+   */
+  setupSessionToken: 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/vtc/install/claim/passkey/finish/0.1" as const;
+
+/**
+ * The earlier version of this specification that this one declares it
+ * extends (front matter `extends`, SPEC §5.2 "Declared extension"), or
+ * `null`. Only the direct declaration — follow the chain with
+ * `extendsChain` / `readForSpec`.
+ */
+export const EXTENDS: string | null = null;
+
+/**
+ * Why this version is deprecated, or `null` while it is current. A
+ * superseded or retired version is still supported, and is withdrawn from
+ * this package in a later scheduled batch (SPEC "Superseded and Withdrawn
+ * Versions").
+ */
+export const DEPRECATION: string | null = null;
+
+/** Stable alias for this specification's request payload shape. */
+export type Payload = VTCInstallClaimPasskeyFinishPayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vtc/install/claim/passkey/finish/0.1#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTCInstallClaimPasskeyFinishResponsePayload;
+
+/**
+ * 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/vtc/install/claim/passkey/finish/0.1",
+  "title": "VTC Install Claim Passkey Finish — payload",
+  "description": "Complete first-administrator enrolment with a passkey: submit the WebAuthn registration and one assertion proving possession of the registered key, from whose credential public key — Ed25519 or P-256 — the administrator's did:key is derived, and receive a setup-session token. The passkey ceremony of vtc/install/claim/finish 0.2, widened from Ed25519 alone to P-256. The outer document members (id, type, issuer, recipient, issuedAt, expiresAt, proof) are owned by the framework — SPEC §6.3.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "installToken",
+    "registrationId",
+    "webauthnResponse",
+    "webauthnAssertion"
+  ],
+  "properties": {
+    "installToken": {
+      "type": "string",
+      "minLength": 1,
+      "description": "The install JWT the claim was started with."
+    },
+    "registrationId": {
+      "type": "string",
+      "minLength": 1,
+      "description": "From vtc/install/claim/passkey/start."
+    },
+    "webauthnResponse": {
+      "type": "object",
+      "description": "RegisterPublicKeyCredential from navigator.credentials.create() (opaque here). Its credential public key is a COSE key for EdDSA/Ed25519 (alg -8) or ES256/P-256 (alg -7); any other is refused with unsupportedAlgorithm."
+    },
+    "webauthnAssertion": {
+      "type": "object",
+      "description": "PublicKeyCredential from navigator.credentials.get() (opaque here): one assertion by the credential just registered, over the assertion challenge vtc/install/claim/passkey/start issued. Verified against the key the administrator's DID is derived from; it is the proof of possession, whatever the registration's attestation format."
+    },
+    "ext": {
+      "$ref": "#/$defs/Ext"
+    }
+  },
+  "$defs": {
+    "Response": {
+      "$anchor": "response",
+      "title": "VTC Install Claim Passkey Finish — response payload",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "adminDid",
+        "setupSessionToken"
+      ],
+      "properties": {
+        "adminDid": {
+          "type": "string",
+          "pattern": "^did:key:z(6Mk|Dn)[1-9A-HJ-NP-Za-km-z]+$",
+          "description": "The administrator's DID: the did:key of the passkey credential's own public key — Ed25519 (multicodec 0xed01, did:key:z6Mk…) or P-256, compressed (multicodec 0x1200, did:key:zDn…). Derived by the community from the registered key, never taken from the install token."
+        },
+        "setupSessionToken": {
+          "type": "string",
+          "minLength": 1,
+          "description": "EdDSA JWT (aud=vtc-install-session, 5min TTL) consumed by admin/bootstrap."
+        },
+        "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": "VTC Install Claim Passkey Finish — response payload",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "adminDid",
+        "setupSessionToken"
+      ],
+      "properties": {
+        "adminDid": {
+          "type": "string",
+          "pattern": "^did:key:z(6Mk|Dn)[1-9A-HJ-NP-Za-km-z]+$",
+          "description": "The administrator's DID: the did:key of the passkey credential's own public key — Ed25519 (multicodec 0xed01, did:key:z6Mk…) or P-256, compressed (multicodec 0x1200, did:key:zDn…). Derived by the community from the registered key, never taken from the install token."
+        },
+        "setupSessionToken": {
+          "type": "string",
+          "minLength": 1,
+          "description": "EdDSA JWT (aud=vtc-install-session, 5min TTL) consumed by admin/bootstrap."
+        },
+        "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: 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: true,
+  isRecipientRequired: true,
+  isIssuedAtRequired: true,
+  payloadSchema: RESPONSE_PAYLOAD_SCHEMA,
+} as const;

package/src/vtc/install/claim/passkey/start/0.1/payload.ts

@@ -0,0 +1,225 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vtc/install/claim/passkey/start/0.1/payload.schema.json
+ */
+
+import type { Ext } from "../../../../../../_shared/components.js";
+
+
+/**
+ * Begin claiming a fresh community with a passkey: exchange the install token (and its claim code, when the token was issued with one) for a WebAuthn registration challenge, and the assertion challenge with which the installer will prove possession of the passkey. The passkey ceremony of vtc/install/claim/start 0.2, with the administrator's DID derived from the passkey's own key — Ed25519 or P-256 — and never named by the token. The outer document members (id, type, issuer, recipient, issuedAt, expiresAt, proof) are owned by the framework — SPEC §6.3.
+ */
+export interface VTCInstallClaimPasskeyStartPayload {
+  /**
+   * The EdDSA-signed install JWT (aud=vtc-install) printed by vtc setup.
+   */
+  installToken: string;
+  /**
+   * A short code the operator receives **out of band**, alongside the install URL but through a separate channel.
+   *
+   * The second factor on a claim: the URL alone is deliberately insufficient, so a stolen or forwarded install link cannot claim the passkey by itself. A maintainer that mints one shows the plaintext once and stores only a hash; a claim that omits or fails it is refused before any registration challenge is issued.
+   *
+   * Optional in the schema because a maintainer may issue tokens without one — but a maintainer that does issue one MUST require it, and SHOULD issue one for any invite that travels over a channel it does not control.
+   */
+  claimSecret?: string;
+  ext?: Ext;
+}
+export interface VTCInstallClaimPasskeyStartResponsePayload {
+  /**
+   * Echoes the install token's jti (a UUID); pass it back to vtc/install/claim/passkey/finish.
+   */
+  registrationId: string;
+  /**
+   * WebAuthn PublicKeyCredentialCreationOptions (opaque here). pubKeyCredParams lists exactly EdDSA (-8, Ed25519) and ES256 (-7, P-256), the two algorithms whose key the administrator's did:key can name; user.id, user.name and user.displayName name no DID.
+   */
+  options: {};
+  /**
+   * WebAuthn PublicKeyCredentialRequestOptions (opaque here) for the one assertion that proves possession of the passkey just registered: a fresh challenge of at least 128 bits, distinct from the creation challenge, single-use and bound to this registration, with the community's rpId. allowCredentials is omitted — the credential does not exist yet — and the installer's page sets it to the rawId navigator.credentials.create() returned.
+   */
+  assertionOptions: {};
+  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/vtc/install/claim/passkey/start/0.1" as const;
+
+/**
+ * The earlier version of this specification that this one declares it
+ * extends (front matter `extends`, SPEC §5.2 "Declared extension"), or
+ * `null`. Only the direct declaration — follow the chain with
+ * `extendsChain` / `readForSpec`.
+ */
+export const EXTENDS: string | null = null;
+
+/**
+ * Why this version is deprecated, or `null` while it is current. A
+ * superseded or retired version is still supported, and is withdrawn from
+ * this package in a later scheduled batch (SPEC "Superseded and Withdrawn
+ * Versions").
+ */
+export const DEPRECATION: string | null = null;
+
+/** Stable alias for this specification's request payload shape. */
+export type Payload = VTCInstallClaimPasskeyStartPayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vtc/install/claim/passkey/start/0.1#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTCInstallClaimPasskeyStartResponsePayload;
+
+/**
+ * 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/vtc/install/claim/passkey/start/0.1",
+  "title": "VTC Install Claim Passkey Start — payload",
+  "description": "Begin claiming a fresh community with a passkey: exchange the install token (and its claim code, when the token was issued with one) for a WebAuthn registration challenge, and the assertion challenge with which the installer will prove possession of the passkey. The passkey ceremony of vtc/install/claim/start 0.2, with the administrator's DID derived from the passkey's own key — Ed25519 or P-256 — and never named by the token. The outer document members (id, type, issuer, recipient, issuedAt, expiresAt, proof) are owned by the framework — SPEC §6.3.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "installToken"
+  ],
+  "properties": {
+    "installToken": {
+      "type": "string",
+      "minLength": 1,
+      "description": "The EdDSA-signed install JWT (aud=vtc-install) printed by vtc setup."
+    },
+    "claimSecret": {
+      "type": "string",
+      "minLength": 1,
+      "description": "A short code the operator receives **out of band**, alongside the install URL but through a separate channel.\n\nThe second factor on a claim: the URL alone is deliberately insufficient, so a stolen or forwarded install link cannot claim the passkey by itself. A maintainer that mints one shows the plaintext once and stores only a hash; a claim that omits or fails it is refused before any registration challenge is issued.\n\nOptional in the schema because a maintainer may issue tokens without one — but a maintainer that does issue one MUST require it, and SHOULD issue one for any invite that travels over a channel it does not control."
+    },
+    "ext": {
+      "$ref": "#/$defs/Ext"
+    }
+  },
+  "$defs": {
+    "Response": {
+      "$anchor": "response",
+      "title": "VTC Install Claim Passkey Start — response payload",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "registrationId",
+        "options",
+        "assertionOptions"
+      ],
+      "properties": {
+        "registrationId": {
+          "type": "string",
+          "minLength": 1,
+          "description": "Echoes the install token's jti (a UUID); pass it back to vtc/install/claim/passkey/finish."
+        },
+        "options": {
+          "type": "object",
+          "description": "WebAuthn PublicKeyCredentialCreationOptions (opaque here). pubKeyCredParams lists exactly EdDSA (-8, Ed25519) and ES256 (-7, P-256), the two algorithms whose key the administrator's did:key can name; user.id, user.name and user.displayName name no DID."
+        },
+        "assertionOptions": {
+          "type": "object",
+          "description": "WebAuthn PublicKeyCredentialRequestOptions (opaque here) for the one assertion that proves possession of the passkey just registered: a fresh challenge of at least 128 bits, distinct from the creation challenge, single-use and bound to this registration, with the community's rpId. allowCredentials is omitted — the credential does not exist yet — and the installer's page sets it to the rawId navigator.credentials.create() returned."
+        },
+        "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": "VTC Install Claim Passkey Start — response payload",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "registrationId",
+        "options",
+        "assertionOptions"
+      ],
+      "properties": {
+        "registrationId": {
+          "type": "string",
+          "minLength": 1,
+          "description": "Echoes the install token's jti (a UUID); pass it back to vtc/install/claim/passkey/finish."
+        },
+        "options": {
+          "type": "object",
+          "description": "WebAuthn PublicKeyCredentialCreationOptions (opaque here). pubKeyCredParams lists exactly EdDSA (-8, Ed25519) and ES256 (-7, P-256), the two algorithms whose key the administrator's did:key can name; user.id, user.name and user.displayName name no DID."
+        },
+        "assertionOptions": {
+          "type": "object",
+          "description": "WebAuthn PublicKeyCredentialRequestOptions (opaque here) for the one assertion that proves possession of the passkey just registered: a fresh challenge of at least 128 bits, distinct from the creation challenge, single-use and bound to this registration, with the community's rpId. allowCredentials is omitted — the credential does not exist yet — and the installer's page sets it to the rawId navigator.credentials.create() returned."
+        },
+        "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: false,
+  isRecipientRequired: true,
+  isIssuedAtRequired: false,
+  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: false,
+  payloadSchema: RESPONSE_PAYLOAD_SCHEMA,
+} as const;

package/src/vtc/install/claim/start/0.2/payload.ts

@@ -6,7 +6,7 @@
 import type { Ext } from "../../../../../_shared/components.js";
 
 
-/** @deprecated superseded by vtc/install/claim/start/0.3 */
+/** @deprecated retired; use vtc/install/claim/passkey/start/0.1 */
 export interface VTCInstallClaimStartPayload {
   /**
    * The EdDSA-signed install JWT (aud=vtc-install) printed by vtc setup.
@@ -22,7 +22,7 @@ export interface VTCInstallClaimStartPayload {
   claimSecret?: string;
   ext?: Ext;
 }
-/** @deprecated superseded by vtc/install/claim/start/0.3 */
+/** @deprecated retired; use vtc/install/claim/passkey/start/0.1 */
 export interface VTCInstallClaimStartResponsePayload {
   /**
    * Echoes the install token's jti (a UUID); pass it back to claim/finish.
@@ -55,12 +55,12 @@ export const EXTENDS: string | null = null;
  * this package in a later scheduled batch (SPEC "Superseded and Withdrawn
  * Versions").
  */
-export const DEPRECATION: string | null = "superseded by vtc/install/claim/start/0.3";
+export const DEPRECATION: string | null = "retired; use vtc/install/claim/passkey/start/0.1";
 
 /**
  * Stable alias for this specification's request payload shape.
  *
- * @deprecated superseded by vtc/install/claim/start/0.3
+ * @deprecated retired; use vtc/install/claim/passkey/start/0.1
  */
 export type Payload = VTCInstallClaimStartPayload;
 
@@ -70,7 +70,7 @@ export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vtc/install/claim/
 /**
  * Stable alias for this specification's success-response payload shape.
  *
- * @deprecated superseded by vtc/install/claim/start/0.3
+ * @deprecated retired; use vtc/install/claim/passkey/start/0.1
  */
 export type Response = VTCInstallClaimStartResponsePayload;