ferrumdeck-policy 0.7.7

FerrumDeck enforcement engine: deny-by-default tool allowlists, Airlock RASP, the R1-R3 reversibility ladder, budgets, and an EU AI Act Art.50 transparency rule
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
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
//! Data exfiltration shield
//!
//! Protects against unauthorized network access:
//! - Domain whitelist for network tools
//! - Blocks raw IP addresses (prevents C2 connections)
//! - Detects suspicious URL patterns
//! - **Credential DLP** scans outbound payloads for cloud keys / tokens /
//!   Luhn-valid PANs / mod-97-valid IBANs (see [`super::credential_dlp`]).
//! - **Per-domain data budget** caps cumulative outbound bytes per (run,
//!   domain) tuple; further dispatches to that domain are denied.

use super::config::ExfiltrationConfig;
use super::credential_dlp;
use super::inspector::{AirlockViolation, RiskLevel, ViolationType};
use regex::Regex;
use std::collections::HashMap;
use std::net::IpAddr;
use std::sync::OnceLock;
use tokio::sync::RwLock;
use tracing::{debug, warn};

/// Get URL extraction regex (compiled once)
fn get_url_regex() -> &'static Regex {
    static URL_REGEX: OnceLock<Regex> = OnceLock::new();
    URL_REGEX.get_or_init(|| {
        // Match http:// or https:// URLs
        Regex::new(r#"https?://([^/\s:'"]+)(:\d+)?(/[^\s'"]*)?"#).unwrap()
    })
}

/// Get IP address regex (compiled once)
fn get_ip_regex() -> &'static Regex {
    static IP_REGEX: OnceLock<Regex> = OnceLock::new();
    IP_REGEX.get_or_init(|| {
        // Match IPv4 addresses
        Regex::new(r#"^(\d{1,3}\.){3}\d{1,3}$"#).unwrap()
    })
}

/// Data exfiltration shield
pub struct ExfiltrationShield {
    target_tools: Vec<String>,
    allowed_domains: Vec<String>,
    block_ip_addresses: bool,
    credential_dlp_enabled: bool,
    data_budget_per_domain_bytes: Option<u64>,
    /// Per-(run_id, domain) cumulative outbound bytes for the data budget.
    /// Reset via [`clear_run`](Self::clear_run) when a run finishes.
    egress: RwLock<HashMap<(String, String), u64>>,
}

impl ExfiltrationShield {
    /// Create a new exfiltration shield from config
    pub fn new(config: &ExfiltrationConfig) -> Self {
        Self {
            target_tools: config.target_tools.clone(),
            allowed_domains: config
                .allowed_domains
                .iter()
                .map(|d| d.to_lowercase())
                .collect(),
            block_ip_addresses: config.block_ip_addresses,
            credential_dlp_enabled: config.credential_dlp_enabled,
            data_budget_per_domain_bytes: config.data_budget_per_domain_bytes,
            egress: RwLock::new(HashMap::new()),
        }
    }

    /// Estimate the outbound payload size in bytes — the serialised JSON
    /// length is a reasonable proxy for what a network tool would actually
    /// transmit. Counted at the boundary so the figure matches what an
    /// observer (gateway egress proxy, audit log) would see.
    pub fn estimate_payload_bytes(value: &serde_json::Value) -> u64 {
        serde_json::to_string(value)
            .map(|s| s.len() as u64)
            .unwrap_or(0)
    }

    /// Reads the cumulative bytes spent on (run, domain) without mutating.
    /// Tests + dashboard rollups can use this.
    pub async fn egress_bytes(&self, run_id: &str, domain: &str) -> u64 {
        self.egress
            .read()
            .await
            .get(&(run_id.to_string(), domain.to_string()))
            .copied()
            .unwrap_or(0)
    }

