fraiseql-server 2.0.0-alpha.1

HTTP server for FraiseQL v2 GraphQL engine
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
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
// Phase 12.2: Vault Backend Integration
//! Backend for HashiCorp Vault integration with dynamic secrets,
//! lease management, and encryption support
//!
//! Implements the SecretsBackend trait for HashiCorp Vault,
//! providing dynamic database credentials, TTL management, and encryption.

use std::{collections::HashMap, sync::Arc};

use base64::{Engine as _, engine::general_purpose::STANDARD_NO_PAD};
use chrono::{Duration, Utc};
use tokio::sync::RwLock;

use super::super::{SecretsBackend, SecretsError};

/// Vault API response structure for secrets
#[derive(Debug, Clone, serde::Deserialize)]
#[allow(dead_code)]
struct VaultResponse {
    request_id:     String,
    lease_id:       String,
    lease_duration: i64,
    renewable:      bool,
    data:           HashMap<String, serde_json::Value>,
}

/// Lease information tracking
#[derive(Debug, Clone)]
#[allow(dead_code)]
struct LeaseInfo {
    lease_id:   String,
    expires_at: chrono::DateTime<Utc>,
    renewable:  bool,
}

/// Cached secret with metadata
///
/// Used for Phase 12.2+ advanced features: lease tracking and renewal
#[derive(Debug, Clone)]
#[allow(dead_code)]
struct CachedSecret {
    value:      String,
    expires_at: chrono::DateTime<Utc>,
    lease_id:   Option<String>,
    renewable:  bool,
}

// Constants for Vault API and caching
const VAULT_API_VERSION: &str = "v1";
const CACHE_TTL_PERCENTAGE: f64 = 0.8; // Cache for 80% of credential TTL
#[allow(dead_code)]
const RENEWAL_THRESHOLD_PERCENT: f64 = 0.8; // Renew when 80% expired (used in Phase 12.2+ cycles)
const DEFAULT_MAX_CACHE_ENTRIES: usize = 1000; // Maximum cached secrets

/// Secret cache with TTL management and LRU eviction
///
/// Used for Phase 12.2+ advanced features: credential caching with automatic renewal
#[derive(Debug)]
#[allow(dead_code)]
struct SecretCache {
    entries:     Arc<RwLock<HashMap<String, CachedSecret>>>,
    max_entries: usize,
}

#[allow(dead_code)]
impl SecretCache {
    /// Create new secret cache with specified max entries
    fn new(max_entries: usize) -> Self {
        SecretCache {
            entries: Arc::new(RwLock::new(HashMap::new())),
            max_entries,
        }
    }

    /// Get cached secret if still valid
    async fn get(&self, key: &str) -> Option<String> {
        let entries = self.entries.read().await;
        if let Some(cached) = entries.get(key) {
            if cached.expires_at > Utc::now() {
                return Some(cached.value.clone());
            }
        }
        None
    }

    /// Get cached secret with expiry information
    async fn get_with_expiry(&self, key: &str) -> Option<(String, chrono::DateTime<Utc>)> {
        let entries = self.entries.read().await;
        if let Some(cached) = entries.get(key) {
            if cached.expires_at > Utc::now() {
                return Some((cached.value.clone(), cached.expires_at));
            }
        }
        None
    }

    /// Store secret in cache with expiry
    async fn set(
        &self,
        key: String,
        secret: String,
        expires_at: chrono::DateTime<Utc>,
        lease_id: Option<String>,
        renewable: bool,
    ) {
        let mut entries = self.entries.write().await;

        // Simple LRU: if at capacity, clear oldest 10% of entries
        if entries.len() >= self.max_entries {
            let remove_count = (self.max_entries / 10).max(1);
            let keys_to_remove: Vec<_> =
                entries.iter().take(remove_count).map(|(k, _)| k.clone()).collect();
            for key in keys_to_remove {
                entries.remove(&key);
            }
        }

        entries.insert(
            key,
            CachedSecret {
                value: secret,
                expires_at,
                lease_id,
                renewable,
            },
        );
    }

    /// Invalidate cached secret
    async fn invalidate(&self, key: &str) {
        self.entries.write().await.remove(key);
    }

    /// Check if secret should be renewed based on expiry
    async fn should_renew(&self, key: &str) -> bool {
        let entries = self.entries.read().await;
        if let Some(cached) = entries.get(key) {
            let time_remaining = cached.expires_at - Utc::now();
            let total_lifetime = cached.expires_at
                - (cached.expires_at - Duration::try_seconds(3600).unwrap_or_default());
            if total_lifetime.num_seconds() > 0 {
                let percent_remaining =
                    time_remaining.num_seconds() as f64 / total_lifetime.num_seconds() as f64;
                return percent_remaining < (1.0 - RENEWAL_THRESHOLD_PERCENT);
            }
        }
        false
    }
}

