1#[cfg(unix)]
2use std::ffi::CString;
3use std::ffi::{OsStr, OsString};
4use std::fs::{self, File, OpenOptions};
5use std::io::{self, Read, Seek, SeekFrom, Write};
6#[cfg(unix)]
7use std::os::fd::{AsRawFd, FromRawFd, RawFd};
8#[cfg(unix)]
9use std::os::unix::ffi::{OsStrExt, OsStringExt};
10#[cfg(unix)]
11use std::os::unix::fs::{MetadataExt, OpenOptionsExt, PermissionsExt};
12#[cfg(windows)]
13use std::os::windows::fs::{MetadataExt, OpenOptionsExt};
14#[cfg(windows)]
15use std::os::windows::io::AsRawHandle;
16use std::path::{Path, PathBuf};
17use std::sync::Arc;
18use std::time::{SystemTime, UNIX_EPOCH};
19
20use serde::{Deserialize, Serialize};
21
22use crate::backup::hash_session;
23use crate::bash_permissions::PermissionAsk;
24use crate::db::bash_tasks::BashTaskRow;
25
26use super::BgTaskStatus;
27
28pub const SCHEMA_VERSION: u32 = 6;
29const CONTROL_DIR: &str = "control";
30const IO_DIR: &str = "io";
31const METADATA_FILE: &str = "metadata.json";
32pub const COMMAND_FILE: &str = "command.sh";
33pub const WRAPPER_FILE: &str = "wrapper.sh";
34pub const ENVIRONMENT_FILE: &str = "environment.bin";
35pub const MANIFEST_FILE: &str = "manifest.blake3";
36pub const SANDBOX_PROFILE_FILE: &str = "sandbox-profile.json";
37
38#[derive(Debug, Clone, Copy, PartialEq, Eq)]
39pub enum TaskLayout {
40 Flat,
41 Directory,
42}
43
44#[derive(Debug, Clone)]
45pub struct TaskPaths {
46 pub layout: TaskLayout,
47 pub task_id: String,
48 pub session_dir: PathBuf,
49 pub dir: PathBuf,
52 pub control_dir: PathBuf,
53 pub io_dir: PathBuf,
54 pub json: PathBuf,
55 pub stdout: PathBuf,
56 pub stderr: PathBuf,
57 pub exit: PathBuf,
58 pub pipeline_status: PathBuf,
59 pub pty: PathBuf,
60 pub sandbox_unavailable: PathBuf,
61 pub command: PathBuf,
62 pub wrapper: PathBuf,
63 pub environment: PathBuf,
64 pub manifest: PathBuf,
65 pub sandbox_profile: PathBuf,
66}
67
68impl TaskPaths {
69 fn directory(session_dir: PathBuf, task_id: &str) -> Self {
70 let dir = session_dir.join(task_id);
71 let control_dir = dir.join(CONTROL_DIR);
72 let io_dir = dir.join(IO_DIR);
73 Self {
74 layout: TaskLayout::Directory,
75 task_id: task_id.to_string(),
76 session_dir,
77 dir,
78 json: control_dir.join(METADATA_FILE),
79 stdout: io_dir.join(TaskArtifact::Stdout.file_name()),
80 stderr: io_dir.join(TaskArtifact::Stderr.file_name()),
81 exit: io_dir.join(TaskArtifact::Exit.file_name()),
82 pipeline_status: io_dir.join(TaskArtifact::PipelineStatus.file_name()),
83 pty: io_dir.join(TaskArtifact::Pty.file_name()),
84 sandbox_unavailable: io_dir.join(TaskArtifact::SandboxUnavailable.file_name()),
85 command: control_dir.join(COMMAND_FILE),
86 wrapper: control_dir.join(WRAPPER_FILE),
87 environment: control_dir.join(ENVIRONMENT_FILE),
88 manifest: control_dir.join(MANIFEST_FILE),
89 sandbox_profile: control_dir.join(SANDBOX_PROFILE_FILE),
90 control_dir,
91 io_dir,
92 }
93 }
94
95 fn flat(session_dir: PathBuf, task_id: &str) -> Self {
96 let prefix = |extension: &str| session_dir.join(format!("{task_id}.{extension}"));
97 Self {
98 layout: TaskLayout::Flat,
99 task_id: task_id.to_string(),
100 dir: session_dir.clone(),
101 control_dir: session_dir.clone(),
102 io_dir: session_dir.clone(),
103 json: prefix("json"),
104 stdout: prefix("stdout"),
105 stderr: prefix("stderr"),
106 exit: prefix("exit"),
107 pipeline_status: prefix("pipeline-status"),
108 pty: prefix("pty"),
109 sandbox_unavailable: prefix("sandbox-unavailable"),
110 command: prefix("sh"),
111 wrapper: prefix("wrapper.sh"),
112 environment: prefix("env"),
113 manifest: prefix("manifest"),
114 sandbox_profile: prefix("sandbox-profile.json"),
115 session_dir,
116 }
117 }
118
119 pub fn artifact_path(&self, artifact: TaskArtifact) -> &Path {
120 match artifact {
121 TaskArtifact::Stdout => &self.stdout,
122 TaskArtifact::Stderr => &self.stderr,
123 TaskArtifact::Exit => &self.exit,
124 TaskArtifact::PipelineStatus => &self.pipeline_status,
125 TaskArtifact::Pty => &self.pty,
126 TaskArtifact::SandboxUnavailable => &self.sandbox_unavailable,
127 }
128 }
129
130 fn artifact_name(&self, artifact: TaskArtifact) -> OsString {
131 match self.layout {
132 TaskLayout::Directory => OsString::from(artifact.file_name()),
133 TaskLayout::Flat => {
134 OsString::from(format!("{}.{}", self.task_id, artifact.flat_extension()))
135 }
136 }
137 }
138}
139
140#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
141pub enum TaskArtifact {
142 Stdout,
143 Stderr,
144 Exit,
145 PipelineStatus,
146 Pty,
147 SandboxUnavailable,
148}
149
150impl TaskArtifact {
151 pub const ALL: [Self; 6] = [
152 Self::Stdout,
153 Self::Stderr,
154 Self::Exit,
155 Self::PipelineStatus,
156 Self::Pty,
157 Self::SandboxUnavailable,
158 ];
159
160 pub fn file_name(self) -> &'static str {
161 match self {
162 Self::Stdout => "stdout",
163 Self::Stderr => "stderr",
164 Self::Exit => "exit",
165 Self::PipelineStatus => "pipeline-status",
166 Self::Pty => "pty",
167 Self::SandboxUnavailable => "sandbox-unavailable",
168 }
169 }
170
171 fn flat_extension(self) -> &'static str {
172 match self {
173 Self::Stdout => "stdout",
174 Self::Stderr => "stderr",
175 Self::Exit => "exit",
176 Self::PipelineStatus => "pipeline-status",
177 Self::Pty => "pty",
178 Self::SandboxUnavailable => "sandbox-unavailable",
179 }
180 }
181}
182
183#[derive(Debug)]
184pub struct PinnedDir {
185 file: File,
186 path: PathBuf,
187}
188
189impl PinnedDir {
190 pub fn open(path: &Path) -> io::Result<Self> {
191 #[cfg(unix)]
192 let file = OpenOptions::new()
193 .read(true)
194 .custom_flags(libc::O_DIRECTORY | libc::O_NOFOLLOW | libc::O_CLOEXEC)
195 .open(path)?;
196 #[cfg(windows)]
197 let file = OpenOptions::new()
198 .read(true)
199 .custom_flags(FILE_FLAG_OPEN_REPARSE_POINT | FILE_FLAG_BACKUP_SEMANTICS)
200 .open(path)?;
201 validate_directory_handle(&file)?;
202 Ok(Self {
203 file,
204 path: path.to_path_buf(),
205 })
206 }
207
208 pub fn path(&self) -> &Path {
209 &self.path
210 }
211
212 fn modified(&self) -> io::Result<SystemTime> {
213 self.file.metadata()?.modified()
214 }
215
216 fn same_identity(&self, other: &Self) -> io::Result<bool> {
217 #[cfg(unix)]
218 {
219 let left = self.file.metadata()?;
220 let right = other.file.metadata()?;
221 Ok(left.dev() == right.dev() && left.ino() == right.ino())
222 }
223 #[cfg(windows)]
224 {
225 let left = windows_file_information(&self.file)?;
226 let right = windows_file_information(&other.file)?;
227 Ok(left.volume_serial_number == right.volume_serial_number
228 && left.file_index_high == right.file_index_high
229 && left.file_index_low == right.file_index_low)
230 }
231 }
232
233 #[cfg(unix)]
234 fn open_dir_at(&self, name: &OsStr) -> io::Result<Self> {
235 let file = openat_file(
236 self.file.as_raw_fd(),
237 name,
238 libc::O_RDONLY | libc::O_DIRECTORY | libc::O_NOFOLLOW | libc::O_CLOEXEC,
239 0,
240 )?;
241 validate_directory_handle(&file)?;
242 Ok(Self {
243 file,
244 path: self.path.join(name),
245 })
246 }
247
248 #[cfg(windows)]
249 fn open_dir_at(&self, name: &OsStr) -> io::Result<Self> {
250 self.ensure_current_identity()?;
251 let child = Self::open(&self.path.join(name))?;
252 self.ensure_current_identity()?;
253 Ok(child)
254 }
255
256 #[cfg(unix)]
257 fn create_dir_at(&self, name: &OsStr) -> io::Result<Self> {
258 let name = os_cstring(name)?;
259 let result = unsafe { libc::mkdirat(self.file.as_raw_fd(), name.as_ptr(), 0o700) };
260 if result != 0 {
261 return Err(io::Error::last_os_error());
262 }
263 self.open_dir_at(OsStr::from_bytes(name.as_bytes()))
264 }
265
266 #[cfg(windows)]
267 fn create_dir_at(&self, name: &OsStr) -> io::Result<Self> {
268 self.ensure_current_identity()?;
269 let path = self.path.join(name);
270 fs::create_dir(&path)?;
271 self.ensure_current_identity()?;
272 Self::open(&path)
273 }
274
275 pub fn open_new_file(&self, name: &OsStr) -> io::Result<File> {
276 #[cfg(unix)]
277 let file = openat_file(
278 self.file.as_raw_fd(),
279 name,
280 libc::O_RDWR | libc::O_CREAT | libc::O_EXCL | libc::O_NOFOLLOW | libc::O_CLOEXEC,
281 0o600,
282 )?;
283 #[cfg(windows)]
284 self.ensure_current_identity()?;
285 #[cfg(windows)]
286 let file = OpenOptions::new()
287 .read(true)
288 .write(true)
289 .create_new(true)
290 .custom_flags(FILE_FLAG_OPEN_REPARSE_POINT)
291 .open(self.path.join(name))?;
292 validate_regular_handle(&file)?;
293 #[cfg(windows)]
294 self.ensure_current_identity()?;
295 Ok(file)
296 }
297
298 pub fn open_file(&self, name: &OsStr, write: bool) -> io::Result<File> {
299 #[cfg(unix)]
300 let file = openat_file(
301 self.file.as_raw_fd(),
302 name,
303 (if write {
304 libc::O_RDWR
305 } else {
306 libc::O_RDONLY | libc::O_NONBLOCK
307 }) | libc::O_NOFOLLOW
308 | libc::O_CLOEXEC,
309 0,
310 )?;
311 #[cfg(windows)]
312 self.ensure_current_identity()?;
313 #[cfg(windows)]
314 let file = OpenOptions::new()
315 .read(true)
316 .write(write)
317 .custom_flags(FILE_FLAG_OPEN_REPARSE_POINT)
318 .open(self.path.join(name))?;
319 validate_regular_handle(&file)?;
320 #[cfg(unix)]
321 if !write {
322 clear_nonblocking(&file)?;
323 }
324 #[cfg(windows)]
325 self.ensure_current_identity()?;
326 Ok(file)
327 }
328
329 pub fn list_names(&self) -> io::Result<Vec<OsString>> {
330 #[cfg(unix)]
331 {
332 let dot = b".\0";
333 let fresh = unsafe {
334 libc::openat(
335 self.file.as_raw_fd(),
336 dot.as_ptr().cast(),
337 libc::O_RDONLY | libc::O_DIRECTORY | libc::O_CLOEXEC | libc::O_NOFOLLOW,
338 )
339 };
340 if fresh < 0 {
341 return Err(io::Error::last_os_error());
342 }
343 let directory = unsafe { libc::fdopendir(fresh) };
344 if directory.is_null() {
345 let error = io::Error::last_os_error();
346 unsafe { libc::close(fresh) };
347 return Err(error);
348 }
349 let mut names = Vec::new();
350 loop {
351 let entry = unsafe { libc::readdir(directory) };
352 if entry.is_null() {
353 break;
354 }
355 let bytes = unsafe {
356 std::ffi::CStr::from_ptr((*entry).d_name.as_ptr())
357 .to_bytes()
358 .to_vec()
359 };
360 if bytes != b"." && bytes != b".." {
361 names.push(OsString::from_vec(bytes));
362 }
363 }
364 unsafe { libc::closedir(directory) };
365 Ok(names)
366 }
367 #[cfg(windows)]
368 {
369 self.ensure_current_identity()?;
370 let names = fs::read_dir(&self.path)?
371 .map(|entry| entry.map(|entry| entry.file_name()))
372 .collect::<io::Result<Vec<_>>>()?;
373 self.ensure_current_identity()?;
374 Ok(names)
375 }
376 }
377
378 fn rename(&self, from: &OsStr, to: &OsStr) -> io::Result<()> {
379 self.rename_to(from, self, to)
380 }
381
382 fn rename_to(&self, from: &OsStr, target: &PinnedDir, to: &OsStr) -> io::Result<()> {
383 #[cfg(unix)]
384 {
385 let from = os_cstring(from)?;
386 let to = os_cstring(to)?;
387 let result = unsafe {
388 libc::renameat(
389 self.file.as_raw_fd(),
390 from.as_ptr(),
391 target.file.as_raw_fd(),
392 to.as_ptr(),
393 )
394 };
395 if result != 0 {
396 return Err(io::Error::last_os_error());
397 }
398 Ok(())
399 }
400 #[cfg(windows)]
401 {
402 self.ensure_current_identity()?;
403 target.ensure_current_identity()?;
404 fs::rename(self.path.join(from), target.path.join(to))?;
405 self.ensure_current_identity()?;
406 target.ensure_current_identity()
407 }
408 }
409
410 #[cfg(windows)]
411 fn ensure_current_identity(&self) -> io::Result<()> {
412 let current = OpenOptions::new()
413 .read(true)
414 .custom_flags(FILE_FLAG_OPEN_REPARSE_POINT | FILE_FLAG_BACKUP_SEMANTICS)
415 .open(&self.path)?;
416 validate_directory_handle(¤t)?;
417 let held = windows_file_information(&self.file)?;
418 let observed = windows_file_information(¤t)?;
419 if held.volume_serial_number != observed.volume_serial_number
420 || held.file_index_high != observed.file_index_high
421 || held.file_index_low != observed.file_index_low
422 {
423 return Err(io::Error::new(
424 io::ErrorKind::PermissionDenied,
425 "pinned directory path identity changed",
426 ));
427 }
428 Ok(())
429 }
430
431 fn remove_file(&self, name: &OsStr) -> io::Result<()> {
432 #[cfg(unix)]
433 {
434 let name = os_cstring(name)?;
435 let result = unsafe { libc::unlinkat(self.file.as_raw_fd(), name.as_ptr(), 0) };
436 if result != 0 {
437 return Err(io::Error::last_os_error());
438 }
439 Ok(())
440 }
441 #[cfg(windows)]
442 {
443 self.ensure_current_identity()?;
444 fs::remove_file(self.path.join(name))?;
445 self.ensure_current_identity()
446 }
447 }
448}
449
450#[derive(Debug)]
451pub struct TaskDirs {
452 pub session: Arc<PinnedDir>,
453 pub task: Arc<PinnedDir>,
454 pub control: Arc<PinnedDir>,
455 pub io: Arc<PinnedDir>,
456}
457
458impl Clone for TaskDirs {
459 fn clone(&self) -> Self {
460 Self {
461 session: Arc::clone(&self.session),
462 task: Arc::clone(&self.task),
463 control: Arc::clone(&self.control),
464 io: Arc::clone(&self.io),
465 }
466 }
467}
468
469#[derive(Debug)]
470pub struct ResolvedTask {
471 pub paths: TaskPaths,
472 pub dirs: TaskDirs,
473}
474
475#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq, Default)]
476#[serde(rename_all = "lowercase")]
477pub enum BgMode {
478 #[default]
479 Pipes,
480 Pty,
481}
482
483#[derive(Debug, Clone, Serialize, Deserialize)]
484pub struct PersistedTask {
485 pub schema_version: u32,
486 pub task_id: String,
487 pub session_id: String,
488 pub command: String,
489 #[serde(default, skip_serializing_if = "Vec::is_empty")]
492 pub pipeline_segments: Vec<String>,
493 #[serde(default)]
494 pub mode: BgMode,
495 pub workdir: PathBuf,
496 #[serde(default)]
497 pub project_root: Option<PathBuf>,
498 pub status: BgTaskStatus,
499 pub started_at: u64,
500 pub finished_at: Option<u64>,
501 pub duration_ms: Option<u64>,
502 pub timeout_ms: Option<u64>,
503 pub exit_code: Option<i32>,
504 pub child_pid: Option<u32>,
505 pub pgid: Option<i32>,
506 pub completion_delivered: bool,
507 #[serde(default = "default_notify_on_completion")]
508 pub notify_on_completion: bool,
509 #[serde(default = "default_compressed")]
510 pub compressed: bool,
511 #[serde(default)]
512 pub pty_rows: Option<u16>,
513 #[serde(default)]
514 pub pty_cols: Option<u16>,
515 #[serde(default, skip_serializing_if = "Vec::is_empty")]
516 pub scanner_report: Vec<PermissionAsk>,
517 #[serde(default)]
518 pub sandbox_native: bool,
519 #[serde(default, skip_serializing_if = "Option::is_none")]
520 pub sandbox_temp_dir: Option<PathBuf>,
521 pub status_reason: Option<String>,
522}
523
524fn default_notify_on_completion() -> bool {
525 true
526}
527
528fn default_compressed() -> bool {
529 true
530}
531
532#[derive(Debug, Clone, PartialEq, Eq)]
533pub enum ExitMarker {
534 Code(i32),
535 Killed,
536}
537
538impl PersistedTask {
539 #[allow(clippy::too_many_arguments)]
540 pub fn starting(
541 task_id: String,
542 session_id: String,
543 command: String,
544 workdir: PathBuf,
545 project_root: Option<PathBuf>,
546 timeout_ms: Option<u64>,
547 notify_on_completion: bool,
548 compressed: bool,
549 ) -> Self {
550 Self {
551 schema_version: SCHEMA_VERSION,
552 task_id,
553 session_id,
554 command,
555 pipeline_segments: Vec::new(),
556 mode: BgMode::Pipes,
557 workdir,
558 project_root,
559 status: BgTaskStatus::Starting,
560 started_at: unix_millis(),
561 finished_at: None,
562 duration_ms: None,
563 timeout_ms,
564 exit_code: None,
565 child_pid: None,
566 pgid: None,
567 completion_delivered: !notify_on_completion,
568 notify_on_completion,
569 compressed,
570 pty_rows: None,
571 pty_cols: None,
572 scanner_report: Vec::new(),
573 sandbox_native: false,
574 sandbox_temp_dir: None,
575 status_reason: None,
576 }
577 }
578
579 pub fn is_terminal(&self) -> bool {
580 self.status.is_terminal()
581 }
582
583 pub fn mark_running(&mut self, child_pid: u32, pgid: i32) {
584 self.status = BgTaskStatus::Running;
585 self.child_pid = Some(child_pid);
586 self.pgid = Some(pgid);
587 }
588
589 pub fn mark_terminal(
590 &mut self,
591 status: BgTaskStatus,
592 exit_code: Option<i32>,
593 reason: Option<String>,
594 ) {
595 let finished_at = unix_millis();
596 self.status = status;
597 self.exit_code = exit_code;
598 self.finished_at = Some(finished_at);
599 self.duration_ms = Some(finished_at.saturating_sub(self.started_at));
600 self.child_pid = None;
601 self.status_reason = reason;
602 self.completion_delivered = !self.notify_on_completion;
603 }
604
605 pub fn to_bash_task_row(
606 &self,
607 harness: &str,
608 paths: &TaskPaths,
609 ) -> Result<BashTaskRow, serde_json::Error> {
610 let project_root = self.project_root.as_deref().unwrap_or(&self.workdir);
611 let output_bytes = capture_output_bytes(&self.mode, paths);
612 let stdout_path = match self.mode {
613 BgMode::Pipes => Some(paths.stdout.display().to_string()),
614 BgMode::Pty => Some(paths.pty.display().to_string()),
615 };
616 let stderr_path = match self.mode {
617 BgMode::Pipes => Some(paths.stderr.display().to_string()),
618 BgMode::Pty => None,
619 };
620 let mut metadata = self.clone();
621 metadata.schema_version = SCHEMA_VERSION;
622 Ok(BashTaskRow {
623 harness: harness.to_string(),
624 session_id: self.session_id.clone(),
625 task_id: self.task_id.clone(),
626 project_key: crate::path_identity::project_scope_key(project_root),
627 command: self.command.clone(),
628 cwd: self.workdir.display().to_string(),
629 status: status_name(&self.status).to_string(),
630 exit_code: self.exit_code,
631 pid: self.child_pid.map(i64::from),
632 pgid: self.pgid.map(i64::from),
633 started_at: self.started_at as i64,
634 completed_at: self.finished_at.map(|value| value as i64),
635 stdout_path,
636 stderr_path,
637 compressed: self.compressed,
638 timeout_ms: self.timeout_ms.map(|value| value as i64),
639 completion_delivered: self.completion_delivered,
640 output_bytes,
641 metadata: serde_json::to_string(&metadata)?,
642 })
643 }
644}
645
646impl From<BashTaskRow> for PersistedTask {
647 fn from(row: BashTaskRow) -> Self {
648 if let Ok(task) = serde_json::from_str::<PersistedTask>(&row.metadata) {
649 return task;
650 }
651 let status = match row.status.as_str() {
652 "starting" => BgTaskStatus::Starting,
653 "running" => BgTaskStatus::Running,
654 "killing" => BgTaskStatus::Killing,
655 "completed" => BgTaskStatus::Completed,
656 "failed" => BgTaskStatus::Failed,
657 "killed" => BgTaskStatus::Killed,
658 "timed_out" => BgTaskStatus::TimedOut,
659 _ => BgTaskStatus::Failed,
660 };
661 let started_at = u64::try_from(row.started_at).unwrap_or_default();
662 let finished_at = row.completed_at.and_then(|value| u64::try_from(value).ok());
663 Self {
664 schema_version: SCHEMA_VERSION,
665 task_id: row.task_id,
666 session_id: row.session_id,
667 command: row.command,
668 pipeline_segments: Vec::new(),
669 mode: BgMode::Pipes,
670 workdir: PathBuf::from(row.cwd),
671 project_root: None,
672 status,
673 started_at,
674 finished_at,
675 duration_ms: finished_at.map(|finished_at| finished_at.saturating_sub(started_at)),
676 timeout_ms: row.timeout_ms.and_then(|value| u64::try_from(value).ok()),
677 exit_code: row.exit_code,
678 child_pid: row.pid.and_then(|value| u32::try_from(value).ok()),
679 pgid: row.pgid.and_then(|value| i32::try_from(value).ok()),
680 completion_delivered: row.completion_delivered,
681 notify_on_completion: !row.completion_delivered,
682 compressed: row.compressed,
683 pty_rows: None,
684 pty_cols: None,
685 scanner_report: Vec::new(),
686 sandbox_native: false,
687 sandbox_temp_dir: None,
688 status_reason: None,
689 }
690 }
691}
692
693fn status_name(status: &BgTaskStatus) -> &'static str {
694 match status {
695 BgTaskStatus::Starting => "starting",
696 BgTaskStatus::Running => "running",
697 BgTaskStatus::Killing => "killing",
698 BgTaskStatus::Completed => "completed",
699 BgTaskStatus::Failed => "failed",
700 BgTaskStatus::Killed => "killed",
701 BgTaskStatus::TimedOut => "timed_out",
702 }
703}
704
705fn capture_output_bytes(mode: &BgMode, paths: &TaskPaths) -> Option<i64> {
706 let len = |artifact| {
707 open_task_artifact(paths, artifact)
708 .ok()
709 .and_then(|file| file.len().ok())
710 };
711 match mode {
712 BgMode::Pipes => match (len(TaskArtifact::Stdout), len(TaskArtifact::Stderr)) {
713 (Some(stdout), Some(stderr)) => Some(stdout.saturating_add(stderr) as i64),
714 (Some(bytes), None) | (None, Some(bytes)) => Some(bytes as i64),
715 (None, None) => None,
716 },
717 BgMode::Pty => len(TaskArtifact::Pty).map(|bytes| bytes as i64),
718 }
719}
720
721pub fn validate_task_id(task_id: &str) -> io::Result<()> {
722 let bytes = task_id.as_bytes();
723 if bytes.len() == 21
724 && bytes.starts_with(b"bash-")
725 && bytes[5..]
726 .iter()
727 .all(|byte| byte.is_ascii_digit() || (b'a'..=b'f').contains(byte))
728 {
729 Ok(())
730 } else {
731 Err(io::Error::new(
732 io::ErrorKind::InvalidInput,
733 "background task id must match ^bash-[0-9a-f]{16}$",
734 ))
735 }
736}
737
738pub fn session_tasks_dir(storage_dir: &Path, session_id: &str) -> PathBuf {
739 let session_hash = hash_session(session_id);
740 let direct = storage_dir.join("bash-tasks").join(&session_hash);
741 if direct.exists() {
742 return direct;
743 }
744 let mut harness_matches = ["opencode", "pi"]
745 .into_iter()
746 .map(|harness| {
747 storage_dir
748 .join(harness)
749 .join("bash-tasks")
750 .join(&session_hash)
751 })
752 .filter(|path| path.exists())
753 .collect::<Vec<_>>();
754 if harness_matches.len() == 1 {
755 return harness_matches.remove(0);
756 }
757 direct
758}
759
760pub fn task_paths(storage_dir: &Path, session_id: &str, task_id: &str) -> io::Result<TaskPaths> {
761 validate_task_id(task_id)?;
762 Ok(TaskPaths::flat(
763 session_tasks_dir(storage_dir, session_id),
764 task_id,
765 ))
766}
767
768pub fn allocate_task_layout(storage_dir: &Path, session_id: &str) -> io::Result<ResolvedTask> {
769 let session_dir = session_tasks_dir(storage_dir, session_id);
770 create_private_task_store(&session_dir)?;
771 let session = Arc::new(PinnedDir::open(&session_dir)?);
772 for _ in 0..32 {
773 let task_id = random_task_id()?;
774 match create_task_layout_from_session(Arc::clone(&session), &task_id) {
775 Ok(task) => return Ok(task),
776 Err(error) if error.kind() == io::ErrorKind::AlreadyExists => continue,
777 Err(error) => return Err(error),
778 }
779 }
780 Err(io::Error::new(
781 io::ErrorKind::AlreadyExists,
782 "failed to allocate unique background task id after 32 attempts",
783 ))
784}
785
786pub fn create_task_layout(
787 storage_dir: &Path,
788 session_id: &str,
789 task_id: &str,
790) -> io::Result<ResolvedTask> {
791 validate_task_id(task_id)?;
792 let session_dir = session_tasks_dir(storage_dir, session_id);
793 create_private_task_store(&session_dir)?;
794 create_task_layout_from_session(Arc::new(PinnedDir::open(&session_dir)?), task_id)
795}
796
797fn create_private_task_store(session_dir: &Path) -> io::Result<()> {
798 fs::create_dir_all(session_dir)?;
799 #[cfg(unix)]
800 {
801 let parent = session_dir.parent().ok_or_else(|| {
802 io::Error::new(
803 io::ErrorKind::InvalidInput,
804 "session task directory has no bash-tasks parent",
805 )
806 })?;
807 fs::set_permissions(parent, fs::Permissions::from_mode(0o700))?;
808 fs::set_permissions(session_dir, fs::Permissions::from_mode(0o700))?;
809 }
810 Ok(())
811}
812
813fn create_task_layout_from_session(
814 session: Arc<PinnedDir>,
815 task_id: &str,
816) -> io::Result<ResolvedTask> {
817 validate_task_id(task_id)?;
818 let task = session.create_dir_at(OsStr::new(task_id))?;
819 let control = task.create_dir_at(OsStr::new(CONTROL_DIR))?;
820 let io_dir = task.create_dir_at(OsStr::new(IO_DIR))?;
821 let paths = TaskPaths::directory(session.path.clone(), task_id);
822 Ok(ResolvedTask {
823 paths,
824 dirs: TaskDirs {
825 session,
826 task: Arc::new(task),
827 control: Arc::new(control),
828 io: Arc::new(io_dir),
829 },
830 })
831}
832
833pub fn resolve_task_layout(session_dir: &Path, task_id: &str) -> io::Result<ResolvedTask> {
834 let task = resolve_uninitialized_task_layout(session_dir, task_id)?;
835 let metadata = read_task_at(&task)?;
836 if metadata.task_id != task_id {
837 return Err(io::Error::new(
838 io::ErrorKind::InvalidData,
839 "background task metadata identity mismatch",
840 ));
841 }
842 Ok(task)
843}
844
845pub fn resolve_uninitialized_task_layout(
846 session_dir: &Path,
847 task_id: &str,
848) -> io::Result<ResolvedTask> {
849 validate_task_id(task_id)?;
850 let session = Arc::new(PinnedDir::open(session_dir)?);
851 let directory = session.open_dir_at(OsStr::new(task_id));
852 let flat_name = OsString::from(format!("{task_id}.json"));
853 let flat = session.open_file(&flat_name, false);
854 let has_directory = match &directory {
855 Ok(_) => true,
856 Err(error) if error.kind() == io::ErrorKind::NotFound => false,
857 Err(error) => {
858 return Err(io::Error::new(
859 error.kind(),
860 format!("invalid task directory: {error}"),
861 ))
862 }
863 };
864 let has_flat = match &flat {
865 Ok(_) => true,
866 Err(error) if error.kind() == io::ErrorKind::NotFound => false,
867 Err(error) => {
868 return Err(io::Error::new(
869 error.kind(),
870 format!("invalid flat task metadata: {error}"),
871 ))
872 }
873 };
874 if has_directory && has_flat {
875 return Err(io::Error::new(
876 io::ErrorKind::InvalidData,
877 "duplicate flat and directory background task layouts",
878 ));
879 }
880 if has_directory {
881 let task = directory.expect("directory result checked");
882 let control = task.open_dir_at(OsStr::new(CONTROL_DIR))?;
883 let io_dir = task.open_dir_at(OsStr::new(IO_DIR))?;
884 let paths = TaskPaths::directory(session_dir.to_path_buf(), task_id);
885 return Ok(ResolvedTask {
886 paths,
887 dirs: TaskDirs {
888 session,
889 task: Arc::new(task),
890 control: Arc::new(control),
891 io: Arc::new(io_dir),
892 },
893 });
894 }
895 if has_flat {
896 let paths = TaskPaths::flat(session_dir.to_path_buf(), task_id);
897 return Ok(ResolvedTask {
898 paths,
899 dirs: TaskDirs {
900 session: Arc::clone(&session),
901 task: Arc::clone(&session),
902 control: Arc::clone(&session),
903 io: session,
904 },
905 });
906 }
907 Err(io::Error::new(
908 io::ErrorKind::NotFound,
909 "background task layout not found",
910 ))
911}
912
913pub fn resolve_task(
914 storage_dir: &Path,
915 session_id: &str,
916 task_id: &str,
917) -> io::Result<ResolvedTask> {
918 resolve_task_layout(&session_tasks_dir(storage_dir, session_id), task_id)
919}
920
921pub fn discover_task_ids(session_dir: &Path) -> io::Result<(Vec<String>, Vec<OsString>)> {
922 let session = PinnedDir::open(session_dir)?;
923 let mut ids = std::collections::BTreeSet::new();
924 let mut invalid = Vec::new();
925 for name in session.list_names()? {
926 let Some(text) = name.to_str() else {
927 invalid.push(name);
928 continue;
929 };
930 if validate_task_id(text).is_ok() {
931 ids.insert(text.to_string());
932 continue;
933 }
934 if let Some((task_id, _suffix)) = text.split_once('.') {
935 if validate_task_id(task_id).is_ok() {
936 ids.insert(task_id.to_string());
937 } else if task_id.starts_with("bash-") {
938 invalid.push(name);
939 }
940 } else if text.starts_with("bash-") {
941 invalid.push(name);
942 }
943 }
944 Ok((ids.into_iter().collect(), invalid))
945}
946
947pub fn uninitialized_layout_is_recent(
948 session_dir: &Path,
949 task_id: &str,
950 grace: std::time::Duration,
951) -> io::Result<bool> {
952 let task = resolve_uninitialized_task_layout(session_dir, task_id)?;
953 let modified = match task.paths.layout {
954 TaskLayout::Directory => task.dirs.control.modified()?,
955 TaskLayout::Flat => task
956 .dirs
957 .session
958 .open_file(&task.paths.artifact_name(TaskArtifact::Exit), false)
959 .and_then(|file| file.metadata()?.modified())
960 .or_else(|_| {
961 task.dirs
962 .session
963 .open_file(OsStr::new(&format!("{task_id}.json")), false)
964 .and_then(|file| file.metadata()?.modified())
965 })?,
966 };
967 Ok(SystemTime::now()
968 .duration_since(modified)
969 .unwrap_or_default()
970 < grace)
971}
972
973pub fn quarantine_task_layout(
974 storage_dir: &Path,
975 session_dir: &Path,
976 task_id: &str,
977 reason: &str,
978) -> io::Result<()> {
979 validate_task_id(task_id)?;
980 let session = PinnedDir::open(session_dir)?;
981 let names = session.list_names()?;
982 let flat_prefix = format!("{task_id}.");
983 let selected = names
984 .into_iter()
985 .filter(|name| {
986 name == OsStr::new(task_id)
987 || name
988 .to_str()
989 .is_some_and(|name| name.starts_with(&flat_prefix))
990 })
991 .collect::<Vec<_>>();
992 quarantine_names(storage_dir, session_dir, &session, selected, reason)
993}
994
995pub fn quarantine_invalid_entry(
996 storage_dir: &Path,
997 session_dir: &Path,
998 entry: &OsStr,
999) -> io::Result<()> {
1000 let session = PinnedDir::open(session_dir)?;
1001 quarantine_names(
1002 storage_dir,
1003 session_dir,
1004 &session,
1005 vec![entry.to_os_string()],
1006 "invalid",
1007 )
1008}
1009
1010fn quarantine_names(
1011 storage_dir: &Path,
1012 session_dir: &Path,
1013 session: &PinnedDir,
1014 names: Vec<OsString>,
1015 reason: &str,
1016) -> io::Result<()> {
1017 if names.is_empty() {
1018 return Ok(());
1019 }
1020 let session_hash = session_dir.file_name().ok_or_else(|| {
1021 io::Error::new(io::ErrorKind::InvalidInput, "session dir has no identity")
1022 })?;
1023 let quarantine_path = storage_dir.join("bash-tasks-quarantine").join(session_hash);
1024 fs::create_dir_all(&quarantine_path)?;
1025 let quarantine = PinnedDir::open(&quarantine_path)?;
1026 for name in names {
1027 let mut random = [0_u8; 8];
1028 getrandom::fill(&mut random).map_err(io::Error::other)?;
1029 let target = OsString::from(format!(
1030 "{}.{}-{}",
1031 name.to_string_lossy(),
1032 reason,
1033 hex_lower(&random)
1034 ));
1035 session.rename_to(&name, &quarantine, &target)?;
1036 }
1037 Ok(())
1038}
1039
1040fn hex_lower(bytes: &[u8]) -> String {
1041 bytes.iter().map(|byte| format!("{byte:02x}")).collect()
1042}
1043
1044pub fn read_task(path: &Path) -> io::Result<PersistedTask> {
1045 let mut file = open_validated_path(path, false)?;
1046 read_task_file(&mut file)
1047}
1048
1049pub fn read_task_at(task: &ResolvedTask) -> io::Result<PersistedTask> {
1050 let name = match task.paths.layout {
1051 TaskLayout::Directory => OsString::from(METADATA_FILE),
1052 TaskLayout::Flat => OsString::from(format!("{}.json", task.paths.task_id)),
1053 };
1054 let mut file = task.dirs.control.open_file(&name, false)?;
1055 let metadata = read_task_file(&mut file)?;
1056 if metadata.task_id != task.paths.task_id {
1057 return Err(io::Error::new(
1058 io::ErrorKind::InvalidData,
1059 "background task metadata identity does not match its layout name",
1060 ));
1061 }
1062 Ok(metadata)
1063}
1064
1065fn read_task_file(file: &mut File) -> io::Result<PersistedTask> {
1066 file.seek(SeekFrom::Start(0))?;
1067 let mut content = String::new();
1068 file.read_to_string(&mut content)?;
1069 let task: PersistedTask = serde_json::from_str(&content).map_err(io::Error::other)?;
1070 if !matches!(task.schema_version, 2 | 3 | 4 | 5 | SCHEMA_VERSION) {
1071 return Err(io::Error::new(
1072 io::ErrorKind::InvalidData,
1073 format!(
1074 "unsupported background task schema_version {} (expected 2, 3, 4, 5, or {SCHEMA_VERSION})",
1075 task.schema_version
1076 ),
1077 ));
1078 }
1079 validate_task_id(&task.task_id)?;
1080 Ok(task)
1081}
1082
1083pub fn write_task(path: &Path, task: &PersistedTask) -> io::Result<()> {
1084 validate_task_id(&task.task_id)?;
1085 if let Some(parent) = path.parent() {
1086 fs::create_dir_all(parent)?;
1087 }
1088 let parent = path.parent().unwrap_or_else(|| Path::new("."));
1089 let dir = PinnedDir::open(parent)?;
1090 let name = path
1091 .file_name()
1092 .ok_or_else(|| io::Error::new(io::ErrorKind::InvalidInput, "metadata path has no name"))?;
1093 write_task_in_dir(&dir, name, task)
1094}
1095
1096pub fn write_task_at(task: &ResolvedTask, metadata: &PersistedTask) -> io::Result<()> {
1097 if metadata.task_id != task.paths.task_id {
1098 return Err(io::Error::new(
1099 io::ErrorKind::InvalidInput,
1100 "refusing to write metadata under a different task identity",
1101 ));
1102 }
1103 let name = match task.paths.layout {
1104 TaskLayout::Directory => OsString::from(METADATA_FILE),
1105 TaskLayout::Flat => OsString::from(format!("{}.json", task.paths.task_id)),
1106 };
1107 write_task_in_dir(&task.dirs.control, &name, metadata)
1108}
1109
1110fn write_task_in_dir(dir: &PinnedDir, name: &OsStr, task: &PersistedTask) -> io::Result<()> {
1111 let mut upgraded = task.clone();
1112 upgraded.schema_version = SCHEMA_VERSION;
1113 let content = serde_json::to_vec_pretty(&upgraded).map_err(io::Error::other)?;
1114 randomized_atomic_replace(dir, name, &content)
1115}
1116
1117pub fn update_task_at<F>(task: &ResolvedTask, update: F) -> io::Result<PersistedTask>
1118where
1119 F: FnOnce(&mut PersistedTask),
1120{
1121 let mut metadata = read_task_at(task)?;
1122 let original_terminal = metadata.is_terminal();
1123 let original = metadata.clone();
1124 update(&mut metadata);
1125 metadata.schema_version = SCHEMA_VERSION;
1126 if original_terminal {
1127 let completion_delivered = metadata.completion_delivered;
1128 metadata = original;
1129 metadata.completion_delivered = completion_delivered;
1130 metadata.schema_version = SCHEMA_VERSION;
1131 }
1132 write_task_at(task, &metadata)?;
1133 Ok(metadata)
1134}
1135
1136pub fn delete_task_bundle(paths: &TaskPaths) -> io::Result<()> {
1137 validate_task_id(&paths.task_id)?;
1138 let resolved = resolve_task_layout(&paths.session_dir, &paths.task_id)?;
1139 if resolved.paths.layout != paths.layout {
1140 return Err(io::Error::new(
1141 io::ErrorKind::InvalidData,
1142 "background task layout changed before deletion",
1143 ));
1144 }
1145 delete_resolved_task(&resolved)
1146}
1147
1148pub fn delete_resolved_task(task: &ResolvedTask) -> io::Result<()> {
1149 validate_task_id(&task.paths.task_id)?;
1150 match task.paths.layout {
1151 TaskLayout::Flat => {
1152 for path in task_bundle_files(&task.paths) {
1153 let Some(name) = path.file_name() else {
1154 continue;
1155 };
1156 match task.dirs.session.remove_file(name) {
1157 Ok(()) => {}
1158 Err(error) if error.kind() == io::ErrorKind::NotFound => {}
1159 Err(error) => return Err(error),
1160 }
1161 }
1162 Ok(())
1163 }
1164 TaskLayout::Directory => remove_directory_task(task),
1165 }
1166}
1167
1168fn remove_directory_task(task: &ResolvedTask) -> io::Result<()> {
1169 let current = task
1170 .dirs
1171 .session
1172 .open_dir_at(OsStr::new(&task.paths.task_id))?;
1173 if !current.same_identity(&task.dirs.task)? {
1174 return Err(io::Error::new(
1175 io::ErrorKind::PermissionDenied,
1176 "task directory identity changed before deletion",
1177 ));
1178 }
1179 #[cfg(unix)]
1180 let tombstone = rename_task_to_tombstone(task)?;
1181 for name in task.dirs.control.list_names()? {
1182 task.dirs.control.remove_file(&name)?;
1183 }
1184 remove_tree_contents(&task.dirs.io)?;
1185 #[cfg(unix)]
1186 {
1187 remove_dir_entry(&task.dirs.task, IO_DIR)?;
1188 remove_dir_entry(&task.dirs.task, CONTROL_DIR)?;
1189 let name = os_cstring(&tombstone)?;
1190 let result = unsafe {
1191 libc::unlinkat(
1192 task.dirs.session.file.as_raw_fd(),
1193 name.as_ptr(),
1194 libc::AT_REMOVEDIR,
1195 )
1196 };
1197 if result != 0 {
1198 return Err(io::Error::last_os_error());
1199 }
1200 Ok(())
1201 }
1202 #[cfg(windows)]
1203 {
1204 task.dirs.io.ensure_current_identity()?;
1205 task.dirs.control.ensure_current_identity()?;
1206 task.dirs.session.ensure_current_identity()?;
1207 fs::remove_dir(task.dirs.io.path())?;
1208 fs::remove_dir(task.dirs.control.path())?;
1209 fs::remove_dir(&task.paths.dir)?;
1210 task.dirs.session.ensure_current_identity()
1211 }
1212}
1213
1214fn remove_tree_contents(dir: &PinnedDir) -> io::Result<()> {
1215 for name in dir.list_names()? {
1216 match dir.open_dir_at(&name) {
1217 Ok(child) => {
1218 remove_tree_contents(&child)?;
1219 #[cfg(unix)]
1220 {
1221 let name = os_cstring(&name)?;
1222 let result = unsafe {
1223 libc::unlinkat(dir.file.as_raw_fd(), name.as_ptr(), libc::AT_REMOVEDIR)
1224 };
1225 if result != 0 {
1226 return Err(io::Error::last_os_error());
1227 }
1228 }
1229 #[cfg(windows)]
1230 fs::remove_dir(child.path())?;
1231 }
1232 Err(error) if error.kind() == io::ErrorKind::NotADirectory => {
1233 dir.remove_file(&name)?;
1234 }
1235 Err(error) => return Err(error),
1236 }
1237 }
1238 Ok(())
1239}
1240
1241#[cfg(unix)]
1242fn rename_task_to_tombstone(task: &ResolvedTask) -> io::Result<OsString> {
1243 for _ in 0..32 {
1244 let tombstone = random_temp_name()?;
1245 match task.dirs.session.open_dir_at(&tombstone) {
1246 Ok(_) => continue,
1247 Err(error) if error.kind() == io::ErrorKind::NotFound => {}
1248 Err(error) => return Err(error),
1249 }
1250 task.dirs
1251 .session
1252 .rename(OsStr::new(&task.paths.task_id), &tombstone)?;
1253 let moved = task.dirs.session.open_dir_at(&tombstone)?;
1254 if !moved.same_identity(&task.dirs.task)? {
1255 return Err(io::Error::new(
1256 io::ErrorKind::PermissionDenied,
1257 "task directory identity changed during deletion",
1258 ));
1259 }
1260 return Ok(tombstone);
1261 }
1262 Err(io::Error::new(
1263 io::ErrorKind::AlreadyExists,
1264 "failed to allocate randomized task deletion name",
1265 ))
1266}
1267
1268#[cfg(unix)]
1269fn remove_dir_entry(task: &PinnedDir, child: &str) -> io::Result<()> {
1270 let child = os_cstring(OsStr::new(child))?;
1271 let result =
1272 unsafe { libc::unlinkat(task.file.as_raw_fd(), child.as_ptr(), libc::AT_REMOVEDIR) };
1273 if result != 0 {
1274 return Err(io::Error::last_os_error());
1275 }
1276 Ok(())
1277}
1278
1279pub fn task_bundle_files(paths: &TaskPaths) -> Vec<PathBuf> {
1280 if paths.layout == TaskLayout::Directory {
1281 return vec![paths.dir.clone()];
1282 }
1283 vec![
1284 paths.json.clone(),
1285 paths.stdout.clone(),
1286 paths.stderr.clone(),
1287 paths.exit.clone(),
1288 paths.pipeline_status.clone(),
1289 paths.pty.clone(),
1290 paths.sandbox_unavailable.clone(),
1291 paths.command.clone(),
1292 paths.wrapper.clone(),
1293 paths.environment.clone(),
1294 paths.manifest.clone(),
1295 paths.sandbox_profile.clone(),
1296 paths.dir.join(format!("{}.ps1", paths.task_id)),
1297 paths.dir.join(format!("{}.bat", paths.task_id)),
1298 ]
1299}
1300
1301pub fn write_kill_marker_if_absent(paths: &TaskPaths) -> io::Result<()> {
1302 match open_task_artifact(paths, TaskArtifact::Exit) {
1303 Ok(file) if file.len()? > 0 => Ok(()),
1304 Ok(mut file) => file.replace_contents(b"killed"),
1305 Err(error) if error.kind() == io::ErrorKind::NotFound => {
1306 let resolved = resolve_task_layout(&paths.session_dir, &paths.task_id)?;
1307 randomized_atomic_replace(
1308 &resolved.dirs.io,
1309 &resolved.paths.artifact_name(TaskArtifact::Exit),
1310 b"killed",
1311 )
1312 }
1313 Err(error) => Err(error),
1314 }
1315}
1316
1317pub fn read_exit_marker(paths: &TaskPaths) -> io::Result<Option<ExitMarker>> {
1318 let mut file = match open_task_artifact(paths, TaskArtifact::Exit) {
1319 Ok(file) => file,
1320 Err(error) if error.kind() == io::ErrorKind::NotFound => return Ok(None),
1321 Err(error) => return Err(error),
1322 };
1323 let mut content = String::new();
1324 file.read_to_string(&mut content)?;
1325 let content = content.trim();
1326 if content.is_empty() {
1327 return Ok(None);
1328 }
1329 if content == "killed" {
1330 return Ok(Some(ExitMarker::Killed));
1331 }
1332 Ok(content.parse::<i32>().ok().map(ExitMarker::Code))
1333}
1334
1335pub fn randomized_atomic_replace(dir: &PinnedDir, name: &OsStr, content: &[u8]) -> io::Result<()> {
1336 for _ in 0..32 {
1337 let temporary = random_temp_name()?;
1338 let mut file = match dir.open_new_file(&temporary) {
1339 Ok(file) => file,
1340 Err(error) if error.kind() == io::ErrorKind::AlreadyExists => continue,
1341 Err(error) => return Err(error),
1342 };
1343 let result = (|| {
1344 file.write_all(content)?;
1345 file.sync_all()?;
1346 validate_regular_handle(&file)?;
1347 dir.rename(&temporary, name)
1348 })();
1349 if result.is_err() {
1350 let _ = dir.remove_file(&temporary);
1351 }
1352 return result;
1353 }
1354 Err(io::Error::new(
1355 io::ErrorKind::AlreadyExists,
1356 "failed to allocate a randomized atomic-write name",
1357 ))
1358}
1359
1360pub fn create_control_file(dirs: &TaskDirs, name: &str, content: &[u8]) -> io::Result<File> {
1361 let mut file = dirs.control.open_new_file(OsStr::new(name))?;
1362 file.write_all(content)?;
1363 file.sync_all()?;
1364 file.seek(SeekFrom::Start(0))?;
1365 validate_regular_handle(&file)?;
1366 Ok(file)
1367}
1368
1369pub fn open_control_file(task: &ResolvedTask, name: &str) -> io::Result<File> {
1370 if name.is_empty() || name.contains('/') || name.contains('\\') || name == "." || name == ".." {
1371 return Err(io::Error::new(
1372 io::ErrorKind::InvalidInput,
1373 "invalid control file name",
1374 ));
1375 }
1376 task.dirs.control.open_file(OsStr::new(name), false)
1377}
1378
1379#[derive(Debug)]
1380pub struct ValidatedArtifact {
1381 file: File,
1382}
1383
1384impl ValidatedArtifact {
1385 fn new(file: File) -> io::Result<Self> {
1386 validate_regular_handle(&file)?;
1387 Ok(Self { file })
1388 }
1389
1390 pub fn len(&self) -> io::Result<u64> {
1391 validate_regular_handle(&self.file)?;
1392 Ok(self.file.metadata()?.len())
1393 }
1394
1395 pub fn rewind(&mut self) -> io::Result<()> {
1396 self.file.seek(SeekFrom::Start(0)).map(|_| ())
1397 }
1398
1399 pub fn tail(&mut self, max_bytes: usize) -> io::Result<(Vec<u8>, bool)> {
1400 let len = self.len()?;
1401 let read_len = len.min(max_bytes as u64);
1402 self.file
1403 .seek(SeekFrom::Start(len.saturating_sub(read_len)))?;
1404 let mut bytes = Vec::with_capacity(read_len as usize);
1405 Read::by_ref(&mut self.file)
1406 .take(read_len)
1407 .read_to_end(&mut bytes)?;
1408 Ok((bytes, len > max_bytes as u64))
1409 }
1410
1411 pub fn read_range(&mut self, start: u64, len: u64) -> io::Result<Vec<u8>> {
1412 self.file.seek(SeekFrom::Start(start))?;
1413 let mut bytes = Vec::with_capacity(len.min(usize::MAX as u64) as usize);
1414 Read::by_ref(&mut self.file)
1415 .take(len)
1416 .read_to_end(&mut bytes)?;
1417 Ok(bytes)
1418 }
1419
1420 pub fn read_all(&mut self) -> io::Result<Vec<u8>> {
1421 self.rewind()?;
1422 let mut bytes = Vec::new();
1423 self.file.read_to_end(&mut bytes)?;
1424 Ok(bytes)
1425 }
1426
1427 pub fn replace_contents(&mut self, content: &[u8]) -> io::Result<()> {
1428 validate_regular_handle(&self.file)?;
1429 self.file.set_len(0)?;
1430 self.file.seek(SeekFrom::Start(0))?;
1431 self.file.write_all(content)?;
1432 self.file.sync_all()
1433 }
1434
1435 pub fn try_clone_file(&self) -> io::Result<File> {
1436 validate_regular_handle(&self.file)?;
1437 self.file.try_clone()
1438 }
1439}
1440
1441impl Read for ValidatedArtifact {
1442 fn read(&mut self, buffer: &mut [u8]) -> io::Result<usize> {
1443 self.file.read(buffer)
1444 }
1445}
1446
1447impl Seek for ValidatedArtifact {
1448 fn seek(&mut self, position: SeekFrom) -> io::Result<u64> {
1449 self.file.seek(position)
1450 }
1451}
1452
1453pub fn open_task_artifact(
1454 paths: &TaskPaths,
1455 artifact: TaskArtifact,
1456) -> io::Result<ValidatedArtifact> {
1457 validate_task_id(&paths.task_id)?;
1458 let resolved = resolve_task_layout(&paths.session_dir, &paths.task_id)?;
1459 if resolved.paths.layout != paths.layout {
1460 return Err(io::Error::new(
1461 io::ErrorKind::InvalidData,
1462 "background task layout identity changed",
1463 ));
1464 }
1465 let metadata = read_task_at(&resolved)?;
1466 if metadata.task_id != paths.task_id {
1467 return Err(io::Error::new(
1468 io::ErrorKind::InvalidData,
1469 "background task metadata identity mismatch",
1470 ));
1471 }
1472 let file = resolved
1473 .dirs
1474 .io
1475 .open_file(&resolved.paths.artifact_name(artifact), false)?;
1476 ValidatedArtifact::new(file)
1477}
1478
1479pub fn replace_artifact_with_tail(
1480 paths: &TaskPaths,
1481 artifact: TaskArtifact,
1482 retain_bytes: u64,
1483) -> io::Result<u64> {
1484 let mut source = open_task_artifact(paths, artifact)?;
1485 let len = source.len()?;
1486 if len <= retain_bytes {
1487 return Ok(0);
1488 }
1489 let mut tail = source.read_range(len.saturating_sub(retain_bytes), retain_bytes)?;
1490 align_tail_start(&mut tail);
1491 let resolved = resolve_task_layout(&paths.session_dir, &paths.task_id)?;
1492 randomized_atomic_replace(
1493 &resolved.dirs.io,
1494 &resolved.paths.artifact_name(artifact),
1495 &tail,
1496 )?;
1497 Ok(len.saturating_sub(tail.len() as u64))
1498}
1499
1500#[derive(Debug)]
1501pub struct TaskIoHandles {
1502 pub dirs: TaskDirs,
1503 stdout: Option<File>,
1504 stderr: Option<File>,
1505 exit: File,
1506 pty: Option<File>,
1507 pipeline_status: Option<File>,
1508 sandbox_unavailable: File,
1509}
1510
1511impl TaskIoHandles {
1512 pub fn create(
1513 task: &ResolvedTask,
1514 mode: BgMode,
1515 capture_pipeline_status: bool,
1516 ) -> io::Result<Self> {
1517 if task.paths.layout != TaskLayout::Directory {
1518 return Err(io::Error::new(
1519 io::ErrorKind::InvalidInput,
1520 "new task output handles require the directory layout",
1521 ));
1522 }
1523 let (stdout, stderr, pty) = match mode {
1524 BgMode::Pipes => (
1525 Some(
1526 task.dirs
1527 .io
1528 .open_new_file(OsStr::new(TaskArtifact::Stdout.file_name()))?,
1529 ),
1530 Some(
1531 task.dirs
1532 .io
1533 .open_new_file(OsStr::new(TaskArtifact::Stderr.file_name()))?,
1534 ),
1535 None,
1536 ),
1537 BgMode::Pty => (
1538 None,
1539 None,
1540 Some(
1541 task.dirs
1542 .io
1543 .open_new_file(OsStr::new(TaskArtifact::Pty.file_name()))?,
1544 ),
1545 ),
1546 };
1547 Ok(Self {
1548 dirs: task.dirs.clone(),
1549 stdout,
1550 stderr,
1551 exit: task
1552 .dirs
1553 .io
1554 .open_new_file(OsStr::new(TaskArtifact::Exit.file_name()))?,
1555 pipeline_status: capture_pipeline_status
1556 .then(|| {
1557 task.dirs
1558 .io
1559 .open_new_file(OsStr::new(TaskArtifact::PipelineStatus.file_name()))
1560 })
1561 .transpose()?,
1562 pty,
1563 sandbox_unavailable: task
1564 .dirs
1565 .io
1566 .open_new_file(OsStr::new(TaskArtifact::SandboxUnavailable.file_name()))?,
1567 })
1568 }
1569
1570 pub fn clone_file(&self, artifact: TaskArtifact) -> io::Result<File> {
1571 let file = match artifact {
1572 TaskArtifact::Stdout => self.stdout.as_ref(),
1573 TaskArtifact::Stderr => self.stderr.as_ref(),
1574 TaskArtifact::Exit => Some(&self.exit),
1575 TaskArtifact::PipelineStatus => self.pipeline_status.as_ref(),
1576 TaskArtifact::Pty => self.pty.as_ref(),
1577 TaskArtifact::SandboxUnavailable => Some(&self.sandbox_unavailable),
1578 }
1579 .ok_or_else(|| {
1580 io::Error::new(io::ErrorKind::NotFound, "task artifact is not pre-opened")
1581 })?;
1582 validate_regular_handle(file)?;
1583 file.try_clone()
1584 }
1585
1586 #[cfg(unix)]
1587 pub fn inheritable_file(&self, artifact: TaskArtifact) -> io::Result<File> {
1588 let file = self.clone_file(artifact)?;
1589 set_close_on_exec(file.as_raw_fd(), false)?;
1590 Ok(file)
1591 }
1592
1593 pub fn write(&mut self, artifact: TaskArtifact, content: &[u8]) -> io::Result<()> {
1594 let file = match artifact {
1595 TaskArtifact::Stdout => self.stdout.as_mut(),
1596 TaskArtifact::Stderr => self.stderr.as_mut(),
1597 TaskArtifact::Exit => Some(&mut self.exit),
1598 TaskArtifact::PipelineStatus => self.pipeline_status.as_mut(),
1599 TaskArtifact::Pty => self.pty.as_mut(),
1600 TaskArtifact::SandboxUnavailable => Some(&mut self.sandbox_unavailable),
1601 }
1602 .ok_or_else(|| {
1603 io::Error::new(io::ErrorKind::NotFound, "task artifact is not pre-opened")
1604 })?;
1605 validate_regular_handle(file)?;
1606 file.set_len(0)?;
1607 file.seek(SeekFrom::Start(0))?;
1608 file.write_all(content)?;
1609 file.sync_all()
1610 }
1611
1612 pub fn artifact_len(&self, artifact: TaskArtifact) -> io::Result<u64> {
1613 let file = match artifact {
1614 TaskArtifact::Stdout => self.stdout.as_ref(),
1615 TaskArtifact::Stderr => self.stderr.as_ref(),
1616 TaskArtifact::Exit => Some(&self.exit),
1617 TaskArtifact::PipelineStatus => self.pipeline_status.as_ref(),
1618 TaskArtifact::Pty => self.pty.as_ref(),
1619 TaskArtifact::SandboxUnavailable => Some(&self.sandbox_unavailable),
1620 }
1621 .ok_or_else(|| {
1622 io::Error::new(io::ErrorKind::NotFound, "task artifact is not pre-opened")
1623 })?;
1624 validate_regular_handle(file)?;
1625 Ok(file.metadata()?.len())
1626 }
1627}
1628
1629pub fn repin_task_io(paths: &TaskPaths) -> io::Result<TaskDirs> {
1630 let resolved = resolve_task_layout(&paths.session_dir, &paths.task_id)?;
1631 let metadata = read_task_at(&resolved)?;
1632 if metadata.task_id != paths.task_id {
1633 return Err(io::Error::new(
1634 io::ErrorKind::InvalidData,
1635 "background task metadata identity mismatch",
1636 ));
1637 }
1638 Ok(resolved.dirs)
1639}
1640
1641pub fn unix_millis() -> u64 {
1642 SystemTime::now()
1643 .duration_since(UNIX_EPOCH)
1644 .map(|duration| duration.as_millis() as u64)
1645 .unwrap_or(0)
1646}
1647
1648fn random_task_id() -> io::Result<String> {
1649 let mut bytes = [0_u8; 8];
1650 getrandom::fill(&mut bytes).map_err(io::Error::other)?;
1651 Ok(format!(
1652 "bash-{}",
1653 bytes
1654 .iter()
1655 .map(|byte| format!("{byte:02x}"))
1656 .collect::<String>()
1657 ))
1658}
1659
1660fn random_temp_name() -> io::Result<OsString> {
1661 let mut bytes = [0_u8; 16];
1662 getrandom::fill(&mut bytes).map_err(io::Error::other)?;
1663 Ok(OsString::from(format!(
1664 ".aft-tmp-{}",
1665 bytes
1666 .iter()
1667 .map(|byte| format!("{byte:02x}"))
1668 .collect::<String>()
1669 )))
1670}
1671
1672#[cfg(test)]
1673pub(crate) fn open_unregistered_artifact(path: &Path) -> io::Result<ValidatedArtifact> {
1674 ValidatedArtifact::new(open_validated_path(path, false)?)
1675}
1676
1677#[cfg(test)]
1678pub(crate) fn replace_unregistered_with_tail(path: &Path, retain_bytes: u64) -> io::Result<u64> {
1679 let mut source = open_unregistered_artifact(path)?;
1680 let len = source.len()?;
1681 if len <= retain_bytes {
1682 return Ok(0);
1683 }
1684 let mut tail = source.read_range(len.saturating_sub(retain_bytes), retain_bytes)?;
1685 align_tail_start(&mut tail);
1686 let parent = PinnedDir::open(path.parent().unwrap_or_else(|| Path::new(".")))?;
1687 let name = path
1688 .file_name()
1689 .ok_or_else(|| io::Error::new(io::ErrorKind::InvalidInput, "path has no file name"))?;
1690 randomized_atomic_replace(&parent, name, &tail)?;
1691 Ok(len.saturating_sub(tail.len() as u64))
1692}
1693
1694fn align_tail_start(bytes: &mut Vec<u8>) {
1695 let prefix = bytes
1696 .iter()
1697 .take_while(|byte| **byte & 0xc0 == 0x80)
1698 .count();
1699 if prefix > 0 {
1700 bytes.drain(..prefix);
1701 }
1702}
1703
1704#[cfg(unix)]
1705fn clear_nonblocking(file: &File) -> io::Result<()> {
1706 let flags = unsafe { libc::fcntl(file.as_raw_fd(), libc::F_GETFL) };
1707 if flags == -1 {
1708 return Err(io::Error::last_os_error());
1709 }
1710 if flags & libc::O_NONBLOCK != 0 {
1711 let result =
1712 unsafe { libc::fcntl(file.as_raw_fd(), libc::F_SETFL, flags & !libc::O_NONBLOCK) };
1713 if result == -1 {
1714 return Err(io::Error::last_os_error());
1715 }
1716 }
1717 Ok(())
1718}
1719
1720fn open_validated_path(path: &Path, write: bool) -> io::Result<File> {
1721 let parent = path.parent().unwrap_or_else(|| Path::new("."));
1722 let name = path
1723 .file_name()
1724 .ok_or_else(|| io::Error::new(io::ErrorKind::InvalidInput, "path has no file name"))?;
1725 PinnedDir::open(parent)?.open_file(name, write)
1726}
1727
1728#[cfg(unix)]
1729fn openat_file(dirfd: RawFd, name: &OsStr, flags: i32, mode: libc::mode_t) -> io::Result<File> {
1730 let name = os_cstring(name)?;
1731 let fd = unsafe { libc::openat(dirfd, name.as_ptr(), flags, libc::c_uint::from(mode)) };
1732 if fd < 0 {
1733 return Err(io::Error::last_os_error());
1734 }
1735 Ok(unsafe { File::from_raw_fd(fd) })
1736}
1737
1738#[cfg(unix)]
1739fn os_cstring(value: &OsStr) -> io::Result<CString> {
1740 CString::new(value.as_bytes())
1741 .map_err(|_| io::Error::new(io::ErrorKind::InvalidInput, "path contains a NUL byte"))
1742}
1743
1744fn validate_directory_handle(file: &File) -> io::Result<()> {
1745 let metadata = file.metadata()?;
1746 if !metadata.is_dir() {
1747 return Err(io::Error::new(
1748 io::ErrorKind::InvalidData,
1749 "expected a non-reparse directory handle",
1750 ));
1751 }
1752 #[cfg(windows)]
1753 validate_windows_handle(file, true)?;
1754 Ok(())
1755}
1756
1757fn validate_regular_handle(file: &File) -> io::Result<()> {
1758 let metadata = file.metadata()?;
1759 if !metadata.is_file() {
1760 return Err(io::Error::new(
1761 io::ErrorKind::InvalidData,
1762 "task artifact is not a regular file",
1763 ));
1764 }
1765 #[cfg(unix)]
1766 if metadata.nlink() != 1 {
1767 return Err(io::Error::new(
1768 io::ErrorKind::InvalidData,
1769 "task artifact has multiple hard links",
1770 ));
1771 }
1772 #[cfg(windows)]
1773 validate_windows_handle(file, false)?;
1774 Ok(())
1775}
1776
1777#[cfg(unix)]
1778pub fn set_close_on_exec(fd: RawFd, enabled: bool) -> io::Result<()> {
1779 let flags = unsafe { libc::fcntl(fd, libc::F_GETFD) };
1780 if flags < 0 {
1781 return Err(io::Error::last_os_error());
1782 }
1783 let flags = if enabled {
1784 flags | libc::FD_CLOEXEC
1785 } else {
1786 flags & !libc::FD_CLOEXEC
1787 };
1788 if unsafe { libc::fcntl(fd, libc::F_SETFD, flags) } < 0 {
1789 return Err(io::Error::last_os_error());
1790 }
1791 Ok(())
1792}
1793
1794#[cfg(windows)]
1795const FILE_FLAG_OPEN_REPARSE_POINT: u32 = 0x0020_0000;
1796#[cfg(windows)]
1797const FILE_FLAG_BACKUP_SEMANTICS: u32 = 0x0200_0000;
1798#[cfg(windows)]
1799const FILE_ATTRIBUTE_REPARSE_POINT: u32 = 0x0000_0400;
1800#[cfg(windows)]
1801const FILE_TYPE_DISK: u32 = 0x0001;
1802#[cfg(windows)]
1803const HANDLE_FLAG_INHERIT: u32 = 0x0000_0001;
1804
1805#[cfg(windows)]
1806fn windows_file_information(file: &File) -> io::Result<ByHandleFileInformation> {
1807 let mut information = std::mem::MaybeUninit::<ByHandleFileInformation>::zeroed();
1808 if unsafe { GetFileInformationByHandle(file.as_raw_handle(), information.as_mut_ptr()) } == 0 {
1809 return Err(io::Error::last_os_error());
1810 }
1811 Ok(unsafe { information.assume_init() })
1812}
1813
1814#[cfg(windows)]
1815fn validate_windows_handle(file: &File, directory: bool) -> io::Result<()> {
1816 if file.metadata()?.file_attributes() & FILE_ATTRIBUTE_REPARSE_POINT != 0 {
1817 return Err(io::Error::new(
1818 io::ErrorKind::InvalidData,
1819 "task path is a reparse point",
1820 ));
1821 }
1822 let handle = file.as_raw_handle();
1823 let file_type = unsafe { GetFileType(handle) };
1824 if file_type != FILE_TYPE_DISK {
1825 return Err(io::Error::new(
1826 io::ErrorKind::InvalidData,
1827 "task artifact is not a regular disk file",
1828 ));
1829 }
1830 let information = windows_file_information(file)?;
1831 if !directory && information.number_of_links != 1 {
1832 return Err(io::Error::new(
1833 io::ErrorKind::InvalidData,
1834 "task artifact has multiple hard links",
1835 ));
1836 }
1837 if unsafe { SetHandleInformation(handle, HANDLE_FLAG_INHERIT, 0) } == 0 {
1838 return Err(io::Error::last_os_error());
1839 }
1840 let mut flags = 0_u32;
1841 if unsafe { GetHandleInformation(handle, &mut flags) } == 0 {
1842 return Err(io::Error::last_os_error());
1843 }
1844 if flags & HANDLE_FLAG_INHERIT != 0 {
1845 return Err(io::Error::new(
1846 io::ErrorKind::PermissionDenied,
1847 "validated task handles must not be inherited",
1848 ));
1849 }
1850 Ok(())
1851}
1852
1853#[cfg(windows)]
1854#[repr(C)]
1855struct ByHandleFileInformation {
1856 file_attributes: u32,
1857 creation_time: [u32; 2],
1858 last_access_time: [u32; 2],
1859 last_write_time: [u32; 2],
1860 volume_serial_number: u32,
1861 file_size_high: u32,
1862 file_size_low: u32,
1863 number_of_links: u32,
1864 file_index_high: u32,
1865 file_index_low: u32,
1866}
1867
1868#[cfg(windows)]
1869#[link(name = "kernel32")]
1870extern "system" {
1871 fn GetFileType(file: std::os::windows::io::RawHandle) -> u32;
1872 fn GetFileInformationByHandle(
1873 file: std::os::windows::io::RawHandle,
1874 information: *mut ByHandleFileInformation,
1875 ) -> i32;
1876 fn SetHandleInformation(object: std::os::windows::io::RawHandle, mask: u32, flags: u32) -> i32;
1877 fn GetHandleInformation(object: std::os::windows::io::RawHandle, flags: *mut u32) -> i32;
1878}
1879
1880#[cfg(test)]
1881mod tests {
1882 use super::*;
1883
1884 fn valid_id(suffix: u64) -> String {
1885 format!("bash-{suffix:016x}")
1886 }
1887
1888 #[test]
1889 fn task_id_validation_is_exact() {
1890 assert!(validate_task_id("bash-0123456789abcdef").is_ok());
1891 for invalid in [
1892 "bash-0123456789abcde",
1893 "bash-0123456789abcdef0",
1894 "bash-0123456789ABCDEf",
1895 "bash-0123456789abcdeg",
1896 "../bash-0123456789abcdef",
1897 ] {
1898 assert!(validate_task_id(invalid).is_err(), "accepted {invalid}");
1899 }
1900 }
1901
1902 #[test]
1903 fn new_layout_separates_control_and_io() {
1904 let storage = tempfile::tempdir().unwrap();
1905 let task = create_task_layout(storage.path(), "session", &valid_id(1)).unwrap();
1906 assert_eq!(
1907 task.paths.json.parent(),
1908 Some(task.paths.control_dir.as_path())
1909 );
1910 assert_eq!(
1911 task.paths.stdout.parent(),
1912 Some(task.paths.io_dir.as_path())
1913 );
1914 assert_ne!(task.paths.control_dir, task.paths.io_dir);
1915 }
1916
1917 #[cfg(unix)]
1918 #[test]
1919 fn task_layout_directories_are_private() {
1920 use std::os::unix::fs::PermissionsExt;
1921
1922 let storage = tempfile::tempdir().unwrap();
1923 let task = create_task_layout(storage.path(), "session", &valid_id(5)).unwrap();
1924 for path in [
1925 &task.paths.session_dir,
1926 &task.paths.dir,
1927 &task.paths.control_dir,
1928 &task.paths.io_dir,
1929 ] {
1930 let mode = fs::metadata(path).unwrap().permissions().mode() & 0o777;
1931 assert_eq!(mode, 0o700, "unexpected permissions for {}", path.display());
1932 }
1933 let bash_tasks = task.paths.session_dir.parent().unwrap();
1934 let mode = fs::metadata(bash_tasks).unwrap().permissions().mode() & 0o777;
1935 assert_eq!(
1936 mode,
1937 0o700,
1938 "unexpected permissions for {}",
1939 bash_tasks.display()
1940 );
1941 }
1942
1943 #[test]
1944 fn resolver_refuses_duplicate_layouts() {
1945 let storage = tempfile::tempdir().unwrap();
1946 let task = create_task_layout(storage.path(), "session", &valid_id(2)).unwrap();
1947 let flat = task
1948 .paths
1949 .session_dir
1950 .join(format!("{}.json", task.paths.task_id));
1951 fs::write(flat, b"{}").unwrap();
1952 let error = resolve_task_layout(&task.paths.session_dir, &task.paths.task_id).unwrap_err();
1953 assert_eq!(error.kind(), io::ErrorKind::InvalidData);
1954 }
1955
1956 #[test]
1957 fn resolver_rejects_metadata_identity_mismatch() {
1958 let storage = tempfile::tempdir().unwrap();
1959 let task = create_task_layout(storage.path(), "session", &valid_id(30)).unwrap();
1960 let metadata = PersistedTask::starting(
1961 valid_id(31),
1962 "session".into(),
1963 "true".into(),
1964 storage.path().into(),
1965 None,
1966 None,
1967 true,
1968 false,
1969 );
1970 fs::write(&task.paths.json, serde_json::to_vec(&metadata).unwrap()).unwrap();
1971 let error = resolve_task_layout(&task.paths.session_dir, &task.paths.task_id).unwrap_err();
1972 assert_eq!(error.kind(), io::ErrorKind::InvalidData);
1973 }
1974
1975 #[cfg(unix)]
1984 #[test]
1985 fn deletion_refuses_replaced_task_directory_without_touching_victim() {
1986 let storage = tempfile::tempdir().unwrap();
1987 let first = create_task_layout(storage.path(), "session", &valid_id(40)).unwrap();
1988 let second = create_task_layout(storage.path(), "session", &valid_id(41)).unwrap();
1989 let victim = second.paths.control_dir.join("victim");
1990 fs::write(&victim, b"victim-bytes").unwrap();
1991 let moved_first = first.paths.session_dir.join("moved-first");
1992 fs::rename(&first.paths.dir, &moved_first).unwrap();
1993 fs::rename(&second.paths.dir, &first.paths.dir).unwrap();
1994
1995 assert!(delete_resolved_task(&first).is_err());
1996 assert_eq!(
1997 fs::read(first.paths.control_dir.join("victim")).unwrap(),
1998 b"victim-bytes"
1999 );
2000 }
2001
2002 #[cfg(windows)]
2007 #[test]
2008 fn deletion_refuses_replaced_task_directory_without_touching_victim() {
2009 let storage = tempfile::tempdir().unwrap();
2010 let first = create_task_layout(storage.path(), "session", &valid_id(40)).unwrap();
2011 let second = create_task_layout(storage.path(), "session", &valid_id(41)).unwrap();
2012 let victim = second.paths.control_dir.join("victim");
2013 fs::write(&victim, b"victim-bytes").unwrap();
2014
2015 let moved_first = first.paths.session_dir.join("moved-first");
2018 let refusal = fs::rename(&first.paths.dir, &moved_first)
2019 .expect_err("open pinned-dir handle must block the task-dir rename on Windows");
2020 assert_eq!(refusal.kind(), io::ErrorKind::PermissionDenied);
2021
2022 assert_eq!(fs::read(&victim).unwrap(), b"victim-bytes");
2024 }
2025
2026 #[test]
2027 fn legacy_flat_layout_is_readable_and_deleted_as_a_bundle() {
2028 let storage = tempfile::tempdir().unwrap();
2029 let task_id = valid_id(32);
2030 let paths = task_paths(storage.path(), "session", &task_id).unwrap();
2031 fs::create_dir_all(&paths.session_dir).unwrap();
2032 let metadata = PersistedTask::starting(
2033 task_id.clone(),
2034 "session".into(),
2035 "true".into(),
2036 storage.path().into(),
2037 None,
2038 None,
2039 true,
2040 false,
2041 );
2042 write_task(&paths.json, &metadata).unwrap();
2043 fs::write(&paths.stdout, b"legacy").unwrap();
2044 fs::write(&paths.stderr, b"").unwrap();
2045 assert_eq!(
2046 resolve_task_layout(&paths.session_dir, &task_id)
2047 .unwrap()
2048 .paths
2049 .layout,
2050 TaskLayout::Flat
2051 );
2052 assert_eq!(
2053 open_task_artifact(&paths, TaskArtifact::Stdout)
2054 .unwrap()
2055 .read_all()
2056 .unwrap(),
2057 b"legacy"
2058 );
2059 delete_task_bundle(&paths).unwrap();
2060 assert!(!paths.json.exists());
2061 assert!(!paths.stdout.exists());
2062 }
2063
2064 #[cfg(unix)]
2065 #[test]
2066 fn live_output_creation_and_later_writes_refuse_link_attacks() {
2067 use std::os::unix::fs::symlink;
2068
2069 let storage = tempfile::tempdir().unwrap();
2070 let task = create_task_layout(storage.path(), "session", &valid_id(33)).unwrap();
2071 let metadata = PersistedTask::starting(
2072 task.paths.task_id.clone(),
2073 "session".into(),
2074 "true".into(),
2075 storage.path().into(),
2076 None,
2077 None,
2078 true,
2079 false,
2080 );
2081 write_task_at(&task, &metadata).unwrap();
2082 let victim = storage.path().join("victim");
2083 fs::write(&victim, b"victim-bytes").unwrap();
2084
2085 symlink(&victim, &task.paths.stdout).unwrap();
2086 assert!(TaskIoHandles::create(&task, BgMode::Pipes, false).is_err());
2087 assert_eq!(fs::read(&victim).unwrap(), b"victim-bytes");
2088 fs::remove_file(&task.paths.stdout).unwrap();
2089
2090 let mut handles = TaskIoHandles::create(&task, BgMode::Pipes, false).unwrap();
2091 fs::hard_link(&task.paths.stdout, task.paths.io_dir.join("linked-stdout")).unwrap();
2092 assert!(handles
2093 .write(TaskArtifact::Stdout, b"daemon-write")
2094 .is_err());
2095 assert_eq!(fs::read(&victim).unwrap(), b"victim-bytes");
2096
2097 fs::remove_file(&task.paths.stdout).unwrap();
2098 symlink(&victim, &task.paths.stdout).unwrap();
2099 assert!(replace_artifact_with_tail(&task.paths, TaskArtifact::Stdout, 1).is_err());
2100 assert_eq!(fs::read(&victim).unwrap(), b"victim-bytes");
2101 }
2102
2103 #[test]
2104 fn registered_artifact_consumers_do_not_reopen_paths_directly() {
2105 let rust_sources = [
2106 include_str!("buffer.rs"),
2107 include_str!("registry.rs"),
2108 include_str!("process.rs"),
2109 include_str!("pty_process.rs"),
2110 include_str!("watches.rs"),
2111 include_str!("watchdog.rs"),
2112 include_str!("../commands/bash_status.rs"),
2113 ];
2114 for source in rust_sources {
2115 let production = source
2116 .split("#[cfg(test)]\nmod tests")
2117 .next()
2118 .unwrap_or(source);
2119 for forbidden in [
2120 "File::open(&task.paths",
2121 "fs::read(&task.paths",
2122 "fs::read_to_string(&task.paths",
2123 "File::open(path)?",
2124 ] {
2125 assert!(
2126 !production.contains(forbidden),
2127 "registered artifact consumer contains raw path read: {forbidden}"
2128 );
2129 }
2130 }
2131 for source in [
2132 include_str!("../../../../packages/opencode-plugin/src/tools/bash.ts"),
2133 include_str!("../../../../packages/opencode-plugin/src/tools/bash_watch.ts"),
2134 include_str!("../../../../packages/pi-plugin/src/tools/bash.ts"),
2135 ] {
2136 for forbidden in [
2137 "fs.readFile(outputPath)",
2138 "fs.readFile(details.output_path)",
2139 "fs.open(outputPath",
2140 ] {
2141 assert!(
2142 !source.contains(forbidden),
2143 "plugin artifact consumer contains raw path read: {forbidden}"
2144 );
2145 }
2146 }
2147 }
2148
2149 #[cfg(unix)]
2150 #[test]
2151 fn validated_artifact_refuses_symlink_hardlink_and_fifo() {
2152 use std::os::unix::fs::symlink;
2153
2154 let storage = tempfile::tempdir().unwrap();
2155 let task = create_task_layout(storage.path(), "session", &valid_id(3)).unwrap();
2156 let metadata = PersistedTask::starting(
2157 task.paths.task_id.clone(),
2158 "session".into(),
2159 "true".into(),
2160 storage.path().into(),
2161 None,
2162 None,
2163 true,
2164 false,
2165 );
2166 write_task_at(&task, &metadata).unwrap();
2167 let canary = storage.path().join("canary");
2168 fs::write(&canary, b"secret").unwrap();
2169
2170 symlink(&canary, &task.paths.stdout).unwrap();
2171 assert!(open_task_artifact(&task.paths, TaskArtifact::Stdout).is_err());
2172 fs::remove_file(&task.paths.stdout).unwrap();
2173
2174 fs::hard_link(&canary, &task.paths.stdout).unwrap();
2175 assert!(open_task_artifact(&task.paths, TaskArtifact::Stdout).is_err());
2176 fs::remove_file(&task.paths.stdout).unwrap();
2177
2178 let path = CString::new(task.paths.stdout.as_os_str().as_bytes()).unwrap();
2179 assert_eq!(unsafe { libc::mkfifo(path.as_ptr(), 0o600) }, 0);
2180 assert!(open_task_artifact(&task.paths, TaskArtifact::Stdout).is_err());
2181 }
2182}