cargo-allow 0.1.11

Source-tree exception ledger and policy scanner for Rust repositories.
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

use serde_json::Value;
use std::collections::BTreeSet;

pub(crate) fn sample_string_matches_supported_pattern(value: &str, pattern: &str) -> bool {
    match pattern {
        "^cargo-allow " => value.starts_with("cargo-allow "),
        "^sha256:v1:[0-9a-f]{64}$" => sample_string_matches_sha256_v1(value),
        "^work-[a-z0-9-]+-[0-9]{4}$" => sample_string_matches_work_item_id(value),
        _ => std::panic::panic_any(format!("unsupported schema pattern {pattern:?}")),
    }
}

fn sample_string_matches_work_item_id(value: &str) -> bool {
    let Some(rest) = value.strip_prefix("work-") else {
        return false;
    };
    let Some((kind, number)) = rest.rsplit_once('-') else {
        return false;
    };
    !kind.is_empty()
        && kind
            .chars()
            .all(|ch| ch.is_ascii_lowercase() || ch.is_ascii_digit() || ch == '-')
        && number.len() == 4
        && number.chars().all(|ch| ch.is_ascii_digit())
}

fn sample_string_matches_sha256_v1(value: &str) -> bool {
    let Some(digest) = value.strip_prefix("sha256:v1:") else {
        return false;
    };
    digest.len() == 64
        && digest
            .chars()
            .all(|ch| ch.is_ascii_digit() || ('a'..='f').contains(&ch))
}

pub(crate) fn supported_schema_patterns() -> BTreeSet<String> {
    [
        "^cargo-allow ",
        "^sha256:v1:[0-9a-f]{64}$",
        "^work-[a-z0-9-]+-[0-9]{4}$",
    ]
    .into_iter()
    .map(std::string::ToString::to_string)
    .collect()
}

pub(crate) fn collect_schema_patterns(value: &Value, patterns: &mut BTreeSet<String>) {
    match value {
        Value::Object(object) => {
            if let Some(pattern) = object.get("pattern").and_then(Value::as_str) {
                patterns.insert(pattern.to_string());
            }
            for child in object.values() {
                collect_schema_patterns(child, patterns);
            }
        }
        Value::Array(items) => {
            for child in items {
                collect_schema_patterns(child, patterns);
            }
        }
        _ => {}
    }
}

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

    #[test]
    fn work_item_id_samples_accept_supported_kind_and_number_shape() {
        let accepted = true;

        assert_eq!(
            sample_string_matches_work_item_id("work-spec-0001"),
            accepted
        );
        assert_eq!(sample_string_matches_work_item_id("work-a-0001"), accepted);
        assert_eq!(sample_string_matches_work_item_id("work-1-0001"), accepted);
        assert_eq!(
            sample_string_matches_work_item_id("work-spec-2-0001"),
            accepted
        );
    }

    #[test]
    fn work_item_id_samples_reject_missing_prefix_or_split() {
        let accepted = false;

        assert_eq!(
            sample_string_matches_work_item_id("task-spec-0001"),
            accepted
        );
        assert_eq!(
            sample_string_matches_work_item_id("work-spec0001"),
            accepted
        );
    }

    #[test]
    fn work_item_id_samples_reject_empty_or_unsupported_kind() {
        let accepted = false;

        assert_eq!(sample_string_matches_work_item_id("work--0001"), accepted);
        assert_eq!(
            sample_string_matches_work_item_id("work-SPEC-0001"),
            accepted
        );
        assert_eq!(
            sample_string_matches_work_item_id("work-spec_system-0001"),
            accepted
        );
    }

    #[test]
    fn work_item_id_samples_require_four_digit_numbers() {
        let accepted = false;

        assert_eq!(
            sample_string_matches_work_item_id("work-spec-001"),
            accepted
        );
        assert_eq!(
            sample_string_matches_work_item_id("work-spec-000x"),
            accepted
        );
    }

    #[test]
    fn sha256_v1_samples_require_a_lowercase_64_digit_digest() {
        assert!(sample_string_matches_sha256_v1(
            "sha256:v1:0000000000000000000000000000000000000000000000000000000000000000"
        ));
        assert!(!sample_string_matches_sha256_v1("sha256:v1:abc123"));
        assert!(!sample_string_matches_sha256_v1(
            "sha256:v1:000000000000000000000000000000000000000000000000000000000000000G"
        ));
    }
}