cuenv-secrets 0.40.6

Secret resolution and management for the cuenv ecosystem
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
//! Batch secret resolution with concurrent provider execution
//!
//! This module provides efficient batch resolution of secrets across multiple
//! providers with:
//! - Concurrent resolution across different providers
//! - Provider-specific batch APIs where available (AWS, 1Password)
//! - Automatic fingerprinting for cache key inclusion
//! - Secure memory handling via [`SecureSecret`]

use crate::{
    BatchSecrets, SaltConfig, SecretError, SecretResolver, SecretSpec, compute_secret_fingerprint,
};
use futures::future::try_join_all;
use std::collections::HashMap;

/// Configuration for batch resolution.
#[derive(Debug, Clone, Default)]
pub struct BatchConfig {
    /// Salt configuration for fingerprinting secrets with `cache_key: true`.
    pub salt_config: SaltConfig,
}

impl BatchConfig {
    /// Create a new batch config with the given salt configuration.
    #[must_use]
    pub const fn new(salt_config: SaltConfig) -> Self {
        Self { salt_config }
    }

    /// Create a batch config from an optional salt string.
    #[must_use]
    pub const fn from_salt(salt: Option<String>) -> Self {
        Self {
            salt_config: SaltConfig::new(salt),
        }
    }
}

/// Multi-provider batch resolver.
///
/// Groups secrets by provider type and resolves concurrently across providers,
/// while using each provider's optimal batch strategy internally.
///
/// # Example
///
/// ```ignore
/// use cuenv_secrets::{BatchResolver, BatchConfig, SaltConfig};
///
/// let config = BatchConfig::new(SaltConfig::new(Some("my-salt".to_string())));
/// let mut resolver = BatchResolver::new(config);
///
/// // Register resolvers
/// resolver.add_resolver(&env_resolver);
/// resolver.add_resolver(&aws_resolver);
///
/// // Resolve all secrets (groups by provider for optimal batch handling)
/// let secrets = resolver.resolve(&secret_specs).await?;
/// ```
pub struct BatchResolver<'a> {
    /// Provider name -> resolver
    resolvers: HashMap<&'static str, &'a dyn SecretResolver>,
    /// Configuration for batch resolution
    config: BatchConfig,
}

impl<'a> BatchResolver<'a> {
    /// Create a new batch resolver with the given configuration.
    #[must_use]
    pub fn new(config: BatchConfig) -> Self {
        Self {
            resolvers: HashMap::new(),
            config,
        }
    }

    /// Register a resolver for its provider.
    ///
    /// The resolver's [`provider_name`](SecretResolver::provider_name) is used
    /// as the key for grouping secrets.
    pub fn add_resolver(&mut self, resolver: &'a dyn SecretResolver) {
        self.resolvers.insert(resolver.provider_name(), resolver);
    }

    /// Get the number of registered resolvers.
    #[must_use]
    pub fn resolver_count(&self) -> usize {
        self.resolvers.len()
    }

