Graphorin API reference v0.1.0

---

Graphorin API reference / @graphorin/security / / KeyringSecretsStore

Class: KeyringSecretsStore

Defined in: packages/security/src/secrets/stores/keyring.ts:35

SecretsStore backed by @napi-rs/keyring.

Stable

Implements

• SecretsStore

Constructors

Constructor

new KeyringSecretsStore(opts?): KeyringSecretsStore;

Defined in: packages/security/src/secrets/stores/keyring.ts:39

Parameters

Parameter	Type
opts	KeyringSecretsStoreOptions

Returns

KeyringSecretsStore

Properties

Property	Modifier	Type	Defined in
kind	readonly	"keyring"	packages/security/src/secrets/stores/keyring.ts:36

Methods

delete()

delete(key, _scope?): Promise<void>;

Defined in: packages/security/src/secrets/stores/keyring.ts:91

Parameters

Parameter	Type
key	string
_scope?	SessionScope

Returns

Promise<void>

Implementation of

SecretsStore.delete

---

get()

get(key, _scope?): Promise<SecretValue | null>;

Defined in: packages/security/src/secrets/stores/keyring.ts:44

Returns the secret if it exists, null otherwise.

Parameters

Parameter	Type
key	string
_scope?	SessionScope

Returns

Promise<SecretValue | null>

Implementation of

SecretsStore.get

---

list()

list(_scope?): Promise<readonly SecretMetadata[]>;

Defined in: packages/security/src/secrets/stores/keyring.ts:100

Returns metadata about every key — never the values themselves.

Parameters

Parameter	Type
_scope?	SessionScope

Returns

Promise<readonly SecretMetadata[]>

Implementation of

SecretsStore.list

---

require()

require(key, _scope?): Promise<SecretValue>;

Defined in: packages/security/src/secrets/stores/keyring.ts:63

Returns the secret or throws. Implementations enforce the per-tool secretsAllowed ACL: if the current tool context disallows key, throw SecretAccessDeniedError.

Parameters

Parameter	Type
key	string
_scope?	SessionScope

Returns

Promise<SecretValue>

Implementation of

SecretsStore.require

---

set()

set(
   key, 
   value, 
_opts?): Promise<void>;

Defined in: packages/security/src/secrets/stores/keyring.ts:77

Persist a secret. Implementations auto-wrap a plain string into a SecretValue so callers don't have to.

Parameters

Parameter	Type
key	string
value	| string | SecretValue
_opts?	SecretsSetOptions

Returns

Promise<void>

Implementation of

SecretsStore.set