dryoc 0.9.0

Don't Roll Your Own Crypto: pure-Rust, hard to misuse cryptography library
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
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279

//! # SHA-2 and SHA-3 hashing
//!
//! Implements libsodium's `crypto_hash_sha256_*`, `crypto_hash_sha512_*`,
//! `crypto_hash_sha3256_*`, and `crypto_hash_sha3512_*` functions.
//!
//! SHA-2 and SHA-3 are unkeyed hash functions. They produce fixed-size digests
//! that identify input bytes, but they do not prove who created the input. Use
//! [`crate::classic::crypto_auth`] or the direct HMAC modules when a shared
//! secret key is required.
//!
//! ```
//! use dryoc::classic::crypto_hash::*;
//!
//! let message = b"The empty vessel makes the loudest sound.";
//!
//! let mut sha256 = Sha256Digest::default();
//! crypto_hash_sha256(&mut sha256, message);
//! assert_eq!(sha256.len(), 32);
//!
//! let mut sha512: Sha512Digest = [0u8; 64];
//! crypto_hash_sha512(&mut sha512, message);
//! assert_eq!(sha512.len(), 64);
//!
//! let mut sha3256 = Sha3256Digest::default();
//! crypto_hash_sha3256(&mut sha3256, message);
//! assert_eq!(sha3256.len(), 32);
//!
//! let mut sha3512: Sha3512Digest = [0u8; 64];
//! crypto_hash_sha3512(&mut sha3512, message);
//! assert_eq!(sha3512.len(), 64);
//! ```

use crate::constants::{
    CRYPTO_HASH_SHA256_BYTES, CRYPTO_HASH_SHA512_BYTES, CRYPTO_HASH_SHA3256_BYTES,
    CRYPTO_HASH_SHA3512_BYTES,
};
use crate::sha3::{Sha3256, Sha3512};
use crate::sha256::Sha256;
use crate::sha512::*;

/// Type alias for SHA512 digest output.
pub type Digest = Sha512Digest;
/// Type alias for SHA256 digest output.
pub type Sha256Digest = [u8; CRYPTO_HASH_SHA256_BYTES];
/// Type alias for SHA512 digest output.
pub type Sha512Digest = [u8; CRYPTO_HASH_SHA512_BYTES];
/// Type alias for SHA3-256 digest output.
pub type Sha3256Digest = [u8; CRYPTO_HASH_SHA3256_BYTES];
/// Type alias for SHA3-512 digest output.
pub type Sha3512Digest = [u8; CRYPTO_HASH_SHA3512_BYTES];

/// Computes a SHA-256 hash from `input`.
pub fn crypto_hash_sha256(output: &mut Sha256Digest, input: &[u8]) {
    let mut state = crypto_hash_sha256_init();
    crypto_hash_sha256_update(&mut state, input);
    crypto_hash_sha256_final(state, output);
}

/// Internal state for SHA-256 functions.
#[derive(Default)]
pub struct Sha256State {
    pub(super) hasher: Sha256,
}

/// Initializes a SHA-256 hasher.
pub fn crypto_hash_sha256_init() -> Sha256State {
    Sha256State::default()
}

/// Updates `state` of SHA-256 hasher with `input`.
pub fn crypto_hash_sha256_update(state: &mut Sha256State, input: &[u8]) {
    state.hasher.update(input);
}

/// Finalizes `state` of SHA-256, and writes the digest to `output` consuming
/// `state`.
pub fn crypto_hash_sha256_final(state: Sha256State, output: &mut Sha256Digest) {
    state.hasher.finalize_into_bytes(output)
}

/// Computes a SHA-512 hash from `input`.
pub fn crypto_hash_sha512(output: &mut Digest, input: &[u8]) {
    let mut state = crypto_hash_sha512_init();
    crypto_hash_sha512_update(&mut state, input);
    crypto_hash_sha512_final(state, output);
}

/// Internal state for SHA-512 functions.
#[derive(Default)]
pub struct Sha512State {
    pub(super) hasher: Sha512,
}

/// Initializes a SHA-512 hasher.
pub fn crypto_hash_sha512_init() -> Sha512State {
    Sha512State::default()
}

/// Updates `state` of SHA-512 hasher with `input`.
pub fn crypto_hash_sha512_update(state: &mut Sha512State, input: &[u8]) {
    state.hasher.update(input);
}

/// Finalizes `state` of SHA-512, and writes the digest to `output` consuming
/// `state`.
pub fn crypto_hash_sha512_final(state: Sha512State, output: &mut Digest) {
    state.hasher.finalize_into_bytes(output)
}

/// Computes a SHA3-256 hash from `input`.
pub fn crypto_hash_sha3256(output: &mut Sha3256Digest, input: &[u8]) {
    let mut state = crypto_hash_sha3256_init();
    crypto_hash_sha3256_update(&mut state, input);
    crypto_hash_sha3256_final(state, output);
}

/// Internal state for SHA3-256 functions.
#[derive(Default)]
pub struct Sha3256State {
    pub(super) hasher: Sha3256,
}

/// Initializes a SHA3-256 hasher.
pub fn crypto_hash_sha3256_init() -> Sha3256State {
    Sha3256State::default()
}

/// Updates `state` of SHA3-256 hasher with `input`.
pub fn crypto_hash_sha3256_update(state: &mut Sha3256State, input: &[u8]) {
    state.hasher.update(input);
}