    /// Resolve all secrets, grouping by provider for optimal batch handling.
    ///
    /// # Arguments
    ///
    /// * `secrets` - Map of secret names to (spec, `provider_name`) tuples
    ///
    /// # Errors
    ///
    /// Returns error if:
    /// - A required provider is not registered
    /// - Salt is missing when secrets have `cache_key: true`
    /// - Any secret resolution fails
    pub async fn resolve_all(
        &self,
        secrets: &HashMap<String, (SecretSpec, &'static str)>,
    ) -> Result<BatchSecrets, SecretError> {
        // Check salt requirements upfront
        let needs_salt = secrets.values().any(|(spec, _)| spec.cache_key);
        if needs_salt && !self.config.salt_config.has_salt() {
            return Err(SecretError::MissingSalt);
        }

        // Group secrets by provider
        let mut by_provider: HashMap<&'static str, HashMap<String, SecretSpec>> = HashMap::new();
        for (name, (spec, provider)) in secrets {
            by_provider
                .entry(*provider)
                .or_default()
                .insert(name.clone(), spec.clone());
        }

        // Resolve each provider's secrets concurrently
        let provider_futures: Vec<_> = by_provider
            .into_iter()
            .map(|(provider, provider_secrets)| async move {
                let secret_resolver = self.resolvers.get(provider).ok_or_else(|| {
                    SecretError::UnsupportedResolver {
                        resolver: provider.to_string(),
                    }
                })?;
                let batch_results = secret_resolver.resolve_batch(&provider_secrets).await?;
                Ok::<_, SecretError>((provider, batch_results))
            })
            .collect();

        let provider_results = try_join_all(provider_futures).await?;

        // Merge results and compute fingerprints
        let mut batch = BatchSecrets::with_capacity(secrets.len());
        for (_provider, batch_result) in provider_results {
            for (name, secure_value) in batch_result {
                // Compute fingerprint if this secret affects cache keys
                let fingerprint = secrets.get(&name).and_then(|(spec, _)| {
                    if !spec.cache_key {
                        return None;
                    }
                    // Warn if secret is too short
                    if secure_value.len() < 4 {
                        tracing::warn!(
                            secret = %name,
                            len = secure_value.len(),
                            "Secret is too short for safe cache key inclusion"
                        );
                    }
                    Some(compute_secret_fingerprint(
                        &name,
                        secure_value.expose(),
                        self.config.salt_config.write_salt().unwrap_or(""),
                    ))
                });

                batch.insert(name, secure_value, fingerprint);
            }
        }

        Ok(batch)
    }
}

/// Convenience function for single-provider batch resolution.
///
/// Resolves all secrets using a single resolver and computes fingerprints
/// for secrets with `cache_key: true`.
///
/// # Arguments
///
/// * `resolver` - The secret resolver to use
/// * `secrets` - Map of secret names to their specifications
/// * `salt_config` - Salt configuration for fingerprinting
///
/// # Errors
///
/// Returns error if:
/// - Salt is missing when secrets have `cache_key: true`
/// - Any secret resolution fails
///
/// # Example
///
/// ```ignore
/// use cuenv_secrets::{resolve_batch, SaltConfig, EnvSecretResolver};
///
/// let resolver = EnvSecretResolver::new();
/// let salt = SaltConfig::new(Some("my-salt".to_string()));
///
/// let secrets = resolve_batch(&resolver, &specs, &salt).await?;
/// ```
#[allow(clippy::implicit_hasher)]
pub async fn resolve_batch<R: SecretResolver>(
    resolver: &R,
    secrets: &HashMap<String, SecretSpec>,
    salt_config: &SaltConfig,
) -> Result<BatchSecrets, SecretError> {
    // Check salt requirements
    let needs_salt = secrets.values().any(|s| s.cache_key);
    if needs_salt && !salt_config.has_salt() {
        return Err(SecretError::MissingSalt);
    }

    // Resolve all secrets using the resolver's batch method
    let batch_results = resolver.resolve_batch(secrets).await?;

    // Build BatchSecrets with fingerprints
    let mut batch = BatchSecrets::with_capacity(secrets.len());
    for (name, secure_value) in batch_results {
        let fingerprint = secrets.get(&name).and_then(|spec| {
            if !spec.cache_key {
                return None;
            }
            // Warn if secret is too short
            if secure_value.len() < 4 {
                tracing::warn!(
                    secret = %name,
                    len = secure_value.len(),
                    "Secret is too short for safe cache key inclusion"
                );
            }
            Some(compute_secret_fingerprint(
                &name,
                secure_value.expose(),
                salt_config.write_salt().unwrap_or(""),
            ))
        });

        batch.insert(name, secure_value, fingerprint);
    }

    Ok(batch)
}

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

    // ==========================================================================
    // BatchConfig tests
    // ==========================================================================

    #[test]
    fn test_batch_config_default() {
        let config = BatchConfig::default();
        assert!(!config.salt_config.has_salt());
    }

