rust-keyvault 0.2.1

A secure, modern cryptographic key management library for Rust
Documentation
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
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
//! Concurrency and thread-safety tests for rust-keyvault
//!
//! These integration tests verify:
//! - Thread-safe concurrent operations
//! - Race condition handling
//! - Deadlock prevention
//! - Data consistency under load

use rust_keyvault::{
    key::{SecretKey, VersionedKey},
    storage::{FileStore, KeyStore, MemoryStore, StorageConfig},
    Algorithm, KeyId, KeyMetadata, KeyState,
};
use std::sync::{Arc, Barrier, Mutex};
use std::thread;
use std::time::{Duration, SystemTime};
use tempfile::tempdir;

/// Test concurrent reads from MemoryStore
/// Multiple threads should be able to read simultaneously without blocking
#[test]
fn test_memory_store_concurrent_reads() {
    let store = Arc::new(Mutex::new(MemoryStore::new()));

    // Create and store a test key
    let key_id = KeyId::generate_base().unwrap();
    let secret_key = SecretKey::generate(Algorithm::ChaCha20Poly1305).unwrap();
    let metadata = KeyMetadata {
        id: key_id.clone(),
        base_id: key_id.clone(),
        algorithm: Algorithm::ChaCha20Poly1305,
        created_at: SystemTime::now(),
        expires_at: None,
        state: KeyState::Active,
        version: 1,
    };

    // Store the key (MemoryStore has interior mutability via RwLock)
    {
        let mut store_locked = store.lock().unwrap();
        store_locked
            .store(VersionedKey {
                key: secret_key,
                metadata,
            })
            .unwrap();
    }

    // Spawn multiple reader threads
    let num_threads = 10;
    let barrier = Arc::new(Barrier::new(num_threads));

    let handles: Vec<_> = (0..num_threads)
        .map(|i| {
            let store_clone = Arc::clone(&store);
            let id_clone = key_id.clone();
            let barrier_clone = Arc::clone(&barrier);

            thread::spawn(move || {
                // Wait for all threads to be ready
                barrier_clone.wait();

                // Perform concurrent reads
                for _ in 0..100 {
                    let store_locked = store_clone.lock().unwrap();
                    let result = store_locked.retrieve(&id_clone);
                    drop(store_locked);
                    assert!(result.is_ok(), "Thread {} failed to read", i);
                }
            })
        })
        .collect();

    // Wait for all threads to complete
    for handle in handles {
        handle.join().unwrap();
    }
}

/// Test concurrent writes to MemoryStore
/// Writes should be properly serialized without data races
#[test]
fn test_memory_store_concurrent_writes() {
    let store = Arc::new(Mutex::new(MemoryStore::new()));
    let num_threads = 10;
    let keys_per_thread = 10;

    let barrier = Arc::new(Barrier::new(num_threads));

    let handles: Vec<_> = (0..num_threads)
        .map(|thread_id| {
            let store_clone = Arc::clone(&store);
            let barrier_clone = Arc::clone(&barrier);

            thread::spawn(move || {
                barrier_clone.wait();

                // Each thread creates its own keys
                for key_num in 0..keys_per_thread {
                    let mut id_bytes = [0u8; 16];
                    id_bytes[0] = thread_id as u8;
                    id_bytes[1] = key_num as u8;
                    let key_id = KeyId::from_bytes(id_bytes);

                    let secret_key = SecretKey::generate(Algorithm::ChaCha20Poly1305).unwrap();
                    let metadata = KeyMetadata {
                        id: key_id.clone(),
                        base_id: key_id.clone(),
                        algorithm: Algorithm::ChaCha20Poly1305,
                        created_at: SystemTime::now(),
                        expires_at: None,
                        state: KeyState::Active,
                        version: 1,
                    };

                    let mut store_locked = store_clone.lock().unwrap();
                    let result = store_locked.store(VersionedKey {
                        key: secret_key,
                        metadata,
                    });
                    drop(store_locked); // Release lock
                    assert!(
                        result.is_ok(),
                        "Thread {} key {} failed to store",
                        thread_id,
                        key_num
                    );
                }
            })
        })
        .collect();

    for handle in handles {
        handle.join().unwrap();
    }

    // Verify all keys were stored
    let expected_count = num_threads * keys_per_thread;
    let store_locked = store.lock().unwrap();
    let actual_count = store_locked.list().unwrap().len();
    assert_eq!(
        actual_count, expected_count,
        "Expected {} keys, found {}",
        expected_count, actual_count
    );
}

