https://github.com/ohsayan/rcrypt
rcrypt is a compact hashing and salting library based on bcrypt that produces smaller hashes
https://github.com/ohsayan/rcrypt
bcrypt bmcf cryptographic-hash-functions cryptography hashing mcf rcrypt rust salting
Last synced: 6 months ago
JSON representation
rcrypt is a compact hashing and salting library based on bcrypt that produces smaller hashes
- Host: GitHub
- URL: https://github.com/ohsayan/rcrypt
- Owner: ohsayan
- License: apache-2.0
- Created: 2022-02-23T03:59:22.000Z (over 3 years ago)
- Default Branch: next
- Last Pushed: 2022-09-13T10:35:17.000Z (about 3 years ago)
- Last Synced: 2025-03-23T12:32:54.540Z (7 months ago)
- Topics: bcrypt, bmcf, cryptographic-hash-functions, cryptography, hashing, mcf, rcrypt, rust, salting
- Language: Rust
- Homepage: https://docs.rs/rcrypt
- Size: 34.2 KB
- Stars: 12
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# `rcrypt`: A compact hashing and salting library
 [](https://crates.io/crates/rcrypt) [](https://docs.rs/rcrypt) [](./LICENSE)
`rcrypt`, short for "reduced crypt" is a compact hashing and salting library based on bcrypt **generating hashes that are 33.3% smaller than bcrypt** (40 bytes over 60 bytes).
It was originally made for a part of [Skytable](https://github.com/skytable/skytable)'s authentication
system storage, but was moved into a separate library for usage in the wider Rust community.
`rcrypt` is almost a drop-in replacement for the `bcrypt` crate. [Here's how it works](#how-it-works).
## Usage
```rust
use rcrypt::DEFAULT_COST;
// your password
let mypass = String::from("pass123");
// hash
let hash = rcrypt::hash(&mypass, DEFAULT_COST).unwrap();
// verify
assert!(rcrypt::verify(&mypass, &hash).unwrap());
```
The usage remains just the same for users who use the [bcrypt](https://crates.io/crates/bcrypt) crate, except that the `hash` method returns a `Vec` instead of a `String`, while for the `verify` method you need to pass a `&[u8]` for the hash.
## Getting back your bcrypt hash
If for some reason you need a `String` with the bcrypt hash from your rcrypt hash, you can do that too!
Here's the procedure:
```rust
use rcrypt::DEFAULT_COST;
let rhash = rcrypt::hash("mypassword", DEFAULT_COST).unwrap();
// now let's get the bcrypt hash from the rcrypt hash
let bhash = rcrypt::bmcf::decode_into_mcf(&rhash).unwrap();
```
## How it works
The smaller hash sizes result by `rcrypt` producing binary hashes and merging hash fields, in accordance
with the [BMCF spec](https://github.com/ademarre/binary-mcf).
- The field separators in the MCF hash are not present in hashes generated by `rcrypt`
- The cost and scheme fields are merged into one field
- The hashes generated by rcrypt do not use base64 which results in lesser bytes being used to store the
salt+digest
## Acknowledgements
- The [Binary Modular Crypt Format specification](https://github.com/ademarre/binary-mcf) by [Andre DeMarre](https://github.com/ademarre)
- The [original bcrypt implementation in Rust](https://github.com/Keats/rust-bcrypt) by [Vincent Prouillet](https://github.com/Keats). The underlying
bcrypt implementation used in this crate, and the public API are heavily inspired by the
[`bcrypt`](https://crates.io/crates/bcrypt) crate
## License
This crate is distributed under the [Apache-2.0 License](./LICENSE).