20 releases (11 breaking)

0.11.0-pre.4 Jul 27, 2024
0.11.0-pre.3 Feb 7, 2024
0.10.6 Dec 16, 2022
0.10.5 Nov 11, 2022
0.3.0 Nov 17, 2016

#118 in Cryptography

Download history 456140/week @ 2024-07-27 475273/week @ 2024-08-03 472551/week @ 2024-08-10 426015/week @ 2024-08-17 444873/week @ 2024-08-24 444021/week @ 2024-08-31 415942/week @ 2024-09-07 392759/week @ 2024-09-14 568694/week @ 2024-09-21 580029/week @ 2024-09-28 1041160/week @ 2024-10-05 906958/week @ 2024-10-12 923732/week @ 2024-10-19 429102/week @ 2024-10-26 427546/week @ 2024-11-02 346252/week @ 2024-11-09

2,210,106 downloads per month
Used in 2,827 crates (466 directly)

MIT/Apache

48KB
1K SLoC

RustCrypto: BLAKE2

crate Docs Build Status Apache2/MIT licensed Rust Version Project Chat

Pure Rust implementation of the BLAKE2 hash function family.

Examples

Fixed output size

use blake2::{Blake2b512, Blake2s256, Digest};
use hex_literal::hex;

// create a Blake2b512 object
let mut hasher = Blake2b512::new();

// write input message
hasher.update(b"hello world");

// read hash digest and consume hasher
let hash = hasher.finalize();
assert_eq!(hash, hex!(
    "021ced8799296ceca557832ab941a50b4a11f83478cf141f51f933f653ab9fbc"
    "c05a037cddbed06e309bf334942c4e58cdf1a46e237911ccd7fcf9787cbc7fd0"
));

// same example for Blake2s256:
let mut hasher = Blake2s256::new();
hasher.update(b"hello world");
let hash = hasher.finalize();
assert_eq!(hash, hex!("9aec6806794561107e594b1f6a8a6b0c92a0cba9acf5e5e93cca06f781813b0b"));

// Hex-encode hash using https://docs.rs/base16ct
let hex_hash = base16ct::lower::encode_string(&hash);
assert_eq!(hex_hash, "9aec6806794561107e594b1f6a8a6b0c92a0cba9acf5e5e93cca06f781813b0b");

Also, see the examples section in the RustCrypto/hashes readme.

Variable output size

This implementation supports run and compile time variable sizes.

Output size set at run time:

use blake2::Blake2bVar;
use blake2::digest::{Update, VariableOutput};
use hex_literal::hex;

let mut hasher = Blake2bVar::new(10).unwrap();
hasher.update(b"my_input");
let mut buf = [0u8; 10];
hasher.finalize_variable(&mut buf).unwrap();
assert_eq!(buf, hex!("2cc55c84e416924e6400"));

Output size set at compile time:

use blake2::{Blake2b, Digest, digest::consts::U10};
use hex_literal::hex;

type Blake2b80 = Blake2b<U10>;

let mut hasher = Blake2b80::new();
hasher.update(b"my_input");
let res = hasher.finalize();
assert_eq!(res, hex!("2cc55c84e416924e6400"));

Minimum Supported Rust Version

Rust 1.71 or higher.

Minimum supported Rust version can be changed in the future, but it will be done with a minor version bump.

SemVer Policy

  • All on-by-default features of this library are covered by SemVer
  • MSRV is considered exempt from SemVer as noted above

License

The crate is licensed under either of:

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

Dependencies

~330–500KB
~11K SLoC