@openvtc/trust-tasks 0.27.4 → 0.27.5

package/src/vta/_shared/0.1/service.ts

@@ -14,4 +14,4 @@ export interface ServiceDefinitionsSharedAcrossTheVtaServicesSpecFamily {
  * The definitions this shared schema publishes, hoisted to one declaration each.
  * See "../../../_shared/components.js".
  */
-export type { DrainEntry, RollbackResult, ServiceKind, ServiceMutationResult, ServiceState } from "../../../_shared/components.js";
+export type { DrainEntry_VtaV0_1 as DrainEntry, RollbackResult_VtaV0_1 as RollbackResult, ServiceKind, ServiceMutationResult_VtaV0_1 as ServiceMutationResult, ServiceState_VtaV0_1 as ServiceState } from "../../../_shared/components.js";

package/src/vta/_shared/0.8/service.ts

@@ -0,0 +1,17 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vta/_shared/0.8/service.schema.json
+ */
+
+/**
+ * A *service* is a transport the agent advertises in its own DID document: DIDComm mediation, a REST endpoint, TSP mediation, or a WebAuthn origin. Enabling or disabling one edits `service` in the agent's did:webvh document and republishes the signed log, so every mutation in this family produces a new log entry rather than flipping a runtime flag — which is why they all return `ServiceMutationResult`. These shapes are defined once because `enable`, `disable`, `update` and `rollback` return the same result, and `list` and `get` return the same state; an inline copy per task would fork the moment one of them gained a member.
+ */
+export interface ServiceDefinitionsSharedAcrossTheVtaServicesSpecFamily {
+  [k: string]: unknown | undefined;
+}
+
+/**
+ * The definitions this shared schema publishes, hoisted to one declaration each.
+ * See "../../../_shared/components.js".
+ */
+export type { DrainEntry_VtaV0_8 as DrainEntry, RollbackResult_VtaV0_8 as RollbackResult, ServiceKind, ServiceMutationResult_VtaV0_8 as ServiceMutationResult, ServiceState_VtaV0_8 as ServiceState } from "../../../_shared/components.js";

package/src/vta/attestation/mnemonic-export/1.1/payload.ts

@@ -0,0 +1,232 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vta/attestation/mnemonic-export/1.1/payload.schema.json
+ */
+
+import type { Ext } from "../../../../_shared/components.js";
+
+
+/**
+ * Asks an agent running in a trusted execution environment to release its seed mnemonic, once, sealed to a key only the producer holds. The outer document members (id, type, issuer, recipient, issuedAt, expiresAt, proof) are owned by the framework — SPEC §6.3.
+ */
+export interface VTAAttestationMnemonicExportPayload {
+  /**
+   * The Ed25519 did:key the mnemonic is sealed to, by its X25519 counterpart, so only the holder of this key's private half can open the answer. Over an end-to-end channel, a key generated for this one export on the machine that will hold the backup, and discarded after. On the signed first-boot path over a hop-by-hop channel, exactly the document's issuer: the key that signed the request.
+   */
+  clientDid: string;
+  /**
+   * Sixteen random bytes, base64url without padding. It becomes the sealed bundle's identifier, and the recipient binds it into its attestation quote, so an answer cannot be replayed to a different request.
+   */
+  nonce: string;
+  /**
+   * Operator-visible label for the request. Never sealed into the answer and never treated as an instruction.
+   */
+  label?: string;
+  /**
+   * Ecosystem-defined extension members per SPEC.md §4.5.1.
+   */
+  ext?: Ext;
+}
+export interface VTAAttestationMnemonicExportResponsePayload {
+  /**
+   * The ASCII-armored sealed bundle. It carries the mnemonic sealed to clientDid under a producer assertion whose attestation quote binds the client key, the nonce and the recipient's own sealing key.
+   */
+  bundle: string;
+  /**
+   * SHA-256 of the bundle, lowercase hex. The producer confirms it out of band before opening, so a substituted bundle is caught before any key is applied to it.
+   */
+  digest: string;
+  /**
+   * Seconds that were left in the export window when the mnemonic was released. Informational: the window is spent either way.
+   */
+  windowRemainingSeconds: 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 { Ext };
+
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/vta/attestation/mnemonic-export/1.1" as const;
+
+/** Stable alias for this specification's request payload shape. */
+export type Payload = VTAAttestationMnemonicExportPayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vta/attestation/mnemonic-export/1.1#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTAAttestationMnemonicExportResponsePayload;
+
+/**
+ * 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/vta/attestation/mnemonic-export/1.1",
+  "title": "VTA Attestation — Mnemonic Export — payload",
+  "description": "Asks an agent running in a trusted execution environment to release its seed mnemonic, once, sealed to a key only the producer holds. The outer document members (id, type, issuer, recipient, issuedAt, expiresAt, proof) are owned by the framework — SPEC §6.3.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "clientDid",
+    "nonce"
+  ],
+  "properties": {
+    "clientDid": {
+      "type": "string",
+      "pattern": "^did:key:z6Mk[1-9A-HJ-NP-Za-km-z]+$",
+      "maxLength": 128,
+      "description": "The Ed25519 did:key the mnemonic is sealed to, by its X25519 counterpart, so only the holder of this key's private half can open the answer. Over an end-to-end channel, a key generated for this one export on the machine that will hold the backup, and discarded after. On the signed first-boot path over a hop-by-hop channel, exactly the document's issuer: the key that signed the request."
+    },
+    "nonce": {
+      "type": "string",
+      "pattern": "^[A-Za-z0-9_-]{22}$",
+      "description": "Sixteen random bytes, base64url without padding. It becomes the sealed bundle's identifier, and the recipient binds it into its attestation quote, so an answer cannot be replayed to a different request."
+    },
+    "label": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 256,
+      "description": "Operator-visible label for the request. Never sealed into the answer and never treated as an instruction."
+    },
+    "ext": {
+      "$ref": "#/$defs/Ext",
+      "description": "Ecosystem-defined extension members per SPEC.md §4.5.1."
+    }
+  },
+  "$defs": {
+    "Response": {
+      "$anchor": "response",
+      "title": "VTA Attestation Mnemonic Export — response payload",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "bundle",
+        "digest",
+        "windowRemainingSeconds"
+      ],
+      "properties": {
+        "bundle": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 65536,
+          "description": "The ASCII-armored sealed bundle. It carries the mnemonic sealed to clientDid under a producer assertion whose attestation quote binds the client key, the nonce and the recipient's own sealing key."
+        },
+        "digest": {
+          "type": "string",
+          "pattern": "^[0-9a-f]{64}$",
+          "description": "SHA-256 of the bundle, lowercase hex. The producer confirms it out of band before opening, so a substituted bundle is caught before any key is applied to it."
+        },
+        "windowRemainingSeconds": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "Seconds that were left in the export window when the mnemonic was released. Informational: the window is spent either way."
+        },
+        "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-]+)+$"
+      }
+    }
+  }
+} 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": "VTA Attestation Mnemonic Export — response payload",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "bundle",
+        "digest",
+        "windowRemainingSeconds"
+      ],
+      "properties": {
+        "bundle": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 65536,
+          "description": "The ASCII-armored sealed bundle. It carries the mnemonic sealed to clientDid under a producer assertion whose attestation quote binds the client key, the nonce and the recipient's own sealing key."
+        },
+        "digest": {
+          "type": "string",
+          "pattern": "^[0-9a-f]{64}$",
+          "description": "SHA-256 of the bundle, lowercase hex. The producer confirms it out of band before opening, so a substituted bundle is caught before any key is applied to it."
+        },
+        "windowRemainingSeconds": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "Seconds that were left in the export window when the mnemonic was released. Informational: the window is spent either way."
+        },
+        "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-]+)+$"
+      }
+    }
+  }
+} 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;

package/src/vta/attestation/mnemonic-status/0.2/payload.ts

@@ -0,0 +1,203 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vta/attestation/mnemonic-status/0.2/payload.schema.json
+ */
+
+import type { Ext } from "../../../../_shared/components.js";
+
+
+/**
+ * An empty request. The outer document members are owned by the framework — SPEC §6.3.
+ */
+export interface VTAAttestationMnemonicStatusPayload {
+  ext?: Ext;
+}
+/**
+ * The mnemonic export guard's current state. Carried in a Trust Task document whose type is https://trusttasks.org/spec/vta/attestation/mnemonic-status/0.2#response.
+ */
+export interface VTAAttestationMnemonicStatusResponsePayload {
+  /**
+   * Whether the export window is currently open.
+   */
+  windowActive: boolean;
+  /**
+   * Whether the mnemonic has already been exported. Once true, no further export succeeds — the release is one-time.
+   */
+  alreadyExported: boolean;
+  /**
+   * Whether the guard still holds entropy. False on every boot after the first, since a VTA generates its seed only once.
+   */
+  entropyAvailable: boolean;
+  /**
+   * Seconds remaining in the export window; 0 once it has expired or was never active.
+   */
+  windowRemainingSeconds: number;
+  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/vta/attestation/mnemonic-status/0.2" as const;
+
+/** Stable alias for this specification's request payload shape. */
+export type Payload = VTAAttestationMnemonicStatusPayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vta/attestation/mnemonic-status/0.2#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTAAttestationMnemonicStatusResponsePayload;
+
+/**
+ * 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/vta/attestation/mnemonic-status/0.2",
+  "title": "VTA Attestation — Mnemonic Status — payload",
+  "description": "An empty request. The outer document members are owned by the framework — SPEC §6.3.",
+  "type": "object",
+  "additionalProperties": false,
+  "properties": {
+    "ext": {
+      "$ref": "#/$defs/Ext"
+    }
+  },
+  "$defs": {
+    "Response": {
+      "$anchor": "response",
+      "title": "VTA Attestation — Mnemonic Status — response payload",
+      "description": "The mnemonic export guard's current state. Carried in a Trust Task document whose type is https://trusttasks.org/spec/vta/attestation/mnemonic-status/0.2#response.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "windowActive",
+        "alreadyExported",
+        "entropyAvailable",
+        "windowRemainingSeconds"
+      ],
+      "properties": {
+        "windowActive": {
+          "type": "boolean",
+          "description": "Whether the export window is currently open."
+        },
+        "alreadyExported": {
+          "type": "boolean",
+          "description": "Whether the mnemonic has already been exported. Once true, no further export succeeds — the release is one-time."
+        },
+        "entropyAvailable": {
+          "type": "boolean",
+          "description": "Whether the guard still holds entropy. False on every boot after the first, since a VTA generates its seed only once."
+        },
+        "windowRemainingSeconds": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "Seconds remaining in the export window; 0 once it has expired or was never active."
+        },
+        "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": "VTA Attestation — Mnemonic Status — response payload",
+      "description": "The mnemonic export guard's current state. Carried in a Trust Task document whose type is https://trusttasks.org/spec/vta/attestation/mnemonic-status/0.2#response.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "windowActive",
+        "alreadyExported",
+        "entropyAvailable",
+        "windowRemainingSeconds"
+      ],
+      "properties": {
+        "windowActive": {
+          "type": "boolean",
+          "description": "Whether the export window is currently open."
+        },
+        "alreadyExported": {
+          "type": "boolean",
+          "description": "Whether the mnemonic has already been exported. Once true, no further export succeeds — the release is one-time."
+        },
+        "entropyAvailable": {
+          "type": "boolean",
+          "description": "Whether the guard still holds entropy. False on every boot after the first, since a VTA generates its seed only once."
+        },
+        "windowRemainingSeconds": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "Seconds remaining in the export window; 0 once it has expired or was never active."
+        },
+        "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: 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: true,
+  isRecipientRequired: true,
+  isIssuedAtRequired: false,
+  payloadSchema: RESPONSE_PAYLOAD_SCHEMA,
+} as const;