oxigeo-security 0.2.2

Enterprise security features for OxiGeo: encryption, access control, compliance
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
//! Key management and rotation.

use crate::encryption::{AtRestEncryptor, EncryptedData, EncryptionAlgorithm};
use crate::error::{Result, SecurityError};
use chrono::{DateTime, Utc};
use dashmap::DashMap;
use serde::{Deserialize, Serialize};
use std::path::Path;
use std::sync::Arc;
use uuid::Uuid;

/// A single persisted key entry.
#[derive(Debug, Clone, Serialize, Deserialize)]
struct PersistedKey {
    key_id: String,
    key: Vec<u8>,
    metadata: KeyMetadata,
}

/// A serializable snapshot of the whole keystore, used for encrypted persistence.
#[derive(Debug, Clone, Serialize, Deserialize)]
struct KeystoreSnapshot {
    current_key_id: Option<String>,
    keys: Vec<PersistedKey>,
}

/// Key metadata.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct KeyMetadata {
    /// Key ID.
    pub key_id: String,
    /// Algorithm.
    pub algorithm: EncryptionAlgorithm,
    /// Created at.
    pub created_at: DateTime<Utc>,
    /// Expires at.
    pub expires_at: Option<DateTime<Utc>>,
    /// Rotation period in days.
    pub rotation_period_days: Option<u32>,
    /// Whether the key is active.
    pub active: bool,
    /// Key version.
    pub version: u32,
}

impl KeyMetadata {
    /// Create new key metadata.
    pub fn new(
        key_id: String,
        algorithm: EncryptionAlgorithm,
        rotation_period_days: Option<u32>,
    ) -> Self {
        let expires_at =
            rotation_period_days.map(|days| Utc::now() + chrono::Duration::days(days as i64));

        Self {
            key_id,
            algorithm,
            created_at: Utc::now(),
            expires_at,
            rotation_period_days,
            active: true,
            version: 1,
        }
    }

    /// Check if the key is expired.
    pub fn is_expired(&self) -> bool {
        self.expires_at.is_some_and(|exp| Utc::now() > exp)
    }

    /// Check if the key needs rotation (within 7 days of expiration).
    pub fn needs_rotation(&self) -> bool {
        self.expires_at
            .is_some_and(|exp| Utc::now() + chrono::Duration::days(7) > exp)
    }
}

/// Key manager for storing and rotating encryption keys.
///
/// By default keys live only in memory: a process restart loses every key generated via
/// [`KeyManager::generate_key`]/[`KeyManager::rotate_key`] (and any data encrypted under
/// them). For durability, persist the keystore with [`KeyManager::save_to_file`] (each key is
/// encrypted under a caller-supplied master key / KEK — which may itself come from an external
/// KMS) and restore it with [`KeyManager::load_from_file`].
pub struct KeyManager {
    keys: Arc<DashMap<String, (Vec<u8>, KeyMetadata)>>,
    current_key_id: Arc<parking_lot::RwLock<Option<String>>>,
}

impl KeyManager {
    /// Create a new key manager.
    pub fn new() -> Self {
        Self {
            keys: Arc::new(DashMap::new()),
            current_key_id: Arc::new(parking_lot::RwLock::new(None)),
        }
    }

    /// Generate a new key.
    pub fn generate_key(
        &self,
        algorithm: EncryptionAlgorithm,
        rotation_period_days: Option<u32>,
    ) -> Result<String> {
        let key_id = Uuid::new_v4().to_string();
        let key = AtRestEncryptor::generate_key(algorithm)?;
        let metadata = KeyMetadata::new(key_id.clone(), algorithm, rotation_period_days);

        self.keys.insert(key_id.clone(), (key, metadata));

        // Set as current key if no current key exists
        {
            let mut current = self.current_key_id.write();
            if current.is_none() {
                *current = Some(key_id.clone());
            }
        }

        Ok(key_id)
    }

    /// Add an existing key.
    pub fn add_key(
        &self,
        key_id: String,
        key: Vec<u8>,
        algorithm: EncryptionAlgorithm,
        rotation_period_days: Option<u32>,
    ) -> Result<()> {
        let metadata = KeyMetadata::new(key_id.clone(), algorithm, rotation_period_days);
        self.keys.insert(key_id, (key, metadata));
        Ok(())
    }

    /// Get a key by ID.
    pub fn get_key(&self, key_id: &str) -> Result<(Vec<u8>, KeyMetadata)> {
        self.keys
            .get(key_id)
            .map(|entry| entry.value().clone())
            .ok_or_else(|| SecurityError::key_management(format!("Key not found: {}", key_id)))
    }

    /// Get the current active key.
    pub fn get_current_key(&self) -> Result<(String, Vec<u8>, KeyMetadata)> {
        let current_id = self
            .current_key_id
            .read()
            .clone()
            .ok_or_else(|| SecurityError::key_management("No current key set"))?;

        let (key, metadata) = self.get_key(&current_id)?;
        Ok((current_id, key, metadata))
    }

    /// Set the current active key.
    pub fn set_current_key(&self, key_id: String) -> Result<()> {
        // Verify key exists
        if !self.keys.contains_key(&key_id) {
            return Err(SecurityError::key_management(format!(
                "Key not found: {}",
                key_id
            )));
        }

        let mut current = self.current_key_id.write();
        *current = Some(key_id);
        Ok(())
    }

    /// Rotate the current key.
    pub fn rotate_key(&self) -> Result<String> {
        let (current_id, _, metadata) = self.get_current_key()?;

        // Generate new key with same parameters
        let new_key_id = self.generate_key(metadata.algorithm, metadata.rotation_period_days)?;

        // Deactivate old key
        if let Some(mut entry) = self.keys.get_mut(&current_id) {
            entry.value_mut().1.active = false;
        }

        // Set new key as current
        self.set_current_key(new_key_id.clone())?;

        Ok(new_key_id)
    }

    /// List all keys.
    pub fn list_keys(&self) -> Vec<(String, KeyMetadata)> {
        self.keys
            .iter()
            .map(|entry| (entry.key().clone(), entry.value().1.clone()))
            .collect()
    }

    /// List expired keys.
    pub fn list_expired_keys(&self) -> Vec<(String, KeyMetadata)> {
        self.keys
            .iter()
            .filter(|entry| entry.value().1.is_expired())
            .map(|entry| (entry.key().clone(), entry.value().1.clone()))
            .collect()
    }

    /// List keys that need rotation.
    pub fn list_keys_needing_rotation(&self) -> Vec<(String, KeyMetadata)> {
        self.keys
            .iter()
            .filter(|entry| entry.value().1.needs_rotation())
            .map(|entry| (entry.key().clone(), entry.value().1.clone()))
            .collect()
    }

    /// Delete a key.
    pub fn delete_key(&self, key_id: &str) -> Result<()> {
        // Prevent deleting current key
        {
            let current = self.current_key_id.read();
            if current.as_ref().is_some_and(|id| id == key_id) {
                return Err(SecurityError::key_management("Cannot delete current key"));
            }
        }

        self.keys
            .remove(key_id)
            .ok_or_else(|| SecurityError::key_management(format!("Key not found: {}", key_id)))?;

        Ok(())
    }

    /// Create an encryptor for a specific key.
    pub fn create_encryptor(&self, key_id: &str) -> Result<AtRestEncryptor> {
        let (key, metadata) = self.get_key(key_id)?;

        if metadata.is_expired() {
            return Err(SecurityError::key_management(format!(
                "Key expired: {}",
                key_id
            )));
        }

        AtRestEncryptor::new(metadata.algorithm, key, key_id.to_string())
    }

    /// Create an encryptor for the current key.
    pub fn create_current_encryptor(&self) -> Result<AtRestEncryptor> {
        let (key_id, key, metadata) = self.get_current_key()?;

        if metadata.is_expired() {
            return Err(SecurityError::key_management("Current key expired"));
        }

        AtRestEncryptor::new(metadata.algorithm, key, key_id)
    }

    /// Persist the keystore to `path`, envelope-encrypted under `master_key`.
    ///
    /// The full set of managed keys (plus which one is current) is serialized and then
    /// encrypted with AES-256-GCM under `master_key`, so the file at rest never contains
    /// plaintext key material. `master_key` must be 32 bytes; it is the KEK and should be
    /// sourced from a secure location (an external KMS, an HSM, or an operator secret) rather
    /// than stored alongside the file.
    pub fn save_to_file(&self, path: impl AsRef<Path>, master_key: &[u8]) -> Result<()> {
        let snapshot = KeystoreSnapshot {
            current_key_id: self.current_key_id.read().clone(),
            keys: self
                .keys
                .iter()
                .map(|entry| PersistedKey {
                    key_id: entry.key().clone(),
                    key: entry.value().0.clone(),
                    metadata: entry.value().1.clone(),
                })
                .collect(),
        };

        let plaintext = serde_json::to_vec(&snapshot)?;
        let encryptor = AtRestEncryptor::new(
            EncryptionAlgorithm::Aes256Gcm,
            master_key.to_vec(),
            "keystore-master".to_string(),
        )?;
        let encrypted = encryptor.encrypt(&plaintext, None)?;
        let serialized = serde_json::to_vec(&encrypted)?;

        std::fs::write(path.as_ref(), serialized)
            .map_err(|e| SecurityError::key_management(format!("failed to write keystore: {e}")))?;
        Ok(())
    }

    /// Load a keystore previously written by [`Self::save_to_file`], decrypting it with
    /// `master_key`.
    ///
    /// Existing in-memory keys are replaced by the loaded set. An incorrect `master_key`, a
    /// tampered file, or a corrupt file yields a typed error rather than silently losing keys.
    pub fn load_from_file(&self, path: impl AsRef<Path>, master_key: &[u8]) -> Result<()> {
        let serialized = std::fs::read(path.as_ref())
            .map_err(|e| SecurityError::key_management(format!("failed to read keystore: {e}")))?;
        let encrypted: EncryptedData = serde_json::from_slice(&serialized)?;

        let encryptor = AtRestEncryptor::new(
            EncryptionAlgorithm::Aes256Gcm,
            master_key.to_vec(),
            "keystore-master".to_string(),
        )?;
        let plaintext = encryptor.decrypt(&encrypted)?;
        let snapshot: KeystoreSnapshot = serde_json::from_slice(&plaintext)?;

        self.keys.clear();
        for persisted in snapshot.keys {
            self.keys
                .insert(persisted.key_id, (persisted.key, persisted.metadata));
        }
        *self.current_key_id.write() = snapshot.current_key_id;

        Ok(())
    }

    /// Get the number of keys.
    pub fn key_count(&self) -> usize {
        self.keys.len()
    }

    /// Clear all keys.
    pub fn clear(&self) {
        self.keys.clear();
        *self.current_key_id.write() = None;
    }
}

impl Default for KeyManager {
    fn default() -> Self {
        Self::new()
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_key_generation() {
        let manager = KeyManager::new();
        let key_id = manager
            .generate_key(EncryptionAlgorithm::Aes256Gcm, Some(365))
            .expect("Failed to generate key");

        assert!(!key_id.is_empty());

        let (key, metadata) = manager.get_key(&key_id).expect("Failed to get key");
        assert_eq!(key.len(), 32);
        assert_eq!(metadata.algorithm, EncryptionAlgorithm::Aes256Gcm);
        assert!(metadata.active);
        assert!(!metadata.is_expired());
    }

    #[test]
    fn test_current_key() {
        let manager = KeyManager::new();
        let key_id = manager
            .generate_key(EncryptionAlgorithm::Aes256Gcm, Some(365))
            .expect("Failed to generate key");

        let (current_id, _, _) = manager
            .get_current_key()
            .expect("Failed to get current key");
        assert_eq!(current_id, key_id);
    }

    #[test]
    fn test_key_rotation() {
        let manager = KeyManager::new();
        let old_key_id = manager
            .generate_key(EncryptionAlgorithm::Aes256Gcm, Some(365))
            .expect("Failed to generate key");

        let new_key_id = manager.rotate_key().expect("Failed to rotate key");
        assert_ne!(old_key_id, new_key_id);

        let (current_id, _, _) = manager
            .get_current_key()
            .expect("Failed to get current key");
        assert_eq!(current_id, new_key_id);

        let (_, old_metadata) = manager.get_key(&old_key_id).expect("Failed to get old key");
        assert!(!old_metadata.active);
    }

    #[test]
    fn test_list_keys() {
        let manager = KeyManager::new();
        manager
            .generate_key(EncryptionAlgorithm::Aes256Gcm, Some(365))
            .expect("Failed to generate key");
        manager
            .generate_key(EncryptionAlgorithm::ChaCha20Poly1305, Some(365))
            .expect("Failed to generate key");

        let keys = manager.list_keys();
        assert_eq!(keys.len(), 2);
    }

    #[test]
    fn test_delete_key() {
        let manager = KeyManager::new();
        let key_id1 = manager
            .generate_key(EncryptionAlgorithm::Aes256Gcm, Some(365))
            .expect("Failed to generate key");
        let key_id2 = manager
            .generate_key(EncryptionAlgorithm::Aes256Gcm, Some(365))
            .expect("Failed to generate key");

        // Cannot delete current key
        assert!(manager.delete_key(&key_id1).is_err());

        // Can delete non-current key
        assert!(manager.delete_key(&key_id2).is_ok());
        assert_eq!(manager.key_count(), 1);
    }

    #[test]
    fn test_save_and_load_roundtrip() {
        let manager = KeyManager::new();
        let key_id = manager
            .generate_key(EncryptionAlgorithm::Aes256Gcm, Some(365))
            .expect("generate");
        let (original_key, _) = manager.get_key(&key_id).expect("get");

        let mut path = std::env::temp_dir();
        path.push(format!("oxigeo_keystore_test_{}.enc", std::process::id()));
        let master_key = [7u8; 32];

        manager
            .save_to_file(&path, &master_key)
            .expect("save should succeed");

        // A fresh manager (simulating a process restart) loads the persisted keys.
        let restored = KeyManager::new();
        assert_eq!(restored.key_count(), 0);
        restored
            .load_from_file(&path, &master_key)
            .expect("load should succeed");

        assert_eq!(restored.key_count(), 1);
        let (loaded_key, _) = restored.get_key(&key_id).expect("loaded key present");
        assert_eq!(
            loaded_key, original_key,
            "key material must survive persistence"
        );

        let (current_id, _, _) = restored.get_current_key().expect("current key restored");
        assert_eq!(current_id, key_id);

        let _ = std::fs::remove_file(&path);
    }

    #[test]
    fn test_load_with_wrong_master_key_errors() {
        let manager = KeyManager::new();
        manager
            .generate_key(EncryptionAlgorithm::Aes256Gcm, Some(365))
            .expect("generate");

        let mut path = std::env::temp_dir();
        path.push(format!("oxigeo_keystore_badkey_{}.enc", std::process::id()));
        manager.save_to_file(&path, &[1u8; 32]).expect("save");

        let restored = KeyManager::new();
        let result = restored.load_from_file(&path, &[2u8; 32]);
        assert!(
            result.is_err(),
            "wrong master key must fail, not silently lose keys"
        );

        let _ = std::fs::remove_file(&path);
    }

    #[test]
    fn test_create_encryptor() {
        let manager = KeyManager::new();
        let key_id = manager
            .generate_key(EncryptionAlgorithm::Aes256Gcm, Some(365))
            .expect("Failed to generate key");

        let encryptor = manager
            .create_encryptor(&key_id)
            .expect("Failed to create encryptor");

        assert_eq!(encryptor.algorithm(), EncryptionAlgorithm::Aes256Gcm);
        assert_eq!(encryptor.key_id(), key_id);
    }
}