    #[test]
    fn test_batch_config_new() {
        let salt_config = SaltConfig::new(Some("test-salt".to_string()));
        let config = BatchConfig::new(salt_config);
        assert!(config.salt_config.has_salt());
        assert_eq!(config.salt_config.write_salt(), Some("test-salt"));
    }

    #[test]
    fn test_batch_config_from_salt() {
        let config = BatchConfig::from_salt(Some("my-salt".to_string()));
        assert!(config.salt_config.has_salt());
        assert_eq!(config.salt_config.write_salt(), Some("my-salt"));
    }

    #[test]
    fn test_batch_config_from_salt_none() {
        let config = BatchConfig::from_salt(None);
        assert!(!config.salt_config.has_salt());
    }

    #[test]
    fn test_batch_config_clone() {
        let config = BatchConfig::from_salt(Some("cloned-salt".to_string()));
        let cloned = config.clone();
        assert!(cloned.salt_config.has_salt());
    }

    #[test]
    fn test_batch_config_debug() {
        let config = BatchConfig::default();
        let debug_str = format!("{:?}", config);
        assert!(debug_str.contains("BatchConfig"));
    }

    // ==========================================================================
    // BatchResolver tests
    // ==========================================================================

    #[test]
    fn test_batch_resolver_new() {
        let config = BatchConfig::default();
        let resolver = BatchResolver::new(config);
        assert_eq!(resolver.resolver_count(), 0);
    }

    #[test]
    fn test_batch_resolver_add_resolver() {
        let config = BatchConfig::default();
        let mut resolver = BatchResolver::new(config);
        let env_resolver = EnvSecretResolver::new();

        resolver.add_resolver(&env_resolver);
        assert_eq!(resolver.resolver_count(), 1);
    }

    #[test]
    fn test_batch_resolver_add_multiple_resolvers() {
        let config = BatchConfig::default();
        let mut resolver = BatchResolver::new(config);
        let env_resolver = EnvSecretResolver::new();

        // Adding the same resolver type replaces (uses same provider_name key)
        resolver.add_resolver(&env_resolver);
        resolver.add_resolver(&env_resolver);
        assert_eq!(resolver.resolver_count(), 1);
    }

