Skip to main content

StorageEncryptionConfig

Struct StorageEncryptionConfig 

Source
pub struct StorageEncryptionConfig {
    pub enabled: bool,
    pub allow_plaintext_reads: bool,
    pub allow_legacy_v0: bool,
    pub require_wrapped_storage: bool,
}
Expand description

Controls whether values written through the generic key-value storage layer (crate::storage::AuthStorage::store_kv/get_kv) are encrypted at rest.

Enabled by default per board decision 124: operators who truly need to opt out (e.g. a storage backend that already encrypts at the disk/volume level) can set enabled: false explicitly, but the framework never silently stores new data unencrypted.

Scope: this only covers the KV layer (API keys, TOTP secrets, OAuth2 client registries, MFA codes, and most other KV-backed subsystems – see docs/STORAGE-AUDIT.md). Core token and session storage go through each backend’s own typed columns, not store_kv, and are not covered by this flag; see crate::storage::encryption::EncryptedStorage’s own “Coverage note” for why, and the roadmap for the planned follow-up.

The key itself comes from crate::storage::encryption::EnvKeyProvider (AUTH_STORAGE_ENCRYPTION_KEY/AUTH_STORAGE_ENCRYPTION_KEYS_FILE) – an env/file key source, per board decision 124, with the limitation that implies documented in docs/storage-backends.md. A KMS-backed provider can replace it later without changing this config shape.

Fields§

§enabled: bool

Whether to encrypt KV-layer storage at rest. Defaults to true – if no encryption key can be loaded while this is true, framework initialization fails rather than silently storing data in plaintext.

§allow_plaintext_reads: bool

Whether a KV value that isn’t a valid encrypted envelope is read back as plaintext (true) or rejected as an error (false, default).

Set this to true only transiently, while migrating an existing deployment’s plaintext data to encrypted (see storage::encryption::migrate_kv_to_encrypted and the security encrypt-kv CLI command). Leaving it true permanently means anyone who can write to the backing store can overwrite an encrypted value with chosen plaintext (or corrupt one) and have it accepted silently forever, which defeats the point of encrypting at rest. Set it back to false once migration is complete.

§allow_legacy_v0: bool

Whether a format-version-0 envelope (the original, pre-redesign EncryptedStorage’s shape: no key_id, no AAD at encryption time), or a format-version-1 envelope (AAD is the bare storage key, so the envelope’s own metadata is not authenticated), is decrypted (true) or rejected as an error (false, default). The name is historical: it covers every format older than the current (v2) one.

Format-version-0 envelopes have no AAD binding a ciphertext to its own storage key, which is exactly the protection the current format’s AAD exists to provide: with this true, a writer who knows one record’s v0 envelope can copy it onto a different record’s key and it will still decrypt, because v0 decryption tries every loaded key with an empty AAD regardless of which record it’s stored under. This flag only controls whether EncryptedStorage::get_kv reads a v0 envelope at all – it is independent of storage::encryption::migrate_kv_to_encrypted’s own accept_legacy_v0 parameter, which separately gates whether migration actually rewrites one. Set this to true only if something needs to read v0 data through this wrapper before, or without ever, running migration; leave it false otherwise.

§require_wrapped_storage: bool

Refuse to start (true) instead of only warning (false, default) when enabled is true but the storage handed to AuthFramework::new_with_storage / replace_storage / the builder’s custom_storage is not an EncryptedStorage. Storage supplied that way bypasses the factory’s automatic wrapping, so without this a deployment can believe KV values are encrypted at rest when they are not.

Trait Implementations§

Source§

impl Clone for StorageEncryptionConfig

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for StorageEncryptionConfig

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for StorageEncryptionConfig

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for StorageEncryptionConfig

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for StorageEncryptionConfig

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

Source§

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

Source§

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

Source§

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FromRef<T> for T
where T: Clone,

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more