orbok-fs 0.9.3

orbok safe file access boundary, source policy, scanner (RFC-003/RFC-004)
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

//! Sensitive-directory warnings (RFC-003 §7, external design §18.2).
//!
//! Warnings, not blocks: the user may proceed with "Add Anyway", but the
//! default recommendation is not to index credential-bearing folders.

use std::path::Path;

/// Directory names (final or intermediate components) that very likely
/// contain credentials or secrets.
const SENSITIVE_COMPONENTS: &[&str] = &[
    ".ssh",
    ".gnupg",
    ".aws",
    ".azure",
    ".kube",
    ".docker",
    ".password-store",
    ".mozilla",
    ".thunderbird",
];

/// Absolute prefixes that are system directories.
#[cfg(unix)]
const SYSTEM_PREFIXES: &[&str] = &["/etc", "/usr", "/bin", "/sbin", "/boot", "/proc", "/sys"];

#[cfg(not(unix))]
const SYSTEM_PREFIXES: &[&str] = &["C:\\Windows", "C:\\Program Files", "C:\\Program Files (x86)"];

/// Returns a warning reason when `path` looks like a sensitive location.
/// `None` means no warning is needed.
pub fn sensitive_warning(path: &Path) -> Option<&'static str> {
    let path_str = path.to_string_lossy();
    for prefix in SYSTEM_PREFIXES {
        if path_str.starts_with(prefix) {
            return Some("system_directory");
        }
    }
    for component in path.components() {
        let name = component.as_os_str().to_string_lossy();
        if SENSITIVE_COMPONENTS.contains(&name.as_ref()) {
            return Some("credential_directory");
        }
        // `.config` only as the home config root, not arbitrary names.
        if name == ".config" {
            return Some("hidden_configuration_directory");
        }
    }
    None
}