Skip to main content

FileFetch

Struct FileFetch 

Source
pub struct FileFetch { /* private fields */ }
Available on crate feature fetcher-file only.
Expand description

KeyFetch implementation that reads bytes from a file on disk.

By default Unix permission bits stricter than 0o600 are rejected; call FileFetch::allow_loose_perms to disable that check (not recommended outside of tests).

§Examples

use key_vault::{FetchContext, FileFetch, KeyFetch};

// Assume /etc/myapp/key.bin is mode 0600 and contains 32 bytes.
let fetcher = FileFetch::new("/etc/myapp/key.bin");
let raw = fetcher.fetch(&FetchContext::new("primary"))?;
assert_eq!(raw.len(), 32);

Implementations§

Source§

impl FileFetch

Source

pub fn new(path: impl Into<PathBuf>) -> Self

Construct a fetcher that reads the file at path. Strict Unix permission checking is enabled by default.

Source

pub fn allow_loose_perms(self) -> Self

Disable strict Unix permission checking.

Useful for test fixtures and containers where the user controlling the file is the same as the process user but the file may have been created with 0o644. Do not disable strict perms in production deployments where multiple users share the host.

Source

pub fn path(&self) -> &Path

Path the fetcher reads from. Used in audit / diagnostic output.

Trait Implementations§

Source§

impl Clone for FileFetch

Source§

fn clone(&self) -> FileFetch

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 FileFetch

Source§

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

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

impl KeyFetch for FileFetch

Source§

fn fetch(&self, _ctx: &FetchContext) -> Result<RawKey>

Acquire raw key material from the underlying source. Read more
Source§

fn describe(&self) -> Cow<'_, str>

Short, machine-friendly identifier for this fetcher (e.g. "keychain", "file", "env"). Used for audit records and error attribution. 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> 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> 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> 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 = 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<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