bitwarden_crypto/keys/
shareable_key.rs

1use std::pin::Pin;
2
3use generic_array::GenericArray;
4use hmac::Mac;
5use typenum::{U32, U64};
6use zeroize::{Zeroize, Zeroizing};
7
8use super::Aes256CbcHmacKey;
9use crate::util::{PbkdfSha256Hmac, hkdf_expand};
10
11/// Derive a shareable key using hkdf from secret and name.
12///
13/// A specialized variant of this function was called `CryptoService.makeSendKey` in the Bitwarden
14/// `clients` repository.
15pub fn derive_shareable_key(
16    secret: Zeroizing<[u8; 16]>,
17    name: &str,
18    info: Option<&str>,
19) -> Aes256CbcHmacKey {
20    // Because all inputs are fixed size, we can unwrap all errors here without issue
21    let res = Zeroizing::new(
22        PbkdfSha256Hmac::new_from_slice(format!("bitwarden-{name}").as_bytes())
23            .expect("hmac new_from_slice should not fail")
24            .chain_update(secret)
25            .finalize()
26            .into_bytes(),
27    );
28
29    let mut key: Pin<Box<GenericArray<u8, U64>>> =
30        hkdf_expand(&res, info).expect("Input is a valid size");
31    let enc_key = Box::pin(GenericArray::<u8, U32>::clone_from_slice(&key[..32]));
32    let mac_key = Box::pin(GenericArray::<u8, U32>::clone_from_slice(&key[32..]));
33    key.zeroize();
34    Aes256CbcHmacKey { enc_key, mac_key }
35}
36
37#[cfg(test)]
38mod tests {
39    use zeroize::Zeroizing;
40
41    use super::derive_shareable_key;
42    use crate::SymmetricCryptoKey;
43
44    #[test]
45    fn test_derive_shareable_key() {
46        let key = derive_shareable_key(Zeroizing::new(*b"&/$%F1a895g67HlX"), "test_key", None);
47        assert_eq!(
48            SymmetricCryptoKey::Aes256CbcHmacKey(key)
49                .to_base64()
50                .to_string(),
51            "4PV6+PcmF2w7YHRatvyMcVQtI7zvCyssv/wFWmzjiH6Iv9altjmDkuBD1aagLVaLezbthbSe+ktR+U6qswxNnQ=="
52        );
53
54        let key = derive_shareable_key(
55            Zeroizing::new(*b"67t9b5g67$%Dh89n"),
56            "test_key",
57            Some("test"),
58        );
59        assert_eq!(
60            SymmetricCryptoKey::Aes256CbcHmacKey(key)
61                .to_base64()
62                .to_string(),
63            "F9jVQmrACGx9VUPjuzfMYDjr726JtL300Y3Yg+VYUnVQtQ1s8oImJ5xtp1KALC9h2nav04++1LDW4iFD+infng=="
64        );
65    }
66}