strict-path 0.1.2

Handle paths from external or unknown sources securely. Defends against 19+ real-world CVEs including symlinks, Windows 8.3 short names, and encoding tricks and exploits.
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

#[cfg(feature = "virtual-path")]
use crate::PathBoundary;
#[cfg(feature = "virtual-path")]
use crate::VirtualRoot;

#[cfg(feature = "virtual-path")]
#[test]
fn test_strict_and_virtual_path_read_dir() {
    let temp = tempfile::tempdir().unwrap();
    let test_dir: PathBoundary = PathBoundary::try_new_create(temp.path()).unwrap();

    // Create a directory with children
    let items_dir = test_dir.strict_join("items").unwrap();
    items_dir.create_dir_all().unwrap();
    let a_file = items_dir.strict_join("a.txt").unwrap();
    a_file.write("A").unwrap();
    let b_file = items_dir.strict_join("b.log").unwrap();
    b_file.write("B").unwrap();
    let sub_dir = items_dir.strict_join("sub").unwrap();
    sub_dir.create_dir_all().unwrap();

    // StrictPath::read_dir on a directory path
    let mut names: Vec<String> = items_dir
        .read_dir()
        .unwrap()
        .map(|e| e.unwrap().file_name().to_string_lossy().into_owned())
        .collect();
    names.sort();
    assert_eq!(names, vec!["a.txt", "b.log", "sub"]);

    // Re-join discovered names via strict_join and ensure they exist
    for name in &names {
        let child = items_dir.strict_join(name).unwrap();
        assert!(child.exists());
    }

    // VirtualPath::read_dir delegates; re-join via virtual_join
    let vdir = items_dir.virtualize();
    let mut vnames: Vec<String> = vdir
        .read_dir()
        .unwrap()
        .map(|e| e.unwrap().file_name().to_string_lossy().into_owned())
        .collect();
    vnames.sort();
    assert_eq!(vnames, names);

    for name in &vnames {
        let vchild = vdir.virtual_join(name).unwrap();
        assert!(vchild.exists());
    }
}

#[cfg(feature = "virtual-path")]
#[test]
fn test_conversion_helpers_for_strict_and_virtual_path() {
    let temp = tempfile::tempdir().unwrap();
    let test_dir: PathBoundary = PathBoundary::try_new_create(temp.path()).unwrap();

    let dir = test_dir.strict_join("workspace").unwrap();
    dir.create_dir_all().unwrap();

    // StrictPath -> PathBoundary conversion symmetry
    let workspace_boundary = dir.clone().try_into_boundary().unwrap();
    assert_eq!(dir, workspace_boundary);

    // Simulate boundary deletion, then try_into_boundary_create recreates it
    test_dir.remove_dir_all().unwrap();
    assert!(!test_dir.exists());
    let recreated_boundary = dir.try_into_boundary_create().unwrap();
    assert!(recreated_boundary.exists());
    assert!(test_dir.exists());

    // VirtualPath -> VirtualRoot conversion symmetry
    let nested_dir = recreated_boundary.strict_join("nested").unwrap();
    nested_dir.create_dir_all().unwrap();
    let vdir = nested_dir.clone().virtualize();
    let nested_access_dir = nested_dir.try_into_boundary_create().unwrap();
    let vroot: VirtualRoot = vdir.clone().try_into_root().unwrap();
    assert_eq!(vroot.as_unvirtual(), &nested_access_dir);

    // Simulate root deletion, then try_into_root_create recreates it
    vroot.remove_dir_all().unwrap();
    assert!(!vroot.exists());
    let recreated_root: VirtualRoot = vdir.try_into_root_create().unwrap();
    assert!(recreated_root.exists());
    assert!(vroot.exists());
}