    /// Per-domain data budget check + record. Returns
    /// `Some(DataExfiltrationBudget)` violation when this call would push
    /// (run, domain) over budget; otherwise records the bytes and returns
    /// `None`. No-op (returns `None`) when no budget is configured.
    pub async fn check_and_record_egress(
        &self,
        run_id: &str,
        domain: &str,
        bytes: u64,
    ) -> Option<AirlockViolation> {
        let budget = self.data_budget_per_domain_bytes?;
        let key = (run_id.to_string(), domain.to_lowercase());
        let mut state = self.egress.write().await;
        let current = *state.get(&key).unwrap_or(&0);
        let prospective = current.saturating_add(bytes);
        if prospective > budget {
            warn!(
                run_id = run_id,
                domain = domain,
                current_bytes = current,
                pending_bytes = bytes,
                budget_bytes = budget,
                "egress data budget exceeded — denying further dispatches",
            );
            return Some(AirlockViolation {
                violation_type: ViolationType::DataExfiltrationBudget,
                risk_score: 80,
                risk_level: RiskLevel::High,
                details: format!(
                    "egress data budget exceeded for {} on run {}: {} (already sent) + {} (this call) > {} (budget)",
                    domain, run_id, current, bytes, budget
                ),
                trigger: format!("data_budget:{}", domain),
            });
        }
        state.insert(key, prospective);
        None
    }

    /// Clear per-run egress state. Call when a run terminates so the
    /// HashMap doesn't grow unbounded.
    pub async fn clear_run(&self, run_id: &str) {
        self.egress
            .write()
            .await
            .retain(|(rid, _), _| rid != run_id);
    }

    /// Check if this tool should be inspected
    fn should_inspect(&self, tool_name: &str) -> bool {
        self.target_tools.iter().any(|t| t == tool_name)
    }

    /// Check if a domain is allowed
    fn is_domain_allowed(&self, domain: &str) -> bool {
        let domain = domain.to_lowercase();

        // If no whitelist configured, allow all domains
        if self.allowed_domains.is_empty() {
            return true;
        }

        // Check exact match and subdomain match
        self.allowed_domains
            .iter()
            .any(|allowed| domain == *allowed || domain.ends_with(&format!(".{}", allowed)))
    }

    /// Check if a string is an IP address
    fn is_ip_address(host: &str) -> bool {
        // Try to parse as IP address
        host.parse::<IpAddr>().is_ok() || get_ip_regex().is_match(host)
    }

    /// Extract URLs from JSON value
    pub(crate) fn extract_urls(value: &serde_json::Value) -> Vec<String> {
        let mut urls = Vec::new();

        match value {
            serde_json::Value::String(s) => {
                // Extract URLs from string content
                for cap in get_url_regex().captures_iter(s) {
                    urls.push(cap[0].to_string());
                }
            }
            serde_json::Value::Array(arr) => {
                for item in arr {
                    urls.extend(Self::extract_urls(item));
                }
            }
            serde_json::Value::Object(obj) => {
                // Special handling for common URL fields
                if let Some(serde_json::Value::String(url)) = obj.get("url") {
                    urls.push(url.clone());
                }
                if let Some(serde_json::Value::String(url)) = obj.get("endpoint") {
                    urls.push(url.clone());
                }
                if let Some(serde_json::Value::String(url)) = obj.get("webhook") {
                    urls.push(url.clone());
                }
                if let Some(serde_json::Value::String(url)) = obj.get("callback") {
                    urls.push(url.clone());
                }

                // Recursively check all values
                for v in obj.values() {
                    urls.extend(Self::extract_urls(v));
                }
            }
            _ => {}
        }

        urls
    }

    /// Extract domain from URL
    pub(crate) fn extract_domain(url: &str) -> Option<String> {
        // Strip protocol
        let url = url
            .strip_prefix("http://")
            .or_else(|| url.strip_prefix("https://"))?;

        // Get host part (before path)
        let host = url.split('/').next()?;

        // Remove port
        let host = host.split(':').next()?;

        Some(host.to_string())
    }

