weavatrix-rust 2.11.0

Protocol-independent Rust repository intelligence: typed evidence graphs for impact, architecture, APIs, Git, search, and memory
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

//! Default reports must not carry secret parameter values.

#[must_use]
pub(super) fn skip_pointer(pointer: &str) -> bool {
    let haystack = pointer.to_ascii_lowercase();
    haystack.contains("pindata")
        || haystack.contains("staticdata")
        || haystack.contains("authentication")
        || haystack.contains("headerparameters")
        || secret_key(&haystack)
}

#[must_use]
pub(super) fn looks_secret(pointer: &str, text: &str) -> bool {
    let haystack = pointer.to_ascii_lowercase();
    skip_pointer(pointer) || secret_key(&haystack) || url_with_userinfo(text)
}

#[must_use]
fn secret_key(pointer: &str) -> bool {
    [
        "password",
        "token",
        "secret",
        "apikey",
        "api_key",
        "authorization",
        "cookie",
        "credential",
        "privatekey",
        "private_key",
        "accesskey",
        "clientsecret",
    ]
    .iter()
    .any(|marker| pointer.contains(marker))
}

#[must_use]
fn url_with_userinfo(text: &str) -> bool {
    text.contains("://") && text.contains('@')
}

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

    #[test]
    fn authorization_header_is_secret() {
        assert!(looks_secret(
            "/parameters/headerParameters/0/value",
            "Bearer abc"
        ));
        assert!(looks_secret("/url", "https://user:pass@host/path"));
        assert!(!looks_secret(
            "/parameters/url",
            "https://api.example/items"
        ));
    }
}