ggen-core 26.7.2

Core graph-aware code generation engine
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
108
109
110
111
112
113
114
115
116
117
118

use std::fmt;
use std::path::{Path, PathBuf};

#[derive(Debug, Clone)]
pub struct ProtectedPath(String);

#[derive(Debug, Clone)]
pub enum PathError {
    InvalidPath(String),
    ContainsDotDot,
    ContainsNullByte,
    Empty,
}

impl fmt::Display for PathError {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            PathError::InvalidPath(reason) => write!(f, "Invalid path: {}", reason),
            PathError::ContainsDotDot => write!(f, "Path traversal detected: contains '..'"),
            PathError::ContainsNullByte => write!(f, "Path contains null byte"),
            PathError::Empty => write!(f, "Path cannot be empty"),
        }
    }
}

impl std::error::Error for PathError {}

impl ProtectedPath {
    pub fn new(path: &str) -> Result<Self, PathError> {
        if path.is_empty() {
            return Err(PathError::Empty);
        }

        if path.contains('\0') {
            return Err(PathError::ContainsNullByte);
        }

        if path.contains("..") {
            return Err(PathError::ContainsDotDot);
        }

        Ok(ProtectedPath(path.to_string()))
    }

    pub fn as_str(&self) -> &str {
        &self.0
    }

    pub fn as_path(&self) -> &Path {
        Path::new(&self.0)
    }

    pub fn to_path_buf(&self) -> PathBuf {
        PathBuf::from(&self.0)
    }
}

impl AsRef<str> for ProtectedPath {
    fn as_ref(&self) -> &str {
        &self.0
    }
}

impl AsRef<Path> for ProtectedPath {
    fn as_ref(&self) -> &Path {
        Path::new(&self.0)
    }
}

impl std::ops::Deref for ProtectedPath {
    type Target = str;

    fn deref(&self) -> &str {
        &self.0
    }
}

impl fmt::Display for ProtectedPath {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "{}", self.0)
    }
}

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

    #[test]
    fn test_valid_path() {
        let path = ProtectedPath::new("src/main.rs");
        assert!(path.is_ok());
        assert_eq!(path.unwrap().as_str(), "src/main.rs");
    }

    #[test]
    fn test_empty_path() {
        let path = ProtectedPath::new("");
        assert!(matches!(path, Err(PathError::Empty)));
    }

    #[test]
    fn test_path_traversal_prevented() {
        let path = ProtectedPath::new("../../../etc/passwd");
        assert!(matches!(path, Err(PathError::ContainsDotDot)));
    }

    #[test]
    fn test_null_byte_prevented() {
        let path = ProtectedPath::new("src/main\0.rs");
        assert!(matches!(path, Err(PathError::ContainsNullByte)));
    }

    #[test]
    fn test_as_path() {
        let path = ProtectedPath::new("src/main.rs").unwrap();
        assert_eq!(path.as_path(), Path::new("src/main.rs"));
    }
}