Overview

For preamble to design philosophy of this crate see GitHub project page.

psh is a password generator and a password manager library which produces deterministic passwords for a set of user inputs. It can store previously used aliases and their password derivation settings in encrypted form in its internal database at $HOME/.psh.db.

There is a binary crate psh-cli -- a CLI utility that leverages psh functionality. It can be installed using the following cargo command: sh $ cargo install psh-cli

Below is an example of how to use psh in your code: ```rust use psh::{Psh, ZeroizingString, store::PshMemDb};

let masterpassword = ZeroizingString::new( "thisbetterbeastrongpassword".tostring()); let psh = Psh::new( masterpassword, PshMemDb::new(), ).expect("Error initializing Psh"); let alias = ZeroizingString::new( "mysecretbox".tostring()); let password = psh.derivepassword(&alias, None, None); ```

For greater security it's possible to supply a secret: ```rust

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

#

let master_password = ZeroizingString::new(

"thisbetterbeastrongpassword".tostring());

let psh = Psh::new(

master_password,

PshMemDb::new(),

).expect("Error initializing Psh");

let alias = ZeroizingString::new(

"mysecretbox".to_string());

let secret = ZeroizingString::new( "aneasytoremembersecretword".tostring()); let password = psh.derive_password(&alias, Some(secret), None); ```

The third argument to derive_password() is [CharSet]: ```rust

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

use psh::CharSet; #

let master_password = ZeroizingString::new(

"thisbetterbeastrongpassword".tostring());

let psh = Psh::new(

master_password,

PshMemDb::new(),

).expect("Error initializing Psh");

let alias = ZeroizingString::new(

"mysecretbox".to_string());

// This password should consist of [a-zA-Z0-9] characters only let password = psh.derive_password(&alias, None, Some(CharSet::Reduced)); ```

To store/remove alias and its settings to/from psh database: ```rust

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

#

let master_password = ZeroizingString::new(

"thisbetterbeastrongpassword".tostring());

let mut psh = Psh::new( master_password, PshMemDb::new(), ).expect("Error initializing Psh");

let alias = ZeroizingString::new(

"mysecretbox".to_string());

let usesecret = true; let charset = CharSet::RequireAll; // Store alias psh.appendaliastodb(&alias, Some(usesecret), Some(charset)) .expect("Error storing alias"); // Remove alias psh.removealiasfromdb(&alias) .expect("Error removing alias"); ```

Note that in the examples above in-memory [PshMemDb] is used as a database backend. There are other backends available: [psh_db::PshDb] which uses plain file and [psh_webdb::PshWebDb] which uses LocalStorage Web API.