use std::path::{Component, Path, PathBuf};
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub(crate) enum Rejected {
Traversal,
Absolute,
Nul,
}
pub(crate) fn safe_join(root: &Path, rel: &str) -> Result<PathBuf, Rejected> {
if rel.contains('\0') {
return Err(Rejected::Nul);
}
if Path::new(rel).is_absolute() || Path::new(rel).has_root() {
return Err(Rejected::Absolute);
}
let mut path = root.to_path_buf();
for part in rel.split('/') {
if part.is_empty() || part == "." {
continue;
}
match Path::new(part).components().next() {
Some(Component::Normal(component)) if component == part => path.push(part),
None => continue,
_ => return Err(Rejected::Traversal),
}
}
Ok(path)
}
#[cfg(test)]
mod tests {
use super::*;
fn join(rel: &str) -> Result<PathBuf, Rejected> {
safe_join(Path::new("/srv/root"), rel)
}
#[test]
fn plain_relative_paths_join_under_the_root() {
assert_eq!(
join("a.png").expect("plain"),
PathBuf::from("/srv/root/a.png")
);
assert_eq!(
join("img/a.png").expect("nested"),
PathBuf::from("/srv/root/img/a.png")
);
assert_eq!(
join("./img//a.png").expect("noisy"),
PathBuf::from("/srv/root/img/a.png")
);
}
#[test]
fn traversal_absolute_and_nul_are_refused_by_name() {
assert_eq!(join("../x").expect_err("parent"), Rejected::Traversal);
assert_eq!(
join("a/../../x").expect_err("escape after a valid segment"),
Rejected::Traversal
);
assert_eq!(join("..").expect_err("bare parent"), Rejected::Traversal);
assert_eq!(
join("/etc/passwd").expect_err("absolute"),
Rejected::Absolute
);
assert_eq!(join("a\0b").expect_err("interior nul"), Rejected::Nul);
assert_eq!(
join("ok/../\0").expect_err("nul past a traversal"),
Rejected::Nul
);
}
#[test]
fn backslash_segments_never_escape() {
let joined = join("a\\..\\..\\x");
match joined {
Ok(path) => assert!(
path.starts_with("/srv/root"),
"a backslash segment must stay inside the root: {}",
path.display()
),
Err(why) => assert_eq!(why, Rejected::Traversal),
}
}
#[test]
fn empty_and_dot_yield_the_root() {
assert_eq!(join("").expect("empty"), PathBuf::from("/srv/root"));
assert_eq!(join(".").expect("dot"), PathBuf::from("/srv/root"));
assert_eq!(join("./.").expect("dots"), PathBuf::from("/srv/root"));
}
#[test]
fn rooted_paths_are_refused_rather_than_re_rooted() {
assert_eq!(join("/a.png").expect_err("rooted"), Rejected::Absolute);
assert_eq!(join("//").expect_err("separators only"), Rejected::Absolute);
assert_eq!(
safe_join(Path::new("/srv/root"), "a.png").expect("a bare name is unaffected"),
PathBuf::from("/srv/root/a.png")
);
}
}