@the-ai-company/cbio-node-runtime 1.63.2 → 1.63.5
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/README.md +48 -209
- package/dist/clients/agent/client.d.ts +18 -40
- package/dist/clients/agent/client.js +22 -109
- package/dist/clients/agent/client.js.map +1 -1
- package/dist/clients/agent/contracts.d.ts +1 -8
- package/dist/clients/agent/index.d.ts +1 -1
- package/dist/clients/owner/client.d.ts +2 -102
- package/dist/clients/owner/client.js +119 -240
- package/dist/clients/owner/client.js.map +1 -1
- package/dist/clients/owner/contracts.d.ts +37 -70
- package/dist/clients/owner/index.d.ts +2 -4
- package/dist/clients/owner/index.js +1 -2
- package/dist/clients/owner/index.js.map +1 -1
- package/dist/internal/id-factory.d.ts +0 -2
- package/dist/internal/id-factory.js +0 -6
- package/dist/internal/id-factory.js.map +1 -1
- package/dist/protocol/identity.d.ts +1 -1
- package/dist/protocol/identity.js +3 -3
- package/dist/protocol/identity.js.map +1 -1
- package/dist/public-types.d.ts +5 -0
- package/dist/public-types.js +2 -0
- package/dist/public-types.js.map +1 -0
- package/dist/runtime/bootstrap.js.map +1 -1
- package/dist/runtime/identity.d.ts +2 -2
- package/dist/runtime/identity.js +3 -5
- package/dist/runtime/identity.js.map +1 -1
- package/dist/runtime/index.d.ts +10 -11
- package/dist/runtime/index.js +7 -8
- package/dist/runtime/index.js.map +1 -1
- package/dist/runtime/owner-session.d.ts +7 -6
- package/dist/runtime/owner-session.js +5 -6
- package/dist/runtime/owner-session.js.map +1 -1
- package/dist/storage/fs.d.ts +3 -2
- package/dist/storage/fs.js +8 -5
- package/dist/storage/fs.js.map +1 -1
- package/dist/storage/prefix.d.ts +1 -0
- package/dist/storage/prefix.js +7 -0
- package/dist/storage/prefix.js.map +1 -1
- package/dist/storage/provider.d.ts +2 -0
- package/dist/vault-core/contracts.d.ts +112 -193
- package/dist/vault-core/contracts.js +5 -8
- package/dist/vault-core/contracts.js.map +1 -1
- package/dist/vault-core/core.d.ts +127 -62
- package/dist/vault-core/core.js +500 -1182
- package/dist/vault-core/core.js.map +1 -1
- package/dist/vault-core/defaults.d.ts +26 -42
- package/dist/vault-core/defaults.js +73 -229
- package/dist/vault-core/defaults.js.map +1 -1
- package/dist/vault-core/errors.d.ts +3 -2
- package/dist/vault-core/errors.js.map +1 -1
- package/dist/vault-core/index.d.ts +5 -5
- package/dist/vault-core/index.js +2 -2
- package/dist/vault-core/index.js.map +1 -1
- package/dist/vault-core/persistence.d.ts +78 -118
- package/dist/vault-core/persistence.js +329 -421
- package/dist/vault-core/persistence.js.map +1 -1
- package/dist/vault-core/ports.d.ts +19 -24
- package/dist/vault-core/read-policy.d.ts +3 -2
- package/dist/vault-core/read-policy.js.map +1 -1
- package/dist/vault-core/tool-metadata.js +2 -2
- package/dist/vault-core/tool-metadata.js.map +1 -1
- package/dist/vault-ingress/defaults.d.ts +4 -2
- package/dist/vault-ingress/defaults.js +14 -8
- package/dist/vault-ingress/defaults.js.map +1 -1
- package/dist/vault-ingress/index.d.ts +43 -117
- package/dist/vault-ingress/index.js +98 -453
- package/dist/vault-ingress/index.js.map +1 -1
- package/dist/vault-ingress/remote-transport.d.ts +5 -3
- package/dist/vault-ingress/remote-transport.js +8 -28
- package/dist/vault-ingress/remote-transport.js.map +1 -1
- package/docs/ARCHITECTURE.md +39 -22
- package/docs/CUSTODY_MODEL.md +1 -1
- package/docs/IDENTITY_MODEL.md +5 -5
- package/docs/MIGRATION-1.51.md +19 -19
- package/docs/MIGRATION-1.65.md +61 -0
- package/docs/PROCESS_ISOLATION.md +2 -2
- package/docs/REFERENCE.md +42 -200
- package/docs/api/README.md +50 -22
- package/docs/api/classes/IdentityError.md +1 -1
- package/docs/api/classes/OwnerClientError.md +1 -1
- package/docs/api/classes/PersistentVaultAgentIdentityRegistry.md +89 -0
- package/docs/api/classes/PersistentVaultAgentSecretGrantRegistry.md +125 -0
- package/docs/api/classes/PersistentVaultAuditLog.md +65 -0
- package/docs/api/classes/PersistentVaultCustomHttpFlowRegistry.md +69 -0
- package/docs/api/classes/PersistentVaultSecretCustody.md +93 -0
- package/docs/api/classes/PersistentVaultSecretDestinationGrantRegistry.md +125 -0
- package/docs/api/classes/PersistentVaultSecretRepository.md +127 -0
- package/docs/api/classes/VaultCore.md +299 -214
- package/docs/api/classes/VaultCoreError.md +3 -3
- package/docs/api/enumerations/AuditAction.md +143 -0
- package/docs/api/enumerations/AuditOutcome.md +35 -0
- package/docs/api/enumerations/DispatchStatus.md +35 -0
- package/docs/api/enumerations/IdentityErrorCode.md +1 -1
- package/docs/api/enumerations/OwnerClientErrorCode.md +1 -1
- package/docs/api/functions/createAgentClient.md +1 -15
- package/docs/api/functions/createIdentity.md +2 -2
- package/docs/api/functions/createOwnerClient.md +17 -0
- package/docs/api/functions/createOwnerSession.md +1 -1
- package/docs/api/functions/createPersistentVaultCoreDependencies.md +4 -4
- package/docs/api/functions/createVault.md +1 -1
- package/docs/api/functions/createVaultCore.md +1 -1
- package/docs/api/functions/createVaultCoreDependencies.md +1 -1
- package/docs/api/functions/createVaultService.md +5 -9
- package/docs/api/functions/createWorkspaceStorage.md +1 -1
- package/docs/api/functions/deriveRootAgentId.md +17 -0
- package/docs/api/functions/deriveVaultWorkingKeyFromPassword.md +1 -1
- package/docs/api/functions/getDefaultWorkspaceDir.md +1 -1
- package/docs/api/functions/handleVaultAgentControlHttp.md +2 -2
- package/docs/api/functions/handleVaultHttpDispatch.md +2 -2
- package/docs/api/functions/initializeVaultCustody.md +7 -3
- package/docs/api/functions/listVaults.md +1 -1
- package/docs/api/functions/readVaultProfile.md +1 -1
- package/docs/api/functions/recoverVault.md +1 -1
- package/docs/api/functions/recoverVaultWorkingKey.md +4 -8
- package/docs/api/functions/restoreIdentity.md +1 -1
- package/docs/api/functions/updateVaultMetadata.md +1 -1
- package/docs/api/functions/writeVaultProfile.md +1 -1
- package/docs/api/interfaces/AgentClient.md +20 -59
- package/docs/api/interfaces/AgentDispatchIntent.md +1 -1
- package/docs/api/interfaces/AgentDispatchTransport.md +12 -44
- package/docs/api/interfaces/AgentIdentity.md +3 -3
- package/docs/api/interfaces/AgentIdentityRecord.md +47 -0
- package/docs/api/interfaces/AgentRequestResult.md +35 -0
- package/docs/api/interfaces/AgentRuntimeManifest.md +55 -0
- package/docs/api/interfaces/AgentSecretGrant.md +41 -0
- package/docs/api/interfaces/AgentSigner.md +1 -1
- package/docs/api/interfaces/AgentVisibleRequestRecord.md +53 -0
- package/docs/api/interfaces/AgentVisibleSecretRecord.md +65 -0
- package/docs/api/interfaces/AuditEntry.md +83 -0
- package/docs/api/interfaces/CbioRuntime.md +13 -150
- package/docs/api/interfaces/CreateAgentClientOptions.md +4 -10
- package/docs/api/interfaces/CreateIdentityOptions.md +1 -1
- package/docs/api/interfaces/{CreateVaultClientOptions.md → CreateOwnerClientOptions.md} +9 -11
- package/docs/api/interfaces/CreateOwnerSessionOptions.md +3 -117
- package/docs/api/interfaces/CreatePersistentVaultCoreDependenciesOptions.md +3 -131
- package/docs/api/interfaces/CreateVaultOptions.md +1 -121
- package/docs/api/interfaces/CreatedVault.md +2 -2
- package/docs/api/interfaces/CustomHttpFlowDefinition.md +71 -0
- package/docs/api/interfaces/DefaultPolicyEngineOptions.md +1 -13
- package/docs/api/interfaces/DispatchAuthorization.md +43 -0
- package/docs/api/interfaces/DispatchInstruction.md +47 -0
- package/docs/api/interfaces/DispatchRequest.md +83 -0
- package/docs/api/interfaces/DispatchResult.md +53 -0
- package/docs/api/interfaces/IStorageProvider.md +13 -1
- package/docs/api/interfaces/InitializeVaultCustodyOptions.md +31 -11
- package/docs/api/interfaces/InitializedVaultCustody.md +1 -7
- package/docs/api/interfaces/OwnerAgentProvisionResult.md +2 -2
- package/docs/api/interfaces/OwnerClient.md +417 -0
- package/docs/api/interfaces/OwnerCreateSecretInput.md +1 -1
- package/docs/api/interfaces/OwnerRemoveSecretInput.md +1 -1
- package/docs/api/interfaces/OwnerRequestRecord.md +97 -0
- package/docs/api/interfaces/OwnerSensitiveActionConfirmation.md +1 -1
- package/docs/api/interfaces/OwnerSensitiveActionContext.md +1 -1
- package/docs/api/interfaces/OwnerSession.md +3 -3
- package/docs/api/interfaces/OwnerUpdateSecretInput.md +1 -1
- package/docs/api/interfaces/OwnerVisibleRequestRecord.md +73 -0
- package/docs/api/interfaces/RecoverVaultOptions.md +1 -121
- package/docs/api/interfaces/RecoveredVault.md +2 -2
- package/docs/api/interfaces/RequestRecord.md +107 -0
- package/docs/api/interfaces/RestoreIdentityOptions.md +1 -1
- package/docs/api/interfaces/SecretAlias.md +11 -0
- package/docs/api/interfaces/SecretDestinationGrant.md +41 -0
- package/docs/api/interfaces/SecretId.md +11 -0
- package/docs/api/interfaces/SecretRecord.md +89 -0
- package/docs/api/interfaces/Signer.md +1 -1
- package/docs/api/interfaces/VaultApproveDispatchInput.md +3 -9
- package/docs/api/interfaces/VaultAuditQueryInput.md +1 -1
- package/docs/api/interfaces/VaultCoreDependenciesOptions.md +1 -5
- package/docs/api/interfaces/VaultCreateAgentInput.md +1 -1
- package/docs/api/interfaces/VaultExportSecretInput.md +1 -1
- package/docs/api/interfaces/VaultGetRequestInput.md +17 -0
- package/docs/api/interfaces/VaultGrantAgentSecretInput.md +23 -0
- package/docs/api/interfaces/VaultGrantSecretDestinationInput.md +23 -0
- package/docs/api/interfaces/VaultId.md +11 -0
- package/docs/api/interfaces/VaultImportAgentInput.md +1 -1
- package/docs/api/interfaces/VaultIssueSessionTokenInput.md +5 -5
- package/docs/api/interfaces/VaultListAgentsInput.md +1 -1
- package/docs/api/interfaces/VaultListGrantsInput.md +23 -0
- package/docs/api/interfaces/VaultListRequestsInput.md +17 -0
- package/docs/api/interfaces/VaultListSecretsInput.md +1 -1
- package/docs/api/interfaces/VaultMetadata.md +1 -1
- package/docs/api/interfaces/VaultObject.md +2 -2
- package/docs/api/interfaces/VaultPrincipal.md +17 -0
- package/docs/api/interfaces/VaultProfile.md +1 -1
- package/docs/api/interfaces/VaultReadAgentPrivateKeyInput.md +7 -7
- package/docs/api/interfaces/VaultReadSecretPlaintextInput.md +1 -1
- package/docs/api/interfaces/VaultRegisterFlowInput.md +1 -1
- package/docs/api/interfaces/VaultRevokeAgentSecretInput.md +23 -0
- package/docs/api/interfaces/VaultRevokeSecretDestinationInput.md +23 -0
- package/docs/api/interfaces/VaultRevokeSessionTokenInput.md +1 -1
- package/docs/api/interfaces/VaultService.md +547 -0
- package/docs/api/interfaces/VaultUpdateAgentInput.md +7 -7
- package/docs/api/type-aliases/AgentId.md +7 -0
- package/docs/api/type-aliases/CbioRuntimeModule.md +1 -1
- package/docs/api/type-aliases/DispatchApprovalDecision.md +7 -0
- package/docs/api/type-aliases/GrantStatus.md +7 -0
- package/docs/api/type-aliases/SecretLifecycleStatus.md +7 -0
- package/docs/api/type-aliases/VaultPrincipalKind.md +7 -0
- package/docs/api/variables/DEFAULT_VAULT_KEY_CUSTODY_BLOB_KEY.md +2 -2
- package/docs/es/README.md +3 -3
- package/docs/fr/README.md +3 -3
- package/docs/ja/README.md +5 -5
- package/docs/ko/README.md +5 -5
- package/docs/pt/README.md +3 -3
- package/docs/zh/PROCESS_ISOLATION.md +2 -2
- package/docs/zh/README.md +24 -24
- package/examples/process-isolation.ts +26 -35
- package/package.json +3 -2
- package/docs/api/functions/createOwnerHttpFlowBoundary.md +0 -17
- package/docs/api/functions/createStandardAcquireBoundary.md +0 -31
- package/docs/api/functions/createStandardDispatchBoundary.md +0 -23
- package/docs/api/functions/createVaultClient.md +0 -32
- package/docs/api/functions/deriveIdentityId.md +0 -17
- package/docs/api/functions/wrapVaultCoreAsVaultService.md +0 -31
- package/docs/api/interfaces/AgentSubmitCapabilityRequestInput.md +0 -41
- package/docs/api/interfaces/VaultApproveCapabilityRequestInput.md +0 -23
- package/docs/api/interfaces/VaultClient.md +0 -473
- package/docs/api/interfaces/VaultGrantCapabilityInput.md +0 -79
- package/docs/api/interfaces/VaultGrantCapabilityRequest.md +0 -23
- package/docs/api/interfaces/VaultIdentity.md +0 -11
- package/docs/api/interfaces/VaultListCapabilitiesInput.md +0 -17
- package/docs/api/interfaces/VaultRevokeCapabilityInput.md +0 -23
- package/docs/api/interfaces/VaultSigner.md +0 -21
- package/docs/api/interfaces/VaultSubmitCapabilityRequestInput.md +0 -73
- package/docs/api/type-aliases/AgentCapabilityEnvelope.md +0 -7
- package/docs/api/type-aliases/AgentVisibleSecretRecord.md +0 -7
- package/docs/api/type-aliases/OwnerGrantCapabilityInput.md +0 -7
package/docs/REFERENCE.md
CHANGED
|
@@ -1,213 +1,55 @@
|
|
|
1
|
-
# CBIO Vault Runtime Reference (v1.
|
|
1
|
+
# CBIO Vault Runtime Reference (v1.65.1)
|
|
2
2
|
|
|
3
3
|
This document describes the current implemented runtime surface for the **Sovereign Vault**.
|
|
4
4
|
|
|
5
5
|
## Primary API Surface
|
|
6
6
|
|
|
7
|
-
The v1.
|
|
7
|
+
The v1.65.1 runtime centers on a streamlined **Grant-based** authorization model, providing a "Zero-Configuration" workflow for agents.
|
|
8
8
|
|
|
9
9
|
### Main Constructors and Entrypoints
|
|
10
10
|
|
|
11
11
|
- `createVault(...)` - Initialize a new vault using a master password.
|
|
12
12
|
- `recoverVault(...)` - Reopen an existing vault using its master password.
|
|
13
|
-
- `
|
|
14
|
-
- `
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
- `
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
-
|
|
26
|
-
-
|
|
27
|
-
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
-
|
|
36
|
-
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
Identity material (private keys) generated and stored securely within the vault's own registry.
|
|
54
|
-
- Use `client.ownerCreateAgent(...)` to manage these.
|
|
55
|
-
- **Session Tokens**: Owners can issue revocable `sat_...` tokens for managed agents to enable stateless authentication without raw private keys.
|
|
56
|
-
|
|
57
|
-
### 2. External Identity
|
|
58
|
-
Identity material already managed elsewhere can be imported into vault custody via `client.ownerImportAgent({ privateKey, ... })`.
|
|
59
|
-
|
|
60
|
-
## Vault Client (Owner/Admin)
|
|
61
|
-
|
|
62
|
-
The `VaultClient` provides the administrative interface for the vault.
|
|
63
|
-
|
|
64
|
-
### Stable Owner API Checklist
|
|
65
|
-
|
|
66
|
-
The following owner-side methods are part of the supported public surface and are intended to be called through an owner session or a short-lived owner client:
|
|
67
|
-
|
|
68
|
-
- `ownerCreateSecret(...)`
|
|
69
|
-
- `ownerUpdateSecret(...)`
|
|
70
|
-
- `ownerReadSecretPlaintext(...)`
|
|
71
|
-
- `ownerExportSecret(...)`
|
|
72
|
-
- `ownerCreateAgent(...)`
|
|
73
|
-
- `ownerImportAgent(...)`
|
|
74
|
-
- `ownerUpdateAgent(...)`
|
|
75
|
-
- `ownerReadAgentPrivateKey(...)`
|
|
76
|
-
- `ownerListAgents(...)`
|
|
77
|
-
- `ownerGrantCapability(...)`
|
|
78
|
-
- `ownerRevokeCapability(...)`
|
|
79
|
-
- `ownerListCapabilities(...)`
|
|
80
|
-
- `ownerListSecrets(...)`
|
|
81
|
-
- `ownerRegisterFlow(...)`
|
|
82
|
-
- `ownerSubmitCapabilityRequest(...)`
|
|
83
|
-
- `ownerListCapabilityStates(...)`
|
|
84
|
-
- `ownerApproveCapabilityRead(...)`
|
|
85
|
-
- `ownerAllowOnce(...)`
|
|
86
|
-
- `ownerAllowAlways(...)`
|
|
87
|
-
- `ownerDeny(...)`
|
|
88
|
-
- `ownerOnCapabilityState(...)`
|
|
89
|
-
- `ownerIssueSessionToken(...)`
|
|
90
|
-
- `ownerIssueAllSessionTokens()`
|
|
91
|
-
- `ownerRevokeSessionToken(...)`
|
|
92
|
-
- `ownerReadAudit(...)`
|
|
93
|
-
|
|
94
|
-
### Core Operations
|
|
95
|
-
- `ownerCreateSecret(...)`: Insert a new active secret. The call fails if the alias already has an active record.
|
|
96
|
-
- `ownerUpdateSecret(...)`: Insert a new successor version for the active alias and mark the previous version as superseded.
|
|
97
|
-
- `ownerCreateAgent(...)`: Generate and host a new agent identity, then return its public record plus a session token.
|
|
98
|
-
- `ownerImportAgent(...)`: Import an existing private key into vault custody, then return its public record plus a session token.
|
|
99
|
-
- `ownerUpdateAgent(...)`: Update an agent's stored nickname and metadata.
|
|
100
|
-
- `ownerListAgents()`: Enumerate authorized agents. Private keys are redacted from the default list response.
|
|
101
|
-
- Each listed agent also includes its current `sessionTokens`.
|
|
102
|
-
- `ownerGrantCapability(...)`: Assign specific secret-use permissions to an agent. Capability IDs are generated internally.
|
|
103
|
-
- `ownerSubmitCapabilityRequest(...)`: Create a capability carrier for later owner review.
|
|
104
|
-
- `ownerListCapabilityStates(...)`: Read capability carriers, optionally filtered by `agentId`, `writeGranted`, or `readGranted`.
|
|
105
|
-
- `ownerApproveCapabilityRead({ requestId, read? })`: Approve the inbound read action separately on the same carrier after write approval. Pass `read` to replace the pending read policy at approval time with a `paths` whitelist. Response shape is always visible; `read.paths` only unlocks values, and `['$']` unlocks the full body.
|
|
106
|
-
- `ownerAllowOnce({ requestId })`: Execute a write-approved pending request once, then delete the carrier. This is only valid for dispatch-discovery carriers with a concrete blocked request.
|
|
107
|
-
- `ownerAllowAlways({ requestId })`: Persist the carrier as an active capability. For dispatch discovery this also executes the blocked request; for explicit requests it grants the capability without sending network traffic. Capability IDs are generated internally.
|
|
108
|
-
- `ownerDeny(requestId)`: Reject the currently pending action on the carrier.
|
|
109
|
-
- `ownerOnCapabilityState(callback)`: Register a real-time observer for capability-carrier changes.
|
|
110
|
-
- `ownerIssueSessionToken(input)`: Issue a session token for a specific agent.
|
|
111
|
-
- `ownerIssueAllSessionTokens()`: Batch-issue session tokens for all registered agents.
|
|
112
|
-
- `ownerRevokeSessionToken({ token })`: Invalidate a specific session token.
|
|
113
|
-
- `ownerReadSecretPlaintext({ alias, password })`: Read one secret's plaintext after re-entering the vault password.
|
|
114
|
-
- `ownerExportSecret({ alias, password })`: Export a secret's full plaintext record after re-entering the vault password.
|
|
115
|
-
- `ownerReadAgentPrivateKey({ agentId, password })`: Read one managed agent private key after re-entering the vault password.
|
|
116
|
-
- `ownerReadAudit(...)`: Access the append-only record of all vault actions.
|
|
117
|
-
|
|
118
|
-
### Sensitive Action Contract
|
|
119
|
-
|
|
120
|
-
The following owner operations are sensitive actions:
|
|
121
|
-
|
|
122
|
-
- `ownerReadSecretPlaintext(...)`
|
|
123
|
-
- `ownerExportSecret(...)`
|
|
124
|
-
- `ownerReadAgentPrivateKey(...)`
|
|
125
|
-
- `ownerRemoveSecret(...)`
|
|
126
|
-
|
|
127
|
-
All four require:
|
|
128
|
-
|
|
129
|
-
- `password`
|
|
130
|
-
- optional `verificationCode`
|
|
131
|
-
|
|
132
|
-
Client configuration:
|
|
133
|
-
|
|
134
|
-
- `createVaultClient(...)` may be configured with `sensitiveActionVerifier(confirmation, context)`
|
|
135
|
-
- if no `sensitiveActionVerifier` is provided, `passwordVerifier(password)` is required for these operations
|
|
136
|
-
|
|
137
|
-
Stable owner client error codes:
|
|
138
|
-
|
|
139
|
-
- `SENSITIVE_ACTION_PASSWORD_REQUIRED`
|
|
140
|
-
- `SENSITIVE_ACTION_VERIFIER_REQUIRED`
|
|
141
|
-
- `SENSITIVE_ACTION_REJECTED`
|
|
142
|
-
- `SENSITIVE_ACTION_INVALID_PASSWORD`
|
|
143
|
-
- `AGENT_PRIVATE_KEY_NOT_FOUND`
|
|
144
|
-
- `INVALID_CREATE_VAULT_CLIENT_OPTIONS`
|
|
145
|
-
|
|
146
|
-
Recommended GUI behavior:
|
|
147
|
-
|
|
148
|
-
- Keep an `OwnerSession`, not a raw `VaultClient`
|
|
149
|
-
- Call `session.client()` or `session.withClient(...)` for each owner operation
|
|
150
|
-
- Show a single reusable confirmation dialog for sensitive actions
|
|
151
|
-
- Always collect the password
|
|
152
|
-
- Optionally collect a second factor such as a 6-digit verification code
|
|
153
|
-
- Branch UI behavior on `OwnerClientError.code` rather than parsing error strings
|
|
154
|
-
|
|
155
|
-
## Agent Client (Consumer)
|
|
156
|
-
|
|
157
|
-
The `AgentClient` is used by delegated processes (e.g., LLMs or background workers) to perform authorized actions.
|
|
158
|
-
|
|
159
|
-
### Core Operations
|
|
160
|
-
- `agentDispatch(...)`: Use a granted capability to send a secret to an authorized target.
|
|
161
|
-
- **Status**: Returns `SUCCEEDED`, `FAILED`, or `PENDING`.
|
|
162
|
-
- **Execution Semantics**: This is the method that attempts the real task immediately.
|
|
163
|
-
- **Owner Context**: A non-empty `reason` string is required and is recorded for owner review.
|
|
164
|
-
- **Result Delivery**: The full result is stored in a sealed request record; use `agentListRequests()` and `agentGetRequest(...)` to inspect it later.
|
|
165
|
-
- **Discovery Flow**: If an agent attempts an action not explicitly in its white-list, the request is automatically stalled as `PENDING` for owner review.
|
|
166
|
-
- `agentListCapabilities()`: Read the agent's capability carriers, including current `write` and `read` action states.
|
|
167
|
-
- `agentListSecrets()`: Read all secret metadata in the vault, with per-secret authorization markers showing which entries the agent can currently use.
|
|
168
|
-
- `agentListRequests()`: Read the agent's request history with partially redacted metadata.
|
|
169
|
-
- `agentGetRequest(...)`: Read one request record and receive the result body only if the corresponding read action has been approved.
|
|
170
|
-
- `ownerListRequests()`: Read request history as owner, including approval states.
|
|
171
|
-
- `ownerGetRequest(...)`: Read the full sealed request record as owner, including response content before read release.
|
|
172
|
-
- `agentIntrospect()`: Read the vault-known self context (`agentId`, `identityId`, `nickname`, `metadata`) plus capability carriers and the tool manifest.
|
|
173
|
-
- `agentSubmitCapabilityRequest(...)`: Ask the owner for a broader `scope + methods` grant without executing any request. A non-empty `reason` string is required for owner review.
|
|
174
|
-
- **Security**: The agent never handles the vault's master password. Agent execution uses **Session Tokens** rather than raw private-key dispatch.
|
|
175
|
-
- **Auditing**: Dispatches are audited by default. Set `skipAudit: true` in the capability (or during approval) to disable logging for specific actions.
|
|
176
|
-
|
|
177
|
-
## Capability Action Approval
|
|
178
|
-
|
|
179
|
-
The runtime uses capability carriers with two independently approved actions:
|
|
180
|
-
|
|
181
|
-
- **Dispatch discovery**: A concrete dispatch misses existing capability coverage and creates a carrier with `write.status = PENDING`.
|
|
182
|
-
- **Capability request**: An external planner or controller creates a broader carrier before any dispatch is attempted.
|
|
183
|
-
|
|
184
|
-
This is useful for LLM-driven planners that can infer the needed scope ahead of time, for example:
|
|
185
|
-
- scope `https://api.example.com/users/*`
|
|
186
|
-
- methods `["GET"]`
|
|
187
|
-
|
|
188
|
-
The carrier remains actionable until the owner approves or rejects its pending actions:
|
|
189
|
-
- `ownerSubmitCapabilityRequest(...)` creates the carrier.
|
|
190
|
-
- `ownerListCapabilityStates({ writeGranted: false })` reads the current queue.
|
|
191
|
-
- `ownerAllowOnce(...)` executes a write-approved discovery request once and removes the pending carrier.
|
|
192
|
-
- `ownerAllowAlways(...)` persists a real capability carrier and also executes the blocked request when the carrier came from dispatch discovery.
|
|
193
|
-
- `ownerApproveCapabilityRead(...)` can be applied later on the same carrier to release response visibility.
|
|
194
|
-
- `ownerDeny(...)` marks the currently pending action rejected.
|
|
195
|
-
- `ownerOnCapabilityState(...)` supports push-style owner interfaces.
|
|
196
|
-
|
|
197
|
-
The proactive request flow does not replace dispatch discovery. Both flows now produce the same carrier shape with independent write/read action states.
|
|
198
|
-
|
|
199
|
-
## Storage Layout
|
|
200
|
-
|
|
201
|
-
The vault uses a unified encrypted partition:
|
|
202
|
-
- `vaults/<vaultId>_v1/profile.sealed`: Unified vault profile.
|
|
203
|
-
- `vaults/<vaultId>_v1/secrets.sealed`: Secret registry.
|
|
204
|
-
- `vaults/<vaultId>_v1/agents.sealed`: Agent identity registry.
|
|
205
|
-
- `vaults/<vaultId>_v1/capabilities.sealed`: Capability registry.
|
|
206
|
-
- `vaults/<vaultId>_v1/requests.sealed`: Sealed request-record registry.
|
|
207
|
-
- `vaults/<vaultId>_v1/custom-flows.sealed`: Owner-defined HTTP request template registry.
|
|
208
|
-
- `vaults/<vaultId>_v1/audit.jsonl`: Tamper-evident audit log.
|
|
209
|
-
- `vaults/<vaultId>_v1/working-key.sealed`: Sealed working-key custody blob.
|
|
210
|
-
- `vaults/<vaultId>_v1/secret-<secretId>.sealed`: Encrypted secret material.
|
|
13
|
+
- `createOwnerClient(...)` - Create an administrative client (Owner).
|
|
14
|
+
- `createAgentClient(...)` - Create an agent client (Consumer).
|
|
15
|
+
|
|
16
|
+
## Identity and Access Control
|
|
17
|
+
|
|
18
|
+
### 1. Agent Identities
|
|
19
|
+
- `ownerCreateAgent(...)`: Provision a new agent identity and return a session token.
|
|
20
|
+
- `ownerListAgents()`: Enumerate all registered agents.
|
|
21
|
+
|
|
22
|
+
### 2. Grant Management (Access Control)
|
|
23
|
+
The system uses a domain-level white-list model:
|
|
24
|
+
- `ownerGrantAgentSecret(...)`: Authorize an agent to use a specific secret alias.
|
|
25
|
+
- `ownerGrantSecretDestination(...)`: Authorize a secret alias for a specific domain.
|
|
26
|
+
- `ownerRevokeAgentSecret(...)`: Remove agent-secret authorization.
|
|
27
|
+
- `ownerRevokeSecretDestination(...)`: Remove secret-domain authorization.
|
|
28
|
+
- `ownerListGrants(...)`: Review all active or pending grants.
|
|
29
|
+
|
|
30
|
+
### 3. Dispatch and Approval (HITL)
|
|
31
|
+
- `agentDispatch(...)`: Attempt a secret-driven HTTP request. Returns `SUCCEEDED` or `PENDING`.
|
|
32
|
+
- `ownerListRequests(...)`: Review blocked (PENDING) or history of dispatches.
|
|
33
|
+
- `ownerApproveDispatch(...)`: Resolve a pending request.
|
|
34
|
+
- `allow_once`: Execute once, no permanent change.
|
|
35
|
+
- `allow_and_grant`: Execute and automatically provision permanent grants.
|
|
36
|
+
- `deny`: Reject the request.
|
|
37
|
+
|
|
38
|
+
## Storage and Lifecycle
|
|
39
|
+
|
|
40
|
+
### Deployment Models
|
|
41
|
+
1. **Managed**: The runtime handles private keys internally.
|
|
42
|
+
2. **Session-based**: Agents use short-lived `sat_...` tokens issued by the owner.
|
|
43
|
+
|
|
44
|
+
### Storage Layout
|
|
45
|
+
- `profile.sealed`: Vault metadata.
|
|
46
|
+
- `secrets/`: Secret records.
|
|
47
|
+
- `custody/`: Secret plaintext.
|
|
48
|
+
- `agents/`: Agent records.
|
|
49
|
+
- `grants/agent_secrets/`: Agent-Secret white-list.
|
|
50
|
+
- `grants/secret_destinations/`: Secret-Domain white-list.
|
|
51
|
+
- `requests/`: Dispatch history and pending queue.
|
|
52
|
+
- `audit/`: Append-only audit trail.
|
|
211
53
|
|
|
212
54
|
## Build & Integration
|
|
213
55
|
|
package/docs/api/README.md
CHANGED
|
@@ -1,11 +1,14 @@
|
|
|
1
|
-
**CBIO Node Runtime Agent API v1.63.
|
|
1
|
+
**CBIO Node Runtime Agent API v1.63.5**
|
|
2
2
|
|
|
3
3
|
***
|
|
4
4
|
|
|
5
|
-
# CBIO Node Runtime Agent API v1.63.
|
|
5
|
+
# CBIO Node Runtime Agent API v1.63.5
|
|
6
6
|
|
|
7
7
|
## Enumerations
|
|
8
8
|
|
|
9
|
+
- [AuditAction](enumerations/AuditAction.md)
|
|
10
|
+
- [AuditOutcome](enumerations/AuditOutcome.md)
|
|
11
|
+
- [DispatchStatus](enumerations/DispatchStatus.md)
|
|
9
12
|
- [IdentityErrorCode](enumerations/IdentityErrorCode.md)
|
|
10
13
|
- [OwnerClientErrorCode](enumerations/OwnerClientErrorCode.md)
|
|
11
14
|
|
|
@@ -13,6 +16,13 @@
|
|
|
13
16
|
|
|
14
17
|
- [IdentityError](classes/IdentityError.md)
|
|
15
18
|
- [OwnerClientError](classes/OwnerClientError.md)
|
|
19
|
+
- [PersistentVaultAgentIdentityRegistry](classes/PersistentVaultAgentIdentityRegistry.md)
|
|
20
|
+
- [PersistentVaultAgentSecretGrantRegistry](classes/PersistentVaultAgentSecretGrantRegistry.md)
|
|
21
|
+
- [PersistentVaultAuditLog](classes/PersistentVaultAuditLog.md)
|
|
22
|
+
- [PersistentVaultCustomHttpFlowRegistry](classes/PersistentVaultCustomHttpFlowRegistry.md)
|
|
23
|
+
- [PersistentVaultSecretCustody](classes/PersistentVaultSecretCustody.md)
|
|
24
|
+
- [PersistentVaultSecretDestinationGrantRegistry](classes/PersistentVaultSecretDestinationGrantRegistry.md)
|
|
25
|
+
- [PersistentVaultSecretRepository](classes/PersistentVaultSecretRepository.md)
|
|
16
26
|
- [VaultCore](classes/VaultCore.md)
|
|
17
27
|
- [VaultCoreError](classes/VaultCoreError.md)
|
|
18
28
|
|
|
@@ -22,64 +32,86 @@
|
|
|
22
32
|
- [AgentDispatchIntent](interfaces/AgentDispatchIntent.md)
|
|
23
33
|
- [AgentDispatchTransport](interfaces/AgentDispatchTransport.md)
|
|
24
34
|
- [AgentIdentity](interfaces/AgentIdentity.md)
|
|
35
|
+
- [AgentIdentityRecord](interfaces/AgentIdentityRecord.md)
|
|
36
|
+
- [AgentRequestResult](interfaces/AgentRequestResult.md)
|
|
37
|
+
- [AgentRuntimeManifest](interfaces/AgentRuntimeManifest.md)
|
|
38
|
+
- [AgentSecretGrant](interfaces/AgentSecretGrant.md)
|
|
25
39
|
- [AgentSigner](interfaces/AgentSigner.md)
|
|
26
|
-
- [
|
|
40
|
+
- [AgentVisibleRequestRecord](interfaces/AgentVisibleRequestRecord.md)
|
|
41
|
+
- [AgentVisibleSecretRecord](interfaces/AgentVisibleSecretRecord.md)
|
|
42
|
+
- [AuditEntry](interfaces/AuditEntry.md)
|
|
27
43
|
- [CbioRuntime](interfaces/CbioRuntime.md)
|
|
28
44
|
- [CreateAgentClientOptions](interfaces/CreateAgentClientOptions.md)
|
|
29
45
|
- [CreatedVault](interfaces/CreatedVault.md)
|
|
30
46
|
- [CreateIdentityOptions](interfaces/CreateIdentityOptions.md)
|
|
47
|
+
- [CreateOwnerClientOptions](interfaces/CreateOwnerClientOptions.md)
|
|
31
48
|
- [CreateOwnerSessionOptions](interfaces/CreateOwnerSessionOptions.md)
|
|
32
49
|
- [CreatePersistentVaultCoreDependenciesOptions](interfaces/CreatePersistentVaultCoreDependenciesOptions.md)
|
|
33
|
-
- [CreateVaultClientOptions](interfaces/CreateVaultClientOptions.md)
|
|
34
50
|
- [CreateVaultOptions](interfaces/CreateVaultOptions.md)
|
|
51
|
+
- [CustomHttpFlowDefinition](interfaces/CustomHttpFlowDefinition.md)
|
|
35
52
|
- [DefaultPolicyEngineOptions](interfaces/DefaultPolicyEngineOptions.md)
|
|
53
|
+
- [DispatchAuthorization](interfaces/DispatchAuthorization.md)
|
|
54
|
+
- [DispatchInstruction](interfaces/DispatchInstruction.md)
|
|
55
|
+
- [DispatchRequest](interfaces/DispatchRequest.md)
|
|
56
|
+
- [DispatchResult](interfaces/DispatchResult.md)
|
|
36
57
|
- [InitializedVaultCustody](interfaces/InitializedVaultCustody.md)
|
|
37
58
|
- [InitializeVaultCustodyOptions](interfaces/InitializeVaultCustodyOptions.md)
|
|
38
59
|
- [IStorageProvider](interfaces/IStorageProvider.md)
|
|
39
60
|
- [OwnerAgentProvisionResult](interfaces/OwnerAgentProvisionResult.md)
|
|
61
|
+
- [OwnerClient](interfaces/OwnerClient.md)
|
|
40
62
|
- [OwnerCreateSecretInput](interfaces/OwnerCreateSecretInput.md)
|
|
41
63
|
- [OwnerRemoveSecretInput](interfaces/OwnerRemoveSecretInput.md)
|
|
64
|
+
- [OwnerRequestRecord](interfaces/OwnerRequestRecord.md)
|
|
42
65
|
- [OwnerSensitiveActionConfirmation](interfaces/OwnerSensitiveActionConfirmation.md)
|
|
43
66
|
- [OwnerSensitiveActionContext](interfaces/OwnerSensitiveActionContext.md)
|
|
44
67
|
- [OwnerSession](interfaces/OwnerSession.md)
|
|
45
68
|
- [OwnerUpdateSecretInput](interfaces/OwnerUpdateSecretInput.md)
|
|
69
|
+
- [OwnerVisibleRequestRecord](interfaces/OwnerVisibleRequestRecord.md)
|
|
46
70
|
- [RecoveredVault](interfaces/RecoveredVault.md)
|
|
47
71
|
- [RecoverVaultOptions](interfaces/RecoverVaultOptions.md)
|
|
72
|
+
- [RequestRecord](interfaces/RequestRecord.md)
|
|
48
73
|
- [RestoreIdentityOptions](interfaces/RestoreIdentityOptions.md)
|
|
74
|
+
- [SecretAlias](interfaces/SecretAlias.md)
|
|
75
|
+
- [SecretDestinationGrant](interfaces/SecretDestinationGrant.md)
|
|
76
|
+
- [SecretId](interfaces/SecretId.md)
|
|
77
|
+
- [SecretRecord](interfaces/SecretRecord.md)
|
|
49
78
|
- [Signer](interfaces/Signer.md)
|
|
50
|
-
- [VaultApproveCapabilityRequestInput](interfaces/VaultApproveCapabilityRequestInput.md)
|
|
51
79
|
- [VaultApproveDispatchInput](interfaces/VaultApproveDispatchInput.md)
|
|
52
80
|
- [VaultAuditQueryInput](interfaces/VaultAuditQueryInput.md)
|
|
53
|
-
- [VaultClient](interfaces/VaultClient.md)
|
|
54
81
|
- [VaultCoreDependenciesOptions](interfaces/VaultCoreDependenciesOptions.md)
|
|
55
82
|
- [VaultCreateAgentInput](interfaces/VaultCreateAgentInput.md)
|
|
56
83
|
- [VaultExportSecretInput](interfaces/VaultExportSecretInput.md)
|
|
57
|
-
- [
|
|
58
|
-
- [
|
|
59
|
-
- [
|
|
84
|
+
- [VaultGetRequestInput](interfaces/VaultGetRequestInput.md)
|
|
85
|
+
- [VaultGrantAgentSecretInput](interfaces/VaultGrantAgentSecretInput.md)
|
|
86
|
+
- [VaultGrantSecretDestinationInput](interfaces/VaultGrantSecretDestinationInput.md)
|
|
87
|
+
- [VaultId](interfaces/VaultId.md)
|
|
60
88
|
- [VaultImportAgentInput](interfaces/VaultImportAgentInput.md)
|
|
61
89
|
- [VaultIssueSessionTokenInput](interfaces/VaultIssueSessionTokenInput.md)
|
|
62
90
|
- [VaultListAgentsInput](interfaces/VaultListAgentsInput.md)
|
|
63
|
-
- [
|
|
91
|
+
- [VaultListGrantsInput](interfaces/VaultListGrantsInput.md)
|
|
92
|
+
- [VaultListRequestsInput](interfaces/VaultListRequestsInput.md)
|
|
64
93
|
- [VaultListSecretsInput](interfaces/VaultListSecretsInput.md)
|
|
65
94
|
- [VaultMetadata](interfaces/VaultMetadata.md)
|
|
66
95
|
- [VaultObject](interfaces/VaultObject.md)
|
|
96
|
+
- [VaultPrincipal](interfaces/VaultPrincipal.md)
|
|
67
97
|
- [VaultProfile](interfaces/VaultProfile.md)
|
|
68
98
|
- [VaultReadAgentPrivateKeyInput](interfaces/VaultReadAgentPrivateKeyInput.md)
|
|
69
99
|
- [VaultReadSecretPlaintextInput](interfaces/VaultReadSecretPlaintextInput.md)
|
|
70
100
|
- [VaultRegisterFlowInput](interfaces/VaultRegisterFlowInput.md)
|
|
71
|
-
- [
|
|
101
|
+
- [VaultRevokeAgentSecretInput](interfaces/VaultRevokeAgentSecretInput.md)
|
|
102
|
+
- [VaultRevokeSecretDestinationInput](interfaces/VaultRevokeSecretDestinationInput.md)
|
|
72
103
|
- [VaultRevokeSessionTokenInput](interfaces/VaultRevokeSessionTokenInput.md)
|
|
73
|
-
- [
|
|
74
|
-
- [VaultSubmitCapabilityRequestInput](interfaces/VaultSubmitCapabilityRequestInput.md)
|
|
104
|
+
- [VaultService](interfaces/VaultService.md)
|
|
75
105
|
- [VaultUpdateAgentInput](interfaces/VaultUpdateAgentInput.md)
|
|
76
106
|
|
|
77
107
|
## Type Aliases
|
|
78
108
|
|
|
79
|
-
- [
|
|
80
|
-
- [AgentVisibleSecretRecord](type-aliases/AgentVisibleSecretRecord.md)
|
|
109
|
+
- [AgentId](type-aliases/AgentId.md)
|
|
81
110
|
- [CbioRuntimeModule](type-aliases/CbioRuntimeModule.md)
|
|
82
|
-
- [
|
|
111
|
+
- [DispatchApprovalDecision](type-aliases/DispatchApprovalDecision.md)
|
|
112
|
+
- [GrantStatus](type-aliases/GrantStatus.md)
|
|
113
|
+
- [SecretLifecycleStatus](type-aliases/SecretLifecycleStatus.md)
|
|
114
|
+
- [VaultPrincipalKind](type-aliases/VaultPrincipalKind.md)
|
|
83
115
|
|
|
84
116
|
## Variables
|
|
85
117
|
|
|
@@ -89,18 +121,15 @@
|
|
|
89
121
|
|
|
90
122
|
- [createAgentClient](functions/createAgentClient.md)
|
|
91
123
|
- [createIdentity](functions/createIdentity.md)
|
|
92
|
-
- [
|
|
124
|
+
- [createOwnerClient](functions/createOwnerClient.md)
|
|
93
125
|
- [createOwnerSession](functions/createOwnerSession.md)
|
|
94
126
|
- [createPersistentVaultCoreDependencies](functions/createPersistentVaultCoreDependencies.md)
|
|
95
|
-
- [createStandardAcquireBoundary](functions/createStandardAcquireBoundary.md)
|
|
96
|
-
- [createStandardDispatchBoundary](functions/createStandardDispatchBoundary.md)
|
|
97
127
|
- [createVault](functions/createVault.md)
|
|
98
|
-
- [createVaultClient](functions/createVaultClient.md)
|
|
99
128
|
- [createVaultCore](functions/createVaultCore.md)
|
|
100
129
|
- [createVaultCoreDependencies](functions/createVaultCoreDependencies.md)
|
|
101
130
|
- [createVaultService](functions/createVaultService.md)
|
|
102
131
|
- [createWorkspaceStorage](functions/createWorkspaceStorage.md)
|
|
103
|
-
- [
|
|
132
|
+
- [deriveRootAgentId](functions/deriveRootAgentId.md)
|
|
104
133
|
- [deriveVaultWorkingKeyFromPassword](functions/deriveVaultWorkingKeyFromPassword.md)
|
|
105
134
|
- [getDefaultWorkspaceDir](functions/getDefaultWorkspaceDir.md)
|
|
106
135
|
- [handleVaultAgentControlHttp](functions/handleVaultAgentControlHttp.md)
|
|
@@ -112,5 +141,4 @@
|
|
|
112
141
|
- [recoverVaultWorkingKey](functions/recoverVaultWorkingKey.md)
|
|
113
142
|
- [restoreIdentity](functions/restoreIdentity.md)
|
|
114
143
|
- [updateVaultMetadata](functions/updateVaultMetadata.md)
|
|
115
|
-
- [wrapVaultCoreAsVaultService](functions/wrapVaultCoreAsVaultService.md)
|
|
116
144
|
- [writeVaultProfile](functions/writeVaultProfile.md)
|
|
@@ -0,0 +1,89 @@
|
|
|
1
|
+
[**CBIO Node Runtime Agent API v1.63.5**](../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
# Class: PersistentVaultAgentIdentityRegistry
|
|
6
|
+
|
|
7
|
+
## Implements
|
|
8
|
+
|
|
9
|
+
- `AgentIdentityRegistry`
|
|
10
|
+
|
|
11
|
+
## Constructors
|
|
12
|
+
|
|
13
|
+
### Constructor
|
|
14
|
+
|
|
15
|
+
> **new PersistentVaultAgentIdentityRegistry**(`baseDir`): `FileAgentIdentityRegistry`
|
|
16
|
+
|
|
17
|
+
#### Parameters
|
|
18
|
+
|
|
19
|
+
##### baseDir
|
|
20
|
+
|
|
21
|
+
`string`
|
|
22
|
+
|
|
23
|
+
#### Returns
|
|
24
|
+
|
|
25
|
+
`FileAgentIdentityRegistry`
|
|
26
|
+
|
|
27
|
+
## Methods
|
|
28
|
+
|
|
29
|
+
### get()
|
|
30
|
+
|
|
31
|
+
> **get**(`vaultId`, `rootAgentId`): `Promise`\<[`AgentIdentityRecord`](../interfaces/AgentIdentityRecord.md) \| `null`\>
|
|
32
|
+
|
|
33
|
+
#### Parameters
|
|
34
|
+
|
|
35
|
+
##### vaultId
|
|
36
|
+
|
|
37
|
+
[`VaultId`](../interfaces/VaultId.md)
|
|
38
|
+
|
|
39
|
+
##### rootAgentId
|
|
40
|
+
|
|
41
|
+
`string`
|
|
42
|
+
|
|
43
|
+
#### Returns
|
|
44
|
+
|
|
45
|
+
`Promise`\<[`AgentIdentityRecord`](../interfaces/AgentIdentityRecord.md) \| `null`\>
|
|
46
|
+
|
|
47
|
+
#### Implementation of
|
|
48
|
+
|
|
49
|
+
`AgentIdentityRegistry.get`
|
|
50
|
+
|
|
51
|
+
***
|
|
52
|
+
|
|
53
|
+
### list()
|
|
54
|
+
|
|
55
|
+
> **list**(`vaultId`): `Promise`\<readonly [`AgentIdentityRecord`](../interfaces/AgentIdentityRecord.md)[]\>
|
|
56
|
+
|
|
57
|
+
#### Parameters
|
|
58
|
+
|
|
59
|
+
##### vaultId
|
|
60
|
+
|
|
61
|
+
[`VaultId`](../interfaces/VaultId.md)
|
|
62
|
+
|
|
63
|
+
#### Returns
|
|
64
|
+
|
|
65
|
+
`Promise`\<readonly [`AgentIdentityRecord`](../interfaces/AgentIdentityRecord.md)[]\>
|
|
66
|
+
|
|
67
|
+
#### Implementation of
|
|
68
|
+
|
|
69
|
+
`AgentIdentityRegistry.list`
|
|
70
|
+
|
|
71
|
+
***
|
|
72
|
+
|
|
73
|
+
### register()
|
|
74
|
+
|
|
75
|
+
> **register**(`identity`): `Promise`\<`void`\>
|
|
76
|
+
|
|
77
|
+
#### Parameters
|
|
78
|
+
|
|
79
|
+
##### identity
|
|
80
|
+
|
|
81
|
+
[`AgentIdentityRecord`](../interfaces/AgentIdentityRecord.md)
|
|
82
|
+
|
|
83
|
+
#### Returns
|
|
84
|
+
|
|
85
|
+
`Promise`\<`void`\>
|
|
86
|
+
|
|
87
|
+
#### Implementation of
|
|
88
|
+
|
|
89
|
+
`AgentIdentityRegistry.register`
|
|
@@ -0,0 +1,125 @@
|
|
|
1
|
+
[**CBIO Node Runtime Agent API v1.63.5**](../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
# Class: PersistentVaultAgentSecretGrantRegistry
|
|
6
|
+
|
|
7
|
+
## Implements
|
|
8
|
+
|
|
9
|
+
- `AgentSecretGrantRegistry`
|
|
10
|
+
|
|
11
|
+
## Constructors
|
|
12
|
+
|
|
13
|
+
### Constructor
|
|
14
|
+
|
|
15
|
+
> **new PersistentVaultAgentSecretGrantRegistry**(`baseDir`): `FileAgentSecretGrantRegistry`
|
|
16
|
+
|
|
17
|
+
#### Parameters
|
|
18
|
+
|
|
19
|
+
##### baseDir
|
|
20
|
+
|
|
21
|
+
`string`
|
|
22
|
+
|
|
23
|
+
#### Returns
|
|
24
|
+
|
|
25
|
+
`FileAgentSecretGrantRegistry`
|
|
26
|
+
|
|
27
|
+
## Methods
|
|
28
|
+
|
|
29
|
+
### delete()
|
|
30
|
+
|
|
31
|
+
> **delete**(`vaultId`, `rootAgentId`, `secretAlias`): `Promise`\<`void`\>
|
|
32
|
+
|
|
33
|
+
#### Parameters
|
|
34
|
+
|
|
35
|
+
##### vaultId
|
|
36
|
+
|
|
37
|
+
[`VaultId`](../interfaces/VaultId.md)
|
|
38
|
+
|
|
39
|
+
##### rootAgentId
|
|
40
|
+
|
|
41
|
+
`string`
|
|
42
|
+
|
|
43
|
+
##### secretAlias
|
|
44
|
+
|
|
45
|
+
`string`
|
|
46
|
+
|
|
47
|
+
#### Returns
|
|
48
|
+
|
|
49
|
+
`Promise`\<`void`\>
|
|
50
|
+
|
|
51
|
+
#### Implementation of
|
|
52
|
+
|
|
53
|
+
`AgentSecretGrantRegistry.delete`
|
|
54
|
+
|
|
55
|
+
***
|
|
56
|
+
|
|
57
|
+
### get()
|
|
58
|
+
|
|
59
|
+
> **get**(`vaultId`, `rootAgentId`, `secretAlias`): `Promise`\<[`AgentSecretGrant`](../interfaces/AgentSecretGrant.md) \| `null`\>
|
|
60
|
+
|
|
61
|
+
#### Parameters
|
|
62
|
+
|
|
63
|
+
##### vaultId
|
|
64
|
+
|
|
65
|
+
[`VaultId`](../interfaces/VaultId.md)
|
|
66
|
+
|
|
67
|
+
##### rootAgentId
|
|
68
|
+
|
|
69
|
+
`string`
|
|
70
|
+
|
|
71
|
+
##### secretAlias
|
|
72
|
+
|
|
73
|
+
`string`
|
|
74
|
+
|
|
75
|
+
#### Returns
|
|
76
|
+
|
|
77
|
+
`Promise`\<[`AgentSecretGrant`](../interfaces/AgentSecretGrant.md) \| `null`\>
|
|
78
|
+
|
|
79
|
+
#### Implementation of
|
|
80
|
+
|
|
81
|
+
`AgentSecretGrantRegistry.get`
|
|
82
|
+
|
|
83
|
+
***
|
|
84
|
+
|
|
85
|
+
### list()
|
|
86
|
+
|
|
87
|
+
> **list**(`vaultId`, `rootAgentId?`): `Promise`\<readonly [`AgentSecretGrant`](../interfaces/AgentSecretGrant.md)[]\>
|
|
88
|
+
|
|
89
|
+
#### Parameters
|
|
90
|
+
|
|
91
|
+
##### vaultId
|
|
92
|
+
|
|
93
|
+
[`VaultId`](../interfaces/VaultId.md)
|
|
94
|
+
|
|
95
|
+
##### rootAgentId?
|
|
96
|
+
|
|
97
|
+
`string`
|
|
98
|
+
|
|
99
|
+
#### Returns
|
|
100
|
+
|
|
101
|
+
`Promise`\<readonly [`AgentSecretGrant`](../interfaces/AgentSecretGrant.md)[]\>
|
|
102
|
+
|
|
103
|
+
#### Implementation of
|
|
104
|
+
|
|
105
|
+
`AgentSecretGrantRegistry.list`
|
|
106
|
+
|
|
107
|
+
***
|
|
108
|
+
|
|
109
|
+
### upsert()
|
|
110
|
+
|
|
111
|
+
> **upsert**(`grant`): `Promise`\<`void`\>
|
|
112
|
+
|
|
113
|
+
#### Parameters
|
|
114
|
+
|
|
115
|
+
##### grant
|
|
116
|
+
|
|
117
|
+
[`AgentSecretGrant`](../interfaces/AgentSecretGrant.md)
|
|
118
|
+
|
|
119
|
+
#### Returns
|
|
120
|
+
|
|
121
|
+
`Promise`\<`void`\>
|
|
122
|
+
|
|
123
|
+
#### Implementation of
|
|
124
|
+
|
|
125
|
+
`AgentSecretGrantRegistry.upsert`
|