table of contents
- NAME
- SYNOPSIS
- DESCRIPTION
- IMPLICIT DEPENDENCIES
- PATHS
- CREDENTIALS
- CAPABILITIES
- SECURITY
- MANDATORY ACCESS CONTROL
- PROCESS PROPERTIES
- SCHEDULING
- SANDBOXING
- SYSTEM CALL FILTERING
- ENVIRONMENT
- LOGGING AND STANDARD INPUT/OUTPUT
- SYSTEM V COMPATIBILITY
- ENVIRONMENT VARIABLES IN SPAWNED PROCESSES
- PROCESS EXIT CODES
- SEE ALSO
- NOTES
- buster 241-7~deb10u7
- buster-backports 247.3-6~bpo10+1
- testing 247.3-6
- unstable 247.3-6
- experimental 249.3-3
SYSTEMD.EXEC(5) | systemd.exec | SYSTEMD.EXEC(5) |
NAME¶
systemd.exec - Execution environment configurationSYNOPSIS¶
service.service, socket.socket, mount.mount, swap.swapDESCRIPTION¶
Unit configuration files for services, sockets, mount points, and swap devices share a subset of configuration options which define the execution environment of spawned processes.This man page lists the configuration options shared by these four unit types. See systemd.unit(5) for the common options of all unit configuration files, and systemd.service(5), systemd.socket(5), systemd.swap(5), and systemd.mount(5) for more information on the specific unit configuration files. The execution specific configuration options are configured in the [Service], [Socket], [Mount], or [Swap] sections, depending on the unit type.
In addition, options which control resources through Linux Control Groups (cgroups) are listed in systemd.resource-control(5). Those options complement options listed here.
IMPLICIT DEPENDENCIES¶
A few execution parameters result in additional, automatic dependencies to be added:PATHS¶
The following settings may be used to change a service's view of the filesystem. Please note that the paths must be absolute and must not contain a ".." path component.WorkingDirectory=
RootDirectory=
The MountAPIVFS= and PrivateUsers= settings are particularly useful in conjunction with RootDirectory=. For details, see below.
RootImage=
When DevicePolicy= is set to "closed" or "strict", or set to "auto" and DeviceAllow= is set, then this setting adds /dev/loop-control with rw mode, "block-loop" and "block-blkext" with rwm mode to DeviceAllow=. See systemd.resource-control(5) for the details about DevicePolicy= or DeviceAllow=. Also, see PrivateDevices= below, as it may change the setting of DevicePolicy=.
MountAPIVFS=
BindPaths=, BindReadOnlyPaths=
BindPaths= creates regular writable bind mounts (unless the source file system mount is already marked read-only), while BindReadOnlyPaths= creates read-only bind mounts. These settings may be used more than once, each usage appends to the unit's list of bind mounts. If the empty string is assigned to either of these two options the entire list of bind mounts defined prior to this is reset. Note that in this case both read-only and regular bind mounts are reset, regardless which of the two settings is used.
This option is particularly useful when RootDirectory=/RootImage= is used. In this case the source path refers to a path on the host file system, while the destination path refers to a path below the root directory of the unit.
CREDENTIALS¶
User=, Group=Note that restrictions on the user/group name syntax are enforced: the specified name must consist only of the characters a-z, A-Z, 0-9, "_" and "-", except for the first character which must be one of a-z, A-Z or "_" (i.e. numbers and "-" are not permitted as first character). The user/group name must have at least one character, and at most 31. These restrictions are enforced in order to avoid ambiguities and to ensure user/group names and unit files remain portable among Linux systems.
When used in conjunction with DynamicUser= the user/group name specified is dynamically allocated at the time the service is started, and released at the time the service is stopped — unless it is already allocated statically (see below). If DynamicUser= is not used the specified user and group must have been created statically in the user database no later than the moment the service is started, for example using the sysusers.d(5) facility, which is applied at boot or package install time.
DynamicUser=
SupplementaryGroups=
PAMName=
Note that for each unit making use of this option a PAM session handler process will be maintained as part of the unit and stays around as long as the unit is active, to ensure that appropriate actions can be taken when the unit and hence the PAM session terminates. This process is named "(sd-pam)" and is an immediate child process of the unit's main process.
Note that when this option is used for a unit it is very likely (depending on PAM configuration) that the main unit process will be migrated to its own session scope unit when it is activated. This process will hence be associated with two units: the unit it was originally started from (and for which PAMName= was configured), and the session scope unit. Any child processes of that process will however be associated with the session scope unit only. This has implications when used in combination with NotifyAccess=all, as these child processes will not be able to affect changes in the original unit through notification messages. These messages will be considered belonging to the session scope unit and not the original unit. It is hence not recommended to use PAMName= in combination with NotifyAccess=all.
CAPABILITIES¶
CapabilityBoundingSet=Example: if a unit has the following,
CapabilityBoundingSet=CAP_A CAP_B CapabilityBoundingSet=CAP_B CAP_C
then CAP_A, CAP_B, and CAP_C are set. If the second line is prefixed with "~", e.g.,
CapabilityBoundingSet=CAP_A CAP_B CapabilityBoundingSet=~CAP_B CAP_C
then, only CAP_A is set.
AmbientCapabilities=
Ambient capability sets are useful if you want to execute a process as a non-privileged user but still want to give it some capabilities. Note that in this case option keep-caps is automatically added to SecureBits= to retain the capabilities over the user change. AmbientCapabilities= does not affect commands prefixed with "+".
SECURITY¶
NoNewPrivileges=SecureBits=
MANDATORY ACCESS CONTROL¶
SELinuxContext=AppArmorProfile=
SmackProcessLabel=
The value may be prefixed by "-", in which case all errors will be ignored. An empty value may be specified to unset previous assignments. This does not affect commands prefixed with "+".
PROCESS PROPERTIES¶
LimitCPU=, LimitFSIZE=, LimitDATA=, LimitSTACK=, LimitCORE=, LimitRSS=, LimitNOFILE=, LimitAS=, LimitNPROC=, LimitMEMLOCK=, LimitLOCKS=, LimitSIGPENDING=, LimitMSGQUEUE=, LimitNICE=, LimitRTPRIO=, LimitRTTIME=Note that most process resource limits configured with these options are per-process, and processes may fork in order to acquire a new set of resources that are accounted independently of the original process, and may thus escape limits set. Also note that LimitRSS= is not implemented on Linux, and setting it has no effect. Often it is advisable to prefer the resource controls listed in systemd.resource-control(5) over these per-process limits, as they apply to services as a whole, may be altered dynamically at runtime, and are generally more expressive. For example, MemoryLimit= is a more powerful (and working) replacement for LimitRSS=.
For system units these resource limits may be chosen freely. For user units however (i.e. units run by a per-user instance of systemd(1)), these limits are bound by (possibly more restrictive) per-user limits enforced by the OS.
Resource limits not configured explicitly for a unit default to the value configured in the various DefaultLimitCPU=, DefaultLimitFSIZE=, ... options available in systemd-system.conf(5), and – if not configured there – the kernel or per-user defaults, as defined by the OS (the latter only for user services, see above).
Table 1. Resource limit directives, their equivalent ulimit shell commands and the unit used
Directive | ulimit equivalent | Unit |
LimitCPU= | ulimit -t | Seconds |
LimitFSIZE= | ulimit -f | Bytes |
LimitDATA= | ulimit -d | Bytes |
LimitSTACK= | ulimit -s | Bytes |
LimitCORE= | ulimit -c | Bytes |
LimitRSS= | ulimit -m | Bytes |
LimitNOFILE= | ulimit -n | Number of File Descriptors |
LimitAS= | ulimit -v | Bytes |
LimitNPROC= | ulimit -u | Number of Processes |
LimitMEMLOCK= | ulimit -l | Bytes |
LimitLOCKS= | ulimit -x | Number of Locks |
LimitSIGPENDING= | ulimit -i | Number of Queued Signals |
LimitMSGQUEUE= | ulimit -q | Bytes |
LimitNICE= | ulimit -e | Nice Level |
LimitRTPRIO= | ulimit -r | Realtime Priority |
LimitRTTIME= | No equivalent | Microseconds |
UMask=
KeyringMode=
OOMScoreAdjust=
TimerSlackNSec=
Personality=
IgnoreSIGPIPE=
SCHEDULING¶
Nice=CPUSchedulingPolicy=
CPUSchedulingPriority=
CPUSchedulingResetOnFork=
CPUAffinity=
IOSchedulingClass=
IOSchedulingPriority=
SANDBOXING¶
The following sandboxing options are an effective way to limit the exposure of the system towards the unit's processes. It is recommended to turn on as many of these options for each unit as is possible without negatively affecting the process' ability to operate. Note that many of these sandboxing features are gracefully turned off on systems where the underlying security mechanism is not available. For example, ProtectSystem= has no effect if the kernel is built without file system namespacing or if the service manager runs in a container manager that makes file system namespacing unavailable to its payload. Similar, RestrictRealtime= has no effect on systems that lack support for SECCOMP system call filtering, or in containers where support for this is turned off.Also note that some sandboxing functionality is generally not available in user services (i.e. services run by the per-user service manager). Specifically, the various settings requiring file system namespacing support (such as ProtectSystem=) are not available, as the underlying kernel functionality is only accessible to privileged processes.
ProtectSystem=
ProtectHome=
Setting this to "yes" is mostly equivalent to set the three directories in InaccessiblePaths=. Similarly, "read-only" is mostly equivalent to ReadOnlyPaths=, and "tmpfs" is mostly equivalent to TemporaryFileSystem=.
It is recommended to enable this setting for all long-running services (in particular network-facing ones), to ensure they cannot get access to private user data, unless the services actually require access to the user's private data. This setting is implied if DynamicUser= is set. This setting cannot ensure protection in all cases. In general it has the same limitations as ReadOnlyPaths=, see below.
RuntimeDirectory=, StateDirectory=, CacheDirectory=, LogsDirectory=, ConfigurationDirectory=
Table 2. Automatic directory creation and environment variables
Locations | for system | for users | Environment variable |
RuntimeDirectory= | /run | $XDG_RUNTIME_DIR | $RUNTIME_DIRECTORY |
StateDirectory= | /var/lib | $XDG_CONFIG_HOME | $STATE_DIRECTORY |
CacheDirectory= | /var/cache | $XDG_CACHE_HOME | $CACHE_DIRECTORY |
LogsDirectory= | /var/log | $XDG_CONFIG_HOME/log | $LOGS_DIRECTORY |
ConfigurationDirectory= | /etc | $XDG_CONFIG_HOME | $CONFIGURATION_DIRECTORY |
In case of
RuntimeDirectory= the lowest subdirectories are removed when the unit
is stopped. It is possible to preserve the specified directories in this
case if RuntimeDirectoryPreserve= is configured to restart or
yes (see below). The directories specified with
StateDirectory=, CacheDirectory=, LogsDirectory=,
ConfigurationDirectory= are not removed when the unit is stopped.
Except in case of ConfigurationDirectory=, the innermost specified directories will be owned by the user and group specified in User= and Group=. If the specified directories already exist and their owning user or group do not match the configured ones, all files and directories below the specified directories as well as the directories themselves will have their file ownership recursively changed to match what is configured. As an optimization, if the specified directories are already owned by the right user and group, files and directories below of them are left as-is, even if they do not match what is requested. The innermost specified directories will have their access mode adjusted to the what is specified in RuntimeDirectoryMode=, StateDirectoryMode=, CacheDirectoryMode=, LogsDirectoryMode= and ConfigurationDirectoryMode=.
These options imply BindPaths= for the specified paths. When combined with RootDirectory= or RootImage= these paths always reside on the host and are mounted from there into the unit's file system namespace.
If DynamicUser= is used in conjunction with StateDirectory=, CacheDirectory= and LogsDirectory= is slightly altered: the directories are created below /var/lib/private, /var/cache/private and /var/log/private, respectively, which are host directories made inaccessible to unprivileged users, which ensures that access to these directories cannot be gained through dynamic user ID recycling. Symbolic links are created to hide this difference in behaviour. Both from perspective of the host and from inside the unit, the relevant directories hence always appear directly below /var/lib, /var/cache and /var/log.
Use RuntimeDirectory= to manage one or more runtime directories for the unit and bind their lifetime to the daemon runtime. This is particularly useful for unprivileged daemons that cannot create runtime directories in /run due to lack of privileges, and to make sure the runtime directory is cleaned up automatically after use. For runtime directories that require more complex or different configuration or lifetime guarantees, please consider using tmpfiles.d(5).
Example: if a system service unit has the following,
RuntimeDirectory=foo/bar baz
the service manager creates /run/foo (if it does not exist), /run/foo/bar, and /run/baz. The directories /run/foo/bar and /run/baz except /run/foo are owned by the user and group specified in User= and Group=, and removed when the service is stopped.
Example: if a system service unit has the following,
RuntimeDirectory=foo/bar StateDirectory=aaa/bbb ccc
then the environment variable "RUNTIME_DIRECTORY" is set with "/run/foo/bar", and "STATE_DIRECTORY" is set with "/var/lib/aaa/bbb:/var/lib/ccc".
RuntimeDirectoryMode=, StateDirectoryMode=, CacheDirectoryMode=, LogsDirectoryMode=, ConfigurationDirectoryMode=
RuntimeDirectoryPreserve=
ReadWritePaths=, ReadOnlyPaths=, InaccessiblePaths=
Paths listed in ReadWritePaths= are accessible from within the namespace with the same access modes as from outside of it. Paths listed in ReadOnlyPaths= are accessible for reading only, writing will be refused even if the usual file access controls would permit this. Nest ReadWritePaths= inside of ReadOnlyPaths= in order to provide writable subdirectories within read-only directories. Use ReadWritePaths= in order to whitelist specific paths for write access if ProtectSystem=strict is used.
Paths listed in InaccessiblePaths= will be made inaccessible for processes inside the namespace along with everything below them in the file system hierarchy. This may be more restrictive than desired, because it is not possible to nest ReadWritePaths=, ReadOnlyPaths=, BindPaths=, or BindReadOnlyPaths= inside it. For a more flexible option, see TemporaryFileSystem=.
Non-directory paths may be specified as well. These options may be specified more than once, in which case all paths listed will have limited access from within the namespace. If the empty string is assigned to this option, the specific list is reset, and all prior assignments have no effect.
Paths in ReadWritePaths=, ReadOnlyPaths= and InaccessiblePaths= may be prefixed with "-", in which case they will be ignored when they do not exist. If prefixed with "+" the paths are taken relative to the root directory of the unit, as configured with RootDirectory=/RootImage=, instead of relative to the root directory of the host (see above). When combining "-" and "+" on the same path make sure to specify "-" first, and "+" second.
Note that these settings will disconnect propagation of mounts from the unit's processes to the host. This means that this setting may not be used for services which shall be able to install mount points in the main mount namespace. For ReadWritePaths= and ReadOnlyPaths= propagation in the other direction is not affected, i.e. mounts created on the host generally appear in the unit processes' namespace, and mounts removed on the host also disappear there too. In particular, note that mount propagation from host to unit will result in unmodified mounts to be created in the unit's namespace, i.e. writable mounts appearing on the host will be writable in the unit's namespace too, even when propagated below a path marked with ReadOnlyPaths=! Restricting access with these options hence does not extend to submounts of a directory that are created later on. This means the lock-down offered by that setting is not complete, and does not offer full protection.
Note that the effect of these settings may be undone by privileged processes. In order to set up an effective sandboxed environment for a unit it is thus recommended to combine these settings with either CapabilityBoundingSet=~CAP_SYS_ADMIN or SystemCallFilter=~@mount.
TemporaryFileSystem=
This is useful to hide files or directories not relevant to the processes invoked by the unit, while necessary files or directories can be still accessed by combining with BindPaths= or BindReadOnlyPaths=. See the example below.
Example: if a unit has the following,
TemporaryFileSystem=/var:ro BindReadOnlyPaths=/var/lib/systemd
then the invoked processes by the unit cannot see any files or directories under /var except for /var/lib/systemd or its contents.
PrivateTmp=
Note that the implementation of this setting might be impossible (for example if mount namespaces are not available), and the unit should be written in a way that does not solely rely on this setting for security.
PrivateDevices=
Note that the implementation of this setting might be impossible (for example if mount namespaces are not available), and the unit should be written in a way that does not solely rely on this setting for security.
PrivateNetwork=
Note that the implementation of this setting might be impossible (for example if network namespaces are not available), and the unit should be written in a way that does not solely rely on this setting for security.
PrivateUsers=
This setting is particularly useful in conjunction with RootDirectory=/RootImage=, as the need to synchronize the user and group databases in the root directory and on the host is reduced, as the only users and groups who need to be matched are "root", "nobody" and the unit's own user and group.
Note that the implementation of this setting might be impossible (for example if user namespaces are not available), and the unit should be written in a way that does not solely rely on this setting for security.
ProtectKernelTunables=
ProtectKernelModules=
ProtectControlGroups=
RestrictAddressFamilies=
Use this option to limit exposure of processes to remote access, in particular via exotic and sensitive network protocols, such as AF_PACKET. Note that in most cases, the local AF_UNIX address family should be included in the configured whitelist as it is frequently used for local communication, including for syslog(2) logging.
RestrictNamespaces=
Example: if a unit has the following,
RestrictNamespaces=cgroup ipc RestrictNamespaces=cgroup net
then cgroup, ipc, and net are set. If the second line is prefixed with "~", e.g.,
RestrictNamespaces=cgroup ipc RestrictNamespaces=~cgroup net
then, only ipc is set.
LockPersonality=
MemoryDenyWriteExecute=
RestrictRealtime=
RemoveIPC=
PrivateMounts=
When turned on, this executes three operations for each invoked process: a new CLONE_NEWNS namespace is created, after which all existing mounts are remounted to MS_SLAVE to disable propagation from the unit's processes to the host (but leaving propagation in the opposite direction in effect). Finally, the mounts are remounted again to the propagation mode configured with MountFlags=, see below.
File system namespaces are set up individually for each process forked off by the service manager. Mounts established in the namespace of the process created by ExecStartPre= will hence be cleaned up automatically as soon as that process exits and will not be available to subsequent processes forked off for ExecStart= (and similar applies to the various other commands configured for units). Similarly, JoinsNamespaceOf= does not permit sharing kernel mount namespaces between units, it only enables sharing of the /tmp/ and /var/tmp/ directories.
Other file system namespace unit settings — PrivateMounts=, PrivateTmp=, PrivateDevices=, ProtectSystem=, ProtectHome=, ReadOnlyPaths=, InaccessiblePaths=, ReadWritePaths=, ... — also enable file system namespacing in a fashion equivalent to this option. Hence it is primarily useful to explicitly request this behaviour if none of the other settings are used.
MountFlags=
This setting only controls the final propagation setting in effect on all mount points of the file system namespace created for each process of this unit. Other file system namespacing unit settings (see the discussion in PrivateMounts= above) will implicitly disable mount and unmount propagation from the unit's processes towards the host by changing the propagation setting of all mount points in the unit's file system namepace to slave first. Setting this option to shared does not reestablish propagation in that case.
If not set – but file system namespaces are enabled through another file system namespace unit setting – shared mount propagation is used, but — as mentioned — as slave is applied first, propagation from the unit's processes to the host is still turned off.
It is not recommended to to use private mount propagation for units, as this means temporary mounts (such as removable media) of the host will stay mounted and thus indefinitely busy in forked off processes, as unmount propagation events won't be received by the file system namespace of the unit.
Usually, it is best to leave this setting unmodified, and use higher level file system namespacing options instead, in particular PrivateMounts=, see above.
SYSTEM CALL FILTERING¶
SystemCallFilter=Note that on systems supporting multiple ABIs (such as x86/x86-64) it is recommended to turn off alternative ABIs for services, so that they cannot be used to circumvent the restrictions of this option. Specifically, it is recommended to combine this option with SystemCallArchitectures=native or similar.
Note that strict system call filters may impact execution and error handling code paths of the service invocation. Specifically, access to the execve system call is required for the execution of the service binary — if it is blocked service invocation will necessarily fail. Also, if execution of the service binary fails for some reason (for example: missing service executable), the error handling logic might require access to an additional set of system calls in order to process and log this failure correctly. It might be necessary to temporarily disable system call filters in order to simplify debugging of such failures.
If you specify both types of this option (i.e. whitelisting and blacklisting), the first encountered will take precedence and will dictate the default action (termination or approval of a system call). Then the next occurrences of this option will add or delete the listed system calls from the set of the filtered system calls, depending of its type and the default action. (For example, if you have started with a whitelisting of read and write, and right after it add a blacklisting of write, then write will be removed from the set.)
As the number of possible system calls is large, predefined sets of system calls are provided. A set starts with "@" character, followed by name of the set.
Table 3. Currently predefined system call sets
Set | Description |
@aio | Asynchronous I/O (io_setup(2), io_submit(2), and related calls) |
@basic-io | System calls for basic I/O: reading, writing, seeking, file descriptor duplication and closing (read(2), write(2), and related calls) |
@chown | Changing file ownership (chown(2), fchownat(2), and related calls) |
@clock | System calls for changing the system clock (adjtimex(2), settimeofday(2), and related calls) |
@cpu-emulation | System calls for CPU emulation functionality (vm86(2) and related calls) |
@debug | Debugging, performance monitoring and tracing functionality (ptrace(2), perf_event_open(2) and related calls) |
@file-system | File system operations: opening, creating files and directories for read and write, renaming and removing them, reading file properties, or creating hard and symbolic links. |
@io-event | Event loop system calls (poll(2), select(2), epoll(7), eventfd(2) and related calls) |
@ipc | Pipes, SysV IPC, POSIX Message Queues and other IPC (mq_overview(7), svipc(7)) |
@keyring | Kernel keyring access (keyctl(2) and related calls) |
@memlock | Locking of memory into RAM (mlock(2), mlockall(2) and related calls) |
@module | Loading and unloading of kernel modules (init_module(2), delete_module(2) and related calls) |
@mount | Mounting and unmounting of file systems (mount(2), chroot(2), and related calls) |
@network-io | Socket I/O (including local AF_UNIX): socket(7), unix(7) |
@obsolete | Unusual, obsolete or unimplemented (create_module(2), gtty(2), ...) |
@privileged | All system calls which need super-user capabilities (capabilities(7)) |
@process | Process control, execution, namespaceing operations (clone(2), kill(2), namespaces(7), ... |
@raw-io | Raw I/O port access (ioperm(2), iopl(2), pciconfig_read(), ...) |
@reboot | System calls for rebooting and reboot preparation (reboot(2), kexec(), ...) |
@resources | System calls for changing resource limits, memory and scheduling parameters (setrlimit(2), setpriority(2), ...) |
@setuid | System calls for changing user ID and group ID credentials, (setuid(2), setgid(2), setresuid(2), ...) |
@signal | System calls for manipulating and handling process signals (signal(2), sigprocmask(2), ...) |
@swap | System calls for enabling/disabling swap devices (swapon(2), swapoff(2)) |
@sync | Synchronizing files and memory to disk: (fsync(2), msync(2), and related calls) |
@system-service | A reasonable set of system calls used by common system services, excluding any special purpose calls. This is the recommended starting point for whitelisting system calls for system services, as it contains what is typically needed by system services, but excludes overly specific interfaces. For example, the following APIs are excluded: "@clock", "@mount", "@swap", "@reboot". |
@timer | System calls for scheduling operations by time (alarm(2), timer_create(2), ...) |
Note, that as new system calls are added to the kernel, additional
system calls might be added to the groups above. Contents of the sets may
also change between systemd versions. In addition, the list of system calls
depends on the kernel version and architecture for which systemd was
compiled. Use
systemd-analyze syscall-filter to list the actual list of system
calls in each filter.
Generally, whitelisting system calls (rather than blacklisting) is the safer mode of operation. It is recommended to enforce system call whitelists for all long-running system services. Specifically, the following lines are a relatively safe basic choice for the majority of system services:
[Service] SystemCallFilter=@system-service SystemCallErrorNumber=EPERM
It is recommended to combine the file system namespacing related options with SystemCallFilter=~@mount, in order to prohibit the unit's processes to undo the mappings. Specifically these are the options PrivateTmp=, PrivateDevices=, ProtectSystem=, ProtectHome=, ProtectKernelTunables=, ProtectControlGroups=, ReadOnlyPaths=, InaccessiblePaths= and ReadWritePaths=.
SystemCallErrorNumber=
SystemCallArchitectures=
If this setting is used, processes of this unit will only be permitted to call native system calls, and system calls of the specified architectures. For the purposes of this option, the x32 architecture is treated as including x86-64 system calls. However, this setting still fulfills its purpose, as explained below, on x32.
System call filtering is not equally effective on all architectures. For example, on x86 filtering of network socket-related calls is not possible, due to ABI limitations — a limitation that x86-64 does not have, however. On systems supporting multiple ABIs at the same time — such as x86/x86-64 — it is hence recommended to limit the set of permitted system call architectures so that secondary ABIs may not be used to circumvent the restrictions applied to the native ABI of the system. In particular, setting SystemCallArchitectures=native is a good choice for disabling non-native ABIs.
System call architectures may also be restricted system-wide via the SystemCallArchitectures= option in the global configuration. See systemd-system.conf(5) for details.
ENVIRONMENT¶
Environment=Example:
Environment="VAR1=word1 word2" VAR2=word3 "VAR3=$word 5 6"
gives three variables "VAR1", "VAR2", "VAR3" with the values "word1 word2", "word3", "$word 5 6".
See environ(7) for details about environment variables.
Note that environment variables are not suitable for passing secrets (such as passwords, key material, ...) to service processes. Environment variables set for a unit are exposed to unprivileged clients via D-Bus IPC, and generally not understood as being data that requires protection. Moreover, environment variables are propagated down the process tree, including across security boundaries (such as setuid/setgid executables), and hence might leak to processes that should not have access to the secret data.
EnvironmentFile=
The argument passed should be an absolute filename or wildcard expression, optionally prefixed with "-", which indicates that if the file does not exist, it will not be read and no error or warning message is logged. This option may be specified more than once in which case all specified files are read. If the empty string is assigned to this option, the list of file to read is reset, all prior assignments have no effect.
The files listed with this directive will be read shortly before the process is executed (more specifically, after all processes from a previous unit state terminated. This means you can generate these files in one unit state, and read it with this option in the next).
Settings from these files override settings made with Environment=. If the same variable is set twice from these files, the files will be read in the order they are specified and the later setting will override the earlier setting.
PassEnvironment=
Variables set for invoked processes due to this setting are subject to being overridden by those configured with Environment= or EnvironmentFile=.
Example:
PassEnvironment=VAR1 VAR2 VAR3
passes three variables "VAR1", "VAR2", "VAR3" with the values set for those variables in PID1.
See environ(7) for details about environment variables.
UnsetEnvironment=
See environ(7) for details about environment variables.
LOGGING AND STANDARD INPUT/OUTPUT¶
StandardInput=If null is selected, standard input will be connected to /dev/null, i.e. all read attempts by the process will result in immediate EOF.
If tty is selected, standard input is connected to a TTY (as configured by TTYPath=, see below) and the executed process becomes the controlling process of the terminal. If the terminal is already being controlled by another process, the executed process waits until the current controlling process releases the terminal.
tty-force is similar to tty, but the executed process is forcefully and immediately made the controlling process of the terminal, potentially removing previous controlling processes from the terminal.
tty-fail is similar to tty, but if the terminal already has a controlling process start-up of the executed process fails.
The data option may be used to configure arbitrary textual or binary data to pass via standard input to the executed process. The data to pass is configured via StandardInputText=/StandardInputData= (see below). Note that the actual file descriptor type passed (memory file, regular file, UNIX pipe, ...) might depend on the kernel and available privileges. In any case, the file descriptor is read-only, and when read returns the specified data followed by EOF.
The file:path option may be used to connect a specific file system object to standard input. An absolute path following the ":" character is expected, which may refer to a regular file, a FIFO or special file. If an AF_UNIX socket in the file system is specified, a stream socket is connected to it. The latter is useful for connecting standard input of processes to arbitrary system services.
The socket option is valid in socket-activated services only, and requires the relevant socket unit file (see systemd.socket(5) for details) to have Accept=yes set, or to specify a single socket only. If this option is set, standard input will be connected to the socket the service was activated from, which is primarily useful for compatibility with daemons designed for use with the traditional inetd(8) socket activation daemon.
The fd:name option connects standard input to a specific, named file descriptor provided by a socket unit. The name may be specified as part of this option, following a ":" character (e.g. "fd:foobar"). If no name is specified, the name "stdin" is implied (i.e. "fd" is equivalent to "fd:stdin"). At least one socket unit defining the specified name must be provided via the Sockets= option, and the file descriptor name may differ from the name of its containing socket unit. If multiple matches are found, the first one will be used. See FileDescriptorName= in systemd.socket(5) for more details about named file descriptors and their ordering.
This setting defaults to null.
Note that services which specify DefaultDependencies=no and use StandardInput= or StandardOutput= with tty/tty-force/tty-fail, should specify After=systemd-vconsole-setup.service, to make sure that the tty intialization is finished before they start.
StandardOutput=
inherit duplicates the file descriptor of standard input for standard output.
null connects standard output to /dev/null, i.e. everything written to it will be lost.
tty connects standard output to a tty (as configured via TTYPath=, see below). If the TTY is used for output only, the executed process will not become the controlling process of the terminal, and will not fail or wait for other processes to release the terminal.
journal connects standard output with the journal which is accessible via journalctl(1). Note that everything that is written to syslog or kmsg (see below) is implicitly stored in the journal as well, the specific two options listed below are hence supersets of this one.
syslog connects standard output to the syslog(3) system syslog service, in addition to the journal. Note that the journal daemon is usually configured to forward everything it receives to syslog anyway, in which case this option is no different from journal.
kmsg connects standard output with the kernel log buffer which is accessible via dmesg(1), in addition to the journal. The journal daemon might be configured to send all logs to kmsg anyway, in which case this option is no different from journal.
journal+console, syslog+console and kmsg+console work in a similar way as the three options above but copy the output to the system console as well.
The file:path option may be used to connect a specific file system object to standard output. The semantics are similar to the same option of StandardInput=, see above. If path refers to a regular file on the filesystem, it is opened (created if it doesn't exist yet) for writing at the beginning of the file, but without truncating it. If standard input and output are directed to the same file path, it is opened only once, for reading as well as writing and duplicated. This is particularly useful when the specified path refers to an AF_UNIX socket in the file system, as in that case only a single stream connection is created for both input and output.
append:path is similar to file:path above, but it opens the file in append mode.
socket connects standard output to a socket acquired via socket activation. The semantics are similar to the same option of StandardInput=, see above.
The fd:name option connects standard output to a specific, named file descriptor provided by a socket unit. A name may be specified as part of this option, following a ":" character (e.g. "fd:foobar"). If no name is specified, the name "stdout" is implied (i.e. "fd" is equivalent to "fd:stdout"). At least one socket unit defining the specified name must be provided via the Sockets= option, and the file descriptor name may differ from the name of its containing socket unit. If multiple matches are found, the first one will be used. See FileDescriptorName= in systemd.socket(5) for more details about named descriptors and their ordering.
If the standard output (or error output, see below) of a unit is connected to the journal, syslog or the kernel log buffer, the unit will implicitly gain a dependency of type After= on systemd-journald.socket (also see the "Implicit Dependencies" section above). Also note that in this case stdout (or stderr, see below) will be an AF_UNIX stream socket, and not a pipe or FIFO that can be re-opened. This means when executing shell scripts the construct echo "hello" > /dev/stderr for writing text to stderr will not work. To mitigate this use the construct echo "hello" >&2 instead, which is mostly equivalent and avoids this pitfall.
This setting defaults to the value set with DefaultStandardOutput= in systemd-system.conf(5), which defaults to journal. Note that setting this parameter might result in additional dependencies to be added to the unit (see above).
StandardError=
This setting defaults to the value set with DefaultStandardError= in systemd-system.conf(5), which defaults to inherit. Note that setting this parameter might result in additional dependencies to be added to the unit (see above).
StandardInputText=, StandardInputData=
StandardInputText= accepts arbitrary textual data. C-style escapes for special characters as well as the usual "%"-specifiers are resolved. Each time this setting is used the specified text is appended to the per-unit data buffer, followed by a newline character (thus every use appends a new line to the end of the buffer). Note that leading and trailing whitespace of lines configured with this option is removed. If an empty line is specified the buffer is cleared (hence, in order to insert an empty line, add an additional "\n" to the end or beginning of a line).
StandardInputData= accepts arbitrary binary data, encoded in Base64[4]. No escape sequences or specifiers are resolved. Any whitespace in the encoded version is ignored during decoding.
Note that StandardInputText= and StandardInputData= operate on the same data buffer, and may be mixed in order to configure both binary and textual data for the same input stream. The textual or binary data is joined strictly in the order the settings appear in the unit file. Assigning an empty string to either will reset the data buffer.
Please keep in mind that in order to maintain readability long unit file settings may be split into multiple lines, by suffixing each line (except for the last) with a "\" character (see systemd.unit(5) for details). This is particularly useful for large data configured with these two options. Example:
... StandardInput=data StandardInputData=SWNrIHNpdHplIGRhIHVuJyBlc3NlIEtsb3BzLAp1ZmYgZWVtYWwga2xvcHAncy4KSWNrIGtpZWtl \ LCBzdGF1bmUsIHd1bmRyZSBtaXIsCnVmZiBlZW1hbCBqZWh0IHNlIHVmZiBkaWUgVMO8ci4KTmFu \ dSwgZGVuayBpY2ssIGljayBkZW5rIG5hbnUhCkpldHogaXNzZSB1ZmYsIGVyc2NodCB3YXIgc2Ug \ enUhCkljayBqZWhlIHJhdXMgdW5kIGJsaWNrZSDigJQKdW5kIHdlciBzdGVodCBkcmF1w59lbj8g \ SWNrZSEK ...
LogLevelMax=
LogExtraFields=
LogRateLimitIntervalSec=, LogRateLimitBurst=
SyslogIdentifier=
SyslogFacility=
SyslogLevel=
SyslogLevelPrefix=
TTYPath=
TTYReset=
TTYVHangup=
TTYVTDisallocate=
SYSTEM V COMPATIBILITY¶
UtmpIdentifier=UtmpMode=
ENVIRONMENT VARIABLES IN SPAWNED PROCESSES¶
Processes started by the service manager are executed with an environment variable block assembled from multiple sources. Processes started by the system service manager generally do not inherit environment variables set for the service manager itself (but this may be altered via PassEnvironment=), but processes started by the user service manager instances generally do inherit all environment variables set for the service manager itself.For each invoked process the list of environment variables set is compiled from the following sources:
If the same environment variables are set by multiple of these sources, the later source — according to the order of the list above — wins. Note that as final step all variables listed in UnsetEnvironment= are removed again from the compiled environment variable list, immediately before it is passed to the executed process.
The following select environment variables are set or propagated by the service manager for each invoked process:
$PATH
$LANG
$USER, $LOGNAME, $HOME, $SHELL
$INVOCATION_ID
$XDG_RUNTIME_DIR
$MAINPID
$MANAGERPID
$LISTEN_FDS, $LISTEN_PID, $LISTEN_FDNAMES
$NOTIFY_SOCKET
$WATCHDOG_PID, $WATCHDOG_USEC
$TERM
$JOURNAL_STREAM
If both standard output and standard error of the executed processes are connected to the journal via a stream socket, this environment variable will contain information about the standard error stream, as that's usually the preferred destination for log data. (Note that typically the same stream is used for both standard output and standard error, hence very likely the environment variable contains device and inode information matching both stream file descriptors.)
This environment variable is primarily useful to allow services to optionally upgrade their used log protocol to the native journal protocol (using sd_journal_print(3) and other functions) if their standard output or standard error output is connected to the journal anyway, thus enabling delivery of structured metadata along with logged messages.
$SERVICE_RESULT
Table 4. Defined $SERVICE_RESULT values
Value | Meaning |
"success" | The service ran successfully and exited cleanly. |
"protocol" | A protocol violation occurred: the service did not take the steps required by its unit configuration (specifically what is configured in its Type= setting). |
"timeout" | One of the steps timed out. |
"exit-code" | Service process exited with a non-zero exit code; see $EXIT_CODE below for the actual exit code returned. |
"signal" | A service process was terminated abnormally by a signal, without dumping core. See $EXIT_CODE below for the actual signal causing the termination. |
"core-dump" | A service process terminated abnormally with a signal and dumped core. See $EXIT_CODE below for the signal causing the termination. |
"watchdog" | Watchdog keep-alive ping was enabled for the service, but the deadline was missed. |
"start-limit-hit" | A start limit was defined for the unit and it was hit, causing the unit to fail to start. See systemd.unit(5)'s StartLimitIntervalSec= and StartLimitBurst= for details. |
"resources" | A catch-all condition in case a system operation failed. |
This environment variable is useful to monitor failure or
successful termination of a service. Even though this variable is available
in both
ExecStop= and ExecStopPost=, it is usually a better choice to
place monitoring tools in the latter, as the former is only invoked for
services that managed to start up correctly, and the latter covers both
services that failed during their start-up and those which failed during
their runtime.
$EXIT_CODE, $EXIT_STATUS
Table 5. Summary of possible service result variable values
$SERVICE_RESULT | $EXIT_CODE | $EXIT_STATUS |
"success" | "exited" | "0" |
"protocol" | not set | not set |
"exited" | "0" | |
"timeout" | "killed" | "TERM", "KILL" |
"exited" | "0", "1", "2", "3", ..., "255" | |
"exit-code" | "exited" | "1", "2", "3", ..., "255" |
"signal" | "killed" | "HUP", "INT", "KILL", ... |
"core-dump" | "dumped" | "ABRT", "SEGV", "QUIT", ... |
"watchdog" | "dumped" | "ABRT" |
"killed" | "TERM", "KILL" | |
"exited" | "0", "1", "2", "3", ..., "255" | |
"start-limit-hit" | not set | not set |
"resources" | any of the above | any of the above |
Note: the process may be also terminated by a signal not sent by systemd. In particular the process may send an arbitrary signal to itself in a handler for any of the non-maskable signals. Nevertheless, in the "timeout" and "watchdog" rows above only the signals that systemd sends have been included. Moreover, using SuccessExitStatus= additional exit statuses may be declared to indicate clean termination, which is not reflected by this table. |
For system services, when
PAMName= is enabled and pam_systemd is part of the selected PAM
stack, additional environment variables defined by systemd may be set for
services. Specifically, these are $XDG_SEAT, $XDG_VTNR, see
pam_systemd(8) for details.
PROCESS EXIT CODES¶
When invoking a unit process the service manager possibly fails to apply the execution parameters configured with the settings above. In that case the already created service process will exit with a non-zero exit code before the configured command line is executed. (Or in other words, the child process possibly exits with these error codes, after having been created by the fork(2) system call, but before the matching execve(2) system call is called.) Specifically, exit codes defined by the C library, by the LSB specification and by the systemd service manager itself are used.The following basic service exit codes are defined by the C library.
Table 6. Basic C library exit codes
Exit Code | Symbolic Name | Description |
0 | EXIT_SUCCESS | Generic success code. |
1 | EXIT_FAILURE | Generic failure or unspecified error. |
The following service exit codes are defined by the
LSB specification[5].
Table 7. LSB service exit codes
Exit Code | Symbolic Name | Description |
2 | EXIT_INVALIDARGUMENT | Invalid or excess arguments. |
3 | EXIT_NOTIMPLEMENTED | Unimplemented feature. |
4 | EXIT_NOPERMISSION | The user has insufficient privileges. |
5 | EXIT_NOTINSTALLED | The program is not installed. |
6 | EXIT_NOTCONFIGURED | The program is not configured. |
7 | EXIT_NOTRUNNING | The program is not running. |
The LSB specification suggests that error codes 200 and above are reserved for implementations. Some of them are used by the service manager to indicate problems during process invocation:
Table 8. systemd-specific exit codes
Exit Code | Symbolic Name | Description |
200 | EXIT_CHDIR | Changing to the requested working directory failed. See WorkingDirectory= above. |
201 | EXIT_NICE | Failed to set up process scheduling priority (nice level). See Nice= above. |
202 | EXIT_FDS | Failed to close unwanted file descriptors, or to adjust passed file descriptors. |
203 | EXIT_EXEC | The actual process execution failed (specifically, the execve(2) system call). Most likely this is caused by a missing or non-accessible executable file. |
204 | EXIT_MEMORY | Failed to perform an action due to memory shortage. |
205 | EXIT_LIMITS | Failed to adjust resource limits. See LimitCPU= and related settings above. |
206 | EXIT_OOM_ADJUST | Failed to adjust the OOM setting. See OOMScoreAdjust= above. |
207 | EXIT_SIGNAL_MASK | Failed to set process signal mask. |
208 | EXIT_STDIN | Failed to set up standard input. See StandardInput= above. |
209 | EXIT_STDOUT | Failed to set up standard output. See StandardOutput= above. |
210 | EXIT_CHROOT | Failed to change root directory (chroot(2)). See RootDirectory=/RootImage= above. |
211 | EXIT_IOPRIO | Failed to set up IO scheduling priority. See IOSchedulingClass=/IOSchedulingPriority= above. |
212 | EXIT_TIMERSLACK | Failed to set up timer slack. See TimerSlackNSec= above. |
213 | EXIT_SECUREBITS | Failed to set process secure bits. See SecureBits= above. |
214 | EXIT_SETSCHEDULER | Failed to set up CPU scheduling. See CPUSchedulingPolicy=/CPUSchedulingPriority= above. |
215 | EXIT_CPUAFFINITY | Failed to set up CPU affinity. See CPUAffinity= above. |
216 | EXIT_GROUP | Failed to determine or change group credentials. See Group=/SupplementaryGroups= above. |
217 | EXIT_USER | Failed to determine or change user credentials, or to set up user namespacing. See User=/PrivateUsers= above. |
218 | EXIT_CAPABILITIES | Failed to drop capabilities, or apply ambient capabilities. See CapabilityBoundingSet=/AmbientCapabilities= above. |
219 | EXIT_CGROUP | Setting up the service control group failed. |
220 | EXIT_SETSID | Failed to create new process session. |
221 | EXIT_CONFIRM | Execution has been cancelled by the user. See the systemd.confirm_spawn= kernel command line setting on kernel-command-line(7) for details. |
222 | EXIT_STDERR | Failed to set up standard error output. See StandardError= above. |
224 | EXIT_PAM | Failed to set up PAM session. See PAMName= above. |
225 | EXIT_NETWORK | Failed to set up network namespacing. See PrivateNetwork= above. |
226 | EXIT_NAMESPACE | Failed to set up mount namespacing. See ReadOnlyPaths= and related settings above. |
227 | EXIT_NO_NEW_PRIVILEGES | Failed to disable new privileges. See NoNewPrivileges=yes above. |
228 | EXIT_SECCOMP | Failed to apply system call filters. See SystemCallFilter= and related settings above. |
229 | EXIT_SELINUX_CONTEXT | Determining or changing SELinux context failed. See SELinuxContext= above. |
230 | EXIT_PERSONALITY | Failed to set up an execution domain (personality). See Personality= above. |
231 | EXIT_APPARMOR_PROFILE | Failed to prepare changing AppArmor profile. See AppArmorProfile= above. |
232 | EXIT_ADDRESS_FAMILIES | Failed to restrict address families. See RestrictAddressFamilies= above. |
233 | EXIT_RUNTIME_DIRECTORY | Setting up runtime directory failed. See RuntimeDirectory= and related settings above. |
235 | EXIT_CHOWN | Failed to adjust socket ownership. Used for socket units only. |
236 | EXIT_SMACK_PROCESS_LABEL | Failed to set SMACK label. See SmackProcessLabel= above. |
237 | EXIT_KEYRING | Failed to set up kernel keyring. |
238 | EXIT_STATE_DIRECTORY | Failed to set up unit's state directory. See StateDirectory= above. |
239 | EXIT_CACHE_DIRECTORY | Failed to set up unit's cache directory. See CacheDirectory= above. |
240 | EXIT_LOGS_DIRECTORY | Failed to set up unit's logging directory. See LogsDirectory= above. |
241 | EXIT_CONFIGURATION_DIRECTORY | Failed to set up unit's configuration directory. See ConfigurationDirectory= above. |
Finally, the BSD operating systems define a set of exit codes, typically defined on Linux systems too:
Table 9. BSD exit codes
Exit Code | Symbolic Name | Description |
64 | EX_USAGE | Command line usage error |
65 | EX_DATAERR | Data format error |
66 | EX_NOINPUT | Cannot open input |
67 | EX_NOUSER | Addressee unknown |
68 | EX_NOHOST | Host name unknown |
69 | EX_UNAVAILABLE | Service unavailable |
70 | EX_SOFTWARE | internal software error |
71 | EX_OSERR | System error (e.g., can't fork) |
72 | EX_OSFILE | Critical OS file missing |
73 | EX_CANTCREAT | Can't create (user) output file |
74 | EX_IOERR | Input/output error |
75 | EX_TEMPFAIL | Temporary failure; user is invited to retry |
76 | EX_PROTOCOL | Remote error in protocol |
77 | EX_NOPERM | Permission denied |
78 | EX_CONFIG | Configuration error |
SEE ALSO¶
systemd(1),systemctl(1), systemd-analyze(1), journalctl(1), systemd-system.conf(5), systemd.unit(5), systemd.service(5), systemd.socket(5), systemd.swap(5), systemd.mount(5), systemd.kill(5), systemd.resource-control(5), systemd.time(7), systemd.directives(7), tmpfiles.d(5), exec(3)
NOTES¶
- 1.
- Discoverable Partitions Specification
- 2.
- No New Privileges Flag
- 3.
- proc.txt
- 4.
- Base64
- 5.
- LSB specification
systemd 241 |