@the-ai-company/cbio-node-runtime 1.45.5 → 1.47.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/dist/clients/owner/client.d.ts +10 -14
- package/dist/clients/owner/client.js +56 -182
- package/dist/clients/owner/client.js.map +1 -1
- package/dist/clients/owner/contracts.d.ts +9 -0
- package/dist/clients/owner/index.d.ts +1 -1
- package/dist/protocol/crypto.d.ts +5 -0
- package/dist/protocol/crypto.js +11 -0
- package/dist/protocol/crypto.js.map +1 -1
- package/dist/runtime/bootstrap.d.ts +14 -27
- package/dist/runtime/bootstrap.js +17 -63
- package/dist/runtime/bootstrap.js.map +1 -1
- package/dist/runtime/identity.d.ts +1 -23
- package/dist/runtime/identity.js +2 -74
- package/dist/runtime/identity.js.map +1 -1
- package/dist/runtime/index.d.ts +10 -24
- package/dist/runtime/index.js +7 -11
- package/dist/runtime/index.js.map +1 -1
- package/dist/runtime/vault-metadata.d.ts +4 -16
- package/dist/runtime/vault-metadata.js +6 -41
- package/dist/runtime/vault-metadata.js.map +1 -1
- package/dist/vault-core/contracts.d.ts +3 -23
- package/dist/vault-core/contracts.js +0 -1
- package/dist/vault-core/contracts.js.map +1 -1
- package/dist/vault-core/core.d.ts +4 -4
- package/dist/vault-core/core.js +10 -76
- package/dist/vault-core/core.js.map +1 -1
- package/dist/vault-core/defaults.d.ts +4 -52
- package/dist/vault-core/defaults.js +2 -300
- package/dist/vault-core/defaults.js.map +1 -1
- package/dist/vault-core/index.d.ts +5 -5
- package/dist/vault-core/index.js +3 -3
- package/dist/vault-core/index.js.map +1 -1
- package/dist/vault-core/persistence.d.ts +5 -34
- package/dist/vault-core/persistence.js +8 -38
- package/dist/vault-core/persistence.js.map +1 -1
- package/dist/vault-core/ports.d.ts +2 -51
- package/dist/vault-ingress/index.d.ts +1 -2
- package/dist/vault-ingress/index.js +0 -5
- package/dist/vault-ingress/index.js.map +1 -1
- package/docs/api/README.md +8 -92
- package/docs/api/classes/IdentityError.md +2 -2
- package/docs/api/classes/VaultCore.md +320 -0
- package/docs/api/classes/VaultCoreError.md +1 -1
- package/docs/api/enumerations/IdentityErrorCode.md +1 -1
- package/docs/api/functions/createAgentClient.md +1 -1
- package/docs/api/functions/createIdentity.md +2 -2
- package/docs/api/functions/createOwnerHttpFlowBoundary.md +4 -4
- package/docs/api/functions/createPersistentVaultCoreDependencies.md +3 -67
- package/docs/api/functions/createStandardAcquireBoundary.md +3 -3
- package/docs/api/functions/createStandardDispatchBoundary.md +3 -3
- package/docs/api/functions/createVault.md +3 -3
- package/docs/api/functions/createVaultClient.md +2 -2
- package/docs/api/functions/createVaultCore.md +4 -4
- package/docs/api/functions/createVaultCoreDependencies.md +17 -0
- package/docs/api/functions/createVaultService.md +6 -6
- package/docs/api/functions/createWorkspaceStorage.md +1 -1
- package/docs/api/functions/deriveIdentityId.md +1 -1
- package/docs/api/functions/deriveVaultWorkingKeyFromPassword.md +24 -0
- package/docs/api/functions/getDefaultWorkspaceDir.md +1 -1
- package/docs/api/functions/handleVaultHttpDispatch.md +4 -4
- package/docs/api/functions/initializeVaultCustody.md +1 -1
- package/docs/api/functions/listVaults.md +5 -5
- package/docs/api/functions/readVaultProfile.md +3 -3
- package/docs/api/functions/recoverVault.md +4 -4
- package/docs/api/functions/recoverVaultWorkingKey.md +1 -1
- package/docs/api/functions/restoreIdentity.md +1 -1
- package/docs/api/functions/updateVaultMetadata.md +7 -7
- package/docs/api/functions/wrapVaultCoreAsVaultService.md +6 -6
- package/docs/api/functions/writeVaultProfile.md +3 -3
- package/docs/api/interfaces/AgentClient.md +3 -3
- package/docs/api/interfaces/AgentDispatchIntent.md +1 -1
- package/docs/api/interfaces/AgentDispatchTransport.md +4 -4
- package/docs/api/interfaces/AgentIdentity.md +1 -1
- package/docs/api/interfaces/AgentSigner.md +1 -1
- package/docs/api/interfaces/CbioRuntime.md +55 -396
- package/docs/api/interfaces/CreateAgentClientOptions.md +4 -4
- package/docs/api/interfaces/CreateIdentityOptions.md +1 -5
- package/docs/api/interfaces/CreatePersistentVaultCoreDependenciesOptions.md +9 -9
- package/docs/api/interfaces/CreateVaultClientOptions.md +5 -5
- package/docs/api/interfaces/CreateVaultOptions.md +16 -16
- package/docs/api/interfaces/CreatedVault.md +3 -3
- package/docs/api/interfaces/DefaultPolicyEngineOptions.md +3 -3
- package/docs/api/interfaces/IStorageProvider.md +1 -1
- package/docs/api/interfaces/InitializeVaultCustodyOptions.md +1 -1
- package/docs/api/interfaces/InitializedVaultCustody.md +1 -1
- package/docs/api/interfaces/OwnerDefineSecretTargetsInput.md +1 -1
- package/docs/api/interfaces/OwnerSecretTargetBinding.md +1 -1
- package/docs/api/interfaces/OwnerStoreSecretInput.md +1 -1
- package/docs/api/interfaces/OwnerWriteSecretInput.md +1 -1
- package/docs/api/interfaces/RecoverVaultOptions.md +10 -10
- package/docs/api/interfaces/RecoveredVault.md +3 -3
- package/docs/api/interfaces/RestoreIdentityOptions.md +1 -1
- package/docs/api/interfaces/Signer.md +1 -1
- package/docs/api/interfaces/VaultAuditQueryInput.md +1 -1
- package/docs/api/interfaces/VaultClient.md +36 -29
- package/docs/api/interfaces/{CreateDefaultVaultCoreDependenciesOptions.md → VaultCoreDependenciesOptions.md} +3 -3
- package/docs/api/interfaces/VaultCreateAgentInput.md +29 -0
- package/docs/api/interfaces/VaultDeleteSecretInput.md +1 -1
- package/docs/api/interfaces/VaultExportSecretInput.md +1 -1
- package/docs/api/interfaces/VaultGrantCapabilityInput.md +2 -2
- package/docs/api/interfaces/VaultIdentity.md +1 -1
- package/docs/api/interfaces/VaultListAgentsInput.md +1 -1
- package/docs/api/interfaces/VaultListCapabilitiesInput.md +1 -1
- package/docs/api/interfaces/{VaultPublicMetadata.md → VaultMetadata.md} +2 -2
- package/docs/api/interfaces/VaultObject.md +3 -3
- package/docs/api/interfaces/VaultProfile.md +7 -11
- package/docs/api/interfaces/VaultRegisterAgentInput.md +19 -1
- package/docs/api/interfaces/VaultRegisterFlowInput.md +7 -7
- package/docs/api/interfaces/VaultRevokeCapabilityInput.md +1 -1
- package/docs/api/interfaces/VaultSigner.md +1 -1
- package/docs/api/type-aliases/AgentCapabilityEnvelope.md +2 -2
- package/docs/api/type-aliases/CbioRuntimeModule.md +1 -1
- package/docs/api/variables/DEFAULT_VAULT_KEY_CUSTODY_BLOB_KEY.md +1 -1
- package/package.json +1 -1
- package/docs/api/classes/InMemoryReplayGuard.md +0 -45
- package/docs/api/enumerations/AuditAction.md +0 -95
- package/docs/api/enumerations/AuditOutcome.md +0 -29
- package/docs/api/enumerations/DispatchStatus.md +0 -23
- package/docs/api/functions/createChildIdentity.md +0 -25
- package/docs/api/functions/createDefaultVaultCoreDependencies.md +0 -77
- package/docs/api/functions/deriveChildIdentity.md +0 -41
- package/docs/api/functions/ensureIdentityPrivateVault.md +0 -21
- package/docs/api/functions/identityPrivateVaultChildrenKey.md +0 -17
- package/docs/api/functions/identityPrivateVaultPrefix.md +0 -17
- package/docs/api/functions/identityPrivateVaultProfileKey.md +0 -17
- package/docs/api/functions/identityPrivateVaultPublicSealedKey.md +0 -17
- package/docs/api/functions/listIdentities.md +0 -19
- package/docs/api/functions/readIdentityMetadata.md +0 -29
- package/docs/api/functions/readIdentityPrivateVaultChildrenState.md +0 -21
- package/docs/api/functions/readIdentityPrivateVaultProfile.md +0 -21
- package/docs/api/functions/readVaultPublicMetadata.md +0 -23
- package/docs/api/functions/toOwnerHttpFlowBoundary.md +0 -17
- package/docs/api/interfaces/AgentCapability.md +0 -103
- package/docs/api/interfaces/AgentIdentityRecord.md +0 -23
- package/docs/api/interfaces/AgentIdentityRegistry.md +0 -57
- package/docs/api/interfaces/AgentProof.md +0 -29
- package/docs/api/interfaces/AgentProofVerifier.md +0 -21
- package/docs/api/interfaces/AuditEntry.md +0 -89
- package/docs/api/interfaces/AuditLog.md +0 -37
- package/docs/api/interfaces/AuditQuery.md +0 -29
- package/docs/api/interfaces/CapabilityRegistry.md +0 -65
- package/docs/api/interfaces/CapabilityRevocationRegistry.md +0 -53
- package/docs/api/interfaces/ChildIdentity.md +0 -77
- package/docs/api/interfaces/Clock.md +0 -15
- package/docs/api/interfaces/CreateChildIdentityOptions.md +0 -19
- package/docs/api/interfaces/CustomHttpFlowDefinition.md +0 -71
- package/docs/api/interfaces/CustomHttpFlowRegistry.md +0 -41
- package/docs/api/interfaces/DeriveIdentityOptions.md +0 -11
- package/docs/api/interfaces/DispatchAuthorization.md +0 -35
- package/docs/api/interfaces/DispatchInstruction.md +0 -47
- package/docs/api/interfaces/DispatchRequest.md +0 -77
- package/docs/api/interfaces/DispatchResult.md +0 -53
- package/docs/api/interfaces/IdGenerator.md +0 -39
- package/docs/api/interfaces/IdentityPrivateVaultChildRecord.md +0 -35
- package/docs/api/interfaces/IdentityPrivateVaultChildrenState.md +0 -17
- package/docs/api/interfaces/IdentityPrivateVaultProfile.md +0 -35
- package/docs/api/interfaces/IssuerWriteSecretCommand.md +0 -59
- package/docs/api/interfaces/OwnerAuditRequest.md +0 -47
- package/docs/api/interfaces/OwnerDefineSecretTargetsCommand.md +0 -53
- package/docs/api/interfaces/OwnerDeleteSecretCommand.md +0 -47
- package/docs/api/interfaces/OwnerExportSecretRequest.md +0 -47
- package/docs/api/interfaces/OwnerHttpFlowBoundary.md +0 -51
- package/docs/api/interfaces/OwnerIdentityRecord.md +0 -23
- package/docs/api/interfaces/OwnerIdentityRegistry.md +0 -57
- package/docs/api/interfaces/OwnerListAgentsRequest.md +0 -41
- package/docs/api/interfaces/OwnerListCapabilitiesRequest.md +0 -47
- package/docs/api/interfaces/OwnerProof.md +0 -29
- package/docs/api/interfaces/OwnerProofVerifier.md +0 -181
- package/docs/api/interfaces/OwnerRegisterAgentIdentityCommand.md +0 -47
- package/docs/api/interfaces/OwnerRegisterCapabilityCommand.md +0 -47
- package/docs/api/interfaces/OwnerRegisterCustomHttpFlowCommand.md +0 -83
- package/docs/api/interfaces/OwnerRevokeCapabilityCommand.md +0 -53
- package/docs/api/interfaces/OwnerSecretExport.md +0 -35
- package/docs/api/interfaces/OwnerWriteSecretCommand.md +0 -65
- package/docs/api/interfaces/PolicyEngine.md +0 -81
- package/docs/api/interfaces/RateLimitStore.md +0 -33
- package/docs/api/interfaces/ReplayGuard.md +0 -21
- package/docs/api/interfaces/SecretAlias.md +0 -11
- package/docs/api/interfaces/SecretCustody.md +0 -57
- package/docs/api/interfaces/SecretId.md +0 -11
- package/docs/api/interfaces/SecretRecord.md +0 -53
- package/docs/api/interfaces/SecretRepository.md +0 -69
- package/docs/api/interfaces/SecretVersion.md +0 -11
- package/docs/api/interfaces/SignatureAgentProofVerifierOptions.md +0 -21
- package/docs/api/interfaces/TrustedExecutor.md +0 -31
- package/docs/api/interfaces/VaultAcquireSecretInput.md +0 -53
- package/docs/api/interfaces/VaultAcquireSecretResult.md +0 -41
- package/docs/api/interfaces/VaultAgentDispatchErrorResponse.md +0 -25
- package/docs/api/interfaces/VaultAgentDispatchRequest.md +0 -75
- package/docs/api/interfaces/VaultAgentDispatchResponse.md +0 -17
- package/docs/api/interfaces/VaultCore.md +0 -311
- package/docs/api/interfaces/VaultCoreDependencies.md +0 -95
- package/docs/api/interfaces/VaultCustomFlowResolver.md +0 -25
- package/docs/api/interfaces/VaultId.md +0 -11
- package/docs/api/interfaces/VaultPrincipal.md +0 -17
- package/docs/api/interfaces/VaultService.md +0 -251
- package/docs/api/interfaces/VaultTargetBinding.md +0 -35
- package/docs/api/type-aliases/IdentityPrivateVaultAccess.md +0 -7
- package/docs/api/type-aliases/RedactedResponseShape.md +0 -7
- package/docs/api/type-aliases/VaultAcquireSecretFlow.md +0 -7
- package/docs/api/type-aliases/VaultPrincipalKind.md +0 -7
- package/docs/api/type-aliases/VaultWriteSecretCommand.md +0 -7
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
[**CBIO Node Runtime Agent API v1.
|
|
1
|
+
[**CBIO Node Runtime Agent API v1.47.0**](../README.md)
|
|
2
2
|
|
|
3
3
|
***
|
|
4
4
|
|
|
@@ -46,111 +46,11 @@ const agent = createAgentClient({
|
|
|
46
46
|
|
|
47
47
|
***
|
|
48
48
|
|
|
49
|
-
### createChildIdentity
|
|
50
|
-
|
|
51
|
-
> **createChildIdentity**: (`storage`, `parentIdentity`, `options`) => `Promise`\<[`ChildIdentity`](ChildIdentity.md)\>
|
|
52
|
-
|
|
53
|
-
#### Parameters
|
|
54
|
-
|
|
55
|
-
##### storage
|
|
56
|
-
|
|
57
|
-
[`IStorageProvider`](IStorageProvider.md)
|
|
58
|
-
|
|
59
|
-
##### parentIdentity
|
|
60
|
-
|
|
61
|
-
`string` \| `CreatedIdentity`
|
|
62
|
-
|
|
63
|
-
##### options?
|
|
64
|
-
|
|
65
|
-
[`CreateChildIdentityOptions`](CreateChildIdentityOptions.md) = `{}`
|
|
66
|
-
|
|
67
|
-
#### Returns
|
|
68
|
-
|
|
69
|
-
`Promise`\<[`ChildIdentity`](ChildIdentity.md)\>
|
|
70
|
-
|
|
71
|
-
***
|
|
72
|
-
|
|
73
|
-
### createDefaultVaultCoreDependencies
|
|
74
|
-
|
|
75
|
-
> **createDefaultVaultCoreDependencies**: (`options`) => `object`
|
|
76
|
-
|
|
77
|
-
#### Parameters
|
|
78
|
-
|
|
79
|
-
##### options?
|
|
80
|
-
|
|
81
|
-
[`CreateDefaultVaultCoreDependenciesOptions`](CreateDefaultVaultCoreDependenciesOptions.md) = `{}`
|
|
82
|
-
|
|
83
|
-
#### Returns
|
|
84
|
-
|
|
85
|
-
`object`
|
|
86
|
-
|
|
87
|
-
##### agentIdentities
|
|
88
|
-
|
|
89
|
-
> **agentIdentities**: `InMemoryAgentIdentityRegistry`
|
|
90
|
-
|
|
91
|
-
##### audit
|
|
92
|
-
|
|
93
|
-
> **audit**: `InMemoryAuditLog`
|
|
94
|
-
|
|
95
|
-
##### capabilities
|
|
96
|
-
|
|
97
|
-
> **capabilities**: `InMemoryCapabilityRegistry`
|
|
98
|
-
|
|
99
|
-
##### clock
|
|
100
|
-
|
|
101
|
-
> **clock**: `SystemClock`
|
|
102
|
-
|
|
103
|
-
##### custody
|
|
104
|
-
|
|
105
|
-
> **custody**: `InMemorySecretCustody`
|
|
106
|
-
|
|
107
|
-
##### customFlows
|
|
108
|
-
|
|
109
|
-
> **customFlows**: `InMemoryCustomHttpFlowRegistry`
|
|
110
|
-
|
|
111
|
-
##### executor
|
|
112
|
-
|
|
113
|
-
> **executor**: `HttpDispatchExecutor`
|
|
114
|
-
|
|
115
|
-
##### ids
|
|
116
|
-
|
|
117
|
-
> **ids**: `RandomIdGenerator`
|
|
118
|
-
|
|
119
|
-
##### ownerIdentities
|
|
120
|
-
|
|
121
|
-
> **ownerIdentities**: `InMemoryOwnerIdentityRegistry`
|
|
122
|
-
|
|
123
|
-
##### ownerProofVerifier
|
|
124
|
-
|
|
125
|
-
> **ownerProofVerifier**: `SignatureOwnerProofVerifier`
|
|
126
|
-
|
|
127
|
-
##### policy
|
|
128
|
-
|
|
129
|
-
> **policy**: `DefaultPolicyEngine`
|
|
130
|
-
|
|
131
|
-
##### proofVerifier
|
|
132
|
-
|
|
133
|
-
> **proofVerifier**: `SignatureAgentProofVerifier`
|
|
134
|
-
|
|
135
|
-
##### replayGuard
|
|
136
|
-
|
|
137
|
-
> **replayGuard**: [`InMemoryReplayGuard`](../classes/InMemoryReplayGuard.md)
|
|
138
|
-
|
|
139
|
-
##### secrets
|
|
140
|
-
|
|
141
|
-
> **secrets**: `InMemorySecretRepository`
|
|
142
|
-
|
|
143
|
-
##### vaultId
|
|
144
|
-
|
|
145
|
-
> **vaultId**: [`VaultId`](VaultId.md)
|
|
146
|
-
|
|
147
|
-
***
|
|
148
|
-
|
|
149
49
|
### createIdentity
|
|
150
50
|
|
|
151
51
|
> **createIdentity**: (`options?`) => `CreatedIdentity`
|
|
152
52
|
|
|
153
|
-
Creates a new
|
|
53
|
+
Creates a new identity with a fresh Ed25519 keypair.
|
|
154
54
|
|
|
155
55
|
#### Parameters
|
|
156
56
|
|
|
@@ -177,107 +77,23 @@ console.log(identity.identityId);
|
|
|
177
77
|
|
|
178
78
|
### createOwnerHttpFlowBoundary
|
|
179
79
|
|
|
180
|
-
> **createOwnerHttpFlowBoundary**: (`boundary`) =>
|
|
80
|
+
> **createOwnerHttpFlowBoundary**: (`boundary`) => `OwnerHttpFlowBoundary`
|
|
181
81
|
|
|
182
82
|
#### Parameters
|
|
183
83
|
|
|
184
84
|
##### boundary
|
|
185
85
|
|
|
186
|
-
|
|
187
|
-
|
|
188
|
-
#### Returns
|
|
189
|
-
|
|
190
|
-
[`OwnerHttpFlowBoundary`](OwnerHttpFlowBoundary.md)
|
|
191
|
-
|
|
192
|
-
***
|
|
193
|
-
|
|
194
|
-
### createPersistentVaultCoreDependencies
|
|
195
|
-
|
|
196
|
-
> **createPersistentVaultCoreDependencies**: (`storage`, `options`) => `object`
|
|
197
|
-
|
|
198
|
-
#### Parameters
|
|
199
|
-
|
|
200
|
-
##### storage
|
|
201
|
-
|
|
202
|
-
[`IStorageProvider`](IStorageProvider.md)
|
|
203
|
-
|
|
204
|
-
##### options
|
|
205
|
-
|
|
206
|
-
[`CreatePersistentVaultCoreDependenciesOptions`](CreatePersistentVaultCoreDependenciesOptions.md)
|
|
86
|
+
`OwnerHttpFlowBoundary`
|
|
207
87
|
|
|
208
88
|
#### Returns
|
|
209
89
|
|
|
210
|
-
`
|
|
211
|
-
|
|
212
|
-
##### agentIdentities
|
|
213
|
-
|
|
214
|
-
> **agentIdentities**: `FileAgentIdentityRegistry`
|
|
215
|
-
|
|
216
|
-
##### audit
|
|
217
|
-
|
|
218
|
-
> **audit**: `FileAuditLog`
|
|
219
|
-
|
|
220
|
-
##### capabilities
|
|
221
|
-
|
|
222
|
-
> **capabilities**: `FileCapabilityRegistry`
|
|
223
|
-
|
|
224
|
-
##### capabilityRevocations
|
|
225
|
-
|
|
226
|
-
> **capabilityRevocations**: [`CapabilityRevocationRegistry`](CapabilityRevocationRegistry.md)
|
|
227
|
-
|
|
228
|
-
##### clock
|
|
229
|
-
|
|
230
|
-
> **clock**: `SystemClock`
|
|
231
|
-
|
|
232
|
-
##### custody
|
|
233
|
-
|
|
234
|
-
> **custody**: `FileSecretCustody`
|
|
235
|
-
|
|
236
|
-
##### customFlows
|
|
237
|
-
|
|
238
|
-
> **customFlows**: [`CustomHttpFlowRegistry`](CustomHttpFlowRegistry.md)
|
|
239
|
-
|
|
240
|
-
##### executor
|
|
241
|
-
|
|
242
|
-
> **executor**: `HttpDispatchExecutor`
|
|
243
|
-
|
|
244
|
-
##### ids
|
|
245
|
-
|
|
246
|
-
> **ids**: `RandomIdGenerator`
|
|
247
|
-
|
|
248
|
-
##### ownerIdentities
|
|
249
|
-
|
|
250
|
-
> **ownerIdentities**: `FileOwnerIdentityRegistry`
|
|
251
|
-
|
|
252
|
-
##### ownerProofVerifier
|
|
253
|
-
|
|
254
|
-
> **ownerProofVerifier**: `SignatureOwnerProofVerifier`
|
|
255
|
-
|
|
256
|
-
##### policy
|
|
257
|
-
|
|
258
|
-
> **policy**: `DefaultPolicyEngine`
|
|
259
|
-
|
|
260
|
-
##### proofVerifier
|
|
261
|
-
|
|
262
|
-
> **proofVerifier**: `SignatureAgentProofVerifier`
|
|
263
|
-
|
|
264
|
-
##### replayGuard
|
|
265
|
-
|
|
266
|
-
> **replayGuard**: [`ReplayGuard`](ReplayGuard.md)
|
|
267
|
-
|
|
268
|
-
##### secrets
|
|
269
|
-
|
|
270
|
-
> **secrets**: `FileSecretRepository`
|
|
271
|
-
|
|
272
|
-
##### vaultId
|
|
273
|
-
|
|
274
|
-
> **vaultId**: [`VaultId`](VaultId.md)
|
|
90
|
+
`OwnerHttpFlowBoundary`
|
|
275
91
|
|
|
276
92
|
***
|
|
277
93
|
|
|
278
94
|
### createStandardAcquireBoundary
|
|
279
95
|
|
|
280
|
-
> **createStandardAcquireBoundary**: (`input`) =>
|
|
96
|
+
> **createStandardAcquireBoundary**: (`input`) => `OwnerHttpFlowBoundary`
|
|
281
97
|
|
|
282
98
|
#### Parameters
|
|
283
99
|
|
|
@@ -301,13 +117,13 @@ console.log(identity.identityId);
|
|
|
301
117
|
|
|
302
118
|
#### Returns
|
|
303
119
|
|
|
304
|
-
|
|
120
|
+
`OwnerHttpFlowBoundary`
|
|
305
121
|
|
|
306
122
|
***
|
|
307
123
|
|
|
308
124
|
### createStandardDispatchBoundary
|
|
309
125
|
|
|
310
|
-
> **createStandardDispatchBoundary**: (`input`) =>
|
|
126
|
+
> **createStandardDispatchBoundary**: (`input`) => `OwnerHttpFlowBoundary`
|
|
311
127
|
|
|
312
128
|
#### Parameters
|
|
313
129
|
|
|
@@ -323,7 +139,7 @@ console.log(identity.identityId);
|
|
|
323
139
|
|
|
324
140
|
#### Returns
|
|
325
141
|
|
|
326
|
-
|
|
142
|
+
`OwnerHttpFlowBoundary`
|
|
327
143
|
|
|
328
144
|
***
|
|
329
145
|
|
|
@@ -349,7 +165,7 @@ Workspace storage (or path string) where vaults are stored.
|
|
|
349
165
|
|
|
350
166
|
[`CreateVaultOptions`](CreateVaultOptions.md)
|
|
351
167
|
|
|
352
|
-
Configuration including
|
|
168
|
+
Configuration including password and metadata.
|
|
353
169
|
|
|
354
170
|
##### Returns
|
|
355
171
|
|
|
@@ -361,7 +177,7 @@ A [CreatedVault](CreatedVault.md) instance.
|
|
|
361
177
|
|
|
362
178
|
```ts
|
|
363
179
|
const vault = await createVault({
|
|
364
|
-
|
|
180
|
+
password: 'my-strong-password',
|
|
365
181
|
nickname: 'production-secrets'
|
|
366
182
|
});
|
|
367
183
|
```
|
|
@@ -398,7 +214,7 @@ Creates a [VaultClient](VaultClient.md) instance for a specific vault owner.
|
|
|
398
214
|
|
|
399
215
|
[`CreateVaultClientOptions`](CreateVaultClientOptions.md)
|
|
400
216
|
|
|
401
|
-
Configuration including owner identity and the vault service.
|
|
217
|
+
Configuration including optional owner identity and the vault service.
|
|
402
218
|
|
|
403
219
|
#### Returns
|
|
404
220
|
|
|
@@ -419,113 +235,86 @@ const client = createVaultClient({
|
|
|
419
235
|
|
|
420
236
|
### createVaultCore
|
|
421
237
|
|
|
422
|
-
> **createVaultCore**: (`deps`) => [`VaultCore`](VaultCore.md)
|
|
238
|
+
> **createVaultCore**: (`deps`) => [`VaultCore`](../classes/VaultCore.md)
|
|
423
239
|
|
|
424
240
|
#### Parameters
|
|
425
241
|
|
|
426
242
|
##### deps
|
|
427
243
|
|
|
428
|
-
|
|
244
|
+
`VaultCoreDependencies`
|
|
429
245
|
|
|
430
246
|
#### Returns
|
|
431
247
|
|
|
432
|
-
[`VaultCore`](VaultCore.md)
|
|
248
|
+
[`VaultCore`](../classes/VaultCore.md)
|
|
433
249
|
|
|
434
250
|
***
|
|
435
251
|
|
|
436
|
-
###
|
|
252
|
+
### createVaultCoreDependencies
|
|
437
253
|
|
|
438
|
-
> **
|
|
254
|
+
> **createVaultCoreDependencies**: (`options`) => `VaultCoreDependencies`
|
|
439
255
|
|
|
440
256
|
#### Parameters
|
|
441
257
|
|
|
442
|
-
##### deps
|
|
443
|
-
|
|
444
|
-
[`VaultCoreDependencies`](VaultCoreDependencies.md)
|
|
445
|
-
|
|
446
258
|
##### options?
|
|
447
259
|
|
|
448
|
-
|
|
449
|
-
|
|
450
|
-
[`Clock`](Clock.md)
|
|
451
|
-
|
|
452
|
-
###### customFlows?
|
|
453
|
-
|
|
454
|
-
[`VaultCustomFlowResolver`](VaultCustomFlowResolver.md)
|
|
455
|
-
|
|
456
|
-
###### fetchImpl?
|
|
457
|
-
|
|
458
|
-
\{(`input`, `init?`): `Promise`\<`Response`\>; (`input`, `init?`): `Promise`\<`Response`\>; \}
|
|
260
|
+
[`VaultCoreDependenciesOptions`](VaultCoreDependenciesOptions.md) = `{}`
|
|
459
261
|
|
|
460
262
|
#### Returns
|
|
461
263
|
|
|
462
|
-
|
|
264
|
+
`VaultCoreDependencies`
|
|
463
265
|
|
|
464
266
|
***
|
|
465
267
|
|
|
466
|
-
###
|
|
467
|
-
|
|
468
|
-
> **deriveChildIdentity**: (`parent`, `childIndex`, `options`) => [`ChildIdentity`](ChildIdentity.md)
|
|
268
|
+
### createVaultService
|
|
469
269
|
|
|
470
|
-
|
|
270
|
+
> **createVaultService**: (`deps`, `options`) => `VaultService`
|
|
471
271
|
|
|
472
272
|
#### Parameters
|
|
473
273
|
|
|
474
|
-
#####
|
|
274
|
+
##### deps
|
|
475
275
|
|
|
476
|
-
`
|
|
276
|
+
`VaultCoreDependencies`
|
|
477
277
|
|
|
478
|
-
|
|
278
|
+
##### options?
|
|
479
279
|
|
|
480
|
-
|
|
280
|
+
###### clock?
|
|
481
281
|
|
|
482
|
-
`
|
|
282
|
+
`Clock`
|
|
483
283
|
|
|
484
|
-
|
|
284
|
+
###### customFlows?
|
|
485
285
|
|
|
486
|
-
|
|
286
|
+
`VaultCustomFlowResolver`
|
|
487
287
|
|
|
488
|
-
|
|
288
|
+
###### fetchImpl?
|
|
489
289
|
|
|
490
|
-
|
|
290
|
+
\{(`input`, `init?`): `Promise`\<`Response`\>; (`input`, `init?`): `Promise`\<`Response`\>; \}
|
|
491
291
|
|
|
492
292
|
#### Returns
|
|
493
293
|
|
|
494
|
-
|
|
495
|
-
|
|
496
|
-
A [ChildIdentity](ChildIdentity.md) with derivation metadata.
|
|
497
|
-
|
|
498
|
-
#### Example
|
|
499
|
-
|
|
500
|
-
```ts
|
|
501
|
-
const child = deriveChildIdentity(parentIdentity, 0, { nickname: 'sub-agent-0' });
|
|
502
|
-
```
|
|
294
|
+
`VaultService`
|
|
503
295
|
|
|
504
296
|
***
|
|
505
297
|
|
|
506
|
-
###
|
|
298
|
+
### deriveVaultWorkingKeyFromPassword
|
|
507
299
|
|
|
508
|
-
> **
|
|
300
|
+
> **deriveVaultWorkingKeyFromPassword**: (`password`, `vaultId`) => `string`
|
|
509
301
|
|
|
510
|
-
|
|
511
|
-
|
|
512
|
-
### ensureIdentityPrivateVault
|
|
513
|
-
|
|
514
|
-
> **ensureIdentityPrivateVault**: (`storage`, `identity`) => `Promise`\<`void`\>
|
|
302
|
+
Derives a 256-bit working key from a user password and salt (vaultId).
|
|
303
|
+
Using scrypt for memory-hard key derivation to resist brute-force attacks.
|
|
515
304
|
|
|
516
305
|
#### Parameters
|
|
517
306
|
|
|
518
|
-
#####
|
|
307
|
+
##### password
|
|
519
308
|
|
|
520
|
-
|
|
309
|
+
`string`
|
|
521
310
|
|
|
522
|
-
#####
|
|
311
|
+
##### vaultId
|
|
523
312
|
|
|
524
|
-
`
|
|
313
|
+
`string`
|
|
525
314
|
|
|
526
315
|
#### Returns
|
|
527
316
|
|
|
528
|
-
`
|
|
317
|
+
`string`
|
|
529
318
|
|
|
530
319
|
***
|
|
531
320
|
|
|
@@ -537,7 +326,7 @@ const child = deriveChildIdentity(parentIdentity, 0, { nickname: 'sub-agent-0' }
|
|
|
537
326
|
|
|
538
327
|
### handleVaultHttpDispatch
|
|
539
328
|
|
|
540
|
-
> **handleVaultHttpDispatch**: (`service`, `body`) => `Promise
|
|
329
|
+
> **handleVaultHttpDispatch**: (`service`, `body`) => `Promise`\<`VaultAgentDispatchResponse` \| `VaultAgentDispatchErrorResponse`\>
|
|
541
330
|
|
|
542
331
|
Standard server-side helper to handle a vault agent dispatch request from an HTTP body.
|
|
543
332
|
This can be used in any HTTP server framework (Express, Fastify, etc.).
|
|
@@ -546,7 +335,7 @@ This can be used in any HTTP server framework (Express, Fastify, etc.).
|
|
|
546
335
|
|
|
547
336
|
##### service
|
|
548
337
|
|
|
549
|
-
|
|
338
|
+
`VaultService`
|
|
550
339
|
|
|
551
340
|
The VaultService instance to handle the request.
|
|
552
341
|
|
|
@@ -558,7 +347,7 @@ The parsed JSON body of the incoming HTTP request.
|
|
|
558
347
|
|
|
559
348
|
#### Returns
|
|
560
349
|
|
|
561
|
-
`Promise
|
|
350
|
+
`Promise`\<`VaultAgentDispatchResponse` \| `VaultAgentDispatchErrorResponse`\>
|
|
562
351
|
|
|
563
352
|
A JSON-serializable response object.
|
|
564
353
|
|
|
@@ -576,49 +365,11 @@ A JSON-serializable response object.
|
|
|
576
365
|
|
|
577
366
|
***
|
|
578
367
|
|
|
579
|
-
### initializeVaultCustody
|
|
580
|
-
|
|
581
|
-
> **initializeVaultCustody**: (`storage`, `options`) => `Promise`\<[`InitializedVaultCustody`](InitializedVaultCustody.md)\>
|
|
582
|
-
|
|
583
|
-
#### Parameters
|
|
584
|
-
|
|
585
|
-
##### storage
|
|
586
|
-
|
|
587
|
-
[`IStorageProvider`](IStorageProvider.md)
|
|
588
|
-
|
|
589
|
-
##### options?
|
|
590
|
-
|
|
591
|
-
[`InitializeVaultCustodyOptions`](InitializeVaultCustodyOptions.md) = `{}`
|
|
592
|
-
|
|
593
|
-
#### Returns
|
|
594
|
-
|
|
595
|
-
`Promise`\<[`InitializedVaultCustody`](InitializedVaultCustody.md)\>
|
|
596
|
-
|
|
597
|
-
***
|
|
598
|
-
|
|
599
|
-
### listIdentities
|
|
600
|
-
|
|
601
|
-
> **listIdentities**: (`storage`) => `Promise`\<`any`[]\>
|
|
602
|
-
|
|
603
|
-
Lists all identities in the workspace with their discovery metadata.
|
|
604
|
-
|
|
605
|
-
#### Parameters
|
|
606
|
-
|
|
607
|
-
##### storage
|
|
608
|
-
|
|
609
|
-
[`IStorageProvider`](IStorageProvider.md)
|
|
610
|
-
|
|
611
|
-
#### Returns
|
|
612
|
-
|
|
613
|
-
`Promise`\<`any`[]\>
|
|
614
|
-
|
|
615
|
-
***
|
|
616
|
-
|
|
617
368
|
### listVaults
|
|
618
369
|
|
|
619
|
-
> **listVaults**: (`storage`) => `Promise`\<`
|
|
370
|
+
> **listVaults**: (`storage`) => `Promise`\<`string`[]\>
|
|
620
371
|
|
|
621
|
-
Lists all available vaults in the workspace
|
|
372
|
+
Lists all available vaults in the workspace.
|
|
622
373
|
|
|
623
374
|
#### Parameters
|
|
624
375
|
|
|
@@ -630,9 +381,9 @@ The root workspace storage provider.
|
|
|
630
381
|
|
|
631
382
|
#### Returns
|
|
632
383
|
|
|
633
|
-
`Promise`\<`
|
|
384
|
+
`Promise`\<`string`[]\>
|
|
634
385
|
|
|
635
|
-
A list of vault IDs
|
|
386
|
+
A list of vault IDs.
|
|
636
387
|
|
|
637
388
|
***
|
|
638
389
|
|
|
@@ -660,74 +411,6 @@ A list of vault IDs and their public discovery metadata.
|
|
|
660
411
|
|
|
661
412
|
***
|
|
662
413
|
|
|
663
|
-
### readIdentityMetadata
|
|
664
|
-
|
|
665
|
-
> **readIdentityMetadata**: (`storage`, `identityId`, `privateKey?`) => `Promise`\<`any`\>
|
|
666
|
-
|
|
667
|
-
Metadata reader for identities.
|
|
668
|
-
Discovery info (nickname) can be read with just identityId.
|
|
669
|
-
Full profile requires privateKey.
|
|
670
|
-
|
|
671
|
-
#### Parameters
|
|
672
|
-
|
|
673
|
-
##### storage
|
|
674
|
-
|
|
675
|
-
[`IStorageProvider`](IStorageProvider.md)
|
|
676
|
-
|
|
677
|
-
##### identityId
|
|
678
|
-
|
|
679
|
-
`string`
|
|
680
|
-
|
|
681
|
-
##### privateKey?
|
|
682
|
-
|
|
683
|
-
`string`
|
|
684
|
-
|
|
685
|
-
#### Returns
|
|
686
|
-
|
|
687
|
-
`Promise`\<`any`\>
|
|
688
|
-
|
|
689
|
-
***
|
|
690
|
-
|
|
691
|
-
### readIdentityPrivateVaultChildrenState
|
|
692
|
-
|
|
693
|
-
> **readIdentityPrivateVaultChildrenState**: (`storage`, `identityOrPrivateKey`) => `Promise`\<[`IdentityPrivateVaultChildrenState`](IdentityPrivateVaultChildrenState.md)\>
|
|
694
|
-
|
|
695
|
-
#### Parameters
|
|
696
|
-
|
|
697
|
-
##### storage
|
|
698
|
-
|
|
699
|
-
[`IStorageProvider`](IStorageProvider.md)
|
|
700
|
-
|
|
701
|
-
##### identityOrPrivateKey
|
|
702
|
-
|
|
703
|
-
[`IdentityPrivateVaultAccess`](../type-aliases/IdentityPrivateVaultAccess.md)
|
|
704
|
-
|
|
705
|
-
#### Returns
|
|
706
|
-
|
|
707
|
-
`Promise`\<[`IdentityPrivateVaultChildrenState`](IdentityPrivateVaultChildrenState.md)\>
|
|
708
|
-
|
|
709
|
-
***
|
|
710
|
-
|
|
711
|
-
### readIdentityPrivateVaultProfile
|
|
712
|
-
|
|
713
|
-
> **readIdentityPrivateVaultProfile**: (`storage`, `identityOrPrivateKey`) => `Promise`\<[`IdentityPrivateVaultProfile`](IdentityPrivateVaultProfile.md) \| `null`\>
|
|
714
|
-
|
|
715
|
-
#### Parameters
|
|
716
|
-
|
|
717
|
-
##### storage
|
|
718
|
-
|
|
719
|
-
[`IStorageProvider`](IStorageProvider.md)
|
|
720
|
-
|
|
721
|
-
##### identityOrPrivateKey
|
|
722
|
-
|
|
723
|
-
[`IdentityPrivateVaultAccess`](../type-aliases/IdentityPrivateVaultAccess.md)
|
|
724
|
-
|
|
725
|
-
#### Returns
|
|
726
|
-
|
|
727
|
-
`Promise`\<[`IdentityPrivateVaultProfile`](IdentityPrivateVaultProfile.md) \| `null`\>
|
|
728
|
-
|
|
729
|
-
***
|
|
730
|
-
|
|
731
414
|
### recoverVault
|
|
732
415
|
|
|
733
416
|
> **recoverVault**: \{(`storage`, `options`): `Promise`\<[`RecoveredVault`](RecoveredVault.md)\>; (`options`): `Promise`\<[`RecoveredVault`](RecoveredVault.md)\>; \}
|
|
@@ -750,7 +433,7 @@ Workspace storage where the vault was created.
|
|
|
750
433
|
|
|
751
434
|
[`RecoverVaultOptions`](RecoverVaultOptions.md)
|
|
752
435
|
|
|
753
|
-
Recovery options (must include `vaultId` and `
|
|
436
|
+
Recovery options (must include `vaultId` and `password`).
|
|
754
437
|
|
|
755
438
|
##### Returns
|
|
756
439
|
|
|
@@ -763,7 +446,7 @@ A [RecoveredVault](RecoveredVault.md) instance.
|
|
|
763
446
|
```ts
|
|
764
447
|
const vault = await recoverVault({
|
|
765
448
|
vaultId: 'vault_123',
|
|
766
|
-
|
|
449
|
+
password: 'my-strong-password'
|
|
767
450
|
});
|
|
768
451
|
```
|
|
769
452
|
|
|
@@ -779,7 +462,7 @@ Recovers an existing vault using the default workspace storage.
|
|
|
779
462
|
|
|
780
463
|
[`RecoverVaultOptions`](RecoverVaultOptions.md)
|
|
781
464
|
|
|
782
|
-
Recovery options including vaultId and
|
|
465
|
+
Recovery options including vaultId and password.
|
|
783
466
|
|
|
784
467
|
##### Returns
|
|
785
468
|
|
|
@@ -787,30 +470,6 @@ Recovery options including vaultId and owner identity.
|
|
|
787
470
|
|
|
788
471
|
***
|
|
789
472
|
|
|
790
|
-
### recoverVaultWorkingKey
|
|
791
|
-
|
|
792
|
-
> **recoverVaultWorkingKey**: (`storage`, `vaultRecoveryKey`, `storageKey`) => `Promise`\<`string`\>
|
|
793
|
-
|
|
794
|
-
#### Parameters
|
|
795
|
-
|
|
796
|
-
##### storage
|
|
797
|
-
|
|
798
|
-
[`IStorageProvider`](IStorageProvider.md)
|
|
799
|
-
|
|
800
|
-
##### vaultRecoveryKey
|
|
801
|
-
|
|
802
|
-
`string`
|
|
803
|
-
|
|
804
|
-
##### storageKey?
|
|
805
|
-
|
|
806
|
-
`string` = `DEFAULT_VAULT_KEY_CUSTODY_BLOB_KEY`
|
|
807
|
-
|
|
808
|
-
#### Returns
|
|
809
|
-
|
|
810
|
-
`Promise`\<`string`\>
|
|
811
|
-
|
|
812
|
-
***
|
|
813
|
-
|
|
814
473
|
### restoreIdentity
|
|
815
474
|
|
|
816
475
|
> **restoreIdentity**: (`privateKey`, `options`) => `CreatedIdentity`
|
|
@@ -859,23 +518,23 @@ const identity = restoreIdentity('MIIB...');
|
|
|
859
518
|
|
|
860
519
|
### wrapVaultCoreAsVaultService
|
|
861
520
|
|
|
862
|
-
> **wrapVaultCoreAsVaultService**: (`core`, `options`) =>
|
|
521
|
+
> **wrapVaultCoreAsVaultService**: (`core`, `options`) => `VaultService`
|
|
863
522
|
|
|
864
523
|
#### Parameters
|
|
865
524
|
|
|
866
525
|
##### core
|
|
867
526
|
|
|
868
|
-
[`VaultCore`](VaultCore.md)
|
|
527
|
+
[`VaultCore`](../classes/VaultCore.md)
|
|
869
528
|
|
|
870
529
|
##### options?
|
|
871
530
|
|
|
872
531
|
###### clock?
|
|
873
532
|
|
|
874
|
-
|
|
533
|
+
`Clock`
|
|
875
534
|
|
|
876
535
|
###### customFlows?
|
|
877
536
|
|
|
878
|
-
|
|
537
|
+
`VaultCustomFlowResolver`
|
|
879
538
|
|
|
880
539
|
###### fetchImpl?
|
|
881
540
|
|
|
@@ -883,4 +542,4 @@ const identity = restoreIdentity('MIIB...');
|
|
|
883
542
|
|
|
884
543
|
#### Returns
|
|
885
544
|
|
|
886
|
-
|
|
545
|
+
`VaultService`
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
[**CBIO Node Runtime Agent API v1.
|
|
1
|
+
[**CBIO Node Runtime Agent API v1.47.0**](../README.md)
|
|
2
2
|
|
|
3
3
|
***
|
|
4
4
|
|
|
@@ -14,13 +14,13 @@
|
|
|
14
14
|
|
|
15
15
|
### capability
|
|
16
16
|
|
|
17
|
-
> **capability**:
|
|
17
|
+
> **capability**: `AgentCapability`
|
|
18
18
|
|
|
19
19
|
***
|
|
20
20
|
|
|
21
21
|
### clock?
|
|
22
22
|
|
|
23
|
-
> `optional` **clock?**:
|
|
23
|
+
> `optional` **clock?**: `Clock`
|
|
24
24
|
|
|
25
25
|
***
|
|
26
26
|
|
|
@@ -38,4 +38,4 @@
|
|
|
38
38
|
|
|
39
39
|
### vault?
|
|
40
40
|
|
|
41
|
-
> `optional` **vault?**:
|
|
41
|
+
> `optional` **vault?**: `VaultService`
|
|
@@ -1,13 +1,9 @@
|
|
|
1
|
-
[**CBIO Node Runtime Agent API v1.
|
|
1
|
+
[**CBIO Node Runtime Agent API v1.47.0**](../README.md)
|
|
2
2
|
|
|
3
3
|
***
|
|
4
4
|
|
|
5
5
|
# Interface: CreateIdentityOptions
|
|
6
6
|
|
|
7
|
-
## Extended by
|
|
8
|
-
|
|
9
|
-
- [`CreateChildIdentityOptions`](CreateChildIdentityOptions.md)
|
|
10
|
-
|
|
11
7
|
## Properties
|
|
12
8
|
|
|
13
9
|
### nickname?
|