cipherrun 0.3.0

A fast, modular, and scalable TLS/SSL security scanner written in Rust
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
// Policy-as-Code Engine - Core module
//
// This module provides a complete policy-as-code implementation for
// enforcing TLS/SSL security policies in CI/CD pipelines and automated scans.

pub mod evaluator;
pub mod exceptions;
pub mod parser;
pub mod rules;
pub mod violation;

use chrono::{DateTime, Utc};
use serde::{Deserialize, Serialize};

/// Policy action to take when a rule is violated
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
pub enum PolicyAction {
    #[serde(rename = "FAIL")]
    Fail,
    #[serde(rename = "WARN")]
    Warn,
    #[serde(rename = "INFO")]
    Info,
}

impl PolicyAction {
    pub fn is_failure(&self) -> bool {
        matches!(self, PolicyAction::Fail)
    }

    pub fn is_warning(&self) -> bool {
        matches!(self, PolicyAction::Warn)
    }
}

/// Complete policy definition
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct Policy {
    pub name: String,
    pub version: String,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub description: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub organization: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub effective_date: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub extends: Option<String>,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub protocols: Option<ProtocolPolicy>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub ciphers: Option<CipherPolicy>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub certificates: Option<CertificatePolicy>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub vulnerabilities: Option<VulnerabilityPolicy>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub rating: Option<RatingPolicy>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub compliance: Option<CompliancePolicy>,

    #[serde(default)]
    pub exceptions: Vec<PolicyException>,
}

/// Protocol policy requirements
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct ProtocolPolicy {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub required: Option<Vec<String>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub prohibited: Option<Vec<String>>,
    pub action: PolicyAction,
}

/// Cipher suite policy requirements
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct CipherPolicy {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub min_strength: Option<String>, // LOW, MEDIUM, HIGH
    #[serde(skip_serializing_if = "Option::is_none")]
    pub require_forward_secrecy: Option<bool>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub require_aead: Option<bool>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub prohibited_patterns: Option<Vec<String>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub required_patterns: Option<Vec<String>>,
    pub action: PolicyAction,
}

/// Certificate policy requirements
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct CertificatePolicy {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub min_key_size: Option<u32>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub max_days_until_expiry: Option<i64>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub prohibited_signature_algorithms: Option<Vec<String>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub require_valid_trust_chain: Option<bool>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub require_san: Option<bool>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub require_hostname_match: Option<bool>,
    pub action: PolicyAction,
}

/// Vulnerability policy requirements
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct VulnerabilityPolicy {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub max_critical: Option<u32>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub max_high: Option<u32>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub max_medium: Option<u32>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub prohibited: Option<Vec<String>>,
    pub action: PolicyAction,
}

/// Rating policy requirements (SSL Labs style)
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct RatingPolicy {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub min_grade: Option<String>, // A+, A, A-, B, etc.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub min_score: Option<u32>,
    pub action: PolicyAction,
}

/// Compliance framework policy
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct CompliancePolicy {
    pub frameworks: Vec<String>,
    #[serde(default)]
    pub require_all: bool,
    pub action: PolicyAction,
}

/// Policy exception for specific targets or rules
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct PolicyException {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub domain: Option<String>, // Supports wildcards: *.example.com
    pub rules: Vec<String>, // Rule paths: "protocols.prohibited"
    pub reason: String,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub expires: Option<String>, // YYYY-MM-DD format
    pub approved_by: String,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub ticket: Option<String>,
}

/// Result of policy evaluation
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct PolicyResult {
    pub policy_name: String,
    pub policy_version: String,
    pub target: String,
    pub evaluation_time: DateTime<Utc>,
    pub violations: Vec<violation::PolicyViolation>,
    pub exceptions_applied: Vec<String>,
    pub summary: PolicySummary,
}

/// Summary statistics of policy evaluation
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct PolicySummary {
    pub total_checks: u32,
    pub passed: u32,
    pub failed: u32,
    pub warnings: u32,
    pub info: u32,
    pub overall_result: PolicyOverallResult,
}

/// Overall policy evaluation result
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
pub enum PolicyOverallResult {
    Pass,
    Fail,
    Warning,
}

impl PolicyResult {
    pub fn new(policy: Policy, violations: Vec<violation::PolicyViolation>) -> Self {
        let mut failed = 0;
        let mut warnings = 0;
        let mut info = 0;

        for violation in &violations {
            match violation.action {
                PolicyAction::Fail => failed += 1,
                PolicyAction::Warn => warnings += 1,
                PolicyAction::Info => info += 1,
            }
        }

        let overall_result = if failed > 0 {
            PolicyOverallResult::Fail
        } else if warnings > 0 {
            PolicyOverallResult::Warning
        } else {
            PolicyOverallResult::Pass
        };

        let total_checks = violations.len() as u32;
        let passed = total_checks - failed - warnings - info;

        Self {
            policy_name: policy.name,
            policy_version: policy.version,
            target: String::new(), // Set by evaluator
            evaluation_time: Utc::now(),
            violations,
            exceptions_applied: Vec::new(), // Set by evaluator
            summary: PolicySummary {
                total_checks,
                passed,
                failed,
                warnings,
                info,
                overall_result,
            },
        }
    }

    /// Check if there are any violations that should fail the check
    pub fn has_violations(&self) -> bool {
        self.summary.overall_result == PolicyOverallResult::Fail
    }

