Skip to content

Rulvar API reference


Rulvar API reference / @rulvar/rulvar / EnvelopeEncryptionOptions

Interface: EnvelopeEncryptionOptions

Defined in: packages/core/dist/index.d.ts

Properties

PropertyTypeDescriptionDefined in
historicalWrappedKeys?readonly Bytes[]Wrapped data keys from earlier sessions or rotations that this process must still read. Unwrapped once at creation; an envelope carrying an UNREGISTERED wrapped key fails typed at read, naming this list.packages/core/dist/index.d.ts
plaintextReads?"reject" | "passthrough"What a NON-enveloped stored entry or blob means at read: 'reject' (default, fail closed) or 'passthrough' (explicit migration mode for stores with pre-encryption history).packages/core/dist/index.d.ts
providerDataKeyProvider-packages/core/dist/index.d.ts