/// Test concurrent reads and writes to MemoryStore
/// Readers and writers should not block each other excessively
#[test]
fn test_memory_store_mixed_operations() {
    let store = Arc::new(Mutex::new(MemoryStore::new()));

    // Pre-populate with some keys
    {
        let mut store_locked = store.lock().unwrap();
        for i in 0..10 {
            let mut id_bytes = [0u8; 16];
            id_bytes[0] = i;
            let key_id = KeyId::from_bytes(id_bytes);

            let secret_key = SecretKey::generate(Algorithm::ChaCha20Poly1305).unwrap();
            let metadata = KeyMetadata {
                id: key_id.clone(),
                base_id: key_id.clone(),
                algorithm: Algorithm::ChaCha20Poly1305,
                created_at: SystemTime::now(),
                expires_at: None,
                state: KeyState::Active,
                version: 1,
            };

            store_locked
                .store(VersionedKey {
                    key: secret_key,
                    metadata,
                })
                .unwrap();
        }
    }

    let num_readers = 5;
    let num_writers = 5;
    let barrier = Arc::new(Barrier::new(num_readers + num_writers));

    // Spawn reader threads
    let mut handles = vec![];
    for i in 0..num_readers {
        let store_clone = Arc::clone(&store);
        let barrier_clone = Arc::clone(&barrier);

        let handle = thread::spawn(move || {
            barrier_clone.wait();

            let mut id_bytes = [0u8; 16];
            id_bytes[0] = (i % 10) as u8;
            let key_id = KeyId::from_bytes(id_bytes);

            for _ in 0..50 {
                let store_locked = store_clone.lock().unwrap();
                let _ = store_locked.retrieve(&key_id);
                drop(store_locked);
                thread::sleep(Duration::from_micros(10));
            }
        });
        handles.push(handle);
    }

    // Spawn writer threads
    for i in 0..num_writers {
        let store_clone = Arc::clone(&store);
        let barrier_clone = Arc::clone(&barrier);

        let handle = thread::spawn(move || {
            barrier_clone.wait();

            for j in 0..50 {
                let mut id_bytes = [0u8; 16];
                id_bytes[0] = 100 + i as u8;
                id_bytes[1] = j as u8;
                let key_id = KeyId::from_bytes(id_bytes);

                let secret_key = SecretKey::generate(Algorithm::ChaCha20Poly1305).unwrap();
                let metadata = KeyMetadata {
                    id: key_id.clone(),
                    base_id: key_id.clone(),
                    algorithm: Algorithm::ChaCha20Poly1305,
                    created_at: SystemTime::now(),
                    expires_at: None,
                    state: KeyState::Active,
                    version: 1,
                };

                let mut store_locked = store_clone.lock().unwrap();
                let _ = store_locked.store(VersionedKey {
                    key: secret_key,
                    metadata,
                });
                drop(store_locked);
                thread::sleep(Duration::from_micros(10));
            }
        });
        handles.push(handle);
    }

    // Wait for all threads
    for handle in handles {
        handle.join().unwrap();
    }
}

