sha3 0.12.0

Implementation of the SHA-3 family of cryptographic hash algorithms
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

#![no_std]
#![doc = include_str!("../README.md")]
#![doc(
    html_logo_url = "https://raw.githubusercontent.com/RustCrypto/media/6ee8e381/logo.svg",
    html_favicon_url = "https://raw.githubusercontent.com/RustCrypto/media/6ee8e381/logo.svg"
)]
#![cfg_attr(docsrs, feature(doc_cfg))]
#![forbid(unsafe_code)]
#![warn(missing_docs, missing_debug_implementations)]
#![warn(unreachable_pub)]

pub use digest::{self, Digest};

use core::fmt;
use digest::{
    FixedOutput, FixedOutputReset, HashMarker, Output, OutputSizeUser, Reset, Update,
    common::{
        AlgorithmName, BlockSizeUser,
        hazmat::{DeserializeStateError, SerializableState, SerializedState},
    },
    consts::{U28, U32, U48, U64, U72, U104, U136, U144, U200, U201},
    typenum::Unsigned,
};
use keccak::{Keccak, State1600};

#[cfg(feature = "oid")]
mod oids;
mod utils;

macro_rules! impl_sha3_variants {
    ($(
        $(#[$attr:meta])*
        $name:ident($rate_ty:ty, $out_len:ty, $pad:expr);
    )*) => {$(
        $(#[$attr])*
        #[derive(Clone, Default)]
        pub struct $name {
            state: State1600,
            cursor: sponge_cursor::SpongeCursor<{ <$rate_ty>::USIZE }>,
            keccak: Keccak,
        }

        impl Reset for $name {
            #[inline]
            fn reset(&mut self) {
                self.state = Default::default();
                self.cursor = Default::default();
            }
        }

        impl HashMarker for $name {}

        impl Update for $name {
            #[inline]
            fn update(&mut self, data: &[u8]) {
                self.keccak.with_f1600(|f1600| {
                    self.cursor.absorb_u64_le(&mut self.state, f1600, data);
                });
            }
        }

        impl BlockSizeUser for $name {
            type BlockSize = $rate_ty;
        }

        impl OutputSizeUser for $name {
            type OutputSize = $out_len;
        }

        impl FixedOutput for $name {
            fn finalize_into(mut self, dst: &mut Output<Self>) {
                utils::pad::<$pad, { <$rate_ty>::USIZE }>(&mut self.state, &self.cursor);
                self.keccak.with_f1600(|f1600| {
                    f1600(&mut self.state);
                    utils::read_state(&mut self.state, dst);
                });
            }
        }

        impl FixedOutputReset for $name {
            fn finalize_into_reset(&mut self, dst: &mut Output<Self>) {
                utils::pad::<$pad, { <$rate_ty>::USIZE }>(&mut self.state, &self.cursor);
                self.keccak.with_f1600(|f1600| {
                    f1600(&mut self.state);
                    utils::read_state(&mut self.state, dst);
                });
                Reset::reset(self);
            }
        }

        impl AlgorithmName for $name {
            #[inline]
            fn write_alg_name(f: &mut fmt::Formatter<'_>) -> fmt::Result {
                f.write_str(stringify!($name))
            }
        }

        impl SerializableState for $name {
            type SerializedStateSize = U201;

            fn serialize(&self) -> SerializedState<Self> {
                utils::serialize(&self.state, &self.cursor).into()
            }

            fn deserialize(
                serialized_state: &SerializedState<Self>,
            ) -> Result<Self, DeserializeStateError> {
                utils::deserialize(serialized_state.into())
                    .ok_or(DeserializeStateError)
                    .map(|(state, cursor)| Self {
                        state,
                        cursor,
                        keccak: Keccak::new(),
                    })
            }
        }

        impl fmt::Debug for $name {
            #[inline]
            fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
                f.write_str(concat!(stringify!($name), " { ... }"))
            }
        }

        impl Drop for $name {
            #[inline]
            fn drop(&mut self) {
                #[cfg(feature = "zeroize")]
                {
                    use digest::zeroize::Zeroize;
                    self.state.zeroize();
                    self.cursor.zeroize();
                }
            }
        }

        #[cfg(feature = "zeroize")]
        impl digest::zeroize::ZeroizeOnDrop for $name {}
    )*};
}

const KECCAK_PAD: u8 = 0x01;
const SHA3_PAD: u8 = 0x06;

impl_sha3_variants!(
    /// SHA-3-224 hasher.
    Sha3_224(U144, U28, SHA3_PAD);
    /// SHA-3-256 hasher.
    Sha3_256(U136, U32, SHA3_PAD);
    /// SHA-3-384 hasher.
    Sha3_384(U104, U48, SHA3_PAD);
    /// SHA-3-256 hasher.
    Sha3_512(U72, U64, SHA3_PAD);

    /// Keccak-224 hasher.
    Keccak224(U144, U28, KECCAK_PAD);
    /// Keccak-256 hasher.
    Keccak256(U136, U32, KECCAK_PAD);
    /// Keccak-384 hasher.
    Keccak384(U104, U48, KECCAK_PAD);
    /// Keccak-512 hasher.
    Keccak512(U72, U64, KECCAK_PAD);

    /// CryptoNight variant of SHA-3.
    Keccak256Full(U136, U200, KECCAK_PAD);
);