sentri-report 0.3.0

Sentri: Report generation for Sentri security analysis violations and findings.
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

//! Report data structures.

use serde::{Deserialize, Serialize};

/// A complete analysis report.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct Report {
    /// Report title.
    pub title: String,

    /// Timestamp of generation.
    pub generated_at: String,

    /// Program analyzed.
    pub program: String,

    /// Total invariants checked.
    pub invariants_checked: usize,

    /// Violations found.
    pub violations_found: usize,

    /// Coverage percentage.
    pub coverage_percent: u8,

    /// Functions protected.
    pub protected_functions: Vec<String>,

    /// Functions not protected.
    pub unprotected_functions: Vec<String>,

    /// Severity breakdown.
    pub severity_breakdown: SeverityBreakdown,
}

/// Breakdown by severity.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct SeverityBreakdown {
    /// Critical violations.
    pub critical: usize,
    /// High severity violations.
    pub high: usize,
    /// Medium severity violations.
    pub medium: usize,
    /// Low severity violations.
    pub low: usize,
}

impl Report {
    /// Create a new report.
    pub fn new(title: String, program: String) -> Self {
        Self {
            title,
            generated_at: chrono::Utc::now().to_rfc3339(),
            program,
            invariants_checked: 0,
            violations_found: 0,
            coverage_percent: 0,
            protected_functions: Vec::new(),
            unprotected_functions: Vec::new(),
            severity_breakdown: SeverityBreakdown::default(),
        }
    }
}