forjar 1.4.2

Rust-native Infrastructure as Code — bare-metal first, BLAKE3 state, provenance tracing
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
//! FJ-3308: Secret access audit trail.
//!
//! Logs every secret access (resolve, read, inject) to a JSONL audit log.
//! Audit entries track: who accessed the secret, which provider resolved it,
//! timestamp, and the BLAKE3 hash of the value (never plaintext).

use serde::{Deserialize, Serialize};
use std::io::Write;
use std::path::Path;

/// A secret access audit event.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct SecretAccessEvent {
    /// ISO 8601 timestamp.
    pub timestamp: String,
    /// Event type: resolve, inject, discard, rotate.
    pub event_type: SecretEventType,
    /// Secret key name.
    pub key: String,
    /// Provider that resolved the secret (env, file, exec, age).
    pub provider: String,
    /// BLAKE3 hash of the secret value (never store plaintext).
    pub value_hash: String,
    /// Machine where the access occurred.
    #[serde(default)]
    pub machine: Option<String>,
    /// Process ID that accessed the secret.
    pub pid: u32,
    /// Namespace the secret was injected into (if applicable).
    #[serde(default)]
    pub namespace: Option<String>,
}

/// Types of secret access events.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
pub enum SecretEventType {
    /// Secret resolved from provider.
    Resolve,
    /// Secret injected into process environment.
    Inject,
    /// Secret value discarded from memory.
    Discard,
    /// Secret key rotated.
    Rotate,
}

impl std::fmt::Display for SecretEventType {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        let s = match self {
            Self::Resolve => "resolve",
            Self::Inject => "inject",
            Self::Discard => "discard",
            Self::Rotate => "rotate",
        };
        write!(f, "{s}")
    }
}

const AUDIT_FILENAME: &str = "secret-audit.jsonl";

/// Append a secret access event to the audit log.
pub fn append_audit(state_dir: &Path, event: &SecretAccessEvent) -> Result<(), String> {
    let path = state_dir.join(AUDIT_FILENAME);
    let line = serde_json::to_string(event).map_err(|e| format!("serialize secret audit: {e}"))?;

    let mut file = std::fs::OpenOptions::new()
        .create(true)
        .append(true)
        .open(&path)
        .map_err(|e| format!("open {}: {e}", path.display()))?;

    writeln!(file, "{line}").map_err(|e| format!("write {}: {e}", path.display()))
}

/// Read all secret access events from the audit log.
pub fn read_audit(state_dir: &Path) -> Result<Vec<SecretAccessEvent>, String> {
    let path = state_dir.join(AUDIT_FILENAME);
    if !path.exists() {
        return Ok(Vec::new());
    }
    let content =
        std::fs::read_to_string(&path).map_err(|e| format!("read {}: {e}", path.display()))?;
    let mut events = Vec::new();
    for line in content.lines() {
        if line.trim().is_empty() {
            continue;
        }
        let event: SecretAccessEvent =
            serde_json::from_str(line).map_err(|e| format!("parse audit entry: {e}"))?;
        events.push(event);
    }
    Ok(events)
}

/// Create a resolve event for a secret key.
pub fn make_resolve_event(
    key: &str,
    provider: &str,
    value_hash: &str,
    machine: Option<&str>,
) -> SecretAccessEvent {
    SecretAccessEvent {
        timestamp: crate::tripwire::eventlog::now_iso8601(),
        event_type: SecretEventType::Resolve,
        key: key.to_string(),
        provider: provider.to_string(),
        value_hash: value_hash.to_string(),
        machine: machine.map(|s| s.to_string()),
        pid: std::process::id(),
        namespace: None,
    }
}

/// Create an inject event (secret pushed to namespace/environment).
pub fn make_inject_event(
    key: &str,
    provider: &str,
    value_hash: &str,
    namespace: &str,
) -> SecretAccessEvent {
    SecretAccessEvent {
        timestamp: crate::tripwire::eventlog::now_iso8601(),
        event_type: SecretEventType::Inject,
        key: key.to_string(),
        provider: provider.to_string(),
        value_hash: value_hash.to_string(),
        machine: None,
        pid: std::process::id(),
        namespace: Some(namespace.to_string()),
    }
}

/// Create a discard event (secret cleared from memory).
pub fn make_discard_event(key: &str, value_hash: &str) -> SecretAccessEvent {
    SecretAccessEvent {
        timestamp: crate::tripwire::eventlog::now_iso8601(),
        event_type: SecretEventType::Discard,
        key: key.to_string(),
        provider: String::new(),
        value_hash: value_hash.to_string(),
        machine: None,
        pid: std::process::id(),
        namespace: None,
    }
}

