orion 0.3.3

Cryptographic functions implemented in Rust, with a simple API.
Documentation

orion Build Status codecov

Warning: There are no guarantees for the security of these implementations. Use at your own risk.

Cryptographic functions implemented in Rust, with a simple API.

Currently contains:

  • HMAC with SHA2(256, 384, 512).
  • HKDF with the above HMAC options.
  • PBKDF2 with the above HMAC options.

Usage

extern crate orion
use orion::{default, core::util};

// HMAC-SHA512
let key = util::gen_rand_key(64).unwrap();
let msg = "Some message".as_bytes();

let expected_hmac = default::hmac(&key, msg).unwrap();
default::hmac_verify(&expected_hmac, &key, &msg).unwrap();


// HKDF-HMAC-SHA512
let salt = util::gen_rand_key(64).unwrap();
let data = "Some data".as_bytes();
let info = "Some info".as_bytes();

let dk = default::hkdf(&salt, data, info, 64).unwrap();
default::hkdf_verify(&dk, &salt, data, info, 64).unwrap();


// PBKDF2-HMAC-SHA512
let salt = util::gen_rand_key(64).unwrap();

let dk = default::pbkdf2("Secret password".as_bytes(), &salt).unwrap();
default::pbkdf2_verify(&dk, "Secret password".as_bytes(), &salt).unwrap();

Documentation

To build the most recent: cargo doc --no-deps or view here.

Tests/Fuzzing

Unit tests are located in the same file as what is being tested, apart from implementation verification tests - these are in tests. To run all tests: cargo test.

Fuzzing is done using cargo-fuzz. Fuzzing targets are located in fuzz/fuzz_targets.

Benchmarks

The library can be benchmarked as below. All benchmarking tests are located in benches.

cargo +nightly bench

Acknowledgments

Thanks to @defuse for a quick audit of the code.

License

orion is licensed under the MIT license. See the LICENSE file for more information.