Struct bcrypter::Inputs

pub struct Inputs { /* fields omitted */ }

The hashing parameters, only a password is required. Defaults to a randomly generated salt and a cost of 12

Methods

impl Inputs

pub fn verify(self, bcrypt_hash: &str) -> Result<bool, InvalidFormat>

Checks password against a known bcrypt hash

Errors

Throws InvalidFormat when the bcrypt hash has invalid base64 or formatting

Examples

let pw = String::from("hunter2");
let hash = String::from("$2a$04$7eAf8viXin8zazyvaU2HLuZGEbvaHy/lsnlG.HFWkBST5irHhXKJO");
let correct = bcrypter::password(pw).verify(&hash);

pub fn hash(self) -> Result<Bcrypt, InvalidCost>

Main hashing function. Returns a Bcrypt struct result from given inputs

Errors

Throws an InvalidCost error if the cost parameter is invalid.

Example

let pw = String::from("hunter2");
let result = bcrypter::password(pw).hash().unwrap();
let hash = result.hash_string;

pub fn salt(self, salt: [u8; 16]) -> Inputs

Sets salt parameter for the hasher, value is ignored when calling verify function.

Example

let sixteen_bytes = [0u8; 16]; // Use appropiate random values instead
let pw = String::from("hunter2");
let result = bcrypter::password(pw).salt(sixteen_bytes).hash().unwrap();

pub fn cost(self, cost: u8) -> Inputs

Sets the cost parameter, value is ignored when calling verify function

Example

let pw = String::from("hunter2");
let result = bcrypter::password(pw).cost(8).hash().unwrap();

pub fn set_defualts(self) -> Inputs

Sets any input parameter that hasn't been modified to the default values.