Struct hips::Database

pub struct Database { /* fields omitted */ }

A handle to the underlying secrets database.

Any calls to this object’s methods (load, store..) will result in a similar call on the injected Backend implementation, no caching is being done. Every call will also invoke encryption/decryption logic, which should be considered slow.

Implementations

impl Database

pub fn new(backend: Box<dyn Backend>, encrypter: Box<dyn Encrypter>) -> Self

Instantiate a new Database with injected Backend/Encrypter.

pub fn from_file(path: PathBuf, password: String) -> Result<Self>

Instantiate a new Database from a file.

This function will try to guess which database type is needed, and create the appropriate backend based on that. This is used in the binary, which supports only the Backends and Encrypters shipped with hips.

impl Database

pub fn store(&mut self, secret: Secret) -> Result<()>

Store the provided secret.

pub fn load(&self, name: String) -> Result<Secret>

Load the name secret.

pub fn remove(&mut self, name: String) -> Result<()>

Remove the name secret.

pub fn list(&self) -> Result<Vec<Secret>>

List all secrets.

impl Database

pub fn template(&self, template: String) -> Result<String>

Process the database through a template.

This call will read the provided template and replace all references to secrets with the secrets stored in the database. We use the tinytemplate engine, see their syntax page for more context.