k12 0.5.1

Implementation of the KangarooTwelve family of extendable-output functions
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

use core::fmt;
use digest::{
    CollisionResistance, ExtendableOutput, ExtendableOutputReset, HashMarker, Reset, Update,
    common::AlgorithmName,
    consts::{U16, U32},
};

use crate::{Kt, KtReader, utils::length_encode};

/// Customized KangarooTwelve hasher generic over rate with borrrowed customization string.
#[derive(Clone)]
pub struct CustomRefKt<'a, const RATE: usize> {
    customization: &'a [u8],
    inner: Kt<RATE>,
}

impl<'a, const RATE: usize> CustomRefKt<'a, RATE> {
    /// Create new customized KangarooTwelve hasher with borrrowed customization string.
    ///
    /// Note that this is an inherent method and `CustomRefKt` does not implement
    /// the [`CustomizedInit`][digest::CustomizedInit] trait.
    #[inline]
    #[must_use]
    pub fn new_customized(customization: &'a [u8]) -> Self {
        Self {
            customization,
            inner: Default::default(),
        }
    }
}

impl<const RATE: usize> Default for CustomRefKt<'static, RATE> {
    #[inline]
    fn default() -> Self {
        Self::new_customized(&[])
    }
}

impl<const RATE: usize> fmt::Debug for CustomRefKt<'_, RATE> {
    #[inline]
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> Result<(), fmt::Error> {
        write!(f, "CustomKt{} {{ ... }}", 4 * (200 - RATE))
    }
}

impl<const RATE: usize> AlgorithmName for CustomRefKt<'_, RATE> {
    #[inline]
    fn write_alg_name(f: &mut fmt::Formatter<'_>) -> fmt::Result {
        Kt::<RATE>::write_alg_name(f)
    }
}

impl<const RATE: usize> HashMarker for CustomRefKt<'_, RATE> {}

impl<const RATE: usize> Update for CustomRefKt<'_, RATE> {
    #[inline]
    fn update(&mut self, data: &[u8]) {
        self.inner.update(data);
    }
}

impl<const RATE: usize> Reset for CustomRefKt<'_, RATE> {
    #[inline]
    fn reset(&mut self) {
        self.inner.reset();
    }
}

impl<const RATE: usize> CustomRefKt<'_, RATE> {
    fn absorb_customization(&mut self) {
        self.inner.update(self.customization);
        let len = u64::try_from(self.customization.len()).expect("length always fits into `u64`");
        length_encode(len, |enc_len| self.inner.update(enc_len));
    }
}

impl<const RATE: usize> ExtendableOutput for CustomRefKt<'_, RATE> {
    type Reader = KtReader<RATE>;

    #[inline]
    fn finalize_xof(mut self) -> Self::Reader {
        self.absorb_customization();
        self.inner.raw_finalize()
    }
}

impl<const RATE: usize> ExtendableOutputReset for CustomRefKt<'_, RATE> {
    #[inline]
    fn finalize_xof_reset(&mut self) -> Self::Reader {
        self.absorb_customization();
        let reader = self.inner.raw_finalize();
        self.inner.reset();
        reader
    }
}

// `inner` is zeroized by `Drop` and `customization` can not be zeroized
#[cfg(feature = "zeroize")]
impl<const RATE: usize> digest::zeroize::ZeroizeOnDrop for CustomRefKt<'_, RATE> {}

/// Customized KT128 hasher with borrowed customization string.
pub type CustomRefKt128<'a> = CustomRefKt<'a, 168>;
/// Customized KT256 hasher with borrowed customization string.
pub type CustomRefKt256<'a> = CustomRefKt<'a, 136>;

impl CollisionResistance for CustomRefKt128<'_> {
    type CollisionResistance = U16;
}

impl CollisionResistance for CustomRefKt256<'_> {
    type CollisionResistance = U32;
}