lattice-common 2026.1.203

Shared types, configuration, and error handling for Lattice scheduler
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
use base64::Engine;
use zeroize::Zeroizing;

use super::backends::{FallbackChain, SecretBackend, VaultBackend};
use super::errors::SecretResolutionError;
use super::value::SecretValue;
use crate::config::LatticeConfig;

/// Which features require which secrets.
#[derive(Debug, Clone, Copy)]
enum FeatureCondition {
    StorageConfigured,
    AccountingConfigured,
    FederationConfigured,
    Always,
}

/// A secret field definition in the registry.
struct SecretField {
    section: &'static str,
    field: &'static str,
    required_when: FeatureCondition,
}

/// Compile-time registry of all secret fields (INV-SEC5).
const SECRETS: &[SecretField] = &[
    SecretField {
        section: "storage",
        field: "vast_username",
        required_when: FeatureCondition::StorageConfigured,
    },
    SecretField {
        section: "storage",
        field: "vast_password",
        required_when: FeatureCondition::StorageConfigured,
    },
    SecretField {
        section: "accounting",
        field: "waldur_token",
        required_when: FeatureCondition::AccountingConfigured,
    },
    SecretField {
        section: "quorum",
        field: "audit_signing_key",
        required_when: FeatureCondition::Always,
    },
    SecretField {
        section: "sovra",
        field: "key_path",
        required_when: FeatureCondition::FederationConfigured,
    },
];

/// Output of secret resolution. Consumed by component initialization code.
pub struct ResolvedSecrets {
    pub vast_username: Option<SecretValue>,
    pub vast_password: Option<SecretValue>,
    pub waldur_token: Option<SecretValue>,
    /// Ed25519 signing key seed, decoded from base64. Zeroized on drop.
    pub audit_signing_key: Option<Zeroizing<[u8; 32]>>,
    pub sovra_key: Option<SecretValue>,
}

/// Resolves all operational secrets at startup.
///
/// When Vault is configured, all secrets come from Vault KV v2 (INV-SEC4).
/// When Vault is not configured, falls back to env vars -> config literals (INV-SEC6).
pub struct SecretResolver {
    backend: Box<dyn SecretBackend>,
    vault_active: bool,
}

impl SecretResolver {
    /// Construct the resolver. If Vault is configured, authenticates immediately.
    /// Failure is fatal (INV-SEC3).
    pub fn new(config: &LatticeConfig) -> Result<Self, SecretResolutionError> {
        if let Some(ref vault_config) = config.vault {
            let backend = VaultBackend::new(vault_config)?;
            Ok(Self {
                backend: Box::new(backend),
                vault_active: true,
            })
        } else {
            tracing::info!("Secret resolution via environment/config (no Vault configured)");
            Ok(Self {
                backend: Box::new(FallbackChain::new(config)),
                vault_active: false,
            })
        }
    }

    /// Construct with a custom backend (for testing).
    #[cfg(test)]
    fn with_backend(backend: Box<dyn SecretBackend>, vault_active: bool) -> Self {
        Self {
            backend,
            vault_active,
        }
    }

    /// Resolve all registered secrets. Collects ALL errors before returning (SEC-F8).
    /// Any error is fatal (INV-SEC1).
    pub fn resolve_all(
        &self,
        config: &LatticeConfig,
    ) -> Result<ResolvedSecrets, SecretResolutionError> {
        let mut vast_username: Option<SecretValue> = None;
        let mut vast_password: Option<SecretValue> = None;
        let mut waldur_token: Option<SecretValue> = None;
        let mut audit_signing_key_raw: Option<SecretValue> = None;
        let mut sovra_key: Option<SecretValue> = None;
        let mut errors: Vec<SecretResolutionError> = Vec::new();

        for secret in SECRETS {
            if !self.is_required(secret, config) {
                continue;
            }

            match self.backend.fetch(secret.section, secret.field) {
                Ok(value) => match (secret.section, secret.field) {
                    ("storage", "vast_username") => vast_username = Some(value),
                    ("storage", "vast_password") => vast_password = Some(value),
                    ("accounting", "waldur_token") => waldur_token = Some(value),
                    ("quorum", "audit_signing_key") => audit_signing_key_raw = Some(value),
                    ("sovra", "key_path") => sovra_key = Some(value),
                    _ => {}
                },
                Err(e) => {
                    // audit_signing_key is special: NotFound is OK (dev mode fallback)
                    // but only when Vault is NOT configured (INV-SEC4: Vault = fatal if missing).
                    if secret.field == "audit_signing_key"
                        && !self.vault_active
                        && matches!(e, SecretResolutionError::NotFound { .. })
                    {
                        continue;
                    }
                    errors.push(e);
                }
            }
        }

        if !errors.is_empty() {
            return if errors.len() == 1 {
                Err(errors.remove(0))
            } else {
                Err(SecretResolutionError::Multiple(errors))
            };
        }

        // Decode audit signing key from base64 if present
        let audit_signing_key = match audit_signing_key_raw {
            Some(ref raw) => {
                let decoded = base64::engine::general_purpose::STANDARD
                    .decode(raw.expose())
                    .map_err(|e| SecretResolutionError::InvalidFormat {
                        section: "quorum".to_string(),
                        field: "audit_signing_key".to_string(),
                        reason: format!("base64 decode failed: {e}"),
                    })?;
                if decoded.len() < 32 {
                    return Err(SecretResolutionError::InvalidFormat {
                        section: "quorum".to_string(),
                        field: "audit_signing_key".to_string(),
                        reason: format!(
                            "decoded key must be at least 32 bytes, got {}",
                            decoded.len()
                        ),
                    });
                }
                let mut seed = Zeroizing::new([0u8; 32]);
                seed.copy_from_slice(&decoded[..32]);
                Some(seed)
            }
            None => None,
        };

        Ok(ResolvedSecrets {
            vast_username,
            vast_password,
            waldur_token,
            audit_signing_key,
            sovra_key,
        })
    }

    /// Check whether a secret field is required given the current config.
    fn is_required(&self, secret: &SecretField, config: &LatticeConfig) -> bool {
        match secret.required_when {
            FeatureCondition::StorageConfigured => config.storage.vast_api_url.is_some(),
            FeatureCondition::AccountingConfigured => {
                config.accounting.as_ref().is_some_and(|a| a.enabled)
            }
            FeatureCondition::FederationConfigured => config.federation.is_some(),
            FeatureCondition::Always => true,
        }
    }

    /// Whether Vault is the active backend.
    pub fn is_vault_active(&self) -> bool {
        self.vault_active
    }
}

#[cfg(test)]
mod tests {
    use std::collections::HashMap;

    use super::*;
    use crate::secrets::backends::MockBackend;

    fn mock_resolver(
        secrets: HashMap<(String, String), String>,
        vault_active: bool,
    ) -> SecretResolver {
        SecretResolver::with_backend(Box::new(MockBackend { secrets }), vault_active)
    }

    #[test]
    fn resolver_without_vault_uses_fallback() {
        let config = LatticeConfig::default();
        let resolver = SecretResolver::new(&config).unwrap();
        assert!(!resolver.is_vault_active());
    }

    #[test]
    fn resolve_all_succeeds_with_no_features_configured() {
        let config = LatticeConfig::default();
        let resolver = mock_resolver(HashMap::new(), false);
        let secrets = resolver.resolve_all(&config).unwrap();
        assert!(secrets.vast_username.is_none());
        assert!(secrets.vast_password.is_none());
        assert!(secrets.waldur_token.is_none());
        assert!(secrets.audit_signing_key.is_none());
        assert!(secrets.sovra_key.is_none());
    }

    #[test]
    fn resolve_all_returns_storage_secrets() {
        let mut config = LatticeConfig::default();
        config.storage.vast_api_url = Some("https://vast.example.com".to_string());

        let mut secrets = HashMap::new();
        secrets.insert(
            ("storage".to_string(), "vast_username".to_string()),
            "user1".to_string(),
        );
        secrets.insert(
            ("storage".to_string(), "vast_password".to_string()),
            "pass1".to_string(),
        );

        let resolver = mock_resolver(secrets, false);
        let resolved = resolver.resolve_all(&config).unwrap();

        assert_eq!(resolved.vast_username.unwrap().expose(), "user1");
        assert_eq!(resolved.vast_password.unwrap().expose(), "pass1");
    }

    #[test]
    fn resolve_all_fails_when_required_storage_secret_missing() {
        let mut config = LatticeConfig::default();
        config.storage.vast_api_url = Some("https://vast.example.com".to_string());

        // Only provide username, not password
        let mut secrets = HashMap::new();
        secrets.insert(
            ("storage".to_string(), "vast_username".to_string()),
            "user1".to_string(),
        );

        let resolver = mock_resolver(secrets, false);
        let result = resolver.resolve_all(&config);
        assert!(result.is_err());
    }

    #[test]
    fn resolve_all_collects_multiple_errors() {
        let mut config = LatticeConfig::default();
        config.storage.vast_api_url = Some("https://vast.example.com".to_string());

        // Provide neither username nor password
        let resolver = mock_resolver(HashMap::new(), false);
        let result = resolver.resolve_all(&config);
        match result {
            Err(SecretResolutionError::Multiple(errors)) => {
                assert_eq!(errors.len(), 2);
            }
            _ => panic!("Expected Multiple error"),
        }
    }

    #[test]
    fn audit_signing_key_decoded_from_base64() {
        let key_bytes = [42u8; 32];
        let encoded = base64::engine::general_purpose::STANDARD.encode(key_bytes);

        let mut secrets = HashMap::new();
        secrets.insert(
            ("quorum".to_string(), "audit_signing_key".to_string()),
            encoded,
        );

        let config = LatticeConfig::default();
        let resolver = mock_resolver(secrets, false);
        let resolved = resolver.resolve_all(&config).unwrap();

        let key = resolved.audit_signing_key.unwrap();
        assert_eq!(&*key, &key_bytes);
    }

    #[test]
    fn audit_signing_key_invalid_base64_fails() {
        let mut secrets = HashMap::new();
        secrets.insert(
            ("quorum".to_string(), "audit_signing_key".to_string()),
            "not-valid-base64!!!".to_string(),
        );

        let config = LatticeConfig::default();
        let resolver = mock_resolver(secrets, false);
        let result = resolver.resolve_all(&config);
        assert!(matches!(
            result,
            Err(SecretResolutionError::InvalidFormat { .. })
        ));
    }

    #[test]
    fn audit_signing_key_too_short_fails() {
        let short_key = [42u8; 16];
        let encoded = base64::engine::general_purpose::STANDARD.encode(short_key);

        let mut secrets = HashMap::new();
        secrets.insert(
            ("quorum".to_string(), "audit_signing_key".to_string()),
            encoded,
        );

        let config = LatticeConfig::default();
        let resolver = mock_resolver(secrets, false);
        let result = resolver.resolve_all(&config);
        assert!(matches!(
            result,
            Err(SecretResolutionError::InvalidFormat { .. })
        ));
    }

    #[test]
    fn audit_signing_key_absent_ok_without_vault() {
        // No audit_signing_key in mock, Vault NOT active -> dev mode, allowed
        let config = LatticeConfig::default();
        let resolver = mock_resolver(HashMap::new(), false);
        let resolved = resolver.resolve_all(&config).unwrap();
        assert!(resolved.audit_signing_key.is_none());
    }

    #[test]
    fn audit_signing_key_absent_fatal_with_vault() {
        // No audit_signing_key in mock, Vault IS active -> must fail (INV-SEC4)
        let config = LatticeConfig::default();
        let resolver = mock_resolver(HashMap::new(), true);
        let result = resolver.resolve_all(&config);
        assert!(result.is_err());
    }

    #[test]
    fn vault_override_ignores_config_literals() {
        // When vault_active=true, only the mock backend matters.
        // Config literals are irrelevant.
        let mut config = LatticeConfig::default();
        config.storage.vast_api_url = Some("https://vast.example.com".to_string());
        config.storage.vast_username = Some("config-value".to_string());

        let mut secrets = HashMap::new();
        secrets.insert(
            ("storage".to_string(), "vast_username".to_string()),
            "vault-value".to_string(),
        );
        secrets.insert(
            ("storage".to_string(), "vast_password".to_string()),
            "vault-pass".to_string(),
        );
        // Need audit key too since vault is active
        let key_bytes = [42u8; 32];
        secrets.insert(
            ("quorum".to_string(), "audit_signing_key".to_string()),
            base64::engine::general_purpose::STANDARD.encode(key_bytes),
        );

        let resolver = mock_resolver(secrets, true);
        let resolved = resolver.resolve_all(&config).unwrap();
        assert_eq!(resolved.vast_username.unwrap().expose(), "vault-value");
    }

    #[test]
    fn convention_path_mapping() {
        assert_eq!(SECRETS[0].section, "storage");
        assert_eq!(SECRETS[0].field, "vast_username");
        assert_eq!(SECRETS[1].section, "storage");
        assert_eq!(SECRETS[1].field, "vast_password");
        assert_eq!(SECRETS[2].section, "accounting");
        assert_eq!(SECRETS[2].field, "waldur_token");
        assert_eq!(SECRETS[3].section, "quorum");
        assert_eq!(SECRETS[3].field, "audit_signing_key");
        assert_eq!(SECRETS[4].section, "sovra");
        assert_eq!(SECRETS[4].field, "key_path");
    }

    #[test]
    fn accounting_resolved_when_enabled() {
        let mut config = LatticeConfig::default();
        config.accounting = Some(crate::config::AccountingConfig {
            enabled: true,
            waldur_api_url: "https://waldur.example.com".to_string(),
            waldur_token: String::new(),
            push_interval_seconds: 60,
            buffer_size: 1000,
        });

        let mut secrets = HashMap::new();
        secrets.insert(
            ("accounting".to_string(), "waldur_token".to_string()),
            "tok-abc".to_string(),
        );

        let resolver = mock_resolver(secrets, false);
        let resolved = resolver.resolve_all(&config).unwrap();
        assert_eq!(resolved.waldur_token.unwrap().expose(), "tok-abc");
    }
}