    /// Check tool input for exfiltration attempts. Layered checks, returns
    /// the FIRST violation found:
    /// 1. Credential DLP (cloud key / token / Luhn PAN / mod-97 IBAN)
    /// 2. Raw IP destination
    /// 3. Unauthorized domain
    pub fn check(
        &self,
        tool_name: &str,
        tool_input: &serde_json::Value,
    ) -> Option<AirlockViolation> {
        if !self.should_inspect(tool_name) {
            return None;
        }

        // Layer 1 — credential DLP. Runs first so a leaked key never even
        // gets evaluated against the domain allowlist. If the LLM tries to
        // POST a Stripe key to an allow-listed host, this still fires.
        if self.credential_dlp_enabled {
            if let Some(cred) = credential_dlp::scan_json(tool_input) {
                warn!(
                    tool = tool_name,
                    credential_kind = cred.kind.as_str(),
                    redacted = %cred.redacted,
                    "credential DLP detected secret in outbound payload"
                );
                return Some(AirlockViolation {
                    violation_type: ViolationType::CredentialLeak,
                    risk_score: 95,
                    risk_level: RiskLevel::Critical,
                    details: format!(
                        "credential of kind `{}` detected in outbound payload (redacted: {}). \
                         Rotate the credential and remove it from the agent's reachable state.",
                        cred.kind.as_str(),
                        cred.redacted
                    ),
                    trigger: format!("credential_leak:{}", cred.kind.as_str()),
                });
            }
        }

        let urls = Self::extract_urls(tool_input);

        for url in urls {
            if let Some(domain) = Self::extract_domain(&url) {
                // Check for IP address (potential C2 connection)
                if self.block_ip_addresses && Self::is_ip_address(&domain) {
                    debug!(
                        tool = tool_name,
                        ip = domain,
                        "IP address detected in network call"
                    );

                    return Some(AirlockViolation {
                        violation_type: ViolationType::IpAddressUsed,
                        risk_score: 80,
                        risk_level: RiskLevel::High,
                        details: format!(
                            "Direct IP address used instead of domain: {}. \
                             This could be an attempt to bypass DNS-based security controls.",
                            domain
                        ),
                        trigger: format!("ip_address:{}", domain),
                    });
                }

                // Check domain whitelist
                if !self.is_domain_allowed(&domain) {
                    debug!(
                        tool = tool_name,
                        domain = domain,
                        "Unauthorized domain detected"
                    );

                    return Some(AirlockViolation {
                        violation_type: ViolationType::ExfiltrationAttempt,
                        risk_score: 85,
                        risk_level: RiskLevel::Critical,
                        details: format!(
                            "Unauthorized network destination: {}. \
                             Add this domain to the allowed list if this is expected behavior.",
                            domain
                        ),
                        trigger: format!("unauthorized_domain:{}", domain),
                    });
                }
            }
        }

        None
    }
}

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

    fn create_shield_with_whitelist(domains: Vec<&str>) -> ExfiltrationShield {
        ExfiltrationShield::new(&ExfiltrationConfig {
            enabled: true,
            target_tools: vec![
                "http_get".to_string(),
                "curl".to_string(),
                "fetch".to_string(),
            ],
            allowed_domains: domains.into_iter().map(String::from).collect(),
            block_ip_addresses: true,
            credential_dlp_enabled: false,
            data_budget_per_domain_bytes: None,
        })
    }

    fn create_shield_no_whitelist() -> ExfiltrationShield {
        ExfiltrationShield::new(&ExfiltrationConfig {
            enabled: true,
            target_tools: vec!["http_get".to_string()],
            allowed_domains: vec![],
            block_ip_addresses: true,
            credential_dlp_enabled: false,
            data_budget_per_domain_bytes: None,
        })
    }

    #[test]
    fn test_allowed_domain() {
        let shield = create_shield_with_whitelist(vec!["github.com", "api.anthropic.com"]);

        let input = serde_json::json!({
            "url": "https://api.github.com/repos/test/repo"
        });

        let result = shield.check("http_get", &input);
        assert!(result.is_none());
    }

    #[test]
    fn test_subdomain_allowed() {
        let shield = create_shield_with_whitelist(vec!["github.com"]);

        let input = serde_json::json!({
            "url": "https://api.github.com/v1/test"
        });

        let result = shield.check("http_get", &input);
        assert!(result.is_none());
    }

    #[test]
    fn test_unauthorized_domain() {
        let shield = create_shield_with_whitelist(vec!["github.com"]);

        let input = serde_json::json!({
            "url": "https://evil-server.com/steal-data"
        });

        let result = shield.check("http_get", &input);
        assert!(result.is_some());

        let violation = result.unwrap();
        assert_eq!(violation.violation_type, ViolationType::ExfiltrationAttempt);
        assert!(violation.details.contains("evil-server.com"));
    }

    #[test]
    fn test_ip_address_blocked() {
        let shield = create_shield_no_whitelist();

        let input = serde_json::json!({
            "url": "http://192.168.1.100:8080/api"
        });

        let result = shield.check("http_get", &input);
        assert!(result.is_some());

        let violation = result.unwrap();
        assert_eq!(violation.violation_type, ViolationType::IpAddressUsed);
    }

    #[test]
    fn test_localhost_ip_blocked() {
        let shield = create_shield_no_whitelist();

        let input = serde_json::json!({
            "endpoint": "http://127.0.0.1:3000/internal"
        });

        let result = shield.check("http_get", &input);
        assert!(result.is_some());

        let violation = result.unwrap();
        assert_eq!(violation.violation_type, ViolationType::IpAddressUsed);
    }

    #[test]
    fn test_no_whitelist_allows_domains() {
        let shield = create_shield_no_whitelist();

        let input = serde_json::json!({
            "url": "https://any-domain.com/api"
        });

        let result = shield.check("http_get", &input);
        // Should be None because no whitelist means all domains allowed
        assert!(result.is_none());
    }

    #[test]
    fn test_non_target_tool_skipped() {
        let shield = create_shield_with_whitelist(vec!["github.com"]);

        let input = serde_json::json!({
            "url": "https://evil.com/data"
        });

        // read_file is not a target tool
        let result = shield.check("read_file", &input);
        assert!(result.is_none());
    }

    #[test]
    fn test_url_extraction_from_nested_json() {
        let shield = create_shield_with_whitelist(vec!["allowed.com"]);

        let input = serde_json::json!({
            "config": {
                "endpoints": [
                    {"url": "https://blocked.io/api"}
                ]
            }
        });

        let result = shield.check("curl", &input);
        assert!(result.is_some());
    }

    #[test]
    fn test_multiple_urls_first_violation() {
        let shield = create_shield_with_whitelist(vec!["allowed.com"]);

        let input = serde_json::json!({
            "urls": [
                "https://allowed.com/ok",
                "https://blocked.io/bad",
                "https://also-blocked.io/bad"
            ]
        });

        let result = shield.check("http_get", &input);
        assert!(result.is_some());

        // Should catch the first violation
        let violation = result.unwrap();
        assert!(violation.details.contains("blocked.io"));
    }

    #[test]
    fn test_domain_extraction() {
        assert_eq!(
            ExfiltrationShield::extract_domain("https://example.com/path"),
            Some("example.com".to_string())
        );

        assert_eq!(
            ExfiltrationShield::extract_domain("http://api.example.com:8080/v1"),
            Some("api.example.com".to_string())
        );

        assert_eq!(
            ExfiltrationShield::extract_domain("https://192.168.1.1/api"),
            Some("192.168.1.1".to_string())
        );

        assert_eq!(ExfiltrationShield::extract_domain("not-a-url"), None);
    }

    #[test]
    fn test_is_ip_address() {
        assert!(ExfiltrationShield::is_ip_address("192.168.1.1"));
        assert!(ExfiltrationShield::is_ip_address("10.0.0.1"));
        assert!(ExfiltrationShield::is_ip_address("127.0.0.1"));
        assert!(ExfiltrationShield::is_ip_address("0.0.0.0"));

        assert!(!ExfiltrationShield::is_ip_address("example.com"));
        assert!(!ExfiltrationShield::is_ip_address("api.github.com"));
        assert!(!ExfiltrationShield::is_ip_address("192.168.1")); // Incomplete
    }

    #[test]
    fn test_case_insensitive_domain_matching() {
        let shield = create_shield_with_whitelist(vec!["GitHub.com"]);

        let input = serde_json::json!({
            "url": "https://GITHUB.COM/test"
        });

        let result = shield.check("http_get", &input);
        assert!(result.is_none()); // Should be allowed (case insensitive)
    }

    // =========================================================================
    // Egress-DLP additions
    // =========================================================================

    fn shield_with_dlp_and_budget(domains: Vec<&str>, budget: Option<u64>) -> ExfiltrationShield {
        ExfiltrationShield::new(&ExfiltrationConfig {
            enabled: true,
            target_tools: vec!["http_post".to_string(), "http_get".to_string()],
            allowed_domains: domains.into_iter().map(String::from).collect(),
            block_ip_addresses: true,
            credential_dlp_enabled: true,
            data_budget_per_domain_bytes: budget,
        })
    }

    #[test]
    fn leaked_aws_key_denied_and_logged() {
        let shield = shield_with_dlp_and_budget(vec!["api.example.com"], None);
        // Allow-listed destination but payload contains a high-confidence
        // AWS access key id — credential DLP must fire BEFORE the domain
        // check would have approved.
        let input = serde_json::json!({
            "url": "https://api.example.com/v1/upload",
            "body": "AWS_ACCESS_KEY_ID=AKIAIOSFODNN7EXAMPLE"
        });

        let violation = shield
            .check("http_post", &input)
            .expect("AWS key in body must be caught");
        assert_eq!(violation.violation_type, ViolationType::CredentialLeak);
        assert_eq!(violation.risk_level, RiskLevel::Critical);
        assert!(violation.trigger.contains("aws_access_key_id"));
        // Audit detail must include the kind + redacted form, never the raw key.
        assert!(violation.details.contains("aws_access_key_id"));
        assert!(!violation.details.contains("IOSFODNN7"));
    }

    #[test]
    fn non_luhn_sixteen_digits_not_flagged_as_card() {
        let shield = shield_with_dlp_and_budget(vec!["api.example.com"], None);
        // 16 digits that fail Luhn — must NOT be flagged. The prompt's
        // explicit false-positive case for the credit-card pattern.
        let input = serde_json::json!({
            "url": "https://api.example.com/log",
            "body": "trace_id=1234567890123456 — arbitrary correlation id"
        });

        // The whole call should pass cleanly: clean payload + allowed domain.
        assert!(shield.check("http_post", &input).is_none());
    }

    #[tokio::test]
    async fn data_budget_exceedance_kills_the_run() {
        // 1 KiB budget. Each call uploads ~600 bytes. Second call exceeds.
        let shield = shield_with_dlp_and_budget(vec!["api.example.com"], Some(1024));
        let run = "run_01HABCDEFG";
        let domain = "api.example.com";

        // First call: 600 bytes → recorded, allowed.
        assert!(shield
            .check_and_record_egress(run, domain, 600)
            .await
            .is_none());
        assert_eq!(shield.egress_bytes(run, domain).await, 600);

        // Second call: 600 more bytes → 1200 > 1024 → DataExfiltrationBudget.
        let violation = shield
            .check_and_record_egress(run, domain, 600)
            .await
            .expect("budget should be exceeded");
        assert_eq!(
            violation.violation_type,
            ViolationType::DataExfiltrationBudget
        );
        assert!(violation.details.contains(domain));
        // The pending bytes are NOT recorded when the budget is exceeded.
        assert_eq!(shield.egress_bytes(run, domain).await, 600);

        // Different run → independent budget.
        assert!(shield
            .check_and_record_egress("run_other", domain, 600)
            .await
            .is_none());

        // Clear the original run and confirm the budget resets.
        shield.clear_run(run).await;
        assert_eq!(shield.egress_bytes(run, domain).await, 0);
        assert!(shield
            .check_and_record_egress(run, domain, 600)
            .await
            .is_none());
    }

    #[tokio::test]
    async fn no_budget_configured_is_noop() {
        let shield = shield_with_dlp_and_budget(vec!["api.example.com"], None);
        // No budget configured → record_egress always returns None.
        assert!(shield
            .check_and_record_egress("run_x", "api.example.com", 999_999)
            .await
            .is_none());
    }
}