@openvtc/trust-tasks 0.21.5 → 0.21.7

package/dist/vta/health/details/0.1/payload.js

@@ -0,0 +1,258 @@
+/**
+ * Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
+ * Source: specs/vta/health/details/0.1/payload.schema.json
+ */
+/** Trust Task type URI. */
+export const TYPE_URI = "https://trusttasks.org/spec/vta/health/details/0.1";
+/** Trust Task response type URI (request type URI + "#response"). */
+export const RESPONSE_TYPE_URI = "https://trusttasks.org/spec/vta/health/details/0.1#response";
+/**
+ * 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/health/details/0.1",
+    "title": "VTA Health — Details — payload",
+    "description": "Asks a Verifiable Trust Agent for its public health flags: messaging configuration, seal and storage-encryption state, trusted-execution status and transport advertisement. Deliberately carries neither the software version nor the restore record — see vta/restore/status. 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": {
+        "TeeStatus": {
+            "title": "TeeStatus",
+            "description": "The trusted execution environment the agent detected at boot. Mirrors the response of vta/attestation/status/0.1 member for member, so a verifier reading either sees the same claim. A claim, not evidence: only vta/attestation/report proves what code runs.",
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+                "teeType",
+                "detected"
+            ],
+            "properties": {
+                "teeType": {
+                    "type": "string",
+                    "enum": [
+                        "nitro",
+                        "sev-snp",
+                        "simulated"
+                    ],
+                    "description": "nitro (AWS Nitro Enclaves), sev-snp (AMD SEV-SNP), or simulated (a development build whose evidence no verifier should accept)."
+                },
+                "detected": {
+                    "type": "boolean",
+                    "description": "Whether the agent found the platform at boot. False means it was configured for one it did not find."
+                },
+                "platformVersion": {
+                    "type": "string",
+                    "minLength": 1,
+                    "maxLength": 256,
+                    "description": "The platform's own version string, when it reports one. Informational."
+                }
+            }
+        },
+        "Response": {
+            "$anchor": "response",
+            "title": "VTA Health Details — response payload",
+            "description": "The agent's public report on its own deployment, carried in a Trust Task document whose type is https://trusttasks.org/spec/vta/health/details/0.1#response. Fixed for every asker. It MUST NOT carry the software version or the restore record, and additionalProperties: false means it cannot: those are served only by vta/restore/status. Failures use trust-task-error, not this shape.",
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+                "status",
+                "sealed",
+                "storageEncrypted",
+                "tspEnabled"
+            ],
+            "properties": {
+                "status": {
+                    "type": "string",
+                    "enum": [
+                        "ok"
+                    ],
+                    "description": "The agent's overall health. `ok` is the only value this version defines: an agent able to answer is serving."
+                },
+                "mediatorUrl": {
+                    "type": "string",
+                    "format": "uri",
+                    "maxLength": 2048,
+                    "description": "The endpoint of the mediator the agent's messaging routes through. Absent when the agent has no messaging configured."
+                },
+                "mediatorDid": {
+                    "type": "string",
+                    "pattern": "^did:",
+                    "maxLength": 2048,
+                    "description": "The DID of that mediator — the one DIDComm and TSP share. Absent when the agent has no messaging configured."
+                },
+                "teeStatus": {
+                    "$ref": "#/$defs/TeeStatus",
+                    "description": "The trusted execution environment the agent detected at boot. Absent when the agent has no attestation provider."
+                },
+                "sealed": {
+                    "type": "boolean",
+                    "description": "Whether the agent is sealed: offline, host-side commands that would change its access control, keys or configuration, or export secrets, are refused, so it is managed only through authenticated tasks."
+                },
+                "storageEncrypted": {
+                    "type": "boolean",
+                    "description": "Whether the agent's key store is encrypted at rest."
+                },
+                "tspEnabled": {
+                    "type": "boolean",
+                    "description": "Whether the agent advertises the Trust Spanning Protocol as a transport. TSP routes through the same mediator as DIDComm (mediatorDid), so no separate endpoint is reported."
+                },
+                "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 {@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": {
+        "TeeStatus": {
+            "title": "TeeStatus",
+            "description": "The trusted execution environment the agent detected at boot. Mirrors the response of vta/attestation/status/0.1 member for member, so a verifier reading either sees the same claim. A claim, not evidence: only vta/attestation/report proves what code runs.",
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+                "teeType",
+                "detected"
+            ],
+            "properties": {
+                "teeType": {
+                    "type": "string",
+                    "enum": [
+                        "nitro",
+                        "sev-snp",
+                        "simulated"
+                    ],
+                    "description": "nitro (AWS Nitro Enclaves), sev-snp (AMD SEV-SNP), or simulated (a development build whose evidence no verifier should accept)."
+                },
+                "detected": {
+                    "type": "boolean",
+                    "description": "Whether the agent found the platform at boot. False means it was configured for one it did not find."
+                },
+                "platformVersion": {
+                    "type": "string",
+                    "minLength": 1,
+                    "maxLength": 256,
+                    "description": "The platform's own version string, when it reports one. Informational."
+                }
+            }
+        },
+        "Response": {
+            "$anchor": "response",
+            "title": "VTA Health Details — response payload",
+            "description": "The agent's public report on its own deployment, carried in a Trust Task document whose type is https://trusttasks.org/spec/vta/health/details/0.1#response. Fixed for every asker. It MUST NOT carry the software version or the restore record, and additionalProperties: false means it cannot: those are served only by vta/restore/status. Failures use trust-task-error, not this shape.",
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+                "status",
+                "sealed",
+                "storageEncrypted",
+                "tspEnabled"
+            ],
+            "properties": {
+                "status": {
+                    "type": "string",
+                    "enum": [
+                        "ok"
+                    ],
+                    "description": "The agent's overall health. `ok` is the only value this version defines: an agent able to answer is serving."
+                },
+                "mediatorUrl": {
+                    "type": "string",
+                    "format": "uri",
+                    "maxLength": 2048,
+                    "description": "The endpoint of the mediator the agent's messaging routes through. Absent when the agent has no messaging configured."
+                },
+                "mediatorDid": {
+                    "type": "string",
+                    "pattern": "^did:",
+                    "maxLength": 2048,
+                    "description": "The DID of that mediator — the one DIDComm and TSP share. Absent when the agent has no messaging configured."
+                },
+                "teeStatus": {
+                    "$ref": "#/$defs/TeeStatus",
+                    "description": "The trusted execution environment the agent detected at boot. Absent when the agent has no attestation provider."
+                },
+                "sealed": {
+                    "type": "boolean",
+                    "description": "Whether the agent is sealed: offline, host-side commands that would change its access control, keys or configuration, or export secrets, are refused, so it is managed only through authenticated tasks."
+                },
+                "storageEncrypted": {
+                    "type": "boolean",
+                    "description": "Whether the agent's key store is encrypted at rest."
+                },
+                "tspEnabled": {
+                    "type": "boolean",
+                    "description": "Whether the agent advertises the Trust Spanning Protocol as a transport. TSP routes through the same mediator as DIDComm (mediatorDid), so no separate endpoint is reported."
+                },
+                "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-]+)+$"
+            }
+        }
+    }
+};
+/**
+ * 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,
+};
+/**
+ * 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,
+};
+//# sourceMappingURL=payload.js.map

package/dist/vta/health/details/0.1/payload.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"payload.js","sourceRoot":"","sources":["../../../../../src/vta/health/details/0.1/payload.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAqEH,2BAA2B;AAC3B,MAAM,CAAC,MAAM,QAAQ,GAAG,oDAA6D,CAAC;AAKtF,qEAAqE;AACrE,MAAM,CAAC,MAAM,iBAAiB,GAAG,6DAAsE,CAAC;AAKxG;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG;IAC5B,SAAS,EAAE,8CAA8C;IACzD,KAAK,EAAE,oDAAoD;IAC3D,OAAO,EAAE,gCAAgC;IACzC,aAAa,EAAE,2aAA2a;IAC1b,MAAM,EAAE,QAAQ;IAChB,sBAAsB,EAAE,KAAK;IAC7B,YAAY,EAAE;QACZ,KAAK,EAAE;YACL,MAAM,EAAE,aAAa;YACrB,aAAa,EAAE,yDAAyD;SACzE;KACF;IACD,OAAO,EAAE;QACP,WAAW,EAAE;YACX,OAAO,EAAE,WAAW;YACpB,aAAa,EAAE,iQAAiQ;YAChR,MAAM,EAAE,QAAQ;YAChB,sBAAsB,EAAE,KAAK;YAC7B,UAAU,EAAE;gBACV,SAAS;gBACT,UAAU;aACX;YACD,YAAY,EAAE;gBACZ,SAAS,EAAE;oBACT,MAAM,EAAE,QAAQ;oBAChB,MAAM,EAAE;wBACN,OAAO;wBACP,SAAS;wBACT,WAAW;qBACZ;oBACD,aAAa,EAAE,iIAAiI;iBACjJ;gBACD,UAAU,EAAE;oBACV,MAAM,EAAE,SAAS;oBACjB,aAAa,EAAE,sGAAsG;iBACtH;gBACD,iBAAiB,EAAE;oBACjB,MAAM,EAAE,QAAQ;oBAChB,WAAW,EAAE,CAAC;oBACd,WAAW,EAAE,GAAG;oBAChB,aAAa,EAAE,wEAAwE;iBACxF;aACF;SACF;QACD,UAAU,EAAE;YACV,SAAS,EAAE,UAAU;YACrB,OAAO,EAAE,uCAAuC;YAChD,aAAa,EAAE,gYAAgY;YAC/Y,MAAM,EAAE,QAAQ;YAChB,sBAAsB,EAAE,KAAK;YAC7B,UAAU,EAAE;gBACV,QAAQ;gBACR,QAAQ;gBACR,kBAAkB;gBAClB,YAAY;aACb;YACD,YAAY,EAAE;gBACZ,QAAQ,EAAE;oBACR,MAAM,EAAE,QAAQ;oBAChB,MAAM,EAAE;wBACN,IAAI;qBACL;oBACD,aAAa,EAAE,8GAA8G;iBAC9H;gBACD,aAAa,EAAE;oBACb,MAAM,EAAE,QAAQ;oBAChB,QAAQ,EAAE,KAAK;oBACf,WAAW,EAAE,IAAI;oBACjB,aAAa,EAAE,uHAAuH;iBACvI;gBACD,aAAa,EAAE;oBACb,MAAM,EAAE,QAAQ;oBAChB,SAAS,EAAE,OAAO;oBAClB,WAAW,EAAE,IAAI;oBACjB,aAAa,EAAE,8GAA8G;iBAC9H;gBACD,WAAW,EAAE;oBACX,MAAM,EAAE,mBAAmB;oBAC3B,aAAa,EAAE,kHAAkH;iBAClI;gBACD,QAAQ,EAAE;oBACR,MAAM,EAAE,SAAS;oBACjB,aAAa,EAAE,0MAA0M;iBAC1N;gBACD,kBAAkB,EAAE;oBAClB,MAAM,EAAE,SAAS;oBACjB,aAAa,EAAE,qDAAqD;iBACrE;gBACD,YAAY,EAAE;oBACZ,MAAM,EAAE,SAAS;oBACjB,aAAa,EAAE,8KAA8K;iBAC9L;gBACD,KAAK,EAAE;oBACL,MAAM,EAAE,aAAa;oBACrB,aAAa,EAAE,yDAAyD;iBACzE;aACF;SACF;QACD,KAAK,EAAE;YACL,OAAO,EAAE,KAAK;YACd,aAAa,EAAE,uKAAuK;YACtL,MAAM,EAAE,QAAQ;YAChB,eAAe,EAAE,CAAC;YAClB,sBAAsB,EAAE,IAAI;YAC5B,eAAe,EAAE;gBACf,SAAS,EAAE,mCAAmC;aAC/C;SACF;KACF;CACO,CAAC;AAEX,mEAAmE;AACnE,MAAM,CAAC,MAAM,uBAAuB,GAAG;IACrC,SAAS,EAAE,8CAA8C;IACzD,MAAM,EAAE,kBAAkB;IAC1B,OAAO,EAAE;QACP,WAAW,EAAE;YACX,OAAO,EAAE,WAAW;YACpB,aAAa,EAAE,iQAAiQ;YAChR,MAAM,EAAE,QAAQ;YAChB,sBAAsB,EAAE,KAAK;YAC7B,UAAU,EAAE;gBACV,SAAS;gBACT,UAAU;aACX;YACD,YAAY,EAAE;gBACZ,SAAS,EAAE;oBACT,MAAM,EAAE,QAAQ;oBAChB,MAAM,EAAE;wBACN,OAAO;wBACP,SAAS;wBACT,WAAW;qBACZ;oBACD,aAAa,EAAE,iIAAiI;iBACjJ;gBACD,UAAU,EAAE;oBACV,MAAM,EAAE,SAAS;oBACjB,aAAa,EAAE,sGAAsG;iBACtH;gBACD,iBAAiB,EAAE;oBACjB,MAAM,EAAE,QAAQ;oBAChB,WAAW,EAAE,CAAC;oBACd,WAAW,EAAE,GAAG;oBAChB,aAAa,EAAE,wEAAwE;iBACxF;aACF;SACF;QACD,UAAU,EAAE;YACV,SAAS,EAAE,UAAU;YACrB,OAAO,EAAE,uCAAuC;YAChD,aAAa,EAAE,gYAAgY;YAC/Y,MAAM,EAAE,QAAQ;YAChB,sBAAsB,EAAE,KAAK;YAC7B,UAAU,EAAE;gBACV,QAAQ;gBACR,QAAQ;gBACR,kBAAkB;gBAClB,YAAY;aACb;YACD,YAAY,EAAE;gBACZ,QAAQ,EAAE;oBACR,MAAM,EAAE,QAAQ;oBAChB,MAAM,EAAE;wBACN,IAAI;qBACL;oBACD,aAAa,EAAE,8GAA8G;iBAC9H;gBACD,aAAa,EAAE;oBACb,MAAM,EAAE,QAAQ;oBAChB,QAAQ,EAAE,KAAK;oBACf,WAAW,EAAE,IAAI;oBACjB,aAAa,EAAE,uHAAuH;iBACvI;gBACD,aAAa,EAAE;oBACb,MAAM,EAAE,QAAQ;oBAChB,SAAS,EAAE,OAAO;oBAClB,WAAW,EAAE,IAAI;oBACjB,aAAa,EAAE,8GAA8G;iBAC9H;gBACD,WAAW,EAAE;oBACX,MAAM,EAAE,mBAAmB;oBAC3B,aAAa,EAAE,kHAAkH;iBAClI;gBACD,QAAQ,EAAE;oBACR,MAAM,EAAE,SAAS;oBACjB,aAAa,EAAE,0MAA0M;iBAC1N;gBACD,kBAAkB,EAAE;oBAClB,MAAM,EAAE,SAAS;oBACjB,aAAa,EAAE,qDAAqD;iBACrE;gBACD,YAAY,EAAE;oBACZ,MAAM,EAAE,SAAS;oBACjB,aAAa,EAAE,8KAA8K;iBAC9L;gBACD,KAAK,EAAE;oBACL,MAAM,EAAE,aAAa;oBACrB,aAAa,EAAE,yDAAyD;iBACzE;aACF;SACF;QACD,KAAK,EAAE;YACL,OAAO,EAAE,KAAK;YACd,aAAa,EAAE,uKAAuK;YACtL,MAAM,EAAE,QAAQ;YAChB,eAAe,EAAE,CAAC;YAClB,sBAAsB,EAAE,IAAI;YAC5B,eAAe,EAAE;gBACf,SAAS,EAAE,mCAAmC;aAC/C;SACF;KACF;CACO,CAAC;AAEX;;;;;GAKG;AACH,MAAM,CAAC,MAAM,IAAI,GAAG;IAClB,OAAO,EAAE,QAAQ;IACjB,QAAQ,EAAE,KAAK;IACf,eAAe,EAAE,KAAK;IACtB,mBAAmB,EAAE,IAAI;IACzB,kBAAkB,EAAE,KAAK;IACzB,aAAa,EAAE,cAAc;CACrB,CAAC;AAEX;;;;GAIG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG;IAC3B,OAAO,EAAE,iBAAiB;IAC1B,QAAQ,EAAE,KAAK;IACf,eAAe,EAAE,IAAI;IACrB,mBAAmB,EAAE,IAAI;IACzB,kBAAkB,EAAE,KAAK;IACzB,aAAa,EAAE,uBAAuB;CAC9B,CAAC"}