]> git.ipfire.org Git - thirdparty/systemd.git/blame - man/systemd.exec.xml
docs: clarify that we don't want to own $BOOT exclusively
[thirdparty/systemd.git] / man / systemd.exec.xml
CommitLineData
514094f9 1<?xml version='1.0'?>
3a54a157 2<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
12b42c76 3 "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
0307f791 4<!-- SPDX-License-Identifier: LGPL-2.1+ -->
dd1eb43b 5
c4d4b5a7 6<refentry id="systemd.exec" xmlns:xi="http://www.w3.org/2001/XInclude">
798d3a52
ZJS
7 <refentryinfo>
8 <title>systemd.exec</title>
9 <productname>systemd</productname>
798d3a52
ZJS
10 </refentryinfo>
11
12 <refmeta>
13 <refentrytitle>systemd.exec</refentrytitle>
14 <manvolnum>5</manvolnum>
15 </refmeta>
16
17 <refnamediv>
18 <refname>systemd.exec</refname>
19 <refpurpose>Execution environment configuration</refpurpose>
20 </refnamediv>
21
22 <refsynopsisdiv>
23 <para><filename><replaceable>service</replaceable>.service</filename>,
24 <filename><replaceable>socket</replaceable>.socket</filename>,
25 <filename><replaceable>mount</replaceable>.mount</filename>,
26 <filename><replaceable>swap</replaceable>.swap</filename></para>
27 </refsynopsisdiv>
28
29 <refsect1>
30 <title>Description</title>
31
b8afec21
LP
32 <para>Unit configuration files for services, sockets, mount points, and swap devices share a subset of
33 configuration options which define the execution environment of spawned processes.</para>
34
35 <para>This man page lists the configuration options shared by these four unit types. See
36 <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry> for the common
37 options of all unit configuration files, and
798d3a52
ZJS
38 <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
39 <citerefentry><refentrytitle>systemd.socket</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
b8afec21
LP
40 <citerefentry><refentrytitle>systemd.swap</refentrytitle><manvolnum>5</manvolnum></citerefentry>, and
41 <citerefentry><refentrytitle>systemd.mount</refentrytitle><manvolnum>5</manvolnum></citerefentry> for more
42 information on the specific unit configuration files. The execution specific configuration options are configured
43 in the [Service], [Socket], [Mount], or [Swap] sections, depending on the unit type.</para>
74b47bbd 44
c7458f93 45 <para>In addition, options which control resources through Linux Control Groups (cgroups) are listed in
74b47bbd
ZJS
46 <citerefentry><refentrytitle>systemd.resource-control</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
47 Those options complement options listed here.</para>
798d3a52
ZJS
48 </refsect1>
49
c129bd5d 50 <refsect1>
45f09f93
JL
51 <title>Implicit Dependencies</title>
52
53 <para>A few execution parameters result in additional, automatic dependencies to be added:</para>
54
55 <itemizedlist>
b8afec21
LP
56 <listitem><para>Units with <varname>WorkingDirectory=</varname>, <varname>RootDirectory=</varname>,
57 <varname>RootImage=</varname>, <varname>RuntimeDirectory=</varname>, <varname>StateDirectory=</varname>,
58 <varname>CacheDirectory=</varname>, <varname>LogsDirectory=</varname> or
59 <varname>ConfigurationDirectory=</varname> set automatically gain dependencies of type
60 <varname>Requires=</varname> and <varname>After=</varname> on all mount units required to access the specified
61 paths. This is equivalent to having them listed explicitly in
62 <varname>RequiresMountsFor=</varname>.</para></listitem>
63
64 <listitem><para>Similar, units with <varname>PrivateTmp=</varname> enabled automatically get mount unit
65 dependencies for all mounts required to access <filename>/tmp</filename> and <filename>/var/tmp</filename>. They
66 will also gain an automatic <varname>After=</varname> dependency on
45f09f93
JL
67 <citerefentry><refentrytitle>systemd-tmpfiles-setup.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para></listitem>
68
b8afec21
LP
69 <listitem><para>Units whose standard output or error output is connected to <option>journal</option>,
70 <option>syslog</option> or <option>kmsg</option> (or their combinations with console output, see below)
71 automatically acquire dependencies of type <varname>After=</varname> on
72 <filename>systemd-journald.socket</filename>.</para></listitem>
45f09f93 73 </itemizedlist>
c129bd5d
LP
74 </refsect1>
75
45f09f93
JL
76 <!-- We don't have any default dependency here. -->
77
798d3a52 78 <refsect1>
b8afec21 79 <title>Paths</title>
798d3a52 80
1448dfa6
AK
81 <para>The following settings may be used to change a service's view of the filesystem. Please note that the paths
82 must be absolute and must not contain a <literal>..</literal> path component.</para>
83
798d3a52
ZJS
84 <variablelist class='unit-directives'>
85
86 <varlistentry>
87 <term><varname>WorkingDirectory=</varname></term>
88
d251207d
LP
89 <listitem><para>Takes a directory path relative to the service's root directory specified by
90 <varname>RootDirectory=</varname>, or the special value <literal>~</literal>. Sets the working directory for
91 executed processes. If set to <literal>~</literal>, the home directory of the user specified in
92 <varname>User=</varname> is used. If not set, defaults to the root directory when systemd is running as a
93 system instance and the respective user's home directory if run as user. If the setting is prefixed with the
94 <literal>-</literal> character, a missing working directory is not considered fatal. If
915e6d16
LP
95 <varname>RootDirectory=</varname>/<varname>RootImage=</varname> is not set, then
96 <varname>WorkingDirectory=</varname> is relative to the root of the system running the service manager. Note
97 that setting this parameter might result in additional dependencies to be added to the unit (see
98 above).</para></listitem>
798d3a52
ZJS
99 </varlistentry>
100
101 <varlistentry>
102 <term><varname>RootDirectory=</varname></term>
103
d251207d
LP
104 <listitem><para>Takes a directory path relative to the host's root directory (i.e. the root of the system
105 running the service manager). Sets the root directory for executed processes, with the <citerefentry
106 project='man-pages'><refentrytitle>chroot</refentrytitle><manvolnum>2</manvolnum></citerefentry> system
107 call. If this is used, it must be ensured that the process binary and all its auxiliary files are available in
108 the <function>chroot()</function> jail. Note that setting this parameter might result in additional
109 dependencies to be added to the unit (see above).</para>
110
5d997827 111 <para>The <varname>MountAPIVFS=</varname> and <varname>PrivateUsers=</varname> settings are particularly useful
c4d4b5a7
LP
112 in conjunction with <varname>RootDirectory=</varname>. For details, see below.</para>
113
114 <xi:include href="system-only.xml" xpointer="singular"/></listitem>
5d997827
LP
115 </varlistentry>
116
915e6d16
LP
117 <varlistentry>
118 <term><varname>RootImage=</varname></term>
b8afec21 119
19ac32cd
LP
120 <listitem><para>Takes a path to a block device node or regular file as argument. This call is similar
121 to <varname>RootDirectory=</varname> however mounts a file system hierarchy from a block device node
122 or loopback file instead of a directory. The device node or file system image file needs to contain a
123 file system without a partition table, or a file system within an MBR/MS-DOS or GPT partition table
124 with only a single Linux-compatible partition, or a set of file systems within a GPT partition table
125 that follows the <ulink url="https://systemd.io/DISCOVERABLE_PARTITIONS">Discoverable Partitions
fe65e88b
YW
126 Specification</ulink>.</para>
127
c4d4b5a7
LP
128 <para>When <varname>DevicePolicy=</varname> is set to <literal>closed</literal> or
129 <literal>strict</literal>, or set to <literal>auto</literal> and <varname>DeviceAllow=</varname> is
130 set, then this setting adds <filename>/dev/loop-control</filename> with <constant>rw</constant> mode,
131 <literal>block-loop</literal> and <literal>block-blkext</literal> with <constant>rwm</constant> mode
132 to <varname>DeviceAllow=</varname>. See
fe65e88b
YW
133 <citerefentry><refentrytitle>systemd.resource-control</refentrytitle><manvolnum>5</manvolnum></citerefentry>
134 for the details about <varname>DevicePolicy=</varname> or <varname>DeviceAllow=</varname>. Also, see
c4d4b5a7
LP
135 <varname>PrivateDevices=</varname> below, as it may change the setting of
136 <varname>DevicePolicy=</varname>.</para>
137
138 <xi:include href="system-only.xml" xpointer="singular"/></listitem>
915e6d16
LP
139 </varlistentry>
140
5d997827
LP
141 <varlistentry>
142 <term><varname>MountAPIVFS=</varname></term>
143
144 <listitem><para>Takes a boolean argument. If on, a private mount namespace for the unit's processes is created
ef3116b5
ZJS
145 and the API file systems <filename>/proc</filename>, <filename>/sys</filename>, and <filename>/dev</filename>
146 are mounted inside of it, unless they are already mounted. Note that this option has no effect unless used in
147 conjunction with <varname>RootDirectory=</varname>/<varname>RootImage=</varname> as these three mounts are
148 generally mounted in the host anyway, and unless the root directory is changed, the private mount namespace
149 will be a 1:1 copy of the host's, and include these three mounts. Note that the <filename>/dev</filename> file
150 system of the host is bind mounted if this option is used without <varname>PrivateDevices=</varname>. To run
151 the service with a private, minimal version of <filename>/dev/</filename>, combine this option with
c4d4b5a7
LP
152 <varname>PrivateDevices=</varname>.</para>
153
154 <xi:include href="system-only.xml" xpointer="singular"/></listitem>
798d3a52
ZJS
155 </varlistentry>
156
b8afec21
LP
157 <varlistentry>
158 <term><varname>BindPaths=</varname></term>
159 <term><varname>BindReadOnlyPaths=</varname></term>
160
161 <listitem><para>Configures unit-specific bind mounts. A bind mount makes a particular file or directory
162 available at an additional place in the unit's view of the file system. Any bind mounts created with this
163 option are specific to the unit, and are not visible in the host's mount table. This option expects a
164 whitespace separated list of bind mount definitions. Each definition consists of a colon-separated triple of
165 source path, destination path and option string, where the latter two are optional. If only a source path is
166 specified the source and destination is taken to be the same. The option string may be either
167 <literal>rbind</literal> or <literal>norbind</literal> for configuring a recursive or non-recursive bind
4ca763a9
YW
168 mount. If the destination path is omitted, the option string must be omitted too.
169 Each bind mount definition may be prefixed with <literal>-</literal>, in which case it will be ignored
170 when its source path does not exist.</para>
b8afec21
LP
171
172 <para><varname>BindPaths=</varname> creates regular writable bind mounts (unless the source file system mount
173 is already marked read-only), while <varname>BindReadOnlyPaths=</varname> creates read-only bind mounts. These
174 settings may be used more than once, each usage appends to the unit's list of bind mounts. If the empty string
175 is assigned to either of these two options the entire list of bind mounts defined prior to this is reset. Note
176 that in this case both read-only and regular bind mounts are reset, regardless which of the two settings is
177 used.</para>
178
179 <para>This option is particularly useful when <varname>RootDirectory=</varname>/<varname>RootImage=</varname>
180 is used. In this case the source path refers to a path on the host file system, while the destination path
c4d4b5a7
LP
181 refers to a path below the root directory of the unit.</para>
182
db8d154d
ZJS
183 <para>Note that the destination directory must exist or systemd must be able to create it. Thus, it
184 is not possible to use those options for mount points nested underneath paths specified in
185 <varname>InaccessiblePaths=</varname>, or under <filename>/home/</filename> and other protected
186 directories if <varname>ProtectHome=yes</varname> is
187 specified. <varname>TemporaryFileSystem=</varname> with <literal>:ro</literal> or
188 <varname>ProtectHome=tmpfs</varname> should be used instead.</para>
189
c4d4b5a7 190 <xi:include href="system-only.xml" xpointer="singular"/></listitem>
b8afec21
LP
191 </varlistentry>
192
193 </variablelist>
194 </refsect1>
195
196 <refsect1>
197 <title>Credentials</title>
198
c4d4b5a7
LP
199 <xi:include href="system-only.xml" xpointer="plural"/>
200
b8afec21
LP
201 <variablelist class='unit-directives'>
202
798d3a52
ZJS
203 <varlistentry>
204 <term><varname>User=</varname></term>
205 <term><varname>Group=</varname></term>
206
29206d46 207 <listitem><para>Set the UNIX user or group that the processes are executed as, respectively. Takes a single
b8afec21
LP
208 user or group name, or a numeric ID as argument. For system services (services run by the system service
209 manager, i.e. managed by PID 1) and for user services of the root user (services managed by root's instance of
47da760e
LP
210 <command>systemd --user</command>), the default is <literal>root</literal>, but <varname>User=</varname> may be
211 used to specify a different user. For user services of any other user, switching user identity is not
212 permitted, hence the only valid setting is the same user the user's service manager is running as. If no group
213 is set, the default group of the user is used. This setting does not affect commands whose command line is
565dab8e
LP
214 prefixed with <literal>+</literal>.</para>
215
216 <para>Note that restrictions on the user/group name syntax are enforced: the specified name must consist only
217 of the characters a-z, A-Z, 0-9, <literal>_</literal> and <literal>-</literal>, except for the first character
218 which must be one of a-z, A-Z or <literal>_</literal> (i.e. numbers and <literal>-</literal> are not permitted
219 as first character). The user/group name must have at least one character, and at most 31. These restrictions
220 are enforced in order to avoid ambiguities and to ensure user/group names and unit files remain portable among
221 Linux systems.</para>
222
223 <para>When used in conjunction with <varname>DynamicUser=</varname> the user/group name specified is
224 dynamically allocated at the time the service is started, and released at the time the service is stopped —
225 unless it is already allocated statically (see below). If <varname>DynamicUser=</varname> is not used the
226 specified user and group must have been created statically in the user database no later than the moment the
227 service is started, for example using the
228 <citerefentry><refentrytitle>sysusers.d</refentrytitle><manvolnum>5</manvolnum></citerefentry> facility, which
b042dd68
LP
229 is applied at boot or package install time.</para>
230
231 <para>If the <varname>User=</varname> setting is used the supplementary group list is initialized
232 from the specified user's default group list, as defined in the system's user and group
233 database. Additional groups may be configured through the <varname>SupplementaryGroups=</varname>
234 setting (see below).</para></listitem>
29206d46
LP
235 </varlistentry>
236
237 <varlistentry>
238 <term><varname>DynamicUser=</varname></term>
239
c648d4d4
LP
240 <listitem><para>Takes a boolean parameter. If set, a UNIX user and group pair is allocated
241 dynamically when the unit is started, and released as soon as it is stopped. The user and group will
242 not be added to <filename>/etc/passwd</filename> or <filename>/etc/group</filename>, but are managed
243 transiently during runtime. The
244 <citerefentry><refentrytitle>nss-systemd</refentrytitle><manvolnum>8</manvolnum></citerefentry> glibc
245 NSS module provides integration of these dynamic users/groups into the system's user and group
29206d46 246 databases. The user and group name to use may be configured via <varname>User=</varname> and
c648d4d4
LP
247 <varname>Group=</varname> (see above). If these options are not used and dynamic user/group
248 allocation is enabled for a unit, the name of the dynamic user/group is implicitly derived from the
249 unit name. If the unit name without the type suffix qualifies as valid user name it is used directly,
250 otherwise a name incorporating a hash of it is used. If a statically allocated user or group of the
251 configured name already exists, it is used and no dynamic user/group is allocated. Note that if
252 <varname>User=</varname> is specified and the static group with the name exists, then it is required
253 that the static user with the name already exists. Similarly, if <varname>Group=</varname> is
254 specified and the static user with the name exists, then it is required that the static group with
255 the name already exists. Dynamic users/groups are allocated from the UID/GID range 61184…65519. It is
256 recommended to avoid this range for regular system or login users. At any point in time each UID/GID
257 from this range is only assigned to zero or one dynamically allocated users/groups in use. However,
258 UID/GIDs are recycled after a unit is terminated. Care should be taken that any processes running as
259 part of a unit for which dynamic users/groups are enabled do not leave files or directories owned by
260 these users/groups around, as a different unit might get the same UID/GID assigned later on, and thus
261 gain access to these files or directories. If <varname>DynamicUser=</varname> is enabled,
e0e65f7d
LP
262 <varname>RemoveIPC=</varname> and <varname>PrivateTmp=</varname> are implied (and cannot be turned
263 off). This ensures that the lifetime of IPC objects and temporary files created by the executed
264 processes is bound to the runtime of the service, and hence the lifetime of the dynamic
265 user/group. Since <filename>/tmp/</filename> and <filename>/var/tmp/</filename> are usually the only
266 world-writable directories on a system this ensures that a unit making use of dynamic user/group
267 allocation cannot leave files around after unit termination. Furthermore
268 <varname>NoNewPrivileges=</varname> and <varname>RestrictSUIDSGID=</varname> are implicitly enabled
269 (and cannot be disabled), to ensure that processes invoked cannot take benefit or create SUID/SGID
270 files or directories. Moreover <varname>ProtectSystem=strict</varname> and
c648d4d4
LP
271 <varname>ProtectHome=read-only</varname> are implied, thus prohibiting the service to write to
272 arbitrary file system locations. In order to allow the service to write to certain directories, they
273 have to be whitelisted using <varname>ReadWritePaths=</varname>, but care must be taken so that
274 UID/GID recycling doesn't create security issues involving files created by the service. Use
275 <varname>RuntimeDirectory=</varname> (see below) in order to assign a writable runtime directory to a
276 service, owned by the dynamic user/group and removed automatically when the unit is terminated. Use
277 <varname>StateDirectory=</varname>, <varname>CacheDirectory=</varname> and
278 <varname>LogsDirectory=</varname> in order to assign a set of writable directories for specific
279 purposes to the service in a way that they are protected from vulnerabilities due to UID reuse (see
280 below). If this option is enabled, care should be taken that the unit's processes do not get access
281 to directories outside of these explicitly configured and managed ones. Specifically, do not use
282 <varname>BindPaths=</varname> and be careful with <constant>AF_UNIX</constant> file descriptor
283 passing for directory file descriptors, as this would permit processes to create files or directories
de04bbdc 284 owned by the dynamic user/group that are not subject to the lifecycle and access guarantees of the
c648d4d4 285 service. Defaults to off.</para></listitem>
798d3a52
ZJS
286 </varlistentry>
287
288 <varlistentry>
289 <term><varname>SupplementaryGroups=</varname></term>
290
b8afec21
LP
291 <listitem><para>Sets the supplementary Unix groups the processes are executed as. This takes a space-separated
292 list of group names or IDs. This option may be specified more than once, in which case all listed groups are
293 set as supplementary groups. When the empty string is assigned, the list of supplementary groups is reset, and
294 all assignments prior to this one will have no effect. In any way, this option does not override, but extends
295 the list of supplementary groups configured in the system group database for the user. This does not affect
296 commands prefixed with <literal>+</literal>.</para></listitem>
798d3a52
ZJS
297 </varlistentry>
298
00d9ef85 299 <varlistentry>
b8afec21 300 <term><varname>PAMName=</varname></term>
00d9ef85 301
b8afec21
LP
302 <listitem><para>Sets the PAM service name to set up a session as. If set, the executed process will be
303 registered as a PAM session under the specified service name. This is only useful in conjunction with the
304 <varname>User=</varname> setting, and is otherwise ignored. If not set, no PAM session will be opened for the
305 executed processes. See <citerefentry
306 project='man-pages'><refentrytitle>pam</refentrytitle><manvolnum>8</manvolnum></citerefentry> for
307 details.</para>
00d9ef85 308
b8afec21
LP
309 <para>Note that for each unit making use of this option a PAM session handler process will be maintained as
310 part of the unit and stays around as long as the unit is active, to ensure that appropriate actions can be
311 taken when the unit and hence the PAM session terminates. This process is named <literal>(sd-pam)</literal> and
312 is an immediate child process of the unit's main process.</para>
798d3a52 313
b8afec21
LP
314 <para>Note that when this option is used for a unit it is very likely (depending on PAM configuration) that the
315 main unit process will be migrated to its own session scope unit when it is activated. This process will hence
316 be associated with two units: the unit it was originally started from (and for which
317 <varname>PAMName=</varname> was configured), and the session scope unit. Any child processes of that process
318 will however be associated with the session scope unit only. This has implications when used in combination
319 with <varname>NotifyAccess=</varname><option>all</option>, as these child processes will not be able to affect
320 changes in the original unit through notification messages. These messages will be considered belonging to the
321 session scope unit and not the original unit. It is hence not recommended to use <varname>PAMName=</varname> in
322 combination with <varname>NotifyAccess=</varname><option>all</option>.</para>
323 </listitem>
798d3a52
ZJS
324 </varlistentry>
325
b8afec21
LP
326 </variablelist>
327 </refsect1>
798d3a52 328
b8afec21
LP
329 <refsect1>
330 <title>Capabilities</title>
798d3a52 331
c4d4b5a7
LP
332 <xi:include href="system-only.xml" xpointer="plural"/>
333
b8afec21 334 <variablelist class='unit-directives'>
798d3a52
ZJS
335
336 <varlistentry>
b8afec21
LP
337 <term><varname>CapabilityBoundingSet=</varname></term>
338
339 <listitem><para>Controls which capabilities to include in the capability bounding set for the executed
340 process. See <citerefentry
341 project='man-pages'><refentrytitle>capabilities</refentrytitle><manvolnum>7</manvolnum></citerefentry> for
342 details. Takes a whitespace-separated list of capability names, e.g. <constant>CAP_SYS_ADMIN</constant>,
343 <constant>CAP_DAC_OVERRIDE</constant>, <constant>CAP_SYS_PTRACE</constant>. Capabilities listed will be
344 included in the bounding set, all others are removed. If the list of capabilities is prefixed with
345 <literal>~</literal>, all but the listed capabilities will be included, the effect of the assignment
346 inverted. Note that this option also affects the respective capabilities in the effective, permitted and
347 inheritable capability sets. If this option is not used, the capability bounding set is not modified on process
348 execution, hence no limits on the capabilities of the process are enforced. This option may appear more than
b086654c 349 once, in which case the bounding sets are merged by <constant>OR</constant>, or by <constant>AND</constant> if
b8afec21
LP
350 the lines are prefixed with <literal>~</literal> (see below). If the empty string is assigned to this option,
351 the bounding set is reset to the empty capability set, and all prior settings have no effect. If set to
352 <literal>~</literal> (without any further argument), the bounding set is reset to the full set of available
353 capabilities, also undoing any previous settings. This does not affect commands prefixed with
354 <literal>+</literal>.</para>
798d3a52 355
b8afec21
LP
356 <para>Example: if a unit has the following,
357 <programlisting>CapabilityBoundingSet=CAP_A CAP_B
358CapabilityBoundingSet=CAP_B CAP_C</programlisting>
f8b68539
ZJS
359 then <constant index='false'>CAP_A</constant>, <constant index='false'>CAP_B</constant>, and
360 <constant index='false'>CAP_C</constant> are set. If the second line is prefixed with
361 <literal>~</literal>, e.g.,
b8afec21
LP
362 <programlisting>CapabilityBoundingSet=CAP_A CAP_B
363CapabilityBoundingSet=~CAP_B CAP_C</programlisting>
f8b68539 364 then, only <constant index='false'>CAP_A</constant> is set.</para></listitem>
798d3a52
ZJS
365 </varlistentry>
366
367 <varlistentry>
b8afec21 368 <term><varname>AmbientCapabilities=</varname></term>
798d3a52 369
b8afec21
LP
370 <listitem><para>Controls which capabilities to include in the ambient capability set for the executed
371 process. Takes a whitespace-separated list of capability names, e.g. <constant>CAP_SYS_ADMIN</constant>,
372 <constant>CAP_DAC_OVERRIDE</constant>, <constant>CAP_SYS_PTRACE</constant>. This option may appear more than
373 once in which case the ambient capability sets are merged (see the above examples in
374 <varname>CapabilityBoundingSet=</varname>). If the list of capabilities is prefixed with <literal>~</literal>,
375 all but the listed capabilities will be included, the effect of the assignment inverted. If the empty string is
376 assigned to this option, the ambient capability set is reset to the empty capability set, and all prior
377 settings have no effect. If set to <literal>~</literal> (without any further argument), the ambient capability
378 set is reset to the full set of available capabilities, also undoing any previous settings. Note that adding
379 capabilities to ambient capability set adds them to the process's inherited capability set. </para><para>
380 Ambient capability sets are useful if you want to execute a process as a non-privileged user but still want to
381 give it some capabilities. Note that in this case option <constant>keep-caps</constant> is automatically added
382 to <varname>SecureBits=</varname> to retain the capabilities over the user
383 change. <varname>AmbientCapabilities=</varname> does not affect commands prefixed with
384 <literal>+</literal>.</para></listitem>
798d3a52
ZJS
385 </varlistentry>
386
b8afec21
LP
387 </variablelist>
388 </refsect1>
798d3a52 389
b8afec21
LP
390 <refsect1>
391 <title>Security</title>
798d3a52 392
b8afec21 393 <variablelist class='unit-directives'>
798d3a52
ZJS
394
395 <varlistentry>
b8afec21 396 <term><varname>NoNewPrivileges=</varname></term>
798d3a52 397
7445db6e
LP
398 <listitem><para>Takes a boolean argument. If true, ensures that the service process and all its
399 children can never gain new privileges through <function>execve()</function> (e.g. via setuid or
400 setgid bits, or filesystem capabilities). This is the simplest and most effective way to ensure that
401 a process and its children can never elevate privileges again. Defaults to false, but certain
402 settings override this and ignore the value of this setting. This is the case when
403 <varname>SystemCallFilter=</varname>, <varname>SystemCallArchitectures=</varname>,
404 <varname>RestrictAddressFamilies=</varname>, <varname>RestrictNamespaces=</varname>,
405 <varname>PrivateDevices=</varname>, <varname>ProtectKernelTunables=</varname>,
d916e35b
KK
406 <varname>ProtectKernelModules=</varname>, <varname>ProtectKernelLogs=</varname>,
407 <varname>MemoryDenyWriteExecute=</varname>, <varname>RestrictRealtime=</varname>,
408 <varname>RestrictSUIDSGID=</varname>, <varname>DynamicUser=</varname> or <varname>LockPersonality=</varname>
409 are specified. Note that even if this setting is overridden by them, <command>systemctl show</command> shows the
410 original value of this setting. Also see <ulink
7445db6e 411 url="https://www.kernel.org/doc/html/latest/userspace-api/no_new_privs.html">No New Privileges
bf65b7e0 412 Flag</ulink>.</para></listitem>
798d3a52
ZJS
413 </varlistentry>
414
415 <varlistentry>
b8afec21 416 <term><varname>SecureBits=</varname></term>
798d3a52 417
b8afec21
LP
418 <listitem><para>Controls the secure bits set for the executed process. Takes a space-separated combination of
419 options from the following list: <option>keep-caps</option>, <option>keep-caps-locked</option>,
420 <option>no-setuid-fixup</option>, <option>no-setuid-fixup-locked</option>, <option>noroot</option>, and
421 <option>noroot-locked</option>. This option may appear more than once, in which case the secure bits are
422 ORed. If the empty string is assigned to this option, the bits are reset to 0. This does not affect commands
423 prefixed with <literal>+</literal>. See <citerefentry
424 project='man-pages'><refentrytitle>capabilities</refentrytitle><manvolnum>7</manvolnum></citerefentry> for
425 details.</para></listitem>
798d3a52
ZJS
426 </varlistentry>
427
b8afec21
LP
428 </variablelist>
429 </refsect1>
798d3a52 430
b8afec21
LP
431 <refsect1>
432 <title>Mandatory Access Control</title>
c4d4b5a7
LP
433
434 <xi:include href="system-only.xml" xpointer="plural"/>
435
e0e2ecd5 436 <variablelist class='unit-directives'>
798d3a52 437
798d3a52 438 <varlistentry>
b8afec21
LP
439 <term><varname>SELinuxContext=</varname></term>
440
441 <listitem><para>Set the SELinux security context of the executed process. If set, this will override the
442 automated domain transition. However, the policy still needs to authorize the transition. This directive is
443 ignored if SELinux is disabled. If prefixed by <literal>-</literal>, all errors will be ignored. This does not
444 affect commands prefixed with <literal>+</literal>. See <citerefentry
445 project='die-net'><refentrytitle>setexeccon</refentrytitle><manvolnum>3</manvolnum></citerefentry> for
446 details.</para></listitem>
798d3a52
ZJS
447 </varlistentry>
448
b4c14404 449 <varlistentry>
b8afec21 450 <term><varname>AppArmorProfile=</varname></term>
b4c14404 451
b8afec21
LP
452 <listitem><para>Takes a profile name as argument. The process executed by the unit will switch to this profile
453 when started. Profiles must already be loaded in the kernel, or the unit will fail. This result in a non
454 operation if AppArmor is not enabled. If prefixed by <literal>-</literal>, all errors will be ignored. This
455 does not affect commands prefixed with <literal>+</literal>.</para></listitem>
456 </varlistentry>
00819cc1 457
b8afec21
LP
458 <varlistentry>
459 <term><varname>SmackProcessLabel=</varname></term>
b4c14404 460
b8afec21
LP
461 <listitem><para>Takes a <option>SMACK64</option> security label as argument. The process executed by the unit
462 will be started under this label and SMACK will decide whether the process is allowed to run or not, based on
463 it. The process will continue to run under the label specified here unless the executable has its own
464 <option>SMACK64EXEC</option> label, in which case the process will transition to run under that label. When not
465 specified, the label that systemd is running under is used. This directive is ignored if SMACK is
466 disabled.</para>
b4c14404 467
b8afec21
LP
468 <para>The value may be prefixed by <literal>-</literal>, in which case all errors will be ignored. An empty
469 value may be specified to unset previous assignments. This does not affect commands prefixed with
470 <literal>+</literal>.</para></listitem>
b4c14404
FB
471 </varlistentry>
472
b8afec21
LP
473 </variablelist>
474 </refsect1>
00819cc1 475
b8afec21
LP
476 <refsect1>
477 <title>Process Properties</title>
00819cc1 478
e0e2ecd5 479 <variablelist class='unit-directives'>
00819cc1 480
798d3a52 481 <varlistentry>
b8afec21
LP
482 <term><varname>LimitCPU=</varname></term>
483 <term><varname>LimitFSIZE=</varname></term>
484 <term><varname>LimitDATA=</varname></term>
485 <term><varname>LimitSTACK=</varname></term>
486 <term><varname>LimitCORE=</varname></term>
487 <term><varname>LimitRSS=</varname></term>
488 <term><varname>LimitNOFILE=</varname></term>
489 <term><varname>LimitAS=</varname></term>
490 <term><varname>LimitNPROC=</varname></term>
491 <term><varname>LimitMEMLOCK=</varname></term>
492 <term><varname>LimitLOCKS=</varname></term>
493 <term><varname>LimitSIGPENDING=</varname></term>
494 <term><varname>LimitMSGQUEUE=</varname></term>
495 <term><varname>LimitNICE=</varname></term>
496 <term><varname>LimitRTPRIO=</varname></term>
497 <term><varname>LimitRTTIME=</varname></term>
fc8d0381 498
b8afec21
LP
499 <listitem><para>Set soft and hard limits on various resources for executed processes. See
500 <citerefentry><refentrytitle>setrlimit</refentrytitle><manvolnum>2</manvolnum></citerefentry> for details on
501 the resource limit concept. Resource limits may be specified in two formats: either as single value to set a
502 specific soft and hard limit to the same value, or as colon-separated pair <option>soft:hard</option> to set
503 both limits individually (e.g. <literal>LimitAS=4G:16G</literal>). Use the string <option>infinity</option> to
504 configure no limit on a specific resource. The multiplicative suffixes K, M, G, T, P and E (to the base 1024)
505 may be used for resource limits measured in bytes (e.g. LimitAS=16G). For the limits referring to time values,
506 the usual time units ms, s, min, h and so on may be used (see
507 <citerefentry><refentrytitle>systemd.time</refentrytitle><manvolnum>7</manvolnum></citerefentry> for
508 details). Note that if no time unit is specified for <varname>LimitCPU=</varname> the default unit of seconds
509 is implied, while for <varname>LimitRTTIME=</varname> the default unit of microseconds is implied. Also, note
510 that the effective granularity of the limits might influence their enforcement. For example, time limits
511 specified for <varname>LimitCPU=</varname> will be rounded up implicitly to multiples of 1s. For
512 <varname>LimitNICE=</varname> the value may be specified in two syntaxes: if prefixed with <literal>+</literal>
513 or <literal>-</literal>, the value is understood as regular Linux nice value in the range -20..19. If not
514 prefixed like this the value is understood as raw resource limit parameter in the range 0..40 (with 0 being
515 equivalent to 1).</para>
fc8d0381 516
b8afec21
LP
517 <para>Note that most process resource limits configured with these options are per-process, and processes may
518 fork in order to acquire a new set of resources that are accounted independently of the original process, and
519 may thus escape limits set. Also note that <varname>LimitRSS=</varname> is not implemented on Linux, and
520 setting it has no effect. Often it is advisable to prefer the resource controls listed in
521 <citerefentry><refentrytitle>systemd.resource-control</refentrytitle><manvolnum>5</manvolnum></citerefentry>
522 over these per-process limits, as they apply to services as a whole, may be altered dynamically at runtime, and
523 are generally more expressive. For example, <varname>MemoryLimit=</varname> is a more powerful (and working)
524 replacement for <varname>LimitRSS=</varname>.</para>
fc8d0381 525
b8afec21
LP
526 <para>For system units these resource limits may be chosen freely. For user units however (i.e. units run by a
527 per-user instance of
528 <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>), these limits are
529 bound by (possibly more restrictive) per-user limits enforced by the OS.</para>
fc8d0381 530
b8afec21
LP
531 <para>Resource limits not configured explicitly for a unit default to the value configured in the various
532 <varname>DefaultLimitCPU=</varname>, <varname>DefaultLimitFSIZE=</varname>, … options available in
533 <citerefentry><refentrytitle>systemd-system.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>, and –
534 if not configured there – the kernel or per-user defaults, as defined by the OS (the latter only for user
535 services, see above).</para>
fc8d0381 536
b8afec21
LP
537 <table>
538 <title>Resource limit directives, their equivalent <command>ulimit</command> shell commands and the unit used</title>
798d3a52 539
a4c18002 540 <tgroup cols='3'>
798d3a52
ZJS
541 <colspec colname='directive' />
542 <colspec colname='equivalent' />
a4c18002 543 <colspec colname='unit' />
798d3a52
ZJS
544 <thead>
545 <row>
546 <entry>Directive</entry>
f4c9356d 547 <entry><command>ulimit</command> equivalent</entry>
a4c18002 548 <entry>Unit</entry>
798d3a52
ZJS
549 </row>
550 </thead>
551 <tbody>
552 <row>
a4c18002 553 <entry>LimitCPU=</entry>
798d3a52 554 <entry>ulimit -t</entry>
a4c18002 555 <entry>Seconds</entry>
798d3a52
ZJS
556 </row>
557 <row>
a4c18002 558 <entry>LimitFSIZE=</entry>
798d3a52 559 <entry>ulimit -f</entry>
a4c18002 560 <entry>Bytes</entry>
798d3a52
ZJS
561 </row>
562 <row>
a4c18002 563 <entry>LimitDATA=</entry>
798d3a52 564 <entry>ulimit -d</entry>
a4c18002 565 <entry>Bytes</entry>
798d3a52
ZJS
566 </row>
567 <row>
a4c18002 568 <entry>LimitSTACK=</entry>
798d3a52 569 <entry>ulimit -s</entry>
a4c18002 570 <entry>Bytes</entry>
798d3a52
ZJS
571 </row>
572 <row>
a4c18002 573 <entry>LimitCORE=</entry>
798d3a52 574 <entry>ulimit -c</entry>
a4c18002 575 <entry>Bytes</entry>
798d3a52
ZJS
576 </row>
577 <row>
a4c18002 578 <entry>LimitRSS=</entry>
798d3a52 579 <entry>ulimit -m</entry>
a4c18002 580 <entry>Bytes</entry>
798d3a52
ZJS
581 </row>
582 <row>
a4c18002 583 <entry>LimitNOFILE=</entry>
798d3a52 584 <entry>ulimit -n</entry>
a4c18002 585 <entry>Number of File Descriptors</entry>
798d3a52
ZJS
586 </row>
587 <row>
a4c18002 588 <entry>LimitAS=</entry>
798d3a52 589 <entry>ulimit -v</entry>
a4c18002 590 <entry>Bytes</entry>
798d3a52
ZJS
591 </row>
592 <row>
a4c18002 593 <entry>LimitNPROC=</entry>
798d3a52 594 <entry>ulimit -u</entry>
a4c18002 595 <entry>Number of Processes</entry>
798d3a52
ZJS
596 </row>
597 <row>
a4c18002 598 <entry>LimitMEMLOCK=</entry>
798d3a52 599 <entry>ulimit -l</entry>
a4c18002 600 <entry>Bytes</entry>
798d3a52
ZJS
601 </row>
602 <row>
a4c18002 603 <entry>LimitLOCKS=</entry>
798d3a52 604 <entry>ulimit -x</entry>
a4c18002 605 <entry>Number of Locks</entry>
798d3a52
ZJS
606 </row>
607 <row>
a4c18002 608 <entry>LimitSIGPENDING=</entry>
798d3a52 609 <entry>ulimit -i</entry>
a4c18002 610 <entry>Number of Queued Signals</entry>
798d3a52
ZJS
611 </row>
612 <row>
a4c18002 613 <entry>LimitMSGQUEUE=</entry>
798d3a52 614 <entry>ulimit -q</entry>
a4c18002 615 <entry>Bytes</entry>
798d3a52
ZJS
616 </row>
617 <row>
a4c18002 618 <entry>LimitNICE=</entry>
798d3a52 619 <entry>ulimit -e</entry>
a4c18002 620 <entry>Nice Level</entry>
798d3a52
ZJS
621 </row>
622 <row>
a4c18002 623 <entry>LimitRTPRIO=</entry>
798d3a52 624 <entry>ulimit -r</entry>
a4c18002 625 <entry>Realtime Priority</entry>
798d3a52
ZJS
626 </row>
627 <row>
a4c18002 628 <entry>LimitRTTIME=</entry>
798d3a52 629 <entry>No equivalent</entry>
a4c18002 630 <entry>Microseconds</entry>
798d3a52
ZJS
631 </row>
632 </tbody>
633 </tgroup>
a4c18002 634 </table></listitem>
798d3a52
ZJS
635 </varlistentry>
636
637 <varlistentry>
b8afec21 638 <term><varname>UMask=</varname></term>
9eb484fa 639
b8afec21
LP
640 <listitem><para>Controls the file mode creation mask. Takes an access mode in octal notation. See
641 <citerefentry><refentrytitle>umask</refentrytitle><manvolnum>2</manvolnum></citerefentry> for details. Defaults
642 to 0022.</para></listitem>
643 </varlistentry>
644
645 <varlistentry>
646 <term><varname>KeyringMode=</varname></term>
647
648 <listitem><para>Controls how the kernel session keyring is set up for the service (see <citerefentry
649 project='man-pages'><refentrytitle>session-keyring</refentrytitle><manvolnum>7</manvolnum></citerefentry> for
650 details on the session keyring). Takes one of <option>inherit</option>, <option>private</option>,
651 <option>shared</option>. If set to <option>inherit</option> no special keyring setup is done, and the kernel's
652 default behaviour is applied. If <option>private</option> is used a new session keyring is allocated when a
653 service process is invoked, and it is not linked up with any user keyring. This is the recommended setting for
654 system services, as this ensures that multiple services running under the same system user ID (in particular
655 the root user) do not share their key material among each other. If <option>shared</option> is used a new
656 session keyring is allocated as for <option>private</option>, but the user keyring of the user configured with
657 <varname>User=</varname> is linked into it, so that keys assigned to the user may be requested by the unit's
658 processes. In this modes multiple units running processes under the same user ID may share key material. Unless
659 <option>inherit</option> is selected the unique invocation ID for the unit (see below) is added as a protected
660 key by the name <literal>invocation_id</literal> to the newly created session keyring. Defaults to
00f5ad93
LP
661 <option>private</option> for services of the system service manager and to <option>inherit</option> for
662 non-service units and for services of the user service manager.</para></listitem>
b8afec21
LP
663 </varlistentry>
664
665 <varlistentry>
666 <term><varname>OOMScoreAdjust=</varname></term>
667
8e74bf7f
LP
668 <listitem><para>Sets the adjustment value for the Linux kernel's Out-Of-Memory (OOM) killer score for
669 executed processes. Takes an integer between -1000 (to disable OOM killing of processes of this unit)
670 and 1000 (to make killing of processes of this unit under memory pressure very likely). See <ulink
671 url="https://www.kernel.org/doc/Documentation/filesystems/proc.txt">proc.txt</ulink> for details. If
672 not specified defaults to the OOM score adjustment level of the service manager itself, which is
673 normally at 0.</para>
674
675 <para>Use the <varname>OOMPolicy=</varname> setting of service units to configure how the service
676 manager shall react to the kernel OOM killer terminating a process of the service. See
677 <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>
678 for details.</para></listitem>
b8afec21
LP
679 </varlistentry>
680
681 <varlistentry>
682 <term><varname>TimerSlackNSec=</varname></term>
683 <listitem><para>Sets the timer slack in nanoseconds for the executed processes. The timer slack controls the
684 accuracy of wake-ups triggered by timers. See
685 <citerefentry><refentrytitle>prctl</refentrytitle><manvolnum>2</manvolnum></citerefentry> for more
686 information. Note that in contrast to most other time span definitions this parameter takes an integer value in
687 nano-seconds if no unit is specified. The usual time units are understood too.</para></listitem>
688 </varlistentry>
689
690 <varlistentry>
691 <term><varname>Personality=</varname></term>
692
693 <listitem><para>Controls which kernel architecture <citerefentry
694 project='man-pages'><refentrytitle>uname</refentrytitle><manvolnum>2</manvolnum></citerefentry> shall report,
695 when invoked by unit processes. Takes one of the architecture identifiers <constant>x86</constant>,
696 <constant>x86-64</constant>, <constant>ppc</constant>, <constant>ppc-le</constant>, <constant>ppc64</constant>,
697 <constant>ppc64-le</constant>, <constant>s390</constant> or <constant>s390x</constant>. Which personality
698 architectures are supported depends on the system architecture. Usually the 64bit versions of the various
699 system architectures support their immediate 32bit personality architecture counterpart, but no others. For
700 example, <constant>x86-64</constant> systems support the <constant>x86-64</constant> and
701 <constant>x86</constant> personalities but no others. The personality feature is useful when running 32-bit
702 services on a 64-bit host system. If not specified, the personality is left unmodified and thus reflects the
703 personality of the host system's kernel.</para></listitem>
704 </varlistentry>
705
706 <varlistentry>
707 <term><varname>IgnoreSIGPIPE=</varname></term>
708
709 <listitem><para>Takes a boolean argument. If true, causes <constant>SIGPIPE</constant> to be ignored in the
710 executed process. Defaults to true because <constant>SIGPIPE</constant> generally is useful only in shell
711 pipelines.</para></listitem>
712 </varlistentry>
713
714 </variablelist>
715 </refsect1>
716
717 <refsect1>
718 <title>Scheduling</title>
719
e0e2ecd5 720 <variablelist class='unit-directives'>
b8afec21
LP
721
722 <varlistentry>
723 <term><varname>Nice=</varname></term>
724
725 <listitem><para>Sets the default nice level (scheduling priority) for executed processes. Takes an integer
726 between -20 (highest priority) and 19 (lowest priority). See
727 <citerefentry><refentrytitle>setpriority</refentrytitle><manvolnum>2</manvolnum></citerefentry> for
728 details.</para></listitem>
729 </varlistentry>
730
731 <varlistentry>
732 <term><varname>CPUSchedulingPolicy=</varname></term>
733
734 <listitem><para>Sets the CPU scheduling policy for executed processes. Takes one of <option>other</option>,
735 <option>batch</option>, <option>idle</option>, <option>fifo</option> or <option>rr</option>. See
736 <citerefentry><refentrytitle>sched_setscheduler</refentrytitle><manvolnum>2</manvolnum></citerefentry> for
737 details.</para></listitem>
738 </varlistentry>
739
740 <varlistentry>
741 <term><varname>CPUSchedulingPriority=</varname></term>
742
743 <listitem><para>Sets the CPU scheduling priority for executed processes. The available priority range depends
744 on the selected CPU scheduling policy (see above). For real-time scheduling policies an integer between 1
745 (lowest priority) and 99 (highest priority) can be used. See
746 <citerefentry><refentrytitle>sched_setscheduler</refentrytitle><manvolnum>2</manvolnum></citerefentry> for
747 details. </para></listitem>
748 </varlistentry>
749
750 <varlistentry>
751 <term><varname>CPUSchedulingResetOnFork=</varname></term>
752
753 <listitem><para>Takes a boolean argument. If true, elevated CPU scheduling priorities and policies will be
754 reset when the executed processes fork, and can hence not leak into child processes. See
755 <citerefentry><refentrytitle>sched_setscheduler</refentrytitle><manvolnum>2</manvolnum></citerefentry> for
756 details. Defaults to false.</para></listitem>
757 </varlistentry>
758
759 <varlistentry>
760 <term><varname>CPUAffinity=</varname></term>
761
762 <listitem><para>Controls the CPU affinity of the executed processes. Takes a list of CPU indices or ranges
763 separated by either whitespace or commas. CPU ranges are specified by the lower and upper CPU indices separated
61fbbac1 764 by a dash. This option may be specified more than once, in which case the specified CPU affinity masks are
b8afec21
LP
765 merged. If the empty string is assigned, the mask is reset, all assignments prior to this will have no
766 effect. See
767 <citerefentry><refentrytitle>sched_setaffinity</refentrytitle><manvolnum>2</manvolnum></citerefentry> for
768 details.</para></listitem>
769 </varlistentry>
770
b070c7c0
MS
771 <varlistentry>
772 <term><varname>NUMAPolicy=</varname></term>
773
774 <listitem><para>Controls the NUMA memory policy of the executed processes. Takes a policy type, one of:
775 <option>default</option>, <option>preferred</option>, <option>bind</option>, <option>interleave</option> and
776 <option>local</option>. A list of NUMA nodes that should be associated with the policy must be specified
777 in <varname>NUMAMask=</varname>. For more details on each policy please see,
778 <citerefentry><refentrytitle>set_mempolicy</refentrytitle><manvolnum>2</manvolnum></citerefentry>. For overall
779 overview of NUMA support in Linux see,
780 <citerefentry><refentrytitle>numa</refentrytitle><manvolnum>7</manvolnum></citerefentry>
781 </para></listitem>
782 </varlistentry>
783
784 <varlistentry>
785 <term><varname>NUMAMask=</varname></term>
786
787 <listitem><para>Controls the NUMA node list which will be applied alongside with selected NUMA policy.
788 Takes a list of NUMA nodes and has the same syntax as a list of CPUs for <varname>CPUAffinity=</varname>
789 option. Note that the list of NUMA nodes is not required for <option>default</option> and <option>local</option>
790 policies and for <option>preferred</option> policy we expect a single NUMA node.</para></listitem>
791 </varlistentry>
792
b8afec21
LP
793 <varlistentry>
794 <term><varname>IOSchedulingClass=</varname></term>
795
796 <listitem><para>Sets the I/O scheduling class for executed processes. Takes an integer between 0 and 3 or one
797 of the strings <option>none</option>, <option>realtime</option>, <option>best-effort</option> or
617d253a
YW
798 <option>idle</option>. If the empty string is assigned to this option, all prior assignments to both
799 <varname>IOSchedulingClass=</varname> and <varname>IOSchedulingPriority=</varname> have no effect. See
b8afec21
LP
800 <citerefentry><refentrytitle>ioprio_set</refentrytitle><manvolnum>2</manvolnum></citerefentry> for
801 details.</para></listitem>
802 </varlistentry>
803
804 <varlistentry>
805 <term><varname>IOSchedulingPriority=</varname></term>
806
807 <listitem><para>Sets the I/O scheduling priority for executed processes. Takes an integer between 0 (highest
808 priority) and 7 (lowest priority). The available priorities depend on the selected I/O scheduling class (see
617d253a
YW
809 above). If the empty string is assigned to this option, all prior assignments to both
810 <varname>IOSchedulingClass=</varname> and <varname>IOSchedulingPriority=</varname> have no effect.
811 See <citerefentry><refentrytitle>ioprio_set</refentrytitle><manvolnum>2</manvolnum></citerefentry> for
b8afec21
LP
812 details.</para></listitem>
813 </varlistentry>
814
815 </variablelist>
816 </refsect1>
817
b8afec21
LP
818 <refsect1>
819 <title>Sandboxing</title>
820
2d2224e4
LP
821 <para>The following sandboxing options are an effective way to limit the exposure of the system towards the unit's
822 processes. It is recommended to turn on as many of these options for each unit as is possible without negatively
823 affecting the process' ability to operate. Note that many of these sandboxing features are gracefully turned off on
824 systems where the underlying security mechanism is not available. For example, <varname>ProtectSystem=</varname>
825 has no effect if the kernel is built without file system namespacing or if the service manager runs in a container
826 manager that makes file system namespacing unavailable to its payload. Similar,
827 <varname>RestrictRealtime=</varname> has no effect on systems that lack support for SECCOMP system call filtering,
828 or in containers where support for this is turned off.</para>
829
d287820d
LP
830 <para>Also note that some sandboxing functionality is generally not available in user services (i.e. services run
831 by the per-user service manager). Specifically, the various settings requiring file system namespacing support
832 (such as <varname>ProtectSystem=</varname>) are not available, as the underlying kernel functionality is only
5749f855
AZ
833 accessible to privileged processes. However, most namespacing settings, that will not work on their own in user
834 services, will work when used in conjunction with <varname>PrivateUsers=</varname><option>true</option>.</para>
d287820d 835
e0e2ecd5 836 <variablelist class='unit-directives'>
b8afec21
LP
837
838 <varlistentry>
839 <term><varname>ProtectSystem=</varname></term>
840
841 <listitem><para>Takes a boolean argument or the special values <literal>full</literal> or
842 <literal>strict</literal>. If true, mounts the <filename>/usr</filename> and <filename>/boot</filename>
843 directories read-only for processes invoked by this unit. If set to <literal>full</literal>, the
844 <filename>/etc</filename> directory is mounted read-only, too. If set to <literal>strict</literal> the entire
845 file system hierarchy is mounted read-only, except for the API file system subtrees <filename>/dev</filename>,
846 <filename>/proc</filename> and <filename>/sys</filename> (protect these directories using
847 <varname>PrivateDevices=</varname>, <varname>ProtectKernelTunables=</varname>,
848 <varname>ProtectControlGroups=</varname>). This setting ensures that any modification of the vendor-supplied
849 operating system (and optionally its configuration, and local mounts) is prohibited for the service. It is
850 recommended to enable this setting for all long-running services, unless they are involved with system updates
851 or need to modify the operating system in other ways. If this option is used,
852 <varname>ReadWritePaths=</varname> may be used to exclude specific directories from being made read-only. This
0e18724e
LP
853 setting is implied if <varname>DynamicUser=</varname> is set. This setting cannot ensure protection in all
854 cases. In general it has the same limitations as <varname>ReadOnlyPaths=</varname>, see below. Defaults to
855 off.</para></listitem>
b8afec21
LP
856 </varlistentry>
857
858 <varlistentry>
859 <term><varname>ProtectHome=</varname></term>
860
e4da7d8c 861 <listitem><para>Takes a boolean argument or the special values <literal>read-only</literal> or
db8d154d
ZJS
862 <literal>tmpfs</literal>. If true, the directories <filename>/home</filename>,
863 <filename>/root</filename>, and <filename>/run/user</filename> are made inaccessible and empty for
864 processes invoked by this unit. If set to <literal>read-only</literal>, the three directories are
865 made read-only instead. If set to <literal>tmpfs</literal>, temporary file systems are mounted on the
866 three directories in read-only mode. The value <literal>tmpfs</literal> is useful to hide home
867 directories not relevant to the processes invoked by the unit, while still allowing necessary
868 directories to be made visible when listed in <varname>BindPaths=</varname> or
869 <varname>BindReadOnlyPaths=</varname>.</para>
e4da7d8c
YW
870
871 <para>Setting this to <literal>yes</literal> is mostly equivalent to set the three directories in
1b2ad5d9 872 <varname>InaccessiblePaths=</varname>. Similarly, <literal>read-only</literal> is mostly equivalent to
e4da7d8c 873 <varname>ReadOnlyPaths=</varname>, and <literal>tmpfs</literal> is mostly equivalent to
db8d154d 874 <varname>TemporaryFileSystem=</varname> with <literal>:ro</literal>.</para>
e4da7d8c 875
db8d154d
ZJS
876 <para>It is recommended to enable this setting for all long-running services (in particular
877 network-facing ones), to ensure they cannot get access to private user data, unless the services
878 actually require access to the user's private data. This setting is implied if
879 <varname>DynamicUser=</varname> is set. This setting cannot ensure protection in all cases. In
880 general it has the same limitations as <varname>ReadOnlyPaths=</varname>, see below.</para>
c4d4b5a7
LP
881
882 <xi:include href="system-only.xml" xpointer="singular"/></listitem>
b8afec21
LP
883 </varlistentry>
884
885 <varlistentry>
886 <term><varname>RuntimeDirectory=</varname></term>
887 <term><varname>StateDirectory=</varname></term>
888 <term><varname>CacheDirectory=</varname></term>
889 <term><varname>LogsDirectory=</varname></term>
890 <term><varname>ConfigurationDirectory=</varname></term>
891
892 <listitem><para>These options take a whitespace-separated list of directory names. The specified directory
d3c8afd0 893 names must be relative, and may not include <literal>..</literal>. If set, one or more
8d00da49 894 directories by the specified names will be created (including their parents) below the locations
d491e65e 895 defined in the following table, when the unit is started. Also, the corresponding environment variable
35f2c0ba 896 is defined with the full path of directories. If multiple directories are set, then in the environment variable
d491e65e 897 the paths are concatenated with colon (<literal>:</literal>).</para>
8d00da49 898 <table>
d491e65e
YW
899 <title>Automatic directory creation and environment variables</title>
900 <tgroup cols='4'>
8d00da49
BV
901 <thead>
902 <row>
8601482c
LP
903 <entry>Directory</entry>
904 <entry>Below path for system units</entry>
905 <entry>Below path for user units</entry>
906 <entry>Environment variable set</entry>
8d00da49
BV
907 </row>
908 </thead>
909 <tbody>
910 <row>
911 <entry><varname>RuntimeDirectory=</varname></entry>
8601482c 912 <entry><filename>/run/</filename></entry>
8d00da49 913 <entry><varname>$XDG_RUNTIME_DIR</varname></entry>
d491e65e 914 <entry><varname>$RUNTIME_DIRECTORY</varname></entry>
8d00da49
BV
915 </row>
916 <row>
917 <entry><varname>StateDirectory=</varname></entry>
8601482c 918 <entry><filename>/var/lib/</filename></entry>
8d00da49 919 <entry><varname>$XDG_CONFIG_HOME</varname></entry>
d491e65e 920 <entry><varname>$STATE_DIRECTORY</varname></entry>
8d00da49
BV
921 </row>
922 <row>
923 <entry><varname>CacheDirectory=</varname></entry>
8601482c 924 <entry><filename>/var/cache/</filename></entry>
8d00da49 925 <entry><varname>$XDG_CACHE_HOME</varname></entry>
d491e65e 926 <entry><varname>$CACHE_DIRECTORY</varname></entry>
8d00da49
BV
927 </row>
928 <row>
929 <entry><varname>LogsDirectory=</varname></entry>
8601482c
LP
930 <entry><filename>/var/log/</filename></entry>
931 <entry><varname>$XDG_CONFIG_HOME</varname><filename>/log/</filename></entry>
d491e65e 932 <entry><varname>$LOGS_DIRECTORY</varname></entry>
8d00da49
BV
933 </row>
934 <row>
935 <entry><varname>ConfigurationDirectory=</varname></entry>
8601482c 936 <entry><filename>/etc/</filename></entry>
8d00da49 937 <entry><varname>$XDG_CONFIG_HOME</varname></entry>
d491e65e 938 <entry><varname>$CONFIGURATION_DIRECTORY</varname></entry>
8d00da49
BV
939 </row>
940 </tbody>
941 </tgroup>
942 </table>
f86fae61 943
6d463b8a
LP
944 <para>In case of <varname>RuntimeDirectory=</varname> the innermost subdirectories are removed when
945 the unit is stopped. It is possible to preserve the specified directories in this case if
946 <varname>RuntimeDirectoryPreserve=</varname> is configured to <option>restart</option> or
947 <option>yes</option> (see below). The directories specified with <varname>StateDirectory=</varname>,
b8afec21
LP
948 <varname>CacheDirectory=</varname>, <varname>LogsDirectory=</varname>,
949 <varname>ConfigurationDirectory=</varname> are not removed when the unit is stopped.</para>
950
951 <para>Except in case of <varname>ConfigurationDirectory=</varname>, the innermost specified directories will be
952 owned by the user and group specified in <varname>User=</varname> and <varname>Group=</varname>. If the
953 specified directories already exist and their owning user or group do not match the configured ones, all files
954 and directories below the specified directories as well as the directories themselves will have their file
955 ownership recursively changed to match what is configured. As an optimization, if the specified directories are
956 already owned by the right user and group, files and directories below of them are left as-is, even if they do
957 not match what is requested. The innermost specified directories will have their access mode adjusted to the
958 what is specified in <varname>RuntimeDirectoryMode=</varname>, <varname>StateDirectoryMode=</varname>,
959 <varname>CacheDirectoryMode=</varname>, <varname>LogsDirectoryMode=</varname> and
960 <varname>ConfigurationDirectoryMode=</varname>.</para>
5aaeeffb 961
b8afec21
LP
962 <para>These options imply <varname>BindPaths=</varname> for the specified paths. When combined with
963 <varname>RootDirectory=</varname> or <varname>RootImage=</varname> these paths always reside on the host and
964 are mounted from there into the unit's file system namespace.</para>
798d3a52 965
b8afec21
LP
966 <para>If <varname>DynamicUser=</varname> is used in conjunction with <varname>StateDirectory=</varname>,
967 <varname>CacheDirectory=</varname> and <varname>LogsDirectory=</varname> is slightly altered: the directories
968 are created below <filename>/var/lib/private</filename>, <filename>/var/cache/private</filename> and
969 <filename>/var/log/private</filename>, respectively, which are host directories made inaccessible to
970 unprivileged users, which ensures that access to these directories cannot be gained through dynamic user ID
971 recycling. Symbolic links are created to hide this difference in behaviour. Both from perspective of the host
972 and from inside the unit, the relevant directories hence always appear directly below
973 <filename>/var/lib</filename>, <filename>/var/cache</filename> and <filename>/var/log</filename>.</para>
798d3a52 974
b8afec21
LP
975 <para>Use <varname>RuntimeDirectory=</varname> to manage one or more runtime directories for the unit and bind
976 their lifetime to the daemon runtime. This is particularly useful for unprivileged daemons that cannot create
977 runtime directories in <filename>/run</filename> due to lack of privileges, and to make sure the runtime
978 directory is cleaned up automatically after use. For runtime directories that require more complex or different
979 configuration or lifetime guarantees, please consider using
980 <citerefentry><refentrytitle>tmpfiles.d</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para>
de7070b4 981
a9a50bd6
PW
982 <para>The directories defined by these options are always created under the standard paths used by systemd
983 (<filename>/var</filename>, <filename>/run</filename>, <filename>/etc</filename>, …). If the service needs
984 directories in a different location, a different mechanism has to be used to create them.</para>
985
986 <para><citerefentry><refentrytitle>tmpfiles.d</refentrytitle><manvolnum>5</manvolnum></citerefentry> provides
987 functionality that overlaps with these options. Using these options is recommended, because the lifetime of
988 the directories is tied directly to the lifetime of the unit, and it is not necessary to ensure that the
989 <filename>tmpfiles.d</filename> configuration is executed before the unit is started.</para>
990
8c8208cb
LP
991 <para>To remove any of the directories created by these settings, use the <command>systemctl clean
992 …</command> command on the relevant units, see
993 <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry> for
994 details.</para>
995
b8afec21
LP
996 <para>Example: if a system service unit has the following,
997 <programlisting>RuntimeDirectory=foo/bar baz</programlisting>
998 the service manager creates <filename>/run/foo</filename> (if it does not exist),
f8b68539
ZJS
999
1000 <filename index='false'>/run/foo/bar</filename>, and <filename index='false'>/run/baz</filename>. The
1001 directories <filename index='false'>/run/foo/bar</filename> and
1002 <filename index='false'>/run/baz</filename> except <filename index='false'>/run/foo</filename> are
b8afec21 1003 owned by the user and group specified in <varname>User=</varname> and <varname>Group=</varname>, and removed
d491e65e
YW
1004 when the service is stopped.</para>
1005
1006 <para>Example: if a system service unit has the following,
1007 <programlisting>RuntimeDirectory=foo/bar
1008StateDirectory=aaa/bbb ccc</programlisting>
1009 then the environment variable <literal>RUNTIME_DIRECTORY</literal> is set with <literal>/run/foo/bar</literal>, and
1010 <literal>STATE_DIRECTORY</literal> is set with <literal>/var/lib/aaa/bbb:/var/lib/ccc</literal>.</para></listitem>
798d3a52
ZJS
1011 </varlistentry>
1012
ece87975 1013 <varlistentry>
b8afec21
LP
1014 <term><varname>RuntimeDirectoryMode=</varname></term>
1015 <term><varname>StateDirectoryMode=</varname></term>
1016 <term><varname>CacheDirectoryMode=</varname></term>
1017 <term><varname>LogsDirectoryMode=</varname></term>
1018 <term><varname>ConfigurationDirectoryMode=</varname></term>
ece87975 1019
b8afec21
LP
1020 <listitem><para>Specifies the access mode of the directories specified in <varname>RuntimeDirectory=</varname>,
1021 <varname>StateDirectory=</varname>, <varname>CacheDirectory=</varname>, <varname>LogsDirectory=</varname>, or
1022 <varname>ConfigurationDirectory=</varname>, respectively, as an octal number. Defaults to
1023 <constant>0755</constant>. See "Permissions" in <citerefentry
1024 project='man-pages'><refentrytitle>path_resolution</refentrytitle><manvolnum>7</manvolnum></citerefentry> for a
1025 discussion of the meaning of permission bits.</para></listitem>
ece87975
IP
1026 </varlistentry>
1027
798d3a52 1028 <varlistentry>
b8afec21
LP
1029 <term><varname>RuntimeDirectoryPreserve=</varname></term>
1030
1031 <listitem><para>Takes a boolean argument or <option>restart</option>. If set to <option>no</option> (the
1032 default), the directories specified in <varname>RuntimeDirectory=</varname> are always removed when the service
1033 stops. If set to <option>restart</option> the directories are preserved when the service is both automatically
1034 and manually restarted. Here, the automatic restart means the operation specified in
1035 <varname>Restart=</varname>, and manual restart means the one triggered by <command>systemctl restart
1036 foo.service</command>. If set to <option>yes</option>, then the directories are not removed when the service is
1037 stopped. Note that since the runtime directory <filename>/run</filename> is a mount point of
1038 <literal>tmpfs</literal>, then for system services the directories specified in
1039 <varname>RuntimeDirectory=</varname> are removed when the system is rebooted.</para></listitem>
798d3a52
ZJS
1040 </varlistentry>
1041
bd9014c3
YW
1042 <varlistentry>
1043 <term><varname>TimeoutCleanSec=</varname></term>
1044 <listitem><para>Configures a timeout on the clean-up operation requested through <command>systemctl
1045 clean …</command>, see
1046 <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry> for
1047 details. Takes the usual time values and defaults to <constant>infinity</constant>, i.e. by default
1048 no time-out is applied. If a time-out is configured the clean operation will be aborted forcibly when
1049 the time-out is reached, potentially leaving resources on disk.</para></listitem>
1050 </varlistentry>
1051
798d3a52 1052 <varlistentry>
2a624c36
AP
1053 <term><varname>ReadWritePaths=</varname></term>
1054 <term><varname>ReadOnlyPaths=</varname></term>
1055 <term><varname>InaccessiblePaths=</varname></term>
798d3a52 1056
effbd6d2
LP
1057 <listitem><para>Sets up a new file system namespace for executed processes. These options may be used to limit
1058 access a process might have to the file system hierarchy. Each setting takes a space-separated list of paths
1059 relative to the host's root directory (i.e. the system running the service manager). Note that if paths
1060 contain symlinks, they are resolved relative to the root directory set with
915e6d16 1061 <varname>RootDirectory=</varname>/<varname>RootImage=</varname>.</para>
effbd6d2
LP
1062
1063 <para>Paths listed in <varname>ReadWritePaths=</varname> are accessible from within the namespace with the same
1064 access modes as from outside of it. Paths listed in <varname>ReadOnlyPaths=</varname> are accessible for
1065 reading only, writing will be refused even if the usual file access controls would permit this. Nest
1066 <varname>ReadWritePaths=</varname> inside of <varname>ReadOnlyPaths=</varname> in order to provide writable
1067 subdirectories within read-only directories. Use <varname>ReadWritePaths=</varname> in order to whitelist
e568a92d
YW
1068 specific paths for write access if <varname>ProtectSystem=strict</varname> is used.</para>
1069
1070 <para>Paths listed in <varname>InaccessiblePaths=</varname> will be made inaccessible for processes inside
1071 the namespace along with everything below them in the file system hierarchy. This may be more restrictive than
1072 desired, because it is not possible to nest <varname>ReadWritePaths=</varname>, <varname>ReadOnlyPaths=</varname>,
1073 <varname>BindPaths=</varname>, or <varname>BindReadOnlyPaths=</varname> inside it. For a more flexible option,
1074 see <varname>TemporaryFileSystem=</varname>.</para>
effbd6d2 1075
0e18724e 1076 <para>Non-directory paths may be specified as well. These options may be specified more than once,
effbd6d2
LP
1077 in which case all paths listed will have limited access from within the namespace. If the empty string is
1078 assigned to this option, the specific list is reset, and all prior assignments have no effect.</para>
1079
e778185b 1080 <para>Paths in <varname>ReadWritePaths=</varname>, <varname>ReadOnlyPaths=</varname> and
5327c910
LP
1081 <varname>InaccessiblePaths=</varname> may be prefixed with <literal>-</literal>, in which case they will be
1082 ignored when they do not exist. If prefixed with <literal>+</literal> the paths are taken relative to the root
915e6d16
LP
1083 directory of the unit, as configured with <varname>RootDirectory=</varname>/<varname>RootImage=</varname>,
1084 instead of relative to the root directory of the host (see above). When combining <literal>-</literal> and
1085 <literal>+</literal> on the same path make sure to specify <literal>-</literal> first, and <literal>+</literal>
1086 second.</para>
5327c910 1087
0e18724e
LP
1088 <para>Note that these settings will disconnect propagation of mounts from the unit's processes to the
1089 host. This means that this setting may not be used for services which shall be able to install mount points in
1090 the main mount namespace. For <varname>ReadWritePaths=</varname> and <varname>ReadOnlyPaths=</varname>
1091 propagation in the other direction is not affected, i.e. mounts created on the host generally appear in the
1092 unit processes' namespace, and mounts removed on the host also disappear there too. In particular, note that
1093 mount propagation from host to unit will result in unmodified mounts to be created in the unit's namespace,
1094 i.e. writable mounts appearing on the host will be writable in the unit's namespace too, even when propagated
1095 below a path marked with <varname>ReadOnlyPaths=</varname>! Restricting access with these options hence does
1096 not extend to submounts of a directory that are created later on. This means the lock-down offered by that
1097 setting is not complete, and does not offer full protection. </para>
1098
1099 <para>Note that the effect of these settings may be undone by privileged processes. In order to set up an
1100 effective sandboxed environment for a unit it is thus recommended to combine these settings with either
5327c910 1101 <varname>CapabilityBoundingSet=~CAP_SYS_ADMIN</varname> or
c4d4b5a7
LP
1102 <varname>SystemCallFilter=~@mount</varname>.</para>
1103
1104 <xi:include href="system-only.xml" xpointer="plural"/></listitem>
798d3a52
ZJS
1105 </varlistentry>
1106
c10b460b
YW
1107 <varlistentry>
1108 <term><varname>TemporaryFileSystem=</varname></term>
1109
1110 <listitem><para>Takes a space-separated list of mount points for temporary file systems (tmpfs). If set, a new file
1111 system namespace is set up for executed processes, and a temporary file system is mounted on each mount point.
1112 This option may be specified more than once, in which case temporary file systems are mounted on all listed mount
1113 points. If the empty string is assigned to this option, the list is reset, and all prior assignments have no effect.
1114 Each mount point may optionally be suffixed with a colon (<literal>:</literal>) and mount options such as
1115 <literal>size=10%</literal> or <literal>ro</literal>. By default, each temporary file system is mounted
1116 with <literal>nodev,strictatime,mode=0755</literal>. These can be disabled by explicitly specifying the corresponding
1117 mount options, e.g., <literal>dev</literal> or <literal>nostrictatime</literal>.</para>
1118
1119 <para>This is useful to hide files or directories not relevant to the processes invoked by the unit, while necessary
1120 files or directories can be still accessed by combining with <varname>BindPaths=</varname> or
db8d154d 1121 <varname>BindReadOnlyPaths=</varname>:</para>
c10b460b
YW
1122
1123 <para>Example: if a unit has the following,
1124 <programlisting>TemporaryFileSystem=/var:ro
1125BindReadOnlyPaths=/var/lib/systemd</programlisting>
1126 then the invoked processes by the unit cannot see any files or directories under <filename>/var</filename> except for
c4d4b5a7
LP
1127 <filename>/var/lib/systemd</filename> or its contents.</para>
1128
1129 <xi:include href="system-only.xml" xpointer="singular"/></listitem>
c10b460b
YW
1130 </varlistentry>
1131
798d3a52
ZJS
1132 <varlistentry>
1133 <term><varname>PrivateTmp=</varname></term>
1134
00d9ef85
LP
1135 <listitem><para>Takes a boolean argument. If true, sets up a new file system namespace for the executed
1136 processes and mounts private <filename>/tmp</filename> and <filename>/var/tmp</filename> directories inside it
1137 that is not shared by processes outside of the namespace. This is useful to secure access to temporary files of
1138 the process, but makes sharing between processes via <filename>/tmp</filename> or <filename>/var/tmp</filename>
1139 impossible. If this is enabled, all temporary files created by a service in these directories will be removed
1140 after the service is stopped. Defaults to false. It is possible to run two or more units within the same
1141 private <filename>/tmp</filename> and <filename>/var/tmp</filename> namespace by using the
798d3a52 1142 <varname>JoinsNamespaceOf=</varname> directive, see
00d9ef85 1143 <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry> for
effbd6d2
LP
1144 details. This setting is implied if <varname>DynamicUser=</varname> is set. For this setting the same
1145 restrictions regarding mount propagation and privileges apply as for <varname>ReadOnlyPaths=</varname> and
d71f0505
LP
1146 related calls, see above. Enabling this setting has the side effect of adding <varname>Requires=</varname> and
1147 <varname>After=</varname> dependencies on all mount units necessary to access <filename>/tmp</filename> and
1148 <filename>/var/tmp</filename>. Moreover an implicitly <varname>After=</varname> ordering on
1149 <citerefentry><refentrytitle>systemd-tmpfiles-setup.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
b0238568
ZJS
1150 is added.</para>
1151
b8afec21
LP
1152 <para>Note that the implementation of this setting might be impossible (for example if mount namespaces are not
1153 available), and the unit should be written in a way that does not solely rely on this setting for
c4d4b5a7
LP
1154 security.</para>
1155
1156 <xi:include href="system-only.xml" xpointer="singular"/></listitem>
798d3a52
ZJS
1157 </varlistentry>
1158
1159 <varlistentry>
1160 <term><varname>PrivateDevices=</varname></term>
1161
b0238568
ZJS
1162 <listitem><para>Takes a boolean argument. If true, sets up a new <filename>/dev</filename> mount for the
1163 executed processes and only adds API pseudo devices such as <filename>/dev/null</filename>,
b8afec21
LP
1164 <filename>/dev/zero</filename> or <filename>/dev/random</filename> (as well as the pseudo TTY subsystem) to it,
1165 but no physical devices such as <filename>/dev/sda</filename>, system memory <filename>/dev/mem</filename>,
1166 system ports <filename>/dev/port</filename> and others. This is useful to securely turn off physical device
1167 access by the executed process. Defaults to false. Enabling this option will install a system call filter to
1168 block low-level I/O system calls that are grouped in the <varname>@raw-io</varname> set, will also remove
1169 <constant>CAP_MKNOD</constant> and <constant>CAP_SYS_RAWIO</constant> from the capability bounding set for the
1170 unit (see above), and set <varname>DevicePolicy=closed</varname> (see
798d3a52 1171 <citerefentry><refentrytitle>systemd.resource-control</refentrytitle><manvolnum>5</manvolnum></citerefentry>
effbd6d2
LP
1172 for details). Note that using this setting will disconnect propagation of mounts from the service to the host
1173 (propagation in the opposite direction continues to work). This means that this setting may not be used for
b8afec21
LP
1174 services which shall be able to install mount points in the main mount namespace. The new
1175 <filename>/dev</filename> will be mounted read-only and 'noexec'. The latter may break old programs which try
1176 to set up executable memory by using
1177 <citerefentry><refentrytitle>mmap</refentrytitle><manvolnum>2</manvolnum></citerefentry> of
1178 <filename>/dev/zero</filename> instead of using <constant>MAP_ANON</constant>. For this setting the same
1179 restrictions regarding mount propagation and privileges apply as for <varname>ReadOnlyPaths=</varname> and
1180 related calls, see above. If turned on and if running in user mode, or in system mode, but without the
1181 <constant>CAP_SYS_ADMIN</constant> capability (e.g. setting <varname>User=</varname>),
1182 <varname>NoNewPrivileges=yes</varname> is implied.</para>
b0238568 1183
b8afec21
LP
1184 <para>Note that the implementation of this setting might be impossible (for example if mount namespaces are not
1185 available), and the unit should be written in a way that does not solely rely on this setting for
c4d4b5a7
LP
1186 security.</para>
1187
1188 <xi:include href="system-only.xml" xpointer="singular"/></listitem>
798d3a52
ZJS
1189 </varlistentry>
1190
1191 <varlistentry>
1192 <term><varname>PrivateNetwork=</varname></term>
1193
b8afec21
LP
1194 <listitem><para>Takes a boolean argument. If true, sets up a new network namespace for the executed processes
1195 and configures only the loopback network device <literal>lo</literal> inside it. No other network devices will
1196 be available to the executed process. This is useful to turn off network access by the executed process.
1197 Defaults to false. It is possible to run two or more units within the same private network namespace by using
1198 the <varname>JoinsNamespaceOf=</varname> directive, see
1199 <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry> for
9236cabf
LP
1200 details. Note that this option will disconnect all socket families from the host, including
1201 <constant>AF_NETLINK</constant> and <constant>AF_UNIX</constant>. Effectively, for
1202 <constant>AF_NETLINK</constant> this means that device configuration events received from
1203 <citerefentry><refentrytitle>systemd-udevd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry> are
1204 not delivered to the unit's processes. And for <constant>AF_UNIX</constant> this has the effect that
1205 <constant>AF_UNIX</constant> sockets in the abstract socket namespace of the host will become unavailable to
1206 the unit's processes (however, those located in the file system will continue to be accessible).</para>
b8afec21
LP
1207
1208 <para>Note that the implementation of this setting might be impossible (for example if network namespaces are
1209 not available), and the unit should be written in a way that does not solely rely on this setting for
4107452e
LP
1210 security.</para>
1211
1212 <para>When this option is used on a socket unit any sockets bound on behalf of this unit will be
1213 bound within a private network namespace. This may be combined with
1214 <varname>JoinsNamespaceOf=</varname> to listen on sockets inside of network namespaces of other
c4d4b5a7
LP
1215 services.</para>
1216
1217 <xi:include href="system-only.xml" xpointer="singular"/></listitem>
4107452e
LP
1218 </varlistentry>
1219
1220 <varlistentry>
1221 <term><varname>NetworkNamespacePath=</varname></term>
1222
1223 <listitem><para>Takes an absolute file system path refererring to a Linux network namespace
1224 pseudo-file (i.e. a file like <filename>/proc/$PID/ns/net</filename> or a bind mount or symlink to
1225 one). When set the invoked processes are added to the network namespace referenced by that path. The
1226 path has to point to a valid namespace file at the moment the processes are forked off. If this
1227 option is used <varname>PrivateNetwork=</varname> has no effect. If this option is used together with
1228 <varname>JoinsNamespaceOf=</varname> then it only has an effect if this unit is started before any of
1229 the listed units that have <varname>PrivateNetwork=</varname> or
1230 <varname>NetworkNamespacePath=</varname> configured, as otherwise the network namespace of those
1231 units is reused.</para>
1232
1233 <para>When this option is used on a socket unit any sockets bound on behalf of this unit will be
c4d4b5a7
LP
1234 bound within the specified network namespace.</para>
1235
1236 <xi:include href="system-only.xml" xpointer="singular"/></listitem>
798d3a52
ZJS
1237 </varlistentry>
1238
1239 <varlistentry>
d251207d
LP
1240 <term><varname>PrivateUsers=</varname></term>
1241
1242 <listitem><para>Takes a boolean argument. If true, sets up a new user namespace for the executed processes and
1243 configures a minimal user and group mapping, that maps the <literal>root</literal> user and group as well as
1244 the unit's own user and group to themselves and everything else to the <literal>nobody</literal> user and
1245 group. This is useful to securely detach the user and group databases used by the unit from the rest of the
1246 system, and thus to create an effective sandbox environment. All files, directories, processes, IPC objects and
2dd67817 1247 other resources owned by users/groups not equaling <literal>root</literal> or the unit's own will stay visible
d251207d
LP
1248 from within the unit but appear owned by the <literal>nobody</literal> user and group. If this mode is enabled,
1249 all unit processes are run without privileges in the host user namespace (regardless if the unit's own
1250 user/group is <literal>root</literal> or not). Specifically this means that the process will have zero process
1251 capabilities on the host's user namespace, but full capabilities within the service's user namespace. Settings
1252 such as <varname>CapabilityBoundingSet=</varname> will affect only the latter, and there's no way to acquire
1253 additional capabilities in the host's user namespace. Defaults to off.</para>
1254
5749f855
AZ
1255 <para>When this setting is set up by a per-user instance of the service manager, the mapping of the
1256 <literal>root</literal> user and group to itself is omitted (unless the user manager is root).
1257 Additionally, in the per-user instance manager case, the
1258 user namespace will be set up before most other namespaces. This means that combining
1259 <varname>PrivateUsers=</varname><option>true</option> with other namespaces will enable use of features not
1260 normally supported by the per-user instances of the service manager.</para>
1261
915e6d16
LP
1262 <para>This setting is particularly useful in conjunction with
1263 <varname>RootDirectory=</varname>/<varname>RootImage=</varname>, as the need to synchronize the user and group
1264 databases in the root directory and on the host is reduced, as the only users and groups who need to be matched
b0238568
ZJS
1265 are <literal>root</literal>, <literal>nobody</literal> and the unit's own user and group.</para>
1266
b8afec21
LP
1267 <para>Note that the implementation of this setting might be impossible (for example if user namespaces are not
1268 available), and the unit should be written in a way that does not solely rely on this setting for
5749f855 1269 security.</para></listitem>
d251207d
LP
1270 </varlistentry>
1271
aecd5ac6
TM
1272 <varlistentry>
1273 <term><varname>ProtectHostname=</varname></term>
1274
1275 <listitem><para>Takes a boolean argument. When set, sets up a new UTS namespace for the executed
1276 processes. In addition, changing hostname or domainname is prevented. Defaults to off.</para>
1277
8df87b43
LP
1278 <para>Note that the implementation of this setting might be impossible (for example if UTS namespaces
1279 are not available), and the unit should be written in a way that does not solely rely on this setting
1280 for security.</para>
1281
1282 <para>Note that when this option is enabled for a service hostname changes no longer propagate from
1283 the system into the service, it is hence not suitable for services that need to take notice of system
c4d4b5a7
LP
1284 hostname changes dynamically.</para>
1285
1286 <xi:include href="system-only.xml" xpointer="singular"/></listitem>
aecd5ac6
TM
1287 </varlistentry>
1288
59eeb84b
LP
1289 <varlistentry>
1290 <term><varname>ProtectKernelTunables=</varname></term>
1291
1292 <listitem><para>Takes a boolean argument. If true, kernel variables accessible through
49accde7
DH
1293 <filename>/proc/sys</filename>, <filename>/sys</filename>, <filename>/proc/sysrq-trigger</filename>,
1294 <filename>/proc/latency_stats</filename>, <filename>/proc/acpi</filename>,
1295 <filename>/proc/timer_stats</filename>, <filename>/proc/fs</filename> and <filename>/proc/irq</filename> will
525872bf
LP
1296 be made read-only to all processes of the unit. Usually, tunable kernel variables should be initialized only at
1297 boot-time, for example with the
1298 <citerefentry><refentrytitle>sysctl.d</refentrytitle><manvolnum>5</manvolnum></citerefentry> mechanism. Few
1299 services need to write to these at runtime; it is hence recommended to turn this on for most services. For this
1300 setting the same restrictions regarding mount propagation and privileges apply as for
1301 <varname>ReadOnlyPaths=</varname> and related calls, see above. Defaults to off. If turned on and if running
1302 in user mode, or in system mode, but without the <constant>CAP_SYS_ADMIN</constant> capability (e.g. services
1303 for which <varname>User=</varname> is set), <varname>NoNewPrivileges=yes</varname> is implied. Note that this
1304 option does not prevent indirect changes to kernel tunables effected by IPC calls to other processes. However,
1305 <varname>InaccessiblePaths=</varname> may be used to make relevant IPC file system objects inaccessible. If
1306 <varname>ProtectKernelTunables=</varname> is set, <varname>MountAPIVFS=yes</varname> is
c4d4b5a7
LP
1307 implied.</para>
1308
1309 <xi:include href="system-only.xml" xpointer="singular"/></listitem>
59eeb84b
LP
1310 </varlistentry>
1311
85265556
DH
1312 <varlistentry>
1313 <term><varname>ProtectKernelModules=</varname></term>
1314
1b2ad5d9
MB
1315 <listitem><para>Takes a boolean argument. If true, explicit module loading will be denied. This allows
1316 module load and unload operations to be turned off on modular kernels. It is recommended to turn this on for most services
bf2d3d7c 1317 that do not need special file systems or extra kernel modules to work. Defaults to off. Enabling this option
b8afec21
LP
1318 removes <constant>CAP_SYS_MODULE</constant> from the capability bounding set for the unit, and installs a
1319 system call filter to block module system calls, also <filename>/usr/lib/modules</filename> is made
1320 inaccessible. For this setting the same restrictions regarding mount propagation and privileges apply as for
1321 <varname>ReadOnlyPaths=</varname> and related calls, see above. Note that limited automatic module loading due
1322 to user configuration or kernel mapping tables might still happen as side effect of requested user operations,
85265556
DH
1323 both privileged and unprivileged. To disable module auto-load feature please see
1324 <citerefentry><refentrytitle>sysctl.d</refentrytitle><manvolnum>5</manvolnum></citerefentry>
1325 <constant>kernel.modules_disabled</constant> mechanism and
b8afec21
LP
1326 <filename>/proc/sys/kernel/modules_disabled</filename> documentation. If turned on and if running in user
1327 mode, or in system mode, but without the <constant>CAP_SYS_ADMIN</constant> capability (e.g. setting
c4d4b5a7
LP
1328 <varname>User=</varname>), <varname>NoNewPrivileges=yes</varname> is implied.</para>
1329
1330 <xi:include href="system-only.xml" xpointer="singular"/></listitem>
85265556
DH
1331 </varlistentry>
1332
d916e35b
KK
1333 <varlistentry>
1334 <term><varname>ProtectKernelLogs=</varname></term>
1335
1336 <listitem><para>Takes a boolean argument. If true, access to the kernel log ring buffer will be denied. It is
1337 recommended to turn this on for most services that do not need to read from or write to the kernel log ring
1338 buffer. Enabling this option removes <constant>CAP_SYSLOG</constant> from the capability bounding set for this
1339 unit, and installs a system call filter to block the
1340 <citerefentry project='man-pages'><refentrytitle>syslog</refentrytitle><manvolnum>2</manvolnum></citerefentry>
1341 system call (not to be confused with the libc API
1342 <citerefentry project='man-pages'><refentrytitle>syslog</refentrytitle><manvolnum>3</manvolnum></citerefentry>
1343 for userspace logging). The kernel exposes its log buffer to userspace via <filename>/dev/kmsg</filename> and
1344 <filename>/proc/kmsg</filename>. If enabled, these are made inaccessible to all the processes in the unit.</para>
1345
1346 <xi:include href="system-only.xml" xpointer="singular"/></listitem>
1347 </varlistentry>
1348
59eeb84b
LP
1349 <varlistentry>
1350 <term><varname>ProtectControlGroups=</varname></term>
1351
effbd6d2
LP
1352 <listitem><para>Takes a boolean argument. If true, the Linux Control Groups (<citerefentry
1353 project='man-pages'><refentrytitle>cgroups</refentrytitle><manvolnum>7</manvolnum></citerefentry>) hierarchies
1354 accessible through <filename>/sys/fs/cgroup</filename> will be made read-only to all processes of the
1355 unit. Except for container managers no services should require write access to the control groups hierarchies;
1356 it is hence recommended to turn this on for most services. For this setting the same restrictions regarding
1357 mount propagation and privileges apply as for <varname>ReadOnlyPaths=</varname> and related calls, see
b8afec21 1358 above. Defaults to off. If <varname>ProtectControlGroups=</varname> is set, <varname>MountAPIVFS=yes</varname>
c4d4b5a7
LP
1359 is implied.</para>
1360
1361 <xi:include href="system-only.xml" xpointer="singular"/></listitem>
798d3a52
ZJS
1362 </varlistentry>
1363
1364 <varlistentry>
b8afec21 1365 <term><varname>RestrictAddressFamilies=</varname></term>
798d3a52 1366
b8afec21
LP
1367 <listitem><para>Restricts the set of socket address families accessible to the processes of this unit. Takes a
1368 space-separated list of address family names to whitelist, such as <constant>AF_UNIX</constant>,
1369 <constant>AF_INET</constant> or <constant>AF_INET6</constant>. When prefixed with <constant>~</constant> the
1370 listed address families will be applied as blacklist, otherwise as whitelist. Note that this restricts access
1371 to the <citerefentry
1372 project='man-pages'><refentrytitle>socket</refentrytitle><manvolnum>2</manvolnum></citerefentry> system call
1373 only. Sockets passed into the process by other means (for example, by using socket activation with socket
1374 units, see <citerefentry><refentrytitle>systemd.socket</refentrytitle><manvolnum>5</manvolnum></citerefentry>)
1375 are unaffected. Also, sockets created with <function>socketpair()</function> (which creates connected AF_UNIX
1376 sockets only) are unaffected. Note that this option has no effect on 32-bit x86, s390, s390x, mips, mips-le,
1377 ppc, ppc-le, pcc64, ppc64-le and is ignored (but works correctly on other ABIs, including x86-64). Note that on
1378 systems supporting multiple ABIs (such as x86/x86-64) it is recommended to turn off alternative ABIs for
1379 services, so that they cannot be used to circumvent the restrictions of this option. Specifically, it is
1380 recommended to combine this option with <varname>SystemCallArchitectures=native</varname> or similar. If
1381 running in user mode, or in system mode, but without the <constant>CAP_SYS_ADMIN</constant> capability
1382 (e.g. setting <varname>User=nobody</varname>), <varname>NoNewPrivileges=yes</varname> is implied. By default,
1383 no restrictions apply, all address families are accessible to processes. If assigned the empty string, any
5238e957 1384 previous address family restriction changes are undone. This setting does not affect commands prefixed with
b8afec21
LP
1385 <literal>+</literal>.</para>
1386
1387 <para>Use this option to limit exposure of processes to remote access, in particular via exotic and sensitive
1388 network protocols, such as <constant>AF_PACKET</constant>. Note that in most cases, the local
1389 <constant>AF_UNIX</constant> address family should be included in the configured whitelist as it is frequently
1390 used for local communication, including for
1391 <citerefentry><refentrytitle>syslog</refentrytitle><manvolnum>2</manvolnum></citerefentry>
1392 logging.</para></listitem>
798d3a52
ZJS
1393 </varlistentry>
1394
1395 <varlistentry>
b8afec21 1396 <term><varname>RestrictNamespaces=</varname></term>
798d3a52 1397
b8afec21
LP
1398 <listitem><para>Restricts access to Linux namespace functionality for the processes of this unit. For details
1399 about Linux namespaces, see <citerefentry
1400 project='man-pages'><refentrytitle>namespaces</refentrytitle><manvolnum>7</manvolnum></citerefentry>. Either
1401 takes a boolean argument, or a space-separated list of namespace type identifiers. If false (the default), no
1402 restrictions on namespace creation and switching are made. If true, access to any kind of namespacing is
1403 prohibited. Otherwise, a space-separated list of namespace type identifiers must be specified, consisting of
1404 any combination of: <constant>cgroup</constant>, <constant>ipc</constant>, <constant>net</constant>,
1405 <constant>mnt</constant>, <constant>pid</constant>, <constant>user</constant> and <constant>uts</constant>. Any
1406 namespace type listed is made accessible to the unit's processes, access to namespace types not listed is
1407 prohibited (whitelisting). By prepending the list with a single tilde character (<literal>~</literal>) the
1408 effect may be inverted: only the listed namespace types will be made inaccessible, all unlisted ones are
1409 permitted (blacklisting). If the empty string is assigned, the default namespace restrictions are applied,
53255e53
YW
1410 which is equivalent to false. This option may appear more than once, in which case the namespace types are
1411 merged by <constant>OR</constant>, or by <constant>AND</constant> if the lines are prefixed with
1412 <literal>~</literal> (see examples below). Internally, this setting limits access to the
b8afec21
LP
1413 <citerefentry><refentrytitle>unshare</refentrytitle><manvolnum>2</manvolnum></citerefentry>,
1414 <citerefentry><refentrytitle>clone</refentrytitle><manvolnum>2</manvolnum></citerefentry> and
1415 <citerefentry><refentrytitle>setns</refentrytitle><manvolnum>2</manvolnum></citerefentry> system calls, taking
1416 the specified flags parameters into account. Note that — if this option is used — in addition to restricting
1417 creation and switching of the specified types of namespaces (or all of them, if true) access to the
1418 <function>setns()</function> system call with a zero flags parameter is prohibited. This setting is only
1419 supported on x86, x86-64, mips, mips-le, mips64, mips64-le, mips64-n32, mips64-le-n32, ppc64, ppc64-le, s390
1420 and s390x, and enforces no restrictions on other architectures. If running in user mode, or in system mode, but
1421 without the <constant>CAP_SYS_ADMIN</constant> capability (e.g. setting <varname>User=</varname>),
53255e53
YW
1422 <varname>NoNewPrivileges=yes</varname> is implied.</para>
1423
1424 <para>Example: if a unit has the following,
1425 <programlisting>RestrictNamespaces=cgroup ipc
1426RestrictNamespaces=cgroup net</programlisting>
1427 then <constant>cgroup</constant>, <constant>ipc</constant>, and <constant>net</constant> are set.
1428 If the second line is prefixed with <literal>~</literal>, e.g.,
1429 <programlisting>RestrictNamespaces=cgroup ipc
1430RestrictNamespaces=~cgroup net</programlisting>
1431 then, only <constant>ipc</constant> is set.</para></listitem>
798d3a52
ZJS
1432 </varlistentry>
1433
023a4f67 1434 <varlistentry>
b8afec21 1435 <term><varname>LockPersonality=</varname></term>
023a4f67 1436
b8afec21
LP
1437 <listitem><para>Takes a boolean argument. If set, locks down the <citerefentry
1438 project='man-pages'><refentrytitle>personality</refentrytitle><manvolnum>2</manvolnum></citerefentry> system
1439 call so that the kernel execution domain may not be changed from the default or the personality selected with
1440 <varname>Personality=</varname> directive. This may be useful to improve security, because odd personality
1441 emulations may be poorly tested and source of vulnerabilities. If running in user mode, or in system mode, but
1442 without the <constant>CAP_SYS_ADMIN</constant> capability (e.g. setting <varname>User=</varname>),
1443 <varname>NoNewPrivileges=yes</varname> is implied.</para></listitem>
023a4f67
LP
1444 </varlistentry>
1445
798d3a52 1446 <varlistentry>
b8afec21 1447 <term><varname>MemoryDenyWriteExecute=</varname></term>
798d3a52 1448
b8afec21
LP
1449 <listitem><para>Takes a boolean argument. If set, attempts to create memory mappings that are writable and
1450 executable at the same time, or to change existing memory mappings to become executable, or mapping shared
1451 memory segments as executable are prohibited. Specifically, a system call filter is added that rejects
1452 <citerefentry><refentrytitle>mmap</refentrytitle><manvolnum>2</manvolnum></citerefentry> system calls with both
1453 <constant>PROT_EXEC</constant> and <constant>PROT_WRITE</constant> set,
1454 <citerefentry><refentrytitle>mprotect</refentrytitle><manvolnum>2</manvolnum></citerefentry> or
1455 <citerefentry><refentrytitle>pkey_mprotect</refentrytitle><manvolnum>2</manvolnum></citerefentry> system calls
1456 with <constant>PROT_EXEC</constant> set and
1457 <citerefentry><refentrytitle>shmat</refentrytitle><manvolnum>2</manvolnum></citerefentry> system calls with
1458 <constant>SHM_EXEC</constant> set. Note that this option is incompatible with programs and libraries that
1459 generate program code dynamically at runtime, including JIT execution engines, executable stacks, and code
1460 "trampoline" feature of various C compilers. This option improves service security, as it makes harder for
10d44e72
TM
1461 software exploits to change running code dynamically. However, the protection can be circumvented, if
1462 the service can write to a filesystem, which is not mounted with <constant>noexec</constant> (such as
1463 <filename>/dev/shm</filename>), or it can use <function>memfd_create()</function>. This can be
1464 prevented by making such file systems inaccessible to the service
1465 (e.g. <varname>InaccessiblePaths=/dev/shm</varname>) and installing further system call filters
1466 (<varname>SystemCallFilter=~memfd_create</varname>). Note that this feature is fully available on
1467 x86-64, and partially on x86. Specifically, the <function>shmat()</function> protection is not
1468 available on x86. Note that on systems supporting multiple ABIs (such as x86/x86-64) it is
1469 recommended to turn off alternative ABIs for services, so that they cannot be used to circumvent the
1470 restrictions of this option. Specifically, it is recommended to combine this option with
1471 <varname>SystemCallArchitectures=native</varname> or similar. If running in user mode, or in system
1472 mode, but without the <constant>CAP_SYS_ADMIN</constant> capability (e.g. setting
1473 <varname>User=</varname>), <varname>NoNewPrivileges=yes</varname> is implied.</para></listitem>
798d3a52
ZJS
1474 </varlistentry>
1475
1476 <varlistentry>
b8afec21 1477 <term><varname>RestrictRealtime=</varname></term>
798d3a52 1478
b8afec21
LP
1479 <listitem><para>Takes a boolean argument. If set, any attempts to enable realtime scheduling in a process of
1480 the unit are refused. This restricts access to realtime task scheduling policies such as
1481 <constant>SCHED_FIFO</constant>, <constant>SCHED_RR</constant> or <constant>SCHED_DEADLINE</constant>. See
1482 <citerefentry project='man-pages'><refentrytitle>sched</refentrytitle><manvolnum>7</manvolnum></citerefentry>
1483 for details about these scheduling policies. If running in user mode, or in system mode, but without the
1484 <constant>CAP_SYS_ADMIN</constant> capability (e.g. setting <varname>User=</varname>),
1485 <varname>NoNewPrivileges=yes</varname> is implied. Realtime scheduling policies may be used to monopolize CPU
1486 time for longer periods of time, and may hence be used to lock up or otherwise trigger Denial-of-Service
1487 situations on the system. It is hence recommended to restrict access to realtime scheduling to the few programs
1488 that actually require them. Defaults to off.</para></listitem>
798d3a52
ZJS
1489 </varlistentry>
1490
7445db6e
LP
1491 <varlistentry>
1492 <term><varname>RestrictSUIDSGID=</varname></term>
1493
1494 <listitem><para>Takes a boolean argument. If set, any attempts to set the set-user-ID (SUID) or
1495 set-group-ID (SGID) bits on files or directories will be denied (for details on these bits see
1496 <citerefentry
1497 project='man-pages'><refentrytitle>inode</refentrytitle><manvolnum>7</manvolnum></citerefentry>). If
1498 running in user mode, or in system mode, but without the <constant>CAP_SYS_ADMIN</constant>
1499 capability (e.g. setting <varname>User=</varname>), <varname>NoNewPrivileges=yes</varname> is
1500 implied. As the SUID/SGID bits are mechanisms to elevate privileges, and allows users to acquire the
1501 identity of other users, it is recommended to restrict creation of SUID/SGID files to the few
1502 programs that actually require them. Note that this restricts marking of any type of file system
1503 object with these bits, including both regular files and directories (where the SGID is a different
bf65b7e0
LP
1504 meaning than for files, see documentation). This option is implied if <varname>DynamicUser=</varname>
1505 is enabled. Defaults to off.</para></listitem>
7445db6e
LP
1506 </varlistentry>
1507
798d3a52 1508 <varlistentry>
b8afec21 1509 <term><varname>RemoveIPC=</varname></term>
798d3a52 1510
b8afec21
LP
1511 <listitem><para>Takes a boolean parameter. If set, all System V and POSIX IPC objects owned by the user and
1512 group the processes of this unit are run as are removed when the unit is stopped. This setting only has an
1513 effect if at least one of <varname>User=</varname>, <varname>Group=</varname> and
1514 <varname>DynamicUser=</varname> are used. It has no effect on IPC objects owned by the root user. Specifically,
1515 this removes System V semaphores, as well as System V and POSIX shared memory segments and message queues. If
1516 multiple units use the same user or group the IPC objects are removed when the last of these units is
c4d4b5a7
LP
1517 stopped. This setting is implied if <varname>DynamicUser=</varname> is set.</para>
1518
1519 <xi:include href="system-only.xml" xpointer="singular"/></listitem>
798d3a52
ZJS
1520 </varlistentry>
1521
2f2e14b2
LP
1522 <varlistentry>
1523 <term><varname>PrivateMounts=</varname></term>
1524
1525 <listitem><para>Takes a boolean parameter. If set, the processes of this unit will be run in their own private
1526 file system (mount) namespace with all mount propagation from the processes towards the host's main file system
1527 namespace turned off. This means any file system mount points established or removed by the unit's processes
1528 will be private to them and not be visible to the host. However, file system mount points established or
1529 removed on the host will be propagated to the unit's processes. See <citerefentry
1530 project='man-pages'><refentrytitle>mount_namespaces</refentrytitle><manvolnum>7</manvolnum></citerefentry> for
1531 details on file system namespaces. Defaults to off.</para>
1532
1533 <para>When turned on, this executes three operations for each invoked process: a new
1534 <constant>CLONE_NEWNS</constant> namespace is created, after which all existing mounts are remounted to
1535 <constant>MS_SLAVE</constant> to disable propagation from the unit's processes to the host (but leaving
1536 propagation in the opposite direction in effect). Finally, the mounts are remounted again to the propagation
1537 mode configured with <varname>MountFlags=</varname>, see below.</para>
1538
1539 <para>File system namespaces are set up individually for each process forked off by the service manager. Mounts
1540 established in the namespace of the process created by <varname>ExecStartPre=</varname> will hence be cleaned
1541 up automatically as soon as that process exits and will not be available to subsequent processes forked off for
1542 <varname>ExecStart=</varname> (and similar applies to the various other commands configured for
1543 units). Similarly, <varname>JoinsNamespaceOf=</varname> does not permit sharing kernel mount namespaces between
1544 units, it only enables sharing of the <filename>/tmp/</filename> and <filename>/var/tmp/</filename>
1545 directories.</para>
1546
1547 <para>Other file system namespace unit settings — <varname>PrivateMounts=</varname>,
1548 <varname>PrivateTmp=</varname>, <varname>PrivateDevices=</varname>, <varname>ProtectSystem=</varname>,
1549 <varname>ProtectHome=</varname>, <varname>ReadOnlyPaths=</varname>, <varname>InaccessiblePaths=</varname>,
1550 <varname>ReadWritePaths=</varname>, … — also enable file system namespacing in a fashion equivalent to this
1551 option. Hence it is primarily useful to explicitly request this behaviour if none of the other settings are
c4d4b5a7
LP
1552 used.</para>
1553
1554 <xi:include href="system-only.xml" xpointer="singular"/></listitem>
2f2e14b2
LP
1555 </varlistentry>
1556
798d3a52 1557 <varlistentry>
b8afec21 1558 <term><varname>MountFlags=</varname></term>
798d3a52 1559
2f2e14b2
LP
1560 <listitem><para>Takes a mount propagation setting: <option>shared</option>, <option>slave</option> or
1561 <option>private</option>, which controls whether file system mount points in the file system namespaces set up
1562 for this unit's processes will receive or propagate mounts and unmounts from other file system namespaces. See
1563 <citerefentry project='man-pages'><refentrytitle>mount</refentrytitle><manvolnum>2</manvolnum></citerefentry>
1564 for details on mount propagation, and the three propagation flags in particular.</para>
1565
1566 <para>This setting only controls the <emphasis>final</emphasis> propagation setting in effect on all mount
1567 points of the file system namespace created for each process of this unit. Other file system namespacing unit
1568 settings (see the discussion in <varname>PrivateMounts=</varname> above) will implicitly disable mount and
1569 unmount propagation from the unit's processes towards the host by changing the propagation setting of all mount
1570 points in the unit's file system namepace to <option>slave</option> first. Setting this option to
923f9101 1571 <option>shared</option> does not reestablish propagation in that case.</para>
2f2e14b2
LP
1572
1573 <para>If not set – but file system namespaces are enabled through another file system namespace unit setting –
1574 <option>shared</option> mount propagation is used, but — as mentioned — as <option>slave</option> is applied
1575 first, propagation from the unit's processes to the host is still turned off.</para>
1576
1577 <para>It is not recommended to to use <option>private</option> mount propagation for units, as this means
1578 temporary mounts (such as removable media) of the host will stay mounted and thus indefinitely busy in forked
1579 off processes, as unmount propagation events won't be received by the file system namespace of the unit.</para>
1580
1581 <para>Usually, it is best to leave this setting unmodified, and use higher level file system namespacing
1582 options instead, in particular <varname>PrivateMounts=</varname>, see above.</para>
c4d4b5a7
LP
1583
1584 <xi:include href="system-only.xml" xpointer="singular"/></listitem>
798d3a52
ZJS
1585 </varlistentry>
1586
b8afec21
LP
1587 </variablelist>
1588 </refsect1>
a6fabe38 1589
b8afec21
LP
1590 <refsect1>
1591 <title>System Call Filtering</title>
e0e2ecd5 1592 <variablelist class='unit-directives'>
798d3a52
ZJS
1593
1594 <varlistentry>
1595 <term><varname>SystemCallFilter=</varname></term>
1596
330703fb
LP
1597 <listitem><para>Takes a space-separated list of system call names. If this setting is used, all
1598 system calls executed by the unit processes except for the listed ones will result in immediate
1599 process termination with the <constant>SIGSYS</constant> signal (whitelisting). (See
1600 <varname>SystemCallErrorNumber=</varname> below for changing the default action). If the first
1601 character of the list is <literal>~</literal>, the effect is inverted: only the listed system calls
1602 will result in immediate process termination (blacklisting). Blacklisted system calls and system call
1603 groups may optionally be suffixed with a colon (<literal>:</literal>) and <literal>errno</literal>
1604 error number (between 0 and 4095) or errno name such as <constant>EPERM</constant>,
1605 <constant>EACCES</constant> or <constant>EUCLEAN</constant> (see <citerefentry
1606 project='man-pages'><refentrytitle>errno</refentrytitle><manvolnum>3</manvolnum></citerefentry> for a
1607 full list). This value will be returned when a blacklisted system call is triggered, instead of
1608 terminating the processes immediately. This value takes precedence over the one given in
1609 <varname>SystemCallErrorNumber=</varname>, see below. If running in user mode, or in system mode,
1610 but without the <constant>CAP_SYS_ADMIN</constant> capability (e.g. setting
1611 <varname>User=nobody</varname>), <varname>NoNewPrivileges=yes</varname> is implied. This feature
1612 makes use of the Secure Computing Mode 2 interfaces of the kernel ('seccomp filtering') and is useful
1613 for enforcing a minimal sandboxing environment. Note that the <function>execve</function>,
1614 <function>exit</function>, <function>exit_group</function>, <function>getrlimit</function>,
1615 <function>rt_sigreturn</function>, <function>sigreturn</function> system calls and the system calls
1616 for querying time and sleeping are implicitly whitelisted and do not need to be listed
1617 explicitly. This option may be specified more than once, in which case the filter masks are
1618 merged. If the empty string is assigned, the filter is reset, all prior assignments will have no
1619 effect. This does not affect commands prefixed with <literal>+</literal>.</para>
798d3a52 1620
0b8fab97
LP
1621 <para>Note that on systems supporting multiple ABIs (such as x86/x86-64) it is recommended to turn off
1622 alternative ABIs for services, so that they cannot be used to circumvent the restrictions of this
1623 option. Specifically, it is recommended to combine this option with
1624 <varname>SystemCallArchitectures=native</varname> or similar.</para>
1625
2ca8dc15
LP
1626 <para>Note that strict system call filters may impact execution and error handling code paths of the service
1627 invocation. Specifically, access to the <function>execve</function> system call is required for the execution
1628 of the service binary — if it is blocked service invocation will necessarily fail. Also, if execution of the
1629 service binary fails for some reason (for example: missing service executable), the error handling logic might
1630 require access to an additional set of system calls in order to process and log this failure correctly. It
1631 might be necessary to temporarily disable system call filters in order to simplify debugging of such
1632 failures.</para>
1633
b8afec21
LP
1634 <para>If you specify both types of this option (i.e. whitelisting and blacklisting), the first encountered
1635 will take precedence and will dictate the default action (termination or approval of a system call). Then the
1636 next occurrences of this option will add or delete the listed system calls from the set of the filtered system
1637 calls, depending of its type and the default action. (For example, if you have started with a whitelisting of
1638 <function>read</function> and <function>write</function>, and right after it add a blacklisting of
1639 <function>write</function>, then <function>write</function> will be removed from the set.)</para>
1640
1641 <para>As the number of possible system calls is large, predefined sets of system calls are provided. A set
1642 starts with <literal>@</literal> character, followed by name of the set.
201c1cc2
TM
1643
1644 <table>
1645 <title>Currently predefined system call sets</title>
1646
1647 <tgroup cols='2'>
1648 <colspec colname='set' />
1649 <colspec colname='description' />
1650 <thead>
1651 <row>
1652 <entry>Set</entry>
1653 <entry>Description</entry>
1654 </row>
1655 </thead>
1656 <tbody>
44898c53
LP
1657 <row>
1658 <entry>@aio</entry>
1659 <entry>Asynchronous I/O (<citerefentry project='man-pages'><refentrytitle>io_setup</refentrytitle><manvolnum>2</manvolnum></citerefentry>, <citerefentry project='man-pages'><refentrytitle>io_submit</refentrytitle><manvolnum>2</manvolnum></citerefentry>, and related calls)</entry>
1660 </row>
133ddbbe
LP
1661 <row>
1662 <entry>@basic-io</entry>
1663 <entry>System calls for basic I/O: reading, writing, seeking, file descriptor duplication and closing (<citerefentry project='man-pages'><refentrytitle>read</refentrytitle><manvolnum>2</manvolnum></citerefentry>, <citerefentry project='man-pages'><refentrytitle>write</refentrytitle><manvolnum>2</manvolnum></citerefentry>, and related calls)</entry>
1664 </row>
44898c53
LP
1665 <row>
1666 <entry>@chown</entry>
1667 <entry>Changing file ownership (<citerefentry project='man-pages'><refentrytitle>chown</refentrytitle><manvolnum>2</manvolnum></citerefentry>, <citerefentry project='man-pages'><refentrytitle>fchownat</refentrytitle><manvolnum>2</manvolnum></citerefentry>, and related calls)</entry>
1668 </row>
201c1cc2
TM
1669 <row>
1670 <entry>@clock</entry>
1f9ac68b
LP
1671 <entry>System calls for changing the system clock (<citerefentry project='man-pages'><refentrytitle>adjtimex</refentrytitle><manvolnum>2</manvolnum></citerefentry>, <citerefentry project='man-pages'><refentrytitle>settimeofday</refentrytitle><manvolnum>2</manvolnum></citerefentry>, and related calls)</entry>
1672 </row>
1673 <row>
1674 <entry>@cpu-emulation</entry>
1675 <entry>System calls for CPU emulation functionality (<citerefentry project='man-pages'><refentrytitle>vm86</refentrytitle><manvolnum>2</manvolnum></citerefentry> and related calls)</entry>
1676 </row>
1677 <row>
1678 <entry>@debug</entry>
1679 <entry>Debugging, performance monitoring and tracing functionality (<citerefentry project='man-pages'><refentrytitle>ptrace</refentrytitle><manvolnum>2</manvolnum></citerefentry>, <citerefentry project='man-pages'><refentrytitle>perf_event_open</refentrytitle><manvolnum>2</manvolnum></citerefentry> and related calls)</entry>
201c1cc2 1680 </row>
1a1b13c9
LP
1681 <row>
1682 <entry>@file-system</entry>
1683 <entry>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.</entry>
1684 </row>
201c1cc2
TM
1685 <row>
1686 <entry>@io-event</entry>
1f9ac68b 1687 <entry>Event loop system calls (<citerefentry project='man-pages'><refentrytitle>poll</refentrytitle><manvolnum>2</manvolnum></citerefentry>, <citerefentry project='man-pages'><refentrytitle>select</refentrytitle><manvolnum>2</manvolnum></citerefentry>, <citerefentry project='man-pages'><refentrytitle>epoll</refentrytitle><manvolnum>7</manvolnum></citerefentry>, <citerefentry project='man-pages'><refentrytitle>eventfd</refentrytitle><manvolnum>2</manvolnum></citerefentry> and related calls)</entry>
201c1cc2
TM
1688 </row>
1689 <row>
1690 <entry>@ipc</entry>
cd5bfd7e 1691 <entry>Pipes, SysV IPC, POSIX Message Queues and other IPC (<citerefentry project='man-pages'><refentrytitle>mq_overview</refentrytitle><manvolnum>7</manvolnum></citerefentry>, <citerefentry project='man-pages'><refentrytitle>svipc</refentrytitle><manvolnum>7</manvolnum></citerefentry>)</entry>
1f9ac68b
LP
1692 </row>
1693 <row>
1694 <entry>@keyring</entry>
1695 <entry>Kernel keyring access (<citerefentry project='man-pages'><refentrytitle>keyctl</refentrytitle><manvolnum>2</manvolnum></citerefentry> and related calls)</entry>
201c1cc2 1696 </row>
cd0ddf6f
LP
1697 <row>
1698 <entry>@memlock</entry>
1699 <entry>Locking of memory into RAM (<citerefentry project='man-pages'><refentrytitle>mlock</refentrytitle><manvolnum>2</manvolnum></citerefentry>, <citerefentry project='man-pages'><refentrytitle>mlockall</refentrytitle><manvolnum>2</manvolnum></citerefentry> and related calls)</entry>
1700 </row>
201c1cc2
TM
1701 <row>
1702 <entry>@module</entry>
d5efc18b 1703 <entry>Loading and unloading of kernel modules (<citerefentry project='man-pages'><refentrytitle>init_module</refentrytitle><manvolnum>2</manvolnum></citerefentry>, <citerefentry project='man-pages'><refentrytitle>delete_module</refentrytitle><manvolnum>2</manvolnum></citerefentry> and related calls)</entry>
201c1cc2
TM
1704 </row>
1705 <row>
1706 <entry>@mount</entry>
d5efc18b 1707 <entry>Mounting and unmounting of file systems (<citerefentry project='man-pages'><refentrytitle>mount</refentrytitle><manvolnum>2</manvolnum></citerefentry>, <citerefentry project='man-pages'><refentrytitle>chroot</refentrytitle><manvolnum>2</manvolnum></citerefentry>, and related calls)</entry>
201c1cc2
TM
1708 </row>
1709 <row>
1710 <entry>@network-io</entry>
1f9ac68b 1711 <entry>Socket I/O (including local AF_UNIX): <citerefentry project='man-pages'><refentrytitle>socket</refentrytitle><manvolnum>7</manvolnum></citerefentry>, <citerefentry project='man-pages'><refentrytitle>unix</refentrytitle><manvolnum>7</manvolnum></citerefentry></entry>
201c1cc2
TM
1712 </row>
1713 <row>
1714 <entry>@obsolete</entry>
1f9ac68b 1715 <entry>Unusual, obsolete or unimplemented (<citerefentry project='man-pages'><refentrytitle>create_module</refentrytitle><manvolnum>2</manvolnum></citerefentry>, <citerefentry project='man-pages'><refentrytitle>gtty</refentrytitle><manvolnum>2</manvolnum></citerefentry>, …)</entry>
201c1cc2
TM
1716 </row>
1717 <row>
1718 <entry>@privileged</entry>
1f9ac68b 1719 <entry>All system calls which need super-user capabilities (<citerefentry project='man-pages'><refentrytitle>capabilities</refentrytitle><manvolnum>7</manvolnum></citerefentry>)</entry>
201c1cc2
TM
1720 </row>
1721 <row>
1722 <entry>@process</entry>
d5efc18b 1723 <entry>Process control, execution, namespaceing operations (<citerefentry project='man-pages'><refentrytitle>clone</refentrytitle><manvolnum>2</manvolnum></citerefentry>, <citerefentry project='man-pages'><refentrytitle>kill</refentrytitle><manvolnum>2</manvolnum></citerefentry>, <citerefentry project='man-pages'><refentrytitle>namespaces</refentrytitle><manvolnum>7</manvolnum></citerefentry>, …</entry>
201c1cc2
TM
1724 </row>
1725 <row>
1726 <entry>@raw-io</entry>
aa6b9cec 1727 <entry>Raw I/O port access (<citerefentry project='man-pages'><refentrytitle>ioperm</refentrytitle><manvolnum>2</manvolnum></citerefentry>, <citerefentry project='man-pages'><refentrytitle>iopl</refentrytitle><manvolnum>2</manvolnum></citerefentry>, <function>pciconfig_read()</function>, …)</entry>
201c1cc2 1728 </row>
bd2ab3f4
LP
1729 <row>
1730 <entry>@reboot</entry>
1731 <entry>System calls for rebooting and reboot preparation (<citerefentry project='man-pages'><refentrytitle>reboot</refentrytitle><manvolnum>2</manvolnum></citerefentry>, <function>kexec()</function>, …)</entry>
1732 </row>
133ddbbe
LP
1733 <row>
1734 <entry>@resources</entry>
1735 <entry>System calls for changing resource limits, memory and scheduling parameters (<citerefentry project='man-pages'><refentrytitle>setrlimit</refentrytitle><manvolnum>2</manvolnum></citerefentry>, <citerefentry project='man-pages'><refentrytitle>setpriority</refentrytitle><manvolnum>2</manvolnum></citerefentry>, …)</entry>
1736 </row>
6eaaeee9
LP
1737 <row>
1738 <entry>@setuid</entry>
1739 <entry>System calls for changing user ID and group ID credentials, (<citerefentry project='man-pages'><refentrytitle>setuid</refentrytitle><manvolnum>2</manvolnum></citerefentry>, <citerefentry project='man-pages'><refentrytitle>setgid</refentrytitle><manvolnum>2</manvolnum></citerefentry>, <citerefentry project='man-pages'><refentrytitle>setresuid</refentrytitle><manvolnum>2</manvolnum></citerefentry>, …)</entry>
1740 </row>
cd0ddf6f
LP
1741 <row>
1742 <entry>@signal</entry>
1743 <entry>System calls for manipulating and handling process signals (<citerefentry project='man-pages'><refentrytitle>signal</refentrytitle><manvolnum>2</manvolnum></citerefentry>, <citerefentry project='man-pages'><refentrytitle>sigprocmask</refentrytitle><manvolnum>2</manvolnum></citerefentry>, …)</entry>
1744 </row>
bd2ab3f4
LP
1745 <row>
1746 <entry>@swap</entry>
1747 <entry>System calls for enabling/disabling swap devices (<citerefentry project='man-pages'><refentrytitle>swapon</refentrytitle><manvolnum>2</manvolnum></citerefentry>, <citerefentry project='man-pages'><refentrytitle>swapoff</refentrytitle><manvolnum>2</manvolnum></citerefentry>)</entry>
1748 </row>
44898c53
LP
1749 <row>
1750 <entry>@sync</entry>
1751 <entry>Synchronizing files and memory to disk: (<citerefentry project='man-pages'><refentrytitle>fsync</refentrytitle><manvolnum>2</manvolnum></citerefentry>, <citerefentry project='man-pages'><refentrytitle>msync</refentrytitle><manvolnum>2</manvolnum></citerefentry>, and related calls)</entry>
1752 </row>
70526841
LP
1753 <row>
1754 <entry>@system-service</entry>
1755 <entry>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: <literal>@clock</literal>, <literal>@mount</literal>, <literal>@swap</literal>, <literal>@reboot</literal>.</entry>
1756 </row>
cd0ddf6f
LP
1757 <row>
1758 <entry>@timer</entry>
1759 <entry>System calls for scheduling operations by time (<citerefentry project='man-pages'><refentrytitle>alarm</refentrytitle><manvolnum>2</manvolnum></citerefentry>, <citerefentry project='man-pages'><refentrytitle>timer_create</refentrytitle><manvolnum>2</manvolnum></citerefentry>, …)</entry>
1760 </row>
201c1cc2
TM
1761 </tbody>
1762 </tgroup>
1763 </table>
1764
b8afec21
LP
1765 Note, that as new system calls are added to the kernel, additional system calls might be added to the groups
1766 above. Contents of the sets may also change between systemd versions. In addition, the list of system calls
1767 depends on the kernel version and architecture for which systemd was compiled. Use
1768 <command>systemd-analyze syscall-filter</command> to list the actual list of system calls in each
1769 filter.</para>
effbd6d2 1770
70526841
LP
1771 <para>Generally, whitelisting system calls (rather than blacklisting) is the safer mode of operation. It is
1772 recommended to enforce system call whitelists for all long-running system services. Specifically, the
1773 following lines are a relatively safe basic choice for the majority of system services:</para>
1774
1775 <programlisting>[Service]
1776SystemCallFilter=@system-service
1777SystemCallErrorNumber=EPERM</programlisting>
1778
330703fb
LP
1779 <para>Note that various kernel system calls are defined redundantly: there are multiple system calls
1780 for executing the same operation. For example, the <function>pidfd_send_signal()</function> system
1781 call may be used to execute operations similar to what can be done with the older
1782 <function>kill()</function> system call, hence blocking the latter without the former only provides
1783 weak protection. Since new system calls are added regularly to the kernel as development progresses,
1784 keeping system call blacklists comprehensive requires constant work. It is thus recommended to use
1785 whitelisting instead, which offers the benefit that new system calls are by default implicitly
1786 blocked until the whitelist is updated.</para>
1787
1788 <para>Also note that a number of system calls are required to be accessible for the dynamic linker to
1789 work. The dynamic linker is required for running most regular programs (specifically: all dynamic ELF
1790 binaries, which is how most distributions build packaged programs). This means that blocking these
1791 system calls (which include <function>open()</function>, <function>openat()</function> or
1792 <function>mmap()</function>) will make most programs typically shipped with generic distributions
1793 unusable.</para>
1794
effbd6d2
LP
1795 <para>It is recommended to combine the file system namespacing related options with
1796 <varname>SystemCallFilter=~@mount</varname>, in order to prohibit the unit's processes to undo the
1797 mappings. Specifically these are the options <varname>PrivateTmp=</varname>,
1798 <varname>PrivateDevices=</varname>, <varname>ProtectSystem=</varname>, <varname>ProtectHome=</varname>,
1799 <varname>ProtectKernelTunables=</varname>, <varname>ProtectControlGroups=</varname>,
d916e35b
KK
1800 <varname>ProtectKernelLogs=</varname>, <varname>ReadOnlyPaths=</varname>,
1801 <varname>InaccessiblePaths=</varname> and <varname>ReadWritePaths=</varname>.</para></listitem>
798d3a52
ZJS
1802 </varlistentry>
1803
1804 <varlistentry>
1805 <term><varname>SystemCallErrorNumber=</varname></term>
1806
330703fb
LP
1807 <listitem><para>Takes an <literal>errno</literal> error number (between 1 and 4095) or errno name
1808 such as <constant>EPERM</constant>, <constant>EACCES</constant> or <constant>EUCLEAN</constant>, to
1809 return when the system call filter configured with <varname>SystemCallFilter=</varname> is triggered,
1810 instead of terminating the process immediately. See <citerefentry
1811 project='man-pages'><refentrytitle>errno</refentrytitle><manvolnum>3</manvolnum></citerefentry> for a
1812 full list of error codes. When this setting is not used, or when the empty string is assigned, the
1813 process will be terminated immediately when the filter is triggered.</para></listitem>
798d3a52
ZJS
1814 </varlistentry>
1815
1816 <varlistentry>
1817 <term><varname>SystemCallArchitectures=</varname></term>
1818
0b8fab97
LP
1819 <listitem><para>Takes a space-separated list of architecture identifiers to include in the system call
1820 filter. The known architecture identifiers are the same as for <varname>ConditionArchitecture=</varname>
1821 described in <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
1822 as well as <constant>x32</constant>, <constant>mips64-n32</constant>, <constant>mips64-le-n32</constant>, and
2428aaf8 1823 the special identifier <constant>native</constant>. The special identifier <constant>native</constant>
62a0680b
AJ
1824 implicitly maps to the native architecture of the system (or more precisely: to the architecture the system
1825 manager is compiled for). If running in user mode, or in system mode, but without the
1826 <constant>CAP_SYS_ADMIN</constant> capability (e.g. setting <varname>User=nobody</varname>),
1827 <varname>NoNewPrivileges=yes</varname> is implied. By default, this option is set to the empty list, i.e. no
1828 system call architecture filtering is applied.</para>
0b8fab97 1829
2428aaf8
AJ
1830 <para>If this setting is used, processes of this unit will only be permitted to call native system calls, and
1831 system calls of the specified architectures. For the purposes of this option, the x32 architecture is treated
1832 as including x86-64 system calls. However, this setting still fulfills its purpose, as explained below, on
1833 x32.</para>
1834
1835 <para>System call filtering is not equally effective on all architectures. For example, on x86
0b8fab97
LP
1836 filtering of network socket-related calls is not possible, due to ABI limitations — a limitation that x86-64
1837 does not have, however. On systems supporting multiple ABIs at the same time — such as x86/x86-64 — it is hence
1838 recommended to limit the set of permitted system call architectures so that secondary ABIs may not be used to
1839 circumvent the restrictions applied to the native ABI of the system. In particular, setting
c29ebc1a 1840 <varname>SystemCallArchitectures=native</varname> is a good choice for disabling non-native ABIs.</para>
0b8fab97 1841
b8afec21
LP
1842 <para>System call architectures may also be restricted system-wide via the
1843 <varname>SystemCallArchitectures=</varname> option in the global configuration. See
1844 <citerefentry><refentrytitle>systemd-system.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry> for
1845 details.</para></listitem>
1846 </varlistentry>
1847
1848 </variablelist>
1849 </refsect1>
1850
1851 <refsect1>
1852 <title>Environment</title>
1853
e0e2ecd5 1854 <variablelist class='unit-directives'>
b8afec21
LP
1855
1856 <varlistentry>
1857 <term><varname>Environment=</varname></term>
1858
1859 <listitem><para>Sets environment variables for executed processes. Takes a space-separated list of variable
1860 assignments. This option may be specified more than once, in which case all listed variables will be set. If
1861 the same variable is set twice, the later setting will override the earlier setting. If the empty string is
1862 assigned to this option, the list of environment variables is reset, all prior assignments have no
1863 effect. Variable expansion is not performed inside the strings, however, specifier expansion is possible. The $
1864 character has no special meaning. If you need to assign a value containing spaces or the equals sign to a
1865 variable, use double quotes (") for the assignment.</para>
1866
1867 <para>Example:
1868 <programlisting>Environment="VAR1=word1 word2" VAR2=word3 "VAR3=$word 5 6"</programlisting>
1869 gives three variables <literal>VAR1</literal>,
1870 <literal>VAR2</literal>, <literal>VAR3</literal>
1871 with the values <literal>word1 word2</literal>,
1872 <literal>word3</literal>, <literal>$word 5 6</literal>.
1873 </para>
1874
1875 <para>
1876 See <citerefentry
1877 project='man-pages'><refentrytitle>environ</refentrytitle><manvolnum>7</manvolnum></citerefentry> for details
438311a5
LP
1878 about environment variables.</para>
1879
1880 <para>Note that environment variables are not suitable for passing secrets (such as passwords, key material, …)
1881 to service processes. Environment variables set for a unit are exposed to unprivileged clients via D-Bus IPC,
1882 and generally not understood as being data that requires protection. Moreover, environment variables are
1883 propagated down the process tree, including across security boundaries (such as setuid/setgid executables), and
1884 hence might leak to processes that should not have access to the secret data.</para></listitem>
b8afec21
LP
1885 </varlistentry>
1886
1887 <varlistentry>
1888 <term><varname>EnvironmentFile=</varname></term>
1889
1890 <listitem><para>Similar to <varname>Environment=</varname> but reads the environment variables from a text
1891 file. The text file should contain new-line-separated variable assignments. Empty lines, lines without an
1892 <literal>=</literal> separator, or lines starting with ; or # will be ignored, which may be used for
1893 commenting. A line ending with a backslash will be concatenated with the following one, allowing multiline
1894 variable definitions. The parser strips leading and trailing whitespace from the values of assignments, unless
1895 you use double quotes (").</para>
1896
69bdb3b1
MS
1897 <para><ulink url="https://en.wikipedia.org/wiki/Escape_sequences_in_C#Table_of_escape_sequences">C escapes</ulink>
1898 are supported, but not
1899 <ulink url="https://en.wikipedia.org/wiki/Control_character#In_ASCII">most control characters</ulink>.
1900 <literal>\t</literal> and <literal>\n</literal> can be used to insert tabs and newlines within
1901 <varname>EnvironmentFile=</varname>.</para>
1902
b8afec21
LP
1903 <para>The argument passed should be an absolute filename or wildcard expression, optionally prefixed with
1904 <literal>-</literal>, which indicates that if the file does not exist, it will not be read and no error or
1905 warning message is logged. This option may be specified more than once in which case all specified files are
1906 read. If the empty string is assigned to this option, the list of file to read is reset, all prior assignments
1907 have no effect.</para>
1908
1909 <para>The files listed with this directive will be read shortly before the process is executed (more
1910 specifically, after all processes from a previous unit state terminated. This means you can generate these
412a6c64
TM
1911 files in one unit state, and read it with this option in the next. The files are read from the file
1912 system of the service manager, before any file system changes like bind mounts take place).</para>
b8afec21
LP
1913
1914 <para>Settings from these files override settings made with <varname>Environment=</varname>. If the same
1915 variable is set twice from these files, the files will be read in the order they are specified and the later
1916 setting will override the earlier setting.</para></listitem>
1917 </varlistentry>
1918
1919 <varlistentry>
1920 <term><varname>PassEnvironment=</varname></term>
1921
1922 <listitem><para>Pass environment variables set for the system service manager to executed processes. Takes a
1923 space-separated list of variable names. This option may be specified more than once, in which case all listed
1924 variables will be passed. If the empty string is assigned to this option, the list of environment variables to
1925 pass is reset, all prior assignments have no effect. Variables specified that are not set for the system
1926 manager will not be passed and will be silently ignored. Note that this option is only relevant for the system
1927 service manager, as system services by default do not automatically inherit any environment variables set for
1928 the service manager itself. However, in case of the user service manager all environment variables are passed
1929 to the executed processes anyway, hence this option is without effect for the user service manager.</para>
1930
1931 <para>Variables set for invoked processes due to this setting are subject to being overridden by those
1932 configured with <varname>Environment=</varname> or <varname>EnvironmentFile=</varname>.</para>
1933
69bdb3b1
MS
1934 <para><ulink url="https://en.wikipedia.org/wiki/Escape_sequences_in_C#Table_of_escape_sequences">C escapes</ulink>
1935 are supported, but not
1936 <ulink url="https://en.wikipedia.org/wiki/Control_character#In_ASCII">most control characters</ulink>.
1937 <literal>\t</literal> and <literal>\n</literal> can be used to insert tabs and newlines within
1938 <varname>EnvironmentFile=</varname>.</para>
1939
b8afec21
LP
1940 <para>Example:
1941 <programlisting>PassEnvironment=VAR1 VAR2 VAR3</programlisting>
1942 passes three variables <literal>VAR1</literal>,
1943 <literal>VAR2</literal>, <literal>VAR3</literal>
1944 with the values set for those variables in PID1.</para>
1945
1946 <para>
1947 See <citerefentry
1948 project='man-pages'><refentrytitle>environ</refentrytitle><manvolnum>7</manvolnum></citerefentry> for details
1949 about environment variables.</para></listitem>
1950 </varlistentry>
1951
1952 <varlistentry>
1953 <term><varname>UnsetEnvironment=</varname></term>
1954
1955 <listitem><para>Explicitly unset environment variable assignments that would normally be passed from the
1956 service manager to invoked processes of this unit. Takes a space-separated list of variable names or variable
1957 assignments. This option may be specified more than once, in which case all listed variables/assignments will
1958 be unset. If the empty string is assigned to this option, the list of environment variables/assignments to
1959 unset is reset. If a variable assignment is specified (that is: a variable name, followed by
1960 <literal>=</literal>, followed by its value), then any environment variable matching this precise assignment is
1961 removed. If a variable name is specified (that is a variable name without any following <literal>=</literal> or
1962 value), then any assignment matching the variable name, regardless of its value is removed. Note that the
1963 effect of <varname>UnsetEnvironment=</varname> is applied as final step when the environment list passed to
1964 executed processes is compiled. That means it may undo assignments from any configuration source, including
1965 assignments made through <varname>Environment=</varname> or <varname>EnvironmentFile=</varname>, inherited from
1966 the system manager's global set of environment variables, inherited via <varname>PassEnvironment=</varname>,
1967 set by the service manager itself (such as <varname>$NOTIFY_SOCKET</varname> and such), or set by a PAM module
1968 (in case <varname>PAMName=</varname> is used).</para>
1969
1970 <para>
1971 See <citerefentry
1972 project='man-pages'><refentrytitle>environ</refentrytitle><manvolnum>7</manvolnum></citerefentry> for details
1973 about environment variables.</para></listitem>
1974 </varlistentry>
1975
1976 </variablelist>
1977 </refsect1>
1978
1979 <refsect1>
1980 <title>Logging and Standard Input/Output</title>
1981
e0e2ecd5 1982 <variablelist class='unit-directives'>
b8afec21
LP
1983 <varlistentry>
1984
1985 <term><varname>StandardInput=</varname></term>
1986
1987 <listitem><para>Controls where file descriptor 0 (STDIN) of the executed processes is connected to. Takes one
1988 of <option>null</option>, <option>tty</option>, <option>tty-force</option>, <option>tty-fail</option>,
1989 <option>data</option>, <option>file:<replaceable>path</replaceable></option>, <option>socket</option> or
1990 <option>fd:<replaceable>name</replaceable></option>.</para>
1991
1992 <para>If <option>null</option> is selected, standard input will be connected to <filename>/dev/null</filename>,
1993 i.e. all read attempts by the process will result in immediate EOF.</para>
1994
1995 <para>If <option>tty</option> is selected, standard input is connected to a TTY (as configured by
1996 <varname>TTYPath=</varname>, see below) and the executed process becomes the controlling process of the
1997 terminal. If the terminal is already being controlled by another process, the executed process waits until the
1998 current controlling process releases the terminal.</para>
1999
2000 <para><option>tty-force</option> is similar to <option>tty</option>, but the executed process is forcefully and
2001 immediately made the controlling process of the terminal, potentially removing previous controlling processes
2002 from the terminal.</para>
2003
2004 <para><option>tty-fail</option> is similar to <option>tty</option>, but if the terminal already has a
2005 controlling process start-up of the executed process fails.</para>
2006
2007 <para>The <option>data</option> option may be used to configure arbitrary textual or binary data to pass via
2008 standard input to the executed process. The data to pass is configured via
2009 <varname>StandardInputText=</varname>/<varname>StandardInputData=</varname> (see below). Note that the actual
2010 file descriptor type passed (memory file, regular file, UNIX pipe, …) might depend on the kernel and available
2011 privileges. In any case, the file descriptor is read-only, and when read returns the specified data followed by
2012 EOF.</para>
2013
2014 <para>The <option>file:<replaceable>path</replaceable></option> option may be used to connect a specific file
2015 system object to standard input. An absolute path following the <literal>:</literal> character is expected,
2016 which may refer to a regular file, a FIFO or special file. If an <constant>AF_UNIX</constant> socket in the
2017 file system is specified, a stream socket is connected to it. The latter is useful for connecting standard
2018 input of processes to arbitrary system services.</para>
2019
2020 <para>The <option>socket</option> option is valid in socket-activated services only, and requires the relevant
2021 socket unit file (see
2022 <citerefentry><refentrytitle>systemd.socket</refentrytitle><manvolnum>5</manvolnum></citerefentry> for details)
2023 to have <varname>Accept=yes</varname> set, or to specify a single socket only. If this option is set, standard
2024 input will be connected to the socket the service was activated from, which is primarily useful for
2025 compatibility with daemons designed for use with the traditional <citerefentry
2026 project='freebsd'><refentrytitle>inetd</refentrytitle><manvolnum>8</manvolnum></citerefentry> socket activation
2027 daemon.</para>
2028
2029 <para>The <option>fd:<replaceable>name</replaceable></option> option connects standard input to a specific,
2030 named file descriptor provided by a socket unit. The name may be specified as part of this option, following a
2031 <literal>:</literal> character (e.g. <literal>fd:foobar</literal>). If no name is specified, the name
2032 <literal>stdin</literal> is implied (i.e. <literal>fd</literal> is equivalent to <literal>fd:stdin</literal>).
2033 At least one socket unit defining the specified name must be provided via the <varname>Sockets=</varname>
2034 option, and the file descriptor name may differ from the name of its containing socket unit. If multiple
2035 matches are found, the first one will be used. See <varname>FileDescriptorName=</varname> in
2036 <citerefentry><refentrytitle>systemd.socket</refentrytitle><manvolnum>5</manvolnum></citerefentry> for more
2037 details about named file descriptors and their ordering.</para>
2038
0b578036
ZJS
2039 <para>This setting defaults to <option>null</option>.</para>
2040
2041 <para>Note that services which specify <option>DefaultDependencies=no</option> and use
2042 <varname>StandardInput=</varname> or <varname>StandardOutput=</varname> with
2043 <option>tty</option>/<option>tty-force</option>/<option>tty-fail</option>, should specify
5238e957 2044 <option>After=systemd-vconsole-setup.service</option>, to make sure that the tty initialization is
0b578036 2045 finished before they start.</para></listitem>
b8afec21
LP
2046 </varlistentry>
2047
2048 <varlistentry>
2049 <term><varname>StandardOutput=</varname></term>
2050
d58b613b 2051 <listitem><para>Controls where file descriptor 1 (stdout) of the executed processes is connected
eedaf7f3
LP
2052 to. Takes one of <option>inherit</option>, <option>null</option>, <option>tty</option>,
2053 <option>journal</option>, <option>kmsg</option>, <option>journal+console</option>,
2054 <option>kmsg+console</option>, <option>file:<replaceable>path</replaceable></option>,
2055 <option>append:<replaceable>path</replaceable></option>, <option>socket</option> or
2056 <option>fd:<replaceable>name</replaceable></option>.</para>
b8afec21
LP
2057
2058 <para><option>inherit</option> duplicates the file descriptor of standard input for standard output.</para>
2059
2060 <para><option>null</option> connects standard output to <filename>/dev/null</filename>, i.e. everything written
2061 to it will be lost.</para>
2062
2063 <para><option>tty</option> connects standard output to a tty (as configured via <varname>TTYPath=</varname>,
2064 see below). If the TTY is used for output only, the executed process will not become the controlling process of
2065 the terminal, and will not fail or wait for other processes to release the terminal.</para>
2066
eedaf7f3
LP
2067 <para><option>journal</option> connects standard output with the journal, which is accessible via
2068 <citerefentry><refentrytitle>journalctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>. Note
2069 that everything that is written to kmsg (see below) is implicitly stored in the journal as well, the
2070 specific option listed below is hence a superset of this one. (Also note that any external,
2071 additional syslog daemons receive their log data from the journal, too, hence this is the option to
2072 use when logging shall be processed with such a daemon.)</para>
b8afec21
LP
2073
2074 <para><option>kmsg</option> connects standard output with the kernel log buffer which is accessible via
2075 <citerefentry project='man-pages'><refentrytitle>dmesg</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
2076 in addition to the journal. The journal daemon might be configured to send all logs to kmsg anyway, in which
2077 case this option is no different from <option>journal</option>.</para>
2078
eedaf7f3
LP
2079 <para><option>journal+console</option> and <option>kmsg+console</option> work in a similar way as the
2080 two options above but copy the output to the system console as well.</para>
b8afec21
LP
2081
2082 <para>The <option>file:<replaceable>path</replaceable></option> option may be used to connect a specific file
2083 system object to standard output. The semantics are similar to the same option of
566b7d23
ZD
2084 <varname>StandardInput=</varname>, see above. If <replaceable>path</replaceable> refers to a regular file
2085 on the filesystem, it is opened (created if it doesn't exist yet) for writing at the beginning of the file,
2086 but without truncating it.
2087 If standard input and output are directed to the same file path, it is opened only once, for reading as well
2088 as writing and duplicated. This is particularly useful when the specified path refers to an
2089 <constant>AF_UNIX</constant> socket in the file system, as in that case only a
b8afec21
LP
2090 single stream connection is created for both input and output.</para>
2091
566b7d23
ZD
2092 <para><option>append:<replaceable>path</replaceable></option> is similar to <option>file:<replaceable>path
2093 </replaceable></option> above, but it opens the file in append mode.</para>
2094
b8afec21
LP
2095 <para><option>socket</option> connects standard output to a socket acquired via socket activation. The
2096 semantics are similar to the same option of <varname>StandardInput=</varname>, see above.</para>
2097
2098 <para>The <option>fd:<replaceable>name</replaceable></option> option connects standard output to a specific,
2099 named file descriptor provided by a socket unit. A name may be specified as part of this option, following a
2100 <literal>:</literal> character (e.g. <literal>fd:foobar</literal>). If no name is specified, the name
2101 <literal>stdout</literal> is implied (i.e. <literal>fd</literal> is equivalent to
2102 <literal>fd:stdout</literal>). At least one socket unit defining the specified name must be provided via the
2103 <varname>Sockets=</varname> option, and the file descriptor name may differ from the name of its containing
2104 socket unit. If multiple matches are found, the first one will be used. See
2105 <varname>FileDescriptorName=</varname> in
2106 <citerefentry><refentrytitle>systemd.socket</refentrytitle><manvolnum>5</manvolnum></citerefentry> for more
2107 details about named descriptors and their ordering.</para>
2108
eedaf7f3
LP
2109 <para>If the standard output (or error output, see below) of a unit is connected to the journal or
2110 the kernel log buffer, the unit will implicitly gain a dependency of type <varname>After=</varname>
2111 on <filename>systemd-journald.socket</filename> (also see the "Implicit Dependencies" section
2112 above). Also note that in this case stdout (or stderr, see below) will be an
2113 <constant>AF_UNIX</constant> stream socket, and not a pipe or FIFO that can be re-opened. This means
2114 when executing shell scripts the construct <command>echo "hello" &gt; /dev/stderr</command> for
2115 writing text to stderr will not work. To mitigate this use the construct <command>echo "hello"
2116 >&amp;2</command> instead, which is mostly equivalent and avoids this pitfall.</para>
b8afec21
LP
2117
2118 <para>This setting defaults to the value set with <varname>DefaultStandardOutput=</varname> in
2119 <citerefentry><refentrytitle>systemd-system.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>, which
2120 defaults to <option>journal</option>. Note that setting this parameter might result in additional dependencies
2121 to be added to the unit (see above).</para></listitem>
2122 </varlistentry>
2123
2124 <varlistentry>
2125 <term><varname>StandardError=</varname></term>
2126
d58b613b 2127 <listitem><para>Controls where file descriptor 2 (stderr) of the executed processes is connected to. The
b8afec21
LP
2128 available options are identical to those of <varname>StandardOutput=</varname>, with some exceptions: if set to
2129 <option>inherit</option> the file descriptor used for standard output is duplicated for standard error, while
2130 <option>fd:<replaceable>name</replaceable></option> will use a default file descriptor name of
2131 <literal>stderr</literal>.</para>
2132
2133 <para>This setting defaults to the value set with <varname>DefaultStandardError=</varname> in
2134 <citerefentry><refentrytitle>systemd-system.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>, which
2135 defaults to <option>inherit</option>. Note that setting this parameter might result in additional dependencies
2136 to be added to the unit (see above).</para></listitem>
2137 </varlistentry>
2138
2139 <varlistentry>
2140 <term><varname>StandardInputText=</varname></term>
2141 <term><varname>StandardInputData=</varname></term>
2142
2143 <listitem><para>Configures arbitrary textual or binary data to pass via file descriptor 0 (STDIN) to the
2144 executed processes. These settings have no effect unless <varname>StandardInput=</varname> is set to
2145 <option>data</option>. Use this option to embed process input data directly in the unit file.</para>
2146
2147 <para><varname>StandardInputText=</varname> accepts arbitrary textual data. C-style escapes for special
2148 characters as well as the usual <literal>%</literal>-specifiers are resolved. Each time this setting is used
1b2ad5d9 2149 the specified text is appended to the per-unit data buffer, followed by a newline character (thus every use
b8afec21
LP
2150 appends a new line to the end of the buffer). Note that leading and trailing whitespace of lines configured
2151 with this option is removed. If an empty line is specified the buffer is cleared (hence, in order to insert an
2152 empty line, add an additional <literal>\n</literal> to the end or beginning of a line).</para>
2153
2154 <para><varname>StandardInputData=</varname> accepts arbitrary binary data, encoded in <ulink
2155 url="https://tools.ietf.org/html/rfc2045#section-6.8">Base64</ulink>. No escape sequences or specifiers are
2156 resolved. Any whitespace in the encoded version is ignored during decoding.</para>
2157
2158 <para>Note that <varname>StandardInputText=</varname> and <varname>StandardInputData=</varname> operate on the
2159 same data buffer, and may be mixed in order to configure both binary and textual data for the same input
2160 stream. The textual or binary data is joined strictly in the order the settings appear in the unit
2161 file. Assigning an empty string to either will reset the data buffer.</para>
2162
2163 <para>Please keep in mind that in order to maintain readability long unit file settings may be split into
2164 multiple lines, by suffixing each line (except for the last) with a <literal>\</literal> character (see
2165 <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry> for
2166 details). This is particularly useful for large data configured with these two options. Example:</para>
2167
2168 <programlisting>…
2169StandardInput=data
2170StandardInputData=SWNrIHNpdHplIGRhIHVuJyBlc3NlIEtsb3BzLAp1ZmYgZWVtYWwga2xvcHAncy4KSWNrIGtpZWtl \
2171 LCBzdGF1bmUsIHd1bmRyZSBtaXIsCnVmZiBlZW1hbCBqZWh0IHNlIHVmZiBkaWUgVMO8ci4KTmFu \
2172 dSwgZGVuayBpY2ssIGljayBkZW5rIG5hbnUhCkpldHogaXNzZSB1ZmYsIGVyc2NodCB3YXIgc2Ug \
2173 enUhCkljayBqZWhlIHJhdXMgdW5kIGJsaWNrZSDigJQKdW5kIHdlciBzdGVodCBkcmF1w59lbj8g \
2174 SWNrZSEK
2175…</programlisting></listitem>
798d3a52
ZJS
2176 </varlistentry>
2177
2178 <varlistentry>
b8afec21 2179 <term><varname>LogLevelMax=</varname></term>
142bd808 2180
b8afec21
LP
2181 <listitem><para>Configures filtering by log level of log messages generated by this unit. Takes a
2182 <command>syslog</command> log level, one of <option>emerg</option> (lowest log level, only highest priority
2183 messages), <option>alert</option>, <option>crit</option>, <option>err</option>, <option>warning</option>,
2184 <option>notice</option>, <option>info</option>, <option>debug</option> (highest log level, also lowest priority
2185 messages). See <citerefentry
2186 project='man-pages'><refentrytitle>syslog</refentrytitle><manvolnum>3</manvolnum></citerefentry> for
2187 details. By default no filtering is applied (i.e. the default maximum log level is <option>debug</option>). Use
2188 this option to configure the logging system to drop log messages of a specific service above the specified
2189 level. For example, set <varname>LogLevelMax=</varname><option>info</option> in order to turn off debug logging
1b2ad5d9 2190 of a particularly chatty unit. Note that the configured level is applied to any log messages written by any
b8afec21
LP
2191 of the processes belonging to this unit, sent via any supported logging protocol. The filtering is applied
2192 early in the logging pipeline, before any kind of further processing is done. Moreover, messages which pass
2193 through this filter successfully might still be dropped by filters applied at a later stage in the logging
2194 subsystem. For example, <varname>MaxLevelStore=</varname> configured in
2195 <citerefentry><refentrytitle>journald.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry> might
2196 prohibit messages of higher log levels to be stored on disk, even though the per-unit
2197 <varname>LogLevelMax=</varname> permitted it to be processed.</para></listitem>
798d3a52
ZJS
2198 </varlistentry>
2199
add00535 2200 <varlistentry>
b8afec21 2201 <term><varname>LogExtraFields=</varname></term>
add00535 2202
db11487d
ZJS
2203 <listitem><para>Configures additional log metadata fields to include in all log records generated by
2204 processes associated with this unit. This setting takes one or more journal field assignments in the
2205 format <literal>FIELD=VALUE</literal> separated by whitespace. See
2206 <citerefentry><refentrytitle>systemd.journal-fields</refentrytitle><manvolnum>7</manvolnum></citerefentry>
2207 for details on the journal field concept. Even though the underlying journal implementation permits
2208 binary field values, this setting accepts only valid UTF-8 values. To include space characters in a
2209 journal field value, enclose the assignment in double quotes ("). <!-- " fake closing quote for emacs-->
2210 The usual specifiers are expanded in all assignments (see below). Note that this setting is not only
2211 useful for attaching additional metadata to log records of a unit, but given that all fields and
2212 values are indexed may also be used to implement cross-unit log record matching. Assign an empty
2213 string to reset the list.</para></listitem>
add00535
LP
2214 </varlistentry>
2215
90fc172e
AZ
2216 <varlistentry>
2217 <term><varname>LogRateLimitIntervalSec=</varname></term>
2218 <term><varname>LogRateLimitBurst=</varname></term>
2219
2220 <listitem><para>Configures the rate limiting that is applied to messages generated by this unit. If, in the
2221 time interval defined by <varname>LogRateLimitIntervalSec=</varname>, more messages than specified in
2222 <varname>LogRateLimitBurst=</varname> are logged by a service, all further messages within the interval are
2223 dropped until the interval is over. A message about the number of dropped messages is generated. The time
2224 specification for <varname>LogRateLimitIntervalSec=</varname> may be specified in the following units: "s",
2225 "min", "h", "ms", "us" (see
2226 <citerefentry><refentrytitle>systemd.time</refentrytitle><manvolnum>7</manvolnum></citerefentry> for details).
2227 The default settings are set by <varname>RateLimitIntervalSec=</varname> and <varname>RateLimitBurst=</varname>
2228 configured in <citerefentry><refentrytitle>journald.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
2229 </para></listitem>
2230 </varlistentry>
2231
798d3a52 2232 <varlistentry>
b8afec21 2233 <term><varname>SyslogIdentifier=</varname></term>
798d3a52 2234
eedaf7f3
LP
2235 <listitem><para>Sets the process name ("<command>syslog</command> tag") to prefix log lines sent to
2236 the logging system or the kernel log buffer with. If not set, defaults to the process name of the
2237 executed process. This option is only useful when <varname>StandardOutput=</varname> or
2238 <varname>StandardError=</varname> are set to <option>journal</option> or <option>kmsg</option> (or to
2239 the same settings in combination with <option>+console</option>) and only applies to log messages
2240 written to stdout or stderr.</para></listitem>
798d3a52
ZJS
2241 </varlistentry>
2242
2243 <varlistentry>
b8afec21 2244 <term><varname>SyslogFacility=</varname></term>
78e864e5 2245
b8afec21
LP
2246 <listitem><para>Sets the <command>syslog</command> facility identifier to use when logging. One of
2247 <option>kern</option>, <option>user</option>, <option>mail</option>, <option>daemon</option>,
2248 <option>auth</option>, <option>syslog</option>, <option>lpr</option>, <option>news</option>,
2249 <option>uucp</option>, <option>cron</option>, <option>authpriv</option>, <option>ftp</option>,
2250 <option>local0</option>, <option>local1</option>, <option>local2</option>, <option>local3</option>,
eedaf7f3
LP
2251 <option>local4</option>, <option>local5</option>, <option>local6</option> or
2252 <option>local7</option>. See <citerefentry
2253 project='man-pages'><refentrytitle>syslog</refentrytitle><manvolnum>3</manvolnum></citerefentry> for
2254 details. This option is only useful when <varname>StandardOutput=</varname> or
2255 <varname>StandardError=</varname> are set to <option>journal</option> or <option>kmsg</option> (or to
2256 the same settings in combination with <option>+console</option>), and only applies to log messages
2257 written to stdout or stderr. Defaults to <option>daemon</option>.</para></listitem>
78e864e5
TM
2258 </varlistentry>
2259
b1edf445 2260 <varlistentry>
b8afec21 2261 <term><varname>SyslogLevel=</varname></term>
b1edf445 2262
b8afec21
LP
2263 <listitem><para>The default <command>syslog</command> log level to use when logging to the logging system or
2264 the kernel log buffer. One of <option>emerg</option>, <option>alert</option>, <option>crit</option>,
2265 <option>err</option>, <option>warning</option>, <option>notice</option>, <option>info</option>,
2266 <option>debug</option>. See <citerefentry
2267 project='man-pages'><refentrytitle>syslog</refentrytitle><manvolnum>3</manvolnum></citerefentry> for
2268 details. This option is only useful when <varname>StandardOutput=</varname> or
eedaf7f3 2269 <varname>StandardError=</varname> are set to <option>journal</option> or
b8afec21
LP
2270 <option>kmsg</option> (or to the same settings in combination with <option>+console</option>), and only applies
2271 to log messages written to stdout or stderr. Note that individual lines output by executed processes may be
2272 prefixed with a different log level which can be used to override the default log level specified here. The
2273 interpretation of these prefixes may be disabled with <varname>SyslogLevelPrefix=</varname>, see below. For
2274 details, see <citerefentry><refentrytitle>sd-daemon</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
2275 Defaults to <option>info</option>.</para></listitem>
78e864e5
TM
2276 </varlistentry>
2277
2278 <varlistentry>
b8afec21 2279 <term><varname>SyslogLevelPrefix=</varname></term>
4a628360 2280
b8afec21 2281 <listitem><para>Takes a boolean argument. If true and <varname>StandardOutput=</varname> or
eedaf7f3
LP
2282 <varname>StandardError=</varname> are set to <option>journal</option> or <option>kmsg</option> (or to
2283 the same settings in combination with <option>+console</option>), log lines written by the executed
2284 process that are prefixed with a log level will be processed with this log level set but the prefix
2285 removed. If set to false, the interpretation of these prefixes is disabled and the logged lines are
2286 passed on as-is. This only applies to log messages written to stdout or stderr. For details about
2287 this prefixing see
2288 <citerefentry><refentrytitle>sd-daemon</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
b8afec21
LP
2289 Defaults to true.</para></listitem>
2290 </varlistentry>
fdfcb946 2291
b8afec21
LP
2292 <varlistentry>
2293 <term><varname>TTYPath=</varname></term>
4a628360 2294
b8afec21
LP
2295 <listitem><para>Sets the terminal device node to use if standard input, output, or error are connected to a TTY
2296 (see above). Defaults to <filename>/dev/console</filename>.</para></listitem>
2297 </varlistentry>
23a7448e 2298
b8afec21
LP
2299 <varlistentry>
2300 <term><varname>TTYReset=</varname></term>
3536f49e 2301
b8afec21
LP
2302 <listitem><para>Reset the terminal device specified with <varname>TTYPath=</varname> before and after
2303 execution. Defaults to <literal>no</literal>.</para></listitem>
3536f49e
YW
2304 </varlistentry>
2305
189cd8c2 2306 <varlistentry>
b8afec21 2307 <term><varname>TTYVHangup=</varname></term>
189cd8c2 2308
b8afec21
LP
2309 <listitem><para>Disconnect all clients which have opened the terminal device specified with
2310 <varname>TTYPath=</varname> before and after execution. Defaults to <literal>no</literal>.</para></listitem>
189cd8c2
ZJS
2311 </varlistentry>
2312
53f47dfc 2313 <varlistentry>
b8afec21 2314 <term><varname>TTYVTDisallocate=</varname></term>
53f47dfc 2315
b8afec21
LP
2316 <listitem><para>If the terminal device specified with <varname>TTYPath=</varname> is a virtual console
2317 terminal, try to deallocate the TTY before and after execution. This ensures that the screen and scrollback
2318 buffer is cleared. Defaults to <literal>no</literal>.</para></listitem>
189cd8c2 2319 </varlistentry>
b8afec21
LP
2320 </variablelist>
2321 </refsect1>
2322
2323 <refsect1>
2324 <title>System V Compatibility</title>
e0e2ecd5 2325 <variablelist class='unit-directives'>
189cd8c2 2326
f3e43635 2327 <varlistentry>
b8afec21 2328 <term><varname>UtmpIdentifier=</varname></term>
f3e43635 2329
b8afec21
LP
2330 <listitem><para>Takes a four character identifier string for an <citerefentry
2331 project='man-pages'><refentrytitle>utmp</refentrytitle><manvolnum>5</manvolnum></citerefentry> and wtmp entry
2332 for this service. This should only be set for services such as <command>getty</command> implementations (such
2333 as <citerefentry
2334 project='die-net'><refentrytitle>agetty</refentrytitle><manvolnum>8</manvolnum></citerefentry>) where utmp/wtmp
2335 entries must be created and cleared before and after execution, or for services that shall be executed as if
2336 they were run by a <command>getty</command> process (see below). If the configured string is longer than four
2337 characters, it is truncated and the terminal four characters are used. This setting interprets %I style string
2338 replacements. This setting is unset by default, i.e. no utmp/wtmp entries are created or cleaned up for this
2339 service.</para></listitem>
f3e43635
TM
2340 </varlistentry>
2341
f4170c67 2342 <varlistentry>
b8afec21 2343 <term><varname>UtmpMode=</varname></term>
f4170c67 2344
b8afec21
LP
2345 <listitem><para>Takes one of <literal>init</literal>, <literal>login</literal> or <literal>user</literal>. If
2346 <varname>UtmpIdentifier=</varname> is set, controls which type of <citerefentry
2347 project='man-pages'><refentrytitle>utmp</refentrytitle><manvolnum>5</manvolnum></citerefentry>/wtmp entries
2348 for this service are generated. This setting has no effect unless <varname>UtmpIdentifier=</varname> is set
2349 too. If <literal>init</literal> is set, only an <constant>INIT_PROCESS</constant> entry is generated and the
2350 invoked process must implement a <command>getty</command>-compatible utmp/wtmp logic. If
2351 <literal>login</literal> is set, first an <constant>INIT_PROCESS</constant> entry, followed by a
2352 <constant>LOGIN_PROCESS</constant> entry is generated. In this case, the invoked process must implement a
2353 <citerefentry
2354 project='die-net'><refentrytitle>login</refentrytitle><manvolnum>1</manvolnum></citerefentry>-compatible
2355 utmp/wtmp logic. If <literal>user</literal> is set, first an <constant>INIT_PROCESS</constant> entry, then a
2356 <constant>LOGIN_PROCESS</constant> entry and finally a <constant>USER_PROCESS</constant> entry is
2357 generated. In this case, the invoked process may be any process that is suitable to be run as session
2358 leader. Defaults to <literal>init</literal>.</para></listitem>
f4170c67
LP
2359 </varlistentry>
2360
798d3a52
ZJS
2361 </variablelist>
2362 </refsect1>
2363
2364 <refsect1>
2365 <title>Environment variables in spawned processes</title>
2366
00819cc1
LP
2367 <para>Processes started by the service manager are executed with an environment variable block assembled from
2368 multiple sources. Processes started by the system service manager generally do not inherit environment variables
2369 set for the service manager itself (but this may be altered via <varname>PassEnvironment=</varname>), but processes
2370 started by the user service manager instances generally do inherit all environment variables set for the service
2371 manager itself.</para>
2372
2373 <para>For each invoked process the list of environment variables set is compiled from the following sources:</para>
2374
2375 <itemizedlist>
2376 <listitem><para>Variables globally configured for the service manager, using the
2377 <varname>DefaultEnvironment=</varname> setting in
2378 <citerefentry><refentrytitle>systemd-system.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>, the kernel command line option <varname>systemd.setenv=</varname> (see
2379 <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>) or via
2380 <command>systemctl set-environment</command> (see <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>).</para></listitem>
2381
2382 <listitem><para>Variables defined by the service manager itself (see the list below)</para></listitem>
2383
2384 <listitem><para>Variables set in the service manager's own environment variable block (subject to <varname>PassEnvironment=</varname> for the system service manager)</para></listitem>
2385
2386 <listitem><para>Variables set via <varname>Environment=</varname> in the unit file</para></listitem>
2387
606df9a5 2388 <listitem><para>Variables read from files specified via <varname>EnvironmentFile=</varname> in the unit file</para></listitem>
00819cc1 2389
46b07329
LP
2390 <listitem><para>Variables set by any PAM modules in case <varname>PAMName=</varname> is in effect,
2391 cf. <citerefentry
2392 project='man-pages'><refentrytitle>pam_env</refentrytitle><manvolnum>8</manvolnum></citerefentry></para></listitem>
00819cc1
LP
2393 </itemizedlist>
2394
2395 <para>If the same environment variables are set by multiple of these sources, the later source — according to the
2396 order of the list above — wins. Note that as final step all variables listed in
2397 <varname>UnsetEnvironment=</varname> are removed again from the compiled environment variable list, immediately
2398 before it is passed to the executed process.</para>
2399
46b07329
LP
2400 <para>The following select environment variables are set or propagated by the service manager for each invoked
2401 process:</para>
798d3a52
ZJS
2402
2403 <variablelist class='environment-variables'>
2404 <varlistentry>
2405 <term><varname>$PATH</varname></term>
2406
db11487d
ZJS
2407 <listitem><para>Colon-separated list of directories to use when launching
2408 executables. <command>systemd</command> uses a fixed value of
2409 <literal><filename>/usr/local/sbin</filename>:<filename>/usr/local/bin</filename>:<filename>/usr/sbin</filename>:<filename>/usr/bin</filename></literal>
2410 in the system manager. When compiled for systems with "unmerged /usr" (<filename>/bin</filename> is
2411 not a symlink to <filename>/usr/bin</filename>),
2412 <literal>:<filename>/sbin</filename>:<filename>/bin</filename></literal> is appended. In case of the
3602ca6f
ZJS
2413 the user manager, a different path may be configured by the distribution. It is recommended to not
2414 rely on the order of entries, and have only one program with a given name in
2415 <varname>$PATH</varname>.</para></listitem>
798d3a52
ZJS
2416 </varlistentry>
2417
2418 <varlistentry>
2419 <term><varname>$LANG</varname></term>
2420
2421 <listitem><para>Locale. Can be set in
3ba3a79d 2422 <citerefentry project='man-pages'><refentrytitle>locale.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>
798d3a52
ZJS
2423 or on the kernel command line (see
2424 <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>
2425 and
2426 <citerefentry><refentrytitle>kernel-command-line</refentrytitle><manvolnum>7</manvolnum></citerefentry>).
2427 </para></listitem>
2428 </varlistentry>
2429
2430 <varlistentry>
2431 <term><varname>$USER</varname></term>
2432 <term><varname>$LOGNAME</varname></term>
2433 <term><varname>$HOME</varname></term>
2434 <term><varname>$SHELL</varname></term>
2435
2436 <listitem><para>User name (twice), home directory, and the
23deef88
LP
2437 login shell. The variables are set for the units that have
2438 <varname>User=</varname> set, which includes user
2439 <command>systemd</command> instances. See
3ba3a79d 2440 <citerefentry project='die-net'><refentrytitle>passwd</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
798d3a52
ZJS
2441 </para></listitem>
2442 </varlistentry>
2443
4b58153d
LP
2444 <varlistentry>
2445 <term><varname>$INVOCATION_ID</varname></term>
2446
2447 <listitem><para>Contains a randomized, unique 128bit ID identifying each runtime cycle of the unit, formatted
2448 as 32 character hexadecimal string. A new ID is assigned each time the unit changes from an inactive state into
2449 an activating or active state, and may be used to identify this specific runtime cycle, in particular in data
2450 stored offline, such as the journal. The same ID is passed to all processes run as part of the
2451 unit.</para></listitem>
2452 </varlistentry>
2453
798d3a52
ZJS
2454 <varlistentry>
2455 <term><varname>$XDG_RUNTIME_DIR</varname></term>
2456
46b07329
LP
2457 <listitem><para>The directory to use for runtime objects (such as IPC objects) and volatile state. Set for all
2458 services run by the user <command>systemd</command> instance, as well as any system services that use
2459 <varname>PAMName=</varname> with a PAM stack that includes <command>pam_systemd</command>. See below and
2460 <citerefentry><refentrytitle>pam_systemd</refentrytitle><manvolnum>8</manvolnum></citerefentry> for more
2461 information.</para></listitem>
798d3a52
ZJS
2462 </varlistentry>
2463
1f6597a8
ZJS
2464 <varlistentry>
2465 <term><varname>$RUNTIME_DIRECTORY</varname></term>
2466 <term><varname>$STATE_DIRECTORY</varname></term>
2467 <term><varname>$CACHE_DIRECTORY</varname></term>
2468 <term><varname>$LOGS_DIRECTORY</varname></term>
2469 <term><varname>$CONFIGURATION_DIRECTORY</varname></term>
2470
2471 <listitem><para>Contains and absolute paths to the directories defined with
2472 <varname>RuntimeDirectory=</varname>, <varname>StateDirectory=</varname>,
2473 <varname>CacheDirectory=</varname>, <varname>LogsDirectory=</varname>, and
2474 <varname>ConfigurationDirectory=</varname> when those settings are used.</para>
2475 </listitem>
2476 </varlistentry>
2477
798d3a52
ZJS
2478 <varlistentry>
2479 <term><varname>$MAINPID</varname></term>
2480
2dd67817 2481 <listitem><para>The PID of the unit's main process if it is
798d3a52
ZJS
2482 known. This is only set for control processes as invoked by
2483 <varname>ExecReload=</varname> and similar. </para></listitem>
2484 </varlistentry>
2485
2486 <varlistentry>
2487 <term><varname>$MANAGERPID</varname></term>
2488
2489 <listitem><para>The PID of the user <command>systemd</command>
2490 instance, set for processes spawned by it. </para></listitem>
2491 </varlistentry>
2492
2493 <varlistentry>
2494 <term><varname>$LISTEN_FDS</varname></term>
2495 <term><varname>$LISTEN_PID</varname></term>
5c019cf2 2496 <term><varname>$LISTEN_FDNAMES</varname></term>
798d3a52
ZJS
2497
2498 <listitem><para>Information about file descriptors passed to a
2499 service for socket activation. See
2500 <citerefentry><refentrytitle>sd_listen_fds</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
2501 </para></listitem>
2502 </varlistentry>
2503
5c019cf2
EV
2504 <varlistentry>
2505 <term><varname>$NOTIFY_SOCKET</varname></term>
2506
2507 <listitem><para>The socket
2508 <function>sd_notify()</function> talks to. See
2509 <citerefentry><refentrytitle>sd_notify</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
2510 </para></listitem>
2511 </varlistentry>
2512
2513 <varlistentry>
2514 <term><varname>$WATCHDOG_PID</varname></term>
2515 <term><varname>$WATCHDOG_USEC</varname></term>
2516
2517 <listitem><para>Information about watchdog keep-alive notifications. See
2518 <citerefentry><refentrytitle>sd_watchdog_enabled</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
2519 </para></listitem>
2520 </varlistentry>
2521
798d3a52
ZJS
2522 <varlistentry>
2523 <term><varname>$TERM</varname></term>
2524
2525 <listitem><para>Terminal type, set only for units connected to
2526 a terminal (<varname>StandardInput=tty</varname>,
2527 <varname>StandardOutput=tty</varname>, or
2528 <varname>StandardError=tty</varname>). See
2529 <citerefentry project='man-pages'><refentrytitle>termcap</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
2530 </para></listitem>
2531 </varlistentry>
7bce046b
LP
2532
2533 <varlistentry>
2534 <term><varname>$JOURNAL_STREAM</varname></term>
2535
2536 <listitem><para>If the standard output or standard error output of the executed processes are connected to the
2537 journal (for example, by setting <varname>StandardError=journal</varname>) <varname>$JOURNAL_STREAM</varname>
2538 contains the device and inode numbers of the connection file descriptor, formatted in decimal, separated by a
2539 colon (<literal>:</literal>). This permits invoked processes to safely detect whether their standard output or
2540 standard error output are connected to the journal. The device and inode numbers of the file descriptors should
2541 be compared with the values set in the environment variable to determine whether the process output is still
2542 connected to the journal. Note that it is generally not sufficient to only check whether
2543 <varname>$JOURNAL_STREAM</varname> is set at all as services might invoke external processes replacing their
2544 standard output or standard error output, without unsetting the environment variable.</para>
2545
ab2116b1
LP
2546 <para>If both standard output and standard error of the executed processes are connected to the journal via a
2547 stream socket, this environment variable will contain information about the standard error stream, as that's
2548 usually the preferred destination for log data. (Note that typically the same stream is used for both standard
2549 output and standard error, hence very likely the environment variable contains device and inode information
2550 matching both stream file descriptors.)</para>
2551
7bce046b
LP
2552 <para>This environment variable is primarily useful to allow services to optionally upgrade their used log
2553 protocol to the native journal protocol (using
2554 <citerefentry><refentrytitle>sd_journal_print</refentrytitle><manvolnum>3</manvolnum></citerefentry> and other
2555 functions) if their standard output or standard error output is connected to the journal anyway, thus enabling
2556 delivery of structured metadata along with logged messages.</para></listitem>
2557 </varlistentry>
136dc4c4
LP
2558
2559 <varlistentry>
2560 <term><varname>$SERVICE_RESULT</varname></term>
2561
2562 <listitem><para>Only defined for the service unit type, this environment variable is passed to all
2563 <varname>ExecStop=</varname> and <varname>ExecStopPost=</varname> processes, and encodes the service
38a7c3c0
LP
2564 "result". Currently, the following values are defined:</para>
2565
2566 <table>
2567 <title>Defined <varname>$SERVICE_RESULT</varname> values</title>
2568 <tgroup cols='2'>
2569 <colspec colname='result'/>
2570 <colspec colname='meaning'/>
2571 <thead>
2572 <row>
2573 <entry>Value</entry>
2574 <entry>Meaning</entry>
2575 </row>
2576 </thead>
2577
2578 <tbody>
2579 <row>
2580 <entry><literal>success</literal></entry>
e124ccdf 2581 <entry>The service ran successfully and exited cleanly.</entry>
38a7c3c0
LP
2582 </row>
2583 <row>
2584 <entry><literal>protocol</literal></entry>
e124ccdf 2585 <entry>A protocol violation occurred: the service did not take the steps required by its unit configuration (specifically what is configured in its <varname>Type=</varname> setting).</entry>
38a7c3c0
LP
2586 </row>
2587 <row>
2588 <entry><literal>timeout</literal></entry>
e124ccdf 2589 <entry>One of the steps timed out.</entry>
38a7c3c0
LP
2590 </row>
2591 <row>
2592 <entry><literal>exit-code</literal></entry>
e124ccdf 2593 <entry>Service process exited with a non-zero exit code; see <varname>$EXIT_CODE</varname> below for the actual exit code returned.</entry>
38a7c3c0
LP
2594 </row>
2595 <row>
2596 <entry><literal>signal</literal></entry>
e124ccdf 2597 <entry>A service process was terminated abnormally by a signal, without dumping core. See <varname>$EXIT_CODE</varname> below for the actual signal causing the termination.</entry>
38a7c3c0
LP
2598 </row>
2599 <row>
2600 <entry><literal>core-dump</literal></entry>
e124ccdf 2601 <entry>A service process terminated abnormally with a signal and dumped core. See <varname>$EXIT_CODE</varname> below for the signal causing the termination.</entry>
38a7c3c0
LP
2602 </row>
2603 <row>
2604 <entry><literal>watchdog</literal></entry>
e124ccdf 2605 <entry>Watchdog keep-alive ping was enabled for the service, but the deadline was missed.</entry>
38a7c3c0
LP
2606 </row>
2607 <row>
2608 <entry><literal>start-limit-hit</literal></entry>
e124ccdf 2609 <entry>A start limit was defined for the unit and it was hit, causing the unit to fail to start. See <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>'s <varname>StartLimitIntervalSec=</varname> and <varname>StartLimitBurst=</varname> for details.</entry>
38a7c3c0
LP
2610 </row>
2611 <row>
2612 <entry><literal>resources</literal></entry>
2613 <entry>A catch-all condition in case a system operation failed.</entry>
2614 </row>
2615 </tbody>
2616 </tgroup>
2617 </table>
136dc4c4
LP
2618
2619 <para>This environment variable is useful to monitor failure or successful termination of a service. Even
2620 though this variable is available in both <varname>ExecStop=</varname> and <varname>ExecStopPost=</varname>, it
2621 is usually a better choice to place monitoring tools in the latter, as the former is only invoked for services
2622 that managed to start up correctly, and the latter covers both services that failed during their start-up and
2623 those which failed during their runtime.</para></listitem>
2624 </varlistentry>
2625
2626 <varlistentry>
2627 <term><varname>$EXIT_CODE</varname></term>
2628 <term><varname>$EXIT_STATUS</varname></term>
2629
2630 <listitem><para>Only defined for the service unit type, these environment variables are passed to all
2631 <varname>ExecStop=</varname>, <varname>ExecStopPost=</varname> processes and contain exit status/code
2632 information of the main process of the service. For the precise definition of the exit code and status, see
2633 <citerefentry><refentrytitle>wait</refentrytitle><manvolnum>2</manvolnum></citerefentry>. <varname>$EXIT_CODE</varname>
2634 is one of <literal>exited</literal>, <literal>killed</literal>,
2635 <literal>dumped</literal>. <varname>$EXIT_STATUS</varname> contains the numeric exit code formatted as string
2636 if <varname>$EXIT_CODE</varname> is <literal>exited</literal>, and the signal name in all other cases. Note
2637 that these environment variables are only set if the service manager succeeded to start and identify the main
e64e1bfd
ZJS
2638 process of the service.</para>
2639
2640 <table>
2641 <title>Summary of possible service result variable values</title>
2642 <tgroup cols='3'>
2643 <colspec colname='result' />
e64e1bfd 2644 <colspec colname='code' />
a4e26faf 2645 <colspec colname='status' />
e64e1bfd
ZJS
2646 <thead>
2647 <row>
2648 <entry><varname>$SERVICE_RESULT</varname></entry>
e64e1bfd 2649 <entry><varname>$EXIT_CODE</varname></entry>
a4e26faf 2650 <entry><varname>$EXIT_STATUS</varname></entry>
e64e1bfd
ZJS
2651 </row>
2652 </thead>
2653
2654 <tbody>
38a7c3c0 2655 <row>
b1222962
C
2656 <entry morerows="1" valign="top"><literal>success</literal></entry>
2657 <entry valign="top"><literal>killed</literal></entry>
2658 <entry><literal>HUP</literal>, <literal>INT</literal>, <literal>TERM</literal>, <literal>PIPE</literal></entry>
2659 </row>
2660 <row>
38a7c3c0
LP
2661 <entry valign="top"><literal>exited</literal></entry>
2662 <entry><literal>0</literal></entry>
2663 </row>
a4e26faf
JW
2664 <row>
2665 <entry morerows="1" valign="top"><literal>protocol</literal></entry>
2666 <entry valign="top">not set</entry>
2667 <entry>not set</entry>
2668 </row>
2669 <row>
2670 <entry><literal>exited</literal></entry>
2671 <entry><literal>0</literal></entry>
2672 </row>
29df65f9
ZJS
2673 <row>
2674 <entry morerows="1" valign="top"><literal>timeout</literal></entry>
2675 <entry valign="top"><literal>killed</literal></entry>
6757c06a 2676 <entry><literal>TERM</literal>, <literal>KILL</literal></entry>
29df65f9 2677 </row>
29df65f9
ZJS
2678 <row>
2679 <entry valign="top"><literal>exited</literal></entry>
6757c06a
LP
2680 <entry><literal>0</literal>, <literal>1</literal>, <literal>2</literal>, <literal
2681 >3</literal>, …, <literal>255</literal></entry>
29df65f9 2682 </row>
e64e1bfd
ZJS
2683 <row>
2684 <entry valign="top"><literal>exit-code</literal></entry>
2685 <entry valign="top"><literal>exited</literal></entry>
38a7c3c0 2686 <entry><literal>1</literal>, <literal>2</literal>, <literal
6757c06a 2687 >3</literal>, …, <literal>255</literal></entry>
e64e1bfd 2688 </row>
e64e1bfd
ZJS
2689 <row>
2690 <entry valign="top"><literal>signal</literal></entry>
2691 <entry valign="top"><literal>killed</literal></entry>
6757c06a 2692 <entry><literal>HUP</literal>, <literal>INT</literal>, <literal>KILL</literal>, …</entry>
e64e1bfd 2693 </row>
e64e1bfd
ZJS
2694 <row>
2695 <entry valign="top"><literal>core-dump</literal></entry>
2696 <entry valign="top"><literal>dumped</literal></entry>
6757c06a 2697 <entry><literal>ABRT</literal>, <literal>SEGV</literal>, <literal>QUIT</literal>, …</entry>
e64e1bfd 2698 </row>
e64e1bfd
ZJS
2699 <row>
2700 <entry morerows="2" valign="top"><literal>watchdog</literal></entry>
2701 <entry><literal>dumped</literal></entry>
2702 <entry><literal>ABRT</literal></entry>
2703 </row>
2704 <row>
2705 <entry><literal>killed</literal></entry>
6757c06a 2706 <entry><literal>TERM</literal>, <literal>KILL</literal></entry>
e64e1bfd
ZJS
2707 </row>
2708 <row>
2709 <entry><literal>exited</literal></entry>
6757c06a
LP
2710 <entry><literal>0</literal>, <literal>1</literal>, <literal>2</literal>, <literal
2711 >3</literal>, …, <literal>255</literal></entry>
e64e1bfd 2712 </row>
b1222962
C
2713 <row>
2714 <entry valign="top"><literal>exec-condition</literal></entry>
2715 <entry><literal>exited</literal></entry>
2716 <entry><literal>1</literal>, <literal>2</literal>, <literal>3</literal>, <literal
2717 >4</literal>, …, <literal>254</literal></entry>
2718 </row>
2719 <row>
2720 <entry valign="top"><literal>oom-kill</literal></entry>
2721 <entry valign="top"><literal>killed</literal></entry>
2722 <entry><literal>TERM</literal>, <literal>KILL</literal></entry>
2723 </row>
38a7c3c0
LP
2724 <row>
2725 <entry><literal>start-limit-hit</literal></entry>
2726 <entry>not set</entry>
2727 <entry>not set</entry>
2728 </row>
e64e1bfd
ZJS
2729 <row>
2730 <entry><literal>resources</literal></entry>
2731 <entry>any of the above</entry>
2732 <entry>any of the above</entry>
2733 </row>
29df65f9 2734 <row>
38a7c3c0 2735 <entry namest="results" nameend="status">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 <literal>timeout</literal> and <literal>watchdog</literal> rows above only the signals that systemd sends have been included. Moreover, using <varname>SuccessExitStatus=</varname> additional exit statuses may be declared to indicate clean termination, which is not reflected by this table.</entry>
29df65f9 2736 </row>
e64e1bfd
ZJS
2737 </tbody>
2738 </tgroup>
2739 </table>
2740
2741 </listitem>
2742 </varlistentry>
dcf3c3c3
LP
2743
2744 <varlistentry>
2745 <term><varname>$PIDFILE</varname></term>
2746
2747 <listitem><para>The path to the configured PID file, in case the process is forked off on behalf of a
2748 service that uses the <varname>PIDFile=</varname> setting, see
2749 <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>
2750 for details. Service code may use this environment variable to automatically generate a PID file at
2751 the location configured in the unit file. This field is set to an absolute path in the file
2752 system.</para></listitem>
2753 </varlistentry>
2754
798d3a52 2755 </variablelist>
46b07329
LP
2756
2757 <para>For system services, when <varname>PAMName=</varname> is enabled and <command>pam_systemd</command> is part
2758 of the selected PAM stack, additional environment variables defined by systemd may be set for
2759 services. Specifically, these are <varname>$XDG_SEAT</varname>, <varname>$XDG_VTNR</varname>, see
2760 <citerefentry><refentrytitle>pam_systemd</refentrytitle><manvolnum>8</manvolnum></citerefentry> for details.</para>
798d3a52
ZJS
2761 </refsect1>
2762
91a8f867
JS
2763 <refsect1>
2764 <title>Process exit codes</title>
2765
2766 <para>When invoking a unit process the service manager possibly fails to apply the execution parameters configured
2767 with the settings above. In that case the already created service process will exit with a non-zero exit code
2768 before the configured command line is executed. (Or in other words, the child process possibly exits with these
2769 error codes, after having been created by the <citerefentry
2770 project='man-pages'><refentrytitle>fork</refentrytitle><manvolnum>2</manvolnum></citerefentry> system call, but
2771 before the matching <citerefentry
2772 project='man-pages'><refentrytitle>execve</refentrytitle><manvolnum>2</manvolnum></citerefentry> system call is
2773 called.) Specifically, exit codes defined by the C library, by the LSB specification and by the systemd service
2774 manager itself are used.</para>
2775
2776 <para>The following basic service exit codes are defined by the C library.</para>
2777
2778 <table>
2779 <title>Basic C library exit codes</title>
2780 <tgroup cols='3'>
2781 <thead>
2782 <row>
2783 <entry>Exit Code</entry>
2784 <entry>Symbolic Name</entry>
2785 <entry>Description</entry>
2786 </row>
2787 </thead>
2788 <tbody>
2789 <row>
2790 <entry>0</entry>
2791 <entry><constant>EXIT_SUCCESS</constant></entry>
2792 <entry>Generic success code.</entry>
2793 </row>
2794 <row>
2795 <entry>1</entry>
2796 <entry><constant>EXIT_FAILURE</constant></entry>
2797 <entry>Generic failure or unspecified error.</entry>
2798 </row>
2799 </tbody>
2800 </tgroup>
2801 </table>
2802
2803 <para>The following service exit codes are defined by the <ulink
29a3d5ca 2804 url="https://refspecs.linuxbase.org/LSB_5.0.0/LSB-Core-generic/LSB-Core-generic/iniscrptact.html">LSB specification</ulink>.
91a8f867
JS
2805 </para>
2806
2807 <table>
2808 <title>LSB service exit codes</title>
2809 <tgroup cols='3'>
2810 <thead>
2811 <row>
2812 <entry>Exit Code</entry>
2813 <entry>Symbolic Name</entry>
2814 <entry>Description</entry>
2815 </row>
2816 </thead>
2817 <tbody>
2818 <row>
2819 <entry>2</entry>
2820 <entry><constant>EXIT_INVALIDARGUMENT</constant></entry>
2821 <entry>Invalid or excess arguments.</entry>
2822 </row>
2823 <row>
2824 <entry>3</entry>
2825 <entry><constant>EXIT_NOTIMPLEMENTED</constant></entry>
2826 <entry>Unimplemented feature.</entry>
2827 </row>
2828 <row>
2829 <entry>4</entry>
2830 <entry><constant>EXIT_NOPERMISSION</constant></entry>
2831 <entry>The user has insufficient privileges.</entry>
2832 </row>
2833 <row>
2834 <entry>5</entry>
2835 <entry><constant>EXIT_NOTINSTALLED</constant></entry>
2836 <entry>The program is not installed.</entry>
2837 </row>
2838 <row>
2839 <entry>6</entry>
2840 <entry><constant>EXIT_NOTCONFIGURED</constant></entry>
2841 <entry>The program is not configured.</entry>
2842 </row>
2843 <row>
2844 <entry>7</entry>
2845 <entry><constant>EXIT_NOTRUNNING</constant></entry>
2846 <entry>The program is not running.</entry>
2847 </row>
2848 </tbody>
2849 </tgroup>
2850 </table>
2851
2852 <para>
2853 The LSB specification suggests that error codes 200 and above are reserved for implementations. Some of them are
2854 used by the service manager to indicate problems during process invocation:
2855 </para>
2856 <table>
2857 <title>systemd-specific exit codes</title>
2858 <tgroup cols='3'>
2859 <thead>
2860 <row>
2861 <entry>Exit Code</entry>
2862 <entry>Symbolic Name</entry>
2863 <entry>Description</entry>
2864 </row>
2865 </thead>
2866 <tbody>
2867 <row>
2868 <entry>200</entry>
2869 <entry><constant>EXIT_CHDIR</constant></entry>
2870 <entry>Changing to the requested working directory failed. See <varname>WorkingDirectory=</varname> above.</entry>
2871 </row>
2872 <row>
2873 <entry>201</entry>
2874 <entry><constant>EXIT_NICE</constant></entry>
2875 <entry>Failed to set up process scheduling priority (nice level). See <varname>Nice=</varname> above.</entry>
2876 </row>
2877 <row>
2878 <entry>202</entry>
2879 <entry><constant>EXIT_FDS</constant></entry>
2880 <entry>Failed to close unwanted file descriptors, or to adjust passed file descriptors.</entry>
2881 </row>
2882 <row>
2883 <entry>203</entry>
2884 <entry><constant>EXIT_EXEC</constant></entry>
2885 <entry>The actual process execution failed (specifically, the <citerefentry project='man-pages'><refentrytitle>execve</refentrytitle><manvolnum>2</manvolnum></citerefentry> system call). Most likely this is caused by a missing or non-accessible executable file.</entry>
2886 </row>
2887 <row>
2888 <entry>204</entry>
2889 <entry><constant>EXIT_MEMORY</constant></entry>
2890 <entry>Failed to perform an action due to memory shortage.</entry>
2891 </row>
2892 <row>
2893 <entry>205</entry>
2894 <entry><constant>EXIT_LIMITS</constant></entry>
dcfaecc7 2895 <entry>Failed to adjust resource limits. See <varname>LimitCPU=</varname> and related settings above.</entry>
91a8f867
JS
2896 </row>
2897 <row>
2898 <entry>206</entry>
2899 <entry><constant>EXIT_OOM_ADJUST</constant></entry>
2900 <entry>Failed to adjust the OOM setting. See <varname>OOMScoreAdjust=</varname> above.</entry>
2901 </row>
2902 <row>
2903 <entry>207</entry>
2904 <entry><constant>EXIT_SIGNAL_MASK</constant></entry>
2905 <entry>Failed to set process signal mask.</entry>
2906 </row>
2907 <row>
2908 <entry>208</entry>
2909 <entry><constant>EXIT_STDIN</constant></entry>
2910 <entry>Failed to set up standard input. See <varname>StandardInput=</varname> above.</entry>
2911 </row>
2912 <row>
2913 <entry>209</entry>
2914 <entry><constant>EXIT_STDOUT</constant></entry>
2915 <entry>Failed to set up standard output. See <varname>StandardOutput=</varname> above.</entry>
2916 </row>
2917 <row>
2918 <entry>210</entry>
2919 <entry><constant>EXIT_CHROOT</constant></entry>
2920 <entry>Failed to change root directory (<citerefentry project='man-pages'><refentrytitle>chroot</refentrytitle><manvolnum>2</manvolnum></citerefentry>). See <varname>RootDirectory=</varname>/<varname>RootImage=</varname> above.</entry>
2921 </row>
2922 <row>
2923 <entry>211</entry>
2924 <entry><constant>EXIT_IOPRIO</constant></entry>
2925 <entry>Failed to set up IO scheduling priority. See <varname>IOSchedulingClass=</varname>/<varname>IOSchedulingPriority=</varname> above.</entry>
2926 </row>
2927 <row>
2928 <entry>212</entry>
2929 <entry><constant>EXIT_TIMERSLACK</constant></entry>
2930 <entry>Failed to set up timer slack. See <varname>TimerSlackNSec=</varname> above.</entry>
2931 </row>
2932 <row>
2933 <entry>213</entry>
2934 <entry><constant>EXIT_SECUREBITS</constant></entry>
2935 <entry>Failed to set process secure bits. See <varname>SecureBits=</varname> above.</entry>
2936 </row>
2937 <row>
2938 <entry>214</entry>
2939 <entry><constant>EXIT_SETSCHEDULER</constant></entry>
2940 <entry>Failed to set up CPU scheduling. See <varname>CPUSchedulingPolicy=</varname>/<varname>CPUSchedulingPriority=</varname> above.</entry>
2941 </row>
2942 <row>
2943 <entry>215</entry>
2944 <entry><constant>EXIT_CPUAFFINITY</constant></entry>
2945 <entry>Failed to set up CPU affinity. See <varname>CPUAffinity=</varname> above.</entry>
2946 </row>
2947 <row>
2948 <entry>216</entry>
2949 <entry><constant>EXIT_GROUP</constant></entry>
2950 <entry>Failed to determine or change group credentials. See <varname>Group=</varname>/<varname>SupplementaryGroups=</varname> above.</entry>
2951 </row>
2952 <row>
2953 <entry>217</entry>
2954 <entry><constant>EXIT_USER</constant></entry>
2955 <entry>Failed to determine or change user credentials, or to set up user namespacing. See <varname>User=</varname>/<varname>PrivateUsers=</varname> above.</entry>
2956 </row>
2957 <row>
2958 <entry>218</entry>
2959 <entry><constant>EXIT_CAPABILITIES</constant></entry>
2960 <entry>Failed to drop capabilities, or apply ambient capabilities. See <varname>CapabilityBoundingSet=</varname>/<varname>AmbientCapabilities=</varname> above.</entry>
2961 </row>
2962 <row>
2963 <entry>219</entry>
2964 <entry><constant>EXIT_CGROUP</constant></entry>
2965 <entry>Setting up the service control group failed.</entry>
2966 </row>
2967 <row>
2968 <entry>220</entry>
2969 <entry><constant>EXIT_SETSID</constant></entry>
2970 <entry>Failed to create new process session.</entry>
2971 </row>
2972 <row>
2973 <entry>221</entry>
2974 <entry><constant>EXIT_CONFIRM</constant></entry>
2975 <entry>Execution has been cancelled by the user. See the <varname>systemd.confirm_spawn=</varname> kernel command line setting on <citerefentry><refentrytitle>kernel-command-line</refentrytitle><manvolnum>7</manvolnum></citerefentry> for details.</entry>
2976 </row>
2977 <row>
2978 <entry>222</entry>
2979 <entry><constant>EXIT_STDERR</constant></entry>
2980 <entry>Failed to set up standard error output. See <varname>StandardError=</varname> above.</entry>
2981 </row>
2982 <row>
2983 <entry>224</entry>
2984 <entry><constant>EXIT_PAM</constant></entry>
2985 <entry>Failed to set up PAM session. See <varname>PAMName=</varname> above.</entry>
2986 </row>
2987 <row>
2988 <entry>225</entry>
2989 <entry><constant>EXIT_NETWORK</constant></entry>
2990 <entry>Failed to set up network namespacing. See <varname>PrivateNetwork=</varname> above.</entry>
2991 </row>
2992 <row>
2993 <entry>226</entry>
2994 <entry><constant>EXIT_NAMESPACE</constant></entry>
2995 <entry>Failed to set up mount namespacing. See <varname>ReadOnlyPaths=</varname> and related settings above.</entry>
2996 </row>
2997 <row>
2998 <entry>227</entry>
2999 <entry><constant>EXIT_NO_NEW_PRIVILEGES</constant></entry>
dcfaecc7 3000 <entry>Failed to disable new privileges. See <varname>NoNewPrivileges=yes</varname> above.</entry>
91a8f867
JS
3001 </row>
3002 <row>
3003 <entry>228</entry>
3004 <entry><constant>EXIT_SECCOMP</constant></entry>
3005 <entry>Failed to apply system call filters. See <varname>SystemCallFilter=</varname> and related settings above.</entry>
3006 </row>
3007 <row>
3008 <entry>229</entry>
3009 <entry><constant>EXIT_SELINUX_CONTEXT</constant></entry>
3010 <entry>Determining or changing SELinux context failed. See <varname>SELinuxContext=</varname> above.</entry>
3011 </row>
3012 <row>
3013 <entry>230</entry>
3014 <entry><constant>EXIT_PERSONALITY</constant></entry>
dcfaecc7 3015 <entry>Failed to set up an execution domain (personality). See <varname>Personality=</varname> above.</entry>
91a8f867
JS
3016 </row>
3017 <row>
3018 <entry>231</entry>
3019 <entry><constant>EXIT_APPARMOR_PROFILE</constant></entry>
3020 <entry>Failed to prepare changing AppArmor profile. See <varname>AppArmorProfile=</varname> above.</entry>
3021 </row>
3022 <row>
3023 <entry>232</entry>
3024 <entry><constant>EXIT_ADDRESS_FAMILIES</constant></entry>
3025 <entry>Failed to restrict address families. See <varname>RestrictAddressFamilies=</varname> above.</entry>
3026 </row>
3027 <row>
3028 <entry>233</entry>
3029 <entry><constant>EXIT_RUNTIME_DIRECTORY</constant></entry>
3030 <entry>Setting up runtime directory failed. See <varname>RuntimeDirectory=</varname> and related settings above.</entry>
3031 </row>
3032 <row>
3033 <entry>235</entry>
3034 <entry><constant>EXIT_CHOWN</constant></entry>
3035 <entry>Failed to adjust socket ownership. Used for socket units only.</entry>
3036 </row>
3037 <row>
3038 <entry>236</entry>
3039 <entry><constant>EXIT_SMACK_PROCESS_LABEL</constant></entry>
3040 <entry>Failed to set SMACK label. See <varname>SmackProcessLabel=</varname> above.</entry>
3041 </row>
3042 <row>
3043 <entry>237</entry>
3044 <entry><constant>EXIT_KEYRING</constant></entry>
3045 <entry>Failed to set up kernel keyring.</entry>
3046 </row>
3047 <row>
3048 <entry>238</entry>
3049 <entry><constant>EXIT_STATE_DIRECTORY</constant></entry>
dcfaecc7 3050 <entry>Failed to set up unit's state directory. See <varname>StateDirectory=</varname> above.</entry>
91a8f867
JS
3051 </row>
3052 <row>
3053 <entry>239</entry>
3054 <entry><constant>EXIT_CACHE_DIRECTORY</constant></entry>
dcfaecc7 3055 <entry>Failed to set up unit's cache directory. See <varname>CacheDirectory=</varname> above.</entry>
91a8f867
JS
3056 </row>
3057 <row>
3058 <entry>240</entry>
3059 <entry><constant>EXIT_LOGS_DIRECTORY</constant></entry>
dcfaecc7 3060 <entry>Failed to set up unit's logging directory. See <varname>LogsDirectory=</varname> above.</entry>
91a8f867
JS
3061 </row>
3062 <row>
3063 <entry>241</entry>
3064 <entry><constant>EXIT_CONFIGURATION_DIRECTORY</constant></entry>
dcfaecc7 3065 <entry>Failed to set up unit's configuration directory. See <varname>ConfigurationDirectory=</varname> above.</entry>
91a8f867 3066 </row>
b070c7c0
MS
3067 <row>
3068 <entry>242</entry>
3069 <entry><constant>EXIT_NUMA_POLICY</constant></entry>
3070 <entry>Failed to set up unit's NUMA memory policy. See <varname>NUMAPolicy=</varname> and <varname>NUMAMask=</varname>above.</entry>
3071 </row>
3072
91a8f867
JS
3073 </tbody>
3074 </tgroup>
3075 </table>
3e0bff7d
LP
3076
3077 <para>Finally, the BSD operating systems define a set of exit codes, typically defined on Linux systems too:</para>
3078
3079 <table>
3080 <title>BSD exit codes</title>
3081 <tgroup cols='3'>
3082 <thead>
3083 <row>
3084 <entry>Exit Code</entry>
3085 <entry>Symbolic Name</entry>
3086 <entry>Description</entry>
3087 </row>
3088 </thead>
3089 <tbody>
3090 <row>
3091 <entry>64</entry>
3092 <entry><constant>EX_USAGE</constant></entry>
3093 <entry>Command line usage error</entry>
3094 </row>
3095 <row>
3096 <entry>65</entry>
3097 <entry><constant>EX_DATAERR</constant></entry>
3098 <entry>Data format error</entry>
3099 </row>
3100 <row>
3101 <entry>66</entry>
3102 <entry><constant>EX_NOINPUT</constant></entry>
3103 <entry>Cannot open input</entry>
3104 </row>
3105 <row>
3106 <entry>67</entry>
3107 <entry><constant>EX_NOUSER</constant></entry>
3108 <entry>Addressee unknown</entry>
3109 </row>
3110 <row>
3111 <entry>68</entry>
3112 <entry><constant>EX_NOHOST</constant></entry>
3113 <entry>Host name unknown</entry>
3114 </row>
3115 <row>
3116 <entry>69</entry>
3117 <entry><constant>EX_UNAVAILABLE</constant></entry>
3118 <entry>Service unavailable</entry>
3119 </row>
3120 <row>
3121 <entry>70</entry>
3122 <entry><constant>EX_SOFTWARE</constant></entry>
3123 <entry>internal software error</entry>
3124 </row>
3125 <row>
3126 <entry>71</entry>
3127 <entry><constant>EX_OSERR</constant></entry>
3128 <entry>System error (e.g., can't fork)</entry>
3129 </row>
3130 <row>
3131 <entry>72</entry>
3132 <entry><constant>EX_OSFILE</constant></entry>
3133 <entry>Critical OS file missing</entry>
3134 </row>
3135 <row>
3136 <entry>73</entry>
3137 <entry><constant>EX_CANTCREAT</constant></entry>
3138 <entry>Can't create (user) output file</entry>
3139 </row>
3140 <row>
3141 <entry>74</entry>
3142 <entry><constant>EX_IOERR</constant></entry>
3143 <entry>Input/output error</entry>
3144 </row>
3145 <row>
3146 <entry>75</entry>
3147 <entry><constant>EX_TEMPFAIL</constant></entry>
3148 <entry>Temporary failure; user is invited to retry</entry>
3149 </row>
3150 <row>
3151 <entry>76</entry>
3152 <entry><constant>EX_PROTOCOL</constant></entry>
3153 <entry>Remote error in protocol</entry>
3154 </row>
3155 <row>
3156 <entry>77</entry>
3157 <entry><constant>EX_NOPERM</constant></entry>
3158 <entry>Permission denied</entry>
3159 </row>
3160 <row>
3161 <entry>78</entry>
3162 <entry><constant>EX_CONFIG</constant></entry>
3163 <entry>Configuration error</entry>
3164 </row>
3165 </tbody>
3166 </tgroup>
3167 </table>
91a8f867
JS
3168 </refsect1>
3169
798d3a52
ZJS
3170 <refsect1>
3171 <title>See Also</title>
3172 <para>
3173 <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
3174 <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
869feb33 3175 <citerefentry><refentrytitle>systemd-analyze</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
68d838f7 3176 <citerefentry><refentrytitle>journalctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
d1698b82 3177 <citerefentry><refentrytitle>systemd-system.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
798d3a52
ZJS
3178 <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
3179 <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
3180 <citerefentry><refentrytitle>systemd.socket</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
3181 <citerefentry><refentrytitle>systemd.swap</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
3182 <citerefentry><refentrytitle>systemd.mount</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
3183 <citerefentry><refentrytitle>systemd.kill</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
3184 <citerefentry><refentrytitle>systemd.resource-control</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
a4c18002 3185 <citerefentry><refentrytitle>systemd.time</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
798d3a52
ZJS
3186 <citerefentry><refentrytitle>systemd.directives</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
3187 <citerefentry><refentrytitle>tmpfiles.d</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
3188 <citerefentry project='man-pages'><refentrytitle>exec</refentrytitle><manvolnum>3</manvolnum></citerefentry>
3189 </para>
3190 </refsect1>
dd1eb43b
LP
3191
3192</refentry>