@openvtc/trust-tasks 0.20.8 → 0.21.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +233 -0
- package/dist/_shared/components.d.ts +299 -2
- package/dist/_shared/components.d.ts.map +1 -1
- package/dist/auth/passkey/enroll/invite/0.2/payload.d.ts +456 -0
- package/dist/auth/passkey/enroll/invite/0.2/payload.d.ts.map +1 -0
- package/dist/auth/passkey/enroll/invite/0.2/payload.js +248 -0
- package/dist/auth/passkey/enroll/invite/0.2/payload.js.map +1 -0
- package/dist/auth/passkey/enroll/redeem/finish/0.1/payload.d.ts +728 -0
- package/dist/auth/passkey/enroll/redeem/finish/0.1/payload.d.ts.map +1 -0
- package/dist/auth/passkey/enroll/redeem/finish/0.1/payload.js +430 -0
- package/dist/auth/passkey/enroll/redeem/finish/0.1/payload.js.map +1 -0
- package/dist/auth/passkey/enroll/redeem/start/0.1/payload.d.ts +1043 -0
- package/dist/auth/passkey/enroll/redeem/start/0.1/payload.d.ts.map +1 -0
- package/dist/auth/passkey/enroll/redeem/start/0.1/payload.js +628 -0
- package/dist/auth/passkey/enroll/redeem/start/0.1/payload.js.map +1 -0
- package/dist/auth/passkey/revoke/finish/0.2/payload.d.ts +533 -0
- package/dist/auth/passkey/revoke/finish/0.2/payload.d.ts.map +1 -0
- package/dist/auth/passkey/revoke/finish/0.2/payload.js +315 -0
- package/dist/auth/passkey/revoke/finish/0.2/payload.js.map +1 -0
- package/dist/auth/passkey/revoke/start/0.2/payload.d.ts +511 -0
- package/dist/auth/passkey/revoke/start/0.2/payload.d.ts.map +1 -0
- package/dist/auth/passkey/revoke/start/0.2/payload.js +297 -0
- package/dist/auth/passkey/revoke/start/0.2/payload.js.map +1 -0
- package/dist/auth/step-up/approve-response/0.5/payload.d.ts +887 -0
- package/dist/auth/step-up/approve-response/0.5/payload.d.ts.map +1 -0
- package/dist/auth/step-up/approve-response/0.5/payload.js +504 -0
- package/dist/auth/step-up/approve-response/0.5/payload.js.map +1 -0
- package/dist/device/list/0.1/payload.d.ts +4 -4
- package/dist/device/list/0.1/payload.d.ts.map +1 -1
- package/dist/device/list/0.1/payload.js +4 -2
- package/dist/device/list/0.1/payload.js.map +1 -1
- package/dist/device/list/0.2/payload.d.ts +4 -4
- package/dist/device/list/0.2/payload.d.ts.map +1 -1
- package/dist/device/list/0.2/payload.js +4 -2
- package/dist/device/list/0.2/payload.js.map +1 -1
- package/dist/device/register/0.1/payload.d.ts +4 -4
- package/dist/device/register/0.1/payload.d.ts.map +1 -1
- package/dist/device/register/0.1/payload.js +4 -2
- package/dist/device/register/0.1/payload.js.map +1 -1
- package/dist/device/register/0.2/payload.d.ts +4 -4
- package/dist/device/register/0.2/payload.d.ts.map +1 -1
- package/dist/device/register/0.2/payload.js +4 -2
- package/dist/device/register/0.2/payload.js.map +1 -1
- package/dist/git-ns/_shared/0.4/git-ns.d.ts +16 -0
- package/dist/git-ns/_shared/0.4/git-ns.d.ts.map +1 -0
- package/dist/git-ns/_shared/0.4/git-ns.js +6 -0
- package/dist/git-ns/_shared/0.4/git-ns.js.map +1 -0
- package/dist/git-ns/account/link-status/0.1/payload.d.ts +2 -2
- package/dist/git-ns/account/link-status/0.1/payload.js +2 -2
- package/dist/git-ns/account/link-status/0.1/payload.js.map +1 -1
- package/dist/git-ns/account/unlink/0.1/payload.d.ts +411 -0
- package/dist/git-ns/account/unlink/0.1/payload.d.ts.map +1 -0
- package/dist/git-ns/account/unlink/0.1/payload.js +228 -0
- package/dist/git-ns/account/unlink/0.1/payload.js.map +1 -0
- package/dist/git-ns/bridge/event/0.3/payload.d.ts +1682 -0
- package/dist/git-ns/bridge/event/0.3/payload.d.ts.map +1 -0
- package/dist/git-ns/bridge/event/0.3/payload.js +971 -0
- package/dist/git-ns/bridge/event/0.3/payload.js.map +1 -0
- package/dist/git-ns/bridge/job/0.4/payload.d.ts +1068 -0
- package/dist/git-ns/bridge/job/0.4/payload.d.ts.map +1 -0
- package/dist/git-ns/bridge/job/0.4/payload.js +573 -0
- package/dist/git-ns/bridge/job/0.4/payload.js.map +1 -0
- package/dist/git-ns/drift/resolve/0.3/payload.d.ts +1072 -0
- package/dist/git-ns/drift/resolve/0.3/payload.d.ts.map +1 -0
- package/dist/git-ns/drift/resolve/0.3/payload.js +634 -0
- package/dist/git-ns/drift/resolve/0.3/payload.js.map +1 -0
- package/dist/git-ns/namespace/reseat/0.3/payload.d.ts +515 -0
- package/dist/git-ns/namespace/reseat/0.3/payload.d.ts.map +1 -0
- package/dist/git-ns/namespace/reseat/0.3/payload.js +296 -0
- package/dist/git-ns/namespace/reseat/0.3/payload.js.map +1 -0
- package/dist/git-ns/repo/create/0.3/payload.d.ts +1101 -0
- package/dist/git-ns/repo/create/0.3/payload.d.ts.map +1 -0
- package/dist/git-ns/repo/create/0.3/payload.js +646 -0
- package/dist/git-ns/repo/create/0.3/payload.js.map +1 -0
- package/dist/git-ns/right/break-glass/0.1/payload.d.ts +685 -0
- package/dist/git-ns/right/break-glass/0.1/payload.d.ts.map +1 -0
- package/dist/git-ns/right/break-glass/0.1/payload.js +397 -0
- package/dist/git-ns/right/break-glass/0.1/payload.js.map +1 -0
- package/dist/git-ns/right/break-glass-notice/0.1/payload.d.ts +384 -0
- package/dist/git-ns/right/break-glass-notice/0.1/payload.d.ts.map +1 -0
- package/dist/git-ns/right/break-glass-notice/0.1/payload.js +216 -0
- package/dist/git-ns/right/break-glass-notice/0.1/payload.js.map +1 -0
- package/dist/git-ns/right/grant/0.3/payload.d.ts +678 -0
- package/dist/git-ns/right/grant/0.3/payload.d.ts.map +1 -0
- package/dist/git-ns/right/grant/0.3/payload.js +383 -0
- package/dist/git-ns/right/grant/0.3/payload.js.map +1 -0
- package/dist/git-ns/right/ratify/0.1/payload.d.ts +702 -0
- package/dist/git-ns/right/ratify/0.1/payload.d.ts.map +1 -0
- package/dist/git-ns/right/ratify/0.1/payload.js +404 -0
- package/dist/git-ns/right/ratify/0.1/payload.js.map +1 -0
- package/dist/git-ns/right/revoke/0.3/payload.d.ts +664 -0
- package/dist/git-ns/right/revoke/0.3/payload.d.ts.map +1 -0
- package/dist/git-ns/right/revoke/0.3/payload.js +378 -0
- package/dist/git-ns/right/revoke/0.3/payload.js.map +1 -0
- package/dist/git-ns/roles/reproject/0.1/payload.d.ts +325 -0
- package/dist/git-ns/roles/reproject/0.1/payload.d.ts.map +1 -0
- package/dist/git-ns/roles/reproject/0.1/payload.js +176 -0
- package/dist/git-ns/roles/reproject/0.1/payload.js.map +1 -0
- package/dist/git-ns/view/0.1/payload.d.ts +2 -2
- package/dist/git-ns/view/0.1/payload.js +2 -2
- package/dist/git-ns/view/0.1/payload.js.map +1 -1
- package/dist/git-ns/view/0.2/payload.d.ts +2 -2
- package/dist/git-ns/view/0.2/payload.js +2 -2
- package/dist/git-ns/view/0.2/payload.js.map +1 -1
- package/dist/git-ns/view/0.3/payload.d.ts +2 -2
- package/dist/git-ns/view/0.3/payload.js +2 -2
- package/dist/git-ns/view/0.3/payload.js.map +1 -1
- package/dist/git-ns/view/0.4/payload.d.ts +1696 -0
- package/dist/git-ns/view/0.4/payload.d.ts.map +1 -0
- package/dist/git-ns/view/0.4/payload.js +1012 -0
- package/dist/git-ns/view/0.4/payload.js.map +1 -0
- package/dist/index.d.ts +30 -0
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +30 -0
- package/dist/index.js.map +1 -1
- package/dist/messaging/message/status/0.1/payload.d.ts +372 -0
- package/dist/messaging/message/status/0.1/payload.d.ts.map +1 -0
- package/dist/messaging/message/status/0.1/payload.js +214 -0
- package/dist/messaging/message/status/0.1/payload.js.map +1 -0
- package/dist/vta/_shared/0.3/did-key-roles.d.ts +16 -0
- package/dist/vta/_shared/0.3/did-key-roles.d.ts.map +1 -0
- package/dist/vta/_shared/0.3/did-key-roles.js +6 -0
- package/dist/vta/_shared/0.3/did-key-roles.js.map +1 -0
- package/dist/vta/attestation/mnemonic-export/1.0/payload.d.ts +326 -0
- package/dist/vta/attestation/mnemonic-export/1.0/payload.d.ts.map +1 -0
- package/dist/vta/attestation/mnemonic-export/1.0/payload.js +175 -0
- package/dist/vta/attestation/mnemonic-export/1.0/payload.js.map +1 -0
- package/dist/vta/webvh/dids/keys/add/1.0/payload.d.ts +1914 -0
- package/dist/vta/webvh/dids/keys/add/1.0/payload.d.ts.map +1 -0
- package/dist/vta/webvh/dids/keys/add/1.0/payload.js +1128 -0
- package/dist/vta/webvh/dids/keys/add/1.0/payload.js.map +1 -0
- package/dist/vta/webvh/dids/keys/list/1.0/payload.d.ts +1603 -0
- package/dist/vta/webvh/dids/keys/list/1.0/payload.d.ts.map +1 -0
- package/dist/vta/webvh/dids/keys/list/1.0/payload.js +942 -0
- package/dist/vta/webvh/dids/keys/list/1.0/payload.js.map +1 -0
- package/dist/vta/webvh/dids/keys/retire/1.0/payload.d.ts +1914 -0
- package/dist/vta/webvh/dids/keys/retire/1.0/payload.d.ts.map +1 -0
- package/dist/vta/webvh/dids/keys/retire/1.0/payload.js +1123 -0
- package/dist/vta/webvh/dids/keys/retire/1.0/payload.js.map +1 -0
- package/dist/vta/webvh/dids/keys/revoke/1.0/payload.d.ts +2021 -0
- package/dist/vta/webvh/dids/keys/revoke/1.0/payload.d.ts.map +1 -0
- package/dist/vta/webvh/dids/keys/revoke/1.0/payload.js +1168 -0
- package/dist/vta/webvh/dids/keys/revoke/1.0/payload.js.map +1 -0
- package/dist/vta/webvh/dids/rotate-keys/2.0/payload.d.ts +1992 -0
- package/dist/vta/webvh/dids/rotate-keys/2.0/payload.d.ts.map +1 -0
- package/dist/vta/webvh/dids/rotate-keys/2.0/payload.js +1151 -0
- package/dist/vta/webvh/dids/rotate-keys/2.0/payload.js.map +1 -0
- package/dist/vta/webvh/dids/update/2.0/payload.d.ts +1062 -0
- package/dist/vta/webvh/dids/update/2.0/payload.d.ts.map +1 -0
- package/dist/vta/webvh/dids/update/2.0/payload.js +616 -0
- package/dist/vta/webvh/dids/update/2.0/payload.js.map +1 -0
- package/dist/vtc/credentials/reissue/0.1/payload.d.ts +502 -0
- package/dist/vtc/credentials/reissue/0.1/payload.d.ts.map +1 -0
- package/dist/vtc/credentials/reissue/0.1/payload.js +282 -0
- package/dist/vtc/credentials/reissue/0.1/payload.js.map +1 -0
- package/dist/vtc/members/personhood/challenge/0.1/payload.d.ts +2 -2
- package/dist/vtc/members/personhood/challenge/0.1/payload.js +2 -2
- package/dist/vtc/members/personhood/challenge/0.1/payload.js.map +1 -1
- package/dist/vtc/vetting/vetters/profile/0.1/payload.d.ts +2 -2
- package/dist/vtc/vetting/vetters/profile/0.1/payload.js +2 -2
- package/dist/vtc/vetting/vetters/profile/0.1/payload.js.map +1 -1
- package/dist/vtc/vetting/vetters/resend/0.1/payload.d.ts +2 -2
- package/dist/vtc/vetting/vetters/resend/0.1/payload.js +2 -2
- package/dist/vtc/vetting/vetters/resend/0.1/payload.js.map +1 -1
- package/package.json +1 -1
- package/src/_shared/components.ts +313 -2
- package/src/auth/passkey/enroll/invite/0.2/payload.ts +325 -0
- package/src/auth/passkey/enroll/redeem/finish/0.1/payload.ts +499 -0
- package/src/auth/passkey/enroll/redeem/start/0.1/payload.ts +700 -0
- package/src/auth/passkey/revoke/finish/0.2/payload.ts +379 -0
- package/src/auth/passkey/revoke/start/0.2/payload.ts +349 -0
- package/src/auth/step-up/approve-response/0.5/payload.ts +593 -0
- package/src/device/list/0.1/payload.ts +4 -2
- package/src/device/list/0.2/payload.ts +4 -2
- package/src/device/register/0.1/payload.ts +4 -2
- package/src/device/register/0.2/payload.ts +4 -2
- package/src/git-ns/_shared/0.4/git-ns.ts +17 -0
- package/src/git-ns/account/link-status/0.1/payload.ts +2 -2
- package/src/git-ns/account/unlink/0.1/payload.ts +274 -0
- package/src/git-ns/bridge/event/0.3/payload.ts +1132 -0
- package/src/git-ns/bridge/job/0.4/payload.ts +691 -0
- package/src/git-ns/drift/resolve/0.3/payload.ts +707 -0
- package/src/git-ns/namespace/reseat/0.3/payload.ts +342 -0
- package/src/git-ns/repo/create/0.3/payload.ts +706 -0
- package/src/git-ns/right/break-glass/0.1/payload.ts +443 -0
- package/src/git-ns/right/break-glass-notice/0.1/payload.ts +258 -0
- package/src/git-ns/right/grant/0.3/payload.ts +434 -0
- package/src/git-ns/right/ratify/0.1/payload.ts +455 -0
- package/src/git-ns/right/revoke/0.3/payload.ts +425 -0
- package/src/git-ns/roles/reproject/0.1/payload.ts +220 -0
- package/src/git-ns/view/0.1/payload.ts +2 -2
- package/src/git-ns/view/0.2/payload.ts +2 -2
- package/src/git-ns/view/0.3/payload.ts +2 -2
- package/src/git-ns/view/0.4/payload.ts +1075 -0
- package/src/index.ts +30 -0
- package/src/messaging/message/status/0.1/payload.ts +270 -0
- package/src/vta/_shared/0.3/did-key-roles.ts +17 -0
- package/src/vta/attestation/mnemonic-export/1.0/payload.ts +232 -0
- package/src/vta/webvh/dids/keys/add/1.0/payload.ts +1217 -0
- package/src/vta/webvh/dids/keys/list/1.0/payload.ts +1004 -0
- package/src/vta/webvh/dids/keys/retire/1.0/payload.ts +1212 -0
- package/src/vta/webvh/dids/keys/revoke/1.0/payload.ts +1276 -0
- package/src/vta/webvh/dids/rotate-keys/2.0/payload.ts +1262 -0
- package/src/vta/webvh/dids/update/2.0/payload.ts +713 -0
- package/src/vtc/credentials/reissue/0.1/payload.ts +357 -0
- package/src/vtc/members/personhood/challenge/0.1/payload.ts +2 -2
- package/src/vtc/vetting/vetters/profile/0.1/payload.ts +2 -2
- package/src/vtc/vetting/vetters/resend/0.1/payload.ts +2 -2
|
@@ -0,0 +1,1603 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Generated by scripts/build-ts-bindings.mjs — DO NOT EDIT BY HAND.
|
|
3
|
+
* Source: specs/vta/webvh/dids/keys/list/1.0/payload.schema.json
|
|
4
|
+
*/
|
|
5
|
+
import type { DidVerificationRelationship, Ext, KeyOrigin, KeyRole, KeyRoleApprovalState, KeyRoleProjection, KeyType, RoleKey, RoleKeyCustody, RoleKeyState, RoleSummary, RotationKind, RotationRecord, RotationState } from "../../../../../../_shared/components.js";
|
|
6
|
+
/**
|
|
7
|
+
* List a did:webvh's keys by role, with their state, and optionally the DID's rotation history and any changes awaiting approval.
|
|
8
|
+
*/
|
|
9
|
+
export interface VTAWebVHDIDsKeysListPayload {
|
|
10
|
+
/**
|
|
11
|
+
* The DID whose key roles are listed.
|
|
12
|
+
*/
|
|
13
|
+
did: string;
|
|
14
|
+
/**
|
|
15
|
+
* Return only these roles. Absent returns every role. Present-but-empty is refused by the schema rather than read as 'every role' — emptiness is never a wildcard.
|
|
16
|
+
*
|
|
17
|
+
* @minItems 1
|
|
18
|
+
*/
|
|
19
|
+
roles?: [KeyRole, ...KeyRole[]];
|
|
20
|
+
/**
|
|
21
|
+
* Include `retired` and `revoked` keys. Absent reads as false. `revoked` keys still published in `verificationMethod` are always included, because the document shows them to anyone who resolves it.
|
|
22
|
+
*/
|
|
23
|
+
includeEnded?: boolean;
|
|
24
|
+
/**
|
|
25
|
+
* Include the DID's rotation history. Absent reads as false.
|
|
26
|
+
*/
|
|
27
|
+
includeHistory?: boolean;
|
|
28
|
+
ext?: Ext;
|
|
29
|
+
}
|
|
30
|
+
/**
|
|
31
|
+
* Success response to vta/webvh/dids/keys/list. Type https://trusttasks.org/spec/vta/webvh/dids/keys/list/1.0#response.
|
|
32
|
+
*/
|
|
33
|
+
export interface VTAWebVHDIDsKeysListResponsePayload {
|
|
34
|
+
did: string;
|
|
35
|
+
/**
|
|
36
|
+
* The log entry the answer describes. Pass it as `expectedVersionId` to a change made on the strength of this answer.
|
|
37
|
+
*/
|
|
38
|
+
versionId: string;
|
|
39
|
+
projection: KeyRoleProjection;
|
|
40
|
+
/**
|
|
41
|
+
* One entry per role asked for, including roles with no keys — an empty role is an answer, and omitting it would read as 'not asked'.
|
|
42
|
+
*/
|
|
43
|
+
roles: RoleSummary[];
|
|
44
|
+
/**
|
|
45
|
+
* Present exactly when `includeHistory` was true. Newest first. In the custody projection this includes changes in `pendingApproval`; in the public projection it includes only changes that published an entry.
|
|
46
|
+
*/
|
|
47
|
+
rotations?: RotationRecord[];
|
|
48
|
+
ext?: Ext;
|
|
49
|
+
}
|
|
50
|
+
/** Shared definitions this specification references, re-exported under the names it used to declare them with. */
|
|
51
|
+
export type { DidVerificationRelationship, Ext, KeyOrigin, KeyRole, KeyRoleApprovalState, KeyRoleProjection, KeyType, RoleKey, RoleKeyCustody, RoleKeyState, RoleSummary, RotationKind, RotationRecord, RotationState };
|
|
52
|
+
/** Trust Task type URI. */
|
|
53
|
+
export declare const TYPE_URI: "https://trusttasks.org/spec/vta/webvh/dids/keys/list/1.0";
|
|
54
|
+
/** Stable alias for this specification's request payload shape. */
|
|
55
|
+
export type Payload = VTAWebVHDIDsKeysListPayload;
|
|
56
|
+
/** Trust Task response type URI (request type URI + "#response"). */
|
|
57
|
+
export declare const RESPONSE_TYPE_URI: "https://trusttasks.org/spec/vta/webvh/dids/keys/list/1.0#response";
|
|
58
|
+
/** Stable alias for this specification's success-response payload shape. */
|
|
59
|
+
export type Response = VTAWebVHDIDsKeysListResponsePayload;
|
|
60
|
+
/**
|
|
61
|
+
* This specification's payload schema, as a value.
|
|
62
|
+
*
|
|
63
|
+
* SPEC.md §7.2 item 2 is performed against this. It is shipped as data
|
|
64
|
+
* rather than only as a `.json` file because TypeScript types are erased
|
|
65
|
+
* at runtime: without a schema a consumer has nothing to validate, and
|
|
66
|
+
* every REQUIRED payload member is optional in practice. Cross-file
|
|
67
|
+
* `$ref`s are already inlined, so it needs no resolver.
|
|
68
|
+
*/
|
|
69
|
+
export declare const PAYLOAD_SCHEMA: {
|
|
70
|
+
readonly $schema: "https://json-schema.org/draft/2020-12/schema";
|
|
71
|
+
readonly $id: "https://trusttasks.org/spec/vta/webvh/dids/keys/list/1.0";
|
|
72
|
+
readonly title: "VTA WebVH DIDs Keys List — payload";
|
|
73
|
+
readonly description: "List a did:webvh's keys by role, with their state, and optionally the DID's rotation history and any changes awaiting approval.";
|
|
74
|
+
readonly type: "object";
|
|
75
|
+
readonly additionalProperties: false;
|
|
76
|
+
readonly required: readonly ["did"];
|
|
77
|
+
readonly properties: {
|
|
78
|
+
readonly did: {
|
|
79
|
+
readonly type: "string";
|
|
80
|
+
readonly minLength: 1;
|
|
81
|
+
readonly description: "The DID whose key roles are listed.";
|
|
82
|
+
};
|
|
83
|
+
readonly roles: {
|
|
84
|
+
readonly type: "array";
|
|
85
|
+
readonly items: {
|
|
86
|
+
readonly $ref: "#/$defs/KeyRole";
|
|
87
|
+
};
|
|
88
|
+
readonly uniqueItems: true;
|
|
89
|
+
readonly minItems: 1;
|
|
90
|
+
readonly description: "Return only these roles. Absent returns every role. Present-but-empty is refused by the schema rather than read as 'every role' — emptiness is never a wildcard.";
|
|
91
|
+
};
|
|
92
|
+
readonly includeEnded: {
|
|
93
|
+
readonly type: "boolean";
|
|
94
|
+
readonly description: "Include `retired` and `revoked` keys. Absent reads as false. `revoked` keys still published in `verificationMethod` are always included, because the document shows them to anyone who resolves it.";
|
|
95
|
+
};
|
|
96
|
+
readonly includeHistory: {
|
|
97
|
+
readonly type: "boolean";
|
|
98
|
+
readonly description: "Include the DID's rotation history. Absent reads as false.";
|
|
99
|
+
};
|
|
100
|
+
readonly ext: {
|
|
101
|
+
readonly $ref: "#/$defs/Ext";
|
|
102
|
+
};
|
|
103
|
+
};
|
|
104
|
+
readonly $defs: {
|
|
105
|
+
readonly Response: {
|
|
106
|
+
readonly $anchor: "response";
|
|
107
|
+
readonly title: "VTA WebVH DIDs Keys List — response payload";
|
|
108
|
+
readonly description: "Success response to vta/webvh/dids/keys/list. Type https://trusttasks.org/spec/vta/webvh/dids/keys/list/1.0#response.";
|
|
109
|
+
readonly type: "object";
|
|
110
|
+
readonly additionalProperties: false;
|
|
111
|
+
readonly required: readonly ["did", "versionId", "projection", "roles"];
|
|
112
|
+
readonly properties: {
|
|
113
|
+
readonly did: {
|
|
114
|
+
readonly type: "string";
|
|
115
|
+
};
|
|
116
|
+
readonly versionId: {
|
|
117
|
+
readonly type: "string";
|
|
118
|
+
readonly description: "The log entry the answer describes. Pass it as `expectedVersionId` to a change made on the strength of this answer.";
|
|
119
|
+
};
|
|
120
|
+
readonly projection: {
|
|
121
|
+
readonly $ref: "#/$defs/KeyRoleProjection";
|
|
122
|
+
};
|
|
123
|
+
readonly roles: {
|
|
124
|
+
readonly type: "array";
|
|
125
|
+
readonly items: {
|
|
126
|
+
readonly $ref: "#/$defs/RoleSummary";
|
|
127
|
+
};
|
|
128
|
+
readonly description: "One entry per role asked for, including roles with no keys — an empty role is an answer, and omitting it would read as 'not asked'.";
|
|
129
|
+
};
|
|
130
|
+
readonly rotations: {
|
|
131
|
+
readonly type: "array";
|
|
132
|
+
readonly items: {
|
|
133
|
+
readonly $ref: "#/$defs/RotationRecord";
|
|
134
|
+
};
|
|
135
|
+
readonly description: "Present exactly when `includeHistory` was true. Newest first. In the custody projection this includes changes in `pendingApproval`; in the public projection it includes only changes that published an entry.";
|
|
136
|
+
};
|
|
137
|
+
readonly ext: {
|
|
138
|
+
readonly $ref: "#/$defs/Ext";
|
|
139
|
+
};
|
|
140
|
+
};
|
|
141
|
+
};
|
|
142
|
+
readonly Ext: {
|
|
143
|
+
readonly title: "Ext";
|
|
144
|
+
readonly 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.";
|
|
145
|
+
readonly type: "object";
|
|
146
|
+
readonly minProperties: 1;
|
|
147
|
+
readonly additionalProperties: true;
|
|
148
|
+
readonly propertyNames: {
|
|
149
|
+
readonly pattern: "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$";
|
|
150
|
+
};
|
|
151
|
+
};
|
|
152
|
+
readonly RotationRecord: {
|
|
153
|
+
readonly title: "RotationRecord";
|
|
154
|
+
readonly type: "object";
|
|
155
|
+
readonly additionalProperties: false;
|
|
156
|
+
readonly required: readonly ["rotationId", "role", "kind", "state"];
|
|
157
|
+
readonly description: "One change to a role's key set, from preview to completion. The rotation history of a DID is the list of these; the log is the authority for what was published, and this record adds what the log cannot say — which change was which, and (custody projection only) who asked, who approved, and why.";
|
|
158
|
+
readonly properties: {
|
|
159
|
+
readonly rotationId: {
|
|
160
|
+
readonly type: "string";
|
|
161
|
+
readonly minLength: 1;
|
|
162
|
+
};
|
|
163
|
+
readonly role: {
|
|
164
|
+
readonly $ref: "#/$defs/KeyRole";
|
|
165
|
+
};
|
|
166
|
+
readonly kind: {
|
|
167
|
+
readonly $ref: "#/$defs/RotationKind";
|
|
168
|
+
};
|
|
169
|
+
readonly state: {
|
|
170
|
+
readonly $ref: "#/$defs/RotationState";
|
|
171
|
+
};
|
|
172
|
+
readonly predecessors: {
|
|
173
|
+
readonly type: "array";
|
|
174
|
+
readonly items: {
|
|
175
|
+
readonly type: "string";
|
|
176
|
+
};
|
|
177
|
+
readonly description: "Verification-method identifiers (or, for `update`, public keys) leaving the role.";
|
|
178
|
+
};
|
|
179
|
+
readonly successors: {
|
|
180
|
+
readonly type: "array";
|
|
181
|
+
readonly items: {
|
|
182
|
+
readonly type: "string";
|
|
183
|
+
};
|
|
184
|
+
readonly description: "Verification-method identifiers (or, for `update`, public keys) entering the role.";
|
|
185
|
+
};
|
|
186
|
+
readonly startedInVersionId: {
|
|
187
|
+
readonly type: "string";
|
|
188
|
+
};
|
|
189
|
+
readonly endedInVersionId: {
|
|
190
|
+
readonly type: "string";
|
|
191
|
+
};
|
|
192
|
+
readonly startedAt: {
|
|
193
|
+
readonly type: "string";
|
|
194
|
+
readonly format: "date-time";
|
|
195
|
+
};
|
|
196
|
+
readonly overlapUntil: {
|
|
197
|
+
readonly type: "string";
|
|
198
|
+
readonly format: "date-time";
|
|
199
|
+
readonly description: "Custody projection only. End of the overlap window.";
|
|
200
|
+
};
|
|
201
|
+
readonly autoRetire: {
|
|
202
|
+
readonly type: "boolean";
|
|
203
|
+
readonly description: "Custody projection only. Whether the VTA retires the predecessor itself at `overlapUntil`.";
|
|
204
|
+
};
|
|
205
|
+
readonly endedAt: {
|
|
206
|
+
readonly type: "string";
|
|
207
|
+
readonly format: "date-time";
|
|
208
|
+
};
|
|
209
|
+
readonly initiatedBy: {
|
|
210
|
+
readonly type: "string";
|
|
211
|
+
readonly description: "Custody projection only. VID of the administrator whose signed request started the change.";
|
|
212
|
+
};
|
|
213
|
+
readonly approvals: {
|
|
214
|
+
readonly $ref: "#/$defs/KeyRoleApprovalState";
|
|
215
|
+
readonly description: "Custody projection only.";
|
|
216
|
+
};
|
|
217
|
+
readonly reason: {
|
|
218
|
+
readonly type: "string";
|
|
219
|
+
readonly maxLength: 1024;
|
|
220
|
+
readonly description: "Custody projection only. The operator's stated reason. Never published.";
|
|
221
|
+
};
|
|
222
|
+
readonly ext: {
|
|
223
|
+
readonly $ref: "#/$defs/Ext";
|
|
224
|
+
};
|
|
225
|
+
readonly activatesAt: {
|
|
226
|
+
readonly type: "string";
|
|
227
|
+
readonly format: "date-time";
|
|
228
|
+
readonly description: "When the successor becomes `active` and the predecessor `retiring`; never before `cacheHorizonAt`.";
|
|
229
|
+
};
|
|
230
|
+
readonly cacheHorizonAt: {
|
|
231
|
+
readonly type: "string";
|
|
232
|
+
readonly format: "date-time";
|
|
233
|
+
readonly description: "Planned rotations: the publishing entry's cache horizon — publication plus the longer of the document's TTL and the verifier cache cap (CONVENTIONS.md §11.1). The switch, and any retirement of the predecessor, happen no earlier. Public: it follows from the log and the published cap.";
|
|
234
|
+
};
|
|
235
|
+
};
|
|
236
|
+
};
|
|
237
|
+
readonly KeyRoleApprovalState: {
|
|
238
|
+
readonly title: "KeyRoleApprovalState";
|
|
239
|
+
readonly type: "object";
|
|
240
|
+
readonly additionalProperties: false;
|
|
241
|
+
readonly required: readonly ["required", "received", "expiresAt"];
|
|
242
|
+
readonly description: "Approval progress of a change the VTA's policy gates on more than one approval (CONVENTIONS.md §3.3).";
|
|
243
|
+
readonly properties: {
|
|
244
|
+
readonly required: {
|
|
245
|
+
readonly type: "integer";
|
|
246
|
+
readonly minimum: 1;
|
|
247
|
+
readonly description: "Distinct approvals the VTA's policy requires.";
|
|
248
|
+
};
|
|
249
|
+
readonly received: {
|
|
250
|
+
readonly type: "integer";
|
|
251
|
+
readonly minimum: 0;
|
|
252
|
+
readonly description: "Distinct approvals recorded so far, including the initiator's own.";
|
|
253
|
+
};
|
|
254
|
+
readonly approvers: {
|
|
255
|
+
readonly type: "array";
|
|
256
|
+
readonly items: {
|
|
257
|
+
readonly type: "string";
|
|
258
|
+
};
|
|
259
|
+
readonly uniqueItems: true;
|
|
260
|
+
readonly description: "VIDs whose approvals were recorded. Custody projection only; omitted from a response to anyone who is not themselves an eligible approver of this change.";
|
|
261
|
+
};
|
|
262
|
+
readonly expiresAt: {
|
|
263
|
+
readonly type: "string";
|
|
264
|
+
readonly format: "date-time";
|
|
265
|
+
readonly description: "When the preview, and every approval bound to it, stops being usable.";
|
|
266
|
+
};
|
|
267
|
+
};
|
|
268
|
+
};
|
|
269
|
+
readonly RotationState: {
|
|
270
|
+
readonly title: "RotationState";
|
|
271
|
+
readonly type: "string";
|
|
272
|
+
readonly enum: readonly ["pendingApproval", "staged", "overlapping", "completed", "aborted", "expired"];
|
|
273
|
+
readonly description: "`pendingApproval` — awaiting the approvals the VTA's policy requires; nothing is published. `staged` — successor published, not yet used; predecessor still active. `overlapping` — successor active, predecessor `retiring`. `completed` — every predecessor retired (or, for `compromise` and `addition`, the entry is published and any overlap it began has ended). `aborted` — the successor was retired instead of the predecessor, which stayed or returned to `active`. `expired` — approvals were not gathered before the preview expired; nothing was published.";
|
|
274
|
+
};
|
|
275
|
+
readonly RotationKind: {
|
|
276
|
+
readonly title: "RotationKind";
|
|
277
|
+
readonly type: "string";
|
|
278
|
+
readonly enum: readonly ["planned", "compromise", "addition"];
|
|
279
|
+
readonly description: "`planned` — a successor was staged, activated, and the predecessor retired on the operator's schedule. `compromise` — a key was revoked and, where the role would otherwise be empty, replaced in the same log entry. `addition` — a key was added to a role without anything leaving it (for example a post-quantum key alongside a classical one).";
|
|
280
|
+
};
|
|
281
|
+
readonly KeyRole: {
|
|
282
|
+
readonly title: "KeyRole";
|
|
283
|
+
readonly type: "string";
|
|
284
|
+
readonly enum: readonly ["attestation", "operational", "messaging", "update"];
|
|
285
|
+
readonly description: "The named key role a key occupies in the DID (VTI-KEY-070 onward). `attestation` — the only keys in `assertionMethod`; sign the DID's attestation artefacts (membership and role credentials, endorsements, status lists, every other credential the node issues), through the VTA's signing service and nowhere else. Generated inside the VTA, never derived, never exportable, never in a backup. `operational` — the only keys in `authentication`; sign the node's own traffic (Trust Task requests and responses, DIDComm and TSP message signatures, invitations, notices, audit checkpoints) with proof purpose `authentication`. `messaging` — the only keys in `keyAgreement`; sign nothing. `update` — the keys that authorize appending to the DID's log (a did:webvh `updateKeys` entry) and the pre-rotation commitments that authorize the next ones; never a verification method, never in `keyRoles`. Generated inside the VTA, never derived, never exportable, never in a backup. No role permits `capabilityInvocation` or `capabilityDelegation` (VTI-KEY-075); both are reserved for a future role. The mapping is normative and is set out in CONVENTIONS.md §1. The set is an extensible registry and growing it is a MINOR change: a consumer that receives a role it does not implement MUST refuse the document rather than map the key onto a role it does know.";
|
|
286
|
+
};
|
|
287
|
+
readonly RoleSummary: {
|
|
288
|
+
readonly title: "RoleSummary";
|
|
289
|
+
readonly type: "object";
|
|
290
|
+
readonly additionalProperties: false;
|
|
291
|
+
readonly required: readonly ["role", "relationships", "keys"];
|
|
292
|
+
readonly properties: {
|
|
293
|
+
readonly role: {
|
|
294
|
+
readonly $ref: "#/$defs/KeyRole";
|
|
295
|
+
};
|
|
296
|
+
readonly relationships: {
|
|
297
|
+
readonly type: "array";
|
|
298
|
+
readonly items: {
|
|
299
|
+
readonly $ref: "#/$defs/DidVerificationRelationship";
|
|
300
|
+
};
|
|
301
|
+
readonly uniqueItems: true;
|
|
302
|
+
readonly description: "The relationship this role owns (CONVENTIONS.md §1). Empty for `update`.";
|
|
303
|
+
};
|
|
304
|
+
readonly keys: {
|
|
305
|
+
readonly type: "array";
|
|
306
|
+
readonly items: {
|
|
307
|
+
readonly $ref: "#/$defs/RoleKey";
|
|
308
|
+
};
|
|
309
|
+
readonly description: "The role's keys, in the order the document publishes them. Terminal-state keys are included only when the request asked for them.";
|
|
310
|
+
};
|
|
311
|
+
readonly preRotationCommitments: {
|
|
312
|
+
readonly type: "integer";
|
|
313
|
+
readonly minimum: 0;
|
|
314
|
+
readonly description: "`update` only: successors the latest entry commits to. `0` means a compromise of the current update key cannot be recovered from by rotation, and the DID would have to be deactivated (VTI-KEY-124).";
|
|
315
|
+
};
|
|
316
|
+
};
|
|
317
|
+
};
|
|
318
|
+
readonly RoleKey: {
|
|
319
|
+
readonly title: "RoleKey";
|
|
320
|
+
readonly type: "object";
|
|
321
|
+
readonly additionalProperties: false;
|
|
322
|
+
readonly required: readonly ["role", "keyType", "publicKeyMultibase", "state"];
|
|
323
|
+
readonly description: "One key in one role. A key is in exactly one role for its whole life; a change of role is a retirement from one and an addition to another, under a new verification-method identifier.";
|
|
324
|
+
readonly properties: {
|
|
325
|
+
readonly verificationMethod: {
|
|
326
|
+
readonly type: "string";
|
|
327
|
+
readonly minLength: 1;
|
|
328
|
+
readonly description: "The full verification-method identifier (`did#fragment`) the document publishes the key under, and lists in `keyRoles`. Absent only for `update` keys, which are published as log parameters and never as verification methods (VTI-KEY-093). A VTA minting a new method SHOULD derive its fragment from the key (VTI-KEY-150).";
|
|
329
|
+
};
|
|
330
|
+
readonly role: {
|
|
331
|
+
readonly $ref: "#/$defs/KeyRole";
|
|
332
|
+
};
|
|
333
|
+
readonly relationships: {
|
|
334
|
+
readonly type: "array";
|
|
335
|
+
readonly items: {
|
|
336
|
+
readonly $ref: "#/$defs/DidVerificationRelationship";
|
|
337
|
+
};
|
|
338
|
+
readonly uniqueItems: true;
|
|
339
|
+
readonly description: "The relationships the key is (or, while `pending`, will be) listed in. Always exactly its role's single relationship (CONVENTIONS.md §1) — carried so a caller can check it against the document rather than trusting it. Empty for `update`, `retired` and `revoked` keys.";
|
|
340
|
+
};
|
|
341
|
+
readonly keyType: {
|
|
342
|
+
readonly $ref: "#/$defs/KeyType";
|
|
343
|
+
};
|
|
344
|
+
readonly publicKeyMultibase: {
|
|
345
|
+
readonly type: "string";
|
|
346
|
+
readonly minLength: 1;
|
|
347
|
+
readonly description: "The public half, multibase-encoded, exactly as published.";
|
|
348
|
+
};
|
|
349
|
+
readonly state: {
|
|
350
|
+
readonly $ref: "#/$defs/RoleKeyState";
|
|
351
|
+
};
|
|
352
|
+
readonly publishedInVersionId: {
|
|
353
|
+
readonly type: "string";
|
|
354
|
+
readonly description: "versionId of the log entry that first published the key. Absent while `pending`.";
|
|
355
|
+
};
|
|
356
|
+
readonly removedInVersionId: {
|
|
357
|
+
readonly type: "string";
|
|
358
|
+
readonly description: "versionId of the log entry that retired or revoked the key.";
|
|
359
|
+
};
|
|
360
|
+
readonly retireAfter: {
|
|
361
|
+
readonly type: "string";
|
|
362
|
+
readonly format: "date-time";
|
|
363
|
+
readonly description: "For a `retiring` key: the end of its overlap window. Custody projection only.";
|
|
364
|
+
};
|
|
365
|
+
readonly compromisedSince: {
|
|
366
|
+
readonly type: "string";
|
|
367
|
+
readonly format: "date-time";
|
|
368
|
+
readonly description: "For a `revoked` key: the compromise time (VTI-KEY-121) — the earliest instant from which the key is treated as compromised. Where the operator cannot establish it, the time the key was first published. Published, because it is what a verifier needs.";
|
|
369
|
+
};
|
|
370
|
+
readonly rotationId: {
|
|
371
|
+
readonly type: "string";
|
|
372
|
+
readonly description: "The rotation this key was introduced or retired by, when it was.";
|
|
373
|
+
};
|
|
374
|
+
readonly label: {
|
|
375
|
+
readonly type: "string";
|
|
376
|
+
readonly maxLength: 256;
|
|
377
|
+
readonly description: "Operator-facing label. Custody projection only.";
|
|
378
|
+
};
|
|
379
|
+
readonly custody: {
|
|
380
|
+
readonly $ref: "#/$defs/RoleKeyCustody";
|
|
381
|
+
};
|
|
382
|
+
readonly ext: {
|
|
383
|
+
readonly $ref: "#/$defs/Ext";
|
|
384
|
+
};
|
|
385
|
+
readonly activatesAt: {
|
|
386
|
+
readonly type: "string";
|
|
387
|
+
readonly format: "date-time";
|
|
388
|
+
readonly description: "For a `staged` key: when the VTA will begin using it — no earlier than the publishing entry's cache horizon (CONVENTIONS.md §11.1).";
|
|
389
|
+
};
|
|
390
|
+
};
|
|
391
|
+
};
|
|
392
|
+
readonly RoleKeyCustody: {
|
|
393
|
+
readonly title: "RoleKeyCustody";
|
|
394
|
+
readonly type: "object";
|
|
395
|
+
readonly additionalProperties: false;
|
|
396
|
+
readonly required: readonly ["keyId", "exportable", "neverExportable", "inBackups"];
|
|
397
|
+
readonly description: "How the VTA holds a key. Present only in the custody projection. Carries no key material, and a conforming VTA MUST NOT place any in `ext`.";
|
|
398
|
+
readonly properties: {
|
|
399
|
+
readonly keyId: {
|
|
400
|
+
readonly type: "string";
|
|
401
|
+
readonly minLength: 1;
|
|
402
|
+
readonly description: "The custodian record identifier (`keys/*`'s `keyId`) behind this key.";
|
|
403
|
+
};
|
|
404
|
+
readonly origin: {
|
|
405
|
+
readonly $ref: "#/$defs/KeyOrigin";
|
|
406
|
+
};
|
|
407
|
+
readonly exportable: {
|
|
408
|
+
readonly type: "boolean";
|
|
409
|
+
readonly description: "Whether the custodian would release the private half through `keys/export-secret`. Always `false` for `attestation` and `update` keys (CONVENTIONS.md §4). Stated explicitly — never absent — because this is the member an operator reads to confirm a role key cannot leave the VTA, and `keys/*`'s absent-means-exportable reading is the wrong default to leave them to infer.";
|
|
410
|
+
};
|
|
411
|
+
readonly neverExportable: {
|
|
412
|
+
readonly type: "boolean";
|
|
413
|
+
readonly description: "True when no authority can make the key exportable — the role forbids it, or the material exists only inside a module that cannot release it. `true` implies `exportable: false`.";
|
|
414
|
+
};
|
|
415
|
+
readonly hardwareBacked: {
|
|
416
|
+
readonly type: "boolean";
|
|
417
|
+
readonly description: "True when the private half is held by a hardware or enclave module that performs the operation without releasing it. Absent means the VTA does not say, not that it is false.";
|
|
418
|
+
};
|
|
419
|
+
readonly inBackups: {
|
|
420
|
+
readonly type: "boolean";
|
|
421
|
+
readonly description: "Whether the key, or material it can be re-derived from, is included in the VTA's backups or any state transfer. Always `false` for `attestation` and `update` keys (VTI-KEY-112): they are generated, not derived, so there is no seed that recovers them, and their loss is recovered by rotation, never by restore.";
|
|
422
|
+
};
|
|
423
|
+
readonly destroyed: {
|
|
424
|
+
readonly type: "boolean";
|
|
425
|
+
readonly description: "True once the private half has been destroyed — a retired `attestation` key (VTI-KEY-125). The record survives so the key's past signatures stay attributable.";
|
|
426
|
+
};
|
|
427
|
+
};
|
|
428
|
+
};
|
|
429
|
+
readonly KeyOrigin: {
|
|
430
|
+
readonly title: "KeyOrigin";
|
|
431
|
+
readonly type: "string";
|
|
432
|
+
readonly enum: readonly ["derived", "imported", "internal"];
|
|
433
|
+
readonly description: "Where the private key came from. `derived` means the maintainer generated it from a seed it holds and can reproduce it from `derivationPath`; `imported` means it arrived from outside and exists only as stored material; `internal` means the maintainer generated it from a CSPRNG and it is reproducible from nothing at all. The distinction is operationally load-bearing: a `derived` key survives a seed restore, an `imported` one is lost unless it was backed up separately, and an `internal` one cannot be recovered by any means once the maintainer's storage is gone. This member is also the only way a consumer can confirm that a `keys/create` request for an `internal` key was honoured rather than silently downgraded to a derived one — see that specification's `internal` member.";
|
|
434
|
+
readonly default: "derived";
|
|
435
|
+
};
|
|
436
|
+
readonly RoleKeyState: {
|
|
437
|
+
readonly title: "RoleKeyState";
|
|
438
|
+
readonly type: "string";
|
|
439
|
+
readonly enum: readonly ["pending", "staged", "active", "retiring", "retired", "revoked"];
|
|
440
|
+
readonly description: "Where a key is in its role's lifecycle. `pending` — planned by a preview or a change awaiting approval; not published; custody projection only. `staged` — published and bound to its role, but not yet used: a planned rotation publishes the successor and waits until the entry's cache horizon — publication plus the longer of the document's TTL and the verifier cache cap (CONVENTIONS.md §11.1) — before the VTA first uses it, so that no verifier holding a cached document sees a signature by a key it has never seen (VTI-KEY-122). Becomes `active` at the rotation's `activatesAt`. `active` — the key the VTA uses for new signatures (or, for `messaging`, advertises for new sessions). `retiring` — still published so that what it signed and sessions keyed to it keep working, but never used again: from the successor's first use the VTA MUST NOT sign with it, while a retiring `messaging` key stays usable for decryption, and senders may still encrypt to it, until it is retired (CONVENTIONS.md §11.3). `retired` — removed by planned rotation; what it signed while published remains valid, judged against the DID version current at issuance (CONVENTIONS.md §7). A retired `attestation` or `messaging` key is destroyed at retirement. `revoked` — removed from every relationship and from `keyRoles` in one entry, without overlap, because it is or may be compromised; what it signed from `compromisedSince` onward establishes nothing. `retired` and `revoked` are terminal.";
|
|
441
|
+
};
|
|
442
|
+
readonly DidVerificationRelationship: {
|
|
443
|
+
readonly title: "DidVerificationRelationship";
|
|
444
|
+
readonly type: "string";
|
|
445
|
+
readonly enum: readonly ["authentication", "assertionMethod", "keyAgreement", "capabilityInvocation", "capabilityDelegation"];
|
|
446
|
+
readonly description: "A DID Core verification relationship.";
|
|
447
|
+
};
|
|
448
|
+
readonly KeyType: {
|
|
449
|
+
readonly title: "KeyType";
|
|
450
|
+
readonly type: "string";
|
|
451
|
+
readonly enum: readonly ["ed25519", "x25519", "p256", "mldsa44", "mldsa65"];
|
|
452
|
+
readonly description: "Cryptographic algorithm the key material belongs to. `ed25519` signs (EdDSA), `x25519` performs key agreement and never signs, `p256` signs (ES256), and `mldsa44` and `mldsa65` sign with the post-quantum ML-DSA scheme of US NIST FIPS 204. The set is expected to grow as algorithms are standardised, and growing it is a MINOR change under SPEC.md §5.2: `keyType` selects no schema branch, so adding a value relaxes a constraint rather than narrowing one, and the generated libraries mark this enumeration non-exhaustive so that a consumer absorbs a new value rather than failing to compile. Two ML-DSA parameter sets are carried because two specifications require different ones — W3C Quantum-Resistant Cryptosuites defines Data Integrity suites only for ML-DSA-44, while Trust Spanning Protocol Rev 3 §8.1 mandates ML-DSA-65 — so the parameter set is chosen by whatever consumes the key and the two are not redundant. A consumer that does not implement a value it receives MUST refuse the document rather than substitute one it does support.";
|
|
453
|
+
};
|
|
454
|
+
readonly KeyRoleProjection: {
|
|
455
|
+
readonly title: "KeyRoleProjection";
|
|
456
|
+
readonly type: "string";
|
|
457
|
+
readonly enum: readonly ["public", "custody"];
|
|
458
|
+
readonly description: "Which view of the DID's key roles the caller was given (CONVENTIONS.md §5). `public` — only what the published document and log already reveal to anyone who resolves the DID. `custody` — additionally the VTA's own custody state: pending keys, the custodian record behind each key, overlap deadlines, who initiated and approved each change, and why. The response always states which it is, so a caller never mistakes an absent member for a statement that the thing does not exist.";
|
|
459
|
+
};
|
|
460
|
+
};
|
|
461
|
+
};
|
|
462
|
+
/** As {@link PAYLOAD_SCHEMA}, for the success-response variant. */
|
|
463
|
+
export declare const RESPONSE_PAYLOAD_SCHEMA: {
|
|
464
|
+
readonly $schema: "https://json-schema.org/draft/2020-12/schema";
|
|
465
|
+
readonly $ref: "#/$defs/Response";
|
|
466
|
+
readonly $defs: {
|
|
467
|
+
readonly Response: {
|
|
468
|
+
readonly $anchor: "response";
|
|
469
|
+
readonly title: "VTA WebVH DIDs Keys List — response payload";
|
|
470
|
+
readonly description: "Success response to vta/webvh/dids/keys/list. Type https://trusttasks.org/spec/vta/webvh/dids/keys/list/1.0#response.";
|
|
471
|
+
readonly type: "object";
|
|
472
|
+
readonly additionalProperties: false;
|
|
473
|
+
readonly required: readonly ["did", "versionId", "projection", "roles"];
|
|
474
|
+
readonly properties: {
|
|
475
|
+
readonly did: {
|
|
476
|
+
readonly type: "string";
|
|
477
|
+
};
|
|
478
|
+
readonly versionId: {
|
|
479
|
+
readonly type: "string";
|
|
480
|
+
readonly description: "The log entry the answer describes. Pass it as `expectedVersionId` to a change made on the strength of this answer.";
|
|
481
|
+
};
|
|
482
|
+
readonly projection: {
|
|
483
|
+
readonly $ref: "#/$defs/KeyRoleProjection";
|
|
484
|
+
};
|
|
485
|
+
readonly roles: {
|
|
486
|
+
readonly type: "array";
|
|
487
|
+
readonly items: {
|
|
488
|
+
readonly $ref: "#/$defs/RoleSummary";
|
|
489
|
+
};
|
|
490
|
+
readonly description: "One entry per role asked for, including roles with no keys — an empty role is an answer, and omitting it would read as 'not asked'.";
|
|
491
|
+
};
|
|
492
|
+
readonly rotations: {
|
|
493
|
+
readonly type: "array";
|
|
494
|
+
readonly items: {
|
|
495
|
+
readonly $ref: "#/$defs/RotationRecord";
|
|
496
|
+
};
|
|
497
|
+
readonly description: "Present exactly when `includeHistory` was true. Newest first. In the custody projection this includes changes in `pendingApproval`; in the public projection it includes only changes that published an entry.";
|
|
498
|
+
};
|
|
499
|
+
readonly ext: {
|
|
500
|
+
readonly $ref: "#/$defs/Ext";
|
|
501
|
+
};
|
|
502
|
+
};
|
|
503
|
+
};
|
|
504
|
+
readonly Ext: {
|
|
505
|
+
readonly title: "Ext";
|
|
506
|
+
readonly 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.";
|
|
507
|
+
readonly type: "object";
|
|
508
|
+
readonly minProperties: 1;
|
|
509
|
+
readonly additionalProperties: true;
|
|
510
|
+
readonly propertyNames: {
|
|
511
|
+
readonly pattern: "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$";
|
|
512
|
+
};
|
|
513
|
+
};
|
|
514
|
+
readonly RotationRecord: {
|
|
515
|
+
readonly title: "RotationRecord";
|
|
516
|
+
readonly type: "object";
|
|
517
|
+
readonly additionalProperties: false;
|
|
518
|
+
readonly required: readonly ["rotationId", "role", "kind", "state"];
|
|
519
|
+
readonly description: "One change to a role's key set, from preview to completion. The rotation history of a DID is the list of these; the log is the authority for what was published, and this record adds what the log cannot say — which change was which, and (custody projection only) who asked, who approved, and why.";
|
|
520
|
+
readonly properties: {
|
|
521
|
+
readonly rotationId: {
|
|
522
|
+
readonly type: "string";
|
|
523
|
+
readonly minLength: 1;
|
|
524
|
+
};
|
|
525
|
+
readonly role: {
|
|
526
|
+
readonly $ref: "#/$defs/KeyRole";
|
|
527
|
+
};
|
|
528
|
+
readonly kind: {
|
|
529
|
+
readonly $ref: "#/$defs/RotationKind";
|
|
530
|
+
};
|
|
531
|
+
readonly state: {
|
|
532
|
+
readonly $ref: "#/$defs/RotationState";
|
|
533
|
+
};
|
|
534
|
+
readonly predecessors: {
|
|
535
|
+
readonly type: "array";
|
|
536
|
+
readonly items: {
|
|
537
|
+
readonly type: "string";
|
|
538
|
+
};
|
|
539
|
+
readonly description: "Verification-method identifiers (or, for `update`, public keys) leaving the role.";
|
|
540
|
+
};
|
|
541
|
+
readonly successors: {
|
|
542
|
+
readonly type: "array";
|
|
543
|
+
readonly items: {
|
|
544
|
+
readonly type: "string";
|
|
545
|
+
};
|
|
546
|
+
readonly description: "Verification-method identifiers (or, for `update`, public keys) entering the role.";
|
|
547
|
+
};
|
|
548
|
+
readonly startedInVersionId: {
|
|
549
|
+
readonly type: "string";
|
|
550
|
+
};
|
|
551
|
+
readonly endedInVersionId: {
|
|
552
|
+
readonly type: "string";
|
|
553
|
+
};
|
|
554
|
+
readonly startedAt: {
|
|
555
|
+
readonly type: "string";
|
|
556
|
+
readonly format: "date-time";
|
|
557
|
+
};
|
|
558
|
+
readonly overlapUntil: {
|
|
559
|
+
readonly type: "string";
|
|
560
|
+
readonly format: "date-time";
|
|
561
|
+
readonly description: "Custody projection only. End of the overlap window.";
|
|
562
|
+
};
|
|
563
|
+
readonly autoRetire: {
|
|
564
|
+
readonly type: "boolean";
|
|
565
|
+
readonly description: "Custody projection only. Whether the VTA retires the predecessor itself at `overlapUntil`.";
|
|
566
|
+
};
|
|
567
|
+
readonly endedAt: {
|
|
568
|
+
readonly type: "string";
|
|
569
|
+
readonly format: "date-time";
|
|
570
|
+
};
|
|
571
|
+
readonly initiatedBy: {
|
|
572
|
+
readonly type: "string";
|
|
573
|
+
readonly description: "Custody projection only. VID of the administrator whose signed request started the change.";
|
|
574
|
+
};
|
|
575
|
+
readonly approvals: {
|
|
576
|
+
readonly $ref: "#/$defs/KeyRoleApprovalState";
|
|
577
|
+
readonly description: "Custody projection only.";
|
|
578
|
+
};
|
|
579
|
+
readonly reason: {
|
|
580
|
+
readonly type: "string";
|
|
581
|
+
readonly maxLength: 1024;
|
|
582
|
+
readonly description: "Custody projection only. The operator's stated reason. Never published.";
|
|
583
|
+
};
|
|
584
|
+
readonly ext: {
|
|
585
|
+
readonly $ref: "#/$defs/Ext";
|
|
586
|
+
};
|
|
587
|
+
readonly activatesAt: {
|
|
588
|
+
readonly type: "string";
|
|
589
|
+
readonly format: "date-time";
|
|
590
|
+
readonly description: "When the successor becomes `active` and the predecessor `retiring`; never before `cacheHorizonAt`.";
|
|
591
|
+
};
|
|
592
|
+
readonly cacheHorizonAt: {
|
|
593
|
+
readonly type: "string";
|
|
594
|
+
readonly format: "date-time";
|
|
595
|
+
readonly description: "Planned rotations: the publishing entry's cache horizon — publication plus the longer of the document's TTL and the verifier cache cap (CONVENTIONS.md §11.1). The switch, and any retirement of the predecessor, happen no earlier. Public: it follows from the log and the published cap.";
|
|
596
|
+
};
|
|
597
|
+
};
|
|
598
|
+
};
|
|
599
|
+
readonly KeyRoleApprovalState: {
|
|
600
|
+
readonly title: "KeyRoleApprovalState";
|
|
601
|
+
readonly type: "object";
|
|
602
|
+
readonly additionalProperties: false;
|
|
603
|
+
readonly required: readonly ["required", "received", "expiresAt"];
|
|
604
|
+
readonly description: "Approval progress of a change the VTA's policy gates on more than one approval (CONVENTIONS.md §3.3).";
|
|
605
|
+
readonly properties: {
|
|
606
|
+
readonly required: {
|
|
607
|
+
readonly type: "integer";
|
|
608
|
+
readonly minimum: 1;
|
|
609
|
+
readonly description: "Distinct approvals the VTA's policy requires.";
|
|
610
|
+
};
|
|
611
|
+
readonly received: {
|
|
612
|
+
readonly type: "integer";
|
|
613
|
+
readonly minimum: 0;
|
|
614
|
+
readonly description: "Distinct approvals recorded so far, including the initiator's own.";
|
|
615
|
+
};
|
|
616
|
+
readonly approvers: {
|
|
617
|
+
readonly type: "array";
|
|
618
|
+
readonly items: {
|
|
619
|
+
readonly type: "string";
|
|
620
|
+
};
|
|
621
|
+
readonly uniqueItems: true;
|
|
622
|
+
readonly description: "VIDs whose approvals were recorded. Custody projection only; omitted from a response to anyone who is not themselves an eligible approver of this change.";
|
|
623
|
+
};
|
|
624
|
+
readonly expiresAt: {
|
|
625
|
+
readonly type: "string";
|
|
626
|
+
readonly format: "date-time";
|
|
627
|
+
readonly description: "When the preview, and every approval bound to it, stops being usable.";
|
|
628
|
+
};
|
|
629
|
+
};
|
|
630
|
+
};
|
|
631
|
+
readonly RotationState: {
|
|
632
|
+
readonly title: "RotationState";
|
|
633
|
+
readonly type: "string";
|
|
634
|
+
readonly enum: readonly ["pendingApproval", "staged", "overlapping", "completed", "aborted", "expired"];
|
|
635
|
+
readonly description: "`pendingApproval` — awaiting the approvals the VTA's policy requires; nothing is published. `staged` — successor published, not yet used; predecessor still active. `overlapping` — successor active, predecessor `retiring`. `completed` — every predecessor retired (or, for `compromise` and `addition`, the entry is published and any overlap it began has ended). `aborted` — the successor was retired instead of the predecessor, which stayed or returned to `active`. `expired` — approvals were not gathered before the preview expired; nothing was published.";
|
|
636
|
+
};
|
|
637
|
+
readonly RotationKind: {
|
|
638
|
+
readonly title: "RotationKind";
|
|
639
|
+
readonly type: "string";
|
|
640
|
+
readonly enum: readonly ["planned", "compromise", "addition"];
|
|
641
|
+
readonly description: "`planned` — a successor was staged, activated, and the predecessor retired on the operator's schedule. `compromise` — a key was revoked and, where the role would otherwise be empty, replaced in the same log entry. `addition` — a key was added to a role without anything leaving it (for example a post-quantum key alongside a classical one).";
|
|
642
|
+
};
|
|
643
|
+
readonly KeyRole: {
|
|
644
|
+
readonly title: "KeyRole";
|
|
645
|
+
readonly type: "string";
|
|
646
|
+
readonly enum: readonly ["attestation", "operational", "messaging", "update"];
|
|
647
|
+
readonly description: "The named key role a key occupies in the DID (VTI-KEY-070 onward). `attestation` — the only keys in `assertionMethod`; sign the DID's attestation artefacts (membership and role credentials, endorsements, status lists, every other credential the node issues), through the VTA's signing service and nowhere else. Generated inside the VTA, never derived, never exportable, never in a backup. `operational` — the only keys in `authentication`; sign the node's own traffic (Trust Task requests and responses, DIDComm and TSP message signatures, invitations, notices, audit checkpoints) with proof purpose `authentication`. `messaging` — the only keys in `keyAgreement`; sign nothing. `update` — the keys that authorize appending to the DID's log (a did:webvh `updateKeys` entry) and the pre-rotation commitments that authorize the next ones; never a verification method, never in `keyRoles`. Generated inside the VTA, never derived, never exportable, never in a backup. No role permits `capabilityInvocation` or `capabilityDelegation` (VTI-KEY-075); both are reserved for a future role. The mapping is normative and is set out in CONVENTIONS.md §1. The set is an extensible registry and growing it is a MINOR change: a consumer that receives a role it does not implement MUST refuse the document rather than map the key onto a role it does know.";
|
|
648
|
+
};
|
|
649
|
+
readonly RoleSummary: {
|
|
650
|
+
readonly title: "RoleSummary";
|
|
651
|
+
readonly type: "object";
|
|
652
|
+
readonly additionalProperties: false;
|
|
653
|
+
readonly required: readonly ["role", "relationships", "keys"];
|
|
654
|
+
readonly properties: {
|
|
655
|
+
readonly role: {
|
|
656
|
+
readonly $ref: "#/$defs/KeyRole";
|
|
657
|
+
};
|
|
658
|
+
readonly relationships: {
|
|
659
|
+
readonly type: "array";
|
|
660
|
+
readonly items: {
|
|
661
|
+
readonly $ref: "#/$defs/DidVerificationRelationship";
|
|
662
|
+
};
|
|
663
|
+
readonly uniqueItems: true;
|
|
664
|
+
readonly description: "The relationship this role owns (CONVENTIONS.md §1). Empty for `update`.";
|
|
665
|
+
};
|
|
666
|
+
readonly keys: {
|
|
667
|
+
readonly type: "array";
|
|
668
|
+
readonly items: {
|
|
669
|
+
readonly $ref: "#/$defs/RoleKey";
|
|
670
|
+
};
|
|
671
|
+
readonly description: "The role's keys, in the order the document publishes them. Terminal-state keys are included only when the request asked for them.";
|
|
672
|
+
};
|
|
673
|
+
readonly preRotationCommitments: {
|
|
674
|
+
readonly type: "integer";
|
|
675
|
+
readonly minimum: 0;
|
|
676
|
+
readonly description: "`update` only: successors the latest entry commits to. `0` means a compromise of the current update key cannot be recovered from by rotation, and the DID would have to be deactivated (VTI-KEY-124).";
|
|
677
|
+
};
|
|
678
|
+
};
|
|
679
|
+
};
|
|
680
|
+
readonly RoleKey: {
|
|
681
|
+
readonly title: "RoleKey";
|
|
682
|
+
readonly type: "object";
|
|
683
|
+
readonly additionalProperties: false;
|
|
684
|
+
readonly required: readonly ["role", "keyType", "publicKeyMultibase", "state"];
|
|
685
|
+
readonly description: "One key in one role. A key is in exactly one role for its whole life; a change of role is a retirement from one and an addition to another, under a new verification-method identifier.";
|
|
686
|
+
readonly properties: {
|
|
687
|
+
readonly verificationMethod: {
|
|
688
|
+
readonly type: "string";
|
|
689
|
+
readonly minLength: 1;
|
|
690
|
+
readonly description: "The full verification-method identifier (`did#fragment`) the document publishes the key under, and lists in `keyRoles`. Absent only for `update` keys, which are published as log parameters and never as verification methods (VTI-KEY-093). A VTA minting a new method SHOULD derive its fragment from the key (VTI-KEY-150).";
|
|
691
|
+
};
|
|
692
|
+
readonly role: {
|
|
693
|
+
readonly $ref: "#/$defs/KeyRole";
|
|
694
|
+
};
|
|
695
|
+
readonly relationships: {
|
|
696
|
+
readonly type: "array";
|
|
697
|
+
readonly items: {
|
|
698
|
+
readonly $ref: "#/$defs/DidVerificationRelationship";
|
|
699
|
+
};
|
|
700
|
+
readonly uniqueItems: true;
|
|
701
|
+
readonly description: "The relationships the key is (or, while `pending`, will be) listed in. Always exactly its role's single relationship (CONVENTIONS.md §1) — carried so a caller can check it against the document rather than trusting it. Empty for `update`, `retired` and `revoked` keys.";
|
|
702
|
+
};
|
|
703
|
+
readonly keyType: {
|
|
704
|
+
readonly $ref: "#/$defs/KeyType";
|
|
705
|
+
};
|
|
706
|
+
readonly publicKeyMultibase: {
|
|
707
|
+
readonly type: "string";
|
|
708
|
+
readonly minLength: 1;
|
|
709
|
+
readonly description: "The public half, multibase-encoded, exactly as published.";
|
|
710
|
+
};
|
|
711
|
+
readonly state: {
|
|
712
|
+
readonly $ref: "#/$defs/RoleKeyState";
|
|
713
|
+
};
|
|
714
|
+
readonly publishedInVersionId: {
|
|
715
|
+
readonly type: "string";
|
|
716
|
+
readonly description: "versionId of the log entry that first published the key. Absent while `pending`.";
|
|
717
|
+
};
|
|
718
|
+
readonly removedInVersionId: {
|
|
719
|
+
readonly type: "string";
|
|
720
|
+
readonly description: "versionId of the log entry that retired or revoked the key.";
|
|
721
|
+
};
|
|
722
|
+
readonly retireAfter: {
|
|
723
|
+
readonly type: "string";
|
|
724
|
+
readonly format: "date-time";
|
|
725
|
+
readonly description: "For a `retiring` key: the end of its overlap window. Custody projection only.";
|
|
726
|
+
};
|
|
727
|
+
readonly compromisedSince: {
|
|
728
|
+
readonly type: "string";
|
|
729
|
+
readonly format: "date-time";
|
|
730
|
+
readonly description: "For a `revoked` key: the compromise time (VTI-KEY-121) — the earliest instant from which the key is treated as compromised. Where the operator cannot establish it, the time the key was first published. Published, because it is what a verifier needs.";
|
|
731
|
+
};
|
|
732
|
+
readonly rotationId: {
|
|
733
|
+
readonly type: "string";
|
|
734
|
+
readonly description: "The rotation this key was introduced or retired by, when it was.";
|
|
735
|
+
};
|
|
736
|
+
readonly label: {
|
|
737
|
+
readonly type: "string";
|
|
738
|
+
readonly maxLength: 256;
|
|
739
|
+
readonly description: "Operator-facing label. Custody projection only.";
|
|
740
|
+
};
|
|
741
|
+
readonly custody: {
|
|
742
|
+
readonly $ref: "#/$defs/RoleKeyCustody";
|
|
743
|
+
};
|
|
744
|
+
readonly ext: {
|
|
745
|
+
readonly $ref: "#/$defs/Ext";
|
|
746
|
+
};
|
|
747
|
+
readonly activatesAt: {
|
|
748
|
+
readonly type: "string";
|
|
749
|
+
readonly format: "date-time";
|
|
750
|
+
readonly description: "For a `staged` key: when the VTA will begin using it — no earlier than the publishing entry's cache horizon (CONVENTIONS.md §11.1).";
|
|
751
|
+
};
|
|
752
|
+
};
|
|
753
|
+
};
|
|
754
|
+
readonly RoleKeyCustody: {
|
|
755
|
+
readonly title: "RoleKeyCustody";
|
|
756
|
+
readonly type: "object";
|
|
757
|
+
readonly additionalProperties: false;
|
|
758
|
+
readonly required: readonly ["keyId", "exportable", "neverExportable", "inBackups"];
|
|
759
|
+
readonly description: "How the VTA holds a key. Present only in the custody projection. Carries no key material, and a conforming VTA MUST NOT place any in `ext`.";
|
|
760
|
+
readonly properties: {
|
|
761
|
+
readonly keyId: {
|
|
762
|
+
readonly type: "string";
|
|
763
|
+
readonly minLength: 1;
|
|
764
|
+
readonly description: "The custodian record identifier (`keys/*`'s `keyId`) behind this key.";
|
|
765
|
+
};
|
|
766
|
+
readonly origin: {
|
|
767
|
+
readonly $ref: "#/$defs/KeyOrigin";
|
|
768
|
+
};
|
|
769
|
+
readonly exportable: {
|
|
770
|
+
readonly type: "boolean";
|
|
771
|
+
readonly description: "Whether the custodian would release the private half through `keys/export-secret`. Always `false` for `attestation` and `update` keys (CONVENTIONS.md §4). Stated explicitly — never absent — because this is the member an operator reads to confirm a role key cannot leave the VTA, and `keys/*`'s absent-means-exportable reading is the wrong default to leave them to infer.";
|
|
772
|
+
};
|
|
773
|
+
readonly neverExportable: {
|
|
774
|
+
readonly type: "boolean";
|
|
775
|
+
readonly description: "True when no authority can make the key exportable — the role forbids it, or the material exists only inside a module that cannot release it. `true` implies `exportable: false`.";
|
|
776
|
+
};
|
|
777
|
+
readonly hardwareBacked: {
|
|
778
|
+
readonly type: "boolean";
|
|
779
|
+
readonly description: "True when the private half is held by a hardware or enclave module that performs the operation without releasing it. Absent means the VTA does not say, not that it is false.";
|
|
780
|
+
};
|
|
781
|
+
readonly inBackups: {
|
|
782
|
+
readonly type: "boolean";
|
|
783
|
+
readonly description: "Whether the key, or material it can be re-derived from, is included in the VTA's backups or any state transfer. Always `false` for `attestation` and `update` keys (VTI-KEY-112): they are generated, not derived, so there is no seed that recovers them, and their loss is recovered by rotation, never by restore.";
|
|
784
|
+
};
|
|
785
|
+
readonly destroyed: {
|
|
786
|
+
readonly type: "boolean";
|
|
787
|
+
readonly description: "True once the private half has been destroyed — a retired `attestation` key (VTI-KEY-125). The record survives so the key's past signatures stay attributable.";
|
|
788
|
+
};
|
|
789
|
+
};
|
|
790
|
+
};
|
|
791
|
+
readonly KeyOrigin: {
|
|
792
|
+
readonly title: "KeyOrigin";
|
|
793
|
+
readonly type: "string";
|
|
794
|
+
readonly enum: readonly ["derived", "imported", "internal"];
|
|
795
|
+
readonly description: "Where the private key came from. `derived` means the maintainer generated it from a seed it holds and can reproduce it from `derivationPath`; `imported` means it arrived from outside and exists only as stored material; `internal` means the maintainer generated it from a CSPRNG and it is reproducible from nothing at all. The distinction is operationally load-bearing: a `derived` key survives a seed restore, an `imported` one is lost unless it was backed up separately, and an `internal` one cannot be recovered by any means once the maintainer's storage is gone. This member is also the only way a consumer can confirm that a `keys/create` request for an `internal` key was honoured rather than silently downgraded to a derived one — see that specification's `internal` member.";
|
|
796
|
+
readonly default: "derived";
|
|
797
|
+
};
|
|
798
|
+
readonly RoleKeyState: {
|
|
799
|
+
readonly title: "RoleKeyState";
|
|
800
|
+
readonly type: "string";
|
|
801
|
+
readonly enum: readonly ["pending", "staged", "active", "retiring", "retired", "revoked"];
|
|
802
|
+
readonly description: "Where a key is in its role's lifecycle. `pending` — planned by a preview or a change awaiting approval; not published; custody projection only. `staged` — published and bound to its role, but not yet used: a planned rotation publishes the successor and waits until the entry's cache horizon — publication plus the longer of the document's TTL and the verifier cache cap (CONVENTIONS.md §11.1) — before the VTA first uses it, so that no verifier holding a cached document sees a signature by a key it has never seen (VTI-KEY-122). Becomes `active` at the rotation's `activatesAt`. `active` — the key the VTA uses for new signatures (or, for `messaging`, advertises for new sessions). `retiring` — still published so that what it signed and sessions keyed to it keep working, but never used again: from the successor's first use the VTA MUST NOT sign with it, while a retiring `messaging` key stays usable for decryption, and senders may still encrypt to it, until it is retired (CONVENTIONS.md §11.3). `retired` — removed by planned rotation; what it signed while published remains valid, judged against the DID version current at issuance (CONVENTIONS.md §7). A retired `attestation` or `messaging` key is destroyed at retirement. `revoked` — removed from every relationship and from `keyRoles` in one entry, without overlap, because it is or may be compromised; what it signed from `compromisedSince` onward establishes nothing. `retired` and `revoked` are terminal.";
|
|
803
|
+
};
|
|
804
|
+
readonly DidVerificationRelationship: {
|
|
805
|
+
readonly title: "DidVerificationRelationship";
|
|
806
|
+
readonly type: "string";
|
|
807
|
+
readonly enum: readonly ["authentication", "assertionMethod", "keyAgreement", "capabilityInvocation", "capabilityDelegation"];
|
|
808
|
+
readonly description: "A DID Core verification relationship.";
|
|
809
|
+
};
|
|
810
|
+
readonly KeyType: {
|
|
811
|
+
readonly title: "KeyType";
|
|
812
|
+
readonly type: "string";
|
|
813
|
+
readonly enum: readonly ["ed25519", "x25519", "p256", "mldsa44", "mldsa65"];
|
|
814
|
+
readonly description: "Cryptographic algorithm the key material belongs to. `ed25519` signs (EdDSA), `x25519` performs key agreement and never signs, `p256` signs (ES256), and `mldsa44` and `mldsa65` sign with the post-quantum ML-DSA scheme of US NIST FIPS 204. The set is expected to grow as algorithms are standardised, and growing it is a MINOR change under SPEC.md §5.2: `keyType` selects no schema branch, so adding a value relaxes a constraint rather than narrowing one, and the generated libraries mark this enumeration non-exhaustive so that a consumer absorbs a new value rather than failing to compile. Two ML-DSA parameter sets are carried because two specifications require different ones — W3C Quantum-Resistant Cryptosuites defines Data Integrity suites only for ML-DSA-44, while Trust Spanning Protocol Rev 3 §8.1 mandates ML-DSA-65 — so the parameter set is chosen by whatever consumes the key and the two are not redundant. A consumer that does not implement a value it receives MUST refuse the document rather than substitute one it does support.";
|
|
815
|
+
};
|
|
816
|
+
readonly KeyRoleProjection: {
|
|
817
|
+
readonly title: "KeyRoleProjection";
|
|
818
|
+
readonly type: "string";
|
|
819
|
+
readonly enum: readonly ["public", "custody"];
|
|
820
|
+
readonly description: "Which view of the DID's key roles the caller was given (CONVENTIONS.md §5). `public` — only what the published document and log already reveal to anyone who resolves the DID. `custody` — additionally the VTA's own custody state: pending keys, the custodian record behind each key, overlap deadlines, who initiated and approved each change, and why. The response always states which it is, so a caller never mistakes an absent member for a statement that the thing does not exist.";
|
|
821
|
+
};
|
|
822
|
+
};
|
|
823
|
+
};
|
|
824
|
+
/**
|
|
825
|
+
* SPEC.md §7.2 policy for the request variant, from this specification's
|
|
826
|
+
* front matter. Pass to `consumeInbound` — items 5b, 7 and 8 are
|
|
827
|
+
* per-specification and cannot be derived from the document alone, and
|
|
828
|
+
* item 2 needs the schema this carries.
|
|
829
|
+
*/
|
|
830
|
+
export declare const SPEC: {
|
|
831
|
+
readonly typeUri: "https://trusttasks.org/spec/vta/webvh/dids/keys/list/1.0";
|
|
832
|
+
readonly isBearer: false;
|
|
833
|
+
readonly isProofRequired: false;
|
|
834
|
+
readonly isRecipientRequired: true;
|
|
835
|
+
readonly isIssuedAtRequired: false;
|
|
836
|
+
readonly payloadSchema: {
|
|
837
|
+
readonly $schema: "https://json-schema.org/draft/2020-12/schema";
|
|
838
|
+
readonly $id: "https://trusttasks.org/spec/vta/webvh/dids/keys/list/1.0";
|
|
839
|
+
readonly title: "VTA WebVH DIDs Keys List — payload";
|
|
840
|
+
readonly description: "List a did:webvh's keys by role, with their state, and optionally the DID's rotation history and any changes awaiting approval.";
|
|
841
|
+
readonly type: "object";
|
|
842
|
+
readonly additionalProperties: false;
|
|
843
|
+
readonly required: readonly ["did"];
|
|
844
|
+
readonly properties: {
|
|
845
|
+
readonly did: {
|
|
846
|
+
readonly type: "string";
|
|
847
|
+
readonly minLength: 1;
|
|
848
|
+
readonly description: "The DID whose key roles are listed.";
|
|
849
|
+
};
|
|
850
|
+
readonly roles: {
|
|
851
|
+
readonly type: "array";
|
|
852
|
+
readonly items: {
|
|
853
|
+
readonly $ref: "#/$defs/KeyRole";
|
|
854
|
+
};
|
|
855
|
+
readonly uniqueItems: true;
|
|
856
|
+
readonly minItems: 1;
|
|
857
|
+
readonly description: "Return only these roles. Absent returns every role. Present-but-empty is refused by the schema rather than read as 'every role' — emptiness is never a wildcard.";
|
|
858
|
+
};
|
|
859
|
+
readonly includeEnded: {
|
|
860
|
+
readonly type: "boolean";
|
|
861
|
+
readonly description: "Include `retired` and `revoked` keys. Absent reads as false. `revoked` keys still published in `verificationMethod` are always included, because the document shows them to anyone who resolves it.";
|
|
862
|
+
};
|
|
863
|
+
readonly includeHistory: {
|
|
864
|
+
readonly type: "boolean";
|
|
865
|
+
readonly description: "Include the DID's rotation history. Absent reads as false.";
|
|
866
|
+
};
|
|
867
|
+
readonly ext: {
|
|
868
|
+
readonly $ref: "#/$defs/Ext";
|
|
869
|
+
};
|
|
870
|
+
};
|
|
871
|
+
readonly $defs: {
|
|
872
|
+
readonly Response: {
|
|
873
|
+
readonly $anchor: "response";
|
|
874
|
+
readonly title: "VTA WebVH DIDs Keys List — response payload";
|
|
875
|
+
readonly description: "Success response to vta/webvh/dids/keys/list. Type https://trusttasks.org/spec/vta/webvh/dids/keys/list/1.0#response.";
|
|
876
|
+
readonly type: "object";
|
|
877
|
+
readonly additionalProperties: false;
|
|
878
|
+
readonly required: readonly ["did", "versionId", "projection", "roles"];
|
|
879
|
+
readonly properties: {
|
|
880
|
+
readonly did: {
|
|
881
|
+
readonly type: "string";
|
|
882
|
+
};
|
|
883
|
+
readonly versionId: {
|
|
884
|
+
readonly type: "string";
|
|
885
|
+
readonly description: "The log entry the answer describes. Pass it as `expectedVersionId` to a change made on the strength of this answer.";
|
|
886
|
+
};
|
|
887
|
+
readonly projection: {
|
|
888
|
+
readonly $ref: "#/$defs/KeyRoleProjection";
|
|
889
|
+
};
|
|
890
|
+
readonly roles: {
|
|
891
|
+
readonly type: "array";
|
|
892
|
+
readonly items: {
|
|
893
|
+
readonly $ref: "#/$defs/RoleSummary";
|
|
894
|
+
};
|
|
895
|
+
readonly description: "One entry per role asked for, including roles with no keys — an empty role is an answer, and omitting it would read as 'not asked'.";
|
|
896
|
+
};
|
|
897
|
+
readonly rotations: {
|
|
898
|
+
readonly type: "array";
|
|
899
|
+
readonly items: {
|
|
900
|
+
readonly $ref: "#/$defs/RotationRecord";
|
|
901
|
+
};
|
|
902
|
+
readonly description: "Present exactly when `includeHistory` was true. Newest first. In the custody projection this includes changes in `pendingApproval`; in the public projection it includes only changes that published an entry.";
|
|
903
|
+
};
|
|
904
|
+
readonly ext: {
|
|
905
|
+
readonly $ref: "#/$defs/Ext";
|
|
906
|
+
};
|
|
907
|
+
};
|
|
908
|
+
};
|
|
909
|
+
readonly Ext: {
|
|
910
|
+
readonly title: "Ext";
|
|
911
|
+
readonly 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.";
|
|
912
|
+
readonly type: "object";
|
|
913
|
+
readonly minProperties: 1;
|
|
914
|
+
readonly additionalProperties: true;
|
|
915
|
+
readonly propertyNames: {
|
|
916
|
+
readonly pattern: "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$";
|
|
917
|
+
};
|
|
918
|
+
};
|
|
919
|
+
readonly RotationRecord: {
|
|
920
|
+
readonly title: "RotationRecord";
|
|
921
|
+
readonly type: "object";
|
|
922
|
+
readonly additionalProperties: false;
|
|
923
|
+
readonly required: readonly ["rotationId", "role", "kind", "state"];
|
|
924
|
+
readonly description: "One change to a role's key set, from preview to completion. The rotation history of a DID is the list of these; the log is the authority for what was published, and this record adds what the log cannot say — which change was which, and (custody projection only) who asked, who approved, and why.";
|
|
925
|
+
readonly properties: {
|
|
926
|
+
readonly rotationId: {
|
|
927
|
+
readonly type: "string";
|
|
928
|
+
readonly minLength: 1;
|
|
929
|
+
};
|
|
930
|
+
readonly role: {
|
|
931
|
+
readonly $ref: "#/$defs/KeyRole";
|
|
932
|
+
};
|
|
933
|
+
readonly kind: {
|
|
934
|
+
readonly $ref: "#/$defs/RotationKind";
|
|
935
|
+
};
|
|
936
|
+
readonly state: {
|
|
937
|
+
readonly $ref: "#/$defs/RotationState";
|
|
938
|
+
};
|
|
939
|
+
readonly predecessors: {
|
|
940
|
+
readonly type: "array";
|
|
941
|
+
readonly items: {
|
|
942
|
+
readonly type: "string";
|
|
943
|
+
};
|
|
944
|
+
readonly description: "Verification-method identifiers (or, for `update`, public keys) leaving the role.";
|
|
945
|
+
};
|
|
946
|
+
readonly successors: {
|
|
947
|
+
readonly type: "array";
|
|
948
|
+
readonly items: {
|
|
949
|
+
readonly type: "string";
|
|
950
|
+
};
|
|
951
|
+
readonly description: "Verification-method identifiers (or, for `update`, public keys) entering the role.";
|
|
952
|
+
};
|
|
953
|
+
readonly startedInVersionId: {
|
|
954
|
+
readonly type: "string";
|
|
955
|
+
};
|
|
956
|
+
readonly endedInVersionId: {
|
|
957
|
+
readonly type: "string";
|
|
958
|
+
};
|
|
959
|
+
readonly startedAt: {
|
|
960
|
+
readonly type: "string";
|
|
961
|
+
readonly format: "date-time";
|
|
962
|
+
};
|
|
963
|
+
readonly overlapUntil: {
|
|
964
|
+
readonly type: "string";
|
|
965
|
+
readonly format: "date-time";
|
|
966
|
+
readonly description: "Custody projection only. End of the overlap window.";
|
|
967
|
+
};
|
|
968
|
+
readonly autoRetire: {
|
|
969
|
+
readonly type: "boolean";
|
|
970
|
+
readonly description: "Custody projection only. Whether the VTA retires the predecessor itself at `overlapUntil`.";
|
|
971
|
+
};
|
|
972
|
+
readonly endedAt: {
|
|
973
|
+
readonly type: "string";
|
|
974
|
+
readonly format: "date-time";
|
|
975
|
+
};
|
|
976
|
+
readonly initiatedBy: {
|
|
977
|
+
readonly type: "string";
|
|
978
|
+
readonly description: "Custody projection only. VID of the administrator whose signed request started the change.";
|
|
979
|
+
};
|
|
980
|
+
readonly approvals: {
|
|
981
|
+
readonly $ref: "#/$defs/KeyRoleApprovalState";
|
|
982
|
+
readonly description: "Custody projection only.";
|
|
983
|
+
};
|
|
984
|
+
readonly reason: {
|
|
985
|
+
readonly type: "string";
|
|
986
|
+
readonly maxLength: 1024;
|
|
987
|
+
readonly description: "Custody projection only. The operator's stated reason. Never published.";
|
|
988
|
+
};
|
|
989
|
+
readonly ext: {
|
|
990
|
+
readonly $ref: "#/$defs/Ext";
|
|
991
|
+
};
|
|
992
|
+
readonly activatesAt: {
|
|
993
|
+
readonly type: "string";
|
|
994
|
+
readonly format: "date-time";
|
|
995
|
+
readonly description: "When the successor becomes `active` and the predecessor `retiring`; never before `cacheHorizonAt`.";
|
|
996
|
+
};
|
|
997
|
+
readonly cacheHorizonAt: {
|
|
998
|
+
readonly type: "string";
|
|
999
|
+
readonly format: "date-time";
|
|
1000
|
+
readonly description: "Planned rotations: the publishing entry's cache horizon — publication plus the longer of the document's TTL and the verifier cache cap (CONVENTIONS.md §11.1). The switch, and any retirement of the predecessor, happen no earlier. Public: it follows from the log and the published cap.";
|
|
1001
|
+
};
|
|
1002
|
+
};
|
|
1003
|
+
};
|
|
1004
|
+
readonly KeyRoleApprovalState: {
|
|
1005
|
+
readonly title: "KeyRoleApprovalState";
|
|
1006
|
+
readonly type: "object";
|
|
1007
|
+
readonly additionalProperties: false;
|
|
1008
|
+
readonly required: readonly ["required", "received", "expiresAt"];
|
|
1009
|
+
readonly description: "Approval progress of a change the VTA's policy gates on more than one approval (CONVENTIONS.md §3.3).";
|
|
1010
|
+
readonly properties: {
|
|
1011
|
+
readonly required: {
|
|
1012
|
+
readonly type: "integer";
|
|
1013
|
+
readonly minimum: 1;
|
|
1014
|
+
readonly description: "Distinct approvals the VTA's policy requires.";
|
|
1015
|
+
};
|
|
1016
|
+
readonly received: {
|
|
1017
|
+
readonly type: "integer";
|
|
1018
|
+
readonly minimum: 0;
|
|
1019
|
+
readonly description: "Distinct approvals recorded so far, including the initiator's own.";
|
|
1020
|
+
};
|
|
1021
|
+
readonly approvers: {
|
|
1022
|
+
readonly type: "array";
|
|
1023
|
+
readonly items: {
|
|
1024
|
+
readonly type: "string";
|
|
1025
|
+
};
|
|
1026
|
+
readonly uniqueItems: true;
|
|
1027
|
+
readonly description: "VIDs whose approvals were recorded. Custody projection only; omitted from a response to anyone who is not themselves an eligible approver of this change.";
|
|
1028
|
+
};
|
|
1029
|
+
readonly expiresAt: {
|
|
1030
|
+
readonly type: "string";
|
|
1031
|
+
readonly format: "date-time";
|
|
1032
|
+
readonly description: "When the preview, and every approval bound to it, stops being usable.";
|
|
1033
|
+
};
|
|
1034
|
+
};
|
|
1035
|
+
};
|
|
1036
|
+
readonly RotationState: {
|
|
1037
|
+
readonly title: "RotationState";
|
|
1038
|
+
readonly type: "string";
|
|
1039
|
+
readonly enum: readonly ["pendingApproval", "staged", "overlapping", "completed", "aborted", "expired"];
|
|
1040
|
+
readonly description: "`pendingApproval` — awaiting the approvals the VTA's policy requires; nothing is published. `staged` — successor published, not yet used; predecessor still active. `overlapping` — successor active, predecessor `retiring`. `completed` — every predecessor retired (or, for `compromise` and `addition`, the entry is published and any overlap it began has ended). `aborted` — the successor was retired instead of the predecessor, which stayed or returned to `active`. `expired` — approvals were not gathered before the preview expired; nothing was published.";
|
|
1041
|
+
};
|
|
1042
|
+
readonly RotationKind: {
|
|
1043
|
+
readonly title: "RotationKind";
|
|
1044
|
+
readonly type: "string";
|
|
1045
|
+
readonly enum: readonly ["planned", "compromise", "addition"];
|
|
1046
|
+
readonly description: "`planned` — a successor was staged, activated, and the predecessor retired on the operator's schedule. `compromise` — a key was revoked and, where the role would otherwise be empty, replaced in the same log entry. `addition` — a key was added to a role without anything leaving it (for example a post-quantum key alongside a classical one).";
|
|
1047
|
+
};
|
|
1048
|
+
readonly KeyRole: {
|
|
1049
|
+
readonly title: "KeyRole";
|
|
1050
|
+
readonly type: "string";
|
|
1051
|
+
readonly enum: readonly ["attestation", "operational", "messaging", "update"];
|
|
1052
|
+
readonly description: "The named key role a key occupies in the DID (VTI-KEY-070 onward). `attestation` — the only keys in `assertionMethod`; sign the DID's attestation artefacts (membership and role credentials, endorsements, status lists, every other credential the node issues), through the VTA's signing service and nowhere else. Generated inside the VTA, never derived, never exportable, never in a backup. `operational` — the only keys in `authentication`; sign the node's own traffic (Trust Task requests and responses, DIDComm and TSP message signatures, invitations, notices, audit checkpoints) with proof purpose `authentication`. `messaging` — the only keys in `keyAgreement`; sign nothing. `update` — the keys that authorize appending to the DID's log (a did:webvh `updateKeys` entry) and the pre-rotation commitments that authorize the next ones; never a verification method, never in `keyRoles`. Generated inside the VTA, never derived, never exportable, never in a backup. No role permits `capabilityInvocation` or `capabilityDelegation` (VTI-KEY-075); both are reserved for a future role. The mapping is normative and is set out in CONVENTIONS.md §1. The set is an extensible registry and growing it is a MINOR change: a consumer that receives a role it does not implement MUST refuse the document rather than map the key onto a role it does know.";
|
|
1053
|
+
};
|
|
1054
|
+
readonly RoleSummary: {
|
|
1055
|
+
readonly title: "RoleSummary";
|
|
1056
|
+
readonly type: "object";
|
|
1057
|
+
readonly additionalProperties: false;
|
|
1058
|
+
readonly required: readonly ["role", "relationships", "keys"];
|
|
1059
|
+
readonly properties: {
|
|
1060
|
+
readonly role: {
|
|
1061
|
+
readonly $ref: "#/$defs/KeyRole";
|
|
1062
|
+
};
|
|
1063
|
+
readonly relationships: {
|
|
1064
|
+
readonly type: "array";
|
|
1065
|
+
readonly items: {
|
|
1066
|
+
readonly $ref: "#/$defs/DidVerificationRelationship";
|
|
1067
|
+
};
|
|
1068
|
+
readonly uniqueItems: true;
|
|
1069
|
+
readonly description: "The relationship this role owns (CONVENTIONS.md §1). Empty for `update`.";
|
|
1070
|
+
};
|
|
1071
|
+
readonly keys: {
|
|
1072
|
+
readonly type: "array";
|
|
1073
|
+
readonly items: {
|
|
1074
|
+
readonly $ref: "#/$defs/RoleKey";
|
|
1075
|
+
};
|
|
1076
|
+
readonly description: "The role's keys, in the order the document publishes them. Terminal-state keys are included only when the request asked for them.";
|
|
1077
|
+
};
|
|
1078
|
+
readonly preRotationCommitments: {
|
|
1079
|
+
readonly type: "integer";
|
|
1080
|
+
readonly minimum: 0;
|
|
1081
|
+
readonly description: "`update` only: successors the latest entry commits to. `0` means a compromise of the current update key cannot be recovered from by rotation, and the DID would have to be deactivated (VTI-KEY-124).";
|
|
1082
|
+
};
|
|
1083
|
+
};
|
|
1084
|
+
};
|
|
1085
|
+
readonly RoleKey: {
|
|
1086
|
+
readonly title: "RoleKey";
|
|
1087
|
+
readonly type: "object";
|
|
1088
|
+
readonly additionalProperties: false;
|
|
1089
|
+
readonly required: readonly ["role", "keyType", "publicKeyMultibase", "state"];
|
|
1090
|
+
readonly description: "One key in one role. A key is in exactly one role for its whole life; a change of role is a retirement from one and an addition to another, under a new verification-method identifier.";
|
|
1091
|
+
readonly properties: {
|
|
1092
|
+
readonly verificationMethod: {
|
|
1093
|
+
readonly type: "string";
|
|
1094
|
+
readonly minLength: 1;
|
|
1095
|
+
readonly description: "The full verification-method identifier (`did#fragment`) the document publishes the key under, and lists in `keyRoles`. Absent only for `update` keys, which are published as log parameters and never as verification methods (VTI-KEY-093). A VTA minting a new method SHOULD derive its fragment from the key (VTI-KEY-150).";
|
|
1096
|
+
};
|
|
1097
|
+
readonly role: {
|
|
1098
|
+
readonly $ref: "#/$defs/KeyRole";
|
|
1099
|
+
};
|
|
1100
|
+
readonly relationships: {
|
|
1101
|
+
readonly type: "array";
|
|
1102
|
+
readonly items: {
|
|
1103
|
+
readonly $ref: "#/$defs/DidVerificationRelationship";
|
|
1104
|
+
};
|
|
1105
|
+
readonly uniqueItems: true;
|
|
1106
|
+
readonly description: "The relationships the key is (or, while `pending`, will be) listed in. Always exactly its role's single relationship (CONVENTIONS.md §1) — carried so a caller can check it against the document rather than trusting it. Empty for `update`, `retired` and `revoked` keys.";
|
|
1107
|
+
};
|
|
1108
|
+
readonly keyType: {
|
|
1109
|
+
readonly $ref: "#/$defs/KeyType";
|
|
1110
|
+
};
|
|
1111
|
+
readonly publicKeyMultibase: {
|
|
1112
|
+
readonly type: "string";
|
|
1113
|
+
readonly minLength: 1;
|
|
1114
|
+
readonly description: "The public half, multibase-encoded, exactly as published.";
|
|
1115
|
+
};
|
|
1116
|
+
readonly state: {
|
|
1117
|
+
readonly $ref: "#/$defs/RoleKeyState";
|
|
1118
|
+
};
|
|
1119
|
+
readonly publishedInVersionId: {
|
|
1120
|
+
readonly type: "string";
|
|
1121
|
+
readonly description: "versionId of the log entry that first published the key. Absent while `pending`.";
|
|
1122
|
+
};
|
|
1123
|
+
readonly removedInVersionId: {
|
|
1124
|
+
readonly type: "string";
|
|
1125
|
+
readonly description: "versionId of the log entry that retired or revoked the key.";
|
|
1126
|
+
};
|
|
1127
|
+
readonly retireAfter: {
|
|
1128
|
+
readonly type: "string";
|
|
1129
|
+
readonly format: "date-time";
|
|
1130
|
+
readonly description: "For a `retiring` key: the end of its overlap window. Custody projection only.";
|
|
1131
|
+
};
|
|
1132
|
+
readonly compromisedSince: {
|
|
1133
|
+
readonly type: "string";
|
|
1134
|
+
readonly format: "date-time";
|
|
1135
|
+
readonly description: "For a `revoked` key: the compromise time (VTI-KEY-121) — the earliest instant from which the key is treated as compromised. Where the operator cannot establish it, the time the key was first published. Published, because it is what a verifier needs.";
|
|
1136
|
+
};
|
|
1137
|
+
readonly rotationId: {
|
|
1138
|
+
readonly type: "string";
|
|
1139
|
+
readonly description: "The rotation this key was introduced or retired by, when it was.";
|
|
1140
|
+
};
|
|
1141
|
+
readonly label: {
|
|
1142
|
+
readonly type: "string";
|
|
1143
|
+
readonly maxLength: 256;
|
|
1144
|
+
readonly description: "Operator-facing label. Custody projection only.";
|
|
1145
|
+
};
|
|
1146
|
+
readonly custody: {
|
|
1147
|
+
readonly $ref: "#/$defs/RoleKeyCustody";
|
|
1148
|
+
};
|
|
1149
|
+
readonly ext: {
|
|
1150
|
+
readonly $ref: "#/$defs/Ext";
|
|
1151
|
+
};
|
|
1152
|
+
readonly activatesAt: {
|
|
1153
|
+
readonly type: "string";
|
|
1154
|
+
readonly format: "date-time";
|
|
1155
|
+
readonly description: "For a `staged` key: when the VTA will begin using it — no earlier than the publishing entry's cache horizon (CONVENTIONS.md §11.1).";
|
|
1156
|
+
};
|
|
1157
|
+
};
|
|
1158
|
+
};
|
|
1159
|
+
readonly RoleKeyCustody: {
|
|
1160
|
+
readonly title: "RoleKeyCustody";
|
|
1161
|
+
readonly type: "object";
|
|
1162
|
+
readonly additionalProperties: false;
|
|
1163
|
+
readonly required: readonly ["keyId", "exportable", "neverExportable", "inBackups"];
|
|
1164
|
+
readonly description: "How the VTA holds a key. Present only in the custody projection. Carries no key material, and a conforming VTA MUST NOT place any in `ext`.";
|
|
1165
|
+
readonly properties: {
|
|
1166
|
+
readonly keyId: {
|
|
1167
|
+
readonly type: "string";
|
|
1168
|
+
readonly minLength: 1;
|
|
1169
|
+
readonly description: "The custodian record identifier (`keys/*`'s `keyId`) behind this key.";
|
|
1170
|
+
};
|
|
1171
|
+
readonly origin: {
|
|
1172
|
+
readonly $ref: "#/$defs/KeyOrigin";
|
|
1173
|
+
};
|
|
1174
|
+
readonly exportable: {
|
|
1175
|
+
readonly type: "boolean";
|
|
1176
|
+
readonly description: "Whether the custodian would release the private half through `keys/export-secret`. Always `false` for `attestation` and `update` keys (CONVENTIONS.md §4). Stated explicitly — never absent — because this is the member an operator reads to confirm a role key cannot leave the VTA, and `keys/*`'s absent-means-exportable reading is the wrong default to leave them to infer.";
|
|
1177
|
+
};
|
|
1178
|
+
readonly neverExportable: {
|
|
1179
|
+
readonly type: "boolean";
|
|
1180
|
+
readonly description: "True when no authority can make the key exportable — the role forbids it, or the material exists only inside a module that cannot release it. `true` implies `exportable: false`.";
|
|
1181
|
+
};
|
|
1182
|
+
readonly hardwareBacked: {
|
|
1183
|
+
readonly type: "boolean";
|
|
1184
|
+
readonly description: "True when the private half is held by a hardware or enclave module that performs the operation without releasing it. Absent means the VTA does not say, not that it is false.";
|
|
1185
|
+
};
|
|
1186
|
+
readonly inBackups: {
|
|
1187
|
+
readonly type: "boolean";
|
|
1188
|
+
readonly description: "Whether the key, or material it can be re-derived from, is included in the VTA's backups or any state transfer. Always `false` for `attestation` and `update` keys (VTI-KEY-112): they are generated, not derived, so there is no seed that recovers them, and their loss is recovered by rotation, never by restore.";
|
|
1189
|
+
};
|
|
1190
|
+
readonly destroyed: {
|
|
1191
|
+
readonly type: "boolean";
|
|
1192
|
+
readonly description: "True once the private half has been destroyed — a retired `attestation` key (VTI-KEY-125). The record survives so the key's past signatures stay attributable.";
|
|
1193
|
+
};
|
|
1194
|
+
};
|
|
1195
|
+
};
|
|
1196
|
+
readonly KeyOrigin: {
|
|
1197
|
+
readonly title: "KeyOrigin";
|
|
1198
|
+
readonly type: "string";
|
|
1199
|
+
readonly enum: readonly ["derived", "imported", "internal"];
|
|
1200
|
+
readonly description: "Where the private key came from. `derived` means the maintainer generated it from a seed it holds and can reproduce it from `derivationPath`; `imported` means it arrived from outside and exists only as stored material; `internal` means the maintainer generated it from a CSPRNG and it is reproducible from nothing at all. The distinction is operationally load-bearing: a `derived` key survives a seed restore, an `imported` one is lost unless it was backed up separately, and an `internal` one cannot be recovered by any means once the maintainer's storage is gone. This member is also the only way a consumer can confirm that a `keys/create` request for an `internal` key was honoured rather than silently downgraded to a derived one — see that specification's `internal` member.";
|
|
1201
|
+
readonly default: "derived";
|
|
1202
|
+
};
|
|
1203
|
+
readonly RoleKeyState: {
|
|
1204
|
+
readonly title: "RoleKeyState";
|
|
1205
|
+
readonly type: "string";
|
|
1206
|
+
readonly enum: readonly ["pending", "staged", "active", "retiring", "retired", "revoked"];
|
|
1207
|
+
readonly description: "Where a key is in its role's lifecycle. `pending` — planned by a preview or a change awaiting approval; not published; custody projection only. `staged` — published and bound to its role, but not yet used: a planned rotation publishes the successor and waits until the entry's cache horizon — publication plus the longer of the document's TTL and the verifier cache cap (CONVENTIONS.md §11.1) — before the VTA first uses it, so that no verifier holding a cached document sees a signature by a key it has never seen (VTI-KEY-122). Becomes `active` at the rotation's `activatesAt`. `active` — the key the VTA uses for new signatures (or, for `messaging`, advertises for new sessions). `retiring` — still published so that what it signed and sessions keyed to it keep working, but never used again: from the successor's first use the VTA MUST NOT sign with it, while a retiring `messaging` key stays usable for decryption, and senders may still encrypt to it, until it is retired (CONVENTIONS.md §11.3). `retired` — removed by planned rotation; what it signed while published remains valid, judged against the DID version current at issuance (CONVENTIONS.md §7). A retired `attestation` or `messaging` key is destroyed at retirement. `revoked` — removed from every relationship and from `keyRoles` in one entry, without overlap, because it is or may be compromised; what it signed from `compromisedSince` onward establishes nothing. `retired` and `revoked` are terminal.";
|
|
1208
|
+
};
|
|
1209
|
+
readonly DidVerificationRelationship: {
|
|
1210
|
+
readonly title: "DidVerificationRelationship";
|
|
1211
|
+
readonly type: "string";
|
|
1212
|
+
readonly enum: readonly ["authentication", "assertionMethod", "keyAgreement", "capabilityInvocation", "capabilityDelegation"];
|
|
1213
|
+
readonly description: "A DID Core verification relationship.";
|
|
1214
|
+
};
|
|
1215
|
+
readonly KeyType: {
|
|
1216
|
+
readonly title: "KeyType";
|
|
1217
|
+
readonly type: "string";
|
|
1218
|
+
readonly enum: readonly ["ed25519", "x25519", "p256", "mldsa44", "mldsa65"];
|
|
1219
|
+
readonly description: "Cryptographic algorithm the key material belongs to. `ed25519` signs (EdDSA), `x25519` performs key agreement and never signs, `p256` signs (ES256), and `mldsa44` and `mldsa65` sign with the post-quantum ML-DSA scheme of US NIST FIPS 204. The set is expected to grow as algorithms are standardised, and growing it is a MINOR change under SPEC.md §5.2: `keyType` selects no schema branch, so adding a value relaxes a constraint rather than narrowing one, and the generated libraries mark this enumeration non-exhaustive so that a consumer absorbs a new value rather than failing to compile. Two ML-DSA parameter sets are carried because two specifications require different ones — W3C Quantum-Resistant Cryptosuites defines Data Integrity suites only for ML-DSA-44, while Trust Spanning Protocol Rev 3 §8.1 mandates ML-DSA-65 — so the parameter set is chosen by whatever consumes the key and the two are not redundant. A consumer that does not implement a value it receives MUST refuse the document rather than substitute one it does support.";
|
|
1220
|
+
};
|
|
1221
|
+
readonly KeyRoleProjection: {
|
|
1222
|
+
readonly title: "KeyRoleProjection";
|
|
1223
|
+
readonly type: "string";
|
|
1224
|
+
readonly enum: readonly ["public", "custody"];
|
|
1225
|
+
readonly description: "Which view of the DID's key roles the caller was given (CONVENTIONS.md §5). `public` — only what the published document and log already reveal to anyone who resolves the DID. `custody` — additionally the VTA's own custody state: pending keys, the custodian record behind each key, overlap deadlines, who initiated and approved each change, and why. The response always states which it is, so a caller never mistakes an absent member for a statement that the thing does not exist.";
|
|
1226
|
+
};
|
|
1227
|
+
};
|
|
1228
|
+
};
|
|
1229
|
+
};
|
|
1230
|
+
/**
|
|
1231
|
+
* SPEC.md §7.2 policy for the success-response variant. `isRecipientRequired`
|
|
1232
|
+
* tracks the *issuer* party's requirement because a response swaps the
|
|
1233
|
+
* parties (§7.3 item 5).
|
|
1234
|
+
*/
|
|
1235
|
+
export declare const RESPONSE_SPEC: {
|
|
1236
|
+
readonly typeUri: "https://trusttasks.org/spec/vta/webvh/dids/keys/list/1.0#response";
|
|
1237
|
+
readonly isBearer: false;
|
|
1238
|
+
readonly isProofRequired: false;
|
|
1239
|
+
readonly isRecipientRequired: true;
|
|
1240
|
+
readonly isIssuedAtRequired: false;
|
|
1241
|
+
readonly payloadSchema: {
|
|
1242
|
+
readonly $schema: "https://json-schema.org/draft/2020-12/schema";
|
|
1243
|
+
readonly $ref: "#/$defs/Response";
|
|
1244
|
+
readonly $defs: {
|
|
1245
|
+
readonly Response: {
|
|
1246
|
+
readonly $anchor: "response";
|
|
1247
|
+
readonly title: "VTA WebVH DIDs Keys List — response payload";
|
|
1248
|
+
readonly description: "Success response to vta/webvh/dids/keys/list. Type https://trusttasks.org/spec/vta/webvh/dids/keys/list/1.0#response.";
|
|
1249
|
+
readonly type: "object";
|
|
1250
|
+
readonly additionalProperties: false;
|
|
1251
|
+
readonly required: readonly ["did", "versionId", "projection", "roles"];
|
|
1252
|
+
readonly properties: {
|
|
1253
|
+
readonly did: {
|
|
1254
|
+
readonly type: "string";
|
|
1255
|
+
};
|
|
1256
|
+
readonly versionId: {
|
|
1257
|
+
readonly type: "string";
|
|
1258
|
+
readonly description: "The log entry the answer describes. Pass it as `expectedVersionId` to a change made on the strength of this answer.";
|
|
1259
|
+
};
|
|
1260
|
+
readonly projection: {
|
|
1261
|
+
readonly $ref: "#/$defs/KeyRoleProjection";
|
|
1262
|
+
};
|
|
1263
|
+
readonly roles: {
|
|
1264
|
+
readonly type: "array";
|
|
1265
|
+
readonly items: {
|
|
1266
|
+
readonly $ref: "#/$defs/RoleSummary";
|
|
1267
|
+
};
|
|
1268
|
+
readonly description: "One entry per role asked for, including roles with no keys — an empty role is an answer, and omitting it would read as 'not asked'.";
|
|
1269
|
+
};
|
|
1270
|
+
readonly rotations: {
|
|
1271
|
+
readonly type: "array";
|
|
1272
|
+
readonly items: {
|
|
1273
|
+
readonly $ref: "#/$defs/RotationRecord";
|
|
1274
|
+
};
|
|
1275
|
+
readonly description: "Present exactly when `includeHistory` was true. Newest first. In the custody projection this includes changes in `pendingApproval`; in the public projection it includes only changes that published an entry.";
|
|
1276
|
+
};
|
|
1277
|
+
readonly ext: {
|
|
1278
|
+
readonly $ref: "#/$defs/Ext";
|
|
1279
|
+
};
|
|
1280
|
+
};
|
|
1281
|
+
};
|
|
1282
|
+
readonly Ext: {
|
|
1283
|
+
readonly title: "Ext";
|
|
1284
|
+
readonly 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.";
|
|
1285
|
+
readonly type: "object";
|
|
1286
|
+
readonly minProperties: 1;
|
|
1287
|
+
readonly additionalProperties: true;
|
|
1288
|
+
readonly propertyNames: {
|
|
1289
|
+
readonly pattern: "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$";
|
|
1290
|
+
};
|
|
1291
|
+
};
|
|
1292
|
+
readonly RotationRecord: {
|
|
1293
|
+
readonly title: "RotationRecord";
|
|
1294
|
+
readonly type: "object";
|
|
1295
|
+
readonly additionalProperties: false;
|
|
1296
|
+
readonly required: readonly ["rotationId", "role", "kind", "state"];
|
|
1297
|
+
readonly description: "One change to a role's key set, from preview to completion. The rotation history of a DID is the list of these; the log is the authority for what was published, and this record adds what the log cannot say — which change was which, and (custody projection only) who asked, who approved, and why.";
|
|
1298
|
+
readonly properties: {
|
|
1299
|
+
readonly rotationId: {
|
|
1300
|
+
readonly type: "string";
|
|
1301
|
+
readonly minLength: 1;
|
|
1302
|
+
};
|
|
1303
|
+
readonly role: {
|
|
1304
|
+
readonly $ref: "#/$defs/KeyRole";
|
|
1305
|
+
};
|
|
1306
|
+
readonly kind: {
|
|
1307
|
+
readonly $ref: "#/$defs/RotationKind";
|
|
1308
|
+
};
|
|
1309
|
+
readonly state: {
|
|
1310
|
+
readonly $ref: "#/$defs/RotationState";
|
|
1311
|
+
};
|
|
1312
|
+
readonly predecessors: {
|
|
1313
|
+
readonly type: "array";
|
|
1314
|
+
readonly items: {
|
|
1315
|
+
readonly type: "string";
|
|
1316
|
+
};
|
|
1317
|
+
readonly description: "Verification-method identifiers (or, for `update`, public keys) leaving the role.";
|
|
1318
|
+
};
|
|
1319
|
+
readonly successors: {
|
|
1320
|
+
readonly type: "array";
|
|
1321
|
+
readonly items: {
|
|
1322
|
+
readonly type: "string";
|
|
1323
|
+
};
|
|
1324
|
+
readonly description: "Verification-method identifiers (or, for `update`, public keys) entering the role.";
|
|
1325
|
+
};
|
|
1326
|
+
readonly startedInVersionId: {
|
|
1327
|
+
readonly type: "string";
|
|
1328
|
+
};
|
|
1329
|
+
readonly endedInVersionId: {
|
|
1330
|
+
readonly type: "string";
|
|
1331
|
+
};
|
|
1332
|
+
readonly startedAt: {
|
|
1333
|
+
readonly type: "string";
|
|
1334
|
+
readonly format: "date-time";
|
|
1335
|
+
};
|
|
1336
|
+
readonly overlapUntil: {
|
|
1337
|
+
readonly type: "string";
|
|
1338
|
+
readonly format: "date-time";
|
|
1339
|
+
readonly description: "Custody projection only. End of the overlap window.";
|
|
1340
|
+
};
|
|
1341
|
+
readonly autoRetire: {
|
|
1342
|
+
readonly type: "boolean";
|
|
1343
|
+
readonly description: "Custody projection only. Whether the VTA retires the predecessor itself at `overlapUntil`.";
|
|
1344
|
+
};
|
|
1345
|
+
readonly endedAt: {
|
|
1346
|
+
readonly type: "string";
|
|
1347
|
+
readonly format: "date-time";
|
|
1348
|
+
};
|
|
1349
|
+
readonly initiatedBy: {
|
|
1350
|
+
readonly type: "string";
|
|
1351
|
+
readonly description: "Custody projection only. VID of the administrator whose signed request started the change.";
|
|
1352
|
+
};
|
|
1353
|
+
readonly approvals: {
|
|
1354
|
+
readonly $ref: "#/$defs/KeyRoleApprovalState";
|
|
1355
|
+
readonly description: "Custody projection only.";
|
|
1356
|
+
};
|
|
1357
|
+
readonly reason: {
|
|
1358
|
+
readonly type: "string";
|
|
1359
|
+
readonly maxLength: 1024;
|
|
1360
|
+
readonly description: "Custody projection only. The operator's stated reason. Never published.";
|
|
1361
|
+
};
|
|
1362
|
+
readonly ext: {
|
|
1363
|
+
readonly $ref: "#/$defs/Ext";
|
|
1364
|
+
};
|
|
1365
|
+
readonly activatesAt: {
|
|
1366
|
+
readonly type: "string";
|
|
1367
|
+
readonly format: "date-time";
|
|
1368
|
+
readonly description: "When the successor becomes `active` and the predecessor `retiring`; never before `cacheHorizonAt`.";
|
|
1369
|
+
};
|
|
1370
|
+
readonly cacheHorizonAt: {
|
|
1371
|
+
readonly type: "string";
|
|
1372
|
+
readonly format: "date-time";
|
|
1373
|
+
readonly description: "Planned rotations: the publishing entry's cache horizon — publication plus the longer of the document's TTL and the verifier cache cap (CONVENTIONS.md §11.1). The switch, and any retirement of the predecessor, happen no earlier. Public: it follows from the log and the published cap.";
|
|
1374
|
+
};
|
|
1375
|
+
};
|
|
1376
|
+
};
|
|
1377
|
+
readonly KeyRoleApprovalState: {
|
|
1378
|
+
readonly title: "KeyRoleApprovalState";
|
|
1379
|
+
readonly type: "object";
|
|
1380
|
+
readonly additionalProperties: false;
|
|
1381
|
+
readonly required: readonly ["required", "received", "expiresAt"];
|
|
1382
|
+
readonly description: "Approval progress of a change the VTA's policy gates on more than one approval (CONVENTIONS.md §3.3).";
|
|
1383
|
+
readonly properties: {
|
|
1384
|
+
readonly required: {
|
|
1385
|
+
readonly type: "integer";
|
|
1386
|
+
readonly minimum: 1;
|
|
1387
|
+
readonly description: "Distinct approvals the VTA's policy requires.";
|
|
1388
|
+
};
|
|
1389
|
+
readonly received: {
|
|
1390
|
+
readonly type: "integer";
|
|
1391
|
+
readonly minimum: 0;
|
|
1392
|
+
readonly description: "Distinct approvals recorded so far, including the initiator's own.";
|
|
1393
|
+
};
|
|
1394
|
+
readonly approvers: {
|
|
1395
|
+
readonly type: "array";
|
|
1396
|
+
readonly items: {
|
|
1397
|
+
readonly type: "string";
|
|
1398
|
+
};
|
|
1399
|
+
readonly uniqueItems: true;
|
|
1400
|
+
readonly description: "VIDs whose approvals were recorded. Custody projection only; omitted from a response to anyone who is not themselves an eligible approver of this change.";
|
|
1401
|
+
};
|
|
1402
|
+
readonly expiresAt: {
|
|
1403
|
+
readonly type: "string";
|
|
1404
|
+
readonly format: "date-time";
|
|
1405
|
+
readonly description: "When the preview, and every approval bound to it, stops being usable.";
|
|
1406
|
+
};
|
|
1407
|
+
};
|
|
1408
|
+
};
|
|
1409
|
+
readonly RotationState: {
|
|
1410
|
+
readonly title: "RotationState";
|
|
1411
|
+
readonly type: "string";
|
|
1412
|
+
readonly enum: readonly ["pendingApproval", "staged", "overlapping", "completed", "aborted", "expired"];
|
|
1413
|
+
readonly description: "`pendingApproval` — awaiting the approvals the VTA's policy requires; nothing is published. `staged` — successor published, not yet used; predecessor still active. `overlapping` — successor active, predecessor `retiring`. `completed` — every predecessor retired (or, for `compromise` and `addition`, the entry is published and any overlap it began has ended). `aborted` — the successor was retired instead of the predecessor, which stayed or returned to `active`. `expired` — approvals were not gathered before the preview expired; nothing was published.";
|
|
1414
|
+
};
|
|
1415
|
+
readonly RotationKind: {
|
|
1416
|
+
readonly title: "RotationKind";
|
|
1417
|
+
readonly type: "string";
|
|
1418
|
+
readonly enum: readonly ["planned", "compromise", "addition"];
|
|
1419
|
+
readonly description: "`planned` — a successor was staged, activated, and the predecessor retired on the operator's schedule. `compromise` — a key was revoked and, where the role would otherwise be empty, replaced in the same log entry. `addition` — a key was added to a role without anything leaving it (for example a post-quantum key alongside a classical one).";
|
|
1420
|
+
};
|
|
1421
|
+
readonly KeyRole: {
|
|
1422
|
+
readonly title: "KeyRole";
|
|
1423
|
+
readonly type: "string";
|
|
1424
|
+
readonly enum: readonly ["attestation", "operational", "messaging", "update"];
|
|
1425
|
+
readonly description: "The named key role a key occupies in the DID (VTI-KEY-070 onward). `attestation` — the only keys in `assertionMethod`; sign the DID's attestation artefacts (membership and role credentials, endorsements, status lists, every other credential the node issues), through the VTA's signing service and nowhere else. Generated inside the VTA, never derived, never exportable, never in a backup. `operational` — the only keys in `authentication`; sign the node's own traffic (Trust Task requests and responses, DIDComm and TSP message signatures, invitations, notices, audit checkpoints) with proof purpose `authentication`. `messaging` — the only keys in `keyAgreement`; sign nothing. `update` — the keys that authorize appending to the DID's log (a did:webvh `updateKeys` entry) and the pre-rotation commitments that authorize the next ones; never a verification method, never in `keyRoles`. Generated inside the VTA, never derived, never exportable, never in a backup. No role permits `capabilityInvocation` or `capabilityDelegation` (VTI-KEY-075); both are reserved for a future role. The mapping is normative and is set out in CONVENTIONS.md §1. The set is an extensible registry and growing it is a MINOR change: a consumer that receives a role it does not implement MUST refuse the document rather than map the key onto a role it does know.";
|
|
1426
|
+
};
|
|
1427
|
+
readonly RoleSummary: {
|
|
1428
|
+
readonly title: "RoleSummary";
|
|
1429
|
+
readonly type: "object";
|
|
1430
|
+
readonly additionalProperties: false;
|
|
1431
|
+
readonly required: readonly ["role", "relationships", "keys"];
|
|
1432
|
+
readonly properties: {
|
|
1433
|
+
readonly role: {
|
|
1434
|
+
readonly $ref: "#/$defs/KeyRole";
|
|
1435
|
+
};
|
|
1436
|
+
readonly relationships: {
|
|
1437
|
+
readonly type: "array";
|
|
1438
|
+
readonly items: {
|
|
1439
|
+
readonly $ref: "#/$defs/DidVerificationRelationship";
|
|
1440
|
+
};
|
|
1441
|
+
readonly uniqueItems: true;
|
|
1442
|
+
readonly description: "The relationship this role owns (CONVENTIONS.md §1). Empty for `update`.";
|
|
1443
|
+
};
|
|
1444
|
+
readonly keys: {
|
|
1445
|
+
readonly type: "array";
|
|
1446
|
+
readonly items: {
|
|
1447
|
+
readonly $ref: "#/$defs/RoleKey";
|
|
1448
|
+
};
|
|
1449
|
+
readonly description: "The role's keys, in the order the document publishes them. Terminal-state keys are included only when the request asked for them.";
|
|
1450
|
+
};
|
|
1451
|
+
readonly preRotationCommitments: {
|
|
1452
|
+
readonly type: "integer";
|
|
1453
|
+
readonly minimum: 0;
|
|
1454
|
+
readonly description: "`update` only: successors the latest entry commits to. `0` means a compromise of the current update key cannot be recovered from by rotation, and the DID would have to be deactivated (VTI-KEY-124).";
|
|
1455
|
+
};
|
|
1456
|
+
};
|
|
1457
|
+
};
|
|
1458
|
+
readonly RoleKey: {
|
|
1459
|
+
readonly title: "RoleKey";
|
|
1460
|
+
readonly type: "object";
|
|
1461
|
+
readonly additionalProperties: false;
|
|
1462
|
+
readonly required: readonly ["role", "keyType", "publicKeyMultibase", "state"];
|
|
1463
|
+
readonly description: "One key in one role. A key is in exactly one role for its whole life; a change of role is a retirement from one and an addition to another, under a new verification-method identifier.";
|
|
1464
|
+
readonly properties: {
|
|
1465
|
+
readonly verificationMethod: {
|
|
1466
|
+
readonly type: "string";
|
|
1467
|
+
readonly minLength: 1;
|
|
1468
|
+
readonly description: "The full verification-method identifier (`did#fragment`) the document publishes the key under, and lists in `keyRoles`. Absent only for `update` keys, which are published as log parameters and never as verification methods (VTI-KEY-093). A VTA minting a new method SHOULD derive its fragment from the key (VTI-KEY-150).";
|
|
1469
|
+
};
|
|
1470
|
+
readonly role: {
|
|
1471
|
+
readonly $ref: "#/$defs/KeyRole";
|
|
1472
|
+
};
|
|
1473
|
+
readonly relationships: {
|
|
1474
|
+
readonly type: "array";
|
|
1475
|
+
readonly items: {
|
|
1476
|
+
readonly $ref: "#/$defs/DidVerificationRelationship";
|
|
1477
|
+
};
|
|
1478
|
+
readonly uniqueItems: true;
|
|
1479
|
+
readonly description: "The relationships the key is (or, while `pending`, will be) listed in. Always exactly its role's single relationship (CONVENTIONS.md §1) — carried so a caller can check it against the document rather than trusting it. Empty for `update`, `retired` and `revoked` keys.";
|
|
1480
|
+
};
|
|
1481
|
+
readonly keyType: {
|
|
1482
|
+
readonly $ref: "#/$defs/KeyType";
|
|
1483
|
+
};
|
|
1484
|
+
readonly publicKeyMultibase: {
|
|
1485
|
+
readonly type: "string";
|
|
1486
|
+
readonly minLength: 1;
|
|
1487
|
+
readonly description: "The public half, multibase-encoded, exactly as published.";
|
|
1488
|
+
};
|
|
1489
|
+
readonly state: {
|
|
1490
|
+
readonly $ref: "#/$defs/RoleKeyState";
|
|
1491
|
+
};
|
|
1492
|
+
readonly publishedInVersionId: {
|
|
1493
|
+
readonly type: "string";
|
|
1494
|
+
readonly description: "versionId of the log entry that first published the key. Absent while `pending`.";
|
|
1495
|
+
};
|
|
1496
|
+
readonly removedInVersionId: {
|
|
1497
|
+
readonly type: "string";
|
|
1498
|
+
readonly description: "versionId of the log entry that retired or revoked the key.";
|
|
1499
|
+
};
|
|
1500
|
+
readonly retireAfter: {
|
|
1501
|
+
readonly type: "string";
|
|
1502
|
+
readonly format: "date-time";
|
|
1503
|
+
readonly description: "For a `retiring` key: the end of its overlap window. Custody projection only.";
|
|
1504
|
+
};
|
|
1505
|
+
readonly compromisedSince: {
|
|
1506
|
+
readonly type: "string";
|
|
1507
|
+
readonly format: "date-time";
|
|
1508
|
+
readonly description: "For a `revoked` key: the compromise time (VTI-KEY-121) — the earliest instant from which the key is treated as compromised. Where the operator cannot establish it, the time the key was first published. Published, because it is what a verifier needs.";
|
|
1509
|
+
};
|
|
1510
|
+
readonly rotationId: {
|
|
1511
|
+
readonly type: "string";
|
|
1512
|
+
readonly description: "The rotation this key was introduced or retired by, when it was.";
|
|
1513
|
+
};
|
|
1514
|
+
readonly label: {
|
|
1515
|
+
readonly type: "string";
|
|
1516
|
+
readonly maxLength: 256;
|
|
1517
|
+
readonly description: "Operator-facing label. Custody projection only.";
|
|
1518
|
+
};
|
|
1519
|
+
readonly custody: {
|
|
1520
|
+
readonly $ref: "#/$defs/RoleKeyCustody";
|
|
1521
|
+
};
|
|
1522
|
+
readonly ext: {
|
|
1523
|
+
readonly $ref: "#/$defs/Ext";
|
|
1524
|
+
};
|
|
1525
|
+
readonly activatesAt: {
|
|
1526
|
+
readonly type: "string";
|
|
1527
|
+
readonly format: "date-time";
|
|
1528
|
+
readonly description: "For a `staged` key: when the VTA will begin using it — no earlier than the publishing entry's cache horizon (CONVENTIONS.md §11.1).";
|
|
1529
|
+
};
|
|
1530
|
+
};
|
|
1531
|
+
};
|
|
1532
|
+
readonly RoleKeyCustody: {
|
|
1533
|
+
readonly title: "RoleKeyCustody";
|
|
1534
|
+
readonly type: "object";
|
|
1535
|
+
readonly additionalProperties: false;
|
|
1536
|
+
readonly required: readonly ["keyId", "exportable", "neverExportable", "inBackups"];
|
|
1537
|
+
readonly description: "How the VTA holds a key. Present only in the custody projection. Carries no key material, and a conforming VTA MUST NOT place any in `ext`.";
|
|
1538
|
+
readonly properties: {
|
|
1539
|
+
readonly keyId: {
|
|
1540
|
+
readonly type: "string";
|
|
1541
|
+
readonly minLength: 1;
|
|
1542
|
+
readonly description: "The custodian record identifier (`keys/*`'s `keyId`) behind this key.";
|
|
1543
|
+
};
|
|
1544
|
+
readonly origin: {
|
|
1545
|
+
readonly $ref: "#/$defs/KeyOrigin";
|
|
1546
|
+
};
|
|
1547
|
+
readonly exportable: {
|
|
1548
|
+
readonly type: "boolean";
|
|
1549
|
+
readonly description: "Whether the custodian would release the private half through `keys/export-secret`. Always `false` for `attestation` and `update` keys (CONVENTIONS.md §4). Stated explicitly — never absent — because this is the member an operator reads to confirm a role key cannot leave the VTA, and `keys/*`'s absent-means-exportable reading is the wrong default to leave them to infer.";
|
|
1550
|
+
};
|
|
1551
|
+
readonly neverExportable: {
|
|
1552
|
+
readonly type: "boolean";
|
|
1553
|
+
readonly description: "True when no authority can make the key exportable — the role forbids it, or the material exists only inside a module that cannot release it. `true` implies `exportable: false`.";
|
|
1554
|
+
};
|
|
1555
|
+
readonly hardwareBacked: {
|
|
1556
|
+
readonly type: "boolean";
|
|
1557
|
+
readonly description: "True when the private half is held by a hardware or enclave module that performs the operation without releasing it. Absent means the VTA does not say, not that it is false.";
|
|
1558
|
+
};
|
|
1559
|
+
readonly inBackups: {
|
|
1560
|
+
readonly type: "boolean";
|
|
1561
|
+
readonly description: "Whether the key, or material it can be re-derived from, is included in the VTA's backups or any state transfer. Always `false` for `attestation` and `update` keys (VTI-KEY-112): they are generated, not derived, so there is no seed that recovers them, and their loss is recovered by rotation, never by restore.";
|
|
1562
|
+
};
|
|
1563
|
+
readonly destroyed: {
|
|
1564
|
+
readonly type: "boolean";
|
|
1565
|
+
readonly description: "True once the private half has been destroyed — a retired `attestation` key (VTI-KEY-125). The record survives so the key's past signatures stay attributable.";
|
|
1566
|
+
};
|
|
1567
|
+
};
|
|
1568
|
+
};
|
|
1569
|
+
readonly KeyOrigin: {
|
|
1570
|
+
readonly title: "KeyOrigin";
|
|
1571
|
+
readonly type: "string";
|
|
1572
|
+
readonly enum: readonly ["derived", "imported", "internal"];
|
|
1573
|
+
readonly description: "Where the private key came from. `derived` means the maintainer generated it from a seed it holds and can reproduce it from `derivationPath`; `imported` means it arrived from outside and exists only as stored material; `internal` means the maintainer generated it from a CSPRNG and it is reproducible from nothing at all. The distinction is operationally load-bearing: a `derived` key survives a seed restore, an `imported` one is lost unless it was backed up separately, and an `internal` one cannot be recovered by any means once the maintainer's storage is gone. This member is also the only way a consumer can confirm that a `keys/create` request for an `internal` key was honoured rather than silently downgraded to a derived one — see that specification's `internal` member.";
|
|
1574
|
+
readonly default: "derived";
|
|
1575
|
+
};
|
|
1576
|
+
readonly RoleKeyState: {
|
|
1577
|
+
readonly title: "RoleKeyState";
|
|
1578
|
+
readonly type: "string";
|
|
1579
|
+
readonly enum: readonly ["pending", "staged", "active", "retiring", "retired", "revoked"];
|
|
1580
|
+
readonly description: "Where a key is in its role's lifecycle. `pending` — planned by a preview or a change awaiting approval; not published; custody projection only. `staged` — published and bound to its role, but not yet used: a planned rotation publishes the successor and waits until the entry's cache horizon — publication plus the longer of the document's TTL and the verifier cache cap (CONVENTIONS.md §11.1) — before the VTA first uses it, so that no verifier holding a cached document sees a signature by a key it has never seen (VTI-KEY-122). Becomes `active` at the rotation's `activatesAt`. `active` — the key the VTA uses for new signatures (or, for `messaging`, advertises for new sessions). `retiring` — still published so that what it signed and sessions keyed to it keep working, but never used again: from the successor's first use the VTA MUST NOT sign with it, while a retiring `messaging` key stays usable for decryption, and senders may still encrypt to it, until it is retired (CONVENTIONS.md §11.3). `retired` — removed by planned rotation; what it signed while published remains valid, judged against the DID version current at issuance (CONVENTIONS.md §7). A retired `attestation` or `messaging` key is destroyed at retirement. `revoked` — removed from every relationship and from `keyRoles` in one entry, without overlap, because it is or may be compromised; what it signed from `compromisedSince` onward establishes nothing. `retired` and `revoked` are terminal.";
|
|
1581
|
+
};
|
|
1582
|
+
readonly DidVerificationRelationship: {
|
|
1583
|
+
readonly title: "DidVerificationRelationship";
|
|
1584
|
+
readonly type: "string";
|
|
1585
|
+
readonly enum: readonly ["authentication", "assertionMethod", "keyAgreement", "capabilityInvocation", "capabilityDelegation"];
|
|
1586
|
+
readonly description: "A DID Core verification relationship.";
|
|
1587
|
+
};
|
|
1588
|
+
readonly KeyType: {
|
|
1589
|
+
readonly title: "KeyType";
|
|
1590
|
+
readonly type: "string";
|
|
1591
|
+
readonly enum: readonly ["ed25519", "x25519", "p256", "mldsa44", "mldsa65"];
|
|
1592
|
+
readonly description: "Cryptographic algorithm the key material belongs to. `ed25519` signs (EdDSA), `x25519` performs key agreement and never signs, `p256` signs (ES256), and `mldsa44` and `mldsa65` sign with the post-quantum ML-DSA scheme of US NIST FIPS 204. The set is expected to grow as algorithms are standardised, and growing it is a MINOR change under SPEC.md §5.2: `keyType` selects no schema branch, so adding a value relaxes a constraint rather than narrowing one, and the generated libraries mark this enumeration non-exhaustive so that a consumer absorbs a new value rather than failing to compile. Two ML-DSA parameter sets are carried because two specifications require different ones — W3C Quantum-Resistant Cryptosuites defines Data Integrity suites only for ML-DSA-44, while Trust Spanning Protocol Rev 3 §8.1 mandates ML-DSA-65 — so the parameter set is chosen by whatever consumes the key and the two are not redundant. A consumer that does not implement a value it receives MUST refuse the document rather than substitute one it does support.";
|
|
1593
|
+
};
|
|
1594
|
+
readonly KeyRoleProjection: {
|
|
1595
|
+
readonly title: "KeyRoleProjection";
|
|
1596
|
+
readonly type: "string";
|
|
1597
|
+
readonly enum: readonly ["public", "custody"];
|
|
1598
|
+
readonly description: "Which view of the DID's key roles the caller was given (CONVENTIONS.md §5). `public` — only what the published document and log already reveal to anyone who resolves the DID. `custody` — additionally the VTA's own custody state: pending keys, the custodian record behind each key, overlap deadlines, who initiated and approved each change, and why. The response always states which it is, so a caller never mistakes an absent member for a statement that the thing does not exist.";
|
|
1599
|
+
};
|
|
1600
|
+
};
|
|
1601
|
+
};
|
|
1602
|
+
};
|
|
1603
|
+
//# sourceMappingURL=payload.d.ts.map
|