Skip to main content

FileKeyringStore

Struct FileKeyringStore 

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

JSON-on-disk secret store for headless environments.

This is the default backend. Secrets are serialised as a JSON object at <home>/.codewhale/secrets/secrets.json with Unix file mode 0600 (owner read/write only). The parent directory is created with mode 0700 if it does not exist.

On Unix, the store rejects files whose permissions are more permissive than 0600 (i.e. group or world bits are set). This prevents other users on the system from reading stored credentials. On Windows, the ACL model is too different to enforce programmatically; callers are responsible for placing the file in a per-user directory.

Implementations§

Source§

impl FileKeyringStore

Source

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

Build a store backed by the given JSON file path.

Source

pub fn default_path() -> Result<PathBuf, SecretsError>

Default path: <home>/.codewhale/secrets/secrets.json. Honours CODEWHALE_HOME, then HOME, USERPROFILE, and finally the platform home directory from the dirs crate. On first use, non-conflicting entries from the legacy <home>/.deepseek/secrets/secrets.json file are copied into the CodeWhale store.

Source

pub fn path(&self) -> &Path

Path used for storage.

Trait Implementations§

Source§

impl Clone for FileKeyringStore

Source§

fn clone(&self) -> FileKeyringStore

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 FileKeyringStore

Source§

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

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

impl KeyringStore for FileKeyringStore

Source§

fn get(&self, key: &str) -> Result<Option<String>, SecretsError>

Read a secret by key. Read more
Source§

fn set(&self, key: &str, value: &str) -> Result<(), SecretsError>

Write a secret, replacing any existing value for the same key. Read more
Source§

fn delete(&self, key: &str) -> Result<(), SecretsError>

Remove a secret by key. Read more
Source§

fn backend_name(&self) -> &'static str

Short, human-readable label for this backend. 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> 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 = 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