Struct AnsibleVault

pub struct AnsibleVault { /* private fields */ }

Ansible Vault encryption and decryption utility.

The AnsibleVault struct provides a comprehensive interface for managing encrypted files and strings using Ansible Vault. It supports all major vault operations including encryption, decryption, viewing, editing, and rekeying.

Examples

Basic File Operations

use ansible::AnsibleVault;

let mut vault = AnsibleVault::new();
vault.set_vault_password_file("vault_pass.txt");

// Encrypt a file
vault.encrypt("secrets.yml")?;

// Decrypt a file
vault.decrypt("secrets.yml")?;

// View encrypted content
let content = vault.view("secrets.yml")?;
println!("Content: {}", content);

String Encryption

use ansible::AnsibleVault;

let mut vault = AnsibleVault::new();
vault.set_vault_password_file("vault_pass.txt");

// Encrypt a string
let encrypted = vault.encrypt_string("my_secret_password")?;
println!("Encrypted: {}", encrypted);

Multiple Vault IDs

use ansible::AnsibleVault;

let mut vault = AnsibleVault::new();
vault.set_vault_id("prod@vault_pass.txt");

// Operations will use the specified vault ID
vault.encrypt("production_secrets.yml")?;

Rekeying Files

use ansible::AnsibleVault;

let mut vault = AnsibleVault::new();
vault
    .set_vault_password_file("old_pass.txt")
    .set_new_vault_password_file("new_pass.txt");

// Change the encryption key
vault.rekey("secrets.yml")?;

Implementations

impl AnsibleVault

pub fn new() -> Self

Create a new AnsibleVault instance

pub fn set_vault_id(&mut self, vault_id: impl Into<String>) -> &mut Self

Set vault ID for encryption/decryption

pub fn set_vault_password_file( &mut self, file_path: impl Into<String>, ) -> &mut Self

Set vault password file

pub fn set_new_vault_password_file( &mut self, file_path: impl Into<String>, ) -> &mut Self

Set new vault password file for rekeying operations

pub fn arg(&mut self, arg: impl Into<String>) -> &mut Self

Add a custom argument

pub fn args<I, S>(&mut self, args: I) -> &mut Self

where I: IntoIterator<Item = S>, S: Into<String>,

Add multiple arguments

pub fn set_system_envs(&mut self) -> &mut Self

Set environment variables from the system

pub fn add_env( &mut self, key: impl Into<String>, value: impl Into<String>, ) -> &mut Self

Add an environment variable

pub fn create(&self, file_path: impl Into<String>) -> Result<String>

Create and encrypt a new file

pub fn encrypt(&self, file_path: impl Into<String>) -> Result<String>

Encrypt an existing file

pub fn decrypt(&self, file_path: impl Into<String>) -> Result<String>

Decrypt a file

pub fn view(&self, file_path: impl Into<String>) -> Result<String>

Decrypt and view a file without modifying it

pub fn edit(&self, file_path: impl Into<String>) -> Result<String>

Edit an encrypted file

pub fn rekey(&self, file_path: impl Into<String>) -> Result<String>

Re-encrypt a file with a new password

pub fn encrypt_string( &self, string_to_encrypt: impl Into<String>, ) -> Result<String>

Encrypt a string and output it in a format suitable for inclusion in YAML

pub fn encrypt_string_with_name( &self, string_to_encrypt: impl Into<String>, var_name: impl Into<String>, ) -> Result<String>

Encrypt a string with a variable name

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

Encrypt a string and prompt for input

pub fn encrypt_string_stdin( &self, stdin_name: impl Into<String>, ) -> Result<String>

Encrypt a string with stdin input

pub fn decrypt_to_file( &self, input_file: impl Into<String>, output_file: impl Into<String>, ) -> Result<String>

Decrypt a file to a specific output location

pub fn encrypt_to_file( &self, input_file: impl Into<String>, output_file: impl Into<String>, ) -> Result<String>

Encrypt a file to a specific output location

pub fn set_encrypt_vault_id(&mut self, vault_id: impl Into<String>) -> &mut Self

Set the vault ID used for encryption (when multiple vault IDs are available)

pub fn ask_vault_password(&mut self) -> &mut Self

Ask for vault password interactively

pub fn verbose(&mut self) -> &mut Self

Enable verbose output

pub fn verbosity(&mut self, level: u8) -> &mut Self

Set multiple levels of verbosity

pub fn get_config(&self) -> &CommandConfig

Get a reference to the command configuration (for testing)

Trait Implementations

impl Clone for AnsibleVault

fn clone(&self) -> AnsibleVault

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AnsibleVault

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

Formats the value using the given formatter.

impl Default for AnsibleVault

fn default() -> Self

Returns the “default value” for a type.

impl Display for AnsibleVault

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

Formats the value using the given formatter.