ghastoolkit 0.12.2

GitHub Advanced Security Toolkit in Rust
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

use serde::{Deserialize, Serialize};

/// A Dependency License enum with SPDX and custom licenses. We only support a few licenses
/// but you can use the `Custom` variant to add your own license.
/// SPDX License List: https://spdx.org/licenses/
///
/// # Example
///
/// ```rust
/// use ghastoolkit::supplychain::License;
///
/// let license = License::from("MIT");
/// assert_eq!(license, License::MIT);
///
/// ```
#[derive(Debug, Clone, Default, Serialize, Deserialize, PartialEq, Eq)]
pub enum License {
    /// Apache (1.0, 1.1, 2.0)
    Apache(String),
    /// MIT
    MIT,
    /// GPL (1.0, 2.0, 3.0)
    GPL(String),
    /// LGPL (2.0, 2.1, 3.0)
    LGPL(String),
    /// AGPL (1.0, 3.0)
    AGPL(String),
    /// Mozilla Public License (1.0, 1.1, 2.0)
    MPL(String),
    /// BSD (2-clause, 3-clause, 4-clause)
    BSD(String),
    /// CC0
    CC0,
    /// ISC
    ISC,
    /// Custom license
    Custom(String),
    /// Unknown license
    #[default]
    Unknown,
}

impl From<&str> for License {
    fn from(value: &str) -> Self {
        match value.to_lowercase().as_str() {
            // apache-1.0 or apache-2.0
            value if value.contains("apache") => License::Apache(split_or_default(value, "-")),
            value if value.contains("mit") => License::MIT,
            value if value.starts_with("gpl") => License::GPL(split_or_default(value, "-")),
            value if value.starts_with("lgpl") => License::LGPL(split_or_default(value, "-")),
            value if value.starts_with("agpl") => License::AGPL(split_or_default(value, "-")),
            value if value.starts_with("mpl") => License::MPL(split_or_default(value, "-")),
            value if value.starts_with("bsd") => License::BSD(split_or_default(value, "-")),
            "cc0" => License::CC0,
            "isc" => License::ISC,
            _ => License::Custom(String::from(value)),
        }
    }
}

/// This helper function will split a string by a separator and return
/// the second part or the default value (the same string).
fn split_or_default(value: &str, sep: &str) -> String {
    if let Some((_, version)) = value.split_once(sep) {
        String::from(version.trim())
    } else {
        String::from(value)
    }
}

impl From<String> for License {
    fn from(value: String) -> Self {
        License::from(value.as_str())
    }
}

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

    #[test]
    fn test_license_from_str() {
        let license = License::from("Apache-2.0");
        assert_eq!(license, License::Apache(String::from("2.0")));
    }

    #[test]
    fn test_license_versions() {
        let license = License::from("GPL-3.0");
        assert_eq!(license, License::GPL(String::from("3.0")));

        let license = License::from("AGPL-3.0");
        assert_eq!(license, License::AGPL(String::from("3.0")));

        let license = License::from("MPL-3.0");
        assert_eq!(license, License::MPL(String::from("3.0")));
    }

    #[test]
    fn test_split_or_default() {
        let license = super::split_or_default("Apache-2.0", "-");
        assert_eq!(license, "2.0");

        let license = super::split_or_default("MIT", "-");
        assert_eq!(license, "MIT");
    }
}