1use std::collections::BTreeMap;
91use std::ffi::OsString;
92use std::fmt;
93use std::path::{Path, PathBuf};
94use std::time::Duration;
95
96use chrono::{DateTime, Utc};
97use runner_manager_domain::model::StartMode;
98use runner_manager_domain::path::LocalAbsolutePath;
99use serde::{Deserialize, Serialize};
100
101use crate::lock::{HostLock, LockError, LockKind};
102use crate::paths::AppPaths;
103#[cfg(windows)]
104use crate::runner_root_access::RootAdmission;
105use crate::runner_root_access::{
106 Reversal, RootAccessChange, RootAccessError, RootAccessReport, RootAccessSummary,
107};
108
109pub const SERVICE_NAME: &str = "runner-manager";
115pub const WINDOWS_SCM_HOST_ARGUMENT: &str = "--windows-service-host";
121
122pub const DISPLAY_NAME: &str = "GitHub Actions Runner Manager";
125
126pub const DESCRIPTION: &str =
128 "Starts ephemeral GitHub Actions self-hosted runners on this machine on demand.";
129
130pub const DAEMON_ARGUMENTS: [&str; 2] = ["daemon", "run"];
136
137pub const RECORD_FILE: &str = "service.toml";
145
146pub const CONTACT_FILE: &str = "github-contact.toml";
152
153pub const ROOT_REFUSAL_FILE: &str = "runner-root-refusal.toml";
157
158pub const LOG_FILE_STEM: &str = crate::logging::SERVICE_LOG_STEM;
169
170#[derive(Debug, Clone, PartialEq, Eq)]
183pub struct ServiceIdentity {
184 name: String,
185 display_name: String,
186 description: String,
187}
188
189impl ServiceIdentity {
190 #[must_use]
192 pub fn product() -> Self {
193 Self {
194 name: SERVICE_NAME.to_string(),
195 display_name: DISPLAY_NAME.to_string(),
196 description: DESCRIPTION.to_string(),
197 }
198 }
199
200 #[must_use]
207 pub fn fixture(tag: &str) -> Self {
208 let tag: String = tag
209 .chars()
210 .map(|c| {
211 if c.is_ascii_alphanumeric() {
212 c.to_ascii_lowercase()
213 } else {
214 '-'
215 }
216 })
217 .collect();
218 let name = format!("{SERVICE_NAME}-selftest-{tag}");
219 Self {
220 display_name: format!("{DISPLAY_NAME} (self-test fixture {tag})"),
221 description: "Disposable fixture created by runner-manager's own installer tests. \
222 Safe to remove."
223 .to_string(),
224 name,
225 }
226 }
227
228 #[must_use]
233 pub fn is_fixture(&self) -> bool {
234 self.name.starts_with(&format!("{SERVICE_NAME}-selftest-"))
235 }
236
237 #[must_use]
240 pub fn name(&self) -> &str {
241 &self.name
242 }
243
244 #[must_use]
246 pub fn display_name(&self) -> &str {
247 &self.display_name
248 }
249
250 #[must_use]
252 pub fn description(&self) -> &str {
253 &self.description
254 }
255
256 #[must_use]
262 pub fn launchd_label(&self) -> String {
263 format!(
264 "{}.{}.{}",
265 crate::paths::QUALIFIER,
266 crate::paths::ORGANIZATION,
267 self.name
268 )
269 }
270
271 #[must_use]
273 pub fn systemd_unit(&self) -> String {
274 format!("{}.service", self.name)
275 }
276}
277
278impl fmt::Display for ServiceIdentity {
279 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
280 f.write_str(&self.name)
281 }
282}
283
284#[derive(Debug, Clone, Copy, PartialEq, Eq)]
298pub struct RestartPolicy {
299 delay: Duration,
300 reset_after: Duration,
301}
302
303impl RestartPolicy {
304 pub const MIN_DELAY: Duration = Duration::from_secs(1);
311
312 pub const MAX_DELAY: Duration = Duration::from_secs(300);
315
316 pub const DEFAULT_DELAY: Duration = Duration::from_secs(15);
318
319 pub const DEFAULT_RESET_AFTER: Duration = Duration::from_secs(600);
321
322 pub fn new(delay: Duration, reset_after: Duration) -> Result<Self, ServiceError> {
330 if delay < Self::MIN_DELAY || delay > Self::MAX_DELAY {
331 return Err(ServiceError::RestartDelay {
332 requested_secs: delay.as_secs(),
333 min_secs: Self::MIN_DELAY.as_secs(),
334 max_secs: Self::MAX_DELAY.as_secs(),
335 });
336 }
337 if reset_after <= delay {
338 return Err(ServiceError::RestartResetWindow {
339 reset_secs: reset_after.as_secs(),
340 delay_secs: delay.as_secs(),
341 });
342 }
343 Ok(Self { delay, reset_after })
344 }
345
346 #[must_use]
348 pub const fn delay(&self) -> Duration {
349 self.delay
350 }
351
352 #[must_use]
354 pub const fn reset_after(&self) -> Duration {
355 self.reset_after
356 }
357
358 #[must_use]
375 pub const fn effective_delay(&self, kind: DefinitionKind) -> Duration {
376 match kind {
377 DefinitionKind::WindowsScheduledTask => {
378 let seconds = self.delay.as_secs();
379 let minutes = seconds.div_ceil(60);
380 Duration::from_secs(if minutes == 0 { 60 } else { minutes * 60 })
381 }
382 _ => self.delay,
383 }
384 }
385}
386
387impl Default for RestartPolicy {
388 fn default() -> Self {
389 Self {
390 delay: Self::DEFAULT_DELAY,
391 reset_after: Self::DEFAULT_RESET_AFTER,
392 }
393 }
394}
395
396impl fmt::Display for RestartPolicy {
397 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
398 write!(
399 f,
400 "restart after {}s, failure count resets after {}s",
401 self.delay.as_secs(),
402 self.reset_after.as_secs()
403 )
404 }
405}
406
407#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
418#[serde(rename_all = "snake_case")]
419pub enum ServiceAccount {
420 LocalSystem,
423 Root,
426 InvokingUser,
428}
429
430impl ServiceAccount {
431 #[must_use]
440 pub const fn for_definition(kind: DefinitionKind, mode: StartMode) -> Self {
441 match (kind, mode) {
442 (DefinitionKind::WindowsService, _) => Self::LocalSystem,
443 (DefinitionKind::WindowsScheduledTask, _) | (_, StartMode::Login) => Self::InvokingUser,
444 (_, StartMode::Boot) => Self::Root,
445 }
446 }
447
448 #[must_use]
451 pub const fn for_start_mode(mode: StartMode) -> Self {
452 Self::for_definition(host_definition_kind(mode), mode)
453 }
454
455 #[must_use]
457 pub const fn as_str(&self) -> &'static str {
458 match self {
459 Self::LocalSystem => "NT AUTHORITY\\SYSTEM",
460 Self::Root => "root",
461 Self::InvokingUser => "the invoking user",
462 }
463 }
464
465 #[must_use]
472 pub const fn justification(&self) -> &'static str {
473 match self {
474 Self::LocalSystem => {
475 "the machine-scoped store's DACL names SY, BA and OW only; LocalService and \
476 NetworkService cannot read it, and widening the DACL to reach them would grant \
477 every service on this host read access to the one credential this product holds"
478 }
479 Self::Root => {
480 "a boot-time registration runs outside every login session: on macOS the System \
481 Keychain is unlocked by /var/db/SystemKey, which is root-only, and on Linux the \
482 machine-scoped store is a 0600 file under /var/lib that only root can open \
483 before a session exists"
484 }
485 Self::InvokingUser => {
486 "a login-mode registration reads the user-scoped store, which is deliberately \
487 readable by exactly one account and needs no elevation at all"
488 }
489 }
490 }
491
492 #[must_use]
494 pub const fn needs_elevation(&self) -> bool {
495 matches!(self, Self::LocalSystem | Self::Root)
496 }
497}
498
499impl fmt::Display for ServiceAccount {
500 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
501 f.write_str(self.as_str())
502 }
503}
504
505#[derive(Debug, thiserror::Error)]
516pub enum ServiceError {
517 #[error("cannot install the service while an agent is already running on this host: {source}")]
523 LockHeld {
524 #[source]
526 source: Box<LockError>,
527 },
528
529 #[error(
532 "cannot tell whether an agent is already running on this host, so the service was not \
533 installed: {source}. Fix the reported problem with the state directory and try again."
534 )]
535 LockUnreadable {
536 #[source]
538 source: Box<LockError>,
539 },
540
541 #[error(
549 "this registration would run jobs under the default runner root, and that root could \
550 not be prepared, so nothing was registered: {source}"
551 )]
552 RunnerRoot {
553 #[source]
555 source: Box<RootAccessError>,
556 },
557
558 #[error(
560 "cannot resolve the absolute path of this executable, so there is nothing to register: \
561 {detail}. Run the installer from the installed binary rather than through a shell \
562 function or a wrapper that replaces argv[0]."
563 )]
564 BinaryPath {
565 detail: String,
567 },
568
569 #[error(
571 "{} is not a file, so registering it would create a service that cannot start. Install \
572 the product first, then run `service install` from the installed binary.",
573 path.display()
574 )]
575 BinaryMissing {
576 path: PathBuf,
578 },
579
580 #[error(
582 "a restart delay of {requested_secs}s is outside the supported range \
583 {min_secs}s-{max_secs}s. Below the floor the platform's own throttle overrides the \
584 value, so `service status` would report a delay that is not the one in force."
585 )]
586 RestartDelay {
587 requested_secs: u64,
589 min_secs: u64,
591 max_secs: u64,
593 },
594
595 #[error(
597 "a failure-count reset window of {reset_secs}s is not longer than the {delay_secs}s \
598 restart delay, so the count would reset between every pair of restarts and no \
599 start limit could ever apply."
600 )]
601 RestartResetWindow {
602 reset_secs: u64,
604 delay_secs: u64,
606 },
607
608 #[error(
614 "{name} is already registered to start at {existing}, and this asks for {requested}. \
615 Changing the start mode moves the registration between two different service \
616 managers, so it is not something an install does by itself: run `service uninstall` \
617 first, or change the start mode in the terminal UI (`runner-manager tui`), which \
618 switches it in place and keeps the registration running throughout."
619 )]
620 AlreadyInstalled {
621 name: String,
623 existing: StartMode,
625 requested: StartMode,
627 },
628
629 #[error("{name} is not registered on this host, so there is nothing to {operation}.")]
631 NotInstalled {
632 name: String,
634 operation: &'static str,
636 },
637
638 #[error("cannot {operation} the service record {}: {detail}", path.display())]
640 Record {
641 operation: &'static str,
643 path: PathBuf,
645 detail: String,
647 },
648
649 #[error(
651 "the service record {} was not written by this product, or was written by a version \
652 this one cannot read: {detail}. Run `service uninstall` and `service install` again; \
653 neither touches configuration, secrets, or the cache.",
654 path.display()
655 )]
656 RecordUnreadable {
657 path: PathBuf,
659 detail: String,
661 },
662
663 #[error(
677 "the service record {} is there and this account may not read it: {detail}. It was \
678 written by whichever account installed the service -- on a boot-mode host, `sudo \
679 service install`. Running `service install` again rewrites it readable; until then \
680 only what the service manager itself reports is available.",
681 path.display()
682 )]
683 RecordNotPermitted {
684 path: PathBuf,
686 detail: String,
688 },
689
690 #[error("cannot prepare this host's application-data directories: {source}")]
692 Paths {
693 #[source]
695 source: Box<crate::paths::PathsError>,
696 },
697
698 #[error("cannot {operation} {name} through {manager}: {detail}")]
700 Control {
701 operation: &'static str,
703 name: String,
705 manager: &'static str,
707 detail: String,
709 },
710
711 #[error(
713 "cannot {operation} {name}: {cause}. The attempted rollback also failed: {rollback}. \
714 Inspect `service status` before retrying."
715 )]
716 Rollback {
717 operation: &'static str,
719 name: String,
721 cause: String,
723 rollback: String,
725 },
726
727 #[error("{operation} {name} needs administrative rights: {detail}. {remedy}")]
729 NeedsElevation {
730 operation: &'static str,
732 name: String,
734 detail: String,
736 remedy: &'static str,
738 },
739}
740
741#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
753pub struct ServiceDirectories {
754 pub config: PathBuf,
756 pub state: PathBuf,
758 pub runtime: PathBuf,
760 pub logs: PathBuf,
762}
763
764impl ServiceDirectories {
765 #[must_use]
767 pub fn of(paths: &AppPaths) -> Self {
768 Self {
769 config: paths.config_dir().to_path_buf(),
770 state: paths.state_dir().to_path_buf(),
771 runtime: paths.runtime_dir().to_path_buf(),
772 logs: paths.logs_dir().to_path_buf(),
773 }
774 }
775
776 #[must_use]
778 pub fn all(&self) -> [&Path; 4] {
779 [
780 self.config.as_path(),
781 self.state.as_path(),
782 self.runtime.as_path(),
783 self.logs.as_path(),
784 ]
785 }
786
787 #[must_use]
790 pub fn log_file(&self) -> PathBuf {
791 self.logs.join(LOG_FILE_STEM)
792 }
793}
794
795#[derive(Debug, Clone, PartialEq, Eq)]
807pub struct InstallRequest {
808 start_mode: StartMode,
809 binary: Option<PathBuf>,
810 source_binary: Option<PathBuf>,
811 arguments: Vec<OsString>,
812 restart: RestartPolicy,
813 on_demand: bool,
814}
815
816impl InstallRequest {
817 #[must_use]
819 pub fn new(start_mode: StartMode) -> Self {
820 Self {
821 start_mode,
822 binary: None,
823 source_binary: None,
824 arguments: DAEMON_ARGUMENTS.iter().map(OsString::from).collect(),
825 restart: RestartPolicy::default(),
826 on_demand: false,
827 }
828 }
829
830 #[must_use]
840 pub const fn started_on_demand(mut self) -> Self {
841 self.on_demand = true;
842 self
843 }
844
845 #[must_use]
852 pub fn for_binary(mut self, binary: impl Into<PathBuf>) -> Self {
853 self.binary = Some(binary.into());
854 self
855 }
856
857 #[must_use]
874 pub fn copied_from(mut self, source: impl Into<PathBuf>) -> Self {
875 self.source_binary = Some(source.into());
876 self
877 }
878
879 #[must_use]
881 pub fn with_arguments<I, S>(mut self, arguments: I) -> Self
882 where
883 I: IntoIterator<Item = S>,
884 S: Into<OsString>,
885 {
886 self.arguments = arguments.into_iter().map(Into::into).collect();
887 self
888 }
889
890 #[must_use]
893 pub const fn with_restart(mut self, restart: RestartPolicy) -> Self {
894 self.restart = restart;
895 self
896 }
897
898 #[must_use]
900 pub const fn start_mode(&self) -> StartMode {
901 self.start_mode
902 }
903}
904
905#[derive(Debug, Clone, PartialEq, Eq)]
912pub struct InstallPlan {
913 identity: ServiceIdentity,
914 start_mode: StartMode,
915 binary: PathBuf,
916 source_binary: Option<PathBuf>,
917 arguments: Vec<OsString>,
918 account: ServiceAccount,
919 restart: RestartPolicy,
920 directories: ServiceDirectories,
921 secret_guard: Option<PathBuf>,
922 on_demand: bool,
923}
924
925impl InstallPlan {
926 pub fn resolve(
934 identity: ServiceIdentity,
935 request: &InstallRequest,
936 directories: ServiceDirectories,
937 ) -> Result<Self, ServiceError> {
938 let binary = match &request.binary {
939 Some(named) => absolute(named)?,
940 None => running_executable()?,
941 };
942 if !binary.is_file() {
943 return Err(ServiceError::BinaryMissing { path: binary });
944 }
945 let secret_guard = crate::secrets::PlatformSecretStore::for_start_mode(request.start_mode)
950 .ok()
951 .map(|store| store.guard());
952 Ok(Self {
953 identity,
954 start_mode: request.start_mode,
955 binary,
956 source_binary: request.source_binary.clone(),
957 arguments: request.arguments.clone(),
958 account: ServiceAccount::for_start_mode(request.start_mode),
959 restart: request.restart,
960 directories,
961 secret_guard,
962 on_demand: request.on_demand,
963 })
964 }
965
966 #[must_use]
973 pub fn unchecked(
974 identity: ServiceIdentity,
975 start_mode: StartMode,
976 binary: impl Into<PathBuf>,
977 directories: ServiceDirectories,
978 ) -> Self {
979 Self {
980 identity,
981 start_mode,
982 binary: binary.into(),
983 source_binary: None,
984 arguments: DAEMON_ARGUMENTS.iter().map(OsString::from).collect(),
985 account: ServiceAccount::for_start_mode(start_mode),
986 restart: RestartPolicy::default(),
987 directories,
988 secret_guard: None,
989 on_demand: false,
990 }
991 }
992
993 #[must_use]
996 pub const fn started_on_demand(mut self) -> Self {
997 self.on_demand = true;
998 self
999 }
1000
1001 #[must_use]
1003 pub const fn is_on_demand(&self) -> bool {
1004 self.on_demand
1005 }
1006
1007 #[must_use]
1014 pub fn with_secret_guard(mut self, guard: impl Into<PathBuf>) -> Self {
1015 self.secret_guard = Some(guard.into());
1016 self
1017 }
1018
1019 #[must_use]
1021 pub fn secret_guard(&self) -> Option<&Path> {
1022 self.secret_guard.as_deref()
1023 }
1024
1025 #[must_use]
1027 pub const fn with_restart(mut self, restart: RestartPolicy) -> Self {
1028 self.restart = restart;
1029 self
1030 }
1031
1032 #[must_use]
1034 pub fn with_arguments<I, S>(mut self, arguments: I) -> Self
1035 where
1036 I: IntoIterator<Item = S>,
1037 S: Into<OsString>,
1038 {
1039 self.arguments = arguments.into_iter().map(Into::into).collect();
1040 self
1041 }
1042
1043 #[must_use]
1045 pub const fn identity(&self) -> &ServiceIdentity {
1046 &self.identity
1047 }
1048
1049 #[must_use]
1051 pub const fn start_mode(&self) -> StartMode {
1052 self.start_mode
1053 }
1054
1055 #[must_use]
1057 pub fn binary(&self) -> &Path {
1058 &self.binary
1059 }
1060
1061 #[must_use]
1067 pub fn source_binary(&self) -> Option<&Path> {
1068 self.source_binary.as_deref()
1069 }
1070
1071 #[must_use]
1073 pub fn arguments(&self) -> &[OsString] {
1074 &self.arguments
1075 }
1076
1077 #[must_use]
1079 pub const fn account(&self) -> &ServiceAccount {
1080 &self.account
1081 }
1082
1083 #[must_use]
1085 pub const fn restart(&self) -> RestartPolicy {
1086 self.restart
1087 }
1088
1089 #[must_use]
1091 pub const fn directories(&self) -> &ServiceDirectories {
1092 &self.directories
1093 }
1094
1095 #[must_use]
1097 pub fn command_line(&self) -> String {
1098 let mut out = quote_argument(&self.binary.to_string_lossy());
1099 for argument in &self.arguments {
1100 out.push(' ');
1101 out.push_str("e_argument(&argument.to_string_lossy()));
1102 }
1103 out
1104 }
1105}
1106
1107fn retained_runner_root(change: &RootAccessChange) -> Option<String> {
1115 let reversal = change.revert();
1116 matches!(reversal, Reversal::Retained { .. }).then(|| reversal.to_string())
1117}
1118
1119fn rolled_back<T>(
1132 retained: Option<String>,
1133 rollback: Result<T, ServiceError>,
1134 operation: &'static str,
1135 identity: &ServiceIdentity,
1136 cause: ServiceError,
1137) -> ServiceError {
1138 let left_behind = match (rollback.err(), retained) {
1139 (Some(rollback), Some(retained)) => Some(format!("{rollback}; {retained}")),
1140 (Some(rollback), None) => Some(rollback.to_string()),
1141 (None, retained) => retained,
1142 };
1143 match left_behind {
1144 Some(rollback) => ServiceError::Rollback {
1145 operation,
1146 name: identity.name().to_string(),
1147 cause: cause.to_string(),
1148 rollback,
1149 },
1150 None => cause,
1151 }
1152}
1153
1154fn undo_runner_root(
1157 change: &RootAccessChange,
1158 operation: &'static str,
1159 identity: &ServiceIdentity,
1160 cause: ServiceError,
1161) -> ServiceError {
1162 rolled_back(
1163 retained_runner_root(change),
1164 Ok(()),
1165 operation,
1166 identity,
1167 cause,
1168 )
1169}
1170
1171fn absolute(path: &Path) -> Result<PathBuf, ServiceError> {
1185 std::path::absolute(path).map_err(|error| ServiceError::BinaryPath {
1186 detail: format!("{} could not be made absolute: {error}", path.display()),
1187 })
1188}
1189
1190fn running_executable() -> Result<PathBuf, ServiceError> {
1192 let raw = std::env::current_exe().map_err(|error| ServiceError::BinaryPath {
1193 detail: error.to_string(),
1194 })?;
1195 absolute(&raw)
1196}
1197
1198pub(crate) fn quote_argument(argument: &str) -> String {
1207 if !argument.is_empty() && !argument.contains([' ', '"', '\t', '\n']) {
1208 return argument.to_string();
1209 }
1210 let mut out = String::with_capacity(argument.len() + 2);
1211 out.push('"');
1212 let mut backslashes = 0usize;
1213 for c in argument.chars() {
1214 match c {
1215 '\\' => {
1216 backslashes += 1;
1217 out.push('\\');
1218 }
1219 '"' => {
1220 for _ in 0..=backslashes {
1223 out.push('\\');
1224 }
1225 out.push('"');
1226 backslashes = 0;
1227 }
1228 other => {
1229 backslashes = 0;
1230 out.push(other);
1231 }
1232 }
1233 }
1234 for _ in 0..backslashes {
1236 out.push('\\');
1237 }
1238 out.push('"');
1239 out
1240}
1241
1242#[must_use]
1253pub fn executable_from_command_line(command_line: &str) -> Option<PathBuf> {
1254 let trimmed = command_line.trim_start();
1255 if trimmed.is_empty() {
1256 return None;
1257 }
1258 let mut out = String::new();
1259 let mut chars = trimmed.chars().peekable();
1260 let quoted = chars.peek() == Some(&'"');
1261 if quoted {
1262 chars.next();
1263 let mut backslashes = 0usize;
1264 for c in chars {
1265 match c {
1266 '\\' => {
1267 backslashes += 1;
1268 }
1269 '"' => {
1270 out.extend(std::iter::repeat_n('\\', backslashes / 2));
1273 if backslashes.is_multiple_of(2) {
1274 break;
1275 }
1276 backslashes = 0;
1277 out.push('"');
1278 }
1279 other => {
1280 out.extend(std::iter::repeat_n('\\', backslashes));
1281 backslashes = 0;
1282 out.push(other);
1283 }
1284 }
1285 }
1286 } else {
1287 for c in chars {
1288 if c == ' ' || c == '\t' {
1289 break;
1290 }
1291 out.push(c);
1292 }
1293 }
1294 if out.is_empty() {
1295 None
1296 } else {
1297 Some(PathBuf::from(out))
1298 }
1299}
1300
1301#[derive(Debug, Clone, Copy, PartialEq, Eq)]
1307pub enum DefinitionKind {
1308 WindowsService,
1312 WindowsScheduledTask,
1314 LaunchdPlist,
1316 SystemdUnit,
1318}
1319
1320impl DefinitionKind {
1321 #[must_use]
1323 pub const fn manager(self) -> &'static str {
1324 match self {
1325 Self::WindowsService => "the Windows Service Control Manager",
1326 Self::WindowsScheduledTask => "Windows Task Scheduler",
1327 Self::LaunchdPlist => "launchd",
1328 Self::SystemdUnit => "systemd",
1329 }
1330 }
1331}
1332
1333impl fmt::Display for DefinitionKind {
1334 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
1335 f.write_str(self.manager())
1336 }
1337}
1338
1339#[derive(Debug, Clone, PartialEq, Eq)]
1346pub struct ServiceDefinition {
1347 kind: DefinitionKind,
1348 text: String,
1349 install_path: Option<PathBuf>,
1350}
1351
1352impl ServiceDefinition {
1353 #[must_use]
1355 pub const fn kind(&self) -> DefinitionKind {
1356 self.kind
1357 }
1358
1359 #[must_use]
1361 pub fn text(&self) -> &str {
1362 &self.text
1363 }
1364
1365 #[must_use]
1372 pub fn install_path(&self) -> Option<&Path> {
1373 self.install_path.as_deref()
1374 }
1375
1376 pub fn for_host(plan: &InstallPlan) -> Result<Self, ServiceError> {
1389 Ok(match host_definition_kind(plan.start_mode()) {
1390 DefinitionKind::WindowsService => Self::windows_service(plan),
1391 DefinitionKind::WindowsScheduledTask => {
1392 Self::windows_scheduled_task(plan, &TaskPrincipal::current()?)
1393 }
1394 DefinitionKind::LaunchdPlist => Self::launchd(plan, host_home().as_deref()),
1395 DefinitionKind::SystemdUnit => Self::systemd(plan, host_home().as_deref()),
1396 })
1397 }
1398
1399 #[must_use]
1401 pub fn windows_service(plan: &InstallPlan) -> Self {
1402 Self {
1403 kind: DefinitionKind::WindowsService,
1404 text: windows_service_descriptor(plan),
1405 install_path: None,
1406 }
1407 }
1408
1409 #[must_use]
1411 pub fn windows_scheduled_task(plan: &InstallPlan, principal: &TaskPrincipal) -> Self {
1412 Self {
1413 kind: DefinitionKind::WindowsScheduledTask,
1414 text: windows_scheduled_task_xml(plan, principal),
1415 install_path: None,
1416 }
1417 }
1418
1419 #[must_use]
1424 pub fn launchd(plan: &InstallPlan, home: Option<&Path>) -> Self {
1425 let file = format!("{}.plist", plan.identity().launchd_label());
1426 let install_path = match plan.start_mode() {
1427 StartMode::Boot => Some(PathBuf::from(LAUNCH_DAEMONS_DIR).join(file)),
1428 StartMode::Login => home.map(|home| home.join(LAUNCH_AGENTS_SUBDIR).join(file)),
1429 };
1430 Self {
1431 kind: DefinitionKind::LaunchdPlist,
1432 text: launchd_plist(plan),
1433 install_path,
1434 }
1435 }
1436
1437 #[must_use]
1445 pub fn from_text(kind: DefinitionKind, text: impl Into<String>) -> Self {
1446 Self {
1447 kind,
1448 text: text.into(),
1449 install_path: None,
1450 }
1451 }
1452
1453 #[must_use]
1458 pub fn systemd(plan: &InstallPlan, home: Option<&Path>) -> Self {
1459 let file = plan.identity().systemd_unit();
1460 let install_path = match plan.start_mode() {
1461 StartMode::Boot => Some(PathBuf::from(SYSTEMD_SYSTEM_DIR).join(file)),
1462 StartMode::Login => home.map(|home| home.join(SYSTEMD_USER_SUBDIR).join(file)),
1463 };
1464 Self {
1465 kind: DefinitionKind::SystemdUnit,
1466 text: systemd_unit(plan),
1467 install_path,
1468 }
1469 }
1470}
1471
1472pub const LAUNCH_DAEMONS_DIR: &str = "/Library/LaunchDaemons";
1474pub const LAUNCH_AGENTS_SUBDIR: &str = "Library/LaunchAgents";
1476pub const SYSTEMD_SYSTEM_DIR: &str = "/etc/systemd/system";
1478pub const SYSTEMD_USER_SUBDIR: &str = ".config/systemd/user";
1480
1481const DOCUMENTATION: &str = "https://github.com/IvanMurzak/GitHub-Runner-Scaler-UI";
1484
1485pub const START_LIMIT_BURST: u32 = 5;
1493
1494#[must_use]
1515pub fn systemd_unit(plan: &InstallPlan) -> String {
1516 let identity = plan.identity();
1517 let restart = plan.restart();
1518 let directories = plan.directories();
1519
1520 let mut out = String::new();
1521 out.push_str("[Unit]\n");
1522 out.push_str(&format!("Description={}\n", identity.display_name()));
1523 out.push_str(&format!("Documentation={DOCUMENTATION}\n"));
1524 out.push_str("After=network-online.target\n");
1525 out.push_str("Wants=network-online.target\n");
1526 out.push_str(&format!(
1529 "StartLimitIntervalSec={}\n",
1530 restart.reset_after().as_secs()
1531 ));
1532 out.push_str(&format!("StartLimitBurst={START_LIMIT_BURST}\n"));
1533
1534 out.push_str("\n[Service]\n");
1535 out.push_str("Type=simple\n");
1536 out.push_str("KillMode=process\n");
1540 out.push_str(&format!("ExecStart={}\n", plan.command_line()));
1541 out.push_str(&format!(
1542 "WorkingDirectory={}\n",
1543 directories.state.display()
1544 ));
1545 out.push_str(&format!("SyslogIdentifier={identity}\n"));
1546 out.push_str("Restart=on-failure\n");
1547 out.push_str(&format!("RestartSec={}\n", restart.delay().as_secs()));
1548
1549 out.push_str("\n# Least privilege. See docs/service-account.md.\n");
1550 for directive in SYSTEMD_HARDENING {
1551 out.push_str(directive);
1552 out.push('\n');
1553 }
1554 let mut writable = directories.all().to_vec();
1555 if let Some(secret_directory) = plan.secret_guard().and_then(Path::parent) {
1556 writable.push(secret_directory);
1557 }
1558 out.push_str(&format!(
1559 "ReadWritePaths={}\n",
1560 writable
1561 .iter()
1562 .map(|path| quote_argument(&path.to_string_lossy()))
1563 .collect::<Vec<_>>()
1564 .join(" ")
1565 ));
1566
1567 out.push_str("\n[Install]\n");
1568 out.push_str(match plan.start_mode() {
1569 StartMode::Boot => "WantedBy=multi-user.target\n",
1570 StartMode::Login => "WantedBy=default.target\n",
1571 });
1572 out
1573}
1574
1575pub const SYSTEMD_HARDENING: [&str; 13] = [
1582 "NoNewPrivileges=yes",
1583 "CapabilityBoundingSet=",
1584 "AmbientCapabilities=",
1585 "PrivateTmp=yes",
1586 "PrivateDevices=yes",
1587 "ProtectSystem=strict",
1588 "ProtectKernelTunables=yes",
1589 "ProtectKernelModules=yes",
1590 "ProtectControlGroups=yes",
1591 "RestrictNamespaces=yes",
1592 "RestrictRealtime=yes",
1593 "RestrictSUIDSGID=yes",
1594 "RestrictAddressFamilies=AF_INET AF_INET6 AF_UNIX",
1595];
1596
1597#[must_use]
1606pub fn launchd_plist(plan: &InstallPlan) -> String {
1607 let identity = plan.identity();
1608 let directories = plan.directories();
1609 let mut out = String::new();
1610 out.push_str("<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n");
1611 out.push_str(
1612 "<!DOCTYPE plist PUBLIC \"-//Apple//DTD PLIST 1.0//EN\" \
1613 \"http://www.apple.com/DTDs/PropertyList-1.0.dtd\">\n",
1614 );
1615 out.push_str("<plist version=\"1.0\">\n<dict>\n");
1616 out.push_str(&plist_string("Label", &identity.launchd_label()));
1617
1618 out.push_str(" <key>ProgramArguments</key>\n <array>\n");
1619 out.push_str(&format!(
1620 " <string>{}</string>\n",
1621 xml_escape(&plan.binary().to_string_lossy())
1622 ));
1623 for argument in plan.arguments() {
1624 out.push_str(&format!(
1625 " <string>{}</string>\n",
1626 xml_escape(&argument.to_string_lossy())
1627 ));
1628 }
1629 out.push_str(" </array>\n");
1630
1631 out.push_str(" <key>RunAtLoad</key>\n <true/>\n");
1632 out.push_str(" <key>KeepAlive</key>\n <dict>\n");
1633 out.push_str(" <key>SuccessfulExit</key>\n <false/>\n");
1634 out.push_str(" </dict>\n");
1635 out.push_str(&format!(
1636 " <key>ThrottleInterval</key>\n <integer>{}</integer>\n",
1637 plan.restart().delay().as_secs()
1638 ));
1639 out.push_str(&plist_string("ProcessType", "Background"));
1642 out.push_str(&plist_string(
1643 "WorkingDirectory",
1644 &directories.state.to_string_lossy(),
1645 ));
1646 out.push_str(&plist_string(
1647 "StandardOutPath",
1648 &directories
1649 .logs
1650 .join("runner-manager.launchd.out.log")
1651 .to_string_lossy(),
1652 ));
1653 out.push_str(&plist_string(
1654 "StandardErrorPath",
1655 &directories
1656 .logs
1657 .join("runner-manager.launchd.err.log")
1658 .to_string_lossy(),
1659 ));
1660
1661 match plan.start_mode() {
1662 StartMode::Boot => {
1663 out.push_str(&plist_string(
1666 "UserName",
1667 ServiceAccount::for_definition(DefinitionKind::LaunchdPlist, StartMode::Boot)
1668 .as_str(),
1669 ));
1670 out.push_str(" <key>SessionCreate</key>\n <false/>\n");
1672 }
1673 StartMode::Login => {
1674 }
1678 }
1679
1680 out.push_str("</dict>\n</plist>\n");
1681 out
1682}
1683
1684fn plist_string(key: &str, value: &str) -> String {
1686 format!(
1687 " <key>{}</key>\n <string>{}</string>\n",
1688 xml_escape(key),
1689 xml_escape(value)
1690 )
1691}
1692
1693#[derive(Debug, Clone, PartialEq, Eq)]
1701pub struct TaskPrincipal {
1702 user_id: String,
1703}
1704
1705impl TaskPrincipal {
1706 pub fn current() -> Result<Self, ServiceError> {
1714 let user = std::env::var("USERNAME")
1715 .ok()
1716 .filter(|value| !value.trim().is_empty());
1717 let Some(user) = user else {
1718 return Err(ServiceError::Control {
1719 operation: "identify the account for",
1720 name: SERVICE_NAME.to_string(),
1721 manager: "Windows Task Scheduler",
1722 detail: "this session reports no %USERNAME%, so there is no principal to \
1723 register a logon-triggered task for"
1724 .to_string(),
1725 });
1726 };
1727 let domain = std::env::var("USERDOMAIN")
1728 .ok()
1729 .filter(|value| !value.trim().is_empty());
1730 Ok(Self {
1731 user_id: match domain {
1732 Some(domain) => format!("{domain}\\{user}"),
1733 None => user,
1734 },
1735 })
1736 }
1737
1738 #[must_use]
1740 pub fn named(user_id: impl Into<String>) -> Self {
1741 Self {
1742 user_id: user_id.into(),
1743 }
1744 }
1745
1746 #[must_use]
1748 pub fn user_id(&self) -> &str {
1749 &self.user_id
1750 }
1751}
1752
1753#[must_use]
1760pub fn windows_scheduled_task_xml(plan: &InstallPlan, principal: &TaskPrincipal) -> String {
1761 let identity = plan.identity();
1762 let user = xml_escape(principal.user_id());
1763 let arguments = plan
1764 .arguments()
1765 .iter()
1766 .map(|argument| quote_argument(&argument.to_string_lossy()))
1767 .collect::<Vec<_>>()
1768 .join(" ");
1769 let mut out = String::new();
1770 out.push_str("<?xml version=\"1.0\" encoding=\"UTF-16\"?>\n");
1771 out.push_str(
1772 "<Task version=\"1.4\" \
1773 xmlns=\"http://schemas.microsoft.com/windows/2004/02/mit/task\">\n",
1774 );
1775 out.push_str(" <RegistrationInfo>\n");
1776 out.push_str(&format!(
1777 " <Description>{}</Description>\n",
1778 xml_escape(identity.description())
1779 ));
1780 out.push_str(&format!(
1781 " <URI>\\{}</URI>\n",
1782 xml_escape(identity.name())
1783 ));
1784 out.push_str(" </RegistrationInfo>\n");
1785
1786 out.push_str(" <Triggers>\n <LogonTrigger>\n");
1787 out.push_str(" <Enabled>true</Enabled>\n");
1788 out.push_str(&format!(" <UserId>{user}</UserId>\n"));
1789 out.push_str(" </LogonTrigger>\n </Triggers>\n");
1790
1791 out.push_str(" <Principals>\n <Principal id=\"Author\">\n");
1792 out.push_str(&format!(" <UserId>{user}</UserId>\n"));
1793 out.push_str(" <LogonType>InteractiveToken</LogonType>\n");
1794 out.push_str(" <RunLevel>LeastPrivilege</RunLevel>\n");
1795 out.push_str(" </Principal>\n </Principals>\n");
1796
1797 out.push_str(" <Settings>\n");
1798 out.push_str(" <MultipleInstancesPolicy>IgnoreNew</MultipleInstancesPolicy>\n");
1802 out.push_str(" <DisallowStartIfOnBatteries>false</DisallowStartIfOnBatteries>\n");
1803 out.push_str(" <StopIfGoingOnBatteries>false</StopIfGoingOnBatteries>\n");
1804 out.push_str(" <AllowHardTerminate>true</AllowHardTerminate>\n");
1805 out.push_str(" <StartWhenAvailable>true</StartWhenAvailable>\n");
1806 out.push_str(" <RunOnlyIfNetworkAvailable>false</RunOnlyIfNetworkAvailable>\n");
1807 out.push_str(" <IdleSettings>\n");
1808 out.push_str(" <StopOnIdleEnd>false</StopOnIdleEnd>\n");
1809 out.push_str(" <RestartOnIdle>false</RestartOnIdle>\n");
1810 out.push_str(" </IdleSettings>\n");
1811 out.push_str(" <AllowStartOnDemand>true</AllowStartOnDemand>\n");
1812 out.push_str(" <Enabled>true</Enabled>\n");
1813 out.push_str(" <Hidden>false</Hidden>\n");
1814 out.push_str(" <RunOnlyIfIdle>false</RunOnlyIfIdle>\n");
1815 out.push_str(" <WakeToRun>false</WakeToRun>\n");
1816 out.push_str(" <ExecutionTimeLimit>PT0S</ExecutionTimeLimit>\n");
1818 out.push_str(" <Priority>7</Priority>\n");
1819 out.push_str(" <RestartOnFailure>\n");
1820 out.push_str(&format!(
1821 " <Interval>{}</Interval>\n",
1822 iso8601_minutes(
1823 plan.restart()
1824 .effective_delay(DefinitionKind::WindowsScheduledTask)
1825 )
1826 ));
1827 out.push_str(&format!(" <Count>{START_LIMIT_BURST}</Count>\n"));
1828 out.push_str(" </RestartOnFailure>\n");
1829 out.push_str(" </Settings>\n");
1830
1831 out.push_str(" <Actions Context=\"Author\">\n <Exec>\n");
1832 out.push_str(&format!(
1833 " <Command>{}</Command>\n",
1834 xml_escape(&plan.binary().to_string_lossy())
1835 ));
1836 if !arguments.is_empty() {
1837 out.push_str(&format!(
1838 " <Arguments>{}</Arguments>\n",
1839 xml_escape(&arguments)
1840 ));
1841 }
1842 out.push_str(&format!(
1843 " <WorkingDirectory>{}</WorkingDirectory>\n",
1844 xml_escape(&plan.directories().state.to_string_lossy())
1845 ));
1846 out.push_str(" </Exec>\n </Actions>\n");
1847 out.push_str("</Task>\n");
1848 out
1849}
1850
1851fn iso8601_minutes(duration: Duration) -> String {
1854 format!("PT{}M", duration.as_secs() / 60)
1855}
1856
1857pub(crate) fn xml_escape(value: &str) -> String {
1865 let mut out = String::with_capacity(value.len());
1866 for c in value.chars() {
1867 match c {
1868 '&' => out.push_str("&"),
1869 '<' => out.push_str("<"),
1870 '>' => out.push_str(">"),
1871 '"' => out.push_str("""),
1872 '\'' => out.push_str("'"),
1873 other => out.push(other),
1874 }
1875 }
1876 out
1877}
1878
1879fn xml_unescape(value: &str) -> String {
1885 value
1886 .replace("<", "<")
1887 .replace(">", ">")
1888 .replace(""", "\"")
1889 .replace("'", "'")
1890 .replace("&", "&")
1891}
1892
1893#[derive(Debug, Clone, PartialEq, Eq)]
1902pub struct WindowsServiceSpec {
1903 pub name: String,
1905 pub display_name: String,
1907 pub description: String,
1909 pub automatic_start: bool,
1911 pub account: Option<String>,
1914 pub command_line: String,
1916 pub restart: RestartPolicy,
1918}
1919
1920#[must_use]
1922pub fn windows_service_spec(plan: &InstallPlan) -> WindowsServiceSpec {
1923 WindowsServiceSpec {
1924 name: plan.identity().name().to_string(),
1925 display_name: plan.identity().display_name().to_string(),
1926 description: plan.identity().description().to_string(),
1927 automatic_start: plan.start_mode() == StartMode::Boot && !plan.is_on_demand(),
1932 account: match ServiceAccount::for_definition(
1933 DefinitionKind::WindowsService,
1934 plan.start_mode(),
1935 ) {
1936 ServiceAccount::LocalSystem => None,
1939 other => Some(other.as_str().to_string()),
1940 },
1941 command_line: plan.command_line(),
1942 restart: plan.restart(),
1943 }
1944}
1945
1946#[must_use]
1949fn windows_service_descriptor(plan: &InstallPlan) -> String {
1950 let spec = windows_service_spec(plan);
1951 let mut out = String::new();
1952 out.push_str("[windows-service]\n");
1953 out.push_str(&format!("Name={}\n", spec.name));
1954 out.push_str(&format!("DisplayName={}\n", spec.display_name));
1955 out.push_str(&format!("Description={}\n", spec.description));
1956 out.push_str("ServiceType=OWN_PROCESS\n");
1960 out.push_str(&format!(
1961 "StartType={}\n",
1962 if spec.automatic_start {
1963 "AutoStart"
1964 } else {
1965 "OnDemand"
1966 }
1967 ));
1968 out.push_str("ErrorControl=Normal\n");
1969 out.push_str(&format!(
1970 "Account={}\n",
1971 spec.account
1972 .as_deref()
1973 .unwrap_or(ServiceAccount::LocalSystem.as_str())
1974 ));
1975 out.push_str(&format!("CommandLine={}\n", spec.command_line));
1976 out.push_str(&format!(
1977 "FailureActionRestartDelaySecs={}\n",
1978 spec.restart.delay().as_secs()
1979 ));
1980 out.push_str(&format!(
1981 "FailureActionsResetPeriodSecs={}\n",
1982 spec.restart.reset_after().as_secs()
1983 ));
1984 out.push_str("FailureActionsOnNonCrashFailures=true\n");
1988 out.push_str(&format!(
1989 "ReadWritePaths={}\n",
1990 plan.directories()
1991 .all()
1992 .iter()
1993 .map(|path| quote_argument(&path.to_string_lossy()))
1994 .collect::<Vec<_>>()
1995 .join(" ")
1996 ));
1997 out
1998}
1999
2000#[derive(Debug, Clone, Copy, PartialEq, Eq)]
2006pub enum FindingKind {
2007 Excess,
2010 Shortfall,
2013}
2014
2015impl fmt::Display for FindingKind {
2016 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
2017 f.write_str(match self {
2018 Self::Excess => "excess",
2019 Self::Shortfall => "shortfall",
2020 })
2021 }
2022}
2023
2024#[derive(Debug, Clone, PartialEq, Eq)]
2026pub struct PrivilegeFinding {
2027 pub kind: FindingKind,
2029 pub subject: String,
2031 pub detail: String,
2033}
2034
2035impl fmt::Display for PrivilegeFinding {
2036 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
2037 write!(f, "{}: {} -- {}", self.kind, self.subject, self.detail)
2038 }
2039}
2040
2041#[derive(Debug, Clone, PartialEq, Eq)]
2055pub struct PrivilegeReview {
2056 kind: DefinitionKind,
2057 account: ServiceAccount,
2058 controls: Vec<String>,
2059 findings: Vec<PrivilegeFinding>,
2060}
2061
2062impl PrivilegeReview {
2063 #[must_use]
2065 pub fn is_least_privilege(&self) -> bool {
2066 !self
2067 .findings
2068 .iter()
2069 .any(|finding| finding.kind == FindingKind::Excess)
2070 }
2071
2072 #[must_use]
2074 pub fn findings(&self) -> &[PrivilegeFinding] {
2075 &self.findings
2076 }
2077
2078 #[must_use]
2081 pub fn excesses(&self) -> Vec<&PrivilegeFinding> {
2082 self.findings
2083 .iter()
2084 .filter(|finding| finding.kind == FindingKind::Excess)
2085 .collect()
2086 }
2087
2088 #[must_use]
2094 pub fn controls(&self) -> &[String] {
2095 &self.controls
2096 }
2097
2098 #[must_use]
2100 pub const fn account(&self) -> &ServiceAccount {
2101 &self.account
2102 }
2103
2104 #[must_use]
2106 pub const fn kind(&self) -> DefinitionKind {
2107 self.kind
2108 }
2109}
2110
2111impl fmt::Display for PrivilegeReview {
2112 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
2113 writeln!(
2114 f,
2115 "{} runs as {} ({})",
2116 self.kind,
2117 self.account,
2118 self.account.justification()
2119 )?;
2120 for control in &self.controls {
2121 writeln!(f, " confirmed {control}")?;
2122 }
2123 for finding in &self.findings {
2124 writeln!(f, " {finding}")?;
2125 }
2126 if self.is_least_privilege() {
2127 write!(f, " verdict least privilege")
2128 } else {
2129 write!(
2130 f,
2131 " verdict NOT least privilege: {} excess(es)",
2132 self.excesses().len()
2133 )
2134 }
2135 }
2136}
2137
2138#[must_use]
2144pub fn review_least_privilege(
2145 definition: &ServiceDefinition,
2146 plan: &InstallPlan,
2147) -> PrivilegeReview {
2148 let mut controls = Vec::new();
2149 let mut findings = Vec::new();
2150 match definition.kind() {
2151 DefinitionKind::SystemdUnit => {
2152 review_systemd(definition.text(), plan, &mut controls, &mut findings);
2153 }
2154 DefinitionKind::LaunchdPlist => {
2155 review_launchd(definition.text(), plan, &mut controls, &mut findings);
2156 }
2157 DefinitionKind::WindowsScheduledTask => {
2158 review_scheduled_task(definition.text(), &mut controls, &mut findings);
2159 }
2160 DefinitionKind::WindowsService => {
2161 review_windows_service(definition.text(), plan, &mut controls, &mut findings);
2162 }
2163 }
2164 PrivilegeReview {
2165 kind: definition.kind(),
2166 account: ServiceAccount::for_definition(definition.kind(), plan.start_mode()),
2171 controls,
2172 findings,
2173 }
2174}
2175
2176fn permitted_paths(kind: DefinitionKind, plan: &InstallPlan) -> Vec<String> {
2178 let mut permitted = plan
2179 .directories()
2180 .all()
2181 .iter()
2182 .map(|path| path.to_string_lossy().into_owned())
2183 .collect::<Vec<_>>();
2184 if kind == DefinitionKind::SystemdUnit
2185 && let Some(secret_directory) = plan.secret_guard().and_then(Path::parent)
2186 {
2187 permitted.push(secret_directory.to_string_lossy().into_owned());
2188 }
2189 permitted
2190}
2191
2192fn same_path_text(left: &str, right: &str) -> bool {
2199 if cfg!(windows) {
2200 left.eq_ignore_ascii_case(right)
2201 } else {
2202 left == right
2203 }
2204}
2205
2206fn same_path_for(kind: DefinitionKind, left: &str, right: &str) -> bool {
2209 match kind {
2210 DefinitionKind::WindowsService | DefinitionKind::WindowsScheduledTask => {
2211 left.eq_ignore_ascii_case(right)
2212 }
2213 DefinitionKind::LaunchdPlist | DefinitionKind::SystemdUnit => left == right,
2214 }
2215}
2216
2217fn review_writable_paths(
2219 kind: DefinitionKind,
2220 subject: &str,
2221 listed: &[String],
2222 plan: &InstallPlan,
2223 controls: &mut Vec<String>,
2224 findings: &mut Vec<PrivilegeFinding>,
2225) {
2226 let permitted = permitted_paths(kind, plan);
2227 for entry in listed {
2228 if !permitted
2229 .iter()
2230 .any(|allowed| same_path_for(kind, allowed, entry))
2231 {
2232 findings.push(PrivilegeFinding {
2233 kind: FindingKind::Excess,
2234 subject: subject.to_string(),
2235 detail: format!(
2236 "{entry} is writable but is not one of this registration's required paths"
2237 ),
2238 });
2239 }
2240 }
2241 for allowed in &permitted {
2242 if !listed
2243 .iter()
2244 .any(|entry| same_path_for(kind, allowed, entry))
2245 {
2246 findings.push(PrivilegeFinding {
2247 kind: FindingKind::Shortfall,
2248 subject: subject.to_string(),
2249 detail: format!(
2250 "{allowed} is one of this registration's directories but is not writable, \
2251 so the daemon cannot use it"
2252 ),
2253 });
2254 }
2255 }
2256 if listed.len() == permitted.len() && findings.iter().all(|f| f.subject != subject) {
2257 controls.push(format!(
2258 "{subject} names exactly the required application-data and credential paths"
2259 ));
2260 }
2261}
2262
2263fn review_inbound_surface(
2271 text: &str,
2272 markers: &[(&str, &str)],
2273 controls: &mut Vec<String>,
2274 findings: &mut Vec<PrivilegeFinding>,
2275) {
2276 let mut clean = true;
2277 for (marker, detail) in markers {
2278 if text.contains(marker) {
2279 clean = false;
2280 findings.push(PrivilegeFinding {
2281 kind: FindingKind::Excess,
2282 subject: (*marker).to_string(),
2283 detail: (*detail).to_string(),
2284 });
2285 }
2286 }
2287 if clean {
2288 controls.push(
2289 "no socket, listener, or Mach service is published on the daemon's behalf".to_string(),
2290 );
2291 }
2292}
2293
2294fn review_systemd(
2295 text: &str,
2296 plan: &InstallPlan,
2297 controls: &mut Vec<String>,
2298 findings: &mut Vec<PrivilegeFinding>,
2299) {
2300 let directives = ini_directives(text, "Service");
2301 for expected in SYSTEMD_HARDENING {
2302 let (key, value) = expected
2303 .split_once('=')
2304 .expect("every hardening directive is written as key=value");
2305 match directives.get(key) {
2306 Some(actual) if actual == value => controls.push((*expected).to_string()),
2307 Some(actual) => findings.push(PrivilegeFinding {
2308 kind: FindingKind::Excess,
2309 subject: key.to_string(),
2310 detail: format!(
2311 "is `{actual}`, not `{value}`, so the unit keeps authority the \
2312 requirement does not ask for"
2313 ),
2314 }),
2315 None => findings.push(PrivilegeFinding {
2316 kind: FindingKind::Excess,
2317 subject: key.to_string(),
2318 detail: format!(
2319 "is absent, so the unit inherits systemd's default rather than `{value}`"
2320 ),
2321 }),
2322 }
2323 }
2324
2325 match directives.get("ReadWritePaths") {
2326 Some(value) => {
2327 let listed = split_quoted(value);
2328 review_writable_paths(
2329 DefinitionKind::SystemdUnit,
2330 "ReadWritePaths",
2331 &listed,
2332 plan,
2333 controls,
2334 findings,
2335 );
2336 }
2337 None => findings.push(PrivilegeFinding {
2338 kind: FindingKind::Shortfall,
2339 subject: "ReadWritePaths".to_string(),
2340 detail: "is absent, so `ProtectSystem=strict` leaves the daemon nowhere to write"
2341 .to_string(),
2342 }),
2343 }
2344
2345 if directives.contains_key("PrivateUsers")
2348 && directives.get("PrivateUsers") == Some(&"no".to_string())
2349 {
2350 findings.push(PrivilegeFinding {
2351 kind: FindingKind::Excess,
2352 subject: "PrivateUsers".to_string(),
2353 detail: "is explicitly disabled, which is broader than leaving it at systemd's default"
2354 .to_string(),
2355 });
2356 }
2357
2358 review_inbound_surface(
2359 text,
2360 &[
2361 (
2362 "ListenStream=",
2363 "asks systemd to open a listening socket for this service, which \
2364 07-security.md rule 2 forbids the product to have",
2365 ),
2366 (
2367 "ListenDatagram=",
2368 "asks systemd to open a listening socket for this service, which \
2369 07-security.md rule 2 forbids the product to have",
2370 ),
2371 ],
2372 controls,
2373 findings,
2374 );
2375}
2376
2377fn review_launchd(
2378 text: &str,
2379 plan: &InstallPlan,
2380 controls: &mut Vec<String>,
2381 findings: &mut Vec<PrivilegeFinding>,
2382) {
2383 match plist_string_value(text, "ProcessType").as_deref() {
2384 Some("Background") => controls.push("ProcessType=Background".to_string()),
2385 Some(other) => findings.push(PrivilegeFinding {
2386 kind: FindingKind::Excess,
2387 subject: "ProcessType".to_string(),
2388 detail: format!(
2389 "is `{other}`, which asks the scheduler for more CPU and I/O than a background \
2390 daemon needs"
2391 ),
2392 }),
2393 None => findings.push(PrivilegeFinding {
2394 kind: FindingKind::Excess,
2395 subject: "ProcessType".to_string(),
2396 detail: "is absent, so launchd applies its `Standard` default rather than \
2397 `Background`"
2398 .to_string(),
2399 }),
2400 }
2401
2402 match plan.start_mode() {
2403 StartMode::Boot => {
2404 if plist_bool_value(text, "SessionCreate") == Some(true) {
2405 findings.push(PrivilegeFinding {
2406 kind: FindingKind::Excess,
2407 subject: "SessionCreate".to_string(),
2408 detail: "asks launchd to create a security session for a job that runs \
2409 outside every login session and has no use for one"
2410 .to_string(),
2411 });
2412 } else {
2413 controls.push("SessionCreate is not requested".to_string());
2414 }
2415 match plist_string_value(text, "UserName").as_deref() {
2416 Some("root") => {
2417 controls.push("UserName=root, stated rather than inherited".to_string())
2418 }
2419 Some(other) => findings.push(PrivilegeFinding {
2420 kind: FindingKind::Shortfall,
2421 subject: "UserName".to_string(),
2422 detail: format!(
2423 "is `{other}`, which cannot unlock the System Keychain: \
2424 /var/db/SystemKey is root-only, so the daemon would start and then \
2425 find no credential"
2426 ),
2427 }),
2428 None => findings.push(PrivilegeFinding {
2429 kind: FindingKind::Shortfall,
2430 subject: "UserName".to_string(),
2431 detail: "is absent, so the account is launchd's implicit default and this \
2432 review cannot confirm it"
2433 .to_string(),
2434 }),
2435 }
2436 }
2437 StartMode::Login => {
2438 if let Some(named) = plist_string_value(text, "UserName") {
2439 findings.push(PrivilegeFinding {
2440 kind: FindingKind::Excess,
2441 subject: "UserName".to_string(),
2442 detail: format!(
2443 "names `{named}` in a LaunchAgent, which already runs as the operator; \
2444 naming an account here asks launchd for a switch a login-mode \
2445 registration has no reason to want"
2446 ),
2447 });
2448 } else {
2449 controls
2450 .push("no UserName: the agent runs as the operator and no other".to_string());
2451 }
2452 }
2453 }
2454
2455 review_inbound_surface(
2456 text,
2457 &[
2458 (
2459 "<key>Sockets</key>",
2460 "asks launchd to open a socket for this job, which 07-security.md rule 2 \
2461 forbids the product to have",
2462 ),
2463 (
2464 "<key>MachServices</key>",
2465 "publishes a Mach service, which is the RPC surface 07-security.md rule 2 \
2466 forbids the product to have",
2467 ),
2468 ],
2469 controls,
2470 findings,
2471 );
2472}
2473
2474fn review_scheduled_task(
2475 text: &str,
2476 controls: &mut Vec<String>,
2477 findings: &mut Vec<PrivilegeFinding>,
2478) {
2479 match xml_value(text, "RunLevel").as_deref() {
2480 Some("LeastPrivilege") => controls.push("RunLevel=LeastPrivilege".to_string()),
2481 Some(other) => findings.push(PrivilegeFinding {
2482 kind: FindingKind::Excess,
2483 subject: "RunLevel".to_string(),
2484 detail: format!(
2485 "is `{other}`, so the task runs with an elevated token whenever the operator is \
2486 an administrator"
2487 ),
2488 }),
2489 None => findings.push(PrivilegeFinding {
2490 kind: FindingKind::Excess,
2491 subject: "RunLevel".to_string(),
2492 detail: "is absent, so Task Scheduler decides the token rather than the definition"
2493 .to_string(),
2494 }),
2495 }
2496
2497 match xml_value(text, "LogonType").as_deref() {
2498 Some("InteractiveToken") => controls.push("LogonType=InteractiveToken".to_string()),
2499 Some(other) => findings.push(PrivilegeFinding {
2500 kind: FindingKind::Excess,
2501 subject: "LogonType".to_string(),
2502 detail: format!(
2503 "is `{other}`, which asks Windows to store or synthesise a credential for this \
2504 task; an interactive token needs neither"
2505 ),
2506 }),
2507 None => findings.push(PrivilegeFinding {
2508 kind: FindingKind::Shortfall,
2509 subject: "LogonType".to_string(),
2510 detail: "is absent, so this review cannot confirm that no credential is stored"
2511 .to_string(),
2512 }),
2513 }
2514}
2515
2516fn review_windows_service(
2517 text: &str,
2518 plan: &InstallPlan,
2519 controls: &mut Vec<String>,
2520 findings: &mut Vec<PrivilegeFinding>,
2521) {
2522 let directives = ini_directives(text, "windows-service");
2523
2524 match directives.get("ServiceType").map(String::as_str) {
2525 Some("OWN_PROCESS") => controls.push("ServiceType=OWN_PROCESS".to_string()),
2526 Some(other) => findings.push(PrivilegeFinding {
2527 kind: FindingKind::Excess,
2528 subject: "ServiceType".to_string(),
2529 detail: format!(
2530 "is `{other}`; an interactive or shared-process service reaches further than a \
2531 daemon that only talks to GitHub over HTTPS"
2532 ),
2533 }),
2534 None => findings.push(PrivilegeFinding {
2535 kind: FindingKind::Shortfall,
2536 subject: "ServiceType".to_string(),
2537 detail: "is absent, so this review cannot confirm the service is not interactive"
2538 .to_string(),
2539 }),
2540 }
2541
2542 match directives.get("Account").map(String::as_str) {
2546 Some(account) if account == ServiceAccount::LocalSystem.as_str() => {
2547 controls.push(format!(
2548 "Account={account}: the only stock account the machine-scoped store's DACL \
2549 (SY, BA, OW) admits"
2550 ));
2551 }
2552 Some(other) => findings.push(PrivilegeFinding {
2553 kind: FindingKind::Shortfall,
2554 subject: "Account".to_string(),
2555 detail: format!(
2556 "is `{other}`, which the machine-scoped store's DACL does not name, so the \
2557 daemon would start and then find no credential. Widening that DACL is not this \
2558 registration's to do: an ACE reaching `{other}` would also reach every other \
2559 service running under it"
2560 ),
2561 }),
2562 None => findings.push(PrivilegeFinding {
2563 kind: FindingKind::Shortfall,
2564 subject: "Account".to_string(),
2565 detail: "is absent, so this review cannot confirm which account was registered"
2566 .to_string(),
2567 }),
2568 }
2569
2570 match directives.get("ReadWritePaths") {
2571 Some(value) => {
2572 let listed = split_quoted(value);
2573 review_writable_paths(
2574 DefinitionKind::WindowsService,
2575 "ReadWritePaths",
2576 &listed,
2577 plan,
2578 controls,
2579 findings,
2580 );
2581 }
2582 None => findings.push(PrivilegeFinding {
2583 kind: FindingKind::Shortfall,
2584 subject: "ReadWritePaths".to_string(),
2585 detail: "is absent, so the directories the service was installed against are not \
2586 recorded"
2587 .to_string(),
2588 }),
2589 }
2590}
2591
2592fn ini_directives(text: &str, section: &str) -> BTreeMap<String, String> {
2600 let mut out = BTreeMap::new();
2601 let mut inside = false;
2602 for line in text.lines() {
2603 let line = line.trim();
2604 if line.starts_with('[') && line.ends_with(']') {
2605 inside = &line[1..line.len() - 1] == section;
2606 continue;
2607 }
2608 if !inside || line.is_empty() || line.starts_with('#') || line.starts_with(';') {
2609 continue;
2610 }
2611 if let Some((key, value)) = line.split_once('=') {
2612 out.insert(key.trim().to_string(), value.trim().to_string());
2613 }
2614 }
2615 out
2616}
2617
2618fn split_quoted(value: &str) -> Vec<String> {
2621 let mut out = Vec::new();
2622 let mut rest = value.trim();
2623 while !rest.is_empty() {
2624 if rest.starts_with('"') {
2625 if let Some(parsed) = executable_from_command_line(rest) {
2628 out.push(parsed.to_string_lossy().into_owned());
2629 }
2630 let mut depth = 0usize;
2632 let mut end = rest.len();
2633 for (index, c) in rest.char_indices() {
2634 match c {
2635 '\\' => depth += 1,
2636 '"' => {
2637 if depth.is_multiple_of(2) && index > 0 {
2638 end = index + 1;
2639 break;
2640 }
2641 depth = 0;
2642 }
2643 _ => depth = 0,
2644 }
2645 }
2646 rest = rest[end..].trim_start();
2647 } else {
2648 let end = rest.find(char::is_whitespace).unwrap_or(rest.len());
2649 out.push(rest[..end].to_string());
2650 rest = rest[end..].trim_start();
2651 }
2652 }
2653 out
2654}
2655
2656pub(crate) fn xml_value(text: &str, tag: &str) -> Option<String> {
2668 let open = format!("<{tag}>");
2669 let close = format!("</{tag}>");
2670 let start = text.find(&open)? + open.len();
2671 let end = text[start..].find(&close)? + start;
2672 Some(xml_unescape(text[start..end].trim()))
2673}
2674
2675#[cfg(any(windows, test))]
2681fn windows_login_task_starts_automatically(document: &str) -> bool {
2682 document.contains("<LogonTrigger>")
2683 && xml_value(document, "Enabled").as_deref() != Some("false")
2684}
2685
2686fn plist_value_after_key<'a>(text: &'a str, key: &str) -> Option<&'a str> {
2688 let marker = format!("<key>{key}</key>");
2689 let start = text.find(&marker)? + marker.len();
2690 Some(text[start..].trim_start())
2691}
2692
2693fn plist_string_value(text: &str, key: &str) -> Option<String> {
2694 let rest = plist_value_after_key(text, key)?;
2695 if !rest.starts_with("<string>") {
2696 return None;
2697 }
2698 xml_value(rest, "string")
2699}
2700
2701fn plist_bool_value(text: &str, key: &str) -> Option<bool> {
2702 let rest = plist_value_after_key(text, key)?;
2703 if rest.starts_with("<true/>") {
2704 Some(true)
2705 } else if rest.starts_with("<false/>") {
2706 Some(false)
2707 } else {
2708 None
2709 }
2710}
2711
2712pub const RECORD_SCHEMA_VERSION: u32 = 1;
2723
2724#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
2736pub struct InstallRecord {
2737 pub schema_version: u32,
2739 pub service_name: String,
2741 pub manager: String,
2743 pub start_mode: StartMode,
2745 pub account: ServiceAccount,
2747 pub binary: PathBuf,
2749 #[serde(default)]
2757 pub source_binary: Option<PathBuf>,
2758 pub arguments: Vec<String>,
2760 pub restart_delay_secs: u64,
2762 pub restart_reset_secs: u64,
2764 pub log_file: PathBuf,
2766 #[serde(default)]
2774 pub starts_on_demand: bool,
2775 pub definition_path: Option<PathBuf>,
2777 pub installed_at: DateTime<Utc>,
2779 pub installed_by_version: String,
2781 pub directories: ServiceDirectories,
2786}
2787
2788impl InstallRecord {
2789 #[must_use]
2791 pub fn path(paths: &AppPaths) -> PathBuf {
2792 paths.config_dir().join(RECORD_FILE)
2793 }
2794
2795 #[must_use]
2797 pub fn of(plan: &InstallPlan, definition: &ServiceDefinition, at: DateTime<Utc>) -> Self {
2798 Self {
2799 schema_version: RECORD_SCHEMA_VERSION,
2800 service_name: plan.identity().name().to_string(),
2801 manager: definition.kind().manager().to_string(),
2802 start_mode: plan.start_mode(),
2803 account: plan.account().clone(),
2804 binary: plan.binary().to_path_buf(),
2805 arguments: plan
2806 .arguments()
2807 .iter()
2808 .map(|argument| argument.to_string_lossy().into_owned())
2809 .collect(),
2810 restart_delay_secs: plan.restart().delay().as_secs(),
2811 restart_reset_secs: plan.restart().reset_after().as_secs(),
2812 starts_on_demand: plan.is_on_demand(),
2813 source_binary: plan.source_binary().map(Path::to_path_buf),
2814 log_file: plan.directories().log_file(),
2815 definition_path: definition.install_path().map(Path::to_path_buf),
2816 installed_at: at,
2817 installed_by_version: env!("CARGO_PKG_VERSION").to_string(),
2818 directories: plan.directories().clone(),
2819 }
2820 }
2821
2822 #[must_use]
2826 pub fn restart(&self) -> RestartPolicy {
2827 RestartPolicy::new(
2828 Duration::from_secs(self.restart_delay_secs),
2829 Duration::from_secs(self.restart_reset_secs),
2830 )
2831 .unwrap_or_default()
2832 }
2833
2834 pub fn read(paths: &AppPaths) -> Result<Option<Self>, ServiceError> {
2845 let path = Self::path(paths);
2846 let text = match std::fs::read_to_string(&path) {
2847 Ok(text) => text,
2848 Err(error) if error.kind() == std::io::ErrorKind::NotFound => return Ok(None),
2849 Err(error) if error.kind() == std::io::ErrorKind::PermissionDenied => {
2852 return Err(ServiceError::RecordNotPermitted {
2853 path,
2854 detail: error.to_string(),
2855 });
2856 }
2857 Err(error) => {
2858 return Err(ServiceError::Record {
2859 operation: "read",
2860 path,
2861 detail: error.to_string(),
2862 });
2863 }
2864 };
2865 let record: Self =
2866 toml::from_str(&text).map_err(|error| ServiceError::RecordUnreadable {
2867 path: path.clone(),
2868 detail: error.to_string(),
2869 })?;
2870 if record.schema_version != RECORD_SCHEMA_VERSION {
2871 return Err(ServiceError::RecordUnreadable {
2872 path,
2873 detail: format!(
2874 "it declares schema version {} and this build reads version {}",
2875 record.schema_version, RECORD_SCHEMA_VERSION
2876 ),
2877 });
2878 }
2879 Ok(Some(record))
2880 }
2881
2882 pub fn write(&self, paths: &AppPaths) -> Result<(), ServiceError> {
2888 use std::io::Write as _;
2889
2890 let path = Self::path(paths);
2891 let text = toml::to_string_pretty(self).map_err(|error| ServiceError::Record {
2892 operation: "encode",
2893 path: path.clone(),
2894 detail: error.to_string(),
2895 })?;
2896 if let Some(parent) = path.parent() {
2897 std::fs::create_dir_all(parent).map_err(|error| ServiceError::Record {
2898 operation: "write",
2899 path: path.clone(),
2900 detail: error.to_string(),
2901 })?;
2902 }
2903 let parent = path.parent().ok_or_else(|| ServiceError::Record {
2904 operation: "write",
2905 path: path.clone(),
2906 detail: "the record path has no parent directory".to_string(),
2907 })?;
2908 let mut temporary =
2909 tempfile::NamedTempFile::new_in(parent).map_err(|error| ServiceError::Record {
2910 operation: "write",
2911 path: path.clone(),
2912 detail: error.to_string(),
2913 })?;
2914 temporary
2915 .write_all(text.as_bytes())
2916 .and_then(|()| temporary.as_file().sync_all())
2917 .map_err(|error| ServiceError::Record {
2918 operation: "write",
2919 path: path.clone(),
2920 detail: error.to_string(),
2921 })?;
2922 #[cfg(unix)]
2938 {
2939 use std::os::unix::fs::PermissionsExt as _;
2940
2941 temporary
2942 .as_file()
2943 .set_permissions(std::fs::Permissions::from_mode(0o644))
2944 .map_err(|error| ServiceError::Record {
2945 operation: "write",
2946 path: path.clone(),
2947 detail: error.to_string(),
2948 })?;
2949 }
2950 temporary
2951 .persist(&path)
2952 .map(|_| ())
2953 .map_err(|error| ServiceError::Record {
2954 operation: "write",
2955 path,
2956 detail: error.error.to_string(),
2957 })
2958 }
2959
2960 pub fn remove(paths: &AppPaths) -> Result<bool, ServiceError> {
2966 let path = Self::path(paths);
2967 match std::fs::remove_file(&path) {
2968 Ok(()) => Ok(true),
2969 Err(error) if error.kind() == std::io::ErrorKind::NotFound => Ok(false),
2970 Err(error) => Err(ServiceError::Record {
2971 operation: "remove",
2972 path,
2973 detail: error.to_string(),
2974 }),
2975 }
2976 }
2977}
2978
2979const CONTACT_SCHEMA_VERSION: u32 = 1;
2985
2986#[derive(Debug, Clone, Serialize, Deserialize)]
2987struct ContactRecord {
2988 schema_version: u32,
2989 last_success: DateTime<Utc>,
2990}
2991
2992pub fn record_github_contact(paths: &AppPaths, at: DateTime<Utc>) -> Result<(), ServiceError> {
3013 let path = contact_path(paths);
3014 let record = ContactRecord {
3015 schema_version: CONTACT_SCHEMA_VERSION,
3016 last_success: at,
3017 };
3018 let failed = |detail: String| ServiceError::Record {
3019 operation: "write",
3020 path: path.clone(),
3021 detail,
3022 };
3023 let text = toml::to_string_pretty(&record).map_err(|error| failed(error.to_string()))?;
3024 let directory = path.parent().unwrap_or_else(|| Path::new("."));
3025 std::fs::create_dir_all(directory).map_err(|error| failed(error.to_string()))?;
3026 let temporary = path.with_extension("toml.new");
3027 std::fs::write(&temporary, text).map_err(|error| failed(error.to_string()))?;
3028 std::fs::rename(&temporary, &path).map_err(|error| failed(error.to_string()))
3029}
3030
3031pub fn last_github_contact(paths: &AppPaths) -> Result<Option<DateTime<Utc>>, ServiceError> {
3043 let path = contact_path(paths);
3044 let text = match std::fs::read_to_string(&path) {
3045 Ok(text) => text,
3046 Err(error) if error.kind() == std::io::ErrorKind::NotFound => return Ok(None),
3047 Err(error) => {
3048 return Err(ServiceError::Record {
3049 operation: "read",
3050 path,
3051 detail: error.to_string(),
3052 });
3053 }
3054 };
3055 let record: ContactRecord = toml::from_str(&text).map_err(|error| ServiceError::Record {
3056 operation: "read",
3057 path,
3058 detail: error.to_string(),
3059 })?;
3060 Ok(Some(record.last_success))
3061}
3062
3063#[must_use]
3065pub fn contact_path(paths: &AppPaths) -> PathBuf {
3066 paths.state_dir().join(CONTACT_FILE)
3067}
3068
3069const ROOT_REFUSAL_SCHEMA_VERSION: u32 = 1;
3074
3075#[derive(Debug, Clone, Serialize, Deserialize)]
3076struct RootRefusalFile {
3077 schema_version: u32,
3078 #[serde(default)]
3080 refusals: BTreeMap<String, RootRefusalEntry>,
3081}
3082
3083#[derive(Debug, Clone, Serialize, Deserialize)]
3084struct RootRefusalEntry {
3085 at: DateTime<Utc>,
3086 kind: String,
3087 root: String,
3088 detail: String,
3089}
3090
3091#[derive(Debug, Clone, PartialEq, Eq)]
3093pub struct RunnerRootRefusal {
3094 pub policy: String,
3096 pub at: DateTime<Utc>,
3098 pub kind: String,
3100 pub root: String,
3102 pub detail: String,
3105}
3106
3107pub fn record_runner_root_refusal(
3141 paths: &AppPaths,
3142 policy: &str,
3143 at: DateTime<Utc>,
3144 kind: &str,
3145 root: &str,
3146 detail: &str,
3147) -> Result<(), ServiceError> {
3148 let mut file = read_refusal_file(paths)?.unwrap_or(RootRefusalFile {
3149 schema_version: ROOT_REFUSAL_SCHEMA_VERSION,
3150 refusals: BTreeMap::new(),
3151 });
3152 file.schema_version = ROOT_REFUSAL_SCHEMA_VERSION;
3153 file.refusals.insert(
3154 policy.to_owned(),
3155 RootRefusalEntry {
3156 at,
3157 kind: kind.to_owned(),
3158 root: root.to_owned(),
3159 detail: detail.to_owned(),
3160 },
3161 );
3162 write_refusal_file(paths, &file)
3163}
3164
3165pub fn clear_runner_root_refusal(paths: &AppPaths, policy: &str) -> Result<(), ServiceError> {
3176 let Some(mut file) = read_refusal_file(paths)? else {
3177 return Ok(());
3178 };
3179 if file.refusals.remove(policy).is_none() {
3180 return Ok(());
3181 }
3182 if file.refusals.is_empty() {
3183 let path = root_refusal_path(paths);
3184 return match std::fs::remove_file(&path) {
3185 Ok(()) => Ok(()),
3186 Err(error) if error.kind() == std::io::ErrorKind::NotFound => Ok(()),
3187 Err(error) => Err(ServiceError::Record {
3188 operation: "remove",
3189 path,
3190 detail: error.to_string(),
3191 }),
3192 };
3193 }
3194 write_refusal_file(paths, &file)
3195}
3196
3197pub fn runner_root_refusals(paths: &AppPaths) -> Result<Vec<RunnerRootRefusal>, ServiceError> {
3209 Ok(read_refusal_file(paths)?
3210 .map(|file| {
3211 file.refusals
3212 .into_iter()
3213 .map(|(policy, entry)| RunnerRootRefusal {
3214 policy,
3215 at: entry.at,
3216 kind: entry.kind,
3217 root: entry.root,
3218 detail: entry.detail,
3219 })
3220 .collect()
3221 })
3222 .unwrap_or_default())
3223}
3224
3225fn read_refusal_file(paths: &AppPaths) -> Result<Option<RootRefusalFile>, ServiceError> {
3226 let path = root_refusal_path(paths);
3227 let text = match std::fs::read_to_string(&path) {
3228 Ok(text) => text,
3229 Err(error) if error.kind() == std::io::ErrorKind::NotFound => return Ok(None),
3230 Err(error) => {
3231 return Err(ServiceError::Record {
3232 operation: "read",
3233 path,
3234 detail: error.to_string(),
3235 });
3236 }
3237 };
3238 toml::from_str(&text)
3239 .map(Some)
3240 .map_err(|error| ServiceError::Record {
3241 operation: "read",
3242 path,
3243 detail: error.to_string(),
3244 })
3245}
3246
3247fn write_refusal_file(paths: &AppPaths, file: &RootRefusalFile) -> Result<(), ServiceError> {
3248 let path = root_refusal_path(paths);
3249 let failed = |detail: String| ServiceError::Record {
3250 operation: "write",
3251 path: path.clone(),
3252 detail,
3253 };
3254 let text = toml::to_string_pretty(file).map_err(|error| failed(error.to_string()))?;
3255 let directory = path.parent().unwrap_or_else(|| Path::new("."));
3256 std::fs::create_dir_all(directory).map_err(|error| failed(error.to_string()))?;
3257 let temporary = path.with_extension("toml.new");
3258 std::fs::write(&temporary, text).map_err(|error| failed(error.to_string()))?;
3259 std::fs::rename(&temporary, &path).map_err(|error| failed(error.to_string()))
3260}
3261
3262#[must_use]
3264pub fn root_refusal_path(paths: &AppPaths) -> PathBuf {
3265 paths.state_dir().join(ROOT_REFUSAL_FILE)
3266}
3267
3268#[derive(Debug, Clone, PartialEq, Eq)]
3279pub enum BinaryPath {
3280 Current {
3282 path: PathBuf,
3284 },
3285 Missing {
3292 recorded: PathBuf,
3294 },
3295 NotExecutable {
3298 recorded: PathBuf,
3300 detail: String,
3302 },
3303 Diverged {
3305 recorded: PathBuf,
3307 registered: PathBuf,
3309 },
3310}
3311
3312impl BinaryPath {
3313 #[must_use]
3315 pub const fn is_error(&self) -> bool {
3316 !matches!(self, Self::Current { .. })
3317 }
3318
3319 #[must_use]
3321 pub fn recorded(&self) -> &Path {
3322 match self {
3323 Self::Current { path } => path,
3324 Self::Missing { recorded }
3325 | Self::NotExecutable { recorded, .. }
3326 | Self::Diverged { recorded, .. } => recorded,
3327 }
3328 }
3329}
3330
3331impl fmt::Display for BinaryPath {
3332 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
3333 match self {
3334 Self::Current { path } => write!(f, "{}", path.display()),
3335 Self::Missing { recorded } => write!(
3336 f,
3337 "{} -- STALE: nothing is at the recorded path, so the service cannot start. A \
3338 package manager that moved the binary is the usual cause; an `npm i -g` \
3339 installation moves with the active Node version. Run `service install` again \
3340 from the binary that is now installed.",
3341 recorded.display()
3342 ),
3343 Self::NotExecutable { recorded, detail } => write!(
3344 f,
3345 "{} -- STALE: {detail}, so the service cannot start. Run `service install` again \
3346 from the installed binary.",
3347 recorded.display()
3348 ),
3349 Self::Diverged {
3350 recorded,
3351 registered,
3352 } => write!(
3353 f,
3354 "{} -- STALE: the service manager is registered to start {} instead. Something \
3355 has edited the registration since it was installed. Run `service uninstall` and \
3356 `service install`; neither touches configuration, secrets, or the cache.",
3357 recorded.display(),
3358 registered.display()
3359 ),
3360 }
3361 }
3362}
3363
3364#[must_use]
3372pub fn inspect_binary(recorded: &Path, registered: Option<&Path>) -> BinaryPath {
3373 match std::fs::metadata(recorded) {
3374 Err(error) if error.kind() == std::io::ErrorKind::NotFound => {
3375 return BinaryPath::Missing {
3376 recorded: recorded.to_path_buf(),
3377 };
3378 }
3379 Err(error) => {
3380 return BinaryPath::NotExecutable {
3381 recorded: recorded.to_path_buf(),
3382 detail: format!("it cannot be inspected ({error})"),
3383 };
3384 }
3385 Ok(metadata) if !metadata.is_file() => {
3386 return BinaryPath::NotExecutable {
3387 recorded: recorded.to_path_buf(),
3388 detail: "what is there is not a file".to_string(),
3389 };
3390 }
3391 Ok(_) => {}
3392 }
3393 if let Some(registered) = registered
3394 && !same_path_text(&recorded.to_string_lossy(), ®istered.to_string_lossy())
3395 {
3396 return BinaryPath::Diverged {
3397 recorded: recorded.to_path_buf(),
3398 registered: registered.to_path_buf(),
3399 };
3400 }
3401 BinaryPath::Current {
3402 path: recorded.to_path_buf(),
3403 }
3404}
3405
3406#[derive(Debug, Clone, PartialEq, Eq)]
3412pub struct Registration {
3413 pub manager: DefinitionKind,
3418 pub start_mode: StartMode,
3420 pub command_line: String,
3422 pub account: Option<String>,
3424 pub running: bool,
3426 pub starts_automatically: bool,
3433 pub restart_delay: Option<Duration>,
3442}
3443
3444impl Registration {
3445 #[must_use]
3447 pub fn binary(&self) -> Option<PathBuf> {
3448 executable_from_command_line(&self.command_line)
3449 }
3450}
3451
3452pub trait ServiceControl: fmt::Debug {
3458 fn manager(&self) -> DefinitionKind;
3460
3461 fn install(&self, plan: &InstallPlan) -> Result<ServiceDefinition, ServiceError>;
3467
3468 fn uninstall(&self, identity: &ServiceIdentity) -> Result<bool, ServiceError>;
3479
3480 fn query(&self, identity: &ServiceIdentity) -> Result<Option<Registration>, ServiceError>;
3486
3487 fn start(&self, identity: &ServiceIdentity) -> Result<(), ServiceError>;
3494
3495 fn stop(&self, identity: &ServiceIdentity) -> Result<bool, ServiceError>;
3501}
3502
3503pub trait ControlFactory: fmt::Debug + Send + Sync {
3509 fn control(&self, mode: StartMode) -> Result<Box<dyn ServiceControl>, ServiceError>;
3515}
3516
3517#[derive(Debug, Clone, Copy, Default)]
3519pub struct HostControls;
3520
3521#[derive(Debug, Clone)]
3527pub struct Installed {
3528 pub plan: InstallPlan,
3530 pub definition: ServiceDefinition,
3532 pub record: InstallRecord,
3534 pub review: PrivilegeReview,
3536 pub runner_root: RootAccessSummary,
3541 pub replaced_existing: bool,
3549}
3550
3551#[derive(Debug, Clone, PartialEq, Eq)]
3553pub struct Uninstalled {
3554 pub removed_registration: bool,
3556 pub removed_record: bool,
3558 pub removed_definition: Option<PathBuf>,
3560 pub preserved: Vec<PathBuf>,
3567}
3568
3569impl fmt::Display for Uninstalled {
3570 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
3571 if self.removed_registration {
3572 writeln!(f, "The service registration was removed.")?;
3573 } else {
3574 writeln!(f, "There was no service registration to remove.")?;
3575 }
3576 writeln!(f, "Nothing else was deleted. These are untouched:")?;
3577 for path in &self.preserved {
3578 writeln!(f, " {}", path.display())?;
3579 }
3580 write!(
3581 f,
3582 "The stored GitHub token is untouched too; `auth logout` is what purges it."
3583 )
3584 }
3585}
3586
3587#[derive(Debug, Clone, PartialEq, Eq)]
3589pub struct StartModeChange {
3590 pub from: StartMode,
3592 pub to: StartMode,
3594 pub changed: bool,
3596 pub store_scope: crate::secrets::SecretScope,
3599 pub runner_root: RootAccessSummary,
3605}
3606
3607impl fmt::Display for StartModeChange {
3608 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
3609 if !self.changed {
3610 return write!(f, "The service already starts at {}.", self.to);
3611 }
3612 write!(
3613 f,
3614 "The service now starts at {} instead of {}. It reads the {}-scoped secret store; \
3615 if the token was stored under the other scope, run `auth login` again. {}",
3616 self.to, self.from, self.store_scope, self.runner_root
3617 )
3618 }
3619}
3620
3621#[derive(Debug, Clone)]
3629pub struct ServiceOperations {
3630 paths: AppPaths,
3631 identity: ServiceIdentity,
3632 controls: std::sync::Arc<dyn ControlFactory>,
3633 runner_root: Option<LocalAbsolutePath>,
3634}
3635
3636impl ServiceOperations {
3637 #[must_use]
3639 pub fn on_this_host(paths: AppPaths) -> Self {
3640 Self::with_controls(
3641 paths,
3642 ServiceIdentity::product(),
3643 std::sync::Arc::new(HostControls),
3644 )
3645 }
3646
3647 #[must_use]
3655 pub fn with_controls(
3656 paths: AppPaths,
3657 identity: ServiceIdentity,
3658 controls: std::sync::Arc<dyn ControlFactory>,
3659 ) -> Self {
3660 Self {
3661 paths,
3662 identity,
3663 controls,
3664 runner_root: None,
3665 }
3666 }
3667
3668 #[must_use]
3687 pub fn with_runner_root(mut self, root: LocalAbsolutePath) -> Self {
3688 self.runner_root = Some(root);
3689 self
3690 }
3691
3692 #[must_use]
3694 pub const fn paths(&self) -> &AppPaths {
3695 &self.paths
3696 }
3697
3698 #[must_use]
3700 pub const fn identity(&self) -> &ServiceIdentity {
3701 &self.identity
3702 }
3703
3704 pub fn install(&self, request: &InstallRequest) -> Result<Installed, ServiceError> {
3724 self.paths
3725 .create_all()
3726 .map_err(|source| ServiceError::Paths {
3727 source: Box::new(source),
3728 })?;
3729
3730 let _guard = self.refuse_while_an_agent_runs()?;
3733
3734 let (replacing, previous_was_running) = match self.find_registration()? {
3763 Some((existing, registration)) if existing == request.start_mode() => {
3764 (true, registration.running)
3765 }
3766 Some((existing, _)) => {
3767 return Err(ServiceError::AlreadyInstalled {
3768 name: self.identity.name().to_string(),
3769 existing,
3770 requested: request.start_mode(),
3771 });
3772 }
3773 None => (false, false),
3774 };
3775
3776 let plan = InstallPlan::resolve(
3777 self.identity.clone(),
3778 request,
3779 ServiceDirectories::of(&self.paths),
3780 )?;
3781
3782 let control = self.controls.control(plan.start_mode())?;
3787
3788 let root = self.prepare_runner_root(plan.start_mode())?;
3794
3795 let previous = if replacing {
3800 InstallRecord::read(&self.paths).ok().flatten()
3801 } else {
3802 None
3803 };
3804 if replacing && let Err(cause) = control.uninstall(&self.identity) {
3805 return Err(undo_runner_root(&root, "install", &self.identity, cause));
3806 }
3807
3808 let definition = match control.install(&plan) {
3809 Ok(definition) => definition,
3810 Err(cause) => {
3811 let restored =
3814 self.reinstate(control.as_ref(), previous.as_ref(), previous_was_running);
3815 return Err(rolled_back(
3816 retained_runner_root(&root),
3817 restored,
3818 "install",
3819 &self.identity,
3820 cause,
3821 ));
3822 }
3823 };
3824 let review = review_least_privilege(&definition, &plan);
3825 let record = InstallRecord::of(&plan, &definition, Utc::now());
3826 if let Err(cause) = record.write(&self.paths) {
3827 let rollback = control
3828 .uninstall(&self.identity)
3829 .map(|_| ())
3830 .and_then(|()| {
3831 self.reinstate(control.as_ref(), previous.as_ref(), previous_was_running)
3832 });
3833 return Err(rolled_back(
3834 retained_runner_root(&root),
3835 rollback,
3836 "install",
3837 &self.identity,
3838 cause,
3839 ));
3840 }
3841
3842 if let Err(cause) = control.start(&self.identity) {
3849 let remove_new = control.uninstall(&self.identity).map(|_| ());
3850 let restore_registration = remove_new.and_then(|()| {
3851 self.reinstate(control.as_ref(), previous.as_ref(), previous_was_running)
3852 });
3853 let restore_record = restore_registration.and_then(|()| match &previous {
3854 Some(previous) => previous.write(&self.paths),
3855 None => InstallRecord::remove(&self.paths).map(|_| ()),
3856 });
3857 return Err(rolled_back(
3858 retained_runner_root(&root),
3859 restore_record,
3860 "install and start",
3861 &self.identity,
3862 cause,
3863 ));
3864 }
3865 Ok(Installed {
3866 plan,
3867 definition,
3868 record,
3869 review,
3870 runner_root: root.summary().clone(),
3871 replaced_existing: replacing,
3872 })
3873 }
3874
3875 fn reinstate(
3886 &self,
3887 control: &dyn ServiceControl,
3888 previous: Option<&InstallRecord>,
3889 was_running: bool,
3890 ) -> Result<(), ServiceError> {
3891 let Some(record) = previous else {
3892 return Ok(());
3893 };
3894 let plan = InstallPlan::unchecked(
3895 self.identity.clone(),
3896 record.start_mode,
3897 record.binary.clone(),
3898 record.directories.clone(),
3899 )
3900 .with_arguments(record.arguments.clone())
3901 .with_restart(record.restart());
3902 let plan = if record.starts_on_demand {
3903 plan.started_on_demand()
3904 } else {
3905 plan
3906 };
3907 let plan = match crate::secrets::PlatformSecretStore::for_start_mode(record.start_mode) {
3908 Ok(store) => plan.with_secret_guard(store.guard()),
3909 Err(_) => plan,
3910 };
3911 control.install(&plan)?;
3912 if was_running {
3913 control.start(&self.identity)?;
3914 }
3915 Ok(())
3916 }
3917
3918 pub fn uninstall(&self) -> Result<Uninstalled, ServiceError> {
3927 let record = InstallRecord::read(&self.paths).ok().flatten();
3928 let removed_definition = record
3929 .as_ref()
3930 .and_then(|record| record.definition_path.clone());
3931
3932 let mut removed_registration = false;
3933 for mode in [StartMode::Boot, StartMode::Login] {
3937 let control = self.controls.control(mode)?;
3938 if control.uninstall(&self.identity)? {
3939 removed_registration = true;
3940 }
3941 }
3942 let removed_record = InstallRecord::remove(&self.paths)?;
3943 Ok(Uninstalled {
3944 removed_registration,
3945 removed_record,
3946 removed_definition: removed_definition.filter(|_| removed_registration),
3947 preserved: self
3948 .paths
3949 .all()
3950 .iter()
3951 .map(|(_, path)| (*path).to_path_buf())
3952 .collect(),
3953 })
3954 }
3955
3956 pub fn set_start_mode(&self, to: StartMode) -> Result<StartModeChange, ServiceError> {
3978 let Some(record) = InstallRecord::read(&self.paths)? else {
3979 return Err(ServiceError::NotInstalled {
3980 name: self.identity.name().to_string(),
3981 operation: "switch the start mode of",
3982 });
3983 };
3984 let from = record.start_mode;
3985 if from == to {
3986 return Ok(StartModeChange {
3990 from,
3991 to,
3992 changed: false,
3993 store_scope: crate::secrets::SecretScope::for_start_mode(to),
3994 runner_root: RootAccessSummary::NotApplicable,
3995 });
3996 }
3997
3998 #[cfg(windows)]
3999 let arguments = {
4000 let mut arguments = record.arguments.clone();
4001 arguments.retain(|argument| argument != WINDOWS_SCM_HOST_ARGUMENT);
4002 if to == StartMode::Boot {
4003 arguments.push(WINDOWS_SCM_HOST_ARGUMENT.to_string());
4004 }
4005 arguments
4006 };
4007 #[cfg(not(windows))]
4008 let arguments = record.arguments.clone();
4009 let plan = InstallPlan::unchecked(
4010 self.identity.clone(),
4011 to,
4012 record.binary.clone(),
4013 record.directories.clone(),
4014 )
4015 .with_arguments(arguments)
4016 .with_restart(record.restart());
4017 let plan = if record.starts_on_demand {
4018 plan.started_on_demand()
4019 } else {
4020 plan
4021 };
4022 let plan = match crate::secrets::PlatformSecretStore::for_start_mode(to) {
4023 Ok(store) => plan.with_secret_guard(store.guard()),
4024 Err(_) => plan,
4025 };
4026
4027 let target = self.controls.control(to)?;
4034 let previous = self.controls.control(from)?;
4039
4040 let root = self.prepare_runner_root(to)?;
4048
4049 let definition = match target.install(&plan) {
4050 Ok(definition) => definition,
4051 Err(cause) => {
4052 return Err(undo_runner_root(
4053 &root,
4054 "switch start mode",
4055 &self.identity,
4056 cause,
4057 ));
4058 }
4059 };
4060 let next_record = InstallRecord::of(&plan, &definition, record.installed_at);
4061 if let Err(cause) = next_record.write(&self.paths) {
4062 return Err(rolled_back(
4063 retained_runner_root(&root),
4064 target.uninstall(&self.identity),
4065 "switch start mode",
4066 &self.identity,
4067 cause,
4068 ));
4069 }
4070
4071 if let Err(cause) = previous.uninstall(&self.identity) {
4075 let target_rollback = target.uninstall(&self.identity);
4076 let record_rollback = record.write(&self.paths);
4077 return Err(rolled_back(
4078 retained_runner_root(&root),
4079 target_rollback.and(record_rollback),
4080 "switch start mode",
4081 &self.identity,
4082 cause,
4083 ));
4084 }
4085 Ok(StartModeChange {
4086 from,
4087 to,
4088 changed: true,
4089 store_scope: crate::secrets::SecretScope::for_start_mode(to),
4090 runner_root: root.summary().clone(),
4091 })
4092 }
4093
4094 pub fn start(&self) -> Result<(), ServiceError> {
4100 let Some((mode, _)) = self.find_registration()? else {
4101 return Err(ServiceError::NotInstalled {
4102 name: self.identity.name().to_string(),
4103 operation: "start",
4104 });
4105 };
4106 self.controls.control(mode)?.start(&self.identity)
4107 }
4108
4109 pub fn stop(&self) -> Result<bool, ServiceError> {
4115 let Some((mode, _)) = self.find_registration()? else {
4116 return Err(ServiceError::NotInstalled {
4117 name: self.identity.name().to_string(),
4118 operation: "stop",
4119 });
4120 };
4121 self.controls.control(mode)?.stop(&self.identity)
4122 }
4123
4124 pub fn status(&self) -> Result<ServiceStatus, ServiceError> {
4143 let (record, record_refused) = match InstallRecord::read(&self.paths) {
4144 Ok(record) => (record, None),
4145 Err(refusal @ ServiceError::RecordNotPermitted { .. }) => (None, Some(refusal)),
4146 Err(error) => return Err(error),
4147 };
4148 let found = self.find_registration()?;
4149 let last_github_contact = last_github_contact(&self.paths)?;
4150 Ok(ServiceStatus::compose(
4151 self.identity.clone(),
4152 record,
4153 record_refused.as_ref(),
4154 found.map(|(_, registration)| registration),
4155 last_github_contact,
4156 &self.paths,
4157 ))
4158 }
4159
4160 fn prepare_runner_root(&self, mode: StartMode) -> Result<RootAccessChange, ServiceError> {
4170 #[cfg(not(windows))]
4171 {
4172 let _ = (mode, &self.runner_root);
4175 Ok(RootAccessChange::not_applicable())
4176 }
4177 #[cfg(windows)]
4178 {
4179 let wrap = |source| ServiceError::RunnerRoot {
4180 source: Box::new(source),
4181 };
4182 if let Some(root) = self
4200 .runner_root
4201 .as_ref()
4202 .filter(|_| self.identity.is_fixture() || cfg!(test))
4203 {
4204 let admission = RootAdmission::of_this_account().map_err(wrap)?;
4205 return crate::runner_root_access::reconcile(&self.paths, root, &admission)
4206 .map_err(wrap);
4207 }
4208
4209 let admission = match ServiceAccount::for_start_mode(mode) {
4210 ServiceAccount::LocalSystem => RootAdmission::LocalSystem,
4213 ServiceAccount::InvokingUser | ServiceAccount::Root => {
4217 RootAdmission::of_this_account().map_err(wrap)?
4218 }
4219 };
4220 crate::runner_root_access::ensure_default_root(&self.paths, &admission).map_err(wrap)
4221 }
4222 }
4223
4224 fn refuse_while_an_agent_runs(&self) -> Result<HostLock, ServiceError> {
4226 HostLock::try_acquire(&self.paths, LockKind::SingleInstance).map_err(
4227 |source| match source {
4228 held @ LockError::Held { .. } => ServiceError::LockHeld {
4229 source: Box::new(held),
4230 },
4231 other => ServiceError::LockUnreadable {
4232 source: Box::new(other),
4233 },
4234 },
4235 )
4236 }
4237
4238 fn find_registration(&self) -> Result<Option<(StartMode, Registration)>, ServiceError> {
4240 for mode in [StartMode::Boot, StartMode::Login] {
4241 let control = self.controls.control(mode)?;
4242 if let Some(registration) = control.query(&self.identity)? {
4243 return Ok(Some((registration.start_mode, registration)));
4244 }
4245 }
4246 Ok(None)
4247 }
4248}
4249
4250#[derive(Debug, Clone, PartialEq, Eq)]
4256pub struct StatusProblem {
4257 pub subject: &'static str,
4259 pub detail: String,
4261}
4262
4263impl fmt::Display for StatusProblem {
4264 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
4265 write!(f, "{}: {}", self.subject, self.detail)
4266 }
4267}
4268
4269#[derive(Debug, Clone)]
4278pub struct ServiceStatus {
4279 identity: ServiceIdentity,
4280 record: Option<InstallRecord>,
4281 registration: Option<Registration>,
4282 binary: Option<BinaryPath>,
4283 log_file: PathBuf,
4284 store: Option<crate::secrets::ActiveStore>,
4285 last_github_contact: Option<DateTime<Utc>>,
4286 runner_root: Option<(PathBuf, RootAccessReport)>,
4287 problems: Vec<StatusProblem>,
4288 notes: Vec<String>,
4289}
4290
4291impl ServiceStatus {
4292 fn compose(
4297 identity: ServiceIdentity,
4298 record: Option<InstallRecord>,
4299 record_refused: Option<&ServiceError>,
4300 registration: Option<Registration>,
4301 last_github_contact: Option<DateTime<Utc>>,
4302 paths: &AppPaths,
4303 ) -> Self {
4304 let mut problems = Vec::new();
4305 let mut notes = Vec::new();
4306
4307 if let Some(refusal) = record_refused {
4308 problems.push(StatusProblem {
4313 subject: "install record",
4314 detail: refusal.to_string(),
4315 });
4316 }
4317
4318 let log_file = record.as_ref().map_or_else(
4319 || ServiceDirectories::of(paths).log_file(),
4320 |record| record.log_file.clone(),
4321 );
4322
4323 let binary = record.as_ref().map(|record| {
4324 inspect_binary(
4325 &record.binary,
4326 registration
4327 .as_ref()
4328 .and_then(Registration::binary)
4329 .as_deref(),
4330 )
4331 });
4332 if let Some(state) = &binary
4333 && state.is_error()
4334 {
4335 problems.push(StatusProblem {
4336 subject: "binary",
4337 detail: state.to_string(),
4338 });
4339 }
4340
4341 match (&record, ®istration) {
4342 (Some(_), None) => problems.push(StatusProblem {
4343 subject: "registration",
4344 detail: "this host has a service record but no service manager knows the \
4345 registration. Run `service install` again; it deletes nothing."
4346 .to_string(),
4347 }),
4348 (None, Some(found)) if record_refused.is_none() => problems.push(StatusProblem {
4353 subject: "record",
4354 detail: format!(
4355 "{} holds a registration for this service but there is no install record, so \
4356 the path it was installed from and the directories it was installed against \
4357 are unknown. Run `service uninstall` and `service install`.",
4358 found.manager
4359 ),
4360 }),
4361 (None, Some(_)) => {}
4362 (Some(record), Some(found)) => {
4363 if record.start_mode != found.start_mode {
4364 problems.push(StatusProblem {
4365 subject: "start mode",
4366 detail: format!(
4367 "the record says {} and {} holds a {} registration. Switch the start \
4368 mode again to make them agree.",
4369 record.start_mode, found.manager, found.start_mode
4370 ),
4371 });
4372 }
4373 if record.start_mode == StartMode::Boot && !found.starts_automatically {
4374 problems.push(StatusProblem {
4375 subject: "start mode",
4376 detail: format!(
4377 "{} holds the registration but will not start it by itself, so this \
4378 host does not resume work after a reboot.",
4379 found.manager
4380 ),
4381 });
4382 }
4383 if let Some(actual) = found.restart_delay {
4384 let expected = record.restart().effective_delay(found.manager);
4385 if actual != expected {
4386 problems.push(StatusProblem {
4387 subject: "restart policy",
4388 detail: format!(
4389 "the record says the service restarts after {}s and {} reports \
4390 {}s. Something has edited the registration since it was \
4391 installed.",
4392 expected.as_secs(),
4393 found.manager,
4394 actual.as_secs()
4395 ),
4396 });
4397 } else if expected != record.restart().delay() {
4398 notes.push(format!(
4403 "{} expresses the restart delay in whole minutes, so the {}s asked \
4404 for is enforced as {}s. The service therefore never restarts faster \
4405 than the configured bound.",
4406 found.manager,
4407 record.restart().delay().as_secs(),
4408 expected.as_secs()
4409 ));
4410 }
4411 }
4412 if found.starts_automatically && !found.running {
4413 problems.push(StatusProblem {
4414 subject: "runtime",
4415 detail: format!(
4416 "{} holds an automatic registration, but the daemon is stopped. Run \
4417 `runner-manager service start`; if it stops again, inspect {}.",
4418 found.manager,
4419 log_file.display()
4420 ),
4421 });
4422 }
4423 }
4424 (None, None) => {}
4425 }
4426
4427 let store = record.as_ref().and_then(|record| {
4432 let registered_mode = registration
4433 .as_ref()
4434 .map_or(record.start_mode, |found| found.start_mode);
4435 crate::secrets::PlatformSecretStore::for_start_mode(record.start_mode)
4436 .ok()
4437 .map(|store| crate::secrets::ActiveStore::of(&store, registered_mode))
4438 });
4439 if let Some(store) = &store
4440 && !store.agrees_with_start_mode()
4441 {
4442 problems.push(StatusProblem {
4443 subject: "secret store",
4444 detail: format!(
4445 "{store}. Run `auth login` again so the token is stored where the registered \
4446 start mode can read it."
4447 ),
4448 });
4449 }
4450
4451 if record.as_ref().map(|record| record.start_mode) == Some(StartMode::Login) {
4452 notes.push(
4453 "This registration starts at login, so the agent does not run until the operator \
4454 signs in; this host does not resume work after an unattended reboot."
4455 .to_string(),
4456 );
4457 }
4458 if last_github_contact.is_none() {
4459 notes.push(
4460 "GitHub has not been reached successfully since this host's state directory was \
4461 created."
4462 .to_string(),
4463 );
4464 }
4465
4466 let runner_root = crate::runner_root::default_runner_root(paths)
4473 .ok()
4474 .map(|root| {
4475 let path = root.as_path().to_path_buf();
4476 let report = crate::runner_root_access::report(&path);
4477 (path, report)
4478 });
4479 if let Some((
4489 path,
4490 RootAccessReport::Present {
4491 broad_write: true, ..
4492 },
4493 )) = &runner_root
4494 {
4495 notes.push(format!(
4496 "the platform default runner root {} can be written by ordinary local users, so \
4497 it is not a safe place to run jobs. `service install` refuses it rather than \
4498 tightening it, because the contents of a directory anybody could write cannot \
4499 be trusted: remove or empty it, or choose another root with `runner-manager \
4500 host set-runtime-root --path <PATH>`.",
4501 path.display()
4502 ));
4503 }
4504
4505 match runner_root_refusals(paths) {
4528 Ok(refusals) => {
4529 for refusal in refusals {
4530 notes.push(format!(
4531 "policy {} started no runner: its runner root {} refused the launch \
4532 ({}), last at {}. {} This clears when that policy next places a \
4533 runner.",
4534 refusal.policy,
4535 refusal.root,
4536 refusal.kind,
4537 refusal.at.to_rfc3339(),
4538 refusal.detail,
4539 ));
4540 }
4541 }
4542 Err(error) => notes.push(format!(
4543 "whether the agent could use its runner roots could not be read: {error}"
4544 )),
4545 }
4546
4547 Self {
4548 identity,
4549 record,
4550 registration,
4551 binary,
4552 log_file,
4553 store,
4554 last_github_contact,
4555 runner_root,
4556 problems,
4557 notes,
4558 }
4559 }
4560
4561 #[must_use]
4569 pub fn runner_root(&self) -> Option<(&Path, &RootAccessReport)> {
4570 self.runner_root
4571 .as_ref()
4572 .map(|(path, report)| (path.as_path(), report))
4573 }
4574
4575 #[must_use]
4577 pub const fn is_installed(&self) -> bool {
4578 self.registration.is_some() || self.record.is_some()
4579 }
4580
4581 #[must_use]
4583 pub fn is_running(&self) -> bool {
4584 self.registration
4585 .as_ref()
4586 .is_some_and(|registration| registration.running)
4587 }
4588
4589 #[must_use]
4591 pub fn is_healthy(&self) -> bool {
4592 self.problems.is_empty()
4593 }
4594
4595 #[must_use]
4597 pub fn problems(&self) -> &[StatusProblem] {
4598 &self.problems
4599 }
4600
4601 #[must_use]
4604 pub fn notes(&self) -> &[String] {
4605 &self.notes
4606 }
4607
4608 #[must_use]
4610 pub fn start_mode(&self) -> Option<StartMode> {
4611 self.record.as_ref().map(|record| record.start_mode)
4612 }
4613
4614 #[must_use]
4617 pub const fn binary(&self) -> Option<&BinaryPath> {
4618 self.binary.as_ref()
4619 }
4620
4621 #[must_use]
4623 pub fn log_file(&self) -> &Path {
4624 &self.log_file
4625 }
4626
4627 #[must_use]
4629 pub const fn last_github_contact(&self) -> Option<DateTime<Utc>> {
4630 self.last_github_contact
4631 }
4632
4633 #[must_use]
4636 pub const fn secret_store(&self) -> Option<&crate::secrets::ActiveStore> {
4637 self.store.as_ref()
4638 }
4639
4640 #[must_use]
4642 pub const fn record(&self) -> Option<&InstallRecord> {
4643 self.record.as_ref()
4644 }
4645
4646 #[must_use]
4648 pub const fn registration(&self) -> Option<&Registration> {
4649 self.registration.as_ref()
4650 }
4651}
4652
4653impl fmt::Display for ServiceStatus {
4654 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
4655 writeln!(f, "Service: {}", self.identity)?;
4656 match (&self.record, &self.registration) {
4657 (None, None) => {
4658 writeln!(
4659 f,
4660 " installed no. `service install` registers `{} {}`.",
4661 SERVICE_NAME,
4662 DAEMON_ARGUMENTS.join(" ")
4663 )?;
4664 }
4665 _ => {
4666 let manager = self
4667 .registration
4668 .as_ref()
4669 .map(|registration| registration.manager.manager());
4670 writeln!(
4671 f,
4672 " installed {}",
4673 manager.unwrap_or("yes, but no service manager knows it")
4674 )?;
4675 writeln!(
4676 f,
4677 " state {}",
4678 if self.is_running() {
4679 "running"
4680 } else {
4681 "not running"
4682 }
4683 )?;
4684 }
4685 }
4686 if let Some(record) = &self.record {
4687 writeln!(f, " start mode {}", record.start_mode)?;
4688 writeln!(f, " account {}", record.account)?;
4689 writeln!(f, " restart on failure {}", record.restart())?;
4690 writeln!(
4691 f,
4692 " arguments {}",
4693 record.arguments.join(" ")
4694 )?;
4695 }
4696 if let Some(binary) = &self.binary {
4697 writeln!(f, " binary {binary}")?;
4698 }
4699 writeln!(f, " diagnostic log {}", self.log_file.display())?;
4700 if let Some((path, report)) = &self.runner_root {
4701 writeln!(f, " default runner root {}", path.display())?;
4708 if *report != RootAccessReport::NotApplicable {
4709 writeln!(f, " default root access {report}")?;
4710 }
4711 }
4712 if let Some(store) = &self.store {
4713 writeln!(f, " secret store {store}")?;
4714 }
4715 writeln!(
4716 f,
4717 " last GitHub contact {}",
4718 match self.last_github_contact {
4719 Some(at) => at.to_rfc3339(),
4720 None => "never".to_string(),
4721 }
4722 )?;
4723 for note in &self.notes {
4724 writeln!(f, " note {note}")?;
4725 }
4726 for problem in &self.problems {
4727 writeln!(f, " ERROR {problem}")?;
4728 }
4729 write!(
4730 f,
4731 " verdict {}",
4732 if self.is_healthy() {
4733 "healthy"
4734 } else {
4735 "NOT healthy"
4736 }
4737 )
4738 }
4739}
4740
4741#[derive(Debug, Clone, Default)]
4758pub struct RecordingControls {
4759 state: std::sync::Arc<std::sync::Mutex<RecordingState>>,
4760}
4761
4762#[derive(Debug, Default)]
4763struct RecordingState {
4764 registrations: BTreeMap<(StartMode, String), Registration>,
4765 definitions: BTreeMap<String, ServiceDefinition>,
4766 calls: Vec<String>,
4767 #[cfg(test)]
4768 install_failures: BTreeMap<StartMode, String>,
4769 #[cfg(test)]
4770 after_install: BTreeMap<StartMode, TestInstallSideEffect>,
4771}
4772
4773#[cfg(test)]
4774#[derive(Debug, Clone)]
4775enum TestInstallSideEffect {
4776 HideDirectory { directory: PathBuf, hidden: PathBuf },
4777}
4778
4779impl RecordingControls {
4780 #[must_use]
4782 pub fn new() -> Self {
4783 Self::default()
4784 }
4785
4786 #[must_use]
4789 pub fn calls(&self) -> Vec<String> {
4790 self.state.lock().expect("not poisoned").calls.clone()
4791 }
4792
4793 #[must_use]
4795 pub fn registrations(&self) -> Vec<(StartMode, String, Registration)> {
4796 self.state
4797 .lock()
4798 .expect("not poisoned")
4799 .registrations
4800 .iter()
4801 .map(|((mode, name), registration)| (*mode, name.clone(), registration.clone()))
4802 .collect()
4803 }
4804
4805 #[must_use]
4807 pub fn definition(&self, name: &str) -> Option<ServiceDefinition> {
4808 self.state
4809 .lock()
4810 .expect("not poisoned")
4811 .definitions
4812 .get(name)
4813 .cloned()
4814 }
4815
4816 pub fn edit(&self, name: &str, edit: impl FnOnce(&mut Registration)) {
4826 let mut state = self.state.lock().expect("not poisoned");
4827 if let Some((_, registration)) = state
4828 .registrations
4829 .iter_mut()
4830 .find(|((_, held), _)| held == name)
4831 {
4832 edit(registration);
4833 }
4834 }
4835
4836 #[cfg(test)]
4837 fn fail_next_install(&self, mode: StartMode, detail: &str) {
4838 self.state
4839 .lock()
4840 .expect("not poisoned")
4841 .install_failures
4842 .insert(mode, detail.to_string());
4843 }
4844
4845 #[cfg(test)]
4846 fn hide_directory_after_install(&self, mode: StartMode, directory: PathBuf, hidden: PathBuf) {
4847 self.state
4848 .lock()
4849 .expect("not poisoned")
4850 .after_install
4851 .insert(
4852 mode,
4853 TestInstallSideEffect::HideDirectory { directory, hidden },
4854 );
4855 }
4856}
4857
4858impl ControlFactory for RecordingControls {
4859 fn control(&self, mode: StartMode) -> Result<Box<dyn ServiceControl>, ServiceError> {
4860 Ok(Box::new(RecordingControl {
4861 mode,
4862 state: std::sync::Arc::clone(&self.state),
4863 }))
4864 }
4865}
4866
4867#[derive(Debug)]
4868struct RecordingControl {
4869 mode: StartMode,
4870 state: std::sync::Arc<std::sync::Mutex<RecordingState>>,
4871}
4872
4873impl RecordingControl {
4874 fn note(&self, operation: &str, name: &str) {
4875 self.state
4876 .lock()
4877 .expect("not poisoned")
4878 .calls
4879 .push(format!("{operation} {name} ({})", self.mode));
4880 }
4881}
4882
4883impl ServiceControl for RecordingControl {
4884 fn manager(&self) -> DefinitionKind {
4885 host_definition_kind(self.mode)
4889 }
4890
4891 fn install(&self, plan: &InstallPlan) -> Result<ServiceDefinition, ServiceError> {
4892 self.note("install", plan.identity().name());
4893 #[cfg(test)]
4894 if let Some(detail) = self
4895 .state
4896 .lock()
4897 .expect("not poisoned")
4898 .install_failures
4899 .remove(&self.mode)
4900 {
4901 return Err(ServiceError::Control {
4902 operation: "install",
4903 name: plan.identity().name().to_string(),
4904 manager: "recording control",
4905 detail,
4906 });
4907 }
4908 let definition = ServiceDefinition::for_host(plan)?;
4913 let mut state = self.state.lock().expect("not poisoned");
4914 state.registrations.insert(
4915 (self.mode, plan.identity().name().to_string()),
4916 Registration {
4917 manager: host_definition_kind(self.mode),
4918 start_mode: self.mode,
4919 command_line: plan.command_line(),
4920 account: Some(plan.account().as_str().to_string()),
4921 running: false,
4922 starts_automatically: true,
4923 restart_delay: Some(plan.restart().delay()),
4924 },
4925 );
4926 state
4927 .definitions
4928 .insert(plan.identity().name().to_string(), definition.clone());
4929 #[cfg(test)]
4930 let side_effect = state.after_install.remove(&self.mode);
4931 drop(state);
4932 #[cfg(test)]
4933 if let Some(TestInstallSideEffect::HideDirectory { directory, hidden }) = side_effect {
4934 std::fs::rename(&directory, &hidden).expect("test fault can hide the record directory");
4935 std::fs::write(&directory, b"blocks recreation")
4936 .expect("test fault can block record directory recreation");
4937 }
4938 Ok(definition)
4939 }
4940
4941 fn uninstall(&self, identity: &ServiceIdentity) -> Result<bool, ServiceError> {
4942 self.note("uninstall", identity.name());
4943 let mut state = self.state.lock().expect("not poisoned");
4944 state.definitions.remove(identity.name());
4945 Ok(state
4946 .registrations
4947 .remove(&(self.mode, identity.name().to_string()))
4948 .is_some())
4949 }
4950
4951 fn query(&self, identity: &ServiceIdentity) -> Result<Option<Registration>, ServiceError> {
4952 self.note("query", identity.name());
4953 Ok(self
4954 .state
4955 .lock()
4956 .expect("not poisoned")
4957 .registrations
4958 .get(&(self.mode, identity.name().to_string()))
4959 .cloned())
4960 }
4961
4962 fn start(&self, identity: &ServiceIdentity) -> Result<(), ServiceError> {
4963 self.note("start", identity.name());
4964 let mut state = self.state.lock().expect("not poisoned");
4965 match state
4966 .registrations
4967 .get_mut(&(self.mode, identity.name().to_string()))
4968 {
4969 Some(registration) => {
4970 registration.running = true;
4971 Ok(())
4972 }
4973 None => Err(ServiceError::NotInstalled {
4974 name: identity.name().to_string(),
4975 operation: "start",
4976 }),
4977 }
4978 }
4979
4980 fn stop(&self, identity: &ServiceIdentity) -> Result<bool, ServiceError> {
4981 self.note("stop", identity.name());
4982 let mut state = self.state.lock().expect("not poisoned");
4983 match state
4984 .registrations
4985 .get_mut(&(self.mode, identity.name().to_string()))
4986 {
4987 Some(registration) => Ok(std::mem::replace(&mut registration.running, false)),
4988 None => Err(ServiceError::NotInstalled {
4989 name: identity.name().to_string(),
4990 operation: "stop",
4991 }),
4992 }
4993 }
4994}
4995
4996impl ControlFactory for HostControls {
4997 fn control(&self, mode: StartMode) -> Result<Box<dyn ServiceControl>, ServiceError> {
4998 sys::control(mode)
4999 }
5000}
5001
5002fn host_home() -> Option<PathBuf> {
5009 directories::BaseDirs::new().map(|dirs| dirs.home_dir().to_path_buf())
5010}
5011
5012#[cfg(unix)]
5014fn home_directory() -> Option<PathBuf> {
5015 host_home()
5016}
5017
5018fn run(program: &str, arguments: &[&std::ffi::OsStr]) -> std::io::Result<(bool, String, String)> {
5027 let output = std::process::Command::new(program)
5028 .args(arguments)
5029 .output()?;
5030 Ok((
5031 output.status.success(),
5032 String::from_utf8_lossy(&output.stdout).into_owned(),
5033 String::from_utf8_lossy(&output.stderr).into_owned(),
5034 ))
5035}
5036
5037#[must_use]
5040pub const fn host_definition_kind(mode: StartMode) -> DefinitionKind {
5041 if cfg!(windows) {
5042 match mode {
5043 StartMode::Boot => DefinitionKind::WindowsService,
5044 StartMode::Login => DefinitionKind::WindowsScheduledTask,
5045 }
5046 } else if cfg!(target_os = "macos") {
5047 DefinitionKind::LaunchdPlist
5048 } else {
5049 DefinitionKind::SystemdUnit
5050 }
5051}
5052
5053#[cfg(any(target_os = "macos", test))]
5060fn enable_launchd_registration(
5061 mut launchctl: impl FnMut(&[&std::ffi::OsStr]) -> (bool, String),
5062 domain: &str,
5063 service_target: &str,
5064 plist: &Path,
5065 name: &str,
5066 elevation_remedy: &'static str,
5067) -> Result<(), ServiceError> {
5068 let (enabled, cause) = launchctl(&[
5069 std::ffi::OsStr::new("enable"),
5070 std::ffi::OsStr::new(service_target),
5071 ]);
5072 if enabled {
5073 return Ok(());
5074 }
5075
5076 let (booted_out, bootout_detail) = launchctl(&[
5077 std::ffi::OsStr::new("bootout"),
5078 std::ffi::OsStr::new(service_target),
5079 ]);
5080 let removed = std::fs::remove_file(plist);
5081 if !booted_out || removed.is_err() {
5082 return Err(ServiceError::Rollback {
5083 operation: "enable launchd registration",
5084 name: name.to_string(),
5085 cause,
5086 rollback: format!(
5087 "launchctl bootout {domain}: {}; remove {}: {}",
5088 if booted_out {
5089 "succeeded".to_string()
5090 } else {
5091 bootout_detail
5092 },
5093 plist.display(),
5094 removed
5095 .err()
5096 .map_or_else(|| "succeeded".to_string(), |error| error.to_string())
5097 ),
5098 });
5099 }
5100
5101 if cause.to_ascii_lowercase().contains("permission denied") {
5102 Err(ServiceError::NeedsElevation {
5103 operation: "enable",
5104 name: name.to_string(),
5105 detail: cause,
5106 remedy: elevation_remedy,
5107 })
5108 } else {
5109 Err(ServiceError::Control {
5110 operation: "enable",
5111 name: name.to_string(),
5112 manager: "launchd",
5113 detail: cause,
5114 })
5115 }
5116}
5117
5118#[derive(Debug, Clone)]
5127pub struct ServiceShutdown(tokio::sync::watch::Receiver<bool>);
5128
5129impl ServiceShutdown {
5130 pub async fn wait(mut self) {
5132 if !*self.0.borrow() {
5133 let _ = self.0.changed().await;
5134 }
5135 }
5136}
5137
5138#[cfg(windows)]
5145pub fn run_windows_service_host<F>(run: F) -> Result<u8, ServiceError>
5146where
5147 F: FnOnce(ServiceShutdown) -> u8 + Send + 'static,
5148{
5149 windows_host::run(Box::new(run))
5150}
5151
5152#[cfg(windows)]
5153mod windows_host {
5154 use std::ffi::OsString;
5155 use std::sync::{Arc, Mutex, OnceLock, mpsc};
5156 use std::time::Duration;
5157
5158 use windows_service::service::{
5159 ServiceControl, ServiceControlAccept, ServiceExitCode, ServiceState, ServiceStatus,
5160 ServiceType,
5161 };
5162 use windows_service::service_control_handler::{
5163 self, ServiceControlHandlerResult, ServiceStatusHandle,
5164 };
5165
5166 use super::{SERVICE_NAME, ServiceError, ServiceShutdown};
5167
5168 type Runner = Box<dyn FnOnce(ServiceShutdown) -> u8 + Send>;
5169
5170 struct Invocation {
5171 run: Runner,
5172 result: mpsc::SyncSender<Result<u8, String>>,
5173 }
5174
5175 static INVOCATION: OnceLock<Mutex<Option<Invocation>>> = OnceLock::new();
5176
5177 windows_service::define_windows_service!(ffi_service_main, service_main);
5178
5179 pub(super) fn run(run: Runner) -> Result<u8, ServiceError> {
5180 let (result_tx, result_rx) = mpsc::sync_channel(1);
5181 let slot = INVOCATION.get_or_init(|| Mutex::new(None));
5182 let mut invocation = slot
5183 .lock()
5184 .map_err(|_| host_error("prepare", "the service-host slot is poisoned"))?;
5185 if invocation.is_some() {
5186 return Err(host_error(
5187 "prepare",
5188 "the service-host slot was already used",
5189 ));
5190 }
5191 *invocation = Some(Invocation {
5192 run,
5193 result: result_tx,
5194 });
5195 drop(invocation);
5196
5197 windows_service::service_dispatcher::start("", ffi_service_main)
5198 .map_err(|error| host_error("connect", &error.to_string()))?;
5199 result_rx
5200 .recv()
5201 .map_err(|error| host_error("finish", &error.to_string()))?
5202 .map_err(|detail| host_error("run", &detail))
5203 }
5204
5205 fn service_main(_arguments: Vec<OsString>) {
5206 let Some(invocation) = INVOCATION.get().and_then(|slot| slot.lock().ok()?.take()) else {
5207 return;
5208 };
5209 let result = run_service(invocation.run);
5210 let _ = invocation.result.send(result);
5211 }
5212
5213 fn run_service(run: Runner) -> Result<u8, String> {
5214 let (stop_tx, stop_rx) = tokio::sync::watch::channel(false);
5215 let status: Arc<Mutex<Option<ServiceStatusHandle>>> = Arc::new(Mutex::new(None));
5216 let handler_status = Arc::clone(&status);
5217 let handler = move |control| match control {
5218 ServiceControl::Interrogate => ServiceControlHandlerResult::NoError,
5219 ServiceControl::Stop | ServiceControl::Shutdown => {
5220 if let Some(handle) = handler_status.lock().ok().and_then(|guard| *guard) {
5221 let _ = handle.set_service_status(service_status(
5222 ServiceState::StopPending,
5223 ServiceControlAccept::empty(),
5224 1,
5225 Duration::from_secs(300),
5226 0,
5227 ));
5228 }
5229 let _ = stop_tx.send(true);
5230 ServiceControlHandlerResult::NoError
5231 }
5232 _ => ServiceControlHandlerResult::NotImplemented,
5233 };
5234 let handle = service_control_handler::register("", handler)
5235 .map_err(|error| format!("cannot register the service control handler: {error}"))?;
5236 *status
5237 .lock()
5238 .map_err(|_| "the service status handle is poisoned".to_string())? = Some(handle);
5239 handle
5240 .set_service_status(service_status(
5241 ServiceState::Running,
5242 ServiceControlAccept::STOP | ServiceControlAccept::SHUTDOWN,
5243 0,
5244 Duration::default(),
5245 0,
5246 ))
5247 .map_err(|error| format!("cannot report SERVICE_RUNNING: {error}"))?;
5248
5249 let exit = run(ServiceShutdown(stop_rx));
5250 handle
5251 .set_service_status(service_status(
5252 ServiceState::Stopped,
5253 ServiceControlAccept::empty(),
5254 0,
5255 Duration::default(),
5256 u32::from(exit),
5257 ))
5258 .map_err(|error| format!("cannot report SERVICE_STOPPED: {error}"))?;
5259 Ok(exit)
5260 }
5261
5262 fn service_status(
5263 state: ServiceState,
5264 accepted: ServiceControlAccept,
5265 checkpoint: u32,
5266 wait_hint: Duration,
5267 exit: u32,
5268 ) -> ServiceStatus {
5269 ServiceStatus {
5270 service_type: ServiceType::OWN_PROCESS,
5271 current_state: state,
5272 controls_accepted: accepted,
5273 exit_code: if exit == 0 {
5274 ServiceExitCode::Win32(0)
5275 } else {
5276 ServiceExitCode::ServiceSpecific(exit)
5277 },
5278 checkpoint,
5279 wait_hint,
5280 process_id: None,
5281 }
5282 }
5283
5284 fn host_error(operation: &'static str, detail: &str) -> ServiceError {
5285 ServiceError::Control {
5286 operation,
5287 name: SERVICE_NAME.to_string(),
5288 manager: "the Windows Service Control Manager",
5289 detail: detail.to_string(),
5290 }
5291 }
5292}
5293
5294#[cfg(windows)]
5295mod sys {
5296 use std::ffi::{OsStr, OsString};
5306 use std::time::{Duration, Instant};
5307
5308 use runner_manager_domain::model::StartMode;
5309 use windows_service::service::{
5310 ServiceAccess, ServiceAction, ServiceActionType, ServiceErrorControl,
5311 ServiceFailureActions, ServiceFailureResetPeriod, ServiceInfo, ServiceStartType,
5312 ServiceState, ServiceType,
5313 };
5314 use windows_service::service_manager::{ServiceManager, ServiceManagerAccess};
5315
5316 use super::{
5317 DefinitionKind, InstallPlan, Registration, ServiceControl, ServiceDefinition, ServiceError,
5318 ServiceIdentity, TaskPrincipal, run, windows_service_spec, xml_value,
5319 };
5320
5321 const SERVICE_DOES_NOT_EXIST: i32 = 1060;
5324 const SERVICE_MARKED_FOR_DELETE: i32 = 1072;
5328 const ACCESS_DENIED: i32 = 5;
5330 const DELETE_TIMEOUT: Duration = Duration::from_secs(30);
5331 const DELETE_POLL_INTERVAL: Duration = Duration::from_millis(200);
5332
5333 const ELEVATION_REMEDY: &str = "Run the command from an elevated prompt: right-click Windows Terminal or PowerShell and \
5334 choose \"Run as administrator\".";
5335
5336 pub(super) fn control(mode: StartMode) -> Result<Box<dyn ServiceControl>, ServiceError> {
5337 Ok(match mode {
5338 StartMode::Boot => Box::new(ScmControl),
5339 StartMode::Login => Box::new(TaskControl),
5340 })
5341 }
5342
5343 #[derive(Debug)]
5346 struct ScmControl;
5347
5348 fn scm_error(
5352 operation: &'static str,
5353 name: &str,
5354 error: &windows_service::Error,
5355 ) -> ServiceError {
5356 let raw = match error {
5357 windows_service::Error::Winapi(io) => io.raw_os_error(),
5358 _ => None,
5359 };
5360 let detail = match error {
5361 windows_service::Error::Winapi(io) => io.to_string(),
5362 other => other.to_string(),
5363 };
5364 if raw == Some(ACCESS_DENIED) {
5365 return ServiceError::NeedsElevation {
5366 operation,
5367 name: name.to_string(),
5368 detail,
5369 remedy: ELEVATION_REMEDY,
5370 };
5371 }
5372 ServiceError::Control {
5373 operation,
5374 name: name.to_string(),
5375 manager: "the Windows Service Control Manager",
5376 detail,
5377 }
5378 }
5379
5380 fn open_manager(
5381 access: ServiceManagerAccess,
5382 operation: &'static str,
5383 name: &str,
5384 ) -> Result<ServiceManager, ServiceError> {
5385 ServiceManager::local_computer(None::<&OsStr>, access)
5386 .map_err(|error| scm_error(operation, name, &error))
5387 }
5388
5389 impl ServiceControl for ScmControl {
5390 fn manager(&self) -> DefinitionKind {
5391 DefinitionKind::WindowsService
5392 }
5393
5394 fn install(&self, plan: &InstallPlan) -> Result<ServiceDefinition, ServiceError> {
5395 let spec = windows_service_spec(plan);
5396 let manager = open_manager(
5397 ServiceManagerAccess::CONNECT | ServiceManagerAccess::CREATE_SERVICE,
5398 "install",
5399 &spec.name,
5400 )?;
5401 let info = ServiceInfo {
5402 name: OsString::from(&spec.name),
5403 display_name: OsString::from(&spec.display_name),
5404 service_type: ServiceType::OWN_PROCESS,
5406 start_type: if spec.automatic_start {
5407 ServiceStartType::AutoStart
5408 } else {
5409 ServiceStartType::OnDemand
5410 },
5411 error_control: ServiceErrorControl::Normal,
5412 executable_path: plan.binary().to_path_buf(),
5413 launch_arguments: plan.arguments().to_vec(),
5414 dependencies: Vec::new(),
5415 account_name: spec.account.as_ref().map(OsString::from),
5417 account_password: None,
5420 };
5421 let service = manager
5422 .create_service(
5423 &info,
5424 ServiceAccess::CHANGE_CONFIG
5425 | ServiceAccess::QUERY_CONFIG
5426 | ServiceAccess::QUERY_STATUS
5427 | ServiceAccess::START
5428 | ServiceAccess::STOP
5429 | ServiceAccess::DELETE,
5430 )
5431 .map_err(|error| scm_error("install", &spec.name, &error))?;
5432 service
5433 .set_description(&spec.description)
5434 .map_err(|error| scm_error("describe", &spec.name, &error))?;
5435 service
5436 .update_failure_actions(ServiceFailureActions {
5437 reset_period: ServiceFailureResetPeriod::After(spec.restart.reset_after()),
5438 reboot_msg: None,
5439 command: None,
5440 actions: Some(vec![
5447 ServiceAction {
5448 action_type: ServiceActionType::Restart,
5449 delay: spec.restart.delay(),
5450 };
5451 3
5452 ]),
5453 })
5454 .map_err(|error| scm_error("set the restart policy of", &spec.name, &error))?;
5455 service
5458 .set_failure_actions_on_non_crash_failures(true)
5459 .map_err(|error| scm_error("set the restart policy of", &spec.name, &error))?;
5460 Ok(ServiceDefinition::windows_service(plan))
5461 }
5462
5463 fn uninstall(&self, identity: &ServiceIdentity) -> Result<bool, ServiceError> {
5464 let manager =
5465 open_manager(ServiceManagerAccess::CONNECT, "uninstall", identity.name())?;
5466 let service = match manager.open_service(
5467 identity.name(),
5468 ServiceAccess::QUERY_STATUS | ServiceAccess::STOP | ServiceAccess::DELETE,
5469 ) {
5470 Ok(service) => service,
5471 Err(error) if is_missing(&error) => return Ok(false),
5472 Err(error) => return Err(scm_error("uninstall", identity.name(), &error)),
5473 };
5474 if let Ok(status) = service.query_status()
5478 && status.current_state != ServiceState::Stopped
5479 {
5480 let _ = service.stop();
5481 }
5482 service
5483 .delete()
5484 .map_err(|error| scm_error("uninstall", identity.name(), &error))?;
5485
5486 drop(service);
5493 let absent = wait_until_scm_absent(DELETE_TIMEOUT, DELETE_POLL_INTERVAL, || {
5494 match manager.open_service(identity.name(), ServiceAccess::QUERY_STATUS) {
5495 Ok(service) => {
5496 drop(service);
5497 Ok(false)
5498 }
5499 Err(error) if is_missing(&error) => Ok(true),
5500 Err(error) if is_marked_for_delete(&error) => Ok(false),
5501 Err(error) => Err(scm_error("verify uninstall of", identity.name(), &error)),
5502 }
5503 })?;
5504 if !absent {
5505 return Err(ServiceError::Control {
5506 operation: "verify uninstall of",
5507 name: identity.name().to_string(),
5508 manager: "the Windows Service Control Manager",
5509 detail: format!(
5510 "the registration was still visible {} seconds after DeleteService; \
5511 retry `service uninstall` from an elevated prompt",
5512 DELETE_TIMEOUT.as_secs()
5513 ),
5514 });
5515 }
5516 Ok(true)
5517 }
5518
5519 fn query(&self, identity: &ServiceIdentity) -> Result<Option<Registration>, ServiceError> {
5520 let manager = open_manager(ServiceManagerAccess::CONNECT, "inspect", identity.name())?;
5521 let service = match manager.open_service(
5522 identity.name(),
5523 ServiceAccess::QUERY_CONFIG | ServiceAccess::QUERY_STATUS,
5524 ) {
5525 Ok(service) => service,
5526 Err(error) if is_missing(&error) => return Ok(None),
5527 Err(error) => return Err(scm_error("inspect", identity.name(), &error)),
5528 };
5529 let config = service
5530 .query_config()
5531 .map_err(|error| scm_error("inspect", identity.name(), &error))?;
5532 let status = service
5533 .query_status()
5534 .map_err(|error| scm_error("inspect", identity.name(), &error))?;
5535 let restart_delay = service.get_failure_actions().ok().and_then(|actions| {
5536 actions
5537 .actions
5538 .and_then(|actions| actions.into_iter().next())
5539 .filter(|action| action.action_type == ServiceActionType::Restart)
5540 .map(|action| action.delay)
5541 });
5542 Ok(Some(Registration {
5543 manager: DefinitionKind::WindowsService,
5544 start_mode: StartMode::Boot,
5545 command_line: config.executable_path.to_string_lossy().into_owned(),
5549 account: config
5550 .account_name
5551 .map(|account| account.to_string_lossy().into_owned()),
5552 running: status.current_state == ServiceState::Running,
5553 starts_automatically: config.start_type == ServiceStartType::AutoStart,
5554 restart_delay,
5555 }))
5556 }
5557
5558 fn start(&self, identity: &ServiceIdentity) -> Result<(), ServiceError> {
5559 let manager = open_manager(ServiceManagerAccess::CONNECT, "start", identity.name())?;
5560 let service = manager
5561 .open_service(identity.name(), ServiceAccess::START)
5562 .map_err(|error| scm_error("start", identity.name(), &error))?;
5563 service
5564 .start::<&OsStr>(&[])
5565 .map_err(|error| scm_error("start", identity.name(), &error))
5566 }
5567
5568 fn stop(&self, identity: &ServiceIdentity) -> Result<bool, ServiceError> {
5569 let manager = open_manager(ServiceManagerAccess::CONNECT, "stop", identity.name())?;
5570 let service = manager
5571 .open_service(
5572 identity.name(),
5573 ServiceAccess::STOP | ServiceAccess::QUERY_STATUS,
5574 )
5575 .map_err(|error| scm_error("stop", identity.name(), &error))?;
5576 let status = service
5577 .query_status()
5578 .map_err(|error| scm_error("stop", identity.name(), &error))?;
5579 if status.current_state == ServiceState::Stopped {
5580 return Ok(false);
5581 }
5582 service
5583 .stop()
5584 .map_err(|error| scm_error("stop", identity.name(), &error))?;
5585 Ok(true)
5586 }
5587 }
5588
5589 fn is_missing(error: &windows_service::Error) -> bool {
5590 matches!(error, windows_service::Error::Winapi(io)
5591 if io.raw_os_error() == Some(SERVICE_DOES_NOT_EXIST))
5592 }
5593
5594 fn is_marked_for_delete(error: &windows_service::Error) -> bool {
5595 matches!(error, windows_service::Error::Winapi(io)
5596 if io.raw_os_error() == Some(SERVICE_MARKED_FOR_DELETE))
5597 }
5598
5599 pub(super) fn wait_until_scm_absent(
5600 timeout: Duration,
5601 poll_interval: Duration,
5602 mut probe_absent: impl FnMut() -> Result<bool, ServiceError>,
5603 ) -> Result<bool, ServiceError> {
5604 let deadline = Instant::now() + timeout;
5605 loop {
5606 if probe_absent()? {
5607 return Ok(true);
5608 }
5609 if Instant::now() >= deadline {
5610 return Ok(false);
5611 }
5612 std::thread::sleep(poll_interval);
5613 }
5614 }
5615
5616 #[derive(Debug)]
5619 struct TaskControl;
5620
5621 fn task_error(operation: &'static str, name: &str, detail: String) -> ServiceError {
5622 if detail.to_ascii_lowercase().contains("access is denied") {
5623 return ServiceError::NeedsElevation {
5624 operation,
5625 name: name.to_string(),
5626 detail,
5627 remedy: ELEVATION_REMEDY,
5628 };
5629 }
5630 ServiceError::Control {
5631 operation,
5632 name: name.to_string(),
5633 manager: "Windows Task Scheduler",
5634 detail,
5635 }
5636 }
5637
5638 fn schtasks(
5639 operation: &'static str,
5640 name: &str,
5641 arguments: &[&OsStr],
5642 ) -> Result<(bool, String), ServiceError> {
5643 match run("schtasks.exe", arguments) {
5644 Ok((ok, stdout, stderr)) => Ok((ok, if ok { stdout } else { stderr })),
5645 Err(error) => Err(task_error(operation, name, error.to_string())),
5646 }
5647 }
5648
5649 fn write_utf16(path: &std::path::Path, text: &str) -> std::io::Result<()> {
5652 let mut bytes = vec![0xFF, 0xFE];
5653 for unit in text.encode_utf16() {
5654 bytes.extend_from_slice(&unit.to_le_bytes());
5655 }
5656 std::fs::write(path, bytes)
5657 }
5658
5659 impl ServiceControl for TaskControl {
5660 fn manager(&self) -> DefinitionKind {
5661 DefinitionKind::WindowsScheduledTask
5662 }
5663
5664 fn install(&self, plan: &InstallPlan) -> Result<ServiceDefinition, ServiceError> {
5665 let name = plan.identity().name().to_string();
5666 let principal = TaskPrincipal::current()?;
5667 let definition = ServiceDefinition::windows_scheduled_task(plan, &principal);
5668 let directory = tempfile::tempdir()
5669 .map_err(|error| task_error("install", &name, error.to_string()))?;
5670 let document = directory.path().join("task.xml");
5671 write_utf16(&document, definition.text())
5672 .map_err(|error| task_error("install", &name, error.to_string()))?;
5673 let (ok, message) = schtasks(
5674 "install",
5675 &name,
5676 &[
5677 OsStr::new("/Create"),
5678 OsStr::new("/TN"),
5679 OsStr::new(&name),
5680 OsStr::new("/XML"),
5681 document.as_os_str(),
5682 ],
5683 )?;
5684 if !ok {
5685 return Err(task_error("install", &name, message));
5686 }
5687 Ok(definition)
5688 }
5689
5690 fn uninstall(&self, identity: &ServiceIdentity) -> Result<bool, ServiceError> {
5691 if self.query(identity)?.is_none() {
5692 return Ok(false);
5693 }
5694 let name = identity.name().to_string();
5695 let (ok, message) = schtasks(
5696 "uninstall",
5697 &name,
5698 &[
5699 OsStr::new("/Delete"),
5700 OsStr::new("/TN"),
5701 OsStr::new(&name),
5702 OsStr::new("/F"),
5703 ],
5704 )?;
5705 if !ok {
5706 return Err(task_error("uninstall", &name, message));
5707 }
5708 Ok(true)
5709 }
5710
5711 fn query(&self, identity: &ServiceIdentity) -> Result<Option<Registration>, ServiceError> {
5712 let name = identity.name().to_string();
5713 let (ok, document) = schtasks(
5714 "inspect",
5715 &name,
5716 &[
5717 OsStr::new("/Query"),
5718 OsStr::new("/TN"),
5719 OsStr::new(&name),
5720 OsStr::new("/XML"),
5721 OsStr::new("ONE"),
5722 ],
5723 )?;
5724 if !ok {
5725 return Ok(None);
5731 }
5732 let command = xml_value(&document, "Command").unwrap_or_default();
5733 let arguments = xml_value(&document, "Arguments").unwrap_or_default();
5734 let command_line = if arguments.is_empty() {
5735 super::quote_argument(&command)
5736 } else {
5737 format!("{} {arguments}", super::quote_argument(&command))
5738 };
5739 Ok(Some(Registration {
5740 manager: DefinitionKind::WindowsScheduledTask,
5741 start_mode: StartMode::Login,
5742 command_line,
5743 account: xml_value(&document, "UserId"),
5744 running: task_is_running(&name),
5745 starts_automatically: super::windows_login_task_starts_automatically(&document),
5746 restart_delay: xml_value(&document, "Interval")
5747 .as_deref()
5748 .and_then(parse_iso8601),
5749 }))
5750 }
5751
5752 fn start(&self, identity: &ServiceIdentity) -> Result<(), ServiceError> {
5753 let name = identity.name().to_string();
5754 let (ok, message) = schtasks(
5755 "start",
5756 &name,
5757 &[OsStr::new("/Run"), OsStr::new("/TN"), OsStr::new(&name)],
5758 )?;
5759 if ok {
5760 Ok(())
5761 } else {
5762 Err(task_error("start", &name, message))
5763 }
5764 }
5765
5766 fn stop(&self, identity: &ServiceIdentity) -> Result<bool, ServiceError> {
5767 let running = self
5768 .query(identity)?
5769 .is_some_and(|registration| registration.running);
5770 if !running {
5771 return Ok(false);
5772 }
5773 let name = identity.name().to_string();
5774 let (ok, message) = schtasks(
5775 "stop",
5776 &name,
5777 &[OsStr::new("/End"), OsStr::new("/TN"), OsStr::new(&name)],
5778 )?;
5779 if ok {
5780 Ok(true)
5781 } else {
5782 Err(task_error("stop", &name, message))
5783 }
5784 }
5785 }
5786
5787 fn task_is_running(name: &str) -> bool {
5801 let Ok((true, stdout, _)) = run(
5802 "schtasks.exe",
5803 &[
5804 OsStr::new("/Query"),
5805 OsStr::new("/TN"),
5806 OsStr::new(name),
5807 OsStr::new("/FO"),
5808 OsStr::new("CSV"),
5809 OsStr::new("/NH"),
5810 ],
5811 ) else {
5812 return false;
5813 };
5814 stdout
5815 .lines()
5816 .filter_map(|line| line.rsplit(',').next())
5817 .any(|status| {
5818 status
5819 .trim()
5820 .trim_matches('"')
5821 .eq_ignore_ascii_case("running")
5822 })
5823 }
5824
5825 fn parse_iso8601(value: &str) -> Option<Duration> {
5829 let rest = value.strip_prefix("PT")?;
5830 if let Some(minutes) = rest.strip_suffix('M') {
5831 return minutes
5832 .parse::<u64>()
5833 .ok()
5834 .map(|minutes| Duration::from_secs(minutes * 60));
5835 }
5836 rest.strip_suffix('S')?
5837 .parse::<u64>()
5838 .ok()
5839 .map(Duration::from_secs)
5840 }
5841}
5842
5843#[cfg(unix)]
5855fn write_definition(
5856 operation: &'static str,
5857 name: &str,
5858 path: &Path,
5859 text: &str,
5860 remedy: &'static str,
5861) -> Result<(), ServiceError> {
5862 if let Some(parent) = path.parent()
5863 && let Err(error) = std::fs::create_dir_all(parent)
5864 && error.kind() != std::io::ErrorKind::AlreadyExists
5865 {
5866 return Err(definition_error(operation, name, error, remedy, parent));
5867 }
5868 std::fs::write(path, text)
5869 .map_err(|error| definition_error(operation, name, error, remedy, path))
5870}
5871
5872#[cfg(unix)]
5873fn definition_error(
5874 operation: &'static str,
5875 name: &str,
5876 error: std::io::Error,
5877 remedy: &'static str,
5878 path: &Path,
5879) -> ServiceError {
5880 let detail = format!("{}: {error}", path.display());
5881 if error.kind() == std::io::ErrorKind::PermissionDenied {
5882 ServiceError::NeedsElevation {
5883 operation,
5884 name: name.to_string(),
5885 detail,
5886 remedy,
5887 }
5888 } else {
5889 ServiceError::Control {
5890 operation,
5891 name: name.to_string(),
5892 manager: "the local service manager",
5893 detail,
5894 }
5895 }
5896}
5897
5898#[cfg(unix)]
5900const SUDO_REMEDY: &str = "A boot-start registration is machine-wide, so it needs root: run the same command with \
5901 `sudo`. `service install --start-at login` needs no elevation at all, at the cost of the \
5902 agent not running until you sign in.";
5903
5904#[cfg(target_os = "macos")]
5909mod sys {
5910 use std::ffi::OsStr;
5923 use std::path::PathBuf;
5924 use std::time::Duration;
5925
5926 use runner_manager_domain::model::StartMode;
5927
5928 use super::{
5929 DefinitionKind, InstallPlan, LAUNCH_AGENTS_SUBDIR, LAUNCH_DAEMONS_DIR, Registration,
5930 SUDO_REMEDY, ServiceControl, ServiceDefinition, ServiceError, ServiceIdentity,
5931 enable_launchd_registration, home_directory, plist_string_value, quote_argument, run,
5932 write_definition, xml_value,
5933 };
5934
5935 pub(super) fn control(mode: StartMode) -> Result<Box<dyn ServiceControl>, ServiceError> {
5936 Ok(Box::new(LaunchdControl { mode }))
5937 }
5938
5939 #[derive(Debug)]
5940 struct LaunchdControl {
5941 mode: StartMode,
5942 }
5943
5944 impl LaunchdControl {
5945 fn domain(&self) -> String {
5947 match self.mode {
5948 StartMode::Boot => "system".to_string(),
5949 StartMode::Login => format!("gui/{}", unsafe { libc::getuid() }),
5952 }
5953 }
5954
5955 fn service_target(&self, identity: &ServiceIdentity) -> String {
5956 format!("{}/{}", self.domain(), identity.launchd_label())
5957 }
5958
5959 fn plist_path(&self, identity: &ServiceIdentity) -> Option<PathBuf> {
5962 let file = format!("{}.plist", identity.launchd_label());
5963 match self.mode {
5964 StartMode::Boot => Some(PathBuf::from(LAUNCH_DAEMONS_DIR).join(file)),
5965 StartMode::Login => {
5966 home_directory().map(|home| home.join(LAUNCH_AGENTS_SUBDIR).join(file))
5967 }
5968 }
5969 }
5970
5971 fn failed(&self, operation: &'static str, name: &str, detail: String) -> ServiceError {
5972 ServiceError::Control {
5973 operation,
5974 name: name.to_string(),
5975 manager: "launchd",
5976 detail,
5977 }
5978 }
5979
5980 fn launchctl(&self, arguments: &[&OsStr]) -> (bool, String) {
5981 match run("launchctl", arguments) {
5982 Ok((ok, stdout, stderr)) => (ok, if ok { stdout } else { stderr }),
5983 Err(error) => (false, error.to_string()),
5984 }
5985 }
5986 }
5987
5988 impl ServiceControl for LaunchdControl {
5989 fn manager(&self) -> DefinitionKind {
5990 DefinitionKind::LaunchdPlist
5991 }
5992
5993 fn install(&self, plan: &InstallPlan) -> Result<ServiceDefinition, ServiceError> {
5994 let name = plan.identity().name().to_string();
5995 let definition = ServiceDefinition::launchd(plan, home_directory().as_deref());
5996 let Some(path) = definition.install_path().map(std::path::Path::to_path_buf) else {
5997 return Err(self.failed(
5998 "install",
5999 &name,
6000 "this account has no home directory, so there is nowhere to put a \
6001 LaunchAgent. Use --start-at boot, which installs a LaunchDaemon under \
6002 /Library/LaunchDaemons."
6003 .to_string(),
6004 ));
6005 };
6006 write_definition("install", &name, &path, definition.text(), SUDO_REMEDY)?;
6007 let target = self.domain();
6008 let (ok, message) = self.launchctl(&[
6009 OsStr::new("bootstrap"),
6010 OsStr::new(&target),
6011 path.as_os_str(),
6012 ]);
6013 if !ok {
6014 let _ = std::fs::remove_file(&path);
6018 if message.to_ascii_lowercase().contains("permission denied") {
6019 return Err(ServiceError::NeedsElevation {
6020 operation: "install",
6021 name,
6022 detail: message,
6023 remedy: SUDO_REMEDY,
6024 });
6025 }
6026 return Err(self.failed("install", &name, message));
6027 }
6028 let service_target = self.service_target(plan.identity());
6031 enable_launchd_registration(
6032 |arguments| self.launchctl(arguments),
6033 &target,
6034 &service_target,
6035 &path,
6036 &name,
6037 SUDO_REMEDY,
6038 )?;
6039 Ok(definition)
6040 }
6041
6042 fn uninstall(&self, identity: &ServiceIdentity) -> Result<bool, ServiceError> {
6043 let Some(path) = self.plist_path(identity) else {
6044 return Ok(false);
6045 };
6046 if !path.exists() {
6047 return Ok(false);
6048 }
6049 let target = self.service_target(identity);
6050 let (ok, message) = self.launchctl(&[OsStr::new("bootout"), OsStr::new(&target)]);
6051 if !ok
6052 && !message.to_ascii_lowercase().contains("no such process")
6053 && !message.contains("113")
6054 {
6055 if message.to_ascii_lowercase().contains("permission denied") {
6056 return Err(ServiceError::NeedsElevation {
6057 operation: "uninstall",
6058 name: identity.name().to_string(),
6059 detail: message,
6060 remedy: SUDO_REMEDY,
6061 });
6062 }
6063 return Err(self.failed("uninstall", identity.name(), message));
6064 }
6065 std::fs::remove_file(&path).map_err(|error| {
6068 super::definition_error(
6069 "uninstall",
6070 identity.name(),
6071 error,
6072 SUDO_REMEDY,
6073 path.as_path(),
6074 )
6075 })?;
6076 Ok(true)
6077 }
6078
6079 fn query(&self, identity: &ServiceIdentity) -> Result<Option<Registration>, ServiceError> {
6080 let Some(path) = self.plist_path(identity) else {
6081 return Ok(None);
6082 };
6083 let Ok(document) = std::fs::read_to_string(&path) else {
6084 return Ok(None);
6085 };
6086 let target = self.service_target(identity);
6087 let (loaded, printed) = self.launchctl(&[OsStr::new("print"), OsStr::new(&target)]);
6088 Ok(Some(Registration {
6089 manager: DefinitionKind::LaunchdPlist,
6090 start_mode: self.mode,
6091 command_line: program_arguments(&document),
6092 account: plist_string_value(&document, "UserName")
6093 .or_else(|| Some("the invoking user".to_string())),
6094 running: loaded && printed.contains("state = running"),
6095 starts_automatically: document.contains("<key>RunAtLoad</key>")
6096 && super::plist_bool_value(&document, "RunAtLoad") == Some(true),
6097 restart_delay: xml_value(
6098 super::plist_value_after_key(&document, "ThrottleInterval").unwrap_or(""),
6099 "integer",
6100 )
6101 .and_then(|value| value.parse::<u64>().ok())
6102 .map(Duration::from_secs),
6103 }))
6104 }
6105
6106 fn start(&self, identity: &ServiceIdentity) -> Result<(), ServiceError> {
6107 let target = self.service_target(identity);
6108 let (ok, message) = self.launchctl(&[
6109 OsStr::new("kickstart"),
6110 OsStr::new("-k"),
6111 OsStr::new(&target),
6112 ]);
6113 if ok {
6114 Ok(())
6115 } else {
6116 Err(self.failed("start", identity.name(), message))
6117 }
6118 }
6119
6120 fn stop(&self, identity: &ServiceIdentity) -> Result<bool, ServiceError> {
6121 let running = self
6122 .query(identity)?
6123 .is_some_and(|registration| registration.running);
6124 if !running {
6125 return Ok(false);
6126 }
6127 let target = self.service_target(identity);
6128 let (ok, message) = self.launchctl(&[
6129 OsStr::new("kill"),
6130 OsStr::new("SIGTERM"),
6131 OsStr::new(&target),
6132 ]);
6133 if ok {
6134 Ok(true)
6135 } else {
6136 Err(self.failed("stop", identity.name(), message))
6137 }
6138 }
6139 }
6140
6141 fn program_arguments(document: &str) -> String {
6143 let Some(rest) = super::plist_value_after_key(document, "ProgramArguments") else {
6144 return String::new();
6145 };
6146 let Some(end) = rest.find("</array>") else {
6147 return String::new();
6148 };
6149 let mut out = Vec::new();
6150 let mut cursor = &rest[..end];
6151 while let Some(open) = cursor.find("<string>") {
6152 let after = &cursor[open + "<string>".len()..];
6153 let Some(close) = after.find("</string>") else {
6154 break;
6155 };
6156 out.push(quote_argument(&super::xml_unescape(&after[..close])));
6157 cursor = &after[close..];
6158 }
6159 out.join(" ")
6160 }
6161}
6162
6163#[cfg(all(unix, not(target_os = "macos")))]
6168mod sys {
6169 use std::ffi::OsStr;
6179 use std::path::PathBuf;
6180 use std::time::Duration;
6181
6182 use runner_manager_domain::model::StartMode;
6183
6184 use super::{
6185 DefinitionKind, InstallPlan, Registration, SUDO_REMEDY, SYSTEMD_SYSTEM_DIR,
6186 SYSTEMD_USER_SUBDIR, ServiceControl, ServiceDefinition, ServiceError, ServiceIdentity,
6187 home_directory, ini_directives, run, write_definition,
6188 };
6189
6190 pub(super) fn control(mode: StartMode) -> Result<Box<dyn ServiceControl>, ServiceError> {
6191 Ok(Box::new(SystemdControl { mode }))
6192 }
6193
6194 #[derive(Debug)]
6195 struct SystemdControl {
6196 mode: StartMode,
6197 }
6198
6199 impl SystemdControl {
6200 fn unit_path(&self, identity: &ServiceIdentity) -> Option<PathBuf> {
6201 let file = identity.systemd_unit();
6202 match self.mode {
6203 StartMode::Boot => Some(PathBuf::from(SYSTEMD_SYSTEM_DIR).join(file)),
6204 StartMode::Login => {
6205 home_directory().map(|home| home.join(SYSTEMD_USER_SUBDIR).join(file))
6206 }
6207 }
6208 }
6209
6210 fn systemctl(&self, arguments: &[&str]) -> (bool, String) {
6212 let mut all: Vec<&OsStr> = Vec::with_capacity(arguments.len() + 1);
6213 if self.mode == StartMode::Login {
6214 all.push(OsStr::new("--user"));
6215 }
6216 all.extend(arguments.iter().map(OsStr::new));
6217 match run("systemctl", &all) {
6218 Ok((ok, stdout, stderr)) => (
6219 ok,
6220 if stdout.trim().is_empty() {
6221 stderr
6222 } else {
6223 stdout
6224 },
6225 ),
6226 Err(error) => (false, error.to_string()),
6227 }
6228 }
6229
6230 fn failed(&self, operation: &'static str, name: &str, detail: String) -> ServiceError {
6231 ServiceError::Control {
6232 operation,
6233 name: name.to_string(),
6234 manager: "systemd",
6235 detail,
6236 }
6237 }
6238 }
6239
6240 impl ServiceControl for SystemdControl {
6241 fn manager(&self) -> DefinitionKind {
6242 DefinitionKind::SystemdUnit
6243 }
6244
6245 fn install(&self, plan: &InstallPlan) -> Result<ServiceDefinition, ServiceError> {
6246 let name = plan.identity().name().to_string();
6247 let definition = ServiceDefinition::systemd(plan, home_directory().as_deref());
6248 let Some(path) = definition.install_path().map(std::path::Path::to_path_buf) else {
6249 return Err(self.failed(
6250 "install",
6251 &name,
6252 "this account has no home directory, so there is nowhere to put a systemd \
6253 user unit. Use --start-at boot, which installs a system unit under \
6254 /etc/systemd/system."
6255 .to_string(),
6256 ));
6257 };
6258 write_definition("install", &name, &path, definition.text(), SUDO_REMEDY)?;
6259 let unit = plan.identity().systemd_unit();
6260 let (reloaded, message) = self.systemctl(&["daemon-reload"]);
6261 if !reloaded {
6262 let _ = std::fs::remove_file(&path);
6263 return Err(self.failed("install", &name, message));
6264 }
6265 let (enabled, message) = self.systemctl(&["enable", &unit]);
6266 if !enabled {
6267 let _ = std::fs::remove_file(&path);
6268 let _ = self.systemctl(&["daemon-reload"]);
6269 return Err(self.failed("install", &name, message));
6270 }
6271 Ok(definition)
6272 }
6273
6274 fn uninstall(&self, identity: &ServiceIdentity) -> Result<bool, ServiceError> {
6275 let Some(path) = self.unit_path(identity) else {
6276 return Ok(false);
6277 };
6278 if !path.exists() {
6279 return Ok(false);
6280 }
6281 let unit = identity.systemd_unit();
6282 let _ = self.systemctl(&["disable", "--now", &unit]);
6287 std::fs::remove_file(&path).map_err(|error| {
6288 super::definition_error(
6289 "uninstall",
6290 identity.name(),
6291 error,
6292 SUDO_REMEDY,
6293 path.as_path(),
6294 )
6295 })?;
6296 let _ = self.systemctl(&["daemon-reload"]);
6297 Ok(true)
6298 }
6299
6300 fn query(&self, identity: &ServiceIdentity) -> Result<Option<Registration>, ServiceError> {
6301 let Some(path) = self.unit_path(identity) else {
6302 return Ok(None);
6303 };
6304 let Ok(document) = std::fs::read_to_string(&path) else {
6305 return Ok(None);
6306 };
6307 let unit = identity.systemd_unit();
6308 let directives = ini_directives(&document, "Service");
6309 let (_, active) = self.systemctl(&["is-active", &unit]);
6310 let (_, enabled) = self.systemctl(&["is-enabled", &unit]);
6311 Ok(Some(Registration {
6312 manager: DefinitionKind::SystemdUnit,
6313 start_mode: self.mode,
6314 command_line: directives.get("ExecStart").cloned().unwrap_or_default(),
6315 account: directives.get("User").cloned().or_else(|| {
6316 Some(match self.mode {
6317 StartMode::Boot => "root".to_string(),
6318 StartMode::Login => "the invoking user".to_string(),
6319 })
6320 }),
6321 running: active.trim() == "active",
6322 starts_automatically: enabled.trim() == "enabled",
6323 restart_delay: directives
6324 .get("RestartSec")
6325 .and_then(|value| value.trim().trim_end_matches('s').parse::<u64>().ok())
6326 .map(Duration::from_secs),
6327 }))
6328 }
6329
6330 fn start(&self, identity: &ServiceIdentity) -> Result<(), ServiceError> {
6331 let unit = identity.systemd_unit();
6332 let (ok, message) = self.systemctl(&["start", &unit]);
6333 if ok {
6334 Ok(())
6335 } else {
6336 Err(self.failed("start", identity.name(), message))
6337 }
6338 }
6339
6340 fn stop(&self, identity: &ServiceIdentity) -> Result<bool, ServiceError> {
6341 let running = self
6342 .query(identity)?
6343 .is_some_and(|registration| registration.running);
6344 if !running {
6345 return Ok(false);
6346 }
6347 let unit = identity.systemd_unit();
6348 let (ok, message) = self.systemctl(&["stop", &unit]);
6349 if ok {
6350 Ok(true)
6351 } else {
6352 Err(self.failed("stop", identity.name(), message))
6353 }
6354 }
6355 }
6356}
6357
6358#[cfg(test)]
6359mod tests {
6360 use super::*;
6361
6362 use std::collections::BTreeMap;
6363
6364 #[test]
6365 fn task_scheduler_omitting_default_enabled_still_means_automatic() {
6366 assert!(windows_login_task_starts_automatically(
6367 "<Task><Triggers><LogonTrigger></LogonTrigger></Triggers></Task>"
6368 ));
6369 assert!(windows_login_task_starts_automatically(
6370 "<Task><LogonTrigger><Enabled>true</Enabled></LogonTrigger></Task>"
6371 ));
6372 assert!(!windows_login_task_starts_automatically(
6373 "<Task><LogonTrigger><Enabled>false</Enabled></LogonTrigger></Task>"
6374 ));
6375 assert!(!windows_login_task_starts_automatically(
6376 "<Task><BootTrigger></BootTrigger></Task>"
6377 ));
6378 }
6379
6380 fn linux_plan(mode: StartMode) -> InstallPlan {
6387 InstallPlan::unchecked(
6388 ServiceIdentity::product(),
6389 mode,
6390 "/opt/runner-manager/bin/runner-manager",
6391 ServiceDirectories {
6392 config: PathBuf::from("/var/lib/runner-manager/config"),
6393 state: PathBuf::from("/var/lib/runner-manager/state"),
6394 runtime: PathBuf::from("/var/lib/runner-manager/runtime"),
6395 logs: PathBuf::from("/var/log/runner-manager"),
6396 },
6397 )
6398 .with_secret_guard("/var/lib/runner-manager/secrets/user-access-token")
6399 }
6400
6401 fn windows_plan(mode: StartMode) -> InstallPlan {
6402 InstallPlan::unchecked(
6403 ServiceIdentity::product(),
6404 mode,
6405 "C:\\Program Files\\runner-manager\\runner-manager.exe",
6406 ServiceDirectories {
6407 config: PathBuf::from("C:\\Users\\op\\AppData\\Local\\rm\\config"),
6408 state: PathBuf::from("C:\\Users\\op\\AppData\\Local\\rm\\state"),
6409 runtime: PathBuf::from("C:\\Users\\op\\AppData\\Local\\rm\\runtime"),
6410 logs: PathBuf::from("C:\\Users\\op\\AppData\\Local\\rm\\logs"),
6411 },
6412 )
6413 }
6414
6415 fn edited(text: &str, from: &str, to: &str) -> String {
6423 assert!(
6424 text.contains(from),
6425 "the rendered definition does not contain `{from}`, so this test would assert \
6426 nothing about a widened one"
6427 );
6428 text.replace(from, to)
6429 }
6430
6431 fn snapshot(roots: &[&Path]) -> BTreeMap<PathBuf, Vec<u8>> {
6433 fn walk(directory: &Path, out: &mut BTreeMap<PathBuf, Vec<u8>>) {
6434 let Ok(entries) = std::fs::read_dir(directory) else {
6435 return;
6436 };
6437 for entry in entries.flatten() {
6438 let path = entry.path();
6439 if path.is_dir() {
6440 walk(&path, out);
6441 } else if let Ok(bytes) = std::fs::read(&path) {
6442 out.insert(path, bytes);
6443 }
6444 }
6445 }
6446 let mut out = BTreeMap::new();
6447 for root in roots {
6448 walk(root, &mut out);
6449 }
6450 out
6451 }
6452
6453 struct Host {
6454 _root: tempfile::TempDir,
6455 paths: AppPaths,
6456 binary: PathBuf,
6457 runner_root: LocalAbsolutePath,
6466 controls: RecordingControls,
6467 }
6468
6469 impl Host {
6470 fn new() -> Self {
6471 let root = tempfile::tempdir().expect("a temporary directory");
6472 let paths = AppPaths::rooted_at(root.path());
6473 paths.create_all().expect("the four directories");
6474 let binary = root.path().join(if cfg!(windows) {
6475 "runner-manager.exe"
6476 } else {
6477 "runner-manager"
6478 });
6479 std::fs::write(&binary, b"not a real binary").expect("a stand-in binary");
6480 let runner_root = LocalAbsolutePath::new(
6481 root.path()
6482 .join("runner-root")
6483 .to_str()
6484 .expect("a unicode temporary path"),
6485 )
6486 .expect("a local absolute path");
6487 Self {
6488 _root: root,
6489 paths,
6490 binary,
6491 runner_root,
6492 controls: RecordingControls::new(),
6493 }
6494 }
6495
6496 fn operations(&self) -> ServiceOperations {
6497 ServiceOperations::with_controls(
6498 self.paths.clone(),
6499 ServiceIdentity::product(),
6500 std::sync::Arc::new(self.controls.clone()),
6501 )
6502 .with_runner_root(self.runner_root.clone())
6503 }
6504
6505 fn request(&self, mode: StartMode) -> InstallRequest {
6506 InstallRequest::new(mode).for_binary(&self.binary)
6507 }
6508 }
6509
6510 #[cfg(windows)]
6511 #[test]
6512 fn windows_uninstall_waits_through_the_marked_for_deletion_window() {
6513 let probes = std::cell::Cell::new(0);
6514 let absent =
6515 super::sys::wait_until_scm_absent(Duration::from_secs(1), Duration::ZERO, || {
6516 let next = probes.get() + 1;
6517 probes.set(next);
6518 Ok(next == 3)
6519 })
6520 .expect("the simulated SCM probe succeeds");
6521
6522 assert!(absent);
6523 assert_eq!(
6524 probes.get(),
6525 3,
6526 "uninstall must recheck after transient presence instead of treating it as a leak"
6527 );
6528 }
6529
6530 #[test]
6531 fn launchd_enable_failure_is_returned_and_removes_the_bootstrapped_registration() {
6532 let root = tempfile::tempdir().expect("a temporary directory");
6533 let plist = root.path().join("fixture.plist");
6534 std::fs::write(&plist, b"fixture").expect("a plist fixture");
6535 let calls = std::cell::RefCell::new(Vec::new());
6536
6537 let error = enable_launchd_registration(
6538 |arguments| {
6539 let call = arguments
6540 .iter()
6541 .map(|argument| argument.to_string_lossy().into_owned())
6542 .collect::<Vec<_>>();
6543 let operation = call[0].clone();
6544 calls.borrow_mut().push(call);
6545 if operation == "enable" {
6546 (false, "label remains disabled".to_string())
6547 } else {
6548 (true, String::new())
6549 }
6550 },
6551 "system",
6552 "system/com.openai.runner-manager-selftest",
6553 &plist,
6554 "runner-manager-selftest",
6555 "rerun with administrative rights",
6556 )
6557 .expect_err("enable failure must fail the install");
6558
6559 assert!(
6560 matches!(
6561 error,
6562 ServiceError::Control {
6563 operation: "enable",
6564 ..
6565 }
6566 ),
6567 "{error}"
6568 );
6569 assert_eq!(calls.borrow().len(), 2);
6570 assert_eq!(calls.borrow()[0][0], "enable");
6571 assert_eq!(calls.borrow()[1][0], "bootout");
6572 assert!(!plist.exists(), "rollback must remove the plist");
6573 }
6574
6575 #[test]
6580 fn a_path_with_spaces_survives_a_round_trip_through_a_command_line() {
6581 let plan = windows_plan(StartMode::Boot);
6582 let command_line = plan.command_line();
6583 assert!(
6584 command_line.starts_with('"'),
6585 "a path with a space must be quoted, got {command_line}"
6586 );
6587 assert_eq!(
6588 executable_from_command_line(&command_line).as_deref(),
6589 Some(plan.binary())
6590 );
6591 }
6592
6593 #[test]
6594 fn a_path_without_spaces_is_not_quoted_and_still_reads_back() {
6595 let plan = linux_plan(StartMode::Boot);
6596 let command_line = plan.command_line();
6597 assert!(!command_line.starts_with('"'), "got {command_line}");
6598 assert_eq!(
6599 executable_from_command_line(&command_line).as_deref(),
6600 Some(plan.binary())
6601 );
6602 }
6603
6604 #[test]
6605 fn a_quoted_path_containing_a_quote_reads_back_verbatim() {
6606 let awkward = r#"C:\odd "name"\rm.exe"#;
6609 let quoted = quote_argument(awkward);
6610 assert_eq!(
6611 executable_from_command_line(&format!("{quoted} daemon run"))
6612 .as_deref()
6613 .map(Path::to_string_lossy)
6614 .as_deref(),
6615 Some(awkward)
6616 );
6617 }
6618
6619 #[test]
6620 fn an_empty_command_line_has_no_executable() {
6621 assert_eq!(executable_from_command_line(" "), None);
6622 assert_eq!(executable_from_command_line(""), None);
6623 }
6624
6625 #[test]
6626 fn xml_escaping_round_trips_the_characters_a_path_or_an_account_may_hold() {
6627 let awkward = r#"DOMAIN\R&D <team> "ops""#;
6628 assert_eq!(
6629 xml_escape(awkward),
6630 "DOMAIN\\R&D <team> "ops""
6631 );
6632 assert_eq!(xml_unescape(&xml_escape(awkward)), awkward);
6633 }
6634
6635 #[test]
6640 fn a_restart_delay_under_the_floor_is_refused() {
6641 let error = RestartPolicy::new(Duration::from_millis(500), Duration::from_secs(60))
6642 .expect_err("half a second is under the one-second floor");
6643 assert!(
6644 matches!(error, ServiceError::RestartDelay { .. }),
6645 "{error}"
6646 );
6647 }
6648
6649 #[test]
6650 fn a_restart_delay_over_the_ceiling_is_refused() {
6651 let error = RestartPolicy::new(Duration::from_secs(3600), Duration::from_secs(7200))
6652 .expect_err("an hour is over the five-minute ceiling");
6653 assert!(
6654 matches!(error, ServiceError::RestartDelay { .. }),
6655 "{error}"
6656 );
6657 }
6658
6659 #[test]
6660 fn a_reset_window_no_longer_than_the_delay_is_refused() {
6661 let error = RestartPolicy::new(Duration::from_secs(15), Duration::from_secs(15))
6662 .expect_err("a window equal to the delay can never elapse between restarts");
6663 assert!(
6664 matches!(error, ServiceError::RestartResetWindow { .. }),
6665 "{error}"
6666 );
6667 }
6668
6669 #[test]
6670 fn a_delay_inside_the_bound_is_accepted() {
6671 let policy = RestartPolicy::new(Duration::from_secs(20), Duration::from_secs(300))
6672 .expect("twenty seconds is inside the bound");
6673 assert_eq!(policy.delay(), Duration::from_secs(20));
6674 assert_eq!(policy.reset_after(), Duration::from_secs(300));
6675 }
6676
6677 #[test]
6682 fn a_fixture_identity_can_never_be_the_product_identity() {
6683 let fixture = ServiceIdentity::fixture("abc123");
6684 assert!(fixture.is_fixture());
6685 assert!(!ServiceIdentity::product().is_fixture());
6686 assert_ne!(fixture.name(), ServiceIdentity::product().name());
6687 assert_ne!(
6688 fixture.launchd_label(),
6689 ServiceIdentity::product().launchd_label()
6690 );
6691 assert_ne!(
6692 fixture.systemd_unit(),
6693 ServiceIdentity::product().systemd_unit()
6694 );
6695 }
6696
6697 #[test]
6698 fn a_fixture_tag_is_reduced_to_characters_every_manager_accepts() {
6699 let fixture = ServiceIdentity::fixture("A b/c:\\d");
6700 assert!(
6701 fixture
6702 .name()
6703 .chars()
6704 .all(|c| c.is_ascii_lowercase() || c.is_ascii_digit() || c == '-'),
6705 "got {}",
6706 fixture.name()
6707 );
6708 }
6709
6710 #[test]
6715 fn the_boot_unit_restarts_on_failure_after_the_bounded_delay() {
6716 let unit = systemd_unit(&linux_plan(StartMode::Boot));
6717 assert!(unit.contains("KillMode=process\n"), "{unit}");
6718 assert!(unit.contains("Restart=on-failure\n"), "{unit}");
6719 assert!(unit.contains("RestartSec=15\n"), "{unit}");
6720 assert!(unit.contains("StartLimitIntervalSec=600\n"), "{unit}");
6721 assert!(unit.contains("StartLimitBurst=5\n"), "{unit}");
6722 assert!(unit.contains("WantedBy=multi-user.target\n"), "{unit}");
6723 }
6724
6725 #[test]
6726 fn the_boot_unit_reads_the_live_store_instead_of_a_frozen_systemd_copy() {
6727 let unit = systemd_unit(&linux_plan(StartMode::Boot));
6728 assert!(
6729 !unit.contains("LoadCredential="),
6730 "a startup snapshot would shadow every rotated credential until restart:\n{unit}"
6731 );
6732 }
6733
6734 #[test]
6735 fn a_login_unit_carries_no_machine_credential_and_wants_the_session_target() {
6736 let unit = systemd_unit(&linux_plan(StartMode::Login));
6737 assert!(
6738 !unit.contains("LoadCredential="),
6739 "a user unit must not name a root-owned credential file, got:\n{unit}"
6740 );
6741 assert!(unit.contains("WantedBy=default.target\n"), "{unit}");
6742 }
6743
6744 #[test]
6745 fn the_unit_can_atomically_replace_the_credential_and_write_only_required_directories() {
6746 let plan = linux_plan(StartMode::Boot);
6747 let unit = systemd_unit(&plan);
6748 let directives = ini_directives(&unit, "Service");
6749 let listed = split_quoted(
6750 directives
6751 .get("ReadWritePaths")
6752 .expect("the unit names its writable paths"),
6753 );
6754 assert_eq!(listed.len(), 5, "{listed:?}");
6755 for path in plan.directories().all() {
6756 assert!(
6757 listed.iter().any(|entry| entry == &path.to_string_lossy()),
6758 "{} is missing from {listed:?}",
6759 path.display()
6760 );
6761 }
6762 assert!(
6763 listed
6764 .iter()
6765 .any(|entry| entry == "/var/lib/runner-manager/secrets"),
6766 "atomic credential replacement needs its parent directory in {listed:?}"
6767 );
6768 }
6769
6770 #[test]
6771 fn the_unit_records_the_absolute_binary_path() {
6772 let plan = linux_plan(StartMode::Boot);
6773 let unit = systemd_unit(&plan);
6774 assert!(
6775 unit.contains("ExecStart=/opt/runner-manager/bin/runner-manager daemon run\n"),
6776 "{unit}"
6777 );
6778 }
6779
6780 #[test]
6785 fn the_daemon_restarts_only_after_an_unsuccessful_exit() {
6786 let plist = launchd_plist(&linux_plan(StartMode::Boot));
6787 assert!(
6790 plist.contains(
6791 "<key>KeepAlive</key>\n <dict>\n <key>SuccessfulExit</key>\n <false/>\n"
6792 ),
6793 "{plist}"
6794 );
6795 assert!(
6796 plist.contains("<key>ThrottleInterval</key>\n <integer>15</integer>"),
6797 "{plist}"
6798 );
6799 }
6800
6801 #[test]
6802 fn a_launch_daemon_names_root_and_a_launch_agent_names_nobody() {
6803 let daemon = launchd_plist(&linux_plan(StartMode::Boot));
6804 assert_eq!(
6805 plist_string_value(&daemon, "UserName").as_deref(),
6806 Some("root")
6807 );
6808 assert_eq!(plist_bool_value(&daemon, "SessionCreate"), Some(false));
6809
6810 let agent = launchd_plist(&linux_plan(StartMode::Login));
6811 assert_eq!(
6812 plist_string_value(&agent, "UserName"),
6813 None,
6814 "a LaunchAgent already runs as the operator:\n{agent}"
6815 );
6816 }
6817
6818 #[test]
6819 fn the_plist_records_the_absolute_binary_path_and_the_daemon_arguments() {
6820 let plist = launchd_plist(&linux_plan(StartMode::Boot));
6821 assert!(
6822 plist.contains("<string>/opt/runner-manager/bin/runner-manager</string>"),
6823 "{plist}"
6824 );
6825 assert!(plist.contains("<string>daemon</string>"), "{plist}");
6826 assert!(plist.contains("<string>run</string>"), "{plist}");
6827 }
6828
6829 #[test]
6830 fn the_launchd_label_is_the_product_identity_in_reverse_domain_form() {
6831 assert_eq!(
6832 ServiceIdentity::product().launchd_label(),
6833 "io.github.IvanMurzak.runner-manager"
6834 );
6835 }
6836
6837 #[test]
6842 fn the_task_runs_at_least_privilege_on_a_logon_trigger() {
6843 let xml = windows_scheduled_task_xml(
6844 &windows_plan(StartMode::Login),
6845 &TaskPrincipal::named("HOST\\operator"),
6846 );
6847 assert!(xml.contains("<LogonTrigger>"), "{xml}");
6848 assert!(xml.contains("<RunLevel>LeastPrivilege</RunLevel>"), "{xml}");
6849 assert!(
6850 xml.contains("<LogonType>InteractiveToken</LogonType>"),
6851 "{xml}"
6852 );
6853 assert!(xml.contains("<UserId>HOST\\operator</UserId>"), "{xml}");
6854 assert!(
6855 xml.contains("<Interval>PT1M</Interval>"),
6856 "Task Scheduler takes whole minutes only, and rejects the registration outright \
6857 for anything finer:\n{xml}"
6858 );
6859 }
6860
6861 #[test]
6862 fn task_schedulers_minute_granularity_only_ever_rounds_the_delay_up() {
6863 for (asked, enforced) in [(1u64, 60u64), (15, 60), (60, 60), (61, 120), (300, 300)] {
6868 let policy =
6869 RestartPolicy::new(Duration::from_secs(asked), Duration::from_secs(asked + 600))
6870 .expect("inside the supported range");
6871 assert_eq!(
6872 policy
6873 .effective_delay(DefinitionKind::WindowsScheduledTask)
6874 .as_secs(),
6875 enforced,
6876 "a {asked}s delay must be enforced as {enforced}s"
6877 );
6878 assert!(
6879 policy.effective_delay(DefinitionKind::WindowsScheduledTask) >= policy.delay(),
6880 "rounding must never shorten the bound"
6881 );
6882 }
6883 }
6884
6885 #[test]
6886 fn every_other_manager_enforces_the_delay_exactly_as_configured() {
6887 let policy = RestartPolicy::default();
6888 for kind in [
6889 DefinitionKind::WindowsService,
6890 DefinitionKind::LaunchdPlist,
6891 DefinitionKind::SystemdUnit,
6892 ] {
6893 assert_eq!(
6894 policy.effective_delay(kind),
6895 policy.delay(),
6896 "{kind:?} takes seconds and enforces exactly what it is given"
6897 );
6898 }
6899 }
6900
6901 #[test]
6902 fn a_task_whose_manager_reports_the_rounded_delay_is_not_a_fault() {
6903 let host = Host::new();
6904 let operations = host.operations();
6905 operations
6906 .install(&host.request(StartMode::Login))
6907 .expect("an install at login");
6908 host.controls.edit("runner-manager", |registration| {
6910 registration.manager = DefinitionKind::WindowsScheduledTask;
6911 registration.restart_delay = Some(Duration::from_secs(60));
6912 });
6913
6914 let status = operations.status().expect("a status");
6915 assert!(
6916 status.is_healthy(),
6917 "minute granularity is the manager's, not a mis-registration: {status}"
6918 );
6919 assert!(
6920 status
6921 .notes()
6922 .iter()
6923 .any(|note| note.contains("whole minutes")),
6924 "but the operator must be told why 15 became 60: {status}"
6925 );
6926
6927 host.controls.edit("runner-manager", |registration| {
6930 registration.restart_delay = Some(Duration::from_secs(1));
6931 });
6932 assert!(
6933 !operations.status().expect("a status").is_healthy(),
6934 "a one-second delay is not what any manager was asked for"
6935 );
6936 }
6937
6938 #[test]
6939 fn the_task_records_the_absolute_binary_path_and_the_daemon_arguments() {
6940 let plan = windows_plan(StartMode::Login);
6941 let xml = windows_scheduled_task_xml(&plan, &TaskPrincipal::named("HOST\\operator"));
6942 assert_eq!(
6943 xml_value(&xml, "Command").as_deref(),
6944 Some("C:\\Program Files\\runner-manager\\runner-manager.exe"),
6945 "{xml}"
6946 );
6947 assert_eq!(xml_value(&xml, "Arguments").as_deref(), Some("daemon run"));
6948 }
6949
6950 #[test]
6951 fn an_account_name_holding_xml_punctuation_is_escaped() {
6952 let xml = windows_scheduled_task_xml(
6953 &windows_plan(StartMode::Login),
6954 &TaskPrincipal::named("R&D\\ops"),
6955 );
6956 assert!(xml.contains("<UserId>R&D\\ops</UserId>"), "{xml}");
6957 assert_eq!(xml_value(&xml, "UserId").as_deref(), Some("R&D\\ops"));
6958 }
6959
6960 #[test]
6965 fn the_service_starts_automatically_under_the_account_the_store_admits() {
6966 let text = windows_service_descriptor(&windows_plan(StartMode::Boot));
6967 let directives = ini_directives(&text, "windows-service");
6968 assert_eq!(
6969 directives.get("StartType").map(String::as_str),
6970 Some("AutoStart")
6971 );
6972 assert_eq!(
6973 directives.get("Account").map(String::as_str),
6974 Some("NT AUTHORITY\\SYSTEM")
6975 );
6976 assert_eq!(
6977 directives.get("ServiceType").map(String::as_str),
6978 Some("OWN_PROCESS")
6979 );
6980 assert_eq!(
6981 directives
6982 .get("FailureActionRestartDelaySecs")
6983 .map(String::as_str),
6984 Some("15")
6985 );
6986 assert_eq!(
6987 directives
6988 .get("FailureActionsOnNonCrashFailures")
6989 .map(String::as_str),
6990 Some("true"),
6991 "without this flag a non-zero exit is not a failure the manager restarts"
6992 );
6993 }
6994
6995 #[test]
6996 fn the_service_spec_leaves_the_account_unnamed_so_the_api_means_local_system() {
6997 let spec = windows_service_spec(&windows_plan(StartMode::Boot));
6998 assert_eq!(spec.account, None);
6999 assert!(spec.automatic_start);
7000 assert!(
7001 spec.command_line.contains("daemon run"),
7002 "{}",
7003 spec.command_line
7004 );
7005 }
7006
7007 #[test]
7012 fn each_definition_goes_where_its_platform_expects_it() {
7013 let home = PathBuf::from("/home/op");
7014 assert_eq!(
7015 ServiceDefinition::launchd(&linux_plan(StartMode::Boot), Some(&home)).install_path(),
7016 Some(Path::new(
7017 "/Library/LaunchDaemons/io.github.IvanMurzak.runner-manager.plist"
7018 ))
7019 );
7020 assert_eq!(
7021 ServiceDefinition::launchd(&linux_plan(StartMode::Login), Some(&home)).install_path(),
7022 Some(Path::new(
7023 "/home/op/Library/LaunchAgents/io.github.IvanMurzak.runner-manager.plist"
7024 ))
7025 );
7026 assert_eq!(
7027 ServiceDefinition::systemd(&linux_plan(StartMode::Boot), Some(&home)).install_path(),
7028 Some(Path::new("/etc/systemd/system/runner-manager.service"))
7029 );
7030 assert_eq!(
7031 ServiceDefinition::systemd(&linux_plan(StartMode::Login), Some(&home)).install_path(),
7032 Some(Path::new(
7033 "/home/op/.config/systemd/user/runner-manager.service"
7034 ))
7035 );
7036 assert_eq!(
7037 ServiceDefinition::windows_service(&windows_plan(StartMode::Boot)).install_path(),
7038 None,
7039 "the Service Control Manager has no file"
7040 );
7041 }
7042
7043 #[test]
7044 fn a_login_definition_without_a_home_directory_has_nowhere_to_go() {
7045 assert_eq!(
7046 ServiceDefinition::systemd(&linux_plan(StartMode::Login), None).install_path(),
7047 None
7048 );
7049 assert_eq!(
7050 ServiceDefinition::launchd(&linux_plan(StartMode::Login), None).install_path(),
7051 None
7052 );
7053 }
7054
7055 #[test]
7060 fn the_rendered_definitions_are_all_least_privilege() {
7061 let linux = linux_plan(StartMode::Boot);
7062 let windows = windows_plan(StartMode::Boot);
7063 for (definition, plan) in [
7064 (ServiceDefinition::systemd(&linux, None), &linux),
7065 (ServiceDefinition::launchd(&linux, None), &linux),
7066 (ServiceDefinition::windows_service(&windows), &windows),
7067 ] {
7068 let review = review_least_privilege(&definition, plan);
7069 assert!(
7070 review.is_least_privilege(),
7071 "{:?} should be least privilege, got:\n{review}",
7072 definition.kind()
7073 );
7074 assert!(
7075 !review.controls().is_empty(),
7076 "a review that confirms nothing proves nothing: {:?}",
7077 definition.kind()
7078 );
7079 }
7080 }
7081
7082 #[test]
7083 fn the_rendered_task_is_least_privilege_and_says_what_it_checked() {
7084 let plan = windows_plan(StartMode::Login);
7085 let definition =
7086 ServiceDefinition::windows_scheduled_task(&plan, &TaskPrincipal::named("HOST\\op"));
7087 let review = review_least_privilege(&definition, &plan);
7088 assert!(review.is_least_privilege(), "{review}");
7089 assert!(
7090 review
7091 .controls()
7092 .iter()
7093 .any(|control| control.contains("LeastPrivilege")),
7094 "{review}"
7095 );
7096 }
7097
7098 #[test]
7099 fn a_unit_that_makes_one_more_directory_writable_is_not_least_privilege() {
7100 let plan = linux_plan(StartMode::Boot);
7101 let rendered = systemd_unit(&plan);
7102 let widened = edited(
7103 &rendered,
7104 "ReadWritePaths=/var/lib/runner-manager/config",
7105 "ReadWritePaths=/etc /var/lib/runner-manager/config",
7106 );
7107 let review = review_least_privilege(
7108 &ServiceDefinition::from_text(DefinitionKind::SystemdUnit, widened),
7109 &plan,
7110 );
7111 assert!(!review.is_least_privilege(), "{review}");
7112 assert!(
7113 review
7114 .excesses()
7115 .iter()
7116 .any(|finding| finding.detail.contains("/etc")),
7117 "the review must name the directory it objects to: {review}"
7118 );
7119 }
7120
7121 #[test]
7122 fn a_unit_that_drops_a_hardening_directive_is_not_least_privilege() {
7123 let plan = linux_plan(StartMode::Boot);
7124 let rendered = systemd_unit(&plan);
7125 let weakened = edited(&rendered, "NoNewPrivileges=yes\n", "");
7126 let review = review_least_privilege(
7127 &ServiceDefinition::from_text(DefinitionKind::SystemdUnit, weakened),
7128 &plan,
7129 );
7130 assert!(!review.is_least_privilege(), "{review}");
7131 assert!(
7132 review
7133 .excesses()
7134 .iter()
7135 .any(|finding| finding.subject == "NoNewPrivileges"),
7136 "{review}"
7137 );
7138 }
7139
7140 #[test]
7141 fn a_unit_that_keeps_capabilities_is_not_least_privilege() {
7142 let plan = linux_plan(StartMode::Boot);
7143 let rendered = systemd_unit(&plan);
7144 let widened = edited(
7145 &rendered,
7146 "CapabilityBoundingSet=\n",
7147 "CapabilityBoundingSet=CAP_NET_ADMIN CAP_SYS_ADMIN\n",
7148 );
7149 let review = review_least_privilege(
7150 &ServiceDefinition::from_text(DefinitionKind::SystemdUnit, widened),
7151 &plan,
7152 );
7153 assert!(!review.is_least_privilege(), "{review}");
7154 assert!(
7155 review
7156 .excesses()
7157 .iter()
7158 .any(|finding| finding.subject == "CapabilityBoundingSet"),
7159 "{review}"
7160 );
7161 }
7162
7163 #[test]
7164 fn a_unit_that_opens_a_listening_socket_is_not_least_privilege() {
7165 let plan = linux_plan(StartMode::Boot);
7166 let rendered = systemd_unit(&plan);
7167 let widened = edited(
7168 &rendered,
7169 "[Install]",
7170 "ListenStream=127.0.0.1:9000\n\n[Install]",
7171 );
7172 let review = review_least_privilege(
7173 &ServiceDefinition::from_text(DefinitionKind::SystemdUnit, widened),
7174 &plan,
7175 );
7176 assert!(
7177 !review.is_least_privilege(),
7178 "07-security.md rule 2 forbids any inbound surface: {review}"
7179 );
7180 }
7181
7182 #[test]
7183 fn a_unit_that_makes_a_directory_unwritable_is_a_shortfall_not_an_excess() {
7184 let plan = linux_plan(StartMode::Boot);
7185 let rendered = systemd_unit(&plan);
7186 let narrowed = edited(&rendered, " /var/lib/runner-manager/runtime", "");
7187 let review = review_least_privilege(
7188 &ServiceDefinition::from_text(DefinitionKind::SystemdUnit, narrowed),
7189 &plan,
7190 );
7191 assert!(
7192 review.is_least_privilege(),
7193 "too little authority is not an excess: {review}"
7194 );
7195 assert!(
7196 review
7197 .findings()
7198 .iter()
7199 .any(|finding| finding.kind == FindingKind::Shortfall
7200 && finding.detail.contains("runtime")),
7201 "{review}"
7202 );
7203 }
7204
7205 #[test]
7206 fn a_launch_agent_that_names_an_account_is_not_least_privilege() {
7207 let plan = linux_plan(StartMode::Login);
7208 let rendered = launchd_plist(&plan);
7209 let widened = edited(
7210 &rendered,
7211 "<key>ProcessType</key>",
7212 "<key>UserName</key>\n <string>root</string>\n <key>ProcessType</key>",
7213 );
7214 let review = review_least_privilege(
7215 &ServiceDefinition::from_text(DefinitionKind::LaunchdPlist, widened),
7216 &plan,
7217 );
7218 assert!(!review.is_least_privilege(), "{review}");
7219 assert!(
7220 review
7221 .excesses()
7222 .iter()
7223 .any(|finding| finding.subject == "UserName"),
7224 "{review}"
7225 );
7226 }
7227
7228 #[test]
7229 fn a_launch_daemon_that_asks_for_a_session_is_not_least_privilege() {
7230 let plan = linux_plan(StartMode::Boot);
7231 let rendered = launchd_plist(&plan);
7232 let widened = edited(
7233 &rendered,
7234 "<key>SessionCreate</key>\n <false/>",
7235 "<key>SessionCreate</key>\n <true/>",
7236 );
7237 let review = review_least_privilege(
7238 &ServiceDefinition::from_text(DefinitionKind::LaunchdPlist, widened),
7239 &plan,
7240 );
7241 assert!(!review.is_least_privilege(), "{review}");
7242 assert!(
7243 review
7244 .excesses()
7245 .iter()
7246 .any(|finding| finding.subject == "SessionCreate"),
7247 "{review}"
7248 );
7249 }
7250
7251 #[test]
7252 fn a_launchd_job_that_publishes_a_mach_service_is_not_least_privilege() {
7253 let plan = linux_plan(StartMode::Boot);
7254 let rendered = launchd_plist(&plan);
7255 let widened = edited(
7256 &rendered,
7257 "<key>ProcessType</key>",
7258 "<key>MachServices</key>\n <dict/>\n <key>ProcessType</key>",
7259 );
7260 let review = review_least_privilege(
7261 &ServiceDefinition::from_text(DefinitionKind::LaunchdPlist, widened),
7262 &plan,
7263 );
7264 assert!(!review.is_least_privilege(), "{review}");
7265 }
7266
7267 #[test]
7268 fn a_task_asking_for_the_highest_available_token_is_not_least_privilege() {
7269 let plan = windows_plan(StartMode::Login);
7270 let rendered = windows_scheduled_task_xml(&plan, &TaskPrincipal::named("HOST\\op"));
7271 let widened = edited(
7272 &rendered,
7273 "<RunLevel>LeastPrivilege</RunLevel>",
7274 "<RunLevel>HighestAvailable</RunLevel>",
7275 );
7276 let review = review_least_privilege(
7277 &ServiceDefinition::from_text(DefinitionKind::WindowsScheduledTask, widened),
7278 &plan,
7279 );
7280 assert!(!review.is_least_privilege(), "{review}");
7281 assert!(
7282 review
7283 .excesses()
7284 .iter()
7285 .any(|finding| finding.subject == "RunLevel"),
7286 "{review}"
7287 );
7288 }
7289
7290 #[test]
7291 fn a_task_that_would_store_a_password_is_not_least_privilege() {
7292 let plan = windows_plan(StartMode::Login);
7293 let rendered = windows_scheduled_task_xml(&plan, &TaskPrincipal::named("HOST\\op"));
7294 let widened = edited(
7295 &rendered,
7296 "<LogonType>InteractiveToken</LogonType>",
7297 "<LogonType>Password</LogonType>",
7298 );
7299 let review = review_least_privilege(
7300 &ServiceDefinition::from_text(DefinitionKind::WindowsScheduledTask, widened),
7301 &plan,
7302 );
7303 assert!(!review.is_least_privilege(), "{review}");
7304 }
7305
7306 #[test]
7307 fn an_interactive_windows_service_is_not_least_privilege() {
7308 let plan = windows_plan(StartMode::Boot);
7309 let rendered = windows_service_descriptor(&plan);
7310 let widened = edited(
7311 &rendered,
7312 "ServiceType=OWN_PROCESS",
7313 "ServiceType=OWN_PROCESS|INTERACTIVE_PROCESS",
7314 );
7315 let review = review_least_privilege(
7316 &ServiceDefinition::from_text(DefinitionKind::WindowsService, widened),
7317 &plan,
7318 );
7319 assert!(!review.is_least_privilege(), "{review}");
7320 assert!(
7321 review
7322 .excesses()
7323 .iter()
7324 .any(|finding| finding.subject == "ServiceType"),
7325 "{review}"
7326 );
7327 }
7328
7329 #[test]
7330 fn a_windows_service_under_an_account_the_store_dacl_does_not_name_is_reported() {
7331 let plan = windows_plan(StartMode::Boot);
7332 let rendered = windows_service_descriptor(&plan);
7333 let changed = edited(
7334 &rendered,
7335 "Account=NT AUTHORITY\\SYSTEM",
7336 "Account=NT AUTHORITY\\LocalService",
7337 );
7338 let review = review_least_privilege(
7339 &ServiceDefinition::from_text(DefinitionKind::WindowsService, changed),
7340 &plan,
7341 );
7342 assert!(review.is_least_privilege(), "{review}");
7348 assert!(
7349 review.findings().iter().any(|finding| {
7350 finding.kind == FindingKind::Shortfall && finding.subject == "Account"
7351 }),
7352 "{review}"
7353 );
7354 }
7355
7356 #[test]
7361 fn a_recorded_path_that_is_still_there_is_current() {
7362 let host = Host::new();
7363 let state = inspect_binary(&host.binary, Some(&host.binary));
7364 assert!(!state.is_error(), "{state}");
7365 assert!(matches!(state, BinaryPath::Current { .. }), "{state}");
7366 }
7367
7368 #[test]
7369 fn the_npm_upgrade_case_reports_a_stale_path_as_an_error() {
7370 let host = Host::new();
7371 let recorded = host.binary.clone();
7375 let healthy = inspect_binary(&recorded, Some(&recorded));
7376 assert!(
7377 !healthy.is_error(),
7378 "the discriminator: before the binary moves, this must be healthy"
7379 );
7380
7381 std::fs::remove_file(&recorded).expect("the binary moves out from under the record");
7382
7383 let state = inspect_binary(&recorded, Some(&recorded));
7384 assert!(state.is_error(), "{state}");
7385 assert!(matches!(state, BinaryPath::Missing { .. }), "{state}");
7386 assert!(
7387 state.to_string().contains("npm"),
7388 "the message must name the cause an operator will not otherwise connect: {state}"
7389 );
7390 }
7391
7392 #[test]
7393 fn a_directory_at_the_recorded_path_is_not_something_the_manager_can_start() {
7394 let root = tempfile::tempdir().expect("a temporary directory");
7395 let state = inspect_binary(root.path(), None);
7396 assert!(state.is_error(), "{state}");
7397 assert!(matches!(state, BinaryPath::NotExecutable { .. }), "{state}");
7398 }
7399
7400 #[test]
7401 fn a_registration_naming_a_different_binary_is_a_divergence() {
7402 let host = Host::new();
7403 let other = host.binary.with_file_name("something-else");
7404 let state = inspect_binary(&host.binary, Some(&other));
7405 assert!(state.is_error(), "{state}");
7406 assert!(matches!(state, BinaryPath::Diverged { .. }), "{state}");
7407 }
7408
7409 #[test]
7410 fn absence_is_reported_before_divergence() {
7411 let host = Host::new();
7412 let recorded = host.binary.clone();
7413 std::fs::remove_file(&recorded).expect("removable");
7414 let other = recorded.with_file_name("something-else");
7415 assert!(matches!(
7419 inspect_binary(&recorded, Some(&other)),
7420 BinaryPath::Missing { .. }
7421 ));
7422 }
7423
7424 #[test]
7429 fn the_record_round_trips_through_toml() {
7430 let host = Host::new();
7431 let plan = InstallPlan::resolve(
7432 ServiceIdentity::product(),
7433 &host.request(StartMode::Boot),
7434 ServiceDirectories::of(&host.paths),
7435 )
7436 .expect("a resolvable plan");
7437 let definition = ServiceDefinition::from_text(DefinitionKind::SystemdUnit, "[Service]\n");
7438 let record = InstallRecord::of(&plan, &definition, Utc::now());
7439 record.write(&host.paths).expect("a writable record");
7440 let read = InstallRecord::read(&host.paths)
7441 .expect("a readable record")
7442 .expect("a record is there");
7443 assert_eq!(read, record);
7444 assert_eq!(read.binary, host.binary);
7445 assert!(read.binary.is_absolute());
7446 }
7447
7448 #[cfg(unix)]
7457 #[test]
7458 fn the_record_is_not_written_readable_only_by_whoever_installed_it() {
7459 use std::os::unix::fs::PermissionsExt as _;
7460
7461 let host = Host::new();
7462 let plan = InstallPlan::resolve(
7463 ServiceIdentity::product(),
7464 &host.request(StartMode::Boot),
7465 ServiceDirectories::of(&host.paths),
7466 )
7467 .expect("a resolvable plan");
7468 let definition = ServiceDefinition::from_text(DefinitionKind::SystemdUnit, "[Service]\n");
7469 InstallRecord::of(&plan, &definition, Utc::now())
7470 .write(&host.paths)
7471 .expect("a writable record");
7472
7473 let mode = std::fs::metadata(InstallRecord::path(&host.paths))
7474 .expect("the record is there")
7475 .permissions()
7476 .mode()
7477 & 0o777;
7478 assert_eq!(
7479 mode, 0o644,
7480 "the record is mode {mode:04o}; at 0600 an operator cannot read a record `sudo \
7481 service install` wrote, and `service status` fails on their own host. It holds no \
7482 credential and sits in a 0700 directory, so 0644 discloses nothing"
7483 );
7484 }
7485
7486 #[test]
7490 fn a_record_without_a_source_binary_still_reads_and_says_it_has_none() {
7491 let host = Host::new();
7492 let path = InstallRecord::path(&host.paths);
7493 std::fs::write(
7494 &path,
7495 format!(
7496 "schema_version = {RECORD_SCHEMA_VERSION}
7497service_name = \"runner-manager\"
7498 manager = \"systemd\"
7499start_mode = \"boot\"
7500account = \"root\"
7501 binary = \"/x\"
7502arguments = []
7503restart_delay_secs = 15
7504 restart_reset_secs = 600
7505log_file = \"/x\"
7506 installed_at = \"2026-01-01T00:00:00Z\"
7507installed_by_version = \"0.1.0\"
7508 [directories]
7509config = \"/a\"
7510state = \"/b\"
7511runtime = \"/c\"
7512logs = \"/d\"
7513"
7514 ),
7515 )
7516 .expect("a writable record");
7517 let read = InstallRecord::read(&host.paths)
7518 .expect("a record missing an optional field is still readable")
7519 .expect("a record is there");
7520 assert_eq!(
7521 read.source_binary, None,
7522 "the legacy layout has no source, and must not invent one"
7523 );
7524 }
7525
7526 #[test]
7528 fn a_registration_remembers_the_file_it_was_copied_from() {
7529 let host = Host::new();
7530 let source = host.binary.with_file_name("npm-installed-runner-manager");
7531 std::fs::copy(&host.binary, &source).expect("a second file to stand in for the package");
7532 let plan = InstallPlan::resolve(
7533 ServiceIdentity::product(),
7534 &host.request(StartMode::Boot).copied_from(&source),
7535 ServiceDirectories::of(&host.paths),
7536 )
7537 .expect("a resolvable plan");
7538 let definition = ServiceDefinition::from_text(
7539 DefinitionKind::SystemdUnit,
7540 "[Service]
7541",
7542 );
7543 let record = InstallRecord::of(&plan, &definition, Utc::now());
7544 record.write(&host.paths).expect("a writable record");
7545
7546 let read = InstallRecord::read(&host.paths)
7547 .expect("a readable record")
7548 .expect("a record is there");
7549 assert_eq!(read.source_binary.as_deref(), Some(source.as_path()));
7550 assert_ne!(
7551 read.source_binary.as_deref(),
7552 Some(read.binary.as_path()),
7553 "the whole point is that the two are different files: one the service holds open, one the package manager is free to replace"
7554 );
7555 }
7556
7557 #[test]
7558 fn a_record_from_a_schema_this_build_cannot_read_is_refused_with_a_remedy() {
7559 let host = Host::new();
7560 let path = InstallRecord::path(&host.paths);
7561 std::fs::write(
7562 &path,
7563 format!(
7564 "schema_version = {}\nservice_name = \"runner-manager\"\nmanager = \"systemd\"\n\
7565 start_mode = \"boot\"\naccount = \"root\"\nbinary = \"/x\"\narguments = []\n\
7566 restart_delay_secs = 15\nrestart_reset_secs = 600\nlog_file = \"/x\"\n\
7567 installed_at = \"2026-01-01T00:00:00Z\"\ninstalled_by_version = \"0.1.0\"\n\
7568 [directories]\nconfig = \"/a\"\nstate = \"/b\"\nruntime = \"/c\"\nlogs = \"/d\"\n",
7569 RECORD_SCHEMA_VERSION + 1
7570 ),
7571 )
7572 .expect("a writable record");
7573 let error = InstallRecord::read(&host.paths).expect_err("a future schema is refused");
7574 assert!(
7575 matches!(error, ServiceError::RecordUnreadable { .. }),
7576 "{error}"
7577 );
7578 assert!(
7579 error.to_string().contains("service uninstall"),
7580 "the message must say how to recover: {error}"
7581 );
7582 }
7583
7584 #[test]
7585 fn no_record_is_not_an_error() {
7586 let host = Host::new();
7587 assert_eq!(InstallRecord::read(&host.paths).expect("no record"), None);
7588 assert!(!InstallRecord::remove(&host.paths).expect("nothing to remove"));
7589 }
7590
7591 #[test]
7596 fn no_heartbeat_reads_as_never_rather_than_as_the_epoch() {
7597 let host = Host::new();
7598 assert_eq!(last_github_contact(&host.paths).expect("readable"), None);
7599 }
7600
7601 #[test]
7602 fn the_heartbeat_round_trips_to_the_second() {
7603 let host = Host::new();
7604 let at = DateTime::parse_from_rfc3339("2026-08-22T10:11:12Z")
7605 .expect("a valid timestamp")
7606 .with_timezone(&Utc);
7607 record_github_contact(&host.paths, at).expect("a writable heartbeat");
7608 assert_eq!(
7609 last_github_contact(&host.paths).expect("readable"),
7610 Some(at)
7611 );
7612 }
7613
7614 #[test]
7615 fn a_malformed_heartbeat_is_an_error_and_not_silently_never() {
7616 let host = Host::new();
7617 std::fs::write(contact_path(&host.paths), b"this is not toml \x00").expect("writable");
7618 let error = last_github_contact(&host.paths)
7619 .expect_err("a heartbeat that cannot be parsed is not the same as no heartbeat");
7620 assert!(matches!(error, ServiceError::Record { .. }), "{error}");
7621 }
7622
7623 #[test]
7629 fn a_runner_root_refusal_round_trips_for_service_status() {
7630 let host = Host::new();
7631 let at = DateTime::from_timestamp(1_760_000_000, 0).expect("a valid instant");
7632
7633 assert!(
7634 runner_root_refusals(&host.paths)
7635 .expect("readable")
7636 .is_empty(),
7637 "no record means every policy is placing runners"
7638 );
7639
7640 record_runner_root_refusal(
7641 &host.paths,
7642 "policy-a",
7643 at,
7644 "denied_by_privacy_policy",
7645 "/Volumes/NVME/runners",
7646 "the runner root /Volumes/NVME/runners cannot be used: ... Grant Full Disk Access",
7647 )
7648 .expect("a writable record");
7649
7650 let refusals = runner_root_refusals(&host.paths).expect("readable");
7651 assert_eq!(refusals.len(), 1);
7652 assert_eq!(refusals[0].policy, "policy-a");
7653 assert_eq!(refusals[0].at, at);
7654 assert_eq!(refusals[0].kind, "denied_by_privacy_policy");
7655 assert_eq!(refusals[0].root, "/Volumes/NVME/runners");
7656 assert!(
7657 refusals[0].detail.contains("/Volumes/NVME/runners")
7658 && refusals[0].detail.contains("Full Disk Access"),
7659 "the path and the remediation are the whole point of this file: {refusals:?}"
7660 );
7661 }
7662
7663 #[test]
7671 fn one_policy_placing_a_runner_does_not_clear_another_policys_refusal() {
7672 let host = Host::new();
7673 let at = DateTime::from_timestamp(1_760_000_000, 0).expect("a valid instant");
7674 record_runner_root_refusal(
7675 &host.paths,
7676 "broken",
7677 at,
7678 "denied_by_privacy_policy",
7679 "/Volumes/NVME/runners",
7680 "detail",
7681 )
7682 .expect("a writable record");
7683 record_runner_root_refusal(
7684 &host.paths,
7685 "also-broken",
7686 at,
7687 "not_writable",
7688 "/srv/other",
7689 "detail",
7690 )
7691 .expect("a writable record");
7692
7693 clear_runner_root_refusal(&host.paths, "healthy")
7695 .expect("clearing an absent policy is fine");
7696 clear_runner_root_refusal(&host.paths, "also-broken").expect("that policy recovered");
7697
7698 let refusals = runner_root_refusals(&host.paths).expect("readable");
7699 assert_eq!(
7700 refusals
7701 .iter()
7702 .map(|r| r.policy.as_str())
7703 .collect::<Vec<_>>(),
7704 vec!["broken"],
7705 "the policy that is still refused must keep its record"
7706 );
7707 }
7708
7709 #[test]
7712 fn clearing_the_last_refusal_removes_the_file_and_is_idempotent() {
7713 let host = Host::new();
7714 record_runner_root_refusal(
7715 &host.paths,
7716 "p",
7717 Utc::now(),
7718 "not_writable",
7719 "/srv/x",
7720 "detail",
7721 )
7722 .expect("a writable record");
7723
7724 clear_runner_root_refusal(&host.paths, "p").expect("the record is removed");
7725 assert!(
7726 !root_refusal_path(&host.paths).exists(),
7727 "a host with nothing refused leaves nothing behind"
7728 );
7729 clear_runner_root_refusal(&host.paths, "p").expect("removing what is gone is not an error");
7730 }
7731
7732 #[test]
7735 fn a_malformed_refusal_is_an_error_and_not_silently_none() {
7736 let host = Host::new();
7737 std::fs::write(root_refusal_path(&host.paths), b"not toml \x00").expect("writable");
7738 let error = runner_root_refusals(&host.paths)
7739 .expect_err("an unparseable record is not the same as no record");
7740 assert!(matches!(error, ServiceError::Record { .. }), "{error}");
7741 }
7742
7743 #[test]
7753 fn service_status_reports_a_refusal_as_a_note_and_stays_healthy() {
7754 let host = Host::new();
7755 record_runner_root_refusal(
7756 &host.paths,
7757 "policy-a",
7758 DateTime::from_timestamp(1_760_000_000, 0).expect("a valid instant"),
7759 "denied_by_privacy_policy",
7760 "/Volumes/NVME/runners",
7761 "Grant Full Disk Access to the program that runs the service",
7762 )
7763 .expect("a writable record");
7764
7765 let status = host.operations().status().expect("a readable status");
7766 let notes = status.notes().join("\n");
7767
7768 assert!(
7769 notes.contains("/Volumes/NVME/runners") && notes.contains("Full Disk Access"),
7770 "the directory and the remediation the log had to scrub must appear here: {notes}"
7771 );
7772 assert!(
7773 notes.contains("policy-a"),
7774 "the operator has to know which target placed no runner: {notes}"
7775 );
7776 assert!(
7777 !status
7778 .problems()
7779 .iter()
7780 .any(|problem| problem.subject == "runner root"),
7781 "a record nothing an operator types can clear must not drive the exit code"
7782 );
7783 }
7784
7785 #[test]
7791 fn install_records_the_absolute_binary_path_and_the_four_directories() {
7792 let host = Host::new();
7793 let installed = host
7794 .operations()
7795 .install(&host.request(StartMode::Boot))
7796 .expect("an install against the recording controls");
7797
7798 assert_eq!(installed.record.binary, host.binary);
7799 assert!(installed.record.binary.is_absolute());
7800 assert_eq!(installed.record.start_mode, StartMode::Boot);
7801 assert_eq!(installed.record.arguments, vec!["daemon", "run"]);
7802 assert_eq!(
7803 installed.record.directories,
7804 ServiceDirectories::of(&host.paths)
7805 );
7806 assert_eq!(
7807 installed.record.log_file,
7808 host.paths.logs_dir().join(LOG_FILE_STEM)
7809 );
7810 assert_eq!(installed.record.restart_delay_secs, 15);
7811
7812 let registrations = host.controls.registrations();
7813 assert_eq!(registrations.len(), 1);
7814 assert_eq!(registrations[0].0, StartMode::Boot);
7815 assert_eq!(registrations[0].1, "runner-manager");
7816 }
7817
7818 #[test]
7819 fn install_is_refused_while_the_single_instance_lock_is_held() {
7820 let host = Host::new();
7821 {
7823 let operations = host.operations();
7824 operations
7825 .install(&host.request(StartMode::Boot))
7826 .expect("an install with the lock free");
7827 operations.uninstall().expect("a clean slate");
7828 }
7829
7830 let _held = HostLock::try_acquire(&host.paths, LockKind::SingleInstance)
7831 .expect("this process takes the lock first");
7832
7833 let error = host
7834 .operations()
7835 .install(&host.request(StartMode::Boot))
7836 .expect_err("a second agent must not be registered while one is running");
7837 assert!(matches!(error, ServiceError::LockHeld { .. }), "{error}");
7838 assert!(
7839 error.to_string().contains("already running"),
7840 "the message must be actionable: {error}"
7841 );
7842 assert!(
7843 host.controls.registrations().is_empty(),
7844 "a refused install must register nothing"
7845 );
7846 assert_eq!(
7847 InstallRecord::read(&host.paths).expect("readable"),
7848 None,
7849 "a refused install must write no record"
7850 );
7851 }
7852
7853 #[test]
7861 fn installing_over_the_same_start_mode_replaces_the_registration() {
7862 let host = Host::new();
7863 let operations = host.operations();
7864 operations
7865 .install(&host.request(StartMode::Boot))
7866 .expect("the first install");
7867
7868 let again = operations
7869 .install(&host.request(StartMode::Boot))
7870 .expect("an install over the same mode replaces rather than refusing");
7871
7872 assert!(
7873 again.replaced_existing,
7874 "the operator is told this replaced something rather than made it"
7875 );
7876 assert_eq!(
7877 host.controls.registrations().len(),
7878 1,
7879 "replacing must not leave two registrations behind"
7880 );
7881 assert_eq!(
7882 InstallRecord::read(&host.paths)
7883 .expect("readable")
7884 .expect("a record")
7885 .start_mode,
7886 StartMode::Boot
7887 );
7888 }
7889
7890 #[test]
7894 fn installing_over_the_other_start_mode_is_refused() {
7895 let host = Host::new();
7896 let operations = host.operations();
7897 operations
7898 .install(&host.request(StartMode::Boot))
7899 .expect("the first install");
7900
7901 let error = operations
7902 .install(&host.request(StartMode::Login))
7903 .expect_err("a mode change is not an install");
7904 assert!(
7905 matches!(
7906 error,
7907 ServiceError::AlreadyInstalled {
7908 existing: StartMode::Boot,
7909 requested: StartMode::Login,
7910 ..
7911 }
7912 ),
7913 "{error}"
7914 );
7915 assert!(
7916 !error
7917 .to_string()
7918 .contains("switch the start mode in place,"),
7919 "the old remedy named a capability no command offers; the terminal UI is where \
7920 the start mode moves: {error}"
7921 );
7922 assert_eq!(host.controls.registrations().len(), 1);
7923 }
7924
7925 #[test]
7926 fn install_rolls_back_the_registration_when_record_persistence_fails() {
7927 let host = Host::new();
7928 let record_path = InstallRecord::path(&host.paths);
7929 std::fs::create_dir(&record_path).expect("a directory blocks the record file");
7930
7931 let error = host
7932 .operations()
7933 .install(&host.request(StartMode::Boot))
7934 .expect_err("record persistence must fail");
7935
7936 assert!(matches!(error, ServiceError::Record { .. }), "{error}");
7937 assert!(
7938 host.controls.registrations().is_empty(),
7939 "a failed install must not leave a live unrecorded registration"
7940 );
7941 assert!(
7942 host.controls
7943 .calls()
7944 .iter()
7945 .any(|call| call == "uninstall runner-manager (boot)"),
7946 "the registration must be explicitly rolled back: {:?}",
7947 host.controls.calls()
7948 );
7949 assert!(
7950 !host.runner_root.as_path().exists(),
7951 "the rollback must take the runner root this install created with it; a directory \
7952 prepared for a registration that does not exist is litter, and on Windows it is \
7953 litter with a security descriptor"
7954 );
7955 }
7956
7957 #[test]
7962 fn the_runner_root_a_boot_registration_needs_admits_only_the_service() {
7963 use crate::runner_root_access::{RootAdmission, default_root_sddl, grants_broad_write};
7964
7965 assert_eq!(
7969 ServiceAccount::for_definition(DefinitionKind::WindowsService, StartMode::Boot),
7970 ServiceAccount::LocalSystem
7971 );
7972 assert_eq!(
7973 ServiceAccount::for_definition(DefinitionKind::WindowsScheduledTask, StartMode::Login),
7974 ServiceAccount::InvokingUser
7975 );
7976
7977 let boot = default_root_sddl(&RootAdmission::LocalSystem);
7978 assert!(!grants_broad_write(&boot), "{boot}");
7979 assert!(
7980 !boot.contains("S-1-5-21"),
7981 "a boot registration runs as LocalSystem, so its root names no operator: {boot}"
7982 );
7983
7984 let login = default_root_sddl(&RootAdmission::Account("S-1-5-21-1-2-3-1001".to_owned()));
7989 assert!(login.contains("S-1-5-21-1-2-3-1001"), "{login}");
7990 assert!(!grants_broad_write(&login), "{login}");
7991 }
7992
7993 #[test]
7994 fn an_install_reports_the_runner_root_it_prepared() {
7995 let host = Host::new();
7996 let installed = host
7997 .operations()
7998 .install(&host.request(StartMode::Boot))
7999 .expect("an install");
8000 let rendered = installed.runner_root.to_string();
8001 assert!(
8002 !rendered.contains("S-1-5-21"),
8003 "the report must add no identity to the output: {rendered}"
8004 );
8005 if cfg!(windows) {
8006 assert_eq!(
8007 installed.runner_root.path(),
8008 Some(host.runner_root.as_path())
8009 );
8010 assert!(
8011 host.runner_root.as_path().is_dir(),
8012 "the directory jobs would run in has to exist once the service is registered"
8013 );
8014 } else {
8015 assert_eq!(
8016 installed.runner_root,
8017 crate::runner_root_access::RootAccessSummary::NotApplicable,
8018 "macOS and Linux keep the runtime directory they have always used"
8019 );
8020 }
8021 }
8022
8023 #[test]
8024 fn switching_start_mode_reconciles_the_runner_root_for_the_new_account() {
8025 let host = Host::new();
8026 let operations = host.operations();
8027 operations
8028 .install(&host.request(StartMode::Boot))
8029 .expect("an install at boot");
8030
8031 let change = operations
8032 .set_start_mode(StartMode::Login)
8033 .expect("a switch to login");
8034
8035 assert!(change.changed);
8036 if cfg!(windows) {
8037 assert_eq!(change.runner_root.path(), Some(host.runner_root.as_path()));
8038 assert!(
8039 host.runner_root.as_path().is_dir(),
8040 "the switch must not remove the directory it reconciled"
8041 );
8042 }
8043 assert!(
8046 change.to_string().contains("runner root"),
8047 "{}",
8048 change.to_string()
8049 );
8050 }
8051
8052 #[test]
8053 fn switching_to_the_mode_already_in_force_touches_no_runner_root() {
8054 let host = Host::new();
8055 let operations = host.operations();
8056 operations
8057 .install(&host.request(StartMode::Boot))
8058 .expect("an install at boot");
8059
8060 let change = operations
8061 .set_start_mode(StartMode::Boot)
8062 .expect("a switch to the mode already in force");
8063
8064 assert!(!change.changed);
8065 assert_eq!(
8066 change.runner_root,
8067 crate::runner_root_access::RootAccessSummary::NotApplicable,
8068 "nothing moves, so nothing about the root's access control has to; reconciling here \
8069 would turn a no-op command into one that can fail on a permission it does not need"
8070 );
8071 }
8072
8073 #[cfg(windows)]
8074 #[test]
8075 fn a_registration_the_manager_refuses_leaves_no_runner_root_behind() {
8076 let host = Host::new();
8077 host.controls
8078 .fail_next_install(StartMode::Boot, "injected registration failure");
8079
8080 let error = host
8081 .operations()
8082 .install(&host.request(StartMode::Boot))
8083 .expect_err("the manager refuses the registration");
8084
8085 assert!(matches!(error, ServiceError::Control { .. }), "{error}");
8086 assert!(
8087 !host.runner_root.as_path().exists(),
8088 "the directory was created for a registration that does not exist"
8089 );
8090 }
8091
8092 #[cfg(windows)]
8093 #[test]
8094 fn an_existing_broad_runner_root_refuses_the_install_before_anything_is_registered() {
8095 let host = Host::new();
8096 crate::runner_root_access::create_with_descriptor_for_tests(
8100 host.runner_root.as_path(),
8101 "D:P(A;OICI;FA;;;SY)(A;OICI;FA;;;WD)",
8102 )
8103 .expect("a deliberately open runner root");
8104 let before = crate::runner_root_access::report(host.runner_root.as_path());
8105
8106 let error = host
8107 .operations()
8108 .install(&host.request(StartMode::Boot))
8109 .expect_err("an open runner root is refused");
8110
8111 assert!(matches!(error, ServiceError::RunnerRoot { .. }), "{error}");
8112 assert!(
8113 error.to_string().contains("nothing was registered"),
8114 "{error}"
8115 );
8116 assert!(
8117 host.controls.registrations().is_empty(),
8118 "the refusal has to come before the platform is asked to register anything: {:?}",
8119 host.controls.calls()
8120 );
8121 assert_eq!(
8122 crate::runner_root_access::report(host.runner_root.as_path()),
8123 before,
8124 "an open directory is refused rather than tightened: its contents cannot be trusted, \
8125 so adopting it would be worse than declining it"
8126 );
8127 }
8128
8129 #[cfg(windows)]
8130 #[test]
8131 fn uninstall_leaves_the_runner_root_exactly_where_it_is() {
8132 let host = Host::new();
8133 let operations = host.operations();
8134 operations
8135 .install(&host.request(StartMode::Boot))
8136 .expect("an install");
8137 assert!(host.runner_root.as_path().is_dir());
8138
8139 operations.uninstall().expect("an uninstall");
8140
8141 assert!(
8142 host.runner_root.as_path().is_dir(),
8143 "`05-infrastructure.md` item 5: uninstall deregisters and deletes nothing else. A \
8144 runner root may hold an operator's retained workspaces."
8145 );
8146 }
8147
8148 #[test]
8149 fn install_reviews_what_it_registered() {
8150 let host = Host::new();
8151 let installed = host
8152 .operations()
8153 .install(&host.request(StartMode::Boot))
8154 .expect("an install");
8155 assert!(
8156 installed.review.is_least_privilege(),
8157 "{}",
8158 installed.review
8159 );
8160 assert!(
8161 !installed.review.controls().is_empty(),
8162 "a review that confirms nothing proves nothing: {}",
8163 installed.review
8164 );
8165 assert_eq!(
8166 installed.review.kind(),
8167 host_definition_kind(StartMode::Boot),
8168 "the review must be of the definition this host's manager was given"
8169 );
8170 assert!(
8171 !installed.review.account().justification().is_empty(),
8172 "a privileged account with no stated reason is an unreviewed one"
8173 );
8174 }
8175
8176 #[test]
8181 fn uninstall_leaves_configuration_sqlite_secrets_and_cache_exactly_as_they_were() {
8182 let host = Host::new();
8183 let operations = host.operations();
8184 operations
8185 .install(&host.request(StartMode::Boot))
8186 .expect("an install");
8187
8188 let config = host.paths.config_dir();
8192 std::fs::write(config.join("runner-manager.db"), b"sqlite fixture").expect("writable");
8193 std::fs::write(config.join("config.toml"), b"host_capacity = 2").expect("writable");
8194 std::fs::create_dir_all(host.paths.state_dir().join("packages/2.330.0")).expect("writable");
8195 std::fs::write(
8196 host.paths
8197 .state_dir()
8198 .join("packages/2.330.0/runner.tar.gz"),
8199 b"cached package",
8200 )
8201 .expect("writable");
8202 std::fs::create_dir_all(host.paths.state_dir().join("secrets")).expect("writable");
8203 std::fs::write(
8204 host.paths.state_dir().join("secrets/user-access-token"),
8205 b"a stand-in for the stored credential",
8206 )
8207 .expect("writable");
8208 std::fs::write(
8209 host.paths.logs_dir().join("runner-manager.log.2026-08-22"),
8210 b"diagnostics",
8211 )
8212 .expect("writable");
8213
8214 let roots: Vec<PathBuf> = host
8215 .paths
8216 .all()
8217 .iter()
8218 .map(|(_, path)| (*path).to_path_buf())
8219 .collect();
8220 let roots: Vec<&Path> = roots.iter().map(PathBuf::as_path).collect();
8221 let before = snapshot(&roots);
8222
8223 assert!(
8226 before.len() >= 6,
8227 "the fixture must actually contain the files this test is about, got {before:#?}"
8228 );
8229 let record_path = InstallRecord::path(&host.paths);
8230 assert!(
8231 before.contains_key(&record_path),
8232 "the install record must be present before uninstall"
8233 );
8234
8235 let uninstalled = operations.uninstall().expect("an uninstall");
8236 assert!(uninstalled.removed_registration);
8237 assert!(uninstalled.removed_record);
8238
8239 let after = snapshot(&roots);
8240
8241 let mut expected = before.clone();
8243 expected.remove(&record_path);
8244 assert_eq!(
8245 after, expected,
8246 "uninstall must remove its own record and nothing else"
8247 );
8248 assert!(
8249 !record_path.exists(),
8250 "the record itself must go, or `uninstall` did nothing at all"
8251 );
8252 assert!(
8253 uninstalled
8254 .preserved
8255 .iter()
8256 .all(|path| roots.contains(&path.as_path())),
8257 "the preserved list must name the four directories: {uninstalled}"
8258 );
8259 }
8260
8261 #[test]
8262 fn uninstall_on_a_host_with_no_registration_is_not_a_failure() {
8263 let host = Host::new();
8264 let uninstalled = host.operations().uninstall().expect("a no-op uninstall");
8265 assert!(!uninstalled.removed_registration);
8266 assert!(!uninstalled.removed_record);
8267 }
8268
8269 #[test]
8270 fn uninstall_removes_a_registration_even_when_the_record_is_gone() {
8271 let host = Host::new();
8272 let operations = host.operations();
8273 operations
8274 .install(&host.request(StartMode::Boot))
8275 .expect("an install");
8276 std::fs::remove_file(InstallRecord::path(&host.paths)).expect("the record is lost");
8277
8278 let uninstalled = operations.uninstall().expect("an uninstall");
8279 assert!(
8280 uninstalled.removed_registration,
8281 "a lost record must not strand a registration"
8282 );
8283 assert!(host.controls.registrations().is_empty());
8284 }
8285
8286 #[test]
8291 fn switching_start_mode_reuses_the_recorded_path_and_re_resolves_nothing() {
8292 let host = Host::new();
8293 let operations = host.operations();
8294 operations
8295 .install(&host.request(StartMode::Boot))
8296 .expect("an install at boot");
8297
8298 std::fs::remove_file(&host.binary).expect("the installed binary goes away");
8302
8303 let change = operations
8304 .set_start_mode(StartMode::Login)
8305 .expect("a switch that does not reinstall the product");
8306 assert!(change.changed);
8307 assert_eq!(change.from, StartMode::Boot);
8308 assert_eq!(change.to, StartMode::Login);
8309 assert_eq!(change.store_scope, crate::secrets::SecretScope::User);
8310
8311 let record = InstallRecord::read(&host.paths)
8312 .expect("readable")
8313 .expect("a record");
8314 assert_eq!(record.start_mode, StartMode::Login);
8315 assert_eq!(
8316 record.binary, host.binary,
8317 "the recorded path must survive the switch untouched"
8318 );
8319
8320 let registrations = host.controls.registrations();
8321 assert_eq!(registrations.len(), 1, "{registrations:?}");
8322 assert_eq!(registrations[0].0, StartMode::Login);
8323 assert!(
8324 registrations[0]
8325 .2
8326 .command_line
8327 .contains(&host.binary.to_string_lossy().into_owned()),
8328 "{:?}",
8329 registrations[0].2
8330 );
8331 }
8332
8333 #[test]
8334 fn switching_start_mode_keeps_the_live_registration_when_target_install_fails() {
8335 let host = Host::new();
8336 let operations = host.operations();
8337 operations
8338 .install(&host.request(StartMode::Boot))
8339 .expect("an install at boot");
8340 let record_before = std::fs::read(InstallRecord::path(&host.paths)).expect("the record");
8341 host.controls
8342 .fail_next_install(StartMode::Login, "injected target failure");
8343
8344 let error = operations
8345 .set_start_mode(StartMode::Login)
8346 .expect_err("the target manager refuses the install");
8347
8348 assert!(matches!(error, ServiceError::Control { .. }), "{error}");
8349 assert_eq!(
8350 std::fs::read(InstallRecord::path(&host.paths)).expect("the old record survives"),
8351 record_before
8352 );
8353 let registrations = host.controls.registrations();
8354 assert_eq!(registrations.len(), 1, "{registrations:?}");
8355 assert_eq!(registrations[0].0, StartMode::Boot);
8356 }
8357
8358 #[test]
8359 fn switching_start_mode_rolls_back_target_when_record_persistence_fails() {
8360 let host = Host::new();
8361 let operations = host.operations();
8362 operations
8363 .install(&host.request(StartMode::Boot))
8364 .expect("an install at boot");
8365 let record_before = std::fs::read(InstallRecord::path(&host.paths)).expect("the record");
8366 let config = host.paths.config_dir().to_path_buf();
8367 let hidden = config.with_file_name("config-hidden-by-fault");
8368 host.controls.hide_directory_after_install(
8369 StartMode::Login,
8370 config.clone(),
8371 hidden.clone(),
8372 );
8373
8374 let error = operations
8375 .set_start_mode(StartMode::Login)
8376 .expect_err("the injected filesystem fault prevents persistence");
8377
8378 std::fs::remove_file(&config).expect("remove the injected blocker");
8379 std::fs::rename(&hidden, &config).expect("restore the record directory");
8380 assert!(matches!(error, ServiceError::Record { .. }), "{error}");
8381 assert_eq!(
8382 std::fs::read(InstallRecord::path(&host.paths)).expect("the old record survives"),
8383 record_before
8384 );
8385 let registrations = host.controls.registrations();
8386 assert_eq!(registrations.len(), 1, "{registrations:?}");
8387 assert_eq!(registrations[0].0, StartMode::Boot);
8388 assert!(
8389 host.controls
8390 .calls()
8391 .iter()
8392 .any(|call| call == "uninstall runner-manager (login)"),
8393 "the target must be rolled back: {:?}",
8394 host.controls.calls()
8395 );
8396 }
8397
8398 #[test]
8399 fn switching_to_the_mode_already_in_force_registers_nothing_again() {
8400 let host = Host::new();
8401 let operations = host.operations();
8402 operations
8403 .install(&host.request(StartMode::Boot))
8404 .expect("an install");
8405 let before = host.controls.calls().len();
8406
8407 let change = operations
8408 .set_start_mode(StartMode::Boot)
8409 .expect("a no-op switch");
8410 assert!(!change.changed);
8411 assert_eq!(
8412 host.controls.calls().len(),
8413 before,
8414 "a no-op switch must not touch the service manager"
8415 );
8416 }
8417
8418 #[test]
8419 fn switching_start_mode_on_a_host_with_no_registration_is_refused() {
8420 let host = Host::new();
8421 let error = host
8422 .operations()
8423 .set_start_mode(StartMode::Login)
8424 .expect_err("there is nothing to switch");
8425 assert!(
8426 matches!(error, ServiceError::NotInstalled { .. }),
8427 "{error}"
8428 );
8429 }
8430
8431 #[test]
8436 fn status_reports_the_four_facts_journey_five_asks_for() {
8437 let host = Host::new();
8438 let operations = host.operations();
8439 operations
8440 .install(&host.request(StartMode::Boot))
8441 .expect("an install");
8442 let at = DateTime::parse_from_rfc3339("2026-08-22T09:00:00Z")
8443 .expect("a valid timestamp")
8444 .with_timezone(&Utc);
8445 record_github_contact(&host.paths, at).expect("a heartbeat");
8446
8447 let status = operations.status().expect("a status");
8448 assert_eq!(status.start_mode(), Some(StartMode::Boot));
8449 assert_eq!(
8450 status.binary().map(BinaryPath::recorded),
8451 Some(host.binary.as_path())
8452 );
8453 assert_eq!(status.log_file(), host.paths.logs_dir().join(LOG_FILE_STEM));
8454 assert_eq!(status.last_github_contact(), Some(at));
8455 assert!(status.is_installed());
8456 assert!(status.is_healthy(), "{status}");
8457
8458 let printed = status.to_string();
8459 for fragment in [
8460 "start mode",
8461 "diagnostic log",
8462 "last GitHub contact",
8463 "binary",
8464 ] {
8465 assert!(printed.contains(fragment), "{printed}");
8466 }
8467 }
8468
8469 #[cfg(unix)]
8481 #[test]
8482 fn status_reports_a_record_it_may_not_read_and_still_reports_the_registration() {
8483 use std::os::unix::fs::PermissionsExt as _;
8484
8485 if unsafe { libc::geteuid() } == 0 {
8489 return;
8490 }
8491
8492 let host = Host::new();
8493 let operations = host.operations();
8494 operations
8495 .install(&host.request(StartMode::Boot))
8496 .expect("an install");
8497 assert!(
8498 operations.status().expect("a status").is_healthy(),
8499 "the discriminator: healthy before the record is made unreadable"
8500 );
8501
8502 let record = InstallRecord::path(&host.paths);
8503 std::fs::set_permissions(&record, std::fs::Permissions::from_mode(0o000))
8504 .expect("the mode is applied");
8505
8506 let status = operations
8507 .status()
8508 .expect("a record this account may not read is reported, not thrown");
8509 assert!(status.is_installed(), "{status}");
8510 assert!(!status.is_healthy(), "{status}");
8511
8512 let printed = status.to_string();
8513 assert!(
8514 printed.contains("this account may not read it"),
8515 "the operator is told which of the two states this is: {printed}"
8516 );
8517 assert!(
8518 !printed.contains("there is no install record"),
8519 "a record that is there and unreadable is not a record that is missing, and the \
8520 missing one's remedy starts with `service uninstall`: {printed}"
8521 );
8522
8523 std::fs::set_permissions(&record, std::fs::Permissions::from_mode(0o644))
8526 .expect("the mode is restored");
8527 }
8528
8529 #[test]
8530 fn status_reports_a_stale_binary_as_an_error_rather_than_appearing_healthy() {
8531 let host = Host::new();
8532 let operations = host.operations();
8533 operations
8534 .install(&host.request(StartMode::Boot))
8535 .expect("an install");
8536
8537 assert!(
8540 operations.status().expect("a status").is_healthy(),
8541 "the freshly installed host must be healthy"
8542 );
8543
8544 std::fs::remove_file(&host.binary).expect("the binary moves out from under the record");
8545
8546 let status = operations.status().expect("a status");
8547 assert!(!status.is_healthy(), "{status}");
8548 assert!(
8549 status
8550 .problems()
8551 .iter()
8552 .any(|problem| problem.subject == "binary"),
8553 "{status}"
8554 );
8555 assert!(status.to_string().contains("STALE"), "{status}");
8556 }
8557
8558 #[test]
8559 fn status_reports_a_registration_that_would_not_start_at_boot() {
8560 let host = Host::new();
8561 let operations = host.operations();
8562 operations
8563 .install(&host.request(StartMode::Boot))
8564 .expect("an install");
8565 assert!(operations.status().expect("a status").is_healthy());
8566
8567 host.controls.edit("runner-manager", |registration| {
8568 registration.starts_automatically = false;
8569 });
8570
8571 let status = operations.status().expect("a status");
8572 assert!(!status.is_healthy(), "{status}");
8573 assert!(
8574 status
8575 .problems()
8576 .iter()
8577 .any(|problem| problem.detail.contains("after a reboot")),
8578 "{status}"
8579 );
8580 }
8581
8582 #[test]
8583 fn install_starts_the_registration_and_a_later_stop_is_unhealthy() {
8584 let host = Host::new();
8585 let operations = host.operations();
8586 operations
8587 .install(&host.request(StartMode::Login))
8588 .expect("install and immediate start");
8589
8590 assert!(
8591 operations.status().expect("running status").is_running(),
8592 "install must not wait for the next login trigger"
8593 );
8594 operations.stop().expect("stop the registration");
8595 let status = operations.status().expect("stopped status");
8596 assert!(!status.is_healthy(), "{status}");
8597 assert!(
8598 status
8599 .problems()
8600 .iter()
8601 .any(|problem| problem.subject == "runtime"),
8602 "{status}"
8603 );
8604 }
8605
8606 #[test]
8607 fn status_reports_a_restart_policy_something_else_edited() {
8608 let host = Host::new();
8609 let operations = host.operations();
8610 operations
8611 .install(&host.request(StartMode::Boot))
8612 .expect("an install");
8613 assert!(operations.status().expect("a status").is_healthy());
8614
8615 host.controls.edit("runner-manager", |registration| {
8616 registration.restart_delay = Some(Duration::from_secs(1));
8617 });
8618
8619 let status = operations.status().expect("a status");
8620 assert!(!status.is_healthy(), "{status}");
8621 assert!(
8622 status
8623 .problems()
8624 .iter()
8625 .any(|problem| problem.subject == "restart policy"),
8626 "{status}"
8627 );
8628 }
8629
8630 #[test]
8631 fn status_reports_a_registration_naming_a_binary_the_record_does_not() {
8632 let host = Host::new();
8633 let operations = host.operations();
8634 operations
8635 .install(&host.request(StartMode::Boot))
8636 .expect("an install");
8637 let other = host.binary.with_file_name("someone-elses.exe");
8638 std::fs::write(&other, b"x").expect("writable");
8639
8640 host.controls.edit("runner-manager", |registration| {
8641 registration.command_line = quote_argument(&other.to_string_lossy());
8642 });
8643
8644 let status = operations.status().expect("a status");
8645 assert!(!status.is_healthy(), "{status}");
8646 assert!(
8647 matches!(status.binary(), Some(BinaryPath::Diverged { .. })),
8648 "{status}"
8649 );
8650 }
8651
8652 #[test]
8653 fn status_reports_a_record_no_service_manager_knows_about() {
8654 let host = Host::new();
8655 let operations = host.operations();
8656 operations
8657 .install(&host.request(StartMode::Boot))
8658 .expect("an install");
8659 for mode in [StartMode::Boot, StartMode::Login] {
8661 host.controls
8662 .control(mode)
8663 .expect("a control")
8664 .uninstall(&ServiceIdentity::product())
8665 .expect("removed");
8666 }
8667
8668 let status = operations.status().expect("a status");
8669 assert!(!status.is_healthy(), "{status}");
8670 assert!(
8671 status
8672 .problems()
8673 .iter()
8674 .any(|problem| problem.subject == "registration"),
8675 "{status}"
8676 );
8677 }
8678
8679 #[test]
8680 fn status_on_a_host_with_nothing_installed_is_neither_healthy_nor_broken() {
8681 let host = Host::new();
8682 let status = host.operations().status().expect("a status");
8683 assert!(!status.is_installed());
8684 assert!(
8685 status.is_healthy(),
8686 "a host that never installed the service has no fault to report: {status}"
8687 );
8688 assert!(status.to_string().contains("installed"), "{status}");
8689 }
8690
8691 #[test]
8692 fn status_says_a_login_registration_does_not_resume_after_an_unattended_reboot() {
8693 let host = Host::new();
8694 let operations = host.operations();
8695 operations
8696 .install(&host.request(StartMode::Login))
8697 .expect("an install at login");
8698 let status = operations.status().expect("a status");
8699 assert!(
8700 status
8701 .notes()
8702 .iter()
8703 .any(|note| note.contains("does not run until the operator signs in")),
8704 "05-infrastructure.md requires `service status` to say so: {status}"
8705 );
8706 }
8707
8708 #[test]
8713 fn start_and_stop_reach_the_domain_that_holds_the_registration() {
8714 let host = Host::new();
8715 let operations = host.operations();
8716 operations
8717 .install(&host.request(StartMode::Login))
8718 .expect("an install at login");
8719 operations.start().expect("a start");
8720 assert!(operations.status().expect("a status").is_running());
8721 assert!(operations.stop().expect("a stop"));
8722 assert!(!operations.status().expect("a status").is_running());
8723 }
8724
8725 #[test]
8726 fn starting_a_host_with_no_registration_is_refused() {
8727 let host = Host::new();
8728 let error = host.operations().start().expect_err("nothing to start");
8729 assert!(
8730 matches!(error, ServiceError::NotInstalled { .. }),
8731 "{error}"
8732 );
8733 }
8734
8735 #[cfg(windows)]
8751 #[test]
8752 fn the_account_this_installer_registers_is_one_the_stores_own_dacl_admits() {
8753 use crate::secrets::{PlatformSecretStore, SecretScope, SecretStore as _};
8754
8755 let root = tempfile::tempdir().expect("a temporary directory");
8756 let store = PlatformSecretStore::rooted_at(SecretScope::Machine, root.path())
8757 .expect("a rooted machine-scoped store");
8758 store
8759 .store(&secrecy::SecretString::from("a stand-in for the token"))
8760 .expect("the store accepts a value");
8761 let protection = store.protection().expect("the DACL can be read back");
8762
8763 assert!(
8764 protection.description().contains(";;;SY)"),
8765 "the machine-scoped store must admit LocalSystem, or a boot-start service cannot \
8766 read the token. `d2` writes this DACL and it is not this task's to widen. Got: {}",
8767 protection.description()
8768 );
8769 assert_eq!(
8770 ServiceAccount::for_definition(DefinitionKind::WindowsService, StartMode::Boot),
8771 ServiceAccount::LocalSystem,
8772 "and that is the account this installer registers, which is why SY is what matters"
8773 );
8774 assert!(
8775 !protection.readable_by_other_local_users(),
8776 "the same DACL must still exclude ordinary local users: {}",
8777 protection.description()
8778 );
8779
8780 for rejected in [";;;LS)", ";;;NS)"] {
8784 assert!(
8785 !protection.description().contains(rejected),
8786 "if the store ever admitted {rejected}, the least-privilege analysis in \
8787 docs/service-account.md would need redoing: {}",
8788 protection.description()
8789 );
8790 }
8791 }
8792}