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
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
use std::{fmt, num::NonZeroU32};
use rand::{self, CryptoRng, RngCore};
use ring::{aead, aead::BoundKey, digest, error::Unspecified, pbkdf2};
use crate::internal::{take_lock, IronOxideErr};
use std::{convert::TryFrom, ops::DerefMut, sync::Mutex};
const PBKDF2_ITERATIONS: NonZeroU32 = unsafe { NonZeroU32::new_unchecked(250_000) };
const PBKDF2_SALT_LEN: usize = 32;
const AES_GCM_TAG_LEN: usize = 16;
const AES_IV_LEN: usize = 12;
const AES_KEY_LEN: usize = 32;
const ENCRYPTED_KEY_AND_GCM_TAG_LEN: usize = AES_KEY_LEN + AES_GCM_TAG_LEN;
pub struct EncryptedMasterKey {
pbkdf2_salt: [u8; PBKDF2_SALT_LEN],
aes_iv: [u8; AES_IV_LEN],
encrypted_key: [u8; ENCRYPTED_KEY_AND_GCM_TAG_LEN],
}
impl fmt::Debug for EncryptedMasterKey {
fn fmt(&self, formatter: &mut fmt::Formatter) -> fmt::Result {
formatter
.debug_struct(stringify!(EncryptedMasterKey))
.field("pbkdf2_salt", &&self.pbkdf2_salt)
.field("aes_iv", &&self.aes_iv)
.field("encrypted_key", &&self.encrypted_key[..])
.finish()
}
}
impl EncryptedMasterKey {
pub const SIZE_BYTES: usize = PBKDF2_SALT_LEN + AES_IV_LEN + ENCRYPTED_KEY_AND_GCM_TAG_LEN;
pub fn new(
pbkdf2_salt: [u8; PBKDF2_SALT_LEN],
aes_iv: [u8; AES_IV_LEN],
encrypted_key: [u8; ENCRYPTED_KEY_AND_GCM_TAG_LEN],
) -> EncryptedMasterKey {
EncryptedMasterKey {
pbkdf2_salt,
aes_iv,
encrypted_key,
}
}
pub fn new_from_slice(bytes: &[u8]) -> Result<EncryptedMasterKey, IronOxideErr> {
if bytes.len() == EncryptedMasterKey::SIZE_BYTES {
let mut pbkdf2_salt = [0u8; PBKDF2_SALT_LEN];
let mut aes_iv = [0u8; AES_IV_LEN];
let mut encrypted_key = [0u8; ENCRYPTED_KEY_AND_GCM_TAG_LEN];
pbkdf2_salt.copy_from_slice(&bytes[..PBKDF2_SALT_LEN]);
aes_iv.copy_from_slice(&bytes[PBKDF2_SALT_LEN..(PBKDF2_SALT_LEN + AES_IV_LEN)]);
encrypted_key.copy_from_slice(&bytes[(PBKDF2_SALT_LEN + AES_IV_LEN)..]);
Ok(EncryptedMasterKey::new(pbkdf2_salt, aes_iv, encrypted_key))
} else {
Err(IronOxideErr::WrongSizeError(
Some(bytes.len()),
Some(EncryptedMasterKey::SIZE_BYTES),
))
}
}
pub fn bytes(&self) -> [u8; EncryptedMasterKey::SIZE_BYTES] {
let mut dest = [0u8; EncryptedMasterKey::SIZE_BYTES];
let vec = [
&self.pbkdf2_salt[..],
&self.aes_iv[..],
&self.encrypted_key[..],
]
.concat();
debug_assert!(dest.len() == vec.len());
dest.copy_from_slice(&vec[..]);
dest
}
}
#[derive(Clone, Debug)]
pub struct AesEncryptedValue {
aes_iv: [u8; AES_IV_LEN],
ciphertext: Vec<u8>,
}
impl AesEncryptedValue {
pub fn bytes(&self) -> Vec<u8> {
[&self.aes_iv[..], &self.ciphertext].concat()
}
}
impl TryFrom<&[u8]> for AesEncryptedValue {
type Error = IronOxideErr;
fn try_from(bytes: &[u8]) -> Result<Self, Self::Error> {
if bytes.len() < (AES_IV_LEN + AES_GCM_TAG_LEN) {
Err(IronOxideErr::AesEncryptedDocSizeError)
} else {
let mut iv: [u8; AES_IV_LEN] = [0u8; AES_IV_LEN];
iv.copy_from_slice(&bytes[..AES_IV_LEN]);
Ok(AesEncryptedValue {
aes_iv: iv,
ciphertext: bytes[AES_IV_LEN..].to_vec(),
})
}
}
}
impl From<ring::error::Unspecified> for IronOxideErr {
fn from(ring_err: Unspecified) -> Self {
IronOxideErr::AesError(ring_err)
}
}
fn derive_key_from_password(password: &str, salt: [u8; PBKDF2_SALT_LEN]) -> [u8; AES_KEY_LEN] {
let mut derived_key = [0u8; digest::SHA256_OUTPUT_LEN];
pbkdf2::derive(
pbkdf2::PBKDF2_HMAC_SHA256,
PBKDF2_ITERATIONS,
&salt,
password.as_bytes(),
&mut derived_key,
);
derived_key
}
pub fn encrypt_user_master_key<R: CryptoRng + RngCore>(
rng: &Mutex<R>,
password: &str,
user_master_key: &[u8; 32],
) -> Result<EncryptedMasterKey, Unspecified> {
let mut salt = [0u8; PBKDF2_SALT_LEN];
take_lock(rng).deref_mut().fill_bytes(&mut salt);
let derived_key = derive_key_from_password(password, salt);
let encrypted_key = encrypt(rng, &user_master_key.to_vec(), derived_key)?;
let mut master_key_ciphertext = [0u8; ENCRYPTED_KEY_AND_GCM_TAG_LEN];
master_key_ciphertext[..].copy_from_slice(&encrypted_key.ciphertext[..]);
Ok(EncryptedMasterKey {
pbkdf2_salt: salt,
aes_iv: encrypted_key.aes_iv,
encrypted_key: master_key_ciphertext,
})
}
pub fn decrypt_user_master_key(
password: &str,
encrypted_master_key: &EncryptedMasterKey,
) -> Result<[u8; 32], Unspecified> {
let derived_key = derive_key_from_password(password, encrypted_master_key.pbkdf2_salt);
let mut fixed_decrypted_master_key = [0u8; 32];
let mut encrypted_key = AesEncryptedValue {
aes_iv: encrypted_master_key.aes_iv,
ciphertext: encrypted_master_key.encrypted_key.to_vec(),
};
let decrypted_master_key = decrypt(&mut encrypted_key, derived_key)?;
fixed_decrypted_master_key[..].copy_from_slice(decrypted_master_key);
Ok(fixed_decrypted_master_key)
}
struct SingleUseNonceGenerator {
iv: Option<[u8; aead::NONCE_LEN]>,
}
impl SingleUseNonceGenerator {
fn new(iv: [u8; aead::NONCE_LEN]) -> SingleUseNonceGenerator {
SingleUseNonceGenerator { iv: Some(iv) }
}
}
impl aead::NonceSequence for SingleUseNonceGenerator {
fn advance(&mut self) -> Result<aead::Nonce, Unspecified> {
self.iv
.take()
.map_or_else(
|| Err(Unspecified),
|iv| Ok(aead::Nonce::assume_unique_for_key(iv)),
)
}
}
pub fn encrypt<R: CryptoRng + RngCore>(
rng: &Mutex<R>,
plaintext: &[u8],
key: [u8; AES_KEY_LEN],
) -> Result<AesEncryptedValue, Unspecified> {
let algorithm = &aead::AES_256_GCM;
let mut iv = [0u8; aead::NONCE_LEN];
take_lock(rng).deref_mut().fill_bytes(&mut iv);
let mut aes_key = aead::SealingKey::new(
aead::UnboundKey::new(algorithm, &key[..])?,
SingleUseNonceGenerator::new(iv),
);
let mut ciphertext = plaintext.to_owned();
aes_key.seal_in_place_append_tag(aead::Aad::empty(), &mut ciphertext)?;
Ok(AesEncryptedValue {
ciphertext,
aes_iv: iv,
})
}
pub async fn encrypt_async<R: CryptoRng + RngCore>(
rng: &Mutex<R>,
plaintext: &[u8],
key: [u8; AES_KEY_LEN],
) -> Result<AesEncryptedValue, IronOxideErr> {
async { encrypt(rng, plaintext, key).map_err(IronOxideErr::from) }.await
}
pub fn decrypt(
encrypted_doc: &mut AesEncryptedValue,
key: [u8; AES_KEY_LEN],
) -> Result<&mut [u8], Unspecified> {
let mut aes_key = aead::OpeningKey::new(
aead::UnboundKey::new(&aead::AES_256_GCM, &key[..])?,
SingleUseNonceGenerator::new(encrypted_doc.aes_iv),
);
let plaintext = aes_key.open_in_place(aead::Aad::empty(), &mut encrypted_doc.ciphertext[..])?;
Ok(plaintext)
}
#[cfg(test)]
mod tests {
use super::*;
use std::{convert::TryInto, sync::Arc};
#[test]
fn test_encrypt_user_master_key() {
let user_master_key = [0u8; 32];
let password = "MyPassword";
let rng = rand::thread_rng();
let encrypted_master_key =
encrypt_user_master_key(&Mutex::new(rng), password, &user_master_key).unwrap();
assert_eq!(encrypted_master_key.pbkdf2_salt.len(), 32);
assert_eq!(encrypted_master_key.aes_iv.len(), 12);
assert_eq!(encrypted_master_key.encrypted_key.len(), 48);
}
#[test]
fn test_decrypt_user_master_key() {
let user_master_key = [0u8; 32];
let password = "MyPassword";
let rng = rand::thread_rng();
let encrypted_master_key =
encrypt_user_master_key(&Mutex::new(rng), password, &user_master_key).unwrap();
let decrypted_master_key =
decrypt_user_master_key(password, &encrypted_master_key).unwrap();
assert_eq!(decrypted_master_key, user_master_key);
}
#[test]
fn test_encrypt() {
let plaintext = vec![1, 2, 3, 4, 5, 6, 7];
let mut key = [0u8; 32];
let mut rng = rand::thread_rng();
rng.fill_bytes(&mut key);
let res = encrypt(&Mutex::new(rng), &plaintext, key).unwrap();
assert_eq!(res.aes_iv.len(), 12);
assert_eq!(
res.ciphertext.len(),
plaintext.len() + aead::AES_256_GCM.tag_len()
);
}
#[test]
fn test_decrypt() {
let plaintext = vec![1, 2, 3, 4, 5, 6, 7];
let mut key = [0u8; 32];
let mut rng = rand::thread_rng();
rng.fill_bytes(&mut key);
let mut encrypted_result = encrypt(&Mutex::new(rng), &plaintext, key).unwrap();
let decrypted_plaintext = decrypt(&mut encrypted_result, key).unwrap();
assert_eq!(*decrypted_plaintext, plaintext[..]);
}
#[test]
fn test_roundtrip_aesencryptedvalue_zero_one_bytes() -> Result<(), IronOxideErr> {
let encrypted_bytes = [0u8; 1 + AES_IV_LEN + AES_GCM_TAG_LEN];
let round_tripped_aes_encrypted_value: AesEncryptedValue =
encrypted_bytes.as_ref().try_into()?;
assert_eq!(round_tripped_aes_encrypted_value.bytes(), encrypted_bytes);
let encrypted_bytes2 = [0u8; AES_IV_LEN + AES_GCM_TAG_LEN];
let round_tripped_aes_encrypted_value: AesEncryptedValue =
encrypted_bytes2.as_ref().try_into()?;
assert_eq!(round_tripped_aes_encrypted_value.bytes(), encrypted_bytes2);
Ok(())
}
#[test]
fn test_parallel_encrypt() {
use rand::SeedableRng;
let plaintext = vec![1, 2, 3, 4, 5, 6, 7];
let mut key = [0u8; 32];
let rng = Mutex::new(rand_chacha::ChaChaRng::from_entropy());
take_lock(&rng).deref_mut().fill_bytes(&mut key);
let a_rng = Arc::new(rng);
let mut threads = vec![];
for _i in 0..100 {
let rng_ref = a_rng.clone();
let pt = plaintext.clone();
threads.push(std::thread::spawn(move || {
let _res = encrypt(&rng_ref, &pt, key).unwrap();
}));
}
let mut joined_count = 0;
for t in threads {
t.join().expect("join failed");
joined_count += 1;
}
assert_eq!(joined_count, 100);
}
}