Struct AuthyClient 

pub struct AuthyClient { /* private fields */ }

High-level client for programmatic vault access.

Each operation loads the vault, performs the mutation, saves it back, and appends an audit entry — mirroring the CLI handler pattern.

Implementations

impl AuthyClient

pub fn with_passphrase(passphrase: &str) -> Result<Self>

Authenticate with a passphrase.

pub fn with_keyfile(keyfile_path: &str) -> Result<Self>

Authenticate with an age keyfile on disk.

pub fn from_env() -> Result<Self>

Authenticate from environment variables (AUTHY_KEYFILE or AUTHY_PASSPHRASE).

This does not fall through to interactive prompts — it only reads env vars.

pub fn with_actor(self, actor: impl Into<String>) -> Self

Override the actor label used in audit entries.

pub fn is_initialized() -> bool

Check whether the vault has been initialized.

pub fn get(&self, name: &str) -> Result<Option<String>>

Retrieve a secret by name. Returns None if not found.

pub fn get_or_err(&self, name: &str) -> Result<String>

Retrieve a secret by name, returning an error if it does not exist.

pub fn store(&self, name: &str, value: &str, force: bool) -> Result<()>

Store a secret. If force is false and the secret already exists, returns AuthyError::SecretAlreadyExists.

pub fn remove(&self, name: &str) -> Result<bool>

Remove a secret. Returns true if the secret existed.

pub fn rotate(&self, name: &str, new_value: &str) -> Result<u32>

Rotate a secret to a new value. Returns the new version number. The secret must already exist.

pub fn list(&self, scope: Option<&str>) -> Result<Vec<String>>

List secret names, optionally filtered by a policy scope.

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

Initialize a new vault. The vault must not already exist.

pub fn audit_entries(&self) -> Result<Vec<AuditEntry>>

Read all audit entries from the log.

pub fn verify_audit_chain(&self) -> Result<(usize, bool)>

Verify the integrity of the audit chain. Returns (entry_count, valid).

pub fn test_policy(&self, scope: &str, secret_name: &str) -> Result<bool>

Test whether a policy allows access to a secret. Returns true if allowed, false if denied.

pub fn create_policy( &self, name: &str, allow: Vec<String>, deny: Vec<String>, description: Option<&str>, run_only: bool, ) -> Result<()>

Create a new policy in the vault.