barad-dur 0.18.0

The all-seeing repository analyzer
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

use serde::{Deserialize, Serialize};

#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
pub enum Ecosystem {
    Cargo,
    Npm,
    Pip,
    Nuget,
}

impl Ecosystem {
    pub fn osv_name(&self) -> &'static str {
        match self {
            Ecosystem::Cargo => "crates.io",
            Ecosystem::Npm => "npm",
            Ecosystem::Pip => "PyPI",
            Ecosystem::Nuget => "NuGet",
        }
    }

    pub fn display_name(&self) -> &'static str {
        match self {
            Ecosystem::Cargo => "Cargo",
            Ecosystem::Npm => "npm",
            Ecosystem::Pip => "pip",
            Ecosystem::Nuget => "NuGet",
        }
    }
}

#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
pub enum DepTier {
    Fresh,    // drift < 0.5y
    Aging,    // 0.5y – 2y
    Stale,    // 2y – 5y
    Critical, // > 5y
}

impl DepTier {
    pub fn from_drift(drift_years: f64) -> Self {
        match drift_years {
            d if d < 0.5 => DepTier::Fresh,
            d if d < 2.0 => DepTier::Aging,
            d if d < 5.0 => DepTier::Stale,
            _ => DepTier::Critical,
        }
    }
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct Vuln {
    pub id: String,
    pub severity: String,
    pub description: String,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct DepAge {
    pub name: String,
    pub ecosystem: Ecosystem,
    pub current_version: String,
    pub drift_years: f64,
    pub tier: DepTier,
    pub vulnerabilities: Vec<Vuln>,
}

impl DepAge {
    pub fn is_critical_callout(&self) -> bool {
        self.tier == DepTier::Critical || !self.vulnerabilities.is_empty()
    }
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct EcosystemReport {
    pub ecosystem: Ecosystem,
    pub total_deps: usize,
    pub mean_drift_years: f64,
    pub total_drift_years: f64,
    pub critical_deps: Vec<DepAge>,
}

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

    #[test]
    fn dep_tier_boundaries() {
        assert_eq!(DepTier::from_drift(0.0), DepTier::Fresh);
        assert_eq!(DepTier::from_drift(0.49), DepTier::Fresh);
        assert_eq!(DepTier::from_drift(0.5), DepTier::Aging);
        assert_eq!(DepTier::from_drift(1.99), DepTier::Aging);
        assert_eq!(DepTier::from_drift(2.0), DepTier::Stale);
        assert_eq!(DepTier::from_drift(4.99), DepTier::Stale);
        assert_eq!(DepTier::from_drift(5.0), DepTier::Critical);
        assert_eq!(DepTier::from_drift(10.0), DepTier::Critical);
    }

    #[test]
    fn critical_callout_by_drift() {
        let dep = DepAge {
            name: "old-crate".into(),
            ecosystem: Ecosystem::Cargo,
            current_version: "0.1.0".into(),
            drift_years: 6.0,
            tier: DepTier::Critical,
            vulnerabilities: vec![],
        };
        assert!(dep.is_critical_callout());
    }

    #[test]
    fn critical_callout_by_vuln() {
        let dep = DepAge {
            name: "vulnerable-pkg".into(),
            ecosystem: Ecosystem::Npm,
            current_version: "1.0.0".into(),
            drift_years: 0.3,
            tier: DepTier::Fresh,
            vulnerabilities: vec![Vuln {
                id: "CVE-2024-1234".into(),
                severity: "HIGH".into(),
                description: "RCE vulnerability".into(),
            }],
        };
        assert!(dep.is_critical_callout());
    }

    #[test]
    fn ecosystem_osv_names() {
        assert_eq!(Ecosystem::Cargo.osv_name(), "crates.io");
        assert_eq!(Ecosystem::Npm.osv_name(), "npm");
        assert_eq!(Ecosystem::Pip.osv_name(), "PyPI");
        assert_eq!(Ecosystem::Nuget.osv_name(), "NuGet");
    }
}