/// Finalizes `state` of SHA3-256, and writes the digest to `output` consuming
/// `state`.
pub fn crypto_hash_sha3256_final(state: Sha3256State, output: &mut Sha3256Digest) {
    state.hasher.finalize_into_bytes(output)
}

/// Computes a SHA3-512 hash from `input`.
pub fn crypto_hash_sha3512(output: &mut Sha3512Digest, input: &[u8]) {
    let mut state = crypto_hash_sha3512_init();
    crypto_hash_sha3512_update(&mut state, input);
    crypto_hash_sha3512_final(state, output);
}

/// Internal state for SHA3-512 functions.
#[derive(Default)]
pub struct Sha3512State {
    pub(super) hasher: Sha3512,
}

/// Initializes a SHA3-512 hasher.
pub fn crypto_hash_sha3512_init() -> Sha3512State {
    Sha3512State::default()
}

/// Updates `state` of SHA3-512 hasher with `input`.
pub fn crypto_hash_sha3512_update(state: &mut Sha3512State, input: &[u8]) {
    state.hasher.update(input);
}

/// Finalizes `state` of SHA3-512, and writes the digest to `output` consuming
/// `state`.
pub fn crypto_hash_sha3512_final(state: Sha3512State, output: &mut Sha3512Digest) {
    state.hasher.finalize_into_bytes(output)
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_crypto_hash_sha256() {
        let mut our_digest = [0u8; CRYPTO_HASH_SHA256_BYTES];
        crypto_hash_sha256(&mut our_digest, b"abc");

        let expected =
            hex::decode("ba7816bf8f01cfea414140de5dae2223b00361a396177a9cb410ff61f20015ad")
                .expect("hex failed");
        assert_eq!(our_digest.as_slice(), expected.as_slice());
    }

    #[test]
    fn test_crypto_hash_sha3256() {
        let mut our_digest = [0u8; CRYPTO_HASH_SHA3256_BYTES];
        crypto_hash_sha3256(&mut our_digest, b"abc");

        let expected =
            hex::decode("3a985da74fe225b2045c172d6bd390bd855f086e3e9d525b46bfe24511431532")
                .expect("hex failed");
        assert_eq!(our_digest.as_slice(), expected.as_slice());
    }

    #[test]
    fn test_crypto_hash_sha3256_update() {
        let mut state = crypto_hash_sha3256_init();
        crypto_hash_sha3256_update(&mut state, b"a");
        crypto_hash_sha3256_update(&mut state, b"b");
        crypto_hash_sha3256_update(&mut state, b"c");

        let mut our_digest = [0u8; CRYPTO_HASH_SHA3256_BYTES];
        crypto_hash_sha3256_final(state, &mut our_digest);

        let expected =
            hex::decode("3a985da74fe225b2045c172d6bd390bd855f086e3e9d525b46bfe24511431532")
                .expect("hex failed");
        assert_eq!(our_digest.as_slice(), expected.as_slice());
    }

    #[test]
    fn test_crypto_hash_sha3512() {
        let mut our_digest = [0u8; CRYPTO_HASH_SHA3512_BYTES];
        crypto_hash_sha3512(&mut our_digest, b"abc");

        let expected = hex::decode(concat!(
            "b751850b1a57168a5693cd924b6b096e08f621827444f70d884f5d0240d2712e",
            "10e116e9192af3c91a7ec57647e3934057340b4cf408d5a56592f8274eec53f0"
        ))
        .expect("hex failed");
        assert_eq!(our_digest.as_slice(), expected.as_slice());
    }

    #[test]
    fn test_crypto_hash_sha3512_update() {
        let mut state = crypto_hash_sha3512_init();
        crypto_hash_sha3512_update(&mut state, b"a");
        crypto_hash_sha3512_update(&mut state, b"b");
        crypto_hash_sha3512_update(&mut state, b"c");

        let mut our_digest = [0u8; CRYPTO_HASH_SHA3512_BYTES];
        crypto_hash_sha3512_final(state, &mut our_digest);

        let expected = hex::decode(concat!(
            "b751850b1a57168a5693cd924b6b096e08f621827444f70d884f5d0240d2712e",
            "10e116e9192af3c91a7ec57647e3934057340b4cf408d5a56592f8274eec53f0"
        ))
        .expect("hex failed");
        assert_eq!(our_digest.as_slice(), expected.as_slice());
    }

    #[cfg(dryoc_native_tests)]
    #[test]
    fn test_crypto_hash_sha512() {
        use sodiumoxide::crypto::hash;

        use crate::rng::randombytes_buf;

        let r = randombytes_buf(64);

        let their_digest = hash::hash(&r);
        let mut our_digest = [0u8; CRYPTO_HASH_SHA512_BYTES];
        crypto_hash_sha512(&mut our_digest, &r);

        assert_eq!(their_digest.as_ref(), our_digest);
    }

    #[cfg(dryoc_native_tests)]
    #[test]
    fn test_crypto_hash_sha512_update() {
        use sodiumoxide::crypto::hash;

        use crate::rng::randombytes_buf;

        let mut their_state = hash::State::new();
        let mut our_state = crypto_hash_sha512_init();

        for _ in 0..10 {
            let r = randombytes_buf(64);
            their_state.update(&r);
            crypto_hash_sha512_update(&mut our_state, &r);
        }

        let their_digest = their_state.finalize();
        let mut our_digest = [0u8; CRYPTO_HASH_SHA512_BYTES];
        crypto_hash_sha512_final(our_state, &mut our_digest);

        assert_eq!(their_digest.as_ref(), our_digest);
    }
}