    #[tokio::test]
    async fn test_batch_resolver_resolve_all_empty() {
        let config = BatchConfig::default();
        let resolver = BatchResolver::new(config);
        let secrets: HashMap<String, (SecretSpec, &'static str)> = HashMap::new();

        let result = resolver.resolve_all(&secrets).await.unwrap();
        assert!(result.is_empty());
    }

    #[tokio::test]
    async fn test_batch_resolver_missing_provider() {
        let config = BatchConfig::default();
        let resolver = BatchResolver::new(config);

        let mut secrets = HashMap::new();
        secrets.insert(
            "TEST".to_string(),
            (SecretSpec::new("test"), "unknown_provider"),
        );

        let result = resolver.resolve_all(&secrets).await;
        assert!(matches!(
            result,
            Err(SecretError::UnsupportedResolver { .. })
        ));
    }

    #[tokio::test]
    async fn test_batch_resolver_missing_salt_for_cache_key() {
        let config = BatchConfig::default(); // No salt
        let resolver = BatchResolver::new(config);

        let mut secrets = HashMap::new();
        secrets.insert(
            "TEST".to_string(),
            (SecretSpec::with_cache_key("test"), "env"),
        );

        let result = resolver.resolve_all(&secrets).await;
        assert!(matches!(result, Err(SecretError::MissingSalt)));
    }

    // ==========================================================================
    // resolve_batch function tests
    // ==========================================================================

    #[tokio::test]
    async fn test_resolve_batch_empty() {
        let resolver = EnvSecretResolver::new();
        let secrets = HashMap::new();
        let salt = SaltConfig::default();

        let result = resolve_batch(&resolver, &secrets, &salt).await.unwrap();
        assert!(result.is_empty());
    }

    #[tokio::test]
    async fn test_resolve_batch_missing_salt() {
        let resolver = EnvSecretResolver::new();
        let mut secrets = HashMap::new();
        secrets.insert("TEST".to_string(), SecretSpec::with_cache_key("TEST_VAR"));
        let salt = SaltConfig::default(); // No salt

        let result = resolve_batch(&resolver, &secrets, &salt).await;
        assert!(matches!(result, Err(SecretError::MissingSalt)));
    }

    #[tokio::test]
    async fn test_resolve_batch_no_cache_key_no_salt_ok() {
        let resolver = EnvSecretResolver::new();
        let mut secrets = HashMap::new();
        // SecretSpec without cache_key doesn't require salt
        secrets.insert("TEST".to_string(), SecretSpec::new("NONEXISTENT_VAR"));
        let salt = SaltConfig::default();

        // This may fail if the env var doesn't exist, but it shouldn't fail due to missing salt
        let result = resolve_batch(&resolver, &secrets, &salt).await;
        // Either succeeds or fails for other reasons (missing env var), not missing salt
        assert!(
            !matches!(result, Err(SecretError::MissingSalt)),
            "Should not require salt for non-cache-key secrets"
        );
    }

    #[tokio::test]
    async fn test_resolve_batch_with_salt_and_cache_key() {
        // Set an env var for testing
        // SAFETY: Test runs in isolation
        #[allow(unsafe_code)]
        unsafe {
            std::env::set_var("BATCH_TEST_SECRET", "test_value");
        }

        let resolver = EnvSecretResolver::new();
        let mut secrets = HashMap::new();
        secrets.insert(
            "my_secret".to_string(),
            SecretSpec::with_cache_key("BATCH_TEST_SECRET"),
        );
        let salt = SaltConfig::new(Some("test-salt".to_string()));

        let result = resolve_batch(&resolver, &secrets, &salt).await.unwrap();
        assert!(!result.is_empty());

        // Cleanup
        #[allow(unsafe_code)]
        unsafe {
            std::env::remove_var("BATCH_TEST_SECRET");
        }
    }

    #[tokio::test]
    async fn test_resolve_batch_without_cache_key() {
        // Set an env var for testing
        // SAFETY: Test runs in isolation
        #[allow(unsafe_code)]
        unsafe {
            std::env::set_var("BATCH_TEST_NO_CACHE", "another_value");
        }

        let resolver = EnvSecretResolver::new();
        let mut secrets = HashMap::new();
        // Without cache_key, no fingerprint is computed
        secrets.insert(
            "my_secret".to_string(),
            SecretSpec::new("BATCH_TEST_NO_CACHE"),
        );
        let salt = SaltConfig::default();

        let result = resolve_batch(&resolver, &secrets, &salt).await.unwrap();
        assert!(!result.is_empty());

        // Cleanup
        #[allow(unsafe_code)]
        unsafe {
            std::env::remove_var("BATCH_TEST_NO_CACHE");
        }
    }

    #[tokio::test]
    async fn test_resolve_batch_multiple_secrets() {
        // SAFETY: Test runs in isolation
        #[allow(unsafe_code)]
        unsafe {
            std::env::set_var("BATCH_MULTI_1", "value1");
            std::env::set_var("BATCH_MULTI_2", "value2");
        }

        let resolver = EnvSecretResolver::new();
        let mut secrets = HashMap::new();
        secrets.insert("secret1".to_string(), SecretSpec::new("BATCH_MULTI_1"));
        secrets.insert("secret2".to_string(), SecretSpec::new("BATCH_MULTI_2"));
        let salt = SaltConfig::default();

        let result = resolve_batch(&resolver, &secrets, &salt).await.unwrap();
        assert_eq!(result.len(), 2);

        // Cleanup
        #[allow(unsafe_code)]
        unsafe {
            std::env::remove_var("BATCH_MULTI_1");
            std::env::remove_var("BATCH_MULTI_2");
        }
    }
}