@openvtc/trust-tasks 0.21.5 → 0.21.7

package/src/vta/restore/status/0.1/payload.ts

@@ -0,0 +1,379 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vta/restore/status/0.1/payload.schema.json
+ */
+
+import type { Ext } from "../../../../_shared/components.js";
+
+
+/**
+ * The kind of deployment an agent's state lives in, as a backup restore classifies it: plain (an unencrypted store), hardened (the store encrypted under a key derived from the agent's seed), or tee (seed and signing keys sealed to an attested trusted execution environment).
+ */
+export type DeploymentEnvironment = "plain" | "hardened" | "tee";
+
+/**
+ * An administrator asks a Verifiable Trust Agent whether its current state derives from a backup restore, and which software version it runs. The payload carries nothing. The outer document members (id, type, issuer, recipient, issuedAt, expiresAt, proof) are owned by the framework — SPEC §6.3.
+ */
+export interface VTARestoreStatusPayload {
+  /**
+   * Ecosystem-defined extension members per SPEC.md §4.5.1.
+   */
+  ext?: Ext;
+}
+/**
+ * Carried in a Trust Task document whose type is https://trusttasks.org/spec/vta/restore/status/0.1#response. Failures use trust-task-error, not this shape.
+ */
+export interface VTARestoreStatusResponsePayload {
+  /**
+   * The agent's software version, as its build reports it.
+   */
+  version: string;
+  /**
+   * Whether the agent's current state derives from a backup restore. Always present, so 'not restored' is stated rather than inferred from an absent member. True exactly when `restore` is present.
+   */
+  restored: boolean;
+  restore?: RestoreRecord;
+  /**
+   * Ecosystem-defined extension members per SPEC.md §4.5.1.
+   */
+  ext?: Ext;
+}
+/**
+ * The restore the agent's current state derives from. Present exactly when `restored` is true.
+ */
+export interface RestoreRecord {
+  /**
+   * When the restored state was applied — the boot at which it replaced the agent's previous state.
+   */
+  appliedAt: string;
+  /**
+   * When the restore was committed and staged for the next boot.
+   */
+  stagedAt: string;
+  /**
+   * The DID of the administrator who committed the restore.
+   */
+  stagedBy: string;
+  /**
+   * The DID of the agent the backup was taken from, when the backup records one. Differs from the responding agent's own DID when a restore replaced its identity.
+   */
+  sourceDid?: string;
+  sourceEnvironment?: DeploymentEnvironment;
+  targetEnvironment: DeploymentEnvironment;
+  /**
+   * Identifiers of keys whose records came back without their material: keys the agent generated internally and never exports, so no backup carries them. Absent when none were lost.
+   *
+   * @maxItems 10000
+   */
+  internalKeysLost?: string[];
+  /**
+   * DIDs whose hosting registrations the restore detached because it replaced a different identity; each must be registered with its host again. Absent when none were.
+   *
+   * @maxItems 10000
+   */
+  hostedDidsDetached?: string[];
+}
+
+/** 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/restore/status/0.1" as const;
+
+/** Stable alias for this specification's request payload shape. */
+export type Payload = VTARestoreStatusPayload;
+
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vta/restore/status/0.1#response" as const;
+
+/** Stable alias for this specification's success-response payload shape. */
+export type Response = VTARestoreStatusResponsePayload;
+
+/**
+ * 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/restore/status/0.1",
+  "title": "VTA Restore — Status — payload",
+  "description": "An administrator asks a Verifiable Trust Agent whether its current state derives from a backup restore, and which software version it runs. The payload carries nothing. The outer document members (id, type, issuer, recipient, issuedAt, expiresAt, proof) are owned by the framework — SPEC §6.3.",
+  "type": "object",
+  "additionalProperties": false,
+  "properties": {
+    "ext": {
+      "$ref": "#/$defs/Ext",
+      "description": "Ecosystem-defined extension members per SPEC.md §4.5.1."
+    }
+  },
+  "$defs": {
+    "DeploymentEnvironment": {
+      "title": "DeploymentEnvironment",
+      "description": "The kind of deployment an agent's state lives in, as a backup restore classifies it: plain (an unencrypted store), hardened (the store encrypted under a key derived from the agent's seed), or tee (seed and signing keys sealed to an attested trusted execution environment).",
+      "type": "string",
+      "enum": [
+        "plain",
+        "hardened",
+        "tee"
+      ]
+    },
+    "RestoreRecord": {
+      "title": "RestoreRecord",
+      "description": "The backup restore the agent's current state derives from (VTI-VTA-051). `sourceEnvironment` is the kind of deployment the backup was taken from, present when the backup records it; `targetEnvironment` is the kind the restore was applied to — this agent's.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "appliedAt",
+        "stagedAt",
+        "stagedBy",
+        "targetEnvironment"
+      ],
+      "properties": {
+        "appliedAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "When the restored state was applied — the boot at which it replaced the agent's previous state."
+        },
+        "stagedAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "When the restore was committed and staged for the next boot."
+        },
+        "stagedBy": {
+          "type": "string",
+          "pattern": "^did:",
+          "maxLength": 2048,
+          "description": "The DID of the administrator who committed the restore."
+        },
+        "sourceDid": {
+          "type": "string",
+          "pattern": "^did:",
+          "maxLength": 2048,
+          "description": "The DID of the agent the backup was taken from, when the backup records one. Differs from the responding agent's own DID when a restore replaced its identity."
+        },
+        "sourceEnvironment": {
+          "$ref": "#/$defs/DeploymentEnvironment"
+        },
+        "targetEnvironment": {
+          "$ref": "#/$defs/DeploymentEnvironment"
+        },
+        "internalKeysLost": {
+          "type": "array",
+          "items": {
+            "type": "string",
+            "minLength": 1,
+            "maxLength": 256
+          },
+          "maxItems": 10000,
+          "description": "Identifiers of keys whose records came back without their material: keys the agent generated internally and never exports, so no backup carries them. Absent when none were lost."
+        },
+        "hostedDidsDetached": {
+          "type": "array",
+          "items": {
+            "type": "string",
+            "pattern": "^did:",
+            "maxLength": 2048
+          },
+          "maxItems": 10000,
+          "description": "DIDs whose hosting registrations the restore detached because it replaced a different identity; each must be registered with its host again. Absent when none were."
+        }
+      }
+    },
+    "Response": {
+      "$anchor": "response",
+      "title": "VTA Restore Status — response payload",
+      "description": "Carried in a Trust Task document whose type is https://trusttasks.org/spec/vta/restore/status/0.1#response. Failures use trust-task-error, not this shape.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "version",
+        "restored"
+      ],
+      "properties": {
+        "version": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 64,
+          "description": "The agent's software version, as its build reports it."
+        },
+        "restored": {
+          "type": "boolean",
+          "description": "Whether the agent's current state derives from a backup restore. Always present, so 'not restored' is stated rather than inferred from an absent member. True exactly when `restore` is present."
+        },
+        "restore": {
+          "$ref": "#/$defs/RestoreRecord",
+          "description": "The restore the agent's current state derives from. Present exactly when `restored` is true."
+        },
+        "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": {
+    "DeploymentEnvironment": {
+      "title": "DeploymentEnvironment",
+      "description": "The kind of deployment an agent's state lives in, as a backup restore classifies it: plain (an unencrypted store), hardened (the store encrypted under a key derived from the agent's seed), or tee (seed and signing keys sealed to an attested trusted execution environment).",
+      "type": "string",
+      "enum": [
+        "plain",
+        "hardened",
+        "tee"
+      ]
+    },
+    "RestoreRecord": {
+      "title": "RestoreRecord",
+      "description": "The backup restore the agent's current state derives from (VTI-VTA-051). `sourceEnvironment` is the kind of deployment the backup was taken from, present when the backup records it; `targetEnvironment` is the kind the restore was applied to — this agent's.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "appliedAt",
+        "stagedAt",
+        "stagedBy",
+        "targetEnvironment"
+      ],
+      "properties": {
+        "appliedAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "When the restored state was applied — the boot at which it replaced the agent's previous state."
+        },
+        "stagedAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "When the restore was committed and staged for the next boot."
+        },
+        "stagedBy": {
+          "type": "string",
+          "pattern": "^did:",
+          "maxLength": 2048,
+          "description": "The DID of the administrator who committed the restore."
+        },
+        "sourceDid": {
+          "type": "string",
+          "pattern": "^did:",
+          "maxLength": 2048,
+          "description": "The DID of the agent the backup was taken from, when the backup records one. Differs from the responding agent's own DID when a restore replaced its identity."
+        },
+        "sourceEnvironment": {
+          "$ref": "#/$defs/DeploymentEnvironment"
+        },
+        "targetEnvironment": {
+          "$ref": "#/$defs/DeploymentEnvironment"
+        },
+        "internalKeysLost": {
+          "type": "array",
+          "items": {
+            "type": "string",
+            "minLength": 1,
+            "maxLength": 256
+          },
+          "maxItems": 10000,
+          "description": "Identifiers of keys whose records came back without their material: keys the agent generated internally and never exports, so no backup carries them. Absent when none were lost."
+        },
+        "hostedDidsDetached": {
+          "type": "array",
+          "items": {
+            "type": "string",
+            "pattern": "^did:",
+            "maxLength": 2048
+          },
+          "maxItems": 10000,
+          "description": "DIDs whose hosting registrations the restore detached because it replaced a different identity; each must be registered with its host again. Absent when none were."
+        }
+      }
+    },
+    "Response": {
+      "$anchor": "response",
+      "title": "VTA Restore Status — response payload",
+      "description": "Carried in a Trust Task document whose type is https://trusttasks.org/spec/vta/restore/status/0.1#response. Failures use trust-task-error, not this shape.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "version",
+        "restored"
+      ],
+      "properties": {
+        "version": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 64,
+          "description": "The agent's software version, as its build reports it."
+        },
+        "restored": {
+          "type": "boolean",
+          "description": "Whether the agent's current state derives from a backup restore. Always present, so 'not restored' is stated rather than inferred from an absent member. True exactly when `restore` is present."
+        },
+        "restore": {
+          "$ref": "#/$defs/RestoreRecord",
+          "description": "The restore the agent's current state derives from. Present exactly when `restored` is true."
+        },
+        "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;