Skip to main content

Class: SecretBox

Defined in: packages/agentos/src/io/channels/meetings/signing.ts:137

Seals a run's meeting url at rest under the current 32-byte key, with the library's AES-256-GCM sealing (sealSecret, openSecret). Previous keys open older texts. Every seal uses a fresh nonce and the stored form remains v1.box.<base64url(nonce | ciphertext | tag)>. The run's id is bound as context, so moving a text to another row fails.

Constructors​

Constructor​

new SecretBox(key, options?): SecretBox

Defined in: packages/agentos/src/io/channels/meetings/signing.ts:146

Parameters​

key​

Buffer

The current 32-byte key, copied so later buffer changes cannot change the box.

options?​

Previous 32-byte keys, copied and tried in order on open; never used to seal new text.

previousKeys?​

readonly Buffer[]

Returns​

SecretBox

Throws​

RangeError when any key is not 32 bytes.

Methods​

[custom]()​

[custom](): string

Defined in: packages/agentos/src/io/channels/meetings/signing.ts:161

What util.inspect, and so console.log and loggers built on it, print: the same redacted marker, never key bytes.

Returns​

string

open()​

open(sealed, context?): string

Defined in: packages/agentos/src/io/channels/meetings/signing.ts:180

Opens with the current key, then each previous key in order.

Parameters​

sealed​

string

The sealed text, including an older v1.box text.

context?​

string = ''

The context used to seal; empty when absent.

Returns​

string

Throws​

SealedSecretError when the format, key, context or authentication fails for every candidate.

seal()​

seal(plain, context?): string

Defined in: packages/agentos/src/io/channels/meetings/signing.ts:170

Seals with the current key and a fresh nonce.

Parameters​

plain​

string

The text to seal.

context?​

string = ''

The run's id, bound as additional authenticated data; empty when absent.

Returns​

string

toJSON()​

toJSON(): string

Defined in: packages/agentos/src/io/channels/meetings/signing.ts:156

Serialises only a redacted marker, never current or previous key bytes.

Returns​

string