llm-shield-api 0.1.0

Production-grade REST API for LLM Shield
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
//! API key storage backends
//!
//! ## SPARC Phase 3: Construction (TDD)
//!
//! Storage trait with multiple backend implementations.

use super::types::{ApiKey, Result};
use async_trait::async_trait;
use llm_shield_core::Error;
use std::collections::HashMap;
use std::path::PathBuf;
use std::sync::Arc;
use tokio::sync::RwLock;

/// API key storage trait
///
/// ## Implementations
///
/// - `MemoryKeyStorage`: In-memory HashMap (testing/development)
/// - `FileKeyStorage`: JSON file persistence (production)
/// - `RedisKeyStorage`: Redis backend (optional, high-scale)
#[async_trait]
pub trait KeyStorage: Send + Sync {
    /// Store a new API key
    async fn store(&self, key: &ApiKey) -> Result<()>;

    /// Retrieve an API key by its hashed value
    async fn get_by_hash(&self, hashed_value: &str) -> Result<Option<ApiKey>>;

    /// Retrieve an API key by its ID
    async fn get_by_id(&self, id: &str) -> Result<Option<ApiKey>>;

    /// Delete an API key by ID
    async fn delete(&self, id: &str) -> Result<()>;

    /// List all keys
    async fn list(&self) -> Result<Vec<ApiKey>>;

    /// Update an existing key
    async fn update(&self, key: &ApiKey) -> Result<()>;
}

/// In-memory key storage (for testing/development)
///
/// ## Thread Safety
///
/// Uses `Arc<RwLock<HashMap>>` for thread-safe access.
///
/// ## Limitations
///
/// - Data lost on restart
/// - Not suitable for multi-instance deployments
/// - Use for testing or single-instance development only
pub struct MemoryKeyStorage {
    keys: Arc<RwLock<HashMap<String, ApiKey>>>,
}

impl MemoryKeyStorage {
    /// Create a new in-memory storage
    pub fn new() -> Self {
        Self {
            keys: Arc::new(RwLock::new(HashMap::new())),
        }
    }
}

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

#[async_trait]
impl KeyStorage for MemoryKeyStorage {
    async fn store(&self, key: &ApiKey) -> Result<()> {
        let mut keys = self.keys.write().await;
        keys.insert(key.id.clone(), key.clone());
        Ok(())
    }

    async fn get_by_hash(&self, hashed_value: &str) -> Result<Option<ApiKey>> {
        let keys = self.keys.read().await;
        Ok(keys
            .values()
            .find(|k| k.hashed_value == hashed_value)
            .cloned())
    }

    async fn get_by_id(&self, id: &str) -> Result<Option<ApiKey>> {
        let keys = self.keys.read().await;
        Ok(keys.get(id).cloned())
    }

    async fn delete(&self, id: &str) -> Result<()> {
        let mut keys = self.keys.write().await;
        keys.remove(id);
        Ok(())
    }

    async fn list(&self) -> Result<Vec<ApiKey>> {
        let keys = self.keys.read().await;
        Ok(keys.values().cloned().collect())
    }

    async fn update(&self, key: &ApiKey) -> Result<()> {
        let mut keys = self.keys.write().await;
        keys.insert(key.id.clone(), key.clone());
        Ok(())
    }
}

/// File-based key storage (JSON persistence)
///
/// ## Features
///
/// - Persists keys to JSON file
/// - Atomic writes with temp file + rename
/// - Thread-safe access
///
/// ## File Format
///
/// ```json
/// {
///   "keys": [
///     {
///       "id": "...",
///       "name": "...",
///       "hashed_value": "...",
///       ...
///     }
///   ]
/// }
/// ```
pub struct FileKeyStorage {
    file_path: PathBuf,
    keys: Arc<RwLock<HashMap<String, ApiKey>>>,
}

#[derive(serde::Serialize, serde::Deserialize)]
struct KeyFile {
    keys: Vec<ApiKey>,
}

