multi-key 1.0.6

Multikey self-describing cryptographic key data
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

// SPDX-License-Identifier: Apache-2.0
use crate::{error::KdfError, mk::Attributes, AttrId, Error, Multikey};
use multi_codec::Codec;
use multi_util::Varuint;
use rand_core::CryptoRng;
use zeroize::Zeroizing;

/// Multikey builder constructs kdf multikeys.
#[derive(Clone, Debug, Default)]
pub struct Builder {
    codec: Codec,
    salt: Option<Zeroizing<Vec<u8>>>,
    rounds: Option<Zeroizing<Vec<u8>>>,
}

impl Builder {
    /// create a new multikey with the given codec
    pub fn new(codec: Codec) -> Self {
        Builder {
            codec,
            ..Default::default()
        }
    }

    /// initialize from a multikey with kdf attributes in it
    pub fn try_from_multikey(mut self, mk: &Multikey) -> Result<Self, Error> {
        // look up the kdf codec in the multikey attributes
        let v = mk
            .attributes
            .get(&AttrId::KdfCodec)
            .ok_or(KdfError::MissingCodec)?;
        self.codec = Codec::try_from(v.as_slice())?;

        // try to look up the salt in the multikey attributes
        if let Some(v) = mk.attributes.get(&AttrId::KdfSalt) {
            self.salt = Some(v.clone());
        }
        // try to look up the rounds in the multikey attributes
        if let Some(v) = mk.attributes.get(&AttrId::KdfRounds) {
            self.rounds = Some(v.clone());
        }
        Ok(self)
    }

    /// add in the salt bytes for the kdf
    pub fn with_salt(mut self, salt: &impl AsRef<[u8]>) -> Self {
        let s: Vec<u8> = salt.as_ref().into();
        self.salt = Some(s.into());
        self
    }

    /// add a random salt for the kdf
    pub fn with_random_salt(mut self, len: usize, rng: &mut impl CryptoRng) -> Self {
        // heap allocate a buffer to receive the random salt
        let mut buf: Zeroizing<Vec<u8>> = vec![0; len].into();
        rng.fill_bytes(buf.as_mut_slice());
        self.salt = Some(buf);
        self
    }

    /// add in the rounds
    pub fn with_rounds(mut self, rounds: usize) -> Self {
        let r: Vec<u8> = Varuint(rounds).into();
        self.rounds = Some(r.into());
        self
    }

    /// build a key using key bytes
    pub fn try_build(self) -> Result<Multikey, Error> {
        let codec = self.codec;
        let comment = String::default();

        // add the kdf attributes
        let mut attributes = Attributes::new();
        if let Some(salt) = self.salt {
            attributes.insert(AttrId::KdfSalt, salt);
        }
        if let Some(rounds) = self.rounds {
            attributes.insert(AttrId::KdfRounds, rounds);
        }

        Ok(Multikey {
            codec,
            comment,
            attributes,
        })
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::{cipher, Views};

    #[test]
    fn test_bcrypt() {
        let salt = hex::decode("8bb78be51ac7cc98f44e38947ff8a128764ec039b89687a790dfa8444ba97682")
            .unwrap();
        let kdfmk = Builder::new(Codec::BcryptPbkdf)
            .with_rounds(10)
            .with_salt(&salt)
            .try_build()
            .unwrap();

        let nonce = hex::decode("714e5abf0f7beae8").unwrap();
        let ciphermk = cipher::Builder::new(Codec::Chacha20Poly1305)
            .with_nonce(&nonce)
            .try_build()
            .unwrap();

        // get the kdf view
        let kdf = ciphermk.kdf_view(&kdfmk).unwrap();
        // derive a key from the passphrase and add it to the cipher multikey
        let ciphermk = kdf
            .derive_key(b"for great justice, move every zig!")
            .unwrap();

        let kattr = ciphermk.kdf_attr_view().unwrap();
        assert_eq!(Codec::BcryptPbkdf, kattr.kdf_codec().unwrap());
        assert_eq!(salt, kattr.salt_bytes().unwrap().to_vec());
        assert_eq!(10, kattr.rounds().unwrap());

        let kd = ciphermk.data_view().unwrap();
        assert_eq!(
            vec![
                119, 109, 13, 221, 140, 26, 88, 179, 135, 17, 119, 25, 176, 99, 5, 2, 203, 25, 82,
                16, 161, 246, 176, 139, 8, 101, 174, 7, 240, 67, 237, 107
            ],
            kd.secret_bytes().unwrap().to_vec()
        );
    }
}