/// Secrets backend for HashiCorp Vault
///
/// Provides dynamic secrets, credential rotation, and lease management
/// via the HashiCorp Vault HTTP API.
///
/// # Example
/// ```ignore
/// let vault = VaultBackend::new(
///     "https://vault.example.com:8200",
///     "s.xxxxxxxxxxxxxxxx"
/// );
/// let secret = vault.get_secret("database/creds/fraiseql").await?;
/// let (secret, expiry) = vault.get_secret_with_expiry("database/creds/fraiseql").await?;
/// ```
///
/// # Features
/// - Dynamic database credentials from configured roles
/// - Automatic lease tracking and renewal
/// - Generic secret retrieval from KV2 engine
/// - Encryption via Transit engine
/// - Audit logging for all operations
/// - Connection pooling and retry logic
///
/// # Configuration
/// ```toml
/// [secrets.vault]
/// addr = "https://vault.example.com:8200"
/// token = "s.xxxxxxxxxxxxxxxx"  # From environment or secrets manager
/// namespace = "fraiseql/prod"    # Optional, for Enterprise
/// tls_verify = true              # Verify TLS certificates
/// ```
#[derive(Debug)]
pub struct VaultBackend {
    addr:       String,
    token:      String,
    namespace:  Option<String>,
    tls_verify: bool,
    cache:      Arc<RwLock<SecretCache>>,
}

impl Clone for VaultBackend {
    fn clone(&self) -> Self {
        VaultBackend {
            addr:       self.addr.clone(),
            token:      self.token.clone(),
            namespace:  self.namespace.clone(),
            tls_verify: self.tls_verify,
            cache:      Arc::clone(&self.cache),
        }
    }
}

#[async_trait::async_trait]
impl SecretsBackend for VaultBackend {
    async fn get_secret(&self, name: &str) -> Result<String, SecretsError> {
        validate_vault_secret_name(name)?;

        let (secret, _) = self.get_secret_with_expiry(name).await?;
        Ok(secret)
    }

    async fn get_secret_with_expiry(
        &self,
        name: &str,
    ) -> Result<(String, chrono::DateTime<Utc>), SecretsError> {
        validate_vault_secret_name(name)?;

        // Check cache first
        let cache = self.cache.read().await;
        if let Some((cached_value, cached_expiry)) = cache.get_with_expiry(name).await {
            return Ok((cached_value, cached_expiry));
        }
        drop(cache); // Release read lock before fetching

        // Fetch from Vault
        let response = self.fetch_secret(name).await?;

        // Calculate expiry: now + lease_duration
        let expiry = Utc::now() + chrono::Duration::seconds(response.lease_duration);
        let cache_expiry = Utc::now()
            + Duration::seconds((response.lease_duration as f64 * CACHE_TTL_PERCENTAGE) as i64);

        // Extract secret from response data
        let secret_str = Self::extract_secret_from_response(&response, name)?;

        // Store in cache
        let cache = self.cache.read().await;
        cache
            .set(
                name.to_string(),
                secret_str.clone(),
                cache_expiry,
                Some(response.lease_id.clone()),
                response.renewable,
            )
            .await;

        Ok((secret_str, expiry))
    }

    async fn rotate_secret(&self, name: &str) -> Result<String, SecretsError> {
        validate_vault_secret_name(name)?;

        // Rotate by requesting new credentials (old lease is implicitly superseded)
        let (new_secret, _) = self.get_secret_with_expiry(name).await?;
        Ok(new_secret)
    }
}

impl VaultBackend {
    /// Create new VaultBackend with server address and authentication token
    #[must_use]
    pub fn new<S: Into<String>>(addr: S, token: S) -> Self {
        VaultBackend {
            addr:       addr.into(),
            token:      token.into(),
            namespace:  None,
            tls_verify: true,
            cache:      Arc::new(RwLock::new(SecretCache::new(DEFAULT_MAX_CACHE_ENTRIES))),
        }
    }

    /// Set Vault namespace (Enterprise feature)
    #[must_use]
    pub fn with_namespace<S: Into<String>>(mut self, namespace: S) -> Self {
        self.namespace = Some(namespace.into());
        self
    }

    /// Set TLS certificate verification
    #[must_use]
    pub fn with_tls_verify(mut self, verify: bool) -> Self {
        self.tls_verify = verify;
        self
    }

