Struct Secret 

pub struct Secret { /* private fields */ }

Credential manager backed by the OS keyring.

Each instance addresses one credential, identified by the account name derived from the legacy file name (.jira_secret becomes jira), and knows how to ask the user for it when the store has nothing.

Implementations

impl Secret

pub fn new(secret_name: &str, prompt: &str) -> Self

Creates a credential handle for the given secret.

Arguments

• secret_name - Legacy file name for the credential (e.g. .jira_secret), which also determines the keyring account name
• prompt - User-facing text shown when asking for the password

Examples

use kasl::libs::secret::Secret;

let jira_secret = Secret::new(".jira_secret", "Enter your Jira password");

pub fn get_or_prompt(&self) -> Result<String>

Retrieves the password from the keyring, prompting when absent.

Order of resolution: keyring, then a legacy AES file (migrated on the spot), then the user. A value obtained from either of the last two is written to the keyring, so this is the only time it is asked for.

Returns

The stored or freshly entered password.

Errors

Returns an error when the keyring is unavailable, or when there is no terminal to prompt at and nothing stored to fall back on.

pub fn try_get_cached(&self) -> Option<String>

Returns a stored password without prompting the user.

Used by the background daemon, which has no terminal and must never block. Migrates a legacy file if one is found, so an unattended run benefits from the migration too.

Returns

Some(password) when the credential is known, None otherwise.

pub fn prompt(&self) -> Result<String>

Prompts for the password and stores it in the keyring.

Errors

Fails when stdin is not a terminal, rather than blocking on input that cannot arrive - this path is reachable from a scheduled report --send.

pub fn store(&self, password: &str) -> Result<()>

Writes the password into the OS keyring.

pub fn delete(&self) -> Result<()>

Removes the credential from the keyring, if present.

Absence is not an error: the goal is that nothing remains afterwards.

Trait Implementations

impl Clone for Secret

fn clone(&self) -> Secret

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Secret

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

Formats the value using the given formatter.