runner_manager_platform/process.rs
1// owner: d1-platform-core
2
3//! Spawning, observing and terminating a child process; a process identity
4//! that survives a restart; and the restrictive handoff that gets a JIT
5//! configuration to a runner without it ever appearing in a process listing.
6//!
7//! # A PID is not an identity
8//!
9//! The agent records the runner processes it started in a durable journal and
10//! reads that journal back after a restart (`03-control-flows.md`, flow 3.2).
11//! If the record were a bare PID, then after a reboot — or after enough process
12//! churn — the PID in the journal may belong to somebody else's process. Acting
13//! on that record means either adopting a stranger as a runner or, worse,
14//! terminating it. `e3`'s restart-recovery Definition of Done ("a journal
15//! containing a live process adopts it without starting a duplicate") rests
16//! entirely on telling those cases apart.
17//!
18//! So [`ProcessIdentity`] is a PID **plus a start token**: an opaque,
19//! platform-defined string that changes when the process at that PID changes.
20//! [`ProcessIdentity::recheck`] re-resolves the token and answers
21//! [`Adoption::Live`], [`Adoption::Gone`], or [`Adoption::PidRecycled`] — three
22//! answers, because collapsing the last two into "not live" is exactly the bug
23//! this type exists to prevent.
24//!
25//! | | Start token | Resolution | Distinct across a reboot |
26//! |---|---|---|---|
27//! | Windows | `GetProcessTimes` creation `FILETIME` | 100 ns | yes, it is an absolute time |
28//! | macOS | `proc_pidinfo(PROC_PIDTBSDINFO)` start `timeval` | 1 µs | yes, it is an absolute time |
29//! | Linux | boot id + `/proc/<pid>/stat` field 22 | one clock tick, typically 10 ms | yes, the boot id changes every boot |
30//!
31//! The Linux token pairs the boot identifier with the raw tick count rather
32//! than converting ticks to a wall-clock time. Field 22 counts ticks *since
33//! boot*, so on its own it repeats after every reboot; and dividing by
34//! `sysconf(_SC_CLK_TCK)` and adding `btime` would produce an absolute time
35//! whose precision is bounded by `btime`'s whole seconds — coarser than the
36//! ticks it was derived from, and coarser than a PID-recycling discriminator
37//! wants. Prefixing the tick count with `/proc/sys/kernel/random/boot_id`
38//! keeps the full tick resolution *and* makes the token unrepeatable across a
39//! reboot. See [`Adoption`] for what that buys.
40//!
41//! # The JIT configuration never becomes an argument
42//!
43//! `07-security.md`'s threat table: *"A process listing reveals a JIT config"*,
44//! controlled by *"Do not pass JIT data as a command-line argument; use
45//! restrictive file/pipe handoff"*. [`RestrictiveHandoff`] is that file, and
46//! [`SpawnSpec::spawn_with_handoff`] refuses to spawn when the payload appears
47//! in any argument or environment value, so an obvious mistake fails the launch
48//! instead of failing a review. [`SpawnSpec::spawn_runner_with_handoff`] is the
49//! one narrow exception: GitHub Runner's supported JIT intake is the secret
50//! `ACTIONS_RUNNER_INPUT_JITCONFIG` environment input. The value is injected
51//! only while creating the child, is never retained in the public spawn spec,
52//! and Runner masks and removes it as its command parser starts.
53//!
54//! **It is a tripwire, not a proof.** A caller that passes it has not been
55//! shown to be safe. The check looks for the payload as a verbatim substring of
56//! each argument's and each environment *value's* `to_string_lossy()`, and that
57//! is all it looks for. It does not inspect the program path, the working
58//! directory, or environment variable *names*; and anything that re-encodes the
59//! payload — base64 of the base64, URL-escaping, a different Unicode
60//! normalisation — or splits it across two arguments walks straight past it.
61//! The control that actually holds is either *"pass the handoff file's path"*
62//! to a program that supports one or use the dedicated Runner intake above;
63//! `e3` must not read a passing generic check as evidence that a configuration
64//! cannot reach a process listing.
65
66use std::ffi::{OsStr, OsString};
67use std::fmt;
68use std::path::{Path, PathBuf};
69use std::process::{Child, Command, ExitStatus, Stdio};
70use std::time::{Duration, Instant};
71
72use secrecy::{ExposeSecret, SecretString};
73use serde::{Deserialize, Serialize};
74
75/// GitHub Runner's supported process-safe JIT configuration input.
76///
77/// `actions/runner` v2.336.0 reads every `ACTIONS_RUNNER_INPUT_*` variable in
78/// `CommandSettings`, registers secret inputs with its masker, and removes the
79/// variable from its environment before `Runner.ExecuteCommand` decodes it.
80const RUNNER_JIT_CONFIG_ENV: &str = "ACTIONS_RUNNER_INPUT_JITCONFIG";
81
82// ---------------------------------------------------------------------------
83// Errors
84// ---------------------------------------------------------------------------
85
86/// Something went wrong spawning, observing, or identifying a process.
87#[derive(Debug, thiserror::Error)]
88pub enum ProcessError {
89 /// The program could not be launched.
90 #[error("cannot start {}: {source}", program.display())]
91 Spawn {
92 /// The program that could not be launched.
93 program: PathBuf,
94 /// The underlying error.
95 #[source]
96 source: std::io::Error,
97 },
98
99 /// The operating system would not say when a process started.
100 #[error("cannot read the start time of process {pid}: {source}")]
101 Identity {
102 /// The process that could not be identified.
103 pid: u32,
104 /// The underlying error.
105 #[source]
106 source: std::io::Error,
107 },
108
109 /// No live process holds this PID, so it has no identity to record.
110 #[error("no live process holds PID {pid}")]
111 NoSuchProcess {
112 /// The PID that resolved to nothing.
113 pid: u32,
114 },
115
116 /// Waiting on, signalling, or killing a process failed.
117 #[error("cannot control process {pid}: {source}")]
118 Control {
119 /// The process that could not be controlled.
120 pid: u32,
121 /// The underlying error.
122 #[source]
123 source: std::io::Error,
124 },
125
126 /// The handoff payload was about to be visible in a process listing.
127 ///
128 /// Returned by [`SpawnSpec::spawn_with_handoff`] rather than logged,
129 /// because the whole point is that the launch must not happen.
130 #[error(
131 "refusing to start {}: the handoff payload appears in {location}, which would put \
132 it in this machine's process listing. Pass the handoff file's path instead \
133 (`07-security.md`, threat table).",
134 program.display()
135 )]
136 SecretInCommandLine {
137 /// The program that would have been launched.
138 program: PathBuf,
139 /// Where the payload was found — an argument index or an environment
140 /// variable name.
141 location: String,
142 },
143}
144
145// ---------------------------------------------------------------------------
146// Process identity
147// ---------------------------------------------------------------------------
148
149/// A PID paired with a token that changes when the process at that PID does.
150///
151/// Serializable because its whole reason to exist is being written to the
152/// attempt journal and read back after a restart. The token is opaque: its
153/// shape is documented at the module level for diagnostics, but nothing should
154/// parse it. Comparison — not interpretation — is the operation it supports.
155#[derive(Debug, Clone, PartialEq, Eq, Hash, Serialize, Deserialize)]
156pub struct ProcessIdentity {
157 pid: u32,
158 start_token: String,
159}
160
161/// The start token of a child that was gone before its identity could be read.
162///
163/// Deliberately not a value any platform produces: every real token is
164/// `<platform>:<instant>`, so this can never compare equal to a live process
165/// and never claims a start instant that was not observed. See
166/// [`ProcessIdentity::of_child`].
167const EXITED_BEFORE_IDENTIFIED: &str = "exited-before-identified";
168
169/// What a recorded [`ProcessIdentity`] turns out to refer to now.
170///
171/// # One journal entry can answer differently on different platforms
172///
173/// For a PID now held by **another account's** process, Linux answers
174/// [`Adoption::PidRecycled`] while macOS and Windows answer
175/// [`ProcessError::Identity`]: `/proc/<pid>/stat` is world-readable, whereas
176/// `proc_pidinfo` and `OpenProcess` refuse an inspection this account is not
177/// entitled to. So the same journal entry, read back after the agent's service
178/// account has been changed, is a recycled PID on one platform and an error on
179/// the other two. `e3` branches on this, and should treat the error as the same
180/// *decision* as `PidRecycled` — do not adopt, do not terminate — rather than
181/// as a platform bug.
182#[derive(Debug, Clone, PartialEq, Eq)]
183pub enum Adoption {
184 /// The same process is still running. Adopt it; do not start a replacement.
185 Live,
186
187 /// Nothing holds the PID. The process is gone and its attempt is terminal.
188 Gone,
189
190 /// Something holds the PID, but it is not the recorded process.
191 ///
192 /// Distinct from [`Adoption::Gone`] on purpose. The recorded process is
193 /// equally gone in both cases, but here there is a stranger at that PID,
194 /// and treating this as `Gone` is one refactor away from treating it as
195 /// `Live` — which is how an agent terminates somebody else's process.
196 PidRecycled {
197 /// Whoever holds the PID now.
198 current: ProcessIdentity,
199 },
200}
201
202impl Adoption {
203 /// Whether the recorded process is still running.
204 #[must_use]
205 pub const fn is_live(&self) -> bool {
206 matches!(self, Self::Live)
207 }
208}
209
210/// The outcome of asking a recorded process to stop.
211#[derive(Debug, Clone, PartialEq, Eq)]
212pub enum Termination {
213 /// The process was signalled and is no longer running.
214 Terminated,
215 /// It had already exited; nothing to do.
216 AlreadyGone,
217 /// The PID belongs to a different process now, so nothing was signalled.
218 ///
219 /// The refusal is the feature. See [`Adoption::PidRecycled`].
220 RefusedPidRecycled {
221 /// Whoever holds the PID now.
222 current: ProcessIdentity,
223 },
224}
225
226impl ProcessIdentity {
227 /// Reads the identity of a live process.
228 ///
229 /// # Errors
230 ///
231 /// [`ProcessError::NoSuchProcess`] when nothing holds the PID, and
232 /// [`ProcessError::Identity`] when the operating system refuses to answer —
233 /// a process owned by another account, for instance. The two are separate
234 /// because "gone" is a normal lifecycle answer and "refused" is a
235 /// misconfiguration.
236 pub fn resolve(pid: u32) -> Result<Self, ProcessError> {
237 Self::read(pid, LivenessFilter::LiveOnly)
238 }
239
240 /// Reads the identity of a process this program has just spawned and still
241 /// holds the handle to.
242 ///
243 /// Separate from [`ProcessIdentity::resolve`] because of a race that would
244 /// otherwise make short-lived children unlaunchable: a program that exits
245 /// before its parent gets round to identifying it is *already* not live by
246 /// the time the identity is read, and `resolve` would answer
247 /// [`ProcessError::NoSuchProcess`]. Reading an exited child's start time is
248 /// safe in a way that reading an arbitrary exited PID's is not — the parent
249 /// holds the child handle, so the PID cannot have been reused underneath
250 /// it.
251 fn of_child(pid: u32) -> Result<Self, ProcessError> {
252 match Self::read(pid, LivenessFilter::IncludeExited) {
253 Ok(identity) => Ok(identity),
254 // ------------------------------------------------------------
255 // THE RACE THIS FUNCTION EXISTS FOR, ON THE ONE PLATFORM WHERE
256 // `IncludeExited` IS NOT ENOUGH TO SURVIVE IT.
257 // ------------------------------------------------------------
258 // The filter above covers a *zombie*: exited, unreaped, still
259 // holding its PID. macOS has a narrower window than that.
260 // `proc_pidinfo(PROC_PIDTBSDINFO)` answers `ESRCH` for a child
261 // that has only just gone, and the filter never gets a say --
262 // so a program that exits fast enough could not be launched at
263 // all, which is the exact failure the documentation above says
264 // this function prevents. It cost two CI runs before it was
265 // recognised as that rather than as noise.
266 //
267 // A start token is a claim about *when a process started*, used
268 // to notice a PID that has since been reused. There is no such
269 // instant to read here, and inventing one would be a lie a later
270 // comparison could believe. This sentinel is the honest value:
271 // it matches nothing, so [`ProcessIdentity::classify`] answers
272 // `Gone` for a PID nobody holds and `PidRecycled` for one
273 // somebody else has taken -- and `PidRecycled` is refused rather
274 // than signalled, which is the safe half of the pair.
275 //
276 // Only the parent reaches this: it holds the child handle, so the
277 // PID cannot already belong to somebody else at this moment.
278 Err(ProcessError::NoSuchProcess { .. }) => Ok(Self {
279 pid,
280 start_token: EXITED_BEFORE_IDENTIFIED.to_string(),
281 }),
282 Err(other) => Err(other),
283 }
284 }
285
286 fn read(pid: u32, filter: LivenessFilter) -> Result<Self, ProcessError> {
287 match sys::start_token(pid, filter) {
288 Ok(Some(start_token)) => Ok(Self { pid, start_token }),
289 Ok(None) => Err(ProcessError::NoSuchProcess { pid }),
290 Err(source) => Err(ProcessError::Identity { pid, source }),
291 }
292 }
293
294 /// The identity of the calling process.
295 ///
296 /// # Errors
297 ///
298 /// As [`ProcessIdentity::resolve`], though a process can always see itself
299 /// in practice.
300 pub fn of_current_process() -> Result<Self, ProcessError> {
301 Self::resolve(std::process::id())
302 }
303
304 /// The PID. Recorded in `RunnerAttempt::process_id` and shown in the UI;
305 /// never used on its own to decide whether a process is ours.
306 #[must_use]
307 pub const fn pid(&self) -> u32 {
308 self.pid
309 }
310
311 /// The opaque start token. Exposed for diagnostics only.
312 #[must_use]
313 pub fn start_token(&self) -> &str {
314 &self.start_token
315 }
316
317 /// Re-resolves this identity against the machine as it is now.
318 ///
319 /// # Errors
320 ///
321 /// [`ProcessError::Identity`] when the operating system refuses to answer.
322 /// A PID that resolves to nothing is [`Adoption::Gone`], not an error.
323 pub fn recheck(&self) -> Result<Adoption, ProcessError> {
324 match sys::start_token(self.pid, LivenessFilter::LiveOnly) {
325 Ok(observed) => Ok(self.classify(observed)),
326 Err(source) => Err(ProcessError::Identity {
327 pid: self.pid,
328 source,
329 }),
330 }
331 }
332
333 /// The adoption decision itself, with the operating system already
334 /// consulted.
335 ///
336 /// Split out of [`ProcessIdentity::recheck`] so that all three answers can
337 /// be exercised without spawning anything. One of them cannot be reached
338 /// through a spawn on demand: two processes carrying an *identical* start
339 /// token. On Windows (100 ns) and macOS (1 µs) that is unreachable, and on
340 /// Linux it happens only by landing inside the same 10 ms clock tick, which
341 /// is a race a test cannot ask for. Comparing tokens here rather than
342 /// inline means the discriminator can be shown to behave correctly on that
343 /// input from every leg of the CI matrix.
344 fn classify(&self, observed: Option<String>) -> Adoption {
345 match observed {
346 None => Adoption::Gone,
347 Some(token) if token == self.start_token => Adoption::Live,
348 Some(token) => Adoption::PidRecycled {
349 current: Self {
350 pid: self.pid,
351 start_token: token,
352 },
353 },
354 }
355 }
356
357 /// Stops the process this identity names, and nothing else.
358 ///
359 /// Re-checks the identity immediately before signalling. That check is the
360 /// difference between "terminate the runner recorded in the journal" and
361 /// "terminate whatever now holds PID 4312", and it is why the recycled case
362 /// returns [`Termination::RefusedPidRecycled`] rather than proceeding.
363 ///
364 /// `grace` applies only where the platform has a polite stop to offer: on
365 /// Unix the process is sent `SIGTERM`, given `grace` to exit, and then
366 /// `SIGKILL`ed. Windows has no console-independent equivalent, so the
367 /// process is terminated immediately and `grace` is ignored — stated here
368 /// rather than emulated, because a fake grace period that never actually
369 /// asks politely is worse than no grace period.
370 ///
371 /// # Errors
372 ///
373 /// [`ProcessError::Control`] when signalling fails for a reason other than
374 /// the process having already exited.
375 pub fn terminate(&self, grace: Duration) -> Result<Termination, ProcessError> {
376 match self.recheck()? {
377 Adoption::Gone => return Ok(Termination::AlreadyGone),
378 Adoption::PidRecycled { current } => {
379 return Ok(Termination::RefusedPidRecycled { current });
380 }
381 Adoption::Live => {}
382 }
383
384 let requested = sys::request_stop(self.pid).map_err(|source| ProcessError::Control {
385 pid: self.pid,
386 source,
387 })?;
388
389 if requested {
390 let deadline = Instant::now() + grace;
391 while Instant::now() < deadline {
392 if matches!(
393 self.recheck()?,
394 Adoption::Gone | Adoption::PidRecycled { .. }
395 ) {
396 return Ok(Termination::Terminated);
397 }
398 std::thread::sleep(POLL_INTERVAL);
399 }
400 }
401
402 // Either the platform has no polite stop, or the grace period expired.
403 // Re-check once more so a process that exited during the wait is not
404 // reported as force-killed, and so a PID recycled during the wait is
405 // not force-killed at all.
406 match self.recheck()? {
407 Adoption::Gone => Ok(Termination::AlreadyGone),
408 Adoption::PidRecycled { current } => Ok(Termination::RefusedPidRecycled { current }),
409 Adoption::Live => {
410 sys::force_stop(self.pid).map_err(|source| ProcessError::Control {
411 pid: self.pid,
412 source,
413 })?;
414 Ok(Termination::Terminated)
415 }
416 }
417 }
418}
419
420impl fmt::Display for ProcessIdentity {
421 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
422 write!(f, "pid {} started {}", self.pid, self.start_token)
423 }
424}
425
426/// How often a wait loop re-checks. Short enough that a terminating runner is
427/// noticed promptly, long enough that a grace period is not a spin.
428const POLL_INTERVAL: Duration = Duration::from_millis(20);
429
430/// Whether a start-time lookup should answer for a process that has already
431/// exited but whose PID is not yet free.
432///
433/// Both states exist on both families: a Unix child that has exited and not
434/// been reaped is a zombie holding its PID, and a Windows process whose handle
435/// is still open leaves a process object behind with a non-zero exit time.
436#[derive(Debug, Clone, Copy, PartialEq, Eq)]
437enum LivenessFilter {
438 /// Answer only for a process that is still running. What recovery and
439 /// adoption need: an exited process is not something to adopt.
440 LiveOnly,
441 /// Answer for an exited process too. Only ever used by the parent of that
442 /// process, which holds its handle and therefore knows the PID is not
443 /// somebody else's.
444 IncludeExited,
445}
446
447// ---------------------------------------------------------------------------
448// Spawning
449// ---------------------------------------------------------------------------
450
451/// What to do with a child's standard output and standard error.
452#[derive(Debug, Clone, Copy, PartialEq, Eq, Default)]
453pub enum OutputMode {
454 /// Send both to the null device. The default: a runner writes its own
455 /// diagnostics into its workspace, and inheriting its output would splice
456 /// unredacted text into this process's stream.
457 #[default]
458 Discard,
459 /// Inherit this process's handles.
460 Inherit,
461 /// Capture both, readable through [`ChildProcess::take_stdout`].
462 Capture,
463}
464
465/// A child process about to be launched.
466///
467/// A builder rather than a bare [`Command`] so that the arguments and the
468/// environment can be inspected before the launch — which is what
469/// [`SpawnSpec::spawn_with_handoff`] does.
470#[derive(Debug, Clone)]
471pub struct SpawnSpec {
472 program: PathBuf,
473 args: Vec<OsString>,
474 envs: Vec<(OsString, OsString)>,
475 working_dir: Option<PathBuf>,
476 output: OutputMode,
477}
478
479impl SpawnSpec {
480 /// Starts a specification for `program`.
481 pub fn new(program: impl Into<PathBuf>) -> Self {
482 Self {
483 program: program.into(),
484 args: Vec::new(),
485 envs: Vec::new(),
486 working_dir: None,
487 output: OutputMode::Discard,
488 }
489 }
490
491 /// Appends one argument.
492 #[must_use]
493 pub fn arg(mut self, arg: impl AsRef<OsStr>) -> Self {
494 self.args.push(arg.as_ref().to_os_string());
495 self
496 }
497
498 /// Appends several arguments.
499 #[must_use]
500 pub fn args<I, S>(mut self, args: I) -> Self
501 where
502 I: IntoIterator<Item = S>,
503 S: AsRef<OsStr>,
504 {
505 self.args
506 .extend(args.into_iter().map(|a| a.as_ref().to_os_string()));
507 self
508 }
509
510 /// Sets one environment variable for the child, on top of the inherited
511 /// environment.
512 #[must_use]
513 pub fn env(mut self, key: impl AsRef<OsStr>, value: impl AsRef<OsStr>) -> Self {
514 self.envs
515 .push((key.as_ref().to_os_string(), value.as_ref().to_os_string()));
516 self
517 }
518
519 /// Sets the child's working directory.
520 #[must_use]
521 pub fn working_dir(mut self, dir: impl Into<PathBuf>) -> Self {
522 self.working_dir = Some(dir.into());
523 self
524 }
525
526 /// Chooses what happens to the child's output.
527 #[must_use]
528 pub fn output(mut self, output: OutputMode) -> Self {
529 self.output = output;
530 self
531 }
532
533 /// The arguments as configured. Exposed so a security test can assert what
534 /// a process listing would show.
535 #[must_use]
536 pub fn arguments(&self) -> &[OsString] {
537 &self.args
538 }
539
540 /// Launches the child.
541 ///
542 /// # Errors
543 ///
544 /// [`ProcessError::Spawn`] when the program cannot be launched, and
545 /// [`ProcessError::Identity`] when it launches but its start time cannot be
546 /// read — which would leave an unrecordable process running, so the child
547 /// is killed rather than leaked.
548 pub fn spawn(&self) -> Result<ChildProcess, ProcessError> {
549 self.spawn_with_extra_env(None)
550 }
551
552 fn spawn_with_extra_env(
553 &self,
554 extra_env: Option<(&OsStr, &OsStr)>,
555 ) -> Result<ChildProcess, ProcessError> {
556 let mut command = Command::new(&self.program);
557 #[cfg(unix)]
558 std::os::unix::process::CommandExt::process_group(&mut command, 0);
559
560 command.args(&self.args);
561 for (key, value) in &self.envs {
562 command.env(key, value);
563 }
564 if let Some((key, value)) = extra_env {
565 command.env(key, value);
566 }
567 if let Some(dir) = &self.working_dir {
568 command.current_dir(dir);
569 }
570 // Never inherited: a runner that reads this process's stdin would block
571 // the agent, and nothing in this design feeds a child interactively.
572 command.stdin(Stdio::null());
573 let (stdout, stderr) = match self.output {
574 OutputMode::Discard => (Stdio::null(), Stdio::null()),
575 OutputMode::Inherit => (Stdio::inherit(), Stdio::inherit()),
576 OutputMode::Capture => (Stdio::piped(), Stdio::piped()),
577 };
578 command.stdout(stdout).stderr(stderr);
579
580 let child = command.spawn().map_err(|source| ProcessError::Spawn {
581 program: self.program.clone(),
582 source,
583 })?;
584
585 let pid = child.id();
586 match ProcessIdentity::of_child(pid) {
587 Ok(identity) => Ok(ChildProcess {
588 child,
589 identity,
590 program: self.program.clone(),
591 }),
592 Err(error) => {
593 // An unidentifiable child cannot be journalled, so it cannot be
594 // recovered after a restart. Leaving it running would create
595 // exactly the orphan the journal exists to prevent.
596 let mut child = child;
597 let _ = child.kill();
598 let _ = child.wait();
599 Err(error)
600 }
601 }
602 }
603
604 /// Launches the child after proving the handoff payload is not in the
605 /// command line or the environment.
606 ///
607 /// This is the enforcement point for `07-security.md`'s control on *"A
608 /// process listing reveals a JIT config"*. `e3` should reach for this and
609 /// not for [`SpawnSpec::spawn`], because a rule that is checked is a rule,
610 /// and a rule that is written down is a hope.
611 ///
612 /// # Errors
613 ///
614 /// [`ProcessError::SecretInCommandLine`] when the payload appears in an
615 /// argument or an environment value, plus everything
616 /// [`SpawnSpec::spawn`] returns.
617 pub fn spawn_with_handoff(
618 &self,
619 handoff: &RestrictiveHandoff,
620 ) -> Result<ChildProcess, ProcessError> {
621 self.reject_exposed_handoff(handoff)?;
622 self.spawn()
623 }
624
625 /// Launches GitHub Runner using its supported process-safe JIT input.
626 ///
627 /// The encoded configuration is deliberately absent from [`SpawnSpec`]:
628 /// callers cannot render it as an argument or accidentally retain it in a
629 /// reusable specification. It is copied from the restrictive handoff into
630 /// the child's initial environment at the final `Command::spawn` boundary.
631 /// GitHub Runner's `CommandSettings` treats `jitconfig` as a secret and
632 /// removes `ACTIONS_RUNNER_INPUT_JITCONFIG` from the process environment
633 /// before executing the `run` command.
634 ///
635 /// The caller still owns deleting `handoff` immediately after this method
636 /// returns. A failed launch leaves deletion to [`RestrictiveHandoff`]'s
637 /// fail-closed `Drop` implementation.
638 ///
639 /// # Errors
640 ///
641 /// [`ProcessError::SecretInCommandLine`] when the payload was also placed
642 /// in an argument or explicitly configured environment value, plus every
643 /// error returned by [`SpawnSpec::spawn`].
644 pub fn spawn_runner_with_handoff(
645 &self,
646 handoff: &RestrictiveHandoff,
647 ) -> Result<ChildProcess, ProcessError> {
648 self.reject_exposed_handoff(handoff)?;
649 self.spawn_with_extra_env(Some((
650 OsStr::new(RUNNER_JIT_CONFIG_ENV),
651 OsStr::new(handoff.payload.expose_secret()),
652 )))
653 }
654
655 fn reject_exposed_handoff(&self, handoff: &RestrictiveHandoff) -> Result<(), ProcessError> {
656 let payload = handoff.payload.expose_secret();
657 // An empty payload cannot meaningfully be searched for — every string
658 // contains it — and it is not a secret worth protecting either.
659 if !payload.is_empty() {
660 for (index, arg) in self.args.iter().enumerate() {
661 if os_str_contains(arg, payload) {
662 return Err(ProcessError::SecretInCommandLine {
663 program: self.program.clone(),
664 location: format!("argument {index}"),
665 });
666 }
667 }
668 for (key, value) in &self.envs {
669 if os_str_contains(value, payload) {
670 return Err(ProcessError::SecretInCommandLine {
671 program: self.program.clone(),
672 location: format!("environment variable {}", key.to_string_lossy()),
673 });
674 }
675 }
676 }
677
678 Ok(())
679 }
680}
681
682/// Whether `haystack` contains `needle`, for an [`OsStr`] that may not be valid
683/// Unicode.
684///
685/// `to_string_lossy` is enough here: the payload is a base64 JIT configuration,
686/// so it is ASCII, and lossy conversion replaces only the bytes that could not
687/// have matched it anyway.
688fn os_str_contains(haystack: &OsStr, needle: &str) -> bool {
689 haystack.to_string_lossy().contains(needle)
690}
691
692/// A child process this agent started.
693///
694/// `04-subsystem-contracts.md`: *"local process state is authoritative only for
695/// a child process owned by this agent"*. That is this type. For a process
696/// recovered from the journal after a restart there is no [`Child`] and no
697/// parent relationship, so [`ProcessIdentity`] is the authority instead.
698#[derive(Debug)]
699pub struct ChildProcess {
700 child: Child,
701 identity: ProcessIdentity,
702 program: PathBuf,
703}
704
705impl ChildProcess {
706 /// The identity to record in the journal.
707 #[must_use]
708 pub const fn identity(&self) -> &ProcessIdentity {
709 &self.identity
710 }
711
712 /// The child's PID.
713 #[must_use]
714 pub const fn pid(&self) -> u32 {
715 self.identity.pid
716 }
717
718 /// Whether the child is still running.
719 ///
720 /// # Errors
721 ///
722 /// [`ProcessError::Control`] when the wait fails.
723 pub fn is_running(&mut self) -> Result<bool, ProcessError> {
724 Ok(self.try_exit_status()?.is_none())
725 }
726
727 /// The child's exit status if it has already exited, reaping it if so.
728 ///
729 /// # Errors
730 ///
731 /// [`ProcessError::Control`] when the wait fails.
732 pub fn try_exit_status(&mut self) -> Result<Option<ExitStatus>, ProcessError> {
733 self.child
734 .try_wait()
735 .map_err(|source| ProcessError::Control {
736 pid: self.identity.pid,
737 source,
738 })
739 }
740
741 /// Blocks until the child exits.
742 ///
743 /// # Errors
744 ///
745 /// [`ProcessError::Control`] when the wait fails.
746 pub fn wait(&mut self) -> Result<ExitStatus, ProcessError> {
747 self.child.wait().map_err(|source| ProcessError::Control {
748 pid: self.identity.pid,
749 source,
750 })
751 }
752
753 /// Waits up to `timeout` for the child to exit; `None` means it is still
754 /// running when the timeout expires.
755 ///
756 /// # Errors
757 ///
758 /// [`ProcessError::Control`] when the wait fails.
759 pub fn wait_for(&mut self, timeout: Duration) -> Result<Option<ExitStatus>, ProcessError> {
760 let deadline = Instant::now() + timeout;
761 loop {
762 if let Some(status) = self.try_exit_status()? {
763 return Ok(Some(status));
764 }
765 if Instant::now() >= deadline {
766 return Ok(None);
767 }
768 std::thread::sleep(POLL_INTERVAL);
769 }
770 }
771
772 /// Asks the child to stop, forcefully if `grace` expires first.
773 ///
774 /// See [`ProcessIdentity::terminate`] for what `grace` means on each
775 /// platform. Unlike that method this one has the parent relationship, so it
776 /// reaps the child and returns its exit status.
777 ///
778 /// # Errors
779 ///
780 /// [`ProcessError::Control`] when signalling or waiting fails.
781 pub fn stop(&mut self, grace: Duration) -> Result<ExitStatus, ProcessError> {
782 if let Some(status) = self.try_exit_status()? {
783 return Ok(status);
784 }
785
786 let pid = self.identity.pid;
787 // Safe to signal by PID: this process holds the child handle, so the
788 // PID cannot have been recycled behind our back.
789 let requested =
790 sys::request_stop(pid).map_err(|source| ProcessError::Control { pid, source })?;
791
792 if requested && let Some(status) = self.wait_for(grace)? {
793 return Ok(status);
794 }
795
796 self.child
797 .kill()
798 .map_err(|source| ProcessError::Control { pid, source })?;
799 self.wait()
800 }
801
802 /// Takes the captured standard output, if [`OutputMode::Capture`] was set.
803 pub fn take_stdout(&mut self) -> Option<std::process::ChildStdout> {
804 self.child.stdout.take()
805 }
806
807 /// Takes the captured standard error, if [`OutputMode::Capture`] was set.
808 pub fn take_stderr(&mut self) -> Option<std::process::ChildStderr> {
809 self.child.stderr.take()
810 }
811
812 /// The program that was launched.
813 #[must_use]
814 pub fn program(&self) -> &Path {
815 &self.program
816 }
817}
818
819// ---------------------------------------------------------------------------
820// Restrictive handoff
821// ---------------------------------------------------------------------------
822
823/// Something went wrong creating, inspecting, or removing a handoff file.
824#[derive(Debug, thiserror::Error)]
825pub enum HandoffError {
826 /// The file could not be created with restrictive permissions.
827 #[error("cannot create a restrictive handoff file in {}: {source}", directory.display())]
828 Create {
829 /// The directory the file was to be created in.
830 directory: PathBuf,
831 /// The underlying error.
832 #[source]
833 source: std::io::Error,
834 },
835
836 /// The payload could not be written.
837 #[error("cannot write the handoff payload to {}: {source}", path.display())]
838 Write {
839 /// The file that could not be written.
840 path: PathBuf,
841 /// The underlying error.
842 #[source]
843 source: std::io::Error,
844 },
845
846 /// The file's permissions could not be read back.
847 #[error("cannot read the permissions of {}: {source}", path.display())]
848 Inspect {
849 /// The file that could not be inspected.
850 path: PathBuf,
851 /// The underlying error.
852 #[source]
853 source: std::io::Error,
854 },
855
856 /// The file could not be removed.
857 ///
858 /// Worth an error rather than a shrug: a JIT configuration left on disk is
859 /// the exact thing `05-infrastructure.md` says must be deleted immediately.
860 #[error("cannot delete the handoff file {}: {source}", path.display())]
861 Delete {
862 /// The file that could not be removed.
863 path: PathBuf,
864 /// The underlying error.
865 #[source]
866 source: std::io::Error,
867 },
868}
869
870/// What a file's permissions amount to, in terms this product cares about.
871#[derive(Debug, Clone, PartialEq, Eq)]
872pub struct PermissionsSummary {
873 /// Platform-native description — a Unix mode, or a Windows DACL in SDDL
874 /// form. For diagnostics and for test failure messages.
875 pub description: String,
876 /// Whether an ordinary local user other than the file's owner could read
877 /// it.
878 ///
879 /// A local administrator or `root` is deliberately outside this question:
880 /// `07-security.md` records that such an account is already assumed able to
881 /// read the runner's credentials and job workspaces, so pretending a file
882 /// mode could exclude it would be theatre.
883 pub readable_by_other_local_users: bool,
884}
885
886/// Reads back what a file's permissions actually grant.
887///
888/// # Errors
889///
890/// [`HandoffError::Inspect`] when the permissions cannot be read.
891/// This account's SID, in the string form an SDDL trustee takes.
892///
893/// Windows only, because a SID is. The secret store names the account that
894/// wrote a value explicitly rather than describing it as `OW`: OWNER RIGHTS is
895/// deleted by the system whenever an object's owner changes, so a DACL that
896/// leans on it loses the grant the moment anybody runs `takeown`.
897///
898/// # Errors
899/// Whatever reading this process's own token reported.
900#[cfg(windows)]
901pub(crate) fn current_user_sid() -> std::io::Result<String> {
902 sys::current_user_sid()
903}
904
905pub fn permissions_summary(path: &Path) -> Result<PermissionsSummary, HandoffError> {
906 sys::describe_permissions(path)
907 .map(
908 |(description, readable_by_other_local_users)| PermissionsSummary {
909 description,
910 readable_by_other_local_users,
911 },
912 )
913 .map_err(|source| HandoffError::Inspect {
914 path: path.to_path_buf(),
915 source,
916 })
917}
918
919/// A short-lived file holding a secret, readable only by this account, deleted
920/// on every path out.
921///
922/// `05-infrastructure.md` puts the encoded JIT configuration in a *"restrictive
923/// temporary file or process-safe handoff"* and requires *"Delete immediately
924/// after runner start or failed start"*. Both halves of that sentence are
925/// implemented here: [`RestrictiveHandoff::create`] makes the file
926/// unreadable by other local users at the moment of creation, and [`Drop`]
927/// deletes it whether the launch succeeded, failed, or panicked.
928///
929/// # Why creation, not creation-then-chmod
930///
931/// On Windows the file is created through `CreateFileW` with an explicit
932/// `SECURITY_ATTRIBUTES`, and on Unix through `open(2)` with mode `0600`. In
933/// both cases the restriction is applied *by the call that creates the file*.
934/// Creating a file and then tightening it leaves a window — however short — in
935/// which the JIT configuration exists on disk under whatever the parent
936/// directory happened to grant, and a window is all a local attacker needs.
937///
938/// # What is not claimed
939///
940/// The file is deleted, not securely erased. No modern filesystem lets a
941/// userspace program guarantee that the bytes are unrecoverable — a journal, a
942/// copy-on-write snapshot, or an SSD's wear levelling can each keep a copy that
943/// an overwrite never reaches. Claiming otherwise would be worse than saying
944/// so plainly, so the control this design relies on is the file's short life
945/// and its access control, not erasure.
946#[derive(Debug)]
947pub struct RestrictiveHandoff {
948 path: PathBuf,
949 payload: SecretString,
950 deleted: bool,
951}
952
953impl RestrictiveHandoff {
954 /// What every handoff file's name begins with.
955 ///
956 /// Published because the name is otherwise a UUID nobody can predict, and
957 /// `c3`'s persistent cleanup has to answer "did an encoded configuration
958 /// survive into this slot?" *after* the process that owned it is gone
959 /// (`04-security-recovery.md`: JIT values are "never retained in slot").
960 /// A second `"jit-"` spelled out over there would be a second source of
961 /// truth for the one fact that decides whether a secret is still on disk.
962 pub const NAME_PREFIX: &'static str = "jit-";
963
964 /// Writes `payload` to a new uniquely named file in `directory`.
965 ///
966 /// The name is a UUID rather than a predictable one, so that another local
967 /// account cannot pre-create the path and win the race for it; creation is
968 /// exclusive, so if it did, this fails rather than writing into the
969 /// squatter's file.
970 ///
971 /// # Errors
972 ///
973 /// [`HandoffError::Create`] and [`HandoffError::Write`].
974 pub fn create(directory: &Path, payload: SecretString) -> Result<Self, HandoffError> {
975 use std::io::Write as _;
976
977 let path = directory.join(format!("{}{}.tmp", Self::NAME_PREFIX, uuid::Uuid::new_v4()));
978
979 let mut file =
980 sys::create_restrictive_file(&path).map_err(|source| HandoffError::Create {
981 directory: directory.to_path_buf(),
982 source,
983 })?;
984
985 let handoff = Self {
986 path,
987 payload,
988 deleted: false,
989 };
990
991 // From here on the file exists, so every failure path must delete it.
992 // `handoff` is already constructed, so `?` unwinds through its `Drop`.
993 let write = file
994 .write_all(handoff.payload.expose_secret().as_bytes())
995 .and_then(|()| file.flush())
996 .and_then(|()| file.sync_all());
997 write.map_err(|source| HandoffError::Write {
998 path: handoff.path.clone(),
999 source,
1000 })?;
1001 drop(file);
1002
1003 Ok(handoff)
1004 }
1005
1006 /// The path to hand to the child process.
1007 ///
1008 /// This is the only thing that may reach a command line. The payload is not
1009 /// exposed at all: it is held as a [`SecretString`], which has no `Display`
1010 /// and a redacting `Debug`, so it cannot be formatted into an argument by
1011 /// accident.
1012 #[must_use]
1013 pub fn path(&self) -> &Path {
1014 &self.path
1015 }
1016
1017 /// What the file's permissions actually grant.
1018 ///
1019 /// # Errors
1020 ///
1021 /// [`HandoffError::Inspect`].
1022 pub fn permissions(&self) -> Result<PermissionsSummary, HandoffError> {
1023 permissions_summary(&self.path)
1024 }
1025
1026 /// Deletes the file now, reporting failure.
1027 ///
1028 /// The success path should call this rather than relying on [`Drop`], for
1029 /// one reason: `Drop` cannot report an error, and a JIT configuration that
1030 /// could not be deleted is something an operator must be told about.
1031 ///
1032 /// # Errors
1033 ///
1034 /// [`HandoffError::Delete`].
1035 pub fn delete(mut self) -> Result<(), HandoffError> {
1036 self.delete_in_place()
1037 }
1038
1039 fn delete_in_place(&mut self) -> Result<(), HandoffError> {
1040 if self.deleted {
1041 return Ok(());
1042 }
1043 match std::fs::remove_file(&self.path) {
1044 Ok(()) => {
1045 self.deleted = true;
1046 Ok(())
1047 }
1048 // Already gone is the desired end state, not a failure.
1049 Err(source) if source.kind() == std::io::ErrorKind::NotFound => {
1050 self.deleted = true;
1051 Ok(())
1052 }
1053 Err(source) => Err(HandoffError::Delete {
1054 path: self.path.clone(),
1055 source,
1056 }),
1057 }
1058 }
1059}
1060
1061impl Drop for RestrictiveHandoff {
1062 fn drop(&mut self) {
1063 if let Err(error) = self.delete_in_place() {
1064 // The path is logged at `error` because an undeleted JIT
1065 // configuration is an operator-actionable condition, and the path
1066 // is the only actionable part. It is redacted by the log sink like
1067 // every other path (`crate::logging`).
1068 tracing::error!(
1069 event = "handoff_delete_failed",
1070 path = %self.path.display(),
1071 error = %error,
1072 "a JIT handoff file could not be deleted and is still on disk"
1073 );
1074 }
1075 }
1076}
1077
1078// ---------------------------------------------------------------------------
1079// The Linux `/proc/<pid>/stat` parser
1080// ---------------------------------------------------------------------------
1081
1082/// The two fields of `/proc/<pid>/stat` this crate reads.
1083#[cfg_attr(
1084 not(target_os = "linux"),
1085 allow(dead_code, reason = "parsed on Linux; unit tested on every platform")
1086)]
1087#[derive(Debug, Clone, PartialEq, Eq)]
1088struct ProcStat<'a> {
1089 /// Field 3: a single character, `R`, `S`, `D`, `Z`, `T`, and so on.
1090 state: &'a str,
1091 /// Field 22: the process's start time, in clock ticks since boot.
1092 start_ticks: &'a str,
1093}
1094
1095/// Parses the fields after the `comm` field of a `/proc/<pid>/stat` line.
1096///
1097/// Lives here, outside the `#[cfg(unix)]` module, for one reason: it is the
1098/// riskiest few lines in this crate and the only ones whose correctness is
1099/// pure string handling. Keeping it platform-independent means it is unit
1100/// tested on the Windows and macOS legs of CI as well as the Linux one, and by
1101/// a developer on any machine — rather than being exercised for the first time
1102/// on the leg where a mistake is a wrong process identity.
1103///
1104/// The hazard it exists to handle: **field 2 is the executable name, in
1105/// parentheses, and it may itself contain spaces and parentheses.** A process
1106/// really can be called `my prog (v2)`, and `procfs(5)` says so. Splitting the
1107/// whole line on whitespace therefore mis-indexes every later field, and does
1108/// so only for the one process whose name happens to be adversarial — which is
1109/// to say, only when someone is being adversarial. The *last* `)` on the line
1110/// is the reliable anchor, because every field after `comm` is numeric.
1111#[cfg_attr(
1112 not(target_os = "linux"),
1113 allow(dead_code, reason = "parsed on Linux; unit tested on every platform")
1114)]
1115fn parse_proc_stat(stat: &str) -> Option<ProcStat<'_>> {
1116 // Everything after the last `)` is field 3 onwards, all of it numeric and
1117 // whitespace separated.
1118 let after_comm = &stat[stat.rfind(')')? + 1..];
1119 let mut fields = after_comm.split_whitespace();
1120
1121 // `next()` yields field 3; the iterator then stands at field 4, so
1122 // `nth(k)` yields field `4 + k`.
1123 let state = fields.next()?;
1124 let start_ticks = fields.nth(22 - 4)?;
1125
1126 Some(ProcStat { state, start_ticks })
1127}
1128
1129/// Whether a failed start-time probe means the process is *gone*, as opposed to
1130/// unreadable for some other reason.
1131///
1132/// `no_such_process` is the platform's `ESRCH`, passed in rather than read from
1133/// `libc` here for the same reason [`parse_proc_stat`] lives outside the
1134/// `#[cfg(unix)]` module: this is a security-relevant decision that is
1135/// otherwise only compiled on two of the three CI legs and testable on neither
1136/// a Windows developer's machine nor the Windows leg. As a plain function over
1137/// an `Option<i32>` it is exercised everywhere.
1138///
1139/// **Only `ESRCH` is "gone".** Every other answer — `EPERM` for a process this
1140/// account may not inspect, or a zero `errno` from a call that failed without
1141/// setting one — is an error. This is the same rule the Windows leg applies to
1142/// `ERROR_ACCESS_DENIED`, and for the same reason: an unexplained failure is
1143/// not evidence of absence, and reporting [`Adoption::Gone`] for one is how an
1144/// agent decides to start a duplicate runner.
1145///
1146/// # Compiled where it is used, rather than allowed where it is not
1147///
1148/// This carried `#[cfg_attr(not(target_os = "macos"), allow(dead_code, …))]`,
1149/// and now carries a `cfg` that names macOS plus `test`. The difference is not
1150/// tidiness. An allowance leaves the lint's premise true and silences the
1151/// report; the condition it carries is a claim about every platform it does
1152/// *not* name, and getting that claim wrong is invisible until the one CI leg
1153/// that disagrees runs. That is precisely how N1 reached the Linux leg. A
1154/// `cfg` makes the premise false instead: on a platform that does not call
1155/// this, the item is not there to be dead, and there is nothing left to allow.
1156///
1157/// `test` is in the condition because the unit tests below are the reason this
1158/// function is a plain function over `Option<i32>` at all -- they are what
1159/// exercise it on the Windows and Linux legs, where the macOS caller does not
1160/// exist.
1161#[cfg(any(target_os = "macos", test))]
1162const fn probe_failure_means_gone(errno: Option<i32>, no_such_process: i32) -> bool {
1163 matches!(errno, Some(code) if code == no_such_process)
1164}
1165
1166// ---------------------------------------------------------------------------
1167// Platform implementations
1168// ---------------------------------------------------------------------------
1169//
1170// Each `sys` module offers the same five functions, and the shared code above
1171// is the only caller:
1172//
1173// start_token(pid, filter) -> Ok(None) when nothing matching holds the PID
1174// request_stop(pid) -> Ok(false) when the platform has no polite stop
1175// force_stop(pid) -> terminate immediately
1176// create_restrictive_file(p) -> a new file only this account can read
1177// describe_permissions(p) -> (native description, readable by others?)
1178
1179#[cfg(windows)]
1180mod sys {
1181 use std::fs::File;
1182 use std::io;
1183 use std::os::windows::ffi::OsStrExt;
1184 use std::os::windows::io::FromRawHandle;
1185 use std::path::Path;
1186
1187 use windows::Win32::Foundation::{
1188 CloseHandle, ERROR_ACCESS_DENIED, ERROR_INVALID_PARAMETER, ERROR_SUCCESS, FILETIME, HANDLE,
1189 HLOCAL, LocalFree,
1190 };
1191 use windows::Win32::Security::Authorization::{
1192 ConvertSecurityDescriptorToStringSecurityDescriptorW, ConvertSidToStringSidW,
1193 ConvertStringSecurityDescriptorToSecurityDescriptorW, GetNamedSecurityInfoW,
1194 SDDL_REVISION_1, SE_FILE_OBJECT,
1195 };
1196 use windows::Win32::Security::{
1197 DACL_SECURITY_INFORMATION, GetTokenInformation, PSECURITY_DESCRIPTOR, SECURITY_ATTRIBUTES,
1198 TOKEN_QUERY, TOKEN_USER, TokenUser,
1199 };
1200 use windows::Win32::Storage::FileSystem::{
1201 CREATE_NEW, CreateFileW, FILE_ATTRIBUTE_NORMAL, FILE_GENERIC_READ, FILE_GENERIC_WRITE,
1202 FILE_SHARE_NONE,
1203 };
1204 use windows::Win32::System::Threading::{
1205 GetCurrentProcess, GetProcessTimes, OpenProcess, OpenProcessToken,
1206 PROCESS_QUERY_LIMITED_INFORMATION, PROCESS_TERMINATE, TerminateProcess,
1207 };
1208 use windows::core::{PCWSTR, PWSTR};
1209
1210 /// `HRESULT_FROM_WIN32`, which windows-rs does not re-export as a function.
1211 const fn hresult_from_win32(code: u32) -> i32 {
1212 if code == 0 {
1213 0
1214 } else {
1215 ((code & 0x0000_ffff) | 0x8007_0000) as i32
1216 }
1217 }
1218
1219 fn to_wide(path: &Path) -> Vec<u16> {
1220 path.as_os_str()
1221 .encode_wide()
1222 .chain(std::iter::once(0))
1223 .collect()
1224 }
1225
1226 fn filetime_to_u64(time: FILETIME) -> u64 {
1227 (u64::from(time.dwHighDateTime) << 32) | u64::from(time.dwLowDateTime)
1228 }
1229
1230 fn io_error(error: &windows::core::Error) -> io::Error {
1231 io::Error::from_raw_os_error(error.code().0)
1232 }
1233
1234 pub(super) fn start_token(
1235 pid: u32,
1236 filter: super::LivenessFilter,
1237 ) -> io::Result<Option<String>> {
1238 let handle = match unsafe { OpenProcess(PROCESS_QUERY_LIMITED_INFORMATION, false, pid) } {
1239 Ok(handle) => handle,
1240 Err(error) => {
1241 // `OpenProcess` answers a PID nobody holds with
1242 // ERROR_INVALID_PARAMETER, not with a "no such process" code.
1243 // Access denied stays an error: a process this agent may not
1244 // query is not the same as one that is gone, and treating it as
1245 // gone is how an agent decides to start a duplicate.
1246 let code = error.code().0;
1247 if code == hresult_from_win32(ERROR_INVALID_PARAMETER.0) {
1248 return Ok(None);
1249 }
1250 if code == hresult_from_win32(ERROR_ACCESS_DENIED.0) {
1251 return Err(io::Error::new(
1252 io::ErrorKind::PermissionDenied,
1253 format!("PID {pid} belongs to a process this account may not query"),
1254 ));
1255 }
1256 return Err(io_error(&error));
1257 }
1258 };
1259
1260 let mut creation = FILETIME::default();
1261 let mut exit = FILETIME::default();
1262 let mut kernel = FILETIME::default();
1263 let mut user = FILETIME::default();
1264 let times =
1265 unsafe { GetProcessTimes(handle, &mut creation, &mut exit, &mut kernel, &mut user) };
1266 unsafe {
1267 let _ = CloseHandle(handle);
1268 }
1269 times.map_err(|error| io_error(&error))?;
1270
1271 // A non-zero exit time means the process object outlives the process
1272 // itself because somebody still holds a handle to it — which this
1273 // process does, for every child it spawned. Without this check a killed
1274 // child would keep reporting `Live` until it was reaped.
1275 if filetime_to_u64(exit) != 0 && filter == super::LivenessFilter::LiveOnly {
1276 return Ok(None);
1277 }
1278
1279 Ok(Some(format!("windows:{}", filetime_to_u64(creation))))
1280 }
1281
1282 pub(super) fn request_stop(_pid: u32) -> io::Result<bool> {
1283 // Windows has no signal a non-console process can be asked to handle
1284 // from outside. `GenerateConsoleCtrlEvent` needs a shared console, and
1285 // a service-hosted agent has none. Reporting `false` tells the caller
1286 // to go straight to `force_stop` rather than sit through a grace period
1287 // during which nothing was ever asked.
1288 Ok(false)
1289 }
1290
1291 pub(super) fn force_stop(pid: u32) -> io::Result<()> {
1292 let _ = std::process::Command::new("taskkill")
1293 .args(["/F", "/T", "/PID", &pid.to_string()])
1294 .stdout(std::process::Stdio::null())
1295 .stderr(std::process::Stdio::null())
1296 .status();
1297
1298 match unsafe { OpenProcess(PROCESS_TERMINATE, false, pid) } {
1299 Ok(handle) => {
1300 let result = unsafe { TerminateProcess(handle, 1) };
1301 unsafe {
1302 let _ = CloseHandle(handle);
1303 }
1304 if let Err(error) = result {
1305 let code = error.code().0 as u32;
1306 if code != 0x80070005 && code != 0x80070057 {
1307 return Err(io_error(&error));
1308 }
1309 }
1310 Ok(())
1311 }
1312 Err(error) => {
1313 let code = error.code().0 as u32;
1314 if code == 0x80070005 || code == 0x80070057 {
1315 Ok(())
1316 } else {
1317 Err(io_error(&error))
1318 }
1319 }
1320 }
1321 }
1322
1323 /// The current account's SID in string form, for the DACL below.
1324 ///
1325 /// `pub(crate)` because the secret store needs the same answer for the same
1326 /// reason: a DACL that names the account explicitly, rather than one that
1327 /// describes it and hopes the description still fits later.
1328 pub(crate) fn current_user_sid() -> io::Result<String> {
1329 let mut token = HANDLE(std::ptr::null_mut());
1330 unsafe { OpenProcessToken(GetCurrentProcess(), TOKEN_QUERY, &mut token) }
1331 .map_err(|error| io_error(&error))?;
1332
1333 let mut needed = 0u32;
1334 // The first call is expected to fail with ERROR_INSUFFICIENT_BUFFER; it
1335 // is how the required size is learned.
1336 let _ = unsafe { GetTokenInformation(token, TokenUser, None, 0, &mut needed) };
1337
1338 // `TOKEN_USER` contains a pointer, so the buffer must be
1339 // pointer-aligned; a `Vec<u8>` is aligned to 1 and casting it would be
1340 // undefined behaviour.
1341 let words = (needed as usize).div_ceil(size_of::<usize>()).max(1);
1342 let mut buffer = vec![0usize; words];
1343
1344 let information = unsafe {
1345 GetTokenInformation(
1346 token,
1347 TokenUser,
1348 Some(buffer.as_mut_ptr().cast()),
1349 needed,
1350 &mut needed,
1351 )
1352 };
1353 if let Err(error) = information {
1354 unsafe {
1355 let _ = CloseHandle(token);
1356 }
1357 return Err(io_error(&error));
1358 }
1359
1360 let token_user = unsafe { &*buffer.as_ptr().cast::<TOKEN_USER>() };
1361 let mut sid_string = PWSTR::null();
1362 let converted = unsafe { ConvertSidToStringSidW(token_user.User.Sid, &mut sid_string) };
1363 unsafe {
1364 let _ = CloseHandle(token);
1365 }
1366 converted.map_err(|error| io_error(&error))?;
1367
1368 let text = unsafe { sid_string.to_string() }
1369 .map_err(|error| io::Error::new(io::ErrorKind::InvalidData, error));
1370 unsafe {
1371 let _ = LocalFree(Some(HLOCAL(sid_string.0.cast())));
1372 }
1373 text
1374 }
1375
1376 pub(super) fn create_restrictive_file(path: &Path) -> io::Result<File> {
1377 // A protected DACL — the `P` — so that nothing is inherited from the
1378 // parent directory, granting full access to exactly two trustees: this
1379 // account, and the local Administrators group.
1380 //
1381 // `BA` is not a weakening: `07-security.md` places a local
1382 // administrator outside this threat model, because such an account can
1383 // already read the runner's workspace and its credentials. It is kept
1384 // so that an operator can clean up a handoff file left behind by an
1385 // agent running under a service account they are not logged in as.
1386 //
1387 // There is deliberately no `(A;;FA;;;SY)` ACE. An earlier version
1388 // carried one "so that a service running as LocalSystem still works",
1389 // and that justification was simply wrong: if this agent *is*
1390 // LocalSystem then `current_user_sid()` returns S-1-5-18 and the third
1391 // ACE already covers it. So the ACE added nothing in the one case it
1392 // was written for, and in every other case it widened access to a file
1393 // whose entire purpose is to be narrow.
1394 let sddl = format!("D:P(A;;FA;;;BA)(A;;FA;;;{})", current_user_sid()?);
1395 let sddl_wide: Vec<u16> = sddl.encode_utf16().chain(std::iter::once(0)).collect();
1396
1397 let mut descriptor = PSECURITY_DESCRIPTOR(std::ptr::null_mut());
1398 unsafe {
1399 ConvertStringSecurityDescriptorToSecurityDescriptorW(
1400 PCWSTR(sddl_wide.as_ptr()),
1401 SDDL_REVISION_1,
1402 &mut descriptor,
1403 None,
1404 )
1405 }
1406 .map_err(|error| io_error(&error))?;
1407
1408 let attributes = SECURITY_ATTRIBUTES {
1409 nLength: u32::try_from(size_of::<SECURITY_ATTRIBUTES>()).unwrap_or(u32::MAX),
1410 lpSecurityDescriptor: descriptor.0,
1411 // False: a handle to the JIT configuration must not be inherited by
1412 // the runner or by anything else this agent spawns.
1413 bInheritHandle: windows::core::BOOL(0),
1414 };
1415
1416 let wide = to_wide(path);
1417 let handle = unsafe {
1418 CreateFileW(
1419 PCWSTR(wide.as_ptr()),
1420 FILE_GENERIC_READ.0 | FILE_GENERIC_WRITE.0,
1421 FILE_SHARE_NONE,
1422 Some(&raw const attributes),
1423 CREATE_NEW,
1424 FILE_ATTRIBUTE_NORMAL,
1425 None,
1426 )
1427 };
1428
1429 unsafe {
1430 let _ = LocalFree(Some(HLOCAL(descriptor.0)));
1431 }
1432
1433 let handle = handle.map_err(|error| io_error(&error))?;
1434 Ok(unsafe { File::from_raw_handle(handle.0) })
1435 }
1436
1437 pub(super) fn describe_permissions(path: &Path) -> io::Result<(String, bool)> {
1438 let wide = to_wide(path);
1439 let mut descriptor = PSECURITY_DESCRIPTOR(std::ptr::null_mut());
1440 let status = unsafe {
1441 GetNamedSecurityInfoW(
1442 PCWSTR(wide.as_ptr()),
1443 SE_FILE_OBJECT,
1444 DACL_SECURITY_INFORMATION,
1445 None,
1446 None,
1447 None,
1448 None,
1449 &mut descriptor,
1450 )
1451 };
1452 if status != ERROR_SUCCESS {
1453 return Err(io::Error::from_raw_os_error(
1454 i32::try_from(status.0).unwrap_or(i32::MAX),
1455 ));
1456 }
1457
1458 let mut sddl = PWSTR::null();
1459 let converted = unsafe {
1460 ConvertSecurityDescriptorToStringSecurityDescriptorW(
1461 descriptor,
1462 SDDL_REVISION_1,
1463 DACL_SECURITY_INFORMATION,
1464 &mut sddl,
1465 None,
1466 )
1467 };
1468 let text = match converted {
1469 Ok(()) => {
1470 let text = unsafe { sddl.to_string() }
1471 .map_err(|error| io::Error::new(io::ErrorKind::InvalidData, error));
1472 unsafe {
1473 let _ = LocalFree(Some(HLOCAL(sddl.0.cast())));
1474 }
1475 text
1476 }
1477 Err(error) => Err(io_error(&error)),
1478 };
1479 unsafe {
1480 let _ = LocalFree(Some(HLOCAL(descriptor.0)));
1481 }
1482 let text = text?;
1483
1484 let readable = dacl_grants_broad_access(&text);
1485 Ok((text, readable))
1486 }
1487
1488 /// Whether a DACL in SDDL form lets an ordinary local user other than the
1489 /// owner read the object.
1490 ///
1491 /// Two conditions, and both matter. An unprotected DACL inherits whatever
1492 /// the parent directory grants, which is not this program's to vouch for.
1493 /// And an allow ACE naming one of the broad well-known trustees grants
1494 /// access to every interactive account on the machine.
1495 fn dacl_grants_broad_access(sddl: &str) -> bool {
1496 /// The trustees that mean "more or less anybody logged in here", in
1497 /// both the two-letter SDDL alias form and the raw SID form the
1498 /// converter may emit instead.
1499 const BROAD: &[&str] = &[
1500 "WD", // Everyone
1501 "S-1-1-0", // Everyone
1502 "AU", // Authenticated Users
1503 "S-1-5-11", // Authenticated Users
1504 "BU", // Builtin Users
1505 "S-1-5-32-545", // Builtin Users
1506 "IU", // Interactive
1507 "S-1-5-4", // Interactive
1508 "AN", // Anonymous
1509 "S-1-5-7", // Anonymous
1510 "WR", // Write Restricted
1511 "LU", // Performance Log Users
1512 ];
1513
1514 let Some(dacl) = sddl.split("D:").nth(1) else {
1515 // No DACL at all means "everyone, full control" in Windows'
1516 // security model. Never the answer this function should be
1517 // optimistic about.
1518 return true;
1519 };
1520
1521 let flags: String = dacl.chars().take_while(|c| *c != '(').collect();
1522 if !flags.contains('P') {
1523 return true;
1524 }
1525
1526 for ace in dacl.split('(').skip(1) {
1527 let ace = ace.split(')').next().unwrap_or_default();
1528 let fields: Vec<&str> = ace.split(';').collect();
1529 // (type;flags;rights;object_guid;inherit_object_guid;trustee)
1530 let (Some(kind), Some(trustee)) = (fields.first(), fields.get(5)) else {
1531 continue;
1532 };
1533 // Only allow ACEs grant anything; a deny ACE naming Everyone is a
1534 // tightening, not a leak.
1535 if !kind.starts_with('A') {
1536 continue;
1537 }
1538 if BROAD
1539 .iter()
1540 .any(|broad| trustee.eq_ignore_ascii_case(broad))
1541 {
1542 return true;
1543 }
1544 }
1545
1546 false
1547 }
1548
1549 #[cfg(test)]
1550 mod tests {
1551 use super::dacl_grants_broad_access;
1552
1553 #[test]
1554 fn a_protected_owner_only_dacl_is_not_broadly_readable() {
1555 // The shape `create_restrictive_file` actually writes: protected,
1556 // Administrators, and this account. No LocalSystem ACE — see the
1557 // comment there for why one would add nothing.
1558 assert!(!dacl_grants_broad_access(
1559 "D:P(A;;FA;;;BA)(A;;FA;;;S-1-5-21-1-2-3-1001)"
1560 ));
1561 // A LocalSystem agent's own SID is S-1-5-18, which is what makes
1562 // the separate `SY` ACE redundant rather than load-bearing.
1563 assert!(!dacl_grants_broad_access(
1564 "D:P(A;;FA;;;BA)(A;;FA;;;S-1-5-18)"
1565 ));
1566 // Still tolerated when it arrives from somewhere else: this
1567 // heuristic inspects files, and not every file it sees was written
1568 // by this module.
1569 assert!(!dacl_grants_broad_access(
1570 "D:P(A;;FA;;;SY)(A;;FA;;;BA)(A;;FA;;;S-1-5-21-1-2-3-1001)"
1571 ));
1572 }
1573
1574 #[test]
1575 fn an_everyone_ace_is_broadly_readable_in_either_notation() {
1576 assert!(dacl_grants_broad_access("D:P(A;;FA;;;SY)(A;;FR;;;WD)"));
1577 assert!(dacl_grants_broad_access("D:P(A;;FA;;;SY)(A;;FR;;;S-1-1-0)"));
1578 assert!(dacl_grants_broad_access("D:P(A;;FR;;;BU)"));
1579 }
1580
1581 #[test]
1582 fn an_unprotected_dacl_is_broadly_readable_because_it_inherits() {
1583 assert!(dacl_grants_broad_access("D:AI(A;ID;FA;;;SY)"));
1584 }
1585
1586 #[test]
1587 fn a_deny_ace_for_everyone_is_not_a_grant() {
1588 assert!(!dacl_grants_broad_access("D:P(D;;FA;;;WD)(A;;FA;;;SY)"));
1589 }
1590
1591 #[test]
1592 fn a_missing_dacl_is_treated_as_wide_open() {
1593 assert!(dacl_grants_broad_access("O:BAG:BA"));
1594 }
1595 }
1596}
1597
1598#[cfg(unix)]
1599mod sys {
1600 use std::fs::File;
1601 use std::io;
1602 use std::os::unix::fs::{OpenOptionsExt, PermissionsExt};
1603 use std::path::Path;
1604
1605 pub(super) fn request_stop(pid: u32) -> io::Result<bool> {
1606 // SAFETY: `kill` takes a PID and a signal number and touches no memory
1607 // this program owns. The PID is checked for liveness by the caller
1608 // immediately beforehand, and every caller either holds the child
1609 // handle or has just re-verified the process identity.
1610 // We use `-pid` to send the signal to the entire process group.
1611 let result = unsafe { libc::kill(-(pid as libc::pid_t), libc::SIGTERM) };
1612 if result == 0 {
1613 return Ok(true);
1614 }
1615 let error = io::Error::last_os_error();
1616 // The process exited between the liveness check and the signal. That is
1617 // a normal race, not a failure to stop it.
1618 if error.raw_os_error() == Some(libc::ESRCH) {
1619 return Ok(true);
1620 }
1621 Err(error)
1622 }
1623
1624 pub(super) fn force_stop(pid: u32) -> io::Result<()> {
1625 // SAFETY: as `request_stop`.
1626 let result = unsafe { libc::kill(-(pid as libc::pid_t), libc::SIGKILL) };
1627 if result == 0 {
1628 return Ok(());
1629 }
1630 let error = io::Error::last_os_error();
1631 if error.raw_os_error() == Some(libc::ESRCH) {
1632 return Ok(());
1633 }
1634 Err(error)
1635 }
1636
1637 pub(super) fn create_restrictive_file(path: &Path) -> io::Result<File> {
1638 // `mode` is applied by `open(2)` itself, so the file never exists with
1639 // any other permissions. `create_new` makes it exclusive, so a
1640 // pre-created path belonging to somebody else is an error rather than a
1641 // file this process writes a JIT configuration into.
1642 std::fs::OpenOptions::new()
1643 .read(true)
1644 .write(true)
1645 .create_new(true)
1646 .mode(0o600)
1647 .open(path)
1648 }
1649
1650 pub(super) fn describe_permissions(path: &Path) -> io::Result<(String, bool)> {
1651 let mode = std::fs::metadata(path)?.permissions().mode() & 0o777;
1652 // Any group or other bit at all, not just the read bit: an executable
1653 // or writable bit for another account is not something this file should
1654 // ever carry either.
1655 Ok((format!("mode {mode:04o}"), mode & 0o077 != 0))
1656 }
1657
1658 #[cfg(target_os = "linux")]
1659 pub(super) fn start_token(
1660 pid: u32,
1661 filter: super::LivenessFilter,
1662 ) -> io::Result<Option<String>> {
1663 let stat = match std::fs::read_to_string(format!("/proc/{pid}/stat")) {
1664 Ok(stat) => stat,
1665 Err(error) if error.kind() == io::ErrorKind::NotFound => return Ok(None),
1666 Err(error) => return Err(error),
1667 };
1668
1669 let parsed = super::parse_proc_stat(&stat).ok_or_else(|| {
1670 io::Error::new(
1671 io::ErrorKind::InvalidData,
1672 format!("/proc/{pid}/stat is not in the documented format"),
1673 )
1674 })?;
1675
1676 // `Z` is a process that has exited and is waiting to be reaped. Its PID
1677 // is still taken, but it is not a process that can be adopted or asked
1678 // to do anything.
1679 if parsed.state == "Z" && filter == super::LivenessFilter::LiveOnly {
1680 return Ok(None);
1681 }
1682
1683 Ok(Some(format!("linux:{}:{}", boot_id()?, parsed.start_ticks)))
1684 }
1685
1686 /// An identifier that changes on every boot.
1687 ///
1688 /// Needed because `starttime` counts from boot, so without it a process
1689 /// started 500 ticks after this boot and one started 500 ticks after the
1690 /// previous boot are indistinguishable — which is exactly the confusion a
1691 /// journal read back after a reboot invites.
1692 #[cfg(target_os = "linux")]
1693 fn boot_id() -> io::Result<String> {
1694 // Every kernel since 2.6.19 offers this, and it is world-readable.
1695 if let Ok(id) = std::fs::read_to_string("/proc/sys/kernel/random/boot_id") {
1696 let id = id.trim();
1697 if !id.is_empty() {
1698 return Ok(id.to_string());
1699 }
1700 }
1701
1702 // A container or a hardened kernel may hide it. `btime` in
1703 // `/proc/stat` is the boot wall-clock time in whole seconds and serves
1704 // the same purpose here: it distinguishes boots. It is only ever the
1705 // fallback because two boots within the same second would collide, and
1706 // `boot_id` cannot.
1707 let stat = std::fs::read_to_string("/proc/stat")?;
1708 stat.lines()
1709 .find_map(|line| line.strip_prefix("btime "))
1710 .map(|value| format!("btime-{}", value.trim()))
1711 .ok_or_else(|| {
1712 io::Error::new(
1713 io::ErrorKind::NotFound,
1714 "neither /proc/sys/kernel/random/boot_id nor /proc/stat btime is readable, \
1715 so a process identity that survives a reboot cannot be formed",
1716 )
1717 })
1718 }
1719
1720 #[cfg(target_os = "macos")]
1721 pub(super) fn start_token(
1722 pid: u32,
1723 filter: super::LivenessFilter,
1724 ) -> io::Result<Option<String>> {
1725 // `proc_pidinfo(PROC_PIDTBSDINFO)` rather than `sysctl(KERN_PROC)`:
1726 // libc 0.2 defines `proc_bsdinfo` for Apple targets but not
1727 // `kinfo_proc`, so the sysctl route would mean declaring the struct
1728 // layout by hand — a layout this crate would then own and have to keep
1729 // correct across macOS releases. `proc_pidinfo` gives the same
1730 // microsecond start time through a declared type.
1731 //
1732 // SAFETY: `info` is a correctly sized, zero-initialised `proc_bsdinfo`
1733 // and the size passed matches it, so the kernel writes only within it.
1734 // `proc_pidinfo` reads no memory this program owns other than that
1735 // buffer.
1736 let mut info: libc::proc_bsdinfo = unsafe { std::mem::zeroed() };
1737 let size = i32::try_from(size_of::<libc::proc_bsdinfo>()).unwrap_or(i32::MAX);
1738 let written = unsafe {
1739 libc::proc_pidinfo(
1740 pid as libc::c_int,
1741 libc::PROC_PIDTBSDINFO,
1742 0,
1743 std::ptr::from_mut(&mut info).cast(),
1744 size,
1745 )
1746 };
1747
1748 if written <= 0 {
1749 let error = io::Error::last_os_error();
1750 // See `super::probe_failure_means_gone`, which is where this rule
1751 // lives so that it can be tested on a leg that has no `libc`.
1752 // Only ESRCH is "gone"; EPERM and a zero `errno` are errors.
1753 return if super::probe_failure_means_gone(error.raw_os_error(), libc::ESRCH) {
1754 Ok(None)
1755 } else {
1756 Err(error)
1757 };
1758 }
1759 if written != size {
1760 return Err(io::Error::new(
1761 io::ErrorKind::InvalidData,
1762 format!("proc_pidinfo returned {written} bytes for PID {pid}, expected {size}"),
1763 ));
1764 }
1765
1766 // A zombie still holds its PID but is not a process anything can adopt.
1767 if info.pbi_status == libc::SZOMB && filter == super::LivenessFilter::LiveOnly {
1768 return Ok(None);
1769 }
1770
1771 Ok(Some(format!(
1772 "macos:{}.{:06}",
1773 info.pbi_start_tvsec, info.pbi_start_tvusec
1774 )))
1775 }
1776}
1777
1778// ---------------------------------------------------------------------------
1779// Tests
1780// ---------------------------------------------------------------------------
1781
1782#[cfg(test)]
1783mod tests {
1784 use super::*;
1785
1786 /// A child can be gone before its parent reads its identity, and launching
1787 /// it must still succeed. macOS is where this bites: `proc_pidinfo` answers
1788 /// `ESRCH` for a child that has only just exited, so `IncludeExited` -- which
1789 /// covers a zombie -- never gets a say, and the spawn failed outright.
1790 #[test]
1791 fn a_child_that_is_already_gone_is_still_given_an_identity() {
1792 let identity = ProcessIdentity::of_child(u32::MAX).expect(
1793 "a parent holding the handle must always end up with an identity, even for a child that has already exited",
1794 );
1795
1796 // The sentinel is a claim about nothing, deliberately: there is no
1797 // start instant to read, and inventing one would be a lie that a later
1798 // comparison could believe.
1799 assert_eq!(
1800 identity.classify(None),
1801 Adoption::Gone,
1802 "a PID nobody holds is gone"
1803 );
1804 assert!(
1805 matches!(
1806 identity.classify(Some("macos:1.000000".to_string())),
1807 Adoption::PidRecycled { .. }
1808 ),
1809 "and a PID somebody else has taken is recycled -- which is refused, never signalled"
1810 );
1811 }
1812
1813 /// A program that exits immediately, on every supported platform.
1814 fn quick_exit() -> SpawnSpec {
1815 if cfg!(windows) {
1816 SpawnSpec::new("cmd").args(["/C", "exit", "0"])
1817 } else {
1818 SpawnSpec::new("true")
1819 }
1820 }
1821
1822 /// A program that stays alive until it is stopped.
1823 ///
1824 /// Deliberately a single process on both families rather than a shell
1825 /// wrapping one. Terminating a shell does not terminate the child it
1826 /// spawned, so a `cmd /C …` or `sh -c …` wrapper would leave a stray
1827 /// process behind after every test that stops it — and would make
1828 /// `Adoption::Gone` assertions read as passes for the wrong reason.
1829 ///
1830 /// `ping -n 600 127.0.0.1` sends one loopback echo a second for ten
1831 /// minutes: it needs no console, writes to the null device this spec
1832 /// already sets, and burns no CPU while waiting.
1833 fn long_running() -> SpawnSpec {
1834 if cfg!(windows) {
1835 SpawnSpec::new("ping").args(["-n", "600", "127.0.0.1"])
1836 } else {
1837 SpawnSpec::new("sleep").args(["600"])
1838 }
1839 }
1840
1841 /// The coarsest start-token resolution any supported platform has.
1842 ///
1843 /// Linux's token carries `/proc/<pid>/stat` field 22, which counts
1844 /// `USER_HZ` ticks. `USER_HZ` is 100 on every supported distribution, so
1845 /// one tick is **10 ms** and two processes started inside the same tick get
1846 /// byte-identical start tokens. Windows resolves creation time to 100 ns
1847 /// and macOS to 1 µs, so neither can collide this way.
1848 const COARSEST_START_TOKEN_TICK: Duration = Duration::from_millis(10);
1849
1850 /// Puts a start-token boundary between two spawns.
1851 ///
1852 /// Every "recycled PID" fixture below works by pairing one process's PID
1853 /// with another process's start token. That only *is* a recycled record if
1854 /// the two tokens differ. Spawning back to back is well inside one Linux
1855 /// tick — a `posix_spawn` and two small `/proc` reads — so without this the
1856 /// synthesised record would be the survivor's genuine identity, `recheck`
1857 /// would correctly answer `Live`, and the fixture would fail while the
1858 /// primitive it is testing was working exactly as designed.
1859 ///
1860 /// This is a defect in the fixture and not in the discriminator: recycling
1861 /// a PID for real takes far longer than 10 ms, and `boot_id` changes across
1862 /// a reboot, so no production record can collide this way.
1863 fn separate_start_tokens() {
1864 // Comfortably more than one tick, so a slow or virtualised Linux CI
1865 // runner does not land on the boundary itself.
1866 std::thread::sleep(COARSEST_START_TOKEN_TICK * 5 / 2);
1867 }
1868
1869 /// Fails with a message naming its own cause if two spawns still collided.
1870 ///
1871 /// Without this the collision surfaces as `assert!(!…is_live())` or as a
1872 /// dead survivor, both of which read as "the start token has stopped
1873 /// discriminating" — the opposite of what actually happened.
1874 fn assert_distinguishable(first: &ProcessIdentity, second: &ProcessIdentity) {
1875 assert_ne!(
1876 first.start_token(),
1877 second.start_token(),
1878 "the two children share a start token, so the record synthesised below would be \
1879 the second child's real identity rather than a recycled one. This is the fixture \
1880 colliding inside one start-token tick, not the discriminator failing; lengthen \
1881 `separate_start_tokens` for this platform."
1882 );
1883 }
1884
1885 // -----------------------------------------------------------------------
1886 // The Linux `/proc/<pid>/stat` parser
1887 //
1888 // Deliberately not `#[cfg(target_os = "linux")]`. This is the only Linux
1889 // path in the crate whose correctness is decidable without a Linux kernel,
1890 // and running it on all three legs means a Windows or macOS developer
1891 // breaking it finds out immediately rather than in the Linux leg of CI.
1892 // -----------------------------------------------------------------------
1893
1894 /// A real `/proc/<pid>/stat` line, from a 6.x kernel, truncated after the
1895 /// fields this crate reads. Fields 1 and 2 are the PID and `comm`; field 3
1896 /// is the state; field 22 is `starttime`.
1897 const REAL_STAT: &str = "1234 (bash) S 1200 1234 1234 34816 1234 4194304 3300 5100 0 0 6 5 8 4 20 0 1 0 987654 12345678 900 18446744073709551615";
1898
1899 #[test]
1900 fn the_proc_stat_parser_reads_the_state_and_the_start_time() {
1901 let parsed = parse_proc_stat(REAL_STAT).expect("a well-formed line parses");
1902 assert_eq!(parsed.state, "S");
1903 assert_eq!(
1904 parsed.start_ticks, "987654",
1905 "field 22 is `starttime`; an off-by-one here silently produces a process identity \
1906 that is stable but wrong, which is worse than one that fails"
1907 );
1908 }
1909
1910 #[test]
1911 fn the_proc_stat_parser_survives_a_command_name_containing_spaces_and_parentheses() {
1912 // `procfs(5)` permits this, and a whitespace split of the whole line
1913 // mis-indexes every field after it. The failure would show up only for
1914 // a process whose name was chosen to cause it — that is, only when
1915 // somebody meant to.
1916 let hostile = REAL_STAT.replace("(bash)", "(my prog (v2) :) )");
1917 let parsed = parse_proc_stat(&hostile).expect("a hostile comm still parses");
1918 assert_eq!(parsed.state, "S");
1919 assert_eq!(parsed.start_ticks, "987654");
1920 }
1921
1922 #[test]
1923 fn a_naive_whitespace_split_gets_the_hostile_case_wrong() {
1924 // Shows the previous test is not decorative: the obvious
1925 // implementation, run on the same input, returns a different field.
1926 let hostile = REAL_STAT.replace("(bash)", "(my prog (v2) :) )");
1927 let naive: Vec<&str> = hostile.split_whitespace().collect();
1928 // Field 22 counting from the start of the line, as the naive reading
1929 // would.
1930 let naive_start = naive.get(21).copied();
1931
1932 assert_ne!(
1933 naive_start,
1934 Some(parse_proc_stat(&hostile).expect("parses").start_ticks),
1935 "if these agree, the hostile fixture no longer exercises the hazard and the test \
1936 above proves nothing"
1937 );
1938 }
1939
1940 #[test]
1941 fn the_proc_stat_parser_reports_a_zombie() {
1942 let zombie = REAL_STAT.replacen(") S ", ") Z ", 1);
1943 let parsed = parse_proc_stat(&zombie).expect("parses");
1944 assert_eq!(
1945 parsed.state, "Z",
1946 "a zombie holds its PID but is not adoptable; the caller depends on seeing this"
1947 );
1948 }
1949
1950 #[test]
1951 fn the_proc_stat_parser_rejects_a_truncated_line() {
1952 assert_eq!(parse_proc_stat(""), None);
1953 assert_eq!(parse_proc_stat("1234 (bash)"), None);
1954 assert_eq!(parse_proc_stat("1234 (bash) S 1200"), None);
1955 assert_eq!(
1956 parse_proc_stat("no parenthesis here at all"),
1957 None,
1958 "a line with no comm field must be rejected, not indexed into"
1959 );
1960 }
1961
1962 #[test]
1963 fn the_current_process_has_a_stable_identity() {
1964 let first = ProcessIdentity::of_current_process().expect("this process can see itself");
1965 let second = ProcessIdentity::of_current_process().expect("twice");
1966
1967 assert_eq!(
1968 first, second,
1969 "an identity that changes between two reads of the same live process would make \
1970 every journal record unmatchable"
1971 );
1972 assert_eq!(first.pid(), std::process::id());
1973 assert!(
1974 !first.start_token().is_empty(),
1975 "an empty start token would make the identity a bare PID again"
1976 );
1977 assert_eq!(first.recheck().expect("resolvable"), Adoption::Live);
1978 }
1979
1980 #[test]
1981 fn the_start_token_varies_between_processes() {
1982 // Guards against the degenerate implementation that satisfies every
1983 // other test in this module: a token that is the same constant for
1984 // everything. Such a token would make a recycled PID indistinguishable
1985 // from the original process.
1986 //
1987 // Under cargo-nextest, this test process and its child start so close
1988 // together that they can share the same clock tick on Linux (10ms resolution).
1989 // Sleep for a tick to ensure they have distinct start times.
1990 std::thread::sleep(Duration::from_millis(20));
1991
1992 let mut child = long_running().spawn().expect("the child starts");
1993 let mine = ProcessIdentity::of_current_process().expect("this process can see itself");
1994
1995 assert_ne!(
1996 child.identity().start_token(),
1997 mine.start_token(),
1998 "two different processes must not share a start token"
1999 );
2000
2001 child.stop(Duration::from_secs(5)).expect("the child stops");
2002 }
2003
2004 #[test]
2005 fn a_spawned_child_is_observable_and_terminable() {
2006 let mut child = long_running().spawn().expect("the child starts");
2007
2008 assert!(child.is_running().expect("observable"), "just spawned");
2009 assert_eq!(child.identity().pid(), child.pid());
2010 assert_eq!(
2011 child.identity().recheck().expect("resolvable"),
2012 Adoption::Live,
2013 "a running child must re-resolve to itself"
2014 );
2015 assert_eq!(
2016 child.wait_for(Duration::from_millis(50)).expect("waitable"),
2017 None,
2018 "a long-running child must not be reported as exited"
2019 );
2020
2021 child
2022 .stop(Duration::from_secs(10))
2023 .expect("the child stops");
2024
2025 assert!(!child.is_running().expect("observable"), "after stop");
2026 assert_eq!(
2027 child.identity().recheck().expect("resolvable"),
2028 Adoption::Gone,
2029 "a stopped child's identity must not still resolve as live"
2030 );
2031 }
2032
2033 #[test]
2034 fn a_child_that_exits_on_its_own_is_reported_as_exited() {
2035 let mut child = quick_exit().spawn().expect("the child starts");
2036
2037 let status = child
2038 .wait_for(Duration::from_secs(30))
2039 .expect("waitable")
2040 .expect("a program that exits immediately must be seen to exit");
2041 assert!(status.success(), "{status:?}");
2042 assert!(!child.is_running().expect("observable"));
2043 }
2044
2045 /// The Definition of Done clause this whole module exists for: *"its
2046 /// recorded identity is re-resolvable after a simulated restart and does
2047 /// **not** match a recycled PID belonging to a different process"*.
2048 ///
2049 /// The restart is simulated by round-tripping the identity through JSON —
2050 /// the journal's representation — and dropping every in-memory handle, so
2051 /// the re-resolution has nothing but the serialised record to work from.
2052 /// The recycling is simulated by pairing a *live* process's PID with a
2053 /// *different* process's start token, which is precisely the state a real
2054 /// PID reuse produces.
2055 #[test]
2056 fn a_recorded_identity_survives_a_restart_and_rejects_a_recycled_pid() {
2057 let mut victim = long_running().spawn().expect("the first child starts");
2058 let recorded = victim.identity().clone();
2059
2060 // The journal round trip.
2061 let journalled = serde_json::to_string(&recorded).expect("serialisable");
2062 let recovered: ProcessIdentity = serde_json::from_str(&journalled).expect("readable back");
2063 assert_eq!(recovered, recorded);
2064 assert_eq!(
2065 recovered.recheck().expect("resolvable"),
2066 Adoption::Live,
2067 "a journalled identity whose process is still running must be adoptable; e3's \
2068 restart recovery depends on exactly this"
2069 );
2070
2071 // A second, unrelated process. Its PID is the one the record will be
2072 // made to point at.
2073 separate_start_tokens();
2074 let mut survivor = long_running().spawn().expect("the second child starts");
2075 let survivor_identity = survivor.identity().clone();
2076 assert_ne!(survivor_identity.pid(), recorded.pid());
2077 assert_distinguishable(&recorded, &survivor_identity);
2078
2079 victim
2080 .stop(Duration::from_secs(10))
2081 .expect("the first child stops");
2082
2083 // The record as it would look after PID reuse: the journalled start
2084 // token, now pointing at a PID a different process holds.
2085 let recycled = ProcessIdentity {
2086 pid: survivor_identity.pid(),
2087 start_token: recorded.start_token().to_string(),
2088 };
2089
2090 match recycled.recheck().expect("resolvable") {
2091 Adoption::PidRecycled { current } => {
2092 assert_eq!(
2093 current, survivor_identity,
2094 "the recycled answer must name whoever actually holds the PID"
2095 );
2096 }
2097 other => panic!(
2098 "a recycled PID must not be adopted, and must be distinguishable from a PID \
2099 nobody holds; got {other:?}"
2100 ),
2101 }
2102
2103 survivor
2104 .stop(Duration::from_secs(10))
2105 .expect("the second child stops");
2106 }
2107
2108 /// Only `ESRCH` means the process is gone.
2109 ///
2110 /// Runs on every leg, including the one with no `libc`, because the rule is
2111 /// a function over an `Option<i32>` rather than a `match` buried in a
2112 /// `#[cfg(target_os = "macos")]` body. `ESRCH` is 3 on both Unix platforms,
2113 /// but it is passed in rather than assumed, so this stays true of a
2114 /// platform where it is not.
2115 #[test]
2116 fn only_no_such_process_means_gone() {
2117 const ESRCH: i32 = 3;
2118 const EPERM: i32 = 1;
2119
2120 assert!(probe_failure_means_gone(Some(ESRCH), ESRCH));
2121
2122 // The finding this guards. A zero `errno` was once folded in with
2123 // `ESRCH`, which contradicted the Windows policy on
2124 // `ERROR_ACCESS_DENIED`: an unexplained failure is not evidence that
2125 // the process is gone, and answering `Gone` for one is how an agent
2126 // decides to start a second runner for an attempt that already has one.
2127 assert!(
2128 !probe_failure_means_gone(Some(0), ESRCH),
2129 "a zero errno is an unexplained failure, not an absent process"
2130 );
2131
2132 // A process owned by another account. Reporting this as `Gone` would
2133 // silently un-adopt every runner after a service-account change.
2134 assert!(!probe_failure_means_gone(Some(EPERM), ESRCH));
2135
2136 // No errno at all is not evidence of anything either.
2137 assert!(!probe_failure_means_gone(None, ESRCH));
2138 }
2139
2140 /// The attribute this scan walks, and the lint it looks for inside it.
2141 ///
2142 /// Assembled rather than written out, so that this file contains no
2143 /// literal spelling of the attribute outside the attributes themselves.
2144 /// A text scan reads its own machinery as readily as it reads code: the
2145 /// first version of this test found the attribute quoted in its own
2146 /// documentation and failed, which was a fair demonstration that it
2147 /// detects the shape and a reminder that the needle must not be in the
2148 /// haystack.
2149 const CFG_ATTR: &str = concat!("#[cfg_", "attr(");
2150
2151 /// The lint's own name, which has to appear verbatim in any allowance.
2152 const DEAD_CODE: &str = concat!("dead_", "code");
2153
2154 /// The condition of every `dead_code` allowance in `source` that names a
2155 /// platform rather than the complement of one.
2156 ///
2157 /// Split out from the test below so that it can also be run against a
2158 /// fixture. A scan that finds nothing in this file is worth exactly what
2159 /// its ability to find something is worth, and the only way to establish
2160 /// that is to hand it something it must object to -- the same device
2161 /// `logging.rs` uses to prove its secret-injection scan is capable of
2162 /// failing.
2163 fn positive_dead_code_conditions(source: &str) -> Vec<String> {
2164 // Comment lines go first, for the reason `CFG_ATTR` documents.
2165 let code: String = source
2166 .lines()
2167 .filter(|line| !line.trim_start().starts_with("//"))
2168 .collect::<Vec<_>>()
2169 .join("\n");
2170
2171 let mut offenders = Vec::new();
2172
2173 for block in code.split(CFG_ATTR).skip(1) {
2174 // Walk to the `)` closing the attribute, and remember the first
2175 // comma at depth zero: that is what separates the condition from
2176 // the attributes it applies.
2177 let mut depth = 0usize;
2178 let mut body_end = None;
2179 let mut split_at = None;
2180 for (index, character) in block.char_indices() {
2181 match character {
2182 '(' => depth += 1,
2183 ')' => {
2184 if depth == 0 {
2185 body_end = Some(index);
2186 break;
2187 }
2188 depth -= 1;
2189 }
2190 ',' if depth == 0 && split_at.is_none() => split_at = Some(index),
2191 _ => {}
2192 }
2193 }
2194
2195 let (Some(body_end), Some(split_at)) = (body_end, split_at) else {
2196 continue;
2197 };
2198 if !block[split_at..body_end].contains(DEAD_CODE) {
2199 continue;
2200 }
2201
2202 let condition = block[..split_at].trim();
2203 if !condition.starts_with("not(") {
2204 offenders.push(condition.to_string());
2205 }
2206 }
2207
2208 offenders
2209 }
2210
2211 /// Every `dead_code` allowance in this file must name a *complement*.
2212 ///
2213 /// A lint on the lint, and it exists because the alternative did not work.
2214 /// `probe_failure_means_gone` carried a `dead_code` allowance conditioned
2215 /// on `windows` while its only non-test caller was macOS-only. On Linux the
2216 /// allowance was inactive *and* the caller absent, so the lint fired on
2217 /// the lib target and `cargo clippy --all-targets -- -D warnings` failed --
2218 /// on the one CI leg no Windows developer runs, and invisibly to every
2219 /// local gate.
2220 ///
2221 /// A `dead_code` allowance is a claim about everywhere the caller is *not*,
2222 /// so its condition is naturally a complement: `not(target_os = "…")`. A
2223 /// bare positive names a single platform and says nothing whatsoever about
2224 /// the rest, which is precisely how the wrong one went unnoticed. Requiring
2225 /// the complement form does not prove the condition names the *right*
2226 /// platform, but it does refuse the shape that hid the bug.
2227 ///
2228 /// # No lower bound, and why the vacuity check is a fixture instead
2229 ///
2230 /// This used to end with `checked >= 3`: a lower bound on the number of
2231 /// allowances found. A lower bound cannot tell "the parser stopped
2232 /// matching" from "somebody removed an allowance properly", so it punished
2233 /// the correct remediation. Replacing one of these with a plain
2234 /// `cfg(any(…, test))` -- no allowance at all, which is strictly stronger,
2235 /// because it makes the lint's premise false rather than silencing the
2236 /// report -- left `cargo clippy --all-targets -- -D warnings` clean and
2237 /// this test failing. A tripwire that fires on the better fix teaches
2238 /// people to make the worse one.
2239 ///
2240 /// Counting parsed attributes against occurrences in the text does not fix
2241 /// it either, and that was tried: both counts come from the same needle, so
2242 /// breaking the needle takes both to zero and the check passes. Measured,
2243 /// not reasoned -- the probe that was meant to fail did not.
2244 ///
2245 /// So the vacuity check is
2246 /// [`the_allowance_scan_catches_a_positive_condition`], which runs the same
2247 /// walk over a fixture that must be objected to. It cannot go vacuous,
2248 /// because its input does not depend on what this file happens to contain,
2249 /// and it costs nothing when an allowance is properly removed.
2250 ///
2251 /// # Scope
2252 ///
2253 /// Scoped to this file because it is the only one in the crate that carries
2254 /// a `dead_code` allowance. It is *not* the only one with
2255 /// target-conditional compilation, which is what this used to claim and
2256 /// which was untrue: `paths.rs` and `logging.rs` both carry `#[cfg(unix)]`,
2257 /// and `lock.rs` carries a Windows arm and a Unix arm. Those are a
2258 /// different shape and not the one guarded here -- a `cfg` that selects an
2259 /// implementation is load-bearing, while an `allow(dead_code)` conditioned
2260 /// on one platform is an unexamined claim about all the others. If an
2261 /// allowance ever appears in another file this scan will not see it, and
2262 /// widening it is then the fix.
2263 #[test]
2264 fn every_dead_code_allowance_names_a_complement() {
2265 let offenders = positive_dead_code_conditions(include_str!("process.rs"));
2266 assert!(
2267 offenders.is_empty(),
2268 "a dead_code allowance must name the complement of its caller's \
2269 cfg rather than one platform, or it says nothing about the legs \
2270 it does not name: {offenders:?}"
2271 );
2272 }
2273
2274 /// Proves the scan above is capable of finding something.
2275 ///
2276 /// Without this, "no offending allowance in the file" and "the walk no
2277 /// longer recognises an attribute" are the same passing test. The fixtures
2278 /// are assembled with `concat!` for the reason [`CFG_ATTR`] documents: a
2279 /// literal here would be found by the file scan itself and reported as a
2280 /// defect in the file.
2281 #[test]
2282 fn the_allowance_scan_catches_a_positive_condition() {
2283 let offending = concat!(
2284 "#[cfg_",
2285 "attr(windows, allow(dead_",
2286 "code, reason = \"a reason\"))]\nfn f() {}"
2287 );
2288 assert_eq!(
2289 positive_dead_code_conditions(offending),
2290 vec!["windows".to_string()],
2291 "the walk no longer recognises an allowance, so the scan over this \
2292 file is checking nothing"
2293 );
2294
2295 // The shape this file actually uses is not objected to.
2296 let complement = concat!(
2297 "#[cfg_",
2298 "attr(not(target_os = \"linux\"), allow(dead_",
2299 "code, reason = \"a reason\"))]\nfn f() {}"
2300 );
2301 assert!(positive_dead_code_conditions(complement).is_empty());
2302
2303 // Nor is a `cfg_attr` that allows something other than this lint, at
2304 // any condition: the rule is about claims made on this lint's behalf.
2305 let unrelated = concat!(
2306 "#[cfg_",
2307 "attr(windows, allow(clippy::needless_return))]\nfn f() {}"
2308 );
2309 assert!(positive_dead_code_conditions(unrelated).is_empty());
2310
2311 // A comment is not code. The rule this enforces is quoted in prose
2312 // above, and reading prose as code is how the first version of this
2313 // scan failed.
2314 let commented = concat!(
2315 "// #[cfg_",
2316 "attr(windows, allow(dead_",
2317 "code))]\nfn f() {}"
2318 );
2319 assert!(positive_dead_code_conditions(commented).is_empty());
2320 }
2321
2322 /// The three-way answer, on synthesised tokens, on every platform.
2323 ///
2324 /// The spawn-based tests above cannot cover the case where two identities
2325 /// carry the *same* start token: on Windows and macOS the resolution makes
2326 /// it unreachable, and on Linux it is a 10 ms race rather than something a
2327 /// test can request. That case is exactly what the tick boundary in
2328 /// `separate_start_tokens` is there to avoid, so it is worth pinning down
2329 /// what the discriminator does with it — and pinning it down on the Windows
2330 /// leg, which cannot exhibit the collision any other way.
2331 #[test]
2332 fn identical_start_tokens_are_the_same_process_and_differing_ones_are_not() {
2333 let recorded = ProcessIdentity {
2334 pid: 4312,
2335 start_token: "platform:token-a".to_string(),
2336 };
2337
2338 // The collision. This is the answer that makes a colliding fixture fail
2339 // for the wrong reason: `Live` is *correct* here, because on the
2340 // evidence available the two are the same process.
2341 assert_eq!(
2342 recorded.classify(Some("platform:token-a".to_string())),
2343 Adoption::Live,
2344 "an identical token is the same process; a fixture that spawns twice inside one \
2345 tick is therefore asserting against a correct answer"
2346 );
2347
2348 // A different token at the same PID is the recycled case, and it must
2349 // carry whoever holds the PID now.
2350 assert_eq!(
2351 recorded.classify(Some("platform:token-b".to_string())),
2352 Adoption::PidRecycled {
2353 current: ProcessIdentity {
2354 pid: 4312,
2355 start_token: "platform:token-b".to_string(),
2356 },
2357 }
2358 );
2359
2360 assert_eq!(recorded.classify(None), Adoption::Gone);
2361 assert!(
2362 recorded
2363 .classify(Some("platform:token-a".to_string()))
2364 .is_live()
2365 );
2366 assert!(
2367 !recorded
2368 .classify(Some("platform:token-b".to_string()))
2369 .is_live()
2370 );
2371 assert!(!recorded.classify(None).is_live());
2372 }
2373
2374 /// The Linux token shape is the one that can collide, so assert the
2375 /// collision is a tick-granularity property rather than a boot-id one.
2376 ///
2377 /// Runs everywhere: these are strings, not `/proc` reads.
2378 #[test]
2379 fn two_linux_tokens_collide_only_within_one_tick_of_one_boot() {
2380 let boot = "f81d4fae-7dec-11d0-a765-00a0c91e6bf6";
2381 let at = |ticks: u64| ProcessIdentity {
2382 pid: 4312,
2383 start_token: format!("linux:{boot}:{ticks}"),
2384 };
2385
2386 // Same boot, same tick: indistinguishable. This is the H1 collision,
2387 // reproduced without a Linux kernel.
2388 assert_eq!(
2389 at(884_213).classify(Some(at(884_213).start_token)),
2390 Adoption::Live
2391 );
2392
2393 // One tick apart — 10 ms — is enough to tell them apart, which is why
2394 // `separate_start_tokens` sleeps for longer than one tick.
2395 assert!(
2396 !at(884_213)
2397 .classify(Some(at(884_214).start_token))
2398 .is_live()
2399 );
2400
2401 // The same tick count across a reboot is a different token, which is
2402 // the whole reason the boot id is in there.
2403 let other_boot = ProcessIdentity {
2404 pid: 4312,
2405 start_token: "linux:6ba7b810-9dad-11d1-80b4-00c04fd430c8:884213".to_string(),
2406 };
2407 assert!(!at(884_213).classify(Some(other_boot.start_token)).is_live());
2408 }
2409
2410 /// Shows the previous test is not vacuous.
2411 ///
2412 /// A bare-PID identity — the implementation the task specification calls
2413 /// insufficient — is built here and run through the same comparison. It
2414 /// reports the recycled record as a match, which is the failure the start
2415 /// token exists to prevent. If this test ever stops finding a difference,
2416 /// the start token has stopped discriminating and the test above has become
2417 /// decoration.
2418 #[test]
2419 fn a_bare_pid_would_have_accepted_the_recycled_record() {
2420 let mut victim = long_running().spawn().expect("the first child starts");
2421 let recorded = victim.identity().clone();
2422 separate_start_tokens();
2423 let mut survivor = long_running().spawn().expect("the second child starts");
2424 let survivor_identity = survivor.identity().clone();
2425 assert_distinguishable(&recorded, &survivor_identity);
2426
2427 victim
2428 .stop(Duration::from_secs(10))
2429 .expect("the first child stops");
2430
2431 let recycled = ProcessIdentity {
2432 pid: survivor_identity.pid(),
2433 start_token: recorded.start_token().to_string(),
2434 };
2435
2436 // What a PID-only comparison would conclude.
2437 let bare_pid_says_live = recycled.pid() == survivor_identity.pid();
2438 assert!(
2439 bare_pid_says_live,
2440 "the recycled record must genuinely point at a live process, or the test above is \
2441 not testing recycling at all"
2442 );
2443
2444 // What this module concludes.
2445 assert!(
2446 !recycled.recheck().expect("resolvable").is_live(),
2447 "the start token must reject what a bare PID accepts"
2448 );
2449
2450 survivor
2451 .stop(Duration::from_secs(10))
2452 .expect("the second child stops");
2453 }
2454
2455 #[test]
2456 fn terminating_a_recycled_record_refuses_rather_than_killing_a_stranger() {
2457 let mut victim = long_running().spawn().expect("the first child starts");
2458 let recorded = victim.identity().clone();
2459 separate_start_tokens();
2460 let mut survivor = long_running().spawn().expect("the second child starts");
2461 let survivor_identity = survivor.identity().clone();
2462 // Without this guard a token collision would make the test SIGTERM and
2463 // then SIGKILL the very process it exists to prove is protected, and
2464 // then fail on `survivor.is_running()` — a failure that names the wrong
2465 // cause and has already destroyed its own evidence.
2466 assert_distinguishable(&recorded, &survivor_identity);
2467
2468 victim
2469 .stop(Duration::from_secs(10))
2470 .expect("the first child stops");
2471
2472 let recycled = ProcessIdentity {
2473 pid: survivor_identity.pid(),
2474 start_token: recorded.start_token().to_string(),
2475 };
2476
2477 let outcome = recycled
2478 .terminate(Duration::from_secs(1))
2479 .expect("terminable");
2480 assert_eq!(
2481 outcome,
2482 Termination::RefusedPidRecycled {
2483 current: survivor_identity,
2484 },
2485 "terminating a recycled record must refuse; killing a stranger's process is the \
2486 worst outcome this primitive can produce"
2487 );
2488
2489 assert!(
2490 survivor.is_running().expect("observable"),
2491 "the innocent process must still be running"
2492 );
2493 survivor.stop(Duration::from_secs(10)).expect("cleanup");
2494 }
2495
2496 #[test]
2497 fn terminating_by_identity_stops_a_process_this_agent_did_not_spawn_as_a_child() {
2498 // The post-restart shape: an identity from the journal, no `Child`.
2499 let mut child = long_running().spawn().expect("the child starts");
2500 let identity = child.identity().clone();
2501
2502 assert_eq!(
2503 identity
2504 .terminate(Duration::from_secs(10))
2505 .expect("terminable"),
2506 Termination::Terminated
2507 );
2508
2509 // Reap it so the PID is released; on Unix an unreaped child stays a
2510 // zombie and keeps its PID.
2511 let status = child.wait_for(Duration::from_secs(30)).expect("waitable");
2512 assert!(status.is_some(), "the process must actually have stopped");
2513
2514 assert_eq!(
2515 identity
2516 .terminate(Duration::from_secs(1))
2517 .expect("terminable"),
2518 Termination::AlreadyGone,
2519 "terminating an already-dead identity must be a no-op, not an error: recovery runs \
2520 this on every journal entry"
2521 );
2522 }
2523
2524 #[test]
2525 fn resolving_a_pid_nobody_holds_is_a_distinct_error() {
2526 // PID 0 is the idle/kernel process on Windows and the scheduler on
2527 // Linux; neither is a process this account can adopt, and on macOS
2528 // `proc_pidinfo` reports nothing for it. Using a child's PID after it
2529 // has been reaped is the honest test, so do that instead.
2530 let mut child = quick_exit().spawn().expect("the child starts");
2531 let pid = child.pid();
2532 child.wait().expect("the child exits");
2533
2534 match ProcessIdentity::resolve(pid) {
2535 Err(ProcessError::NoSuchProcess { pid: reported }) => assert_eq!(reported, pid),
2536 // A PID freed moments ago can legitimately be reused by an
2537 // unrelated process on a busy machine. That is not this test's
2538 // failure; it is the very thing the module handles.
2539 Ok(other) => assert_eq!(other.pid(), pid),
2540 Err(other) => panic!("unexpected error: {other}"),
2541 }
2542 }
2543
2544 // -----------------------------------------------------------------------
2545 // Restrictive handoff
2546 // -----------------------------------------------------------------------
2547
2548 /// Stands in for an encoded JIT configuration: long, base64-shaped, and
2549 /// the thing `07-security.md` says must never reach a process listing.
2550 fn jit_payload() -> SecretString {
2551 SecretString::from(
2552 "eyJhZ2VudCI6ICJydW5uZXItbWFuYWdlciIsICJqaXQiOiAidGhpcy1pcy1ub3QtYS1yZWFsLWNvbmZp\
2553 Zy1idXQtaXQtaXMtdGhlLXJpZ2h0LXNoYXBlLWFuZC1sZW5ndGgifQ=="
2554 .to_string(),
2555 )
2556 }
2557
2558 #[test]
2559 fn a_handoff_file_is_unreadable_by_other_local_users() {
2560 let directory = tempfile::tempdir().expect("a temporary directory");
2561 let payload = jit_payload();
2562 let handoff =
2563 RestrictiveHandoff::create(directory.path(), payload).expect("the file is created");
2564
2565 let contents = std::fs::read_to_string(handoff.path()).expect("this account can read it");
2566 assert_eq!(contents, jit_payload().expose_secret());
2567
2568 let permissions = handoff.permissions().expect("inspectable");
2569 assert!(
2570 !permissions.readable_by_other_local_users,
2571 "the JIT handoff is readable by other local accounts: {}",
2572 permissions.description
2573 );
2574 }
2575
2576 #[test]
2577 fn the_permissions_check_catches_a_world_readable_file() {
2578 // Without this, `a_handoff_file_is_unreadable_by_other_local_users`
2579 // could be passing because the check always says "no". Create a file
2580 // the ordinary way — inheriting whatever the directory grants, with no
2581 // restriction applied — and require the check to tell it apart from the
2582 // restrictive one.
2583 let directory = tempfile::tempdir().expect("a temporary directory");
2584
2585 let restrictive = directory.path().join("restrictive");
2586 drop(super::sys::create_restrictive_file(&restrictive).expect("created"));
2587 let restrictive_summary = permissions_summary(&restrictive).expect("inspectable");
2588 assert!(!restrictive_summary.readable_by_other_local_users);
2589
2590 let open = directory.path().join("open");
2591 std::fs::write(&open, b"not a secret").expect("created");
2592 make_world_readable(&open);
2593 let open_summary = permissions_summary(&open).expect("inspectable");
2594
2595 assert!(
2596 open_summary.readable_by_other_local_users,
2597 "a deliberately permissive file was reported as restricted, so the assertion in \
2598 `a_handoff_file_is_unreadable_by_other_local_users` proves nothing. \
2599 restrictive={} permissive={}",
2600 restrictive_summary.description, open_summary.description
2601 );
2602 }
2603
2604 #[cfg(unix)]
2605 fn make_world_readable(path: &Path) {
2606 use std::os::unix::fs::PermissionsExt;
2607 std::fs::set_permissions(path, std::fs::Permissions::from_mode(0o644))
2608 .expect("the mode can be widened");
2609 }
2610
2611 #[cfg(windows)]
2612 fn make_world_readable(path: &Path) {
2613 // `icacls` is part of Windows itself and is the shortest way to put a
2614 // real Everyone ACE on a real file. Test-only: nothing in the product
2615 // ever widens a DACL.
2616 //
2617 // Best effort, and the caller's assertion does not depend on it. A file
2618 // created the ordinary way already inherits the parent directory's
2619 // DACL, which is unprotected — and an unprotected DACL is by itself
2620 // something `dacl_grants_broad_access` must report, because this
2621 // program cannot vouch for what a directory it did not create grants.
2622 let _ = std::process::Command::new("icacls")
2623 .arg(path)
2624 .args(["/grant", "*S-1-1-0:(R)"])
2625 .stdout(std::process::Stdio::null())
2626 .stderr(std::process::Stdio::null())
2627 .status();
2628 }
2629
2630 #[test]
2631 fn a_handoff_file_is_deleted_on_the_success_path() {
2632 let directory = tempfile::tempdir().expect("a temporary directory");
2633 let handoff = RestrictiveHandoff::create(directory.path(), jit_payload()).expect("created");
2634 let path = handoff.path().to_path_buf();
2635 assert!(path.exists());
2636
2637 handoff.delete().expect("deletable");
2638 assert!(!path.exists(), "the handoff outlived its explicit deletion");
2639 }
2640
2641 #[test]
2642 fn a_handoff_file_is_deleted_on_the_failure_path() {
2643 let directory = tempfile::tempdir().expect("a temporary directory");
2644
2645 // A launch that fails after the handoff exists. `?` unwinds through
2646 // `RestrictiveHandoff`'s `Drop`, which is the only thing standing
2647 // between a failed start and a JIT configuration left on disk.
2648 fn launch_and_fail(directory: &Path) -> Result<PathBuf, ProcessError> {
2649 let handoff = RestrictiveHandoff::create(directory, jit_payload())
2650 .expect("the handoff is created");
2651 let path = handoff.path().to_path_buf();
2652 SpawnSpec::new("a-program-that-does-not-exist-anywhere")
2653 .arg(handoff.path())
2654 .spawn_with_handoff(&handoff)?;
2655 Ok(path)
2656 }
2657
2658 let before = std::fs::read_dir(directory.path())
2659 .expect("readable")
2660 .count();
2661 assert_eq!(before, 0, "the temporary directory should start empty");
2662
2663 let error = launch_and_fail(directory.path()).expect_err("the program does not exist");
2664 assert!(matches!(error, ProcessError::Spawn { .. }), "{error}");
2665
2666 let remaining: Vec<PathBuf> = std::fs::read_dir(directory.path())
2667 .expect("readable")
2668 .filter_map(Result::ok)
2669 .map(|entry| entry.path())
2670 .collect();
2671 assert!(
2672 remaining.is_empty(),
2673 "a failed start left the JIT handoff on disk: {remaining:?}"
2674 );
2675 }
2676
2677 #[test]
2678 fn a_handoff_file_is_deleted_when_a_panic_unwinds_past_it() {
2679 let directory = tempfile::tempdir().expect("a temporary directory");
2680 let root = directory.path().to_path_buf();
2681
2682 let panicked = std::panic::catch_unwind(move || {
2683 let _handoff = RestrictiveHandoff::create(&root, jit_payload()).expect("created");
2684 panic!("something went wrong after the handoff was written");
2685 });
2686 assert!(panicked.is_err());
2687
2688 let remaining: Vec<PathBuf> = std::fs::read_dir(directory.path())
2689 .expect("readable")
2690 .filter_map(Result::ok)
2691 .map(|entry| entry.path())
2692 .collect();
2693 assert!(
2694 remaining.is_empty(),
2695 "a panic left the JIT handoff on disk: {remaining:?}"
2696 );
2697 }
2698
2699 #[test]
2700 fn spawning_refuses_to_put_the_payload_in_an_argument() {
2701 let directory = tempfile::tempdir().expect("a temporary directory");
2702 let handoff = RestrictiveHandoff::create(directory.path(), jit_payload()).expect("created");
2703
2704 // The mistake `07-security.md`'s threat table names: the configuration
2705 // itself on the command line, where every local account's process
2706 // listing shows it.
2707 let spec = long_running()
2708 .arg("--jit-config")
2709 .arg(jit_payload().expose_secret());
2710
2711 let error = spec
2712 .spawn_with_handoff(&handoff)
2713 .expect_err("the payload must never reach a command line");
2714 match error {
2715 ProcessError::SecretInCommandLine { location, .. } => {
2716 assert!(location.starts_with("argument"), "{location}");
2717 }
2718 other => panic!("expected a refusal, got {other}"),
2719 }
2720 }
2721
2722 #[test]
2723 fn spawning_refuses_to_put_the_payload_in_the_environment() {
2724 let directory = tempfile::tempdir().expect("a temporary directory");
2725 let handoff = RestrictiveHandoff::create(directory.path(), jit_payload()).expect("created");
2726
2727 let spec = long_running().env("ACTIONS_RUNNER_JITCONFIG", jit_payload().expose_secret());
2728
2729 let error = spec
2730 .spawn_with_handoff(&handoff)
2731 .expect_err("the payload must not be inherited through the environment either");
2732 match error {
2733 ProcessError::SecretInCommandLine { location, .. } => {
2734 assert!(location.contains("ACTIONS_RUNNER_JITCONFIG"), "{location}");
2735 }
2736 other => panic!("expected a refusal, got {other}"),
2737 }
2738 }
2739
2740 #[test]
2741 fn runner_handoff_injects_the_supported_secret_input_without_an_argument() {
2742 let directory = tempfile::tempdir().expect("a temporary directory");
2743 let payload = jit_payload();
2744 let payload_length = payload.expose_secret().len();
2745 let handoff = RestrictiveHandoff::create(directory.path(), payload).expect("created");
2746 let spec = runner_jit_input_probe(payload_length);
2747
2748 let rendered: Vec<String> = spec
2749 .arguments()
2750 .iter()
2751 .map(|argument| argument.to_string_lossy().into_owned())
2752 .collect();
2753 assert!(
2754 rendered
2755 .iter()
2756 .all(|argument| !argument.contains(jit_payload().expose_secret())),
2757 "the JIT payload reached the command line: {rendered:?}"
2758 );
2759 assert!(
2760 rendered
2761 .iter()
2762 .all(|argument| argument != "--jit-config-file"),
2763 "the obsolete listener option returned: {rendered:?}"
2764 );
2765
2766 let mut child = spec
2767 .spawn_runner_with_handoff(&handoff)
2768 .expect("the probe starts");
2769 handoff
2770 .delete()
2771 .expect("the handoff is deleted immediately");
2772 let status = child.wait().expect("the probe exits");
2773 assert!(
2774 status.success(),
2775 "the child did not receive the complete {RUNNER_JIT_CONFIG_ENV} input: {status}"
2776 );
2777 }
2778
2779 #[cfg(windows)]
2780 fn runner_jit_input_probe(expected_length: usize) -> SpawnSpec {
2781 SpawnSpec::new("powershell.exe").args([
2782 "-NoProfile".into(),
2783 "-NonInteractive".into(),
2784 "-Command".into(),
2785 format!(
2786 "$value = [Environment]::GetEnvironmentVariable('{RUNNER_JIT_CONFIG_ENV}'); \
2787 if ($null -eq $value -or $value.Length -ne {expected_length}) {{ exit 41 }}"
2788 ),
2789 ])
2790 }
2791
2792 #[cfg(unix)]
2793 fn runner_jit_input_probe(expected_length: usize) -> SpawnSpec {
2794 SpawnSpec::new("/bin/sh").args([
2795 "-c".to_owned(),
2796 format!("test \"${{#{RUNNER_JIT_CONFIG_ENV}}}\" -eq \"{expected_length}\""),
2797 ])
2798 }
2799
2800 #[test]
2801 fn spawning_allows_the_handoff_path_itself() {
2802 let directory = tempfile::tempdir().expect("a temporary directory");
2803 let handoff = RestrictiveHandoff::create(directory.path(), jit_payload()).expect("created");
2804
2805 let spec = long_running().arg("--jit-config-file").arg(handoff.path());
2806 let mut child = spec
2807 .spawn_with_handoff(&handoff)
2808 .expect("passing the path is the supported handoff");
2809
2810 // What a process listing would show: the path, and nothing that
2811 // contains the payload.
2812 let rendered: Vec<String> = spec
2813 .arguments()
2814 .iter()
2815 .map(|arg| arg.to_string_lossy().into_owned())
2816 .collect();
2817 let payload = jit_payload();
2818 assert!(
2819 rendered
2820 .iter()
2821 .all(|arg| !arg.contains(payload.expose_secret())),
2822 "the payload reached the argument vector: {rendered:?}"
2823 );
2824 assert!(
2825 rendered
2826 .iter()
2827 .any(|arg| arg == &handoff.path().display().to_string()),
2828 "the handoff path should be there: {rendered:?}"
2829 );
2830
2831 child.stop(Duration::from_secs(10)).expect("cleanup");
2832 }
2833
2834 #[test]
2835 fn the_handoff_path_is_unique_per_handoff() {
2836 let directory = tempfile::tempdir().expect("a temporary directory");
2837 let first = RestrictiveHandoff::create(directory.path(), jit_payload()).expect("created");
2838 let second = RestrictiveHandoff::create(directory.path(), jit_payload()).expect("created");
2839
2840 assert_ne!(
2841 first.path(),
2842 second.path(),
2843 "two concurrent attempts must not share a handoff file"
2844 );
2845 }
2846
2847 #[test]
2848 fn the_payload_has_no_debug_or_display_that_reveals_it() {
2849 // The structural half of the control: even a careless
2850 // `format!("{:?}", …)` in a later task cannot print the configuration.
2851 let payload = jit_payload();
2852 let rendered = format!("{payload:?}");
2853 assert!(
2854 !rendered.contains(payload.expose_secret()),
2855 "SecretString's Debug leaked the payload: {rendered}"
2856 );
2857
2858 let directory = tempfile::tempdir().expect("a temporary directory");
2859 let handoff = RestrictiveHandoff::create(directory.path(), jit_payload()).expect("created");
2860 let rendered = format!("{handoff:?}");
2861 assert!(
2862 !rendered.contains(jit_payload().expose_secret()),
2863 "RestrictiveHandoff's Debug leaked the payload: {rendered}"
2864 );
2865 }
2866}