@openvtc/trust-tasks 0.12.9 → 0.12.11

package/src/vtc/endorsements/show/0.1/payload.ts

@@ -39,7 +39,7 @@ export interface Endorsement {
    * The attested claim body, validated against the endorsement type's claimSchema when it declares one.
    */
   claim?: {};
-  issued: IssuedCredential;
+  issued: CredentialReference;
   /**
    * The endorsement's slot on the community's shared Revocation status list. Published, so a foreign verifier can check revocation without contacting this community.
    */
@@ -50,22 +50,18 @@ export interface Endorsement {
   revokedAt?: string | null;
 }
 /**
- * The registry-wide issuance receipt — credentialId, the signed VEC, and expiry.
+ * A pointer to the issued VEC — its identifier and lifetime, not its bytes. `endorsements/issue` additionally returns the credential itself, because that is the one call whose caller has no other way to receive it.
  */
-export interface IssuedCredential {
+export interface CredentialReference {
   credentialId: CredentialId;
-  /**
-   * The issued Verifiable Credential (W3C VC Data Model 2.0), signed by the issuer's key. Opaque to the framework.
-   */
-  credential: {};
   /**
    * When the credential was minted.
    */
   issuedAt?: string;
   /**
-   * When the credential's validUntil falls due.
+   * When it lapses, or null when it does not.
    */
-  expiresAt: string;
+  expiresAt?: string | null;
 }
 
 /** Trust Task type URI. */
@@ -169,8 +165,8 @@ export const PAYLOAD_SCHEMA = {
           "description": "The attested claim body, validated against the endorsement type's claimSchema when it declares one."
         },
         "issued": {
-          "$ref": "#/$defs/IssuedCredential",
-          "description": "The registry-wide issuance receipt — credentialId, the signed VEC, and expiry."
+          "$ref": "#/$defs/CredentialReference",
+          "description": "A pointer to the issued VEC — its identifier and lifetime, not its bytes. `endorsements/issue` additionally returns the credential itself, because that is the one call whose caller has no other way to receive it."
         },
         "statusListIndex": {
           "type": "integer",
@@ -187,34 +183,31 @@ export const PAYLOAD_SCHEMA = {
         }
       }
     },
-    "IssuedCredential": {
-      "$anchor": "issuedCredential",
-      "title": "IssuedCredential",
-      "description": "The receipt for a successfully-minted Verifiable Credential: a stable handle for revocation and audit, the signed credential itself, and when it lapses.\n\nSCOPE — this is an *issuance* receipt, returned by the party that minted the credential. It is not the shape for a *delivery* receipt, where a holder hands an already-issued credential to a party that stores it: such a task returns a receipt naming what was stored (see vtc/members/vmc and vtc/join-requests/accept) and MUST NOT echo the credential back to the party that just sent it. Reaching for this definition on a delivery task is the mistake this paragraph exists to prevent.\n\n`additionalProperties` is false, so a specification needing extra members cannot compose this by `$ref` — `allOf` evaluates each subschema against the whole object and this one would reject them. vta/credentials/issue is that case: its response is this shape plus `supersedes` and `ext`, and it therefore states the members inline while `$ref`-ing the shared CredentialId. That is deliberate, not drift.",
+    "CredentialReference": {
+      "$anchor": "credentialReference",
+      "title": "CredentialReference",
       "type": "object",
       "additionalProperties": false,
+      "description": "A pointer to an issued credential, without the credential itself.\n\nThe counterpart to IssuedCredential, for the far more common case of *reading about* a credential rather than being handed one. A listing that embedded the signed credential in every row would grow with the size of the credentials rather than the number of them — a page of fifty is megabytes — and a reader that only needs to know a credential exists, when it lapses, and how to revoke it does not need the bytes.\n\nThe holder can always fetch the credential itself by `credentialId`, and a verifier can check revocation from the row's status-list slot without either. Reach for IssuedCredential only at the moment of minting, where the caller has no other way to receive what was just made for them.",
       "required": [
-        "credentialId",
-        "credential",
-        "expiresAt"
+        "credentialId"
       ],
       "properties": {
         "credentialId": {
           "$ref": "#/$defs/CredentialId"
         },
-        "credential": {
-          "type": "object",
-          "description": "The issued Verifiable Credential (W3C VC Data Model 2.0), signed by the issuer's key. Opaque to the framework."
-        },
         "issuedAt": {
           "type": "string",
           "format": "date-time",
           "description": "When the credential was minted."
         },
         "expiresAt": {
-          "type": "string",
+          "type": [
+            "string",
+            "null"
+          ],
           "format": "date-time",
-          "description": "When the credential's validUntil falls due."
+          "description": "When it lapses, or null when it does not."
         }
       }
     },
@@ -294,8 +287,8 @@ export const RESPONSE_PAYLOAD_SCHEMA = {
           "description": "The attested claim body, validated against the endorsement type's claimSchema when it declares one."
         },
         "issued": {
-          "$ref": "#/$defs/IssuedCredential",
-          "description": "The registry-wide issuance receipt — credentialId, the signed VEC, and expiry."
+          "$ref": "#/$defs/CredentialReference",
+          "description": "A pointer to the issued VEC — its identifier and lifetime, not its bytes. `endorsements/issue` additionally returns the credential itself, because that is the one call whose caller has no other way to receive it."
         },
         "statusListIndex": {
           "type": "integer",
@@ -312,34 +305,31 @@ export const RESPONSE_PAYLOAD_SCHEMA = {
         }
       }
     },
-    "IssuedCredential": {
-      "$anchor": "issuedCredential",
-      "title": "IssuedCredential",
-      "description": "The receipt for a successfully-minted Verifiable Credential: a stable handle for revocation and audit, the signed credential itself, and when it lapses.\n\nSCOPE — this is an *issuance* receipt, returned by the party that minted the credential. It is not the shape for a *delivery* receipt, where a holder hands an already-issued credential to a party that stores it: such a task returns a receipt naming what was stored (see vtc/members/vmc and vtc/join-requests/accept) and MUST NOT echo the credential back to the party that just sent it. Reaching for this definition on a delivery task is the mistake this paragraph exists to prevent.\n\n`additionalProperties` is false, so a specification needing extra members cannot compose this by `$ref` — `allOf` evaluates each subschema against the whole object and this one would reject them. vta/credentials/issue is that case: its response is this shape plus `supersedes` and `ext`, and it therefore states the members inline while `$ref`-ing the shared CredentialId. That is deliberate, not drift.",
+    "CredentialReference": {
+      "$anchor": "credentialReference",
+      "title": "CredentialReference",
       "type": "object",
       "additionalProperties": false,
+      "description": "A pointer to an issued credential, without the credential itself.\n\nThe counterpart to IssuedCredential, for the far more common case of *reading about* a credential rather than being handed one. A listing that embedded the signed credential in every row would grow with the size of the credentials rather than the number of them — a page of fifty is megabytes — and a reader that only needs to know a credential exists, when it lapses, and how to revoke it does not need the bytes.\n\nThe holder can always fetch the credential itself by `credentialId`, and a verifier can check revocation from the row's status-list slot without either. Reach for IssuedCredential only at the moment of minting, where the caller has no other way to receive what was just made for them.",
       "required": [
-        "credentialId",
-        "credential",
-        "expiresAt"
+        "credentialId"
       ],
       "properties": {
         "credentialId": {
           "$ref": "#/$defs/CredentialId"
         },
-        "credential": {
-          "type": "object",
-          "description": "The issued Verifiable Credential (W3C VC Data Model 2.0), signed by the issuer's key. Opaque to the framework."
-        },
         "issuedAt": {
           "type": "string",
           "format": "date-time",
           "description": "When the credential was minted."
         },
         "expiresAt": {
-          "type": "string",
+          "type": [
+            "string",
+            "null"
+          ],
           "format": "date-time",
-          "description": "When the credential's validUntil falls due."
+          "description": "When it lapses, or null when it does not."
         }
       }
     },

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

@@ -0,0 +1,193 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vtc/install/claim/finish/0.2/payload.schema.json
+ */
+
+export interface VTCInstallClaimFinishPayload {
+  installToken: string;
+  /**
+   * From claim/start.
+   */
+  registrationId: string;
+  /**
+   * RegisterPublicKeyCredential from navigator.credentials.create() (opaque here).
+   */
+  webauthnResponse: {};
+  ext?: Ext;
+}
+/**
+ * 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.
+ */
+export interface Ext {
+  [k: string]: unknown | undefined;
+}
+export interface VTCInstallClaimFinishResponsePayload {
+  /**
+   * Candidate admin DID derived from the passkey's Ed25519 public key.
+   */
+  adminDid: string;
+  /**
+   * EdDSA JWT (aud=vtc-install-session, 5min TTL) consumed by admin/bootstrap.
+   */
+  setupSessionToken: string;
+  ext?: Ext;
+}
+
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/vtc/install/claim/finish/0.2" as const;
+
+/** Stable alias for this specification's request payload shape. */
+export type Payload = VTCInstallClaimFinishPayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vtc/install/claim/finish/0.2#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTCInstallClaimFinishResponsePayload;
+
+/**
+ * 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/finish/0.2",
+  "title": "VTC Install Claim Finish — payload",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "installToken",
+    "registrationId",
+    "webauthnResponse"
+  ],
+  "properties": {
+    "installToken": {
+      "type": "string",
+      "minLength": 1
+    },
+    "registrationId": {
+      "type": "string",
+      "minLength": 1,
+      "description": "From claim/start."
+    },
+    "webauthnResponse": {
+      "type": "object",
+      "description": "RegisterPublicKeyCredential from navigator.credentials.create() (opaque here)."
+    },
+    "ext": {
+      "$ref": "#/$defs/Ext"
+    }
+  },
+  "$defs": {
+    "Response": {
+      "$anchor": "response",
+      "title": "VTC Install Claim Finish — response payload",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "adminDid",
+        "setupSessionToken"
+      ],
+      "properties": {
+        "adminDid": {
+          "type": "string",
+          "pattern": "^did:key:z",
+          "description": "Candidate admin DID derived from the passkey's Ed25519 public key."
+        },
+        "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 Finish — response payload",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "adminDid",
+        "setupSessionToken"
+      ],
+      "properties": {
+        "adminDid": {
+          "type": "string",
+          "pattern": "^did:key:z",
+          "description": "Candidate admin DID derived from the passkey's Ed25519 public key."
+        },
+        "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,
+  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,
+  payloadSchema: RESPONSE_PAYLOAD_SCHEMA,
+} as const;

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

@@ -8,6 +8,14 @@ export interface VTCInstallClaimStartPayload {
    * 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;
 }
 /**
@@ -68,6 +76,11 @@ export const PAYLOAD_SCHEMA = {
       "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"
     }

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

@@ -0,0 +1,189 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vtc/install/claim/start/0.2/payload.schema.json
+ */
+
+export interface VTCInstallClaimStartPayload {
+  /**
+   * 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;
+}
+/**
+ * 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.
+ */
+export interface Ext {
+  [k: string]: unknown | undefined;
+}
+export interface VTCInstallClaimStartResponsePayload {
+  /**
+   * Echoes the install token's jti (a UUID); pass it back to claim/finish.
+   */
+  registrationId: string;
+  /**
+   * WebAuthn PublicKeyCredentialCreationOptions (opaque here); pubKeyCredParams = [{public-key, -8}].
+   */
+  options: {};
+  ext?: Ext;
+}
+
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/vtc/install/claim/start/0.2" as const;
+
+/** Stable alias for this specification's request payload shape. */
+export type Payload = VTCInstallClaimStartPayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vtc/install/claim/start/0.2#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTCInstallClaimStartResponsePayload;
+
+/**
+ * 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/start/0.2",
+  "title": "VTC Install Claim Start — payload",
+  "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 Start — response payload",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "registrationId",
+        "options"
+      ],
+      "properties": {
+        "registrationId": {
+          "type": "string",
+          "minLength": 1,
+          "description": "Echoes the install token's jti (a UUID); pass it back to claim/finish."
+        },
+        "options": {
+          "type": "object",
+          "description": "WebAuthn PublicKeyCredentialCreationOptions (opaque here); pubKeyCredParams = [{public-key, -8}]."
+        },
+        "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 Start — response payload",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "registrationId",
+        "options"
+      ],
+      "properties": {
+        "registrationId": {
+          "type": "string",
+          "minLength": 1,
+          "description": "Echoes the install token's jti (a UUID); pass it back to claim/finish."
+        },
+        "options": {
+          "type": "object",
+          "description": "WebAuthn PublicKeyCredentialCreationOptions (opaque here); pubKeyCredParams = [{public-key, -8}]."
+        },
+        "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,
+  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,
+  payloadSchema: RESPONSE_PAYLOAD_SCHEMA,
+} as const;