    /// Format the result for display
    pub fn format(&self, format: &str) -> crate::Result<String> {
        match format {
            "json" => Ok(serde_json::to_string_pretty(self)?),
            "csv" => self.to_csv(),
            "terminal" => self.to_terminal(),
            _ => self.to_terminal(),
        }
    }

    /// Format as terminal output
    fn to_terminal(&self) -> crate::Result<String> {
        use colored::*;
        let mut output = String::new();

        output.push_str(&format!("{}\n", "=".repeat(60).cyan()));
        output.push_str(&format!(
            "Policy Evaluation: {} v{}\n",
            self.policy_name.bold(),
            self.policy_version
        ));
        output.push_str(&format!("{}\n", "=".repeat(60).cyan()));
        output.push_str(&format!("Target: {}\n", self.target.green()));
        output.push_str(&format!(
            "Evaluation Time: {}\n",
            self.evaluation_time.format("%Y-%m-%d %H:%M:%S UTC")
        ));

        let result_str = match self.summary.overall_result {
            PolicyOverallResult::Pass => format!(
                "Result: {} ({} violations)",
                "PASS".green().bold(),
                self.violations.len()
            ),
            PolicyOverallResult::Fail => format!(
                "Result: {} ({} violations)",
                "FAIL".red().bold(),
                self.violations.len()
            ),
            PolicyOverallResult::Warning => format!(
                "Result: {} ({} violations)",
                "WARNING".yellow().bold(),
                self.violations.len()
            ),
        };
        output.push_str(&format!("{}\n", result_str));

        if !self.violations.is_empty() {
            output.push_str(&format!("\n{}\n", "Violations:".yellow().bold()));
            output.push_str(&format!("{}\n", "-".repeat(60)));

            for violation in &self.violations {
                let action_str = match violation.action {
                    PolicyAction::Fail => "[FAIL]".red().bold(),
                    PolicyAction::Warn => "[WARN]".yellow(),
                    PolicyAction::Info => "[INFO]".cyan(),
                };

                output.push_str(&format!(
                    "\n{} {}\n",
                    action_str,
                    violation.rule_path.bold()
                ));
                output.push_str(&format!("  Rule: {}\n", violation.rule_name));
                output.push_str(&format!("  Description: {}\n", violation.description));
                if let Some(ref evidence) = violation.evidence {
                    output.push_str(&format!("  Evidence: {}\n", evidence.dimmed()));
                }
                if let Some(ref remediation) = violation.remediation {
                    output.push_str(&format!("  Remediation: {}\n", remediation.green()));
                }
            }
        }

        if !self.exceptions_applied.is_empty() {
            output.push_str(&format!("\n{}\n", "Exceptions Applied:".cyan()));
            output.push_str(&format!("{}\n", "-".repeat(60)));
            for exception in &self.exceptions_applied {
                output.push_str(&format!("  {}\n", exception));
            }
        } else {
            output.push_str(&format!("\n{}\n", "Exceptions Applied:".cyan()));
            output.push_str(&format!("{}\n", "-".repeat(60)));
            output.push_str("None\n");
        }

        output.push_str(&format!("\n{}\n", "Summary:".cyan()));
        output.push_str(&format!("  Total Checks: {}\n", self.summary.total_checks));
        output.push_str(&format!(
            "  {} Passed: {}\n",
            "".green(),
            self.summary.passed.to_string().green()
        ));
        output.push_str(&format!(
            "  {} Failed: {}\n",
            "".red(),
            self.summary.failed.to_string().red()
        ));
        output.push_str(&format!(
            "  {} Warnings: {}\n",
            "".yellow(),
            self.summary.warnings.to_string().yellow()
        ));

        let exit_code_msg = if self.has_violations() {
            "Exit Code: 1 (FAIL)".red().bold()
        } else {
            "Exit Code: 0 (PASS)".green().bold()
        };
        output.push_str(&format!("\n{}\n", exit_code_msg));

        Ok(output)
    }

    /// Format as CSV
    fn to_csv(&self) -> crate::Result<String> {
        let mut output = String::new();
        output.push_str("Rule Path,Rule Name,Action,Description,Evidence,Remediation\n");

        for violation in &self.violations {
            output.push_str(&format!(
                "\"{}\",\"{}\",\"{:?}\",\"{}\",\"{}\",\"{}\"\n",
                violation.rule_path,
                violation.rule_name,
                violation.action,
                violation.description.replace('"', "\"\""),
                violation
                    .evidence
                    .as_ref()
                    .unwrap_or(&String::new())
                    .replace('"', "\"\""),
                violation
                    .remediation
                    .as_ref()
                    .unwrap_or(&String::new())
                    .replace('"', "\"\"")
            ));
        }

        Ok(output)
    }
}

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

    #[test]
    fn test_policy_action_is_failure() {
        assert!(PolicyAction::Fail.is_failure());
        assert!(!PolicyAction::Warn.is_failure());
        assert!(!PolicyAction::Info.is_failure());
    }

    #[test]
    fn test_policy_result_has_violations() {
        let policy = Policy {
            name: "test".to_string(),
            version: "1.0".to_string(),
            description: None,
            organization: None,
            effective_date: None,
            extends: None,
            protocols: None,
            ciphers: None,
            certificates: None,
            vulnerabilities: None,
            rating: None,
            compliance: None,
            exceptions: Vec::new(),
        };

        let result = PolicyResult::new(policy, Vec::new());
        assert!(!result.has_violations());
    }
}