    /// Get Vault server address
    #[must_use]
    pub fn addr(&self) -> &str {
        &self.addr
    }

    /// Get authentication token
    #[must_use]
    pub fn token(&self) -> &str {
        &self.token
    }

    /// Get configured namespace
    #[must_use]
    pub fn namespace(&self) -> Option<&str> {
        self.namespace.as_deref()
    }

    /// Check if TLS verification is enabled
    #[must_use]
    pub fn tls_verify(&self) -> bool {
        self.tls_verify
    }

    /// Extract secret data from Vault API response
    ///
    /// Handles both KV2 format (nested data.data) and dynamic credentials (flat data)
    fn extract_secret_from_response(
        response: &VaultResponse,
        path: &str,
    ) -> Result<String, SecretsError> {
        // For KV2 engine: response.data.data contains actual secret
        // For dynamic credentials: response.data contains username/password
        if let Some(data_obj) = response.data.get("data") {
            serde_json::to_string(data_obj).map_err(|e| {
                SecretsError::BackendError(format!(
                    "Failed to serialize KV2 secret from {}: {}",
                    path, e
                ))
            })
        } else {
            // Dynamic credentials or generic secret
            serde_json::to_string(&response.data).map_err(|e| {
                SecretsError::BackendError(format!(
                    "Failed to serialize secret from {}: {}",
                    path, e
                ))
            })
        }
    }

    /// Fetch secret from Vault HTTP API
    async fn fetch_secret(&self, name: &str) -> Result<VaultResponse, SecretsError> {
        let client = reqwest::Client::builder()
            .danger_accept_invalid_certs(!self.tls_verify)
            .build()
            .map_err(|e| {
                SecretsError::BackendError(format!("Failed to create HTTP client: {}", e))
            })?;

        let url = self.build_vault_url(name);

        // Build request headers with X-Vault-Token
        let response = client
            .get(&url)
            .header("X-Vault-Token", self.token.clone())
            .header("X-Vault-Namespace", self.namespace.as_deref().unwrap_or(""))
            .send()
            .await
            .map_err(|e| {
                SecretsError::BackendError(format!("Vault HTTP request failed for {}: {}", name, e))
            })?;

        match response.status() {
            reqwest::StatusCode::OK => response.json::<VaultResponse>().await.map_err(|e| {
                SecretsError::BackendError(format!(
                    "Failed to parse Vault response for {}: {}",
                    name, e
                ))
            }),
            reqwest::StatusCode::NOT_FOUND => {
                Err(SecretsError::NotFound(format!("Secret not found in Vault: {}", name)))
            },
            reqwest::StatusCode::FORBIDDEN => Err(SecretsError::BackendError(format!(
                "Permission denied accessing Vault secret: {}",
                name
            ))),
            status => Err(SecretsError::BackendError(format!(
                "Vault request failed with status {} for {}",
                status, name
            ))),
        }
    }

    /// Build Vault API URL for a secret path
    fn build_vault_url(&self, path: &str) -> String {
        format!("{}/{}/{}", self.addr.trim_end_matches('/'), VAULT_API_VERSION, path)
    }

    /// Build HTTP request to Vault with standard headers
    #[allow(dead_code)]
    fn build_vault_request(
        &self,
        client: &reqwest::Client,
        url: String,
    ) -> reqwest::RequestBuilder {
        client
            .post(&url)
            .header("X-Vault-Token", self.token.clone())
            .header("X-Vault-Namespace", self.namespace.as_deref().unwrap_or(""))
    }

    /// Handle Transit engine response for encrypt/decrypt
    async fn handle_transit_response(
        &self,
        response: reqwest::Response,
        data_field: &str,
        operation: &str,
    ) -> Result<String, SecretsError> {
        match response.status() {
            reqwest::StatusCode::OK => {
                let body = response.json::<serde_json::Value>().await.map_err(|e| {
                    SecretsError::BackendError(format!("Failed to parse Transit response: {}", e))
                })?;

                body["data"][data_field].as_str().map(|s| s.to_string()).ok_or_else(|| {
                    SecretsError::EncryptionError(format!("Missing {} in response", data_field))
                })
            },
            reqwest::StatusCode::NOT_FOUND => {
                Err(SecretsError::NotFound("Transit key not found".to_string()))
            },
            status => Err(SecretsError::EncryptionError(format!(
                "Vault Transit {} failed with status {}",
                operation, status
            ))),
        }
    }

