|
| 1 | +//! Adversarial `prefix` / `suffix` handling. |
| 2 | +//! |
| 3 | +//! Affixes are composed into a single path component |
| 4 | +//! (`{prefix}{random}{suffix}`). These tests pin down the behavior for hostile |
| 5 | +//! affixes: |
| 6 | +//! |
| 7 | +//! * Path separators / traversal must be **rejected** so a name can never escape |
| 8 | +//! the target directory (`../` traversal, or an absolute prefix that would |
| 9 | +//! otherwise replace the target via `Path::join`). |
| 10 | +//! * Names the OS itself rejects (an embedded NUL, an over-long component) must |
| 11 | +//! surface as a clean `Err`, never a panic or an infinite retry loop. |
| 12 | +//! * Ordinary affixes keep working and stay inside the target directory. |
| 13 | +
|
| 14 | +use async_tempfile::{TempDir, TempFile}; |
| 15 | + |
| 16 | +// --- path separators / traversal are rejected ------------------------------- |
| 17 | + |
| 18 | +#[tokio::test] |
| 19 | +async fn file_prefix_with_path_separator_is_rejected() { |
| 20 | + let dir = TempDir::new().await.unwrap(); |
| 21 | + let result = TempFile::builder() |
| 22 | + .prefix("sub/evil_") |
| 23 | + .dir(dir.dir_path().clone()) |
| 24 | + .create() |
| 25 | + .await; |
| 26 | + assert!(result.is_err(), "separator in prefix must be rejected"); |
| 27 | +} |
| 28 | + |
| 29 | +#[tokio::test] |
| 30 | +async fn file_suffix_with_path_separator_is_rejected() { |
| 31 | + let dir = TempDir::new().await.unwrap(); |
| 32 | + let result = TempFile::builder() |
| 33 | + .suffix("/etc/passwd") |
| 34 | + .dir(dir.dir_path().clone()) |
| 35 | + .create() |
| 36 | + .await; |
| 37 | + assert!(result.is_err(), "separator in suffix must be rejected"); |
| 38 | +} |
| 39 | + |
| 40 | +#[tokio::test] |
| 41 | +async fn file_traversal_prefix_cannot_escape_target_dir() { |
| 42 | + // A nested target dir so an escape would be observable: `../` would land the |
| 43 | + // file in the parent (`root`) instead of `target`. |
| 44 | + let root = TempDir::new().await.unwrap(); |
| 45 | + let target = TempDir::new_in(root.dir_path().as_path()).await.unwrap(); |
| 46 | + |
| 47 | + let result = TempFile::builder() |
| 48 | + .prefix("../") |
| 49 | + .dir(target.dir_path().clone()) |
| 50 | + .create() |
| 51 | + .await; |
| 52 | + |
| 53 | + assert!(result.is_err(), "`../` traversal must be rejected"); |
| 54 | + |
| 55 | + // Nothing leaked one level up into `root`. |
| 56 | + let mut entries = tokio::fs::read_dir(root.dir_path()).await.unwrap(); |
| 57 | + while let Some(entry) = entries.next_entry().await.unwrap() { |
| 58 | + assert_eq!( |
| 59 | + entry.path(), |
| 60 | + *target.dir_path(), |
| 61 | + "unexpected entry escaped into the parent dir: {:?}", |
| 62 | + entry.path() |
| 63 | + ); |
| 64 | + } |
| 65 | +} |
| 66 | + |
| 67 | +#[tokio::test] |
| 68 | +async fn file_absolute_prefix_is_rejected() { |
| 69 | + let dir = TempDir::new().await.unwrap(); |
| 70 | + let result = TempFile::builder() |
| 71 | + .prefix("/tmp/abs_") |
| 72 | + .dir(dir.dir_path().clone()) |
| 73 | + .create() |
| 74 | + .await; |
| 75 | + assert!( |
| 76 | + result.is_err(), |
| 77 | + "absolute (separator-bearing) prefix must be rejected" |
| 78 | + ); |
| 79 | +} |
| 80 | + |
| 81 | +#[tokio::test] |
| 82 | +async fn dir_prefix_with_path_separator_is_rejected() { |
| 83 | + let root = TempDir::new().await.unwrap(); |
| 84 | + let result = TempDir::builder() |
| 85 | + .prefix("../escaped_") |
| 86 | + .dir(root.dir_path().clone()) |
| 87 | + .create() |
| 88 | + .await; |
| 89 | + assert!(result.is_err(), "separator in dir prefix must be rejected"); |
| 90 | +} |
| 91 | + |
| 92 | +// --- OS-rejected names surface as a clean `Err`, never a panic -------------- |
| 93 | + |
| 94 | +#[tokio::test] |
| 95 | +async fn file_nul_byte_in_suffix_errors_without_panic() { |
| 96 | + let dir = TempDir::new().await.unwrap(); |
| 97 | + let result = TempFile::builder() |
| 98 | + .suffix("\0bad") |
| 99 | + .dir(dir.dir_path().clone()) |
| 100 | + .create() |
| 101 | + .await; |
| 102 | + assert!(result.is_err(), "embedded NUL must error, not panic"); |
| 103 | +} |
| 104 | + |
| 105 | +#[tokio::test] |
| 106 | +async fn file_overlong_prefix_errors_without_panic() { |
| 107 | + let dir = TempDir::new().await.unwrap(); |
| 108 | + let result = TempFile::builder() |
| 109 | + .prefix("a".repeat(5000)) |
| 110 | + .dir(dir.dir_path().clone()) |
| 111 | + .create() |
| 112 | + .await; |
| 113 | + assert!(result.is_err(), "over-long name must error, not panic"); |
| 114 | +} |
| 115 | + |
| 116 | +// --- ordinary affixes keep working and stay contained ----------------------- |
| 117 | + |
| 118 | +#[tokio::test] |
| 119 | +async fn ordinary_affixes_still_work_and_stay_contained() { |
| 120 | + let dir = TempDir::new().await.unwrap(); |
| 121 | + let file = TempFile::builder() |
| 122 | + .prefix("ok_") |
| 123 | + .suffix(".log") |
| 124 | + .dir(dir.dir_path().clone()) |
| 125 | + .create() |
| 126 | + .await |
| 127 | + .unwrap(); |
| 128 | + |
| 129 | + let name = file |
| 130 | + .file_path() |
| 131 | + .file_name() |
| 132 | + .unwrap() |
| 133 | + .to_string_lossy() |
| 134 | + .into_owned(); |
| 135 | + assert!(name.starts_with("ok_"), "name was {name}"); |
| 136 | + assert!(name.ends_with(".log"), "name was {name}"); |
| 137 | + |
| 138 | + // The file lives directly inside the requested directory. |
| 139 | + assert_eq!(file.file_path().parent().unwrap(), dir.dir_path()); |
| 140 | +} |
0 commit comments