blazehash 0.2.4

Forensic file hasher — hashdeep for the modern era, BLAKE3 by default
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152

use digest::Digest;
use std::fmt;
use std::str::FromStr;

#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, Default)]
pub enum Algorithm {
    #[default]
    Blake3,
    Sha256,
    Sha512,
    Sha3_256,
    Sha1,
    Md5,
    Tiger,
    Whirlpool,
    Ssdeep,
    Tlsh,
    Crc32c,
    Xxh3,
    Shake128,
    Shake256,
}

impl Algorithm {
    pub fn all() -> &'static [Algorithm] {
        &[
            Algorithm::Blake3,
            Algorithm::Sha256,
            Algorithm::Sha512,
            Algorithm::Sha3_256,
            Algorithm::Sha1,
            Algorithm::Md5,
            Algorithm::Tiger,
            Algorithm::Whirlpool,
        ]
    }

    pub fn hashdeep_name(&self) -> &'static str {
        match self {
            Algorithm::Blake3 => "blake3",
            Algorithm::Sha256 => "sha256",
            Algorithm::Sha512 => "sha512",
            Algorithm::Sha3_256 => "sha3-256",
            Algorithm::Sha1 => "sha1",
            Algorithm::Md5 => "md5",
            Algorithm::Tiger => "tiger",
            Algorithm::Whirlpool => "whirlpool",
            Algorithm::Ssdeep => "ssdeep",
            Algorithm::Tlsh => "tlsh",
            Algorithm::Crc32c => "crc32c",
            Algorithm::Xxh3 => "xxh3",
            Algorithm::Shake128 => "shake128",
            Algorithm::Shake256 => "shake256",
        }
    }

    pub fn is_fuzzy(&self) -> bool {
        matches!(self, Algorithm::Ssdeep | Algorithm::Tlsh)
    }

    pub fn is_non_cryptographic(&self) -> bool {
        matches!(self, Algorithm::Crc32c | Algorithm::Xxh3)
    }

    /// Returns true for algorithms that require reading the full file into memory
    /// before hashing — either because they are non-cryptographic (CRC32C, XXH3)
    /// or because they are XOFs (SHAKE-128, SHAKE-256) that cannot stream via
    /// the `DynHasher` trait.
    pub fn needs_full_read(&self) -> bool {
        matches!(
            self,
            Algorithm::Crc32c | Algorithm::Xxh3 | Algorithm::Shake128 | Algorithm::Shake256
        )
    }
}

impl fmt::Display for Algorithm {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.write_str(self.hashdeep_name())
    }
}

impl FromStr for Algorithm {
    type Err = anyhow::Error;
    fn from_str(s: &str) -> Result<Self, Self::Err> {
        match s.to_lowercase().as_str() {
            "blake3" => Ok(Algorithm::Blake3),
            "sha256" | "sha-256" => Ok(Algorithm::Sha256),
            "sha512" | "sha-512" => Ok(Algorithm::Sha512),
            "sha3-256" | "sha3_256" => Ok(Algorithm::Sha3_256),
            "sha1" | "sha-1" => Ok(Algorithm::Sha1),
            "md5" => Ok(Algorithm::Md5),
            "tiger" => Ok(Algorithm::Tiger),
            "whirlpool" => Ok(Algorithm::Whirlpool),
            "ssdeep" => Ok(Algorithm::Ssdeep),
            "tlsh" => Ok(Algorithm::Tlsh),
            "crc32c" => Ok(Algorithm::Crc32c),
            "xxh3" => Ok(Algorithm::Xxh3),
            "shake128" => Ok(Algorithm::Shake128),
            "shake256" => Ok(Algorithm::Shake256),
            other => anyhow::bail!("unknown algorithm: {other}"),
        }
    }
}

pub fn hash_bytes(algo: Algorithm, data: &[u8]) -> String {
    match algo {
        Algorithm::Blake3 => blake3::hash(data).to_hex().to_string(),
        Algorithm::Sha256 => hex_digest::<sha2::Sha256>(data),
        Algorithm::Sha512 => hex_digest::<sha2::Sha512>(data),
        Algorithm::Sha3_256 => hex_digest::<sha3::Sha3_256>(data),
        Algorithm::Sha1 => hex_digest::<sha1::Sha1>(data),
        Algorithm::Md5 => hex_digest::<md5::Md5>(data),
        Algorithm::Tiger => hex_digest::<tiger::Tiger>(data),
        Algorithm::Whirlpool => hex_digest::<whirlpool::Whirlpool>(data),
        Algorithm::Ssdeep => crate::fuzzy::ssdeep::compute(data),
        Algorithm::Tlsh => crate::fuzzy::tlsh::compute(data).unwrap_or_default(),
        Algorithm::Crc32c => {
            let checksum = crc32c::crc32c(data);
            format!("{checksum:08x}")
        }
        Algorithm::Xxh3 => {
            use xxhash_rust::xxh3::xxh3_128;
            let hash = xxh3_128(data);
            format!("{hash:032x}")
        }
        Algorithm::Shake128 => {
            use sha3::digest::{ExtendableOutput, XofReader};
            let mut h = sha3::Shake128::default();
            sha3::digest::Update::update(&mut h, data);
            let mut reader = h.finalize_xof();
            let mut buf = [0u8; 32];
            reader.read(&mut buf);
            hex::encode(buf)
        }
        Algorithm::Shake256 => {
            use sha3::digest::{ExtendableOutput, XofReader};
            let mut h = sha3::Shake256::default();
            sha3::digest::Update::update(&mut h, data);
            let mut reader = h.finalize_xof();
            let mut buf = [0u8; 64];
            reader.read(&mut buf);
            hex::encode(buf)
        }
    }
}

fn hex_digest<D: Digest>(data: &[u8]) -> String {
    let mut hasher = D::new();
    hasher.update(data);
    hex::encode(hasher.finalize())
}