vendor/openssl/src/pkcs5.rs

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