vendor/openssl/src/pkcs5.rs

   1 use libc::c_int;
   2 use std::ptr;
   3
   4 use crate::cvt;
   5 use crate::error::ErrorStack;
   6 use crate::hash::MessageDigest;
   7 use crate::symm::Cipher;
   8 use openssl_macros::corresponds;
   9
  10 #[derive(Clone, Eq, PartialEq, Hash, Debug)]
  11 pub struct KeyIvPair {
  12     pub key: Vec<u8>,
  13     pub iv: Option<Vec<u8>>,
  14 }
  15
  16 /// Derives a key and an IV from various parameters.
  17 ///
  18 /// If specified, `salt` must be 8 bytes in length.
  19 ///
  20 /// If the total key and IV length is less than 16 bytes and MD5 is used then
  21 /// the algorithm is compatible with the key derivation algorithm from PKCS#5
  22 /// v1.5 or PBKDF1 from PKCS#5 v2.0.
  23 ///
  24 /// New applications should not use this and instead use
  25 /// `pbkdf2_hmac` or another more modern key derivation algorithm.
  26 #[corresponds(EVP_BytesToKey)]
  27 #[allow(clippy::useless_conversion)]
  28 pub fn bytes_to_key(
  29     cipher: Cipher,
  30     digest: MessageDigest,
  31     data: &[u8],
  32     salt: Option<&[u8]>,
  33     count: i32,
  34 ) -> Result<KeyIvPair, ErrorStack> {
  35     unsafe {
  36         assert!(data.len() <= c_int::max_value() as usize);
  37         let salt_ptr = match salt {
  38             Some(salt) => {
  39                 assert_eq!(salt.len(), ffi::PKCS5_SALT_LEN as usize);
  40                 salt.as_ptr()
  41             }
  42             None => ptr::null(),
  43         };
  44
  45         ffi::init();
  46
  47         let mut iv = cipher.iv_len().map(|l| vec![0; l]);
  48
  49         let cipher = cipher.as_ptr();
  50         let digest = digest.as_ptr();
  51
  52         let len = cvt(ffi::EVP_BytesToKey(
  53             cipher,
  54             digest,
  55             salt_ptr,
  56             ptr::null(),
  57             data.len() as c_int,
  58             count.into(),
  59             ptr::null_mut(),
  60             ptr::null_mut(),
  61         ))?;
  62
  63         let mut key = vec![0; len as usize];
  64         let iv_ptr = iv
  65             .as_mut()
  66             .map(|v| v.as_mut_ptr())
  67             .unwrap_or(ptr::null_mut());
  68
  69         cvt(ffi::EVP_BytesToKey(
  70             cipher,
  71             digest,
  72             salt_ptr,
  73             data.as_ptr(),
  74             data.len() as c_int,
  75             count as c_int,
  76             key.as_mut_ptr(),
  77             iv_ptr,
  78         ))?;
  79
  80         Ok(KeyIvPair { key, iv })
  81     }
  82 }
  83
  84 /// Derives a key from a password and salt using the PBKDF2-HMAC algorithm with a digest function.
  85 #[corresponds(PKCS5_PBKDF2_HMAC)]
  86 pub fn pbkdf2_hmac(
  87     pass: &[u8],
  88     salt: &[u8],
  89     iter: usize,
  90     hash: MessageDigest,
  91     key: &mut [u8],
  92 ) -> Result<(), ErrorStack> {
  93     unsafe {
  94         assert!(pass.len() <= c_int::max_value() as usize);
  95         assert!(salt.len() <= c_int::max_value() as usize);
  96         assert!(key.len() <= c_int::max_value() as usize);
  97
  98         ffi::init();
  99         cvt(ffi::PKCS5_PBKDF2_HMAC(
 100             pass.as_ptr() as *const _,
 101             pass.len() as c_int,
 102             salt.as_ptr(),
 103             salt.len() as c_int,
 104             iter as c_int,
 105             hash.as_ptr(),
 106             key.len() as c_int,
 107             key.as_mut_ptr(),
 108         ))
 109         .map(|_| ())
 110     }
 111 }
 112
 113 /// Derives a key from a password and salt using the scrypt algorithm.
 114 ///
 115 /// Requires OpenSSL 1.1.0 or newer.
 116 #[corresponds(EVP_PBE_scrypt)]
 117 #[cfg(any(ossl110))]
 118 pub fn scrypt(
 119     pass: &[u8],
 120     salt: &[u8],
 121     n: u64,
 122     r: u64,
 123     p: u64,
 124     maxmem: u64,
 125     key: &mut [u8],
 126 ) -> Result<(), ErrorStack> {
 127     unsafe {
 128         ffi::init();
 129         cvt(ffi::EVP_PBE_scrypt(
 130             pass.as_ptr() as *const _,
 131             pass.len(),
 132             salt.as_ptr() as *const _,
 133             salt.len(),
 134             n,
 135             r,
 136             p,
 137             maxmem,
 138             key.as_mut_ptr() as *mut _,
 139             key.len(),
 140         ))
 141         .map(|_| ())
 142     }
 143 }
 144
 145 #[cfg(test)]
 146 mod tests {
 147     use crate::hash::MessageDigest;
 148     use crate::symm::Cipher;
 149
 150     // Test vectors from
 151     // https://git.lysator.liu.se/nettle/nettle/blob/nettle_3.1.1_release_20150424/testsuite/pbkdf2-test.c
 152     #[test]
 153     fn pbkdf2_hmac_sha256() {
 154         let mut buf = [0; 16];
 155
 156         super::pbkdf2_hmac(b"passwd", b"salt", 1, MessageDigest::sha256(), &mut buf).unwrap();
 157         assert_eq!(
 158             buf,
 159             &[
 160                 0x55_u8, 0xac_u8, 0x04_u8, 0x6e_u8, 0x56_u8, 0xe3_u8, 0x08_u8, 0x9f_u8, 0xec_u8,
 161                 0x16_u8, 0x91_u8, 0xc2_u8, 0x25_u8, 0x44_u8, 0xb6_u8, 0x05_u8,
 162             ][..]
 163         );
 164
 165         super::pbkdf2_hmac(
 166             b"Password",
 167             b"NaCl",
 168             80000,
 169             MessageDigest::sha256(),
 170             &mut buf,
 171         )
 172         .unwrap();
 173         assert_eq!(
 174             buf,
 175             &[
 176                 0x4d_u8, 0xdc_u8, 0xd8_u8, 0xf6_u8, 0x0b_u8, 0x98_u8, 0xbe_u8, 0x21_u8, 0x83_u8,
 177                 0x0c_u8, 0xee_u8, 0x5e_u8, 0xf2_u8, 0x27_u8, 0x01_u8, 0xf9_u8,
 178             ][..]
 179         );
 180     }
 181
 182     // Test vectors from
 183     // https://git.lysator.liu.se/nettle/nettle/blob/nettle_3.1.1_release_20150424/testsuite/pbkdf2-test.c
 184     #[test]
 185     fn pbkdf2_hmac_sha512() {
 186         let mut buf = [0; 64];
 187
 188         super::pbkdf2_hmac(b"password", b"NaCL", 1, MessageDigest::sha512(), &mut buf).unwrap();
 189         assert_eq!(
 190             &buf[..],
 191             &[
 192                 0x73_u8, 0xde_u8, 0xcf_u8, 0xa5_u8, 0x8a_u8, 0xa2_u8, 0xe8_u8, 0x4f_u8, 0x94_u8,
 193                 0x77_u8, 0x1a_u8, 0x75_u8, 0x73_u8, 0x6b_u8, 0xb8_u8, 0x8b_u8, 0xd3_u8, 0xc7_u8,
 194                 0xb3_u8, 0x82_u8, 0x70_u8, 0xcf_u8, 0xb5_u8, 0x0c_u8, 0xb3_u8, 0x90_u8, 0xed_u8,
 195                 0x78_u8, 0xb3_u8, 0x05_u8, 0x65_u8, 0x6a_u8, 0xf8_u8, 0x14_u8, 0x8e_u8, 0x52_u8,
 196                 0x45_u8, 0x2b_u8, 0x22_u8, 0x16_u8, 0xb2_u8, 0xb8_u8, 0x09_u8, 0x8b_u8, 0x76_u8,
 197                 0x1f_u8, 0xc6_u8, 0x33_u8, 0x60_u8, 0x60_u8, 0xa0_u8, 0x9f_u8, 0x76_u8, 0x41_u8,
 198                 0x5e_u8, 0x9f_u8, 0x71_u8, 0xea_u8, 0x47_u8, 0xf9_u8, 0xe9_u8, 0x06_u8, 0x43_u8,
 199                 0x06_u8,
 200             ][..]
 201         );
 202
 203         super::pbkdf2_hmac(
 204             b"pass\0word",
 205             b"sa\0lt",
 206             1,
 207             MessageDigest::sha512(),
 208             &mut buf,
 209         )
 210         .unwrap();
 211         assert_eq!(
 212             &buf[..],
 213             &[
 214                 0x71_u8, 0xa0_u8, 0xec_u8, 0x84_u8, 0x2a_u8, 0xbd_u8, 0x5c_u8, 0x67_u8, 0x8b_u8,
 215                 0xcf_u8, 0xd1_u8, 0x45_u8, 0xf0_u8, 0x9d_u8, 0x83_u8, 0x52_u8, 0x2f_u8, 0x93_u8,
 216                 0x36_u8, 0x15_u8, 0x60_u8, 0x56_u8, 0x3c_u8, 0x4d_u8, 0x0d_u8, 0x63_u8, 0xb8_u8,
 217                 0x83_u8, 0x29_u8, 0x87_u8, 0x10_u8, 0x90_u8, 0xe7_u8, 0x66_u8, 0x04_u8, 0xa4_u8,
 218                 0x9a_u8, 0xf0_u8, 0x8f_u8, 0xe7_u8, 0xc9_u8, 0xf5_u8, 0x71_u8, 0x56_u8, 0xc8_u8,
 219                 0x79_u8, 0x09_u8, 0x96_u8, 0xb2_u8, 0x0f_u8, 0x06_u8, 0xbc_u8, 0x53_u8, 0x5e_u8,
 220                 0x5a_u8, 0xb5_u8, 0x44_u8, 0x0d_u8, 0xf7_u8, 0xe8_u8, 0x78_u8, 0x29_u8, 0x6f_u8,
 221                 0xa7_u8,
 222             ][..]
 223         );
 224
 225         super::pbkdf2_hmac(
 226             b"passwordPASSWORDpassword",
 227             b"salt\0\0\0",
 228             50,
 229             MessageDigest::sha512(),
 230             &mut buf,
 231         )
 232         .unwrap();
 233         assert_eq!(
 234             &buf[..],
 235             &[
 236                 0x01_u8, 0x68_u8, 0x71_u8, 0xa4_u8, 0xc4_u8, 0xb7_u8, 0x5f_u8, 0x96_u8, 0x85_u8,
 237                 0x7f_u8, 0xd2_u8, 0xb9_u8, 0xf8_u8, 0xca_u8, 0x28_u8, 0x02_u8, 0x3b_u8, 0x30_u8,
 238                 0xee_u8, 0x2a_u8, 0x39_u8, 0xf5_u8, 0xad_u8, 0xca_u8, 0xc8_u8, 0xc9_u8, 0x37_u8,
 239                 0x5f_u8, 0x9b_u8, 0xda_u8, 0x1c_u8, 0xcd_u8, 0x1b_u8, 0x6f_u8, 0x0b_u8, 0x2f_u8,
 240                 0xc3_u8, 0xad_u8, 0xda_u8, 0x50_u8, 0x54_u8, 0x12_u8, 0xe7_u8, 0x9d_u8, 0x89_u8,
 241                 0x00_u8, 0x56_u8, 0xc6_u8, 0x2e_u8, 0x52_u8, 0x4c_u8, 0x7d_u8, 0x51_u8, 0x15_u8,
 242                 0x4b_u8, 0x1a_u8, 0x85_u8, 0x34_u8, 0x57_u8, 0x5b_u8, 0xd0_u8, 0x2d_u8, 0xee_u8,
 243                 0x39_u8,
 244             ][..]
 245         );
 246     }
 247
 248     #[test]
 249     fn bytes_to_key() {
 250         let salt = [16_u8, 34_u8, 19_u8, 23_u8, 141_u8, 4_u8, 207_u8, 221_u8];
 251
 252         let data = [
 253             143_u8, 210_u8, 75_u8, 63_u8, 214_u8, 179_u8, 155_u8, 241_u8, 242_u8, 31_u8, 154_u8,
 254             56_u8, 198_u8, 145_u8, 192_u8, 64_u8, 2_u8, 245_u8, 167_u8, 220_u8, 55_u8, 119_u8,
 255             233_u8, 136_u8, 139_u8, 27_u8, 71_u8, 242_u8, 119_u8, 175_u8, 65_u8, 207_u8,
 256         ];
 257
 258         let expected_key = vec![
 259             249_u8, 115_u8, 114_u8, 97_u8, 32_u8, 213_u8, 165_u8, 146_u8, 58_u8, 87_u8, 234_u8,
 260             3_u8, 43_u8, 250_u8, 97_u8, 114_u8, 26_u8, 98_u8, 245_u8, 246_u8, 238_u8, 177_u8,
 261             229_u8, 161_u8, 183_u8, 224_u8, 174_u8, 3_u8, 6_u8, 244_u8, 236_u8, 255_u8,
 262         ];
 263         let expected_iv = vec![
 264             4_u8, 223_u8, 153_u8, 219_u8, 28_u8, 142_u8, 234_u8, 68_u8, 227_u8, 69_u8, 98_u8,
 265             107_u8, 208_u8, 14_u8, 236_u8, 60_u8,
 266         ];
 267
 268         assert_eq!(
 269             super::bytes_to_key(
 270                 Cipher::aes_256_cbc(),
 271                 MessageDigest::sha1(),
 272                 &data,
 273                 Some(&salt),
 274                 1,
 275             )
 276             .unwrap(),
 277             super::KeyIvPair {
 278                 key: expected_key,
 279                 iv: Some(expected_iv),
 280             }
 281         );
 282     }
 283
 284     #[test]
 285     #[cfg(any(ossl110))]
 286     fn scrypt() {
 287         let pass = "pleaseletmein";
 288         let salt = "SodiumChloride";
 289         let expected =
 290             "7023bdcb3afd7348461c06cd81fd38ebfda8fbba904f8e3ea9b543f6545da1f2d5432955613\
 291              f0fcf62d49705242a9af9e61e85dc0d651e40dfcf017b45575887";
 292
 293         let mut actual = [0; 64];
 294         super::scrypt(
 295             pass.as_bytes(),
 296             salt.as_bytes(),
 297             16384,
 298             8,
 299             1,
 300             0,
 301             &mut actual,
 302         )
 303         .unwrap();
 304         assert_eq!(hex::encode(&actual[..]), expected);
 305     }
 306 }