impl FileKeyStorage {
    /// Create a new file-based storage
    ///
    /// # Arguments
    ///
    /// * `file_path` - Path to the JSON file
    ///
    /// # Example
    ///
    /// ```rust,ignore
    /// let storage = FileKeyStorage::new("config/api_keys.json").await?;
    /// ```
    pub async fn new<P: Into<PathBuf>>(file_path: P) -> Result<Self> {
        let file_path = file_path.into();

        // Create parent directory if it doesn't exist
        if let Some(parent) = file_path.parent() {
            tokio::fs::create_dir_all(parent)
                .await
                .map_err(|e| Error::auth(format!("Failed to create key directory: {}", e)))?;
        }

        let mut storage = Self {
            file_path,
            keys: Arc::new(RwLock::new(HashMap::new())),
        };

        // Load existing keys
        storage.load().await?;

        Ok(storage)
    }

    /// Load keys from file
    async fn load(&mut self) -> Result<()> {
        if !tokio::fs::try_exists(&self.file_path)
            .await
            .unwrap_or(false)
        {
            // File doesn't exist yet - start with empty storage
            return Ok(());
        }

        let contents = tokio::fs::read_to_string(&self.file_path)
            .await
            .map_err(|e| Error::auth(format!("Failed to read keys file: {}", e)))?;

        let key_file: KeyFile = serde_json::from_str(&contents)
            .map_err(|e| Error::auth(format!("Failed to parse keys file: {}", e)))?;

        let mut keys = self.keys.write().await;
        keys.clear();

        for key in key_file.keys {
            keys.insert(key.id.clone(), key);
        }

        Ok(())
    }

    /// Save keys to file
    async fn save(&self) -> Result<()> {
        let keys = self.keys.read().await;
        let key_file = KeyFile {
            keys: keys.values().cloned().collect(),
        };

        let contents = serde_json::to_string_pretty(&key_file)
            .map_err(|e| Error::auth(format!("Failed to serialize keys: {}", e)))?;

        // Write to temp file first
        let temp_path = self.file_path.with_extension("tmp");
        tokio::fs::write(&temp_path, contents)
            .await
            .map_err(|e| Error::auth(format!("Failed to write temp file: {}", e)))?;

        // Atomic rename
        tokio::fs::rename(&temp_path, &self.file_path)
            .await
            .map_err(|e| Error::auth(format!("Failed to rename temp file: {}", e)))?;

        Ok(())
    }
}

#[async_trait]
impl KeyStorage for FileKeyStorage {
    async fn store(&self, key: &ApiKey) -> Result<()> {
        {
            let mut keys = self.keys.write().await;
            keys.insert(key.id.clone(), key.clone());
        }
        self.save().await
    }

    async fn get_by_hash(&self, hashed_value: &str) -> Result<Option<ApiKey>> {
        let keys = self.keys.read().await;
        Ok(keys
            .values()
            .find(|k| k.hashed_value == hashed_value)
            .cloned())
    }

    async fn get_by_id(&self, id: &str) -> Result<Option<ApiKey>> {
        let keys = self.keys.read().await;
        Ok(keys.get(id).cloned())
    }

    async fn delete(&self, id: &str) -> Result<()> {
        {
            let mut keys = self.keys.write().await;
            keys.remove(id);
        }
        self.save().await
    }

    async fn list(&self) -> Result<Vec<ApiKey>> {
        let keys = self.keys.read().await;
        Ok(keys.values().cloned().collect())
    }

