Struct Psh 

pub struct Psh { /* private fields */ }

psh interface

Implementations

impl Psh

pub fn new( master_password: ZeroizingString, db: impl PshStore + 'static, ) -> Result<Self>

Initializes password generator/manager fetching all known (previously used) aliases from psh database.

pub fn derive_password( &self, alias: &ZeroizingString, secret: Option<ZeroizingString>, charset: Option<CharSet>, ) -> ZeroizingString

Derives password.

If charset is None - uses Standard charset.

Panics

Panics if alias is an empty string.
Panics if alias is longer than ALIAS_MAX_BYTES.
Panics if alias is known and expects secret but None or empty string is given.
Panics if alias is known and wrong charset is given.

Examples

use psh::{Psh, ZeroizingString, store::PshMemDb};

let psh = Psh::new(
        ZeroizingString::new("password".to_string()),
        PshMemDb::new(),
    ).expect("Error initializing Psh");
let alias = ZeroizingString::new("alias".to_string());
let secret = ZeroizingString::new("secret".to_string());
let password = psh.derive_password(&alias, Some(secret), None);

assert_eq!(password.as_str(), "MBF>VgO/UsR-OeQU");

pub fn aliases(&self) -> Vec<&ZeroizingString>

Returns a sorted list of previously used aliases (those recorded in psh database).

pub fn alias_is_known(&self, alias: &ZeroizingString) -> bool

Checks if alias has been previously used (exists in psh database).

pub fn alias_uses_secret(&self, alias: &ZeroizingString) -> bool

Checks if alias that has been previously used requires a secret.

Panics

Panics if alias is not present in psh database.

pub fn get_charset(&self, alias: &ZeroizingString) -> CharSet

Returns a charset for an alias that has been previously used.

Panics

Panics if alias is not present in psh database.

pub fn append_alias_to_db( &mut self, alias: &ZeroizingString, use_secret: Option<bool>, charset: Option<CharSet>, ) -> Result<()>

Saves alias to psh database.

If use_secret is None - does not use secret.
If charset is None - uses Standard charset.

pub fn remove_alias_from_db(&mut self, alias: &ZeroizingString) -> Result<()>

Removes alias from psh database.