Crate sha2 Copy item path

§RustCrypto: SHA-2

Pure Rust implementation of the SHA-2 cryptographic hash algorithms.

There are 6 standard algorithms specified in the SHA-2 standard: Sha224, Sha256, Sha512_224, Sha512_256, Sha384, and Sha512.

Algorithmically, there are only 2 core algorithms: SHA-256 and SHA-512. All other algorithms are just applications of these with different initial hash values, and truncated to different digest bit lengths. The first two algorithms in the list are based on SHA-256, while the last four are based on SHA-512.

§Examples

§One-shot API

use sha2::{Sha256, Digest};
use hex_literal::hex;

let hash = Sha256::digest(b"hello world");
assert_eq!(hash, hex!("b94d27b9934d3e08a52e52d7da7dabfac484efe37a5380ee9088f7ace2efcde9"));

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

§Incremental API

use sha2::{Sha256, Sha512, Digest};
use hex_literal::hex;

let mut hasher = Sha256::new();
hasher.update(b"hello ");
hasher.update(b"world");
let hash256 = hasher.finalize();

assert_eq!(hash256, hex!("b94d27b9934d3e08a52e52d7da7dabfac484efe37a5380ee9088f7ace2efcde9"));

let mut hasher = Sha512::new();
hasher.update(b"hello world");
let hash512 = hasher.finalize();

assert_eq!(hash512, hex!(
    "309ecc489c12d6eb4cc40f50c902f2b4d0ed77ee511a7c7a9bcd3ca86d4cd86f"
    "989dd35bc5ff499670da34255b45b0cfd830e81f605dcf7dc5542e93ae9cd76f"
));

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

§Backends

This crate supports the following backends:

• soft: portable implementation with fully unrolled rounds
• soft-compact: portable implementation which produces smaller binaries
• aarch64-sha2: uses the AArch64 sha2 extension, fallbacks to the soft backend if the extension is not available
• loongarch64-asm: asm!-based implementation for LoongArch64 targets
• riscv-zknh: uses the RISC-V Zknh scalar crypto extension (experimental)
• riscv-zknh-compact: same as riscv_zknh but does not unroll rounds (experimental)
• wasm32-simd: uses the WASM simd128 extension
• x86-shani: uses the x86 SHA-NI extension, fallbacks to the soft backend if the extension is not available (SHA-256 only)
• x86-avx2: uses the x86 AVX2 extension, fallbacks to the soft backend if the extension is not available (SHA-512 only)

You can force backend selection using the sha2_backend configuration flag. It can be enabled using either environment variable (e.g. RUSTFLAGS='--cfg sha2_backend="soft"' cargo build), or by modifying your .cargo/config.toml file. Currently the flag supports the following values: soft, soft-compact, riscv-zknh, and riscv-zknh-compact.

Note that the RISC-V backends are experimental and require Nightly compiler.

§License

The crate is licensed under either of:

• Apache License, Version 2.0
• MIT license

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.