/// Create a rotate event (secret key rotated to new value).
pub fn make_rotate_event(
    key: &str,
    provider: &str,
    old_hash: &str,
    new_hash: &str,
) -> SecretAccessEvent {
    SecretAccessEvent {
        timestamp: crate::tripwire::eventlog::now_iso8601(),
        event_type: SecretEventType::Rotate,
        key: key.to_string(),
        provider: provider.to_string(),
        // Store new hash as value_hash, old hash in namespace for rotation tracking
        value_hash: new_hash.to_string(),
        machine: None,
        pid: std::process::id(),
        namespace: Some(format!("rotated_from:{old_hash}")),
    }
}

/// Filter audit events by key.
pub fn filter_by_key<'a>(events: &'a [SecretAccessEvent], key: &str) -> Vec<&'a SecretAccessEvent> {
    events.iter().filter(|e| e.key == key).collect()
}

/// Filter audit events by event type.
pub fn filter_by_type<'a>(
    events: &'a [SecretAccessEvent],
    event_type: &SecretEventType,
) -> Vec<&'a SecretAccessEvent> {
    events
        .iter()
        .filter(|e| &e.event_type == event_type)
        .collect()
}

/// Summary of secret access audit.
#[derive(Debug, Clone)]
pub struct AuditSummary {
    /// Total events.
    pub total: usize,
    /// Resolve events.
    pub resolves: usize,
    /// Inject events.
    pub injects: usize,
    /// Discard events.
    pub discards: usize,
    /// Rotate events.
    pub rotations: usize,
    /// Unique keys accessed.
    pub unique_keys: usize,
    /// Unique providers used.
    pub unique_providers: usize,
}

/// Compute summary of audit events.
pub fn audit_summary(events: &[SecretAccessEvent]) -> AuditSummary {
    use std::collections::HashSet;
    let mut keys = HashSet::new();
    let mut providers = HashSet::new();
    let mut resolves = 0;
    let mut injects = 0;
    let mut discards = 0;
    let mut rotations = 0;

    for event in events {
        keys.insert(&event.key);
        if !event.provider.is_empty() {
            providers.insert(&event.provider);
        }
        match event.event_type {
            SecretEventType::Resolve => resolves += 1,
            SecretEventType::Inject => injects += 1,
            SecretEventType::Discard => discards += 1,
            SecretEventType::Rotate => rotations += 1,
        }
    }

    AuditSummary {
        total: events.len(),
        resolves,
        injects,
        discards,
        rotations,
        unique_keys: keys.len(),
        unique_providers: providers.len(),
    }
}