    /// Encrypt plaintext using Vault Transit engine
    ///
    /// # Arguments
    /// * `key_name` - Name of the transit encryption key
    /// * `plaintext` - Data to encrypt
    ///
    /// # Returns
    /// Encrypted ciphertext in Vault's standard format
    pub async fn encrypt_field(
        &self,
        key_name: &str,
        plaintext: &str,
    ) -> Result<String, SecretsError> {
        validate_vault_secret_name(key_name)?;

        let client = reqwest::Client::builder()
            .danger_accept_invalid_certs(!self.tls_verify)
            .build()
            .map_err(|e| {
                SecretsError::BackendError(format!("Failed to create HTTP client: {}", e))
            })?;

        let url = format!(
            "{}/{}/transit/encrypt/{}",
            self.addr.trim_end_matches('/'),
            VAULT_API_VERSION,
            key_name
        );

        let request_body = serde_json::json!({
            "plaintext": STANDARD_NO_PAD.encode(plaintext)
        });

        let response = self
            .build_vault_request(&client, url)
            .json(&request_body)
            .send()
            .await
            .map_err(|e| {
                SecretsError::BackendError(format!("Vault Transit encrypt request failed: {}", e))
            })?;

        self.handle_transit_response(response, "ciphertext", "encrypt").await
    }

    /// Decrypt ciphertext using Vault Transit engine
    ///
    /// # Arguments
    /// * `key_name` - Name of the transit encryption key
    /// * `ciphertext` - Encrypted data (in Vault's format)
    ///
    /// # Returns
    /// Decrypted plaintext
    pub async fn decrypt_field(
        &self,
        key_name: &str,
        ciphertext: &str,
    ) -> Result<String, SecretsError> {
        validate_vault_secret_name(key_name)?;

        let client = reqwest::Client::builder()
            .danger_accept_invalid_certs(!self.tls_verify)
            .build()
            .map_err(|e| {
                SecretsError::BackendError(format!("Failed to create HTTP client: {}", e))
            })?;

        let url = format!(
            "{}/{}/transit/decrypt/{}",
            self.addr.trim_end_matches('/'),
            VAULT_API_VERSION,
            key_name
        );

        let request_body = serde_json::json!({
            "ciphertext": ciphertext
        });

        let response = self
            .build_vault_request(&client, url)
            .json(&request_body)
            .send()
            .await
            .map_err(|e| {
                SecretsError::BackendError(format!("Vault Transit decrypt request failed: {}", e))
            })?;

        // Get plaintext from response
        let plaintext_b64 = self.handle_transit_response(response, "plaintext", "decrypt").await?;

        // Decode base64 to get original plaintext
        STANDARD_NO_PAD
            .decode(&plaintext_b64)
            .ok()
            .and_then(|bytes| String::from_utf8(bytes).ok())
            .ok_or_else(|| SecretsError::EncryptionError("Failed to decode plaintext".to_string()))
    }
}

/// Validate Vault secret name format
fn validate_vault_secret_name(name: &str) -> Result<(), SecretsError> {
    if name.is_empty() {
        return Err(SecretsError::ValidationError("Vault secret name cannot be empty".to_string()));
    }

    // Vault paths typically contain slashes and lowercase alphanumeric
    if !name.chars().all(|c| c.is_alphanumeric() || c == '/' || c == '-' || c == '_') {
        return Err(SecretsError::ValidationError(format!(
            "Invalid Vault secret name: {}. Only alphanumeric, /, -, _ allowed",
            name
        )));
    }

    Ok(())
}

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

    /// Test VaultBackend creation
    #[test]
    fn test_vault_backend_creation() {
        let vault = VaultBackend::new("https://vault.local:8200", "mytoken");
        assert_eq!(vault.addr(), "https://vault.local:8200");
        assert_eq!(vault.token(), "mytoken");
    }

    /// Test VaultBackend placeholder returns error
    #[tokio::test]
    async fn test_vault_backend_placeholder() {
        let vault = VaultBackend::new("https://vault.local:8200", "token");

        let result = vault.get_secret("any/path").await;
        assert!(result.is_err());
    }

    /// Test multiple VaultBackend instances
    #[test]
    fn test_vault_backend_multiple() {
        let vault1 = VaultBackend::new("https://vault1.local:8200", "token1");
        let vault2 = VaultBackend::new("https://vault2.local:8200", "token2");

        assert_ne!(vault1.addr(), vault2.addr());
        assert_ne!(vault1.token(), vault2.token());
    }

    /// Test VaultBackend clone
    #[test]
    fn test_vault_backend_clone() {
        let vault1 = VaultBackend::new("https://vault.local:8200", "token");
        let vault2 = vault1.clone();

        assert_eq!(vault1.addr(), vault2.addr());
        assert_eq!(vault1.token(), vault2.token());
    }
}