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: boolWhether 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: boolWhether 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: boolWhether 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: boolRefuse 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
impl Clone for StorageEncryptionConfig
Source§impl Debug for StorageEncryptionConfig
impl Debug for StorageEncryptionConfig
Source§impl Default for StorageEncryptionConfig
impl Default for StorageEncryptionConfig
Source§impl<'de> Deserialize<'de> for StorageEncryptionConfigwhere
StorageEncryptionConfig: Default,
impl<'de> Deserialize<'de> for StorageEncryptionConfigwhere
StorageEncryptionConfig: Default,
Source§fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
Auto Trait Implementations§
impl Freeze for StorageEncryptionConfig
impl RefUnwindSafe for StorageEncryptionConfig
impl Send for StorageEncryptionConfig
impl Sync for StorageEncryptionConfig
impl Unpin for StorageEncryptionConfig
impl UnsafeUnpin for StorageEncryptionConfig
impl UnwindSafe for StorageEncryptionConfig
Blanket Implementations§
Source§impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
Source§impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,
impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> DeserializeOwned for Twhere
T: for<'de> Deserialize<'de>,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
Source§fn in_current_span(self) -> Instrumented<Self> ⓘ
fn in_current_span(self) -> Instrumented<Self> ⓘ
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
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