/// Test concurrent operations on FileStore
/// FileStore uses interior mutability and should handle concurrent access
#[test]
fn test_file_store_concurrent_operations() {
    let temp_dir = tempdir().unwrap();
    let config = StorageConfig::default();
    let store = Arc::new(std::sync::Mutex::new(
        FileStore::new(temp_dir.path(), config).unwrap(),
    ));

    let num_threads = 5;
    let keys_per_thread = 5;
    let barrier = Arc::new(Barrier::new(num_threads));

    let handles: Vec<_> = (0..num_threads)
        .map(|thread_id| {
            let store_clone = Arc::clone(&store);
            let barrier_clone = Arc::clone(&barrier);

            thread::spawn(move || {
                barrier_clone.wait();

                for key_num in 0..keys_per_thread {
                    let mut id_bytes = [0u8; 16];
                    id_bytes[0] = thread_id as u8;
                    id_bytes[1] = key_num as u8;
                    let key_id = KeyId::from_bytes(id_bytes);

                    let secret_key = SecretKey::generate(Algorithm::ChaCha20Poly1305).unwrap();
                    let metadata = KeyMetadata {
                        id: key_id.clone(),
                        base_id: key_id.clone(),
                        algorithm: Algorithm::ChaCha20Poly1305,
                        created_at: SystemTime::now(),
                        expires_at: None,
                        state: KeyState::Active,
                        version: 1,
                    };

                    // Lock for write
                    {
                        let mut store = store_clone.lock().unwrap();
                        store
                            .store(VersionedKey {
                                key: secret_key,
                                metadata,
                            })
                            .unwrap();
                    }

                    // Lock for read
                    {
                        let store = store_clone.lock().unwrap();
                        let retrieved = store.retrieve(&key_id).unwrap();
                        assert_eq!(retrieved.metadata.id, key_id);
                    }

                    thread::sleep(Duration::from_micros(100));
                }
            })
        })
        .collect();

    for handle in handles {
        handle.join().unwrap();
    }

    // Verify all keys were stored
    let store = store.lock().unwrap();
    let keys = store.list().unwrap();
    assert_eq!(keys.len(), num_threads * keys_per_thread);
}

/// Stress test: High-volume concurrent operations
#[test]
fn test_memory_store_stress() {
    let store = Arc::new(Mutex::new(MemoryStore::new()));
    let num_threads = 20;
    let operations_per_thread = 100;

    let barrier = Arc::new(Barrier::new(num_threads));

    let handles: Vec<_> = (0..num_threads)
        .map(|thread_id| {
            let store_clone = Arc::clone(&store);
            let barrier_clone = Arc::clone(&barrier);

            thread::spawn(move || {
                barrier_clone.wait();

                for op in 0..operations_per_thread {
                    let mut id_bytes = [0u8; 16];
                    id_bytes[0] = thread_id as u8;
                    id_bytes[1] = (op % 256) as u8;
                    let key_id = KeyId::from_bytes(id_bytes);

                    // Mix of operations
                    match op % 4 {
                        0 => {
                            // Store
                            let secret_key =
                                SecretKey::generate(Algorithm::ChaCha20Poly1305).unwrap();
                            let metadata = KeyMetadata {
                                id: key_id.clone(),
                                base_id: key_id.clone(),
                                algorithm: Algorithm::ChaCha20Poly1305,
                                created_at: SystemTime::now(),
                                expires_at: None,
                                state: KeyState::Active,
                                version: 1,
                            };
                            let mut store_locked = store_clone.lock().unwrap();
                            let _ = store_locked.store(VersionedKey {
                                key: secret_key,
                                metadata,
                            });
                        }
                        1 => {
                            // Retrieve
                            let store_locked = store_clone.lock().unwrap();
                            let _ = store_locked.retrieve(&key_id);
                        }
                        2 => {
                            // List
                            let store_locked = store_clone.lock().unwrap();
                            let _ = store_locked.list();
                        }
                        3 => {
                            // Delete (if exists)
                            let mut store_locked = store_clone.lock().unwrap();
                            let _ = store_locked.delete(&key_id);
                        }
                        _ => unreachable!(),
                    }
                }
            })
        })
        .collect();

    for handle in handles {
        handle.join().unwrap();
    }

    // Store should still be functional after stress
    let store_locked = store.lock().unwrap();
    let keys = store_locked.list().unwrap();
    println!("Stress test completed. Final key count: {}", keys.len());
}

/// Test that no deadlocks occur with complex operation sequences
#[test]
fn test_no_deadlocks() {
    let store = Arc::new(Mutex::new(MemoryStore::new()));
    let num_threads = 10;
    let timeout = Duration::from_secs(5);

    let barrier = Arc::new(Barrier::new(num_threads));

    let handles: Vec<_> = (0..num_threads)
        .map(|thread_id| {
            let store_clone = Arc::clone(&store);
            let barrier_clone = Arc::clone(&barrier);

            thread::spawn(move || {
                barrier_clone.wait();

                for i in 0..20 {
                    let mut id_bytes = [0u8; 16];
                    id_bytes[0] = ((thread_id + i) % 10) as u8;
                    let key_id = KeyId::from_bytes(id_bytes);

                    // Complex sequence: store, retrieve, list, delete
                    let secret_key = SecretKey::generate(Algorithm::ChaCha20Poly1305).unwrap();
                    let metadata = KeyMetadata {
                        id: key_id.clone(),
                        base_id: key_id.clone(),
                        algorithm: Algorithm::ChaCha20Poly1305,
                        created_at: SystemTime::now(),
                        expires_at: None,
                        state: KeyState::Active,
                        version: 1,
                    };

                    {
                        let mut store_locked = store_clone.lock().unwrap();
                        let _ = store_locked.store(VersionedKey {
                            key: secret_key,
                            metadata,
                        });
                    }
                    {
                        let store_locked = store_clone.lock().unwrap();
                        let _ = store_locked.retrieve(&key_id);
                    }
                    {
                        let store_locked = store_clone.lock().unwrap();
                        let _ = store_locked.list();
                    }
                    thread::sleep(Duration::from_micros(50));
                }
            })
        })
        .collect();

    // Wait with timeout to detect deadlocks
    let start = std::time::Instant::now();
    for handle in handles {
        handle.join().unwrap();
    }
    let elapsed = start.elapsed();

    assert!(
        elapsed < timeout,
        "Test took too long - possible deadlock detected"
    );
}

/// Test concurrent export/import operations
#[test]
fn test_concurrent_export_import() {
    // ⚠️ NOTE: This test takes ~15-20 seconds due to Argon2id password derivation
    // Each export_key() operation takes ~2.5s (intentional security feature)
    // Due to lock contention, exports run mostly sequentially
    // 3 threads × 1 iteration × 2.5s ≈ 7-8 seconds + overhead
    let temp_dir = tempdir().unwrap();
    let config = StorageConfig::default();
    let store = Arc::new(std::sync::Mutex::new(
        FileStore::new(temp_dir.path(), config).unwrap(),
    ));

    // Pre-populate with keys
    {
        let mut s = store.lock().unwrap();
        for i in 0..3 {
            // Reduced from 5 to 3
            let mut id_bytes = [0u8; 16];
            id_bytes[0] = i;
            let key_id = KeyId::from_bytes(id_bytes);

            let secret_key = SecretKey::generate(Algorithm::ChaCha20Poly1305).unwrap();
            let metadata = KeyMetadata {
                id: key_id.clone(),
                base_id: key_id.clone(),
                algorithm: Algorithm::ChaCha20Poly1305,
                created_at: SystemTime::now(),
                expires_at: None,
                state: KeyState::Active,
                version: 1,
            };

            s.store(VersionedKey {
                key: secret_key,
                metadata,
            })
            .unwrap();
        }
    }

    let num_threads = 3; // Reduced from 5 to 3
    let barrier = Arc::new(Barrier::new(num_threads));

    let handles: Vec<_> = (0..num_threads)
        .map(|i| {
            let store_clone = Arc::clone(&store);
            let barrier_clone = Arc::clone(&barrier);

            thread::spawn(move || {
                barrier_clone.wait();

                let mut id_bytes = [0u8; 16];
                id_bytes[0] = i as u8;
                let key_id = KeyId::from_bytes(id_bytes);

                // Only 1 iteration per thread to keep test time reasonable
                // (Argon2 is intentionally slow at ~2.5s per export)
                let mut store = store_clone.lock().unwrap();
                let exported = store.export_key(&key_id, b"test-password").unwrap();
                drop(store); // Release lock

                // Verify can deserialize
                let json = exported.to_json().unwrap();
                let _ = rust_keyvault::export::ExportedKey::from_json(&json).unwrap();
            })
        })
        .collect();

    for handle in handles {
        handle.join().unwrap();
    }
}