Skip to content

Latest commit

 

History

History
70 lines (49 loc) · 1.7 KB

Readme.md

File metadata and controls

70 lines (49 loc) · 1.7 KB

BCrypter

Crates.io Build Status Crates.io

A pure rust implementation of the bcrypt hashing function based on the Blowfish cipher. Currently only running on nightly builds. Full API documentation can be found here

Installation

In your Cargo.toml file:

[dependencies]
bcrypter = "0.1.1"

Usage

Basic hash

extern crate bcrypter;
use bcrypter::password;

let pw = "hunter2".to_string();
let bcrypt_hash = password(pw).hash().unwrap();

Custom cost

let result = password(pw)
                .cost(6)
                .hash()
                .unwrap();

Custom salt

let salt = [0u8; 16];
let result = password(pw)
                .salt(salt)
                .cost(8)
                .hash()
                .unwrap();

Verify password

let known_hash = "$2a$04$7eAf8viXin8zazyvaU2HLuZGEbvaHy/lsnlG.HFWkBST5irHhXKJO".to_string();
let correct_password : bool = password(pw)
                                .verify(known_hash)
                                .unwrap()

Raw digest

let result = password(pw).hash().unwrap();
let digest_bytes : [u8: 24] = result.digest;

Notes

  • The default cost is 12

  • A random 16 byte array is used when no salt parameter is provided.

  • The maximum password input is 72 bytes, anything over that will be truncated rather than raise an error. If you need larger inputs consider hashing it beforehand.