1个不稳定版本
0.0.0 | 2019年11月6日 |
---|
#17 在 #blake2
2KB
RustCrypto: 哈希
纯Rust编写的加密哈希函数集合。
所有算法都位于独立的crate中,并使用来自digest
crate的trait实现。此外,所有crate都不需要标准库(即no_std
兼容)并可以轻松用于裸机或WebAssembly编程。
支持算法
注意:对于新应用,或者与其他现有标准的兼容性不是首要关注的问题时,我们强烈建议使用BLAKE2、SHA-2或SHA-3。
算法 | crate | Crates.io | 文档 | MSRV | 安全性 |
---|---|---|---|---|---|
Ascon哈希 | ascon‑hash |
💚 | |||
BelT哈希 | belt‑hash |
💚 | |||
BLAKE2 | blake2 |
💚 | |||
FSB | fsb |
💚 | |||
GOST R 34.11-94 | gost94 |
💛 | |||
Grøstl (Groestl) | groestl |
💚 | |||
JH | jh |
💚 | |||
KangarooTwelve | k12 |
💚 | |||
MD2 | md2 |
💔 | |||
MD4 | md4 |
💔 | |||
MD5 | md5 ❗ |
💔 | |||
RIPEMD | ripemd |
💚 | |||
SHA-1 | sha1 |
💔 | |||
SHA-1 Checked | sha1-checked |
💛 | |||
SHA-2 | sha2 |
💚 | |||
SHA-3 (Keccak) | sha3 |
💚 | |||
SHABAL | shabal |
💚 | |||
Skein | skein |
💚 | |||
SM3 (OSCCA GM/T 0004-2012) | sm3 |
💚 | |||
Streebog (GOST R 34.11-2012) | streebog |
💛 | |||
Tiger | tiger |
💚 | |||
Whirlpool | whirlpool |
💚 |
注意:blake3
crate实现了此仓库中其余哈希使用的digest
traits,但由BLAKE3团队维护。
安全级别图例
以下描述了与每个哈希函数(即算法,而非具体实现)相关的安全级别评分
心形 | 描述 |
---|---|
💚 | 没有已知成功的攻击 |
💛 | 理论破解:安全性低于声称的 |
💔 | 实践中已展示攻击:尽可能避免 |
有关更多信息,请参阅维基百科上的安全页面。
crate名称
尽可能情况下,库文件将以与库文件夹相同的名称发布。库文件 md5
的所有者 拒绝 参与此项目。此库没有实现 digest
特性,因此它与 RustCrypto 生态系统不兼容。这就是为什么我们将我们的 MD5 实现作为 md-5
发布,并用 ❗ 标记。请注意,库本身被命名为 md5
,即在 use
语句中,您应该使用 md5
,而不是 md_5
。
SHA-1 实现在之前被发布为 sha-1
,但从 v0.10.0 版本开始迁移到 sha1
。 sha-1
将继续接收 v0.10.x 补丁更新,但在 sha1
v0.11 版本发布后将被弃用。
最低支持 Rust 版本 (MSRV) 政策
MSRV 的提升被视为破坏性更改,并且仅通过次要版本提升进行。
示例
让我们以 SHA-2 为例,演示如何使用此存储库中的库。
首先将 sha2
库添加到您的 Cargo.toml
[dependencies]
sha2 = "0.10"
请注意,此存储库中的所有库都默认启用了 std
功能。因此,如果您计划在 no_std
环境中使用库,请务必禁用它
[dependencies]
sha2 = { version = "0.10", default-features = false }
sha2
和其他哈希实现库为了方便起见重新导出 digest
库和 Digest
特性,因此您不需要将其作为显式依赖项包含在 Cargo.toml
中。
现在您可以编写以下代码
use sha2::{Sha256, Digest};
let mut hasher = Sha256::new();
let data = b"Hello world!";
hasher.update(data);
// `update` can be called repeatedly and is generic over `AsRef<[u8]>`
hasher.update("String data");
// Note that calling `finalize()` consumes hasher
let hash = hasher.finalize();
println!("Binary hash: {:?}", hash);
在这个例子中 hash
的类型是 GenericArray<u8, U32>
,这是 generic-array
库中定义的 [u8; 32]
的泛型替代。如果您需要将哈希值序列化为字符串,您可以使用 base16ct
和 base64ct
等库。
use base64ct::{Base64, Encoding};
let base64_hash = Base64::encode_string(&hash);
println!("Base64-encoded hash: {}", base64_hash);
let hex_hash = base16ct::lower::encode_string(&hash);
println!("Hex-encoded hash: {}", hex_hash);
除了调用 update
之外,您还可以使用链式方法
use sha2::{Sha256, Digest};
let hash = Sha256::new()
.chain_update(b"Hello world!")
.chain_update("String data")
.finalize();
如果有一个完整的消息可用,则可以使用方便的 Digest::digest
方法
use sha2::{Sha256, Digest};
let hash = Sha256::digest(b"my message");
哈希可读对象
如果您想从实现了 Read
特性的类型中哈希数据,您可以依靠 Write
特性的实现(需要默认启用的 std
功能)
use sha2::{Sha256, Digest};
use std::{fs, io};
let mut file = fs::File::open(&path)?;
let mut hasher = Sha256::new();
let n = io::copy(&mut file, &mut hasher)?;
let hash = hasher.finalize();
基于哈希的消息认证码 (HMAC)
如果您想计算 基于哈希的消息认证码 (HMAC),您可以使用 hmac
库的泛型实现,该库是 RustCrypto/MACs 存储库的一部分。
泛型代码
您可以在 Digest
trait(或来自 digest
crate 的其他 traits)上编写通用代码,这些代码将适用于不同的哈希函数。
use sha2::{Sha256, Sha512, Digest};
// Toy example, do not use it in practice!
// Instead use crates from: https://github.com/RustCrypto/password-hashing
fn hash_password<D: Digest>(password: &str, salt: &str, output: &mut [u8]) {
let mut hasher = D::new();
hasher.update(password.as_bytes());
hasher.update(b"$");
hasher.update(salt.as_bytes());
output.copy_from_slice(&hasher.finalize())
}
let mut buf1 = [0u8; 32];
hash_password::<Sha256>("my_password", "abcd", &mut buf1);
let mut buf2 = [0u8; 64];
hash_password::<Sha512>("my_password", "abcd", &mut buf2);
如果您想使用具有 trait 对象的哈希函数,可以使用 DynDigest
trait。
use digest::DynDigest;
// Dynamic hash function
fn use_hasher(hasher: &mut dyn DynDigest, data: &[u8]) -> Box<[u8]> {
hasher.update(data);
hasher.finalize_reset()
}
// You can use something like this when parsing user input, CLI arguments, etc.
// DynDigest needs to be boxed here, since function return should be sized.
fn select_hasher(s: &str) -> Box<dyn DynDigest> {
match s {
"md5" => Box::new(md5::Md5::default()),
"sha1" => Box::new(sha1::Sha1::default()),
"sha224" => Box::new(sha2::Sha224::default()),
"sha256" => Box::new(sha2::Sha256::default()),
"sha384" => Box::new(sha2::Sha384::default()),
"sha512" => Box::new(sha2::Sha512::default()),
_ => unimplemented!("unsupported digest: {}", s),
}
}
let mut hasher1 = select_hasher("md5");
let mut hasher2 = select_hasher("sha512");
// the `&mut *hasher` is to DerefMut the value out of the Box
// this is equivalent to `DerefMut::deref_mut(&mut hasher)`
// can be reused due to `finalize_reset()`
let hash1_1 = use_hasher(&mut *hasher1, b"foo");
let hash1_2 = use_hasher(&mut *hasher1, b"bar");
let hash2_1 = use_hasher(&mut *hasher2, b"foo");
许可证
本存储库中的所有 crate 都许可在以下两种中的一种:
由您选择。
贡献
除非您明确声明,否则根据 Apache-2.0 许可证定义的,您有意提交以包含在作品中的任何贡献,都将按照上述方式双许可,没有任何附加条款或条件。