/// Format audit summary as human-readable text.
pub fn format_audit_summary(summary: &AuditSummary) -> String {
    let mut lines = Vec::new();
    lines.push(format!("Secret Access Audit: {} events", summary.total));
    lines.push(format!("  Resolves:  {}", summary.resolves));
    lines.push(format!("  Injects:   {}", summary.injects));
    lines.push(format!("  Discards:  {}", summary.discards));
    lines.push(format!("  Rotations: {}", summary.rotations));
    lines.push(format!("  Unique keys:      {}", summary.unique_keys));
    lines.push(format!("  Unique providers:  {}", summary.unique_providers));
    lines.join("\n")
}

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

    #[test]
    fn append_and_read_roundtrip() {
        let dir = TempDir::new().unwrap();
        let event = make_resolve_event("db_pass", "env", "abc123hash", Some("web-01"));
        append_audit(dir.path(), &event).unwrap();

        let events = read_audit(dir.path()).unwrap();
        assert_eq!(events.len(), 1);
        assert_eq!(events[0].key, "db_pass");
        assert_eq!(events[0].provider, "env");
        assert_eq!(events[0].event_type, SecretEventType::Resolve);
    }

    #[test]
    fn multiple_event_types() {
        let dir = TempDir::new().unwrap();
        let e1 = make_resolve_event("api_key", "file", "hash1", None);
        let e2 = make_inject_event("api_key", "file", "hash1", "ns-forjar-1");
        let e3 = make_discard_event("api_key", "hash1");
        append_audit(dir.path(), &e1).unwrap();
        append_audit(dir.path(), &e2).unwrap();
        append_audit(dir.path(), &e3).unwrap();

        let events = read_audit(dir.path()).unwrap();
        assert_eq!(events.len(), 3);
        assert_eq!(events[0].event_type, SecretEventType::Resolve);
        assert_eq!(events[1].event_type, SecretEventType::Inject);
        assert_eq!(events[2].event_type, SecretEventType::Discard);
    }

    #[test]
    fn rotate_event() {
        let dir = TempDir::new().unwrap();
        let event = make_rotate_event("tls_cert", "exec", "old_hash", "new_hash");
        append_audit(dir.path(), &event).unwrap();

        let events = read_audit(dir.path()).unwrap();
        assert_eq!(events[0].event_type, SecretEventType::Rotate);
        assert_eq!(events[0].value_hash, "new_hash");
        assert_eq!(
            events[0].namespace.as_deref(),
            Some("rotated_from:old_hash")
        );
    }

    #[test]
    fn read_empty_audit() {
        let dir = TempDir::new().unwrap();
        let events = read_audit(dir.path()).unwrap();
        assert!(events.is_empty());
    }

    #[test]
    fn filter_by_key_works() {
        let events = vec![
            make_resolve_event("key_a", "env", "h1", None),
            make_resolve_event("key_b", "env", "h2", None),
            make_discard_event("key_a", "h1"),
        ];
        let filtered = filter_by_key(&events, "key_a");
        assert_eq!(filtered.len(), 2);
    }

    #[test]
    fn filter_by_type_works() {
        let events = vec![
            make_resolve_event("k", "env", "h", None),
            make_inject_event("k", "env", "h", "ns"),
            make_discard_event("k", "h"),
        ];
        let resolves = filter_by_type(&events, &SecretEventType::Resolve);
        assert_eq!(resolves.len(), 1);
        let injects = filter_by_type(&events, &SecretEventType::Inject);
        assert_eq!(injects.len(), 1);
    }

    #[test]
    fn audit_summary_counts() {
        let events = vec![
            make_resolve_event("k1", "env", "h1", None),
            make_resolve_event("k2", "file", "h2", None),
            make_inject_event("k1", "env", "h1", "ns1"),
            make_discard_event("k1", "h1"),
            make_rotate_event("k2", "file", "old", "new"),
        ];
        let summary = audit_summary(&events);
        assert_eq!(summary.total, 5);
        assert_eq!(summary.resolves, 2);
        assert_eq!(summary.injects, 1);
        assert_eq!(summary.discards, 1);
        assert_eq!(summary.rotations, 1);
        assert_eq!(summary.unique_keys, 2);
        assert_eq!(summary.unique_providers, 2);
    }

    #[test]
    fn format_summary_output() {
        let summary = AuditSummary {
            total: 10,
            resolves: 4,
            injects: 3,
            discards: 2,
            rotations: 1,
            unique_keys: 3,
            unique_providers: 2,
        };
        let text = format_audit_summary(&summary);
        assert!(text.contains("10 events"));
        assert!(text.contains("Resolves:  4"));
        assert!(text.contains("Rotations: 1"));
    }

    #[test]
    fn event_type_display() {
        assert_eq!(SecretEventType::Resolve.to_string(), "resolve");
        assert_eq!(SecretEventType::Inject.to_string(), "inject");
        assert_eq!(SecretEventType::Discard.to_string(), "discard");
        assert_eq!(SecretEventType::Rotate.to_string(), "rotate");
    }

    #[test]
    fn serde_roundtrip() {
        let event = make_inject_event("tls_key", "exec", "blake3hash", "ns-apply");
        let json = serde_json::to_string(&event).unwrap();
        let parsed: SecretAccessEvent = serde_json::from_str(&json).unwrap();
        assert_eq!(parsed.key, "tls_key");
        assert_eq!(parsed.event_type, SecretEventType::Inject);
        assert_eq!(parsed.namespace.as_deref(), Some("ns-apply"));
    }

    #[test]
    fn audit_jsonl_format() {
        let dir = TempDir::new().unwrap();
        let e1 = make_resolve_event("k1", "env", "h1", None);
        let e2 = make_discard_event("k1", "h1");
        append_audit(dir.path(), &e1).unwrap();
        append_audit(dir.path(), &e2).unwrap();

        let content = std::fs::read_to_string(dir.path().join("secret-audit.jsonl")).unwrap();
        let lines: Vec<&str> = content.lines().collect();
        assert_eq!(lines.len(), 2);
        for line in &lines {
            serde_json::from_str::<SecretAccessEvent>(line).unwrap();
        }
    }

    #[test]
    fn empty_provider_not_counted() {
        let events = vec![make_discard_event("k", "h")];
        let summary = audit_summary(&events);
        assert_eq!(summary.unique_providers, 0);
    }

    #[test]
    fn make_resolve_populates_pid() {
        let event = make_resolve_event("k", "env", "h", None);
        assert!(event.pid > 0);
    }

    #[test]
    fn make_inject_has_namespace() {
        let event = make_inject_event("k", "env", "h", "ns-test");
        assert_eq!(event.namespace.as_deref(), Some("ns-test"));
    }
}