    async fn update(&self, key: &ApiKey) -> Result<()> {
        {
            let mut keys = self.keys.write().await;
            keys.insert(key.id.clone(), key.clone());
        }
        self.save().await
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::config::rate_limit::RateLimitTier;

    fn create_test_key(name: &str) -> ApiKey {
        ApiKey::new(name.to_string(), RateLimitTier::Free, None).unwrap()
    }

    #[tokio::test]
    async fn test_memory_storage_new() {
        let storage = MemoryKeyStorage::new();
        let keys = storage.list().await.unwrap();
        assert_eq!(keys.len(), 0);
    }

    #[tokio::test]
    async fn test_memory_storage_store_and_get() {
        let storage = MemoryKeyStorage::new();
        let key = create_test_key("test-key");

        storage.store(&key).await.unwrap();

        let retrieved = storage.get_by_id(&key.id).await.unwrap();
        assert!(retrieved.is_some());
        assert_eq!(retrieved.unwrap().id, key.id);
    }

    #[tokio::test]
    async fn test_memory_storage_get_by_hash() {
        let storage = MemoryKeyStorage::new();
        let key = create_test_key("test-key");
        let hash = key.hashed_value.clone();

        storage.store(&key).await.unwrap();

        let retrieved = storage.get_by_hash(&hash).await.unwrap();
        assert!(retrieved.is_some());
        assert_eq!(retrieved.unwrap().hashed_value, hash);
    }

    #[tokio::test]
    async fn test_memory_storage_delete() {
        let storage = MemoryKeyStorage::new();
        let key = create_test_key("test-key");

        storage.store(&key).await.unwrap();
        assert!(storage.get_by_id(&key.id).await.unwrap().is_some());

        storage.delete(&key.id).await.unwrap();
        assert!(storage.get_by_id(&key.id).await.unwrap().is_none());
    }

    #[tokio::test]
    async fn test_memory_storage_list() {
        let storage = MemoryKeyStorage::new();

        storage.store(&create_test_key("key1")).await.unwrap();
        storage.store(&create_test_key("key2")).await.unwrap();
        storage.store(&create_test_key("key3")).await.unwrap();

        let keys = storage.list().await.unwrap();
        assert_eq!(keys.len(), 3);
    }

    #[tokio::test]
    async fn test_memory_storage_update() {
        let storage = MemoryKeyStorage::new();
        let mut key = create_test_key("test-key");

        storage.store(&key).await.unwrap();

        // Update key
        key.active = false;
        storage.update(&key).await.unwrap();

        let retrieved = storage.get_by_id(&key.id).await.unwrap().unwrap();
        assert!(!retrieved.active);
    }

    #[tokio::test]
    async fn test_file_storage_new() {
        let temp_file = std::env::temp_dir().join("test_keys_new.json");

        // Clean up if exists
        let _ = tokio::fs::remove_file(&temp_file).await;

        let storage = FileKeyStorage::new(&temp_file).await.unwrap();
        let keys = storage.list().await.unwrap();
        assert_eq!(keys.len(), 0);

        // Clean up
        let _ = tokio::fs::remove_file(&temp_file).await;
    }

    #[tokio::test]
    async fn test_file_storage_persistence() {
        let temp_file = std::env::temp_dir().join("test_keys_persist.json");

        // Clean up if exists
        let _ = tokio::fs::remove_file(&temp_file).await;

        // Create storage and add key
        {
            let storage = FileKeyStorage::new(&temp_file).await.unwrap();
            let key = create_test_key("test-key");
            storage.store(&key).await.unwrap();
        }

        // Load storage again and verify key exists
        {
            let storage = FileKeyStorage::new(&temp_file).await.unwrap();
            let keys = storage.list().await.unwrap();
            assert_eq!(keys.len(), 1);
            assert_eq!(keys[0].name, "test-key");
        }

        // Clean up
        let _ = tokio::fs::remove_file(&temp_file).await;
    }

    #[tokio::test]
    async fn test_file_storage_crud() {
        let temp_file = std::env::temp_dir().join("test_keys_crud.json");

        // Clean up if exists
        let _ = tokio::fs::remove_file(&temp_file).await;

        let storage = FileKeyStorage::new(&temp_file).await.unwrap();

        // Create
        let key = create_test_key("test-key");
        storage.store(&key).await.unwrap();

        // Read
        let retrieved = storage.get_by_id(&key.id).await.unwrap();
        assert!(retrieved.is_some());

        // Update
        let mut updated_key = retrieved.unwrap();
        updated_key.active = false;
        storage.update(&updated_key).await.unwrap();

        let retrieved = storage.get_by_id(&key.id).await.unwrap().unwrap();
        assert!(!retrieved.active);

        // Delete
        storage.delete(&key.id).await.unwrap();
        assert!(storage.get_by_id(&key.id).await.unwrap().is_none());

        // Clean up
        let _ = tokio::fs::remove_file(&temp_file).await;
    }
}