Skip to main content

ConfigEncryptor

Struct ConfigEncryptor 

Source
pub struct ConfigEncryptor { /* private fields */ }
Expand description

AES-GCM encrypted config store backed by the system keyring.

Uses PBKDF2-HMAC-SHA256 for key derivation from a machine-specific hostname:username material, and AES-256-GCM for authenticated encryption.

Wire format for AES-encrypted values: enc:<base64(nonce[12] || tag[16] || ciphertext)>

Keyring-stored values are referenced as: keyring:<key>

Implementations§

Source§

impl ConfigEncryptor

Source

pub fn new() -> Result<Self, ConfigDecryptionError>

Create a new ConfigEncryptor using the OS keyring when available.

Source

pub fn new_forced_aes() -> Self

Create a ConfigEncryptor that always uses AES encryption, bypassing the OS keyring. Intended for use in tests running in headless/CI environments.

Source

pub fn store( &self, key: &str, value: &str, ) -> Result<String, ConfigDecryptionError>

Persist value for key.

Tries the OS keyring first. On failure (headless / CI) falls back to AES-256-GCM file encryption.

Returns a config-file token:

  • "keyring:<key>" when stored in the OS keyring.
  • "enc:<base64>" when stored as an encrypted blob.
§Security note

The enc: fallback path derives its encryption key from the machine’s hostname and the current username. This protects against casual file browsing but not against targeted attacks by co-tenants on shared systems who know both values. For sensitive credentials (API keys, tokens), prefer the keyring: path (OS keyring) when available, or use environment variables instead of config file storage.

Source

pub fn retrieve( &self, config_value: &str, key: &str, ) -> Result<String, ConfigDecryptionError>

Retrieve the plaintext for a config value token.

Handles three formats:

  • "keyring:<ref>" — fetch from OS keyring.
  • "enc:<base64>" — base64-decode then AES-GCM decrypt.
  • anything else — return as-is (plain passthrough).

Trait Implementations§

Source§

impl Default for ConfigEncryptor

Source§

fn default() -> ConfigEncryptor

Returns the “default value” for a type. 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<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<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> NoneValue for T
where T: Default,

Source§

type NoneType = T

Source§

fn null_value() -> T

The none-equivalent value.
Source§

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

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: 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: 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> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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