mirrors/systemd
0
0
Fork 0
mirror of https://github.com/systemd/systemd.git synced 2024-11-24 10:43:35 +08:00
Code Issues Packages Projects Releases Wiki Activity
b1b16aa977
systemd/man/systemd.exec.xml

4664 lines
294 KiB
XML
Raw Normal View History

man: drop mode line in file headers This is already included in .dir-locals, so we don't need it in the files themselves.
2018-07-03 05:15:39 +08:00
<?xml version='1.0'?>
man: use same header for all files The "include" files had type "book" for some raeason. I don't think this is meaningful. Let's just use the same everywhere. $ perl -i -0pe 's^..DOCTYPE (book|refentry) PUBLIC "-//OASIS//DTD DocBook XML V4.[25]//EN"\s+"http^<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"\n "http^gms' man/*.xml
2019-03-14 21:40:58 +08:00
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
man: revert dynamic paths for split-usr setups This did not really work out as we had hoped. Trying to do this upstream introduced several problems that probably makes it better suited as a downstream patch after all. At any rate, it is not releaseable in the current state, so we at least need to revert this before the release. * by adjusting the path to binaries, but not do the same thing to the search path we end up with inconsistent man-pages. Adjusting the search path too would be quite messy, and it is not at all obvious that this is worth the effort, but at any rate it would have to be done before we could ship this. * this means that distributed man-pages does not make sense as they depend on config options, and for better or worse we are still distributing man pages, so that is something that definitely needs sorting out before we could ship with this patch. * we have long held that split-usr is only minimally supported in order to boot, and something we hope will eventually go away. So before we start adding even more magic/effort in order to make this work nicely, we should probably question if it makes sense at all.
2015-06-19 01:47:44 +08:00
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
license: LGPL-2.1+ -> LGPL-2.1-or-later
2020-11-09 12:23:58 +08:00
<!-- SPDX-License-Identifier: LGPL-2.1-or-later -->
man: document execution context related settings
2010-07-03 05:24:38 +08:00
man: say explicitly which settings are not available in --user services Fixes: #3944
2019-03-14 00:24:24 +08:00
<refentry id="systemd.exec" xmlns:xi="http://www.w3.org/2001/XInclude">
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
<refentryinfo>
<title>systemd.exec</title>
<productname>systemd</productname>
</refentryinfo>
<refmeta>
<refentrytitle>systemd.exec</refentrytitle>
<manvolnum>5</manvolnum>
</refmeta>
<refnamediv>
<refname>systemd.exec</refname>
<refpurpose>Execution environment configuration</refpurpose>
</refnamediv>
<refsynopsisdiv>
<para><filename><replaceable>service</replaceable>.service</filename>,
<filename><replaceable>socket</replaceable>.socket</filename>,
<filename><replaceable>mount</replaceable>.mount</filename>,
<filename><replaceable>swap</replaceable>.swap</filename></para>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
<para>Unit configuration files for services, sockets, mount points, and swap devices share a subset of
configuration options which define the execution environment of spawned processes.</para>
<para>This man page lists the configuration options shared by these four unit types. See
<citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry> for the common
options of all unit configuration files, and
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
<citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
<citerefentry><refentrytitle>systemd.socket</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
<citerefentry><refentrytitle>systemd.swap</refentrytitle><manvolnum>5</manvolnum></citerefentry>, and
<citerefentry><refentrytitle>systemd.mount</refentrytitle><manvolnum>5</manvolnum></citerefentry> for more
information on the specific unit configuration files. The execution specific configuration options are configured
in the [Service], [Socket], [Mount], or [Swap] sections, depending on the unit type.</para>
man: add crosslink between systemd.resource-control(5) and systemd.exec(5) Fixes #4379.
2016-10-16 02:17:05 +08:00
man: avoid abbreviated "cgroups" terminology (#4396) Let's avoid the overly abbreviated "cgroups" terminology. Let's instead write: "Linux Control Groups (cgroups)" is the long form wherever the term is introduced in prose. Use "control groups" in the short form wherever the term is used within brief explanations. Follow-up to: #4381
2016-10-17 21:50:26 +08:00
<para>In addition, options which control resources through Linux Control Groups (cgroups) are listed in
man: add crosslink between systemd.resource-control(5) and systemd.exec(5) Fixes #4379.
2016-10-16 02:17:05 +08:00
<citerefentry><refentrytitle>systemd.resource-control</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
Those options complement options listed here.</para>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
</refsect1>
man: document automatic dependencies For all units ensure there's an "Automatic Dependencies" section in the man page, and explain which dependencies are automatically added in all cases, and which ones are added on top if DefaultDependencies=yes is set. This is also done for systemd.exec(5), systemd.resource-control(5) and systemd.unit(5) as these pages describe common behaviour of various unit types.
2015-11-12 03:47:07 +08:00
<refsect1>
man: explicitly distinguish "implicit dependencies" and "default dependencies" Fixes: #6793
2017-09-12 12:02:27 +08:00
<title>Implicit Dependencies</title>
<para>A few execution parameters result in additional, automatic dependencies to be added:</para>
<itemizedlist>
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
<listitem><para>Units with <varname>WorkingDirectory=</varname>, <varname>RootDirectory=</varname>,
<varname>RootImage=</varname>, <varname>RuntimeDirectory=</varname>, <varname>StateDirectory=</varname>,
<varname>CacheDirectory=</varname>, <varname>LogsDirectory=</varname> or
<varname>ConfigurationDirectory=</varname> set automatically gain dependencies of type
<varname>Requires=</varname> and <varname>After=</varname> on all mount units required to access the specified
man: Add some punctuation; remove double spaces.
2022-06-15 01:42:59 +08:00
paths. This is equivalent to having them listed explicitly in
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
<varname>RequiresMountsFor=</varname>.</para></listitem>
man: use trailing slash on directories in more places
2020-10-06 00:08:21 +08:00
<listitem><para>Similarly, units with <varname>PrivateTmp=</varname> enabled automatically get mount
unit dependencies for all mounts required to access <filename>/tmp/</filename> and
<filename>/var/tmp/</filename>. They will also gain an automatic <varname>After=</varname> dependency
on
<citerefentry><refentrytitle>systemd-tmpfiles-setup.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
</para></listitem>
man: explicitly distinguish "implicit dependencies" and "default dependencies" Fixes: #6793
2017-09-12 12:02:27 +08:00
man: drop some left-over mentions of StandardOutput=syslog We dropped them from the StandardOuput= documentation long ago, but elswhere some references where lurking.
2020-05-14 18:19:46 +08:00
<listitem><para>Units whose standard output or error output is connected to <option>journal</option> or
<option>kmsg</option> (or their combinations with console output, see below) automatically acquire
Revert "pid1: order units using TTYVHangup= after vconsole setup" This reverts commit e019ea738d63d5f7803f378f8bd3e074d66be08f. In the new approach, a lock on /dev/console will be used. This lock will solve the issue for services which run in early boot. Services which run later are ordered after sysinit.target, so they'll run much later anyway so this automatic dependency is not useful. Let's remove it again to make the code simpler.
2023-07-12 20:32:54 +08:00
dependencies of type <varname>After=</varname> on
<filename>systemd-journald.socket</filename>.</para></listitem>
man: document LogNamespace= unit setting
2019-11-28 17:02:02 +08:00
<listitem><para>Units using <varname>LogNamespace=</varname> will automatically gain ordering and
requirement dependencies on the two socket units associated with
<filename>systemd-journald@.service</filename> instances.</para></listitem>
man: explicitly distinguish "implicit dependencies" and "default dependencies" Fixes: #6793
2017-09-12 12:02:27 +08:00
</itemizedlist>
man: document automatic dependencies For all units ensure there's an "Automatic Dependencies" section in the man page, and explain which dependencies are automatically added in all cases, and which ones are added on top if DefaultDependencies=yes is set. This is also done for systemd.exec(5), systemd.resource-control(5) and systemd.unit(5) as these pages describe common behaviour of various unit types.
2015-11-12 03:47:07 +08:00
</refsect1>
man: explicitly distinguish "implicit dependencies" and "default dependencies" Fixes: #6793
2017-09-12 12:02:27 +08:00
<!-- We don't have any default dependency here. -->
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
<refsect1>
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
<title>Paths</title>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
man: Mention that paths in unit files must be fully normalized. Related to issues #9107 and #9498 and PRs #9149 and #9157.
2018-07-05 23:06:54 +08:00
<para>The following settings may be used to change a service's view of the filesystem. Please note that the paths
must be absolute and must not contain a <literal>..</literal> path component.</para>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
<variablelist class='unit-directives'>
core: Add ExecSearchPath parameter to specify the directory relative to which binaries executed by Exec*= should be found Currently there does not exist a way to specify a path relative to which all binaries executed by Exec should be found. The only way is to specify the absolute path. This change implements the functionality to specify a path relative to which binaries executed by Exec*= can be found. Closes #6308
2021-07-09 08:10:47 +08:00
<varlistentry>
<term><varname>ExecSearchPath=</varname></term>
<listitem><para>Takes a colon separated list of absolute paths relative to which the executable
used by the <varname>Exec*=</varname> (e.g. <varname>ExecStart=</varname>,
<varname>ExecStop=</varname>, etc.) properties can be found. <varname>ExecSearchPath=</varname>
overrides <varname>$PATH</varname> if <varname>$PATH</varname> is not supplied by the user through
<varname>Environment=</varname>, <varname>EnvironmentFile=</varname> or
<varname>PassEnvironment=</varname>. Assigning an empty string removes previous assignments
and setting <varname>ExecSearchPath=</varname> to a value multiple times will append
to the previous setting.
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-23 00:52:36 +08:00
</para>
<xi:include href="version-info.xml" xpointer="v250"/></listitem>
core: Add ExecSearchPath parameter to specify the directory relative to which binaries executed by Exec*= should be found Currently there does not exist a way to specify a path relative to which all binaries executed by Exec should be found. The only way is to specify the absolute path. This change implements the functionality to specify a path relative to which binaries executed by Exec*= can be found. Closes #6308
2021-07-09 08:10:47 +08:00
</varlistentry>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
<varlistentry>
<term><varname>WorkingDirectory=</varname></term>
core: add new PrivateUsers= option to service execution This setting adds minimal user namespacing support to a service. When set the invoked processes will run in their own user namespace. Only a trivial mapping will be set up: the root user/group is mapped to root, and the user/group of the service will be mapped to itself, everything else is mapped to nobody. If this setting is used the service runs with no capabilities on the host, but configurable capabilities within the service. This setting is particularly useful in conjunction with RootDirectory= as the need to synchronize /etc/passwd and /etc/group between the host and the service OS tree is reduced, as only three UID/GIDs need to match: root, nobody and the user of the service itself. But even outside the RootDirectory= case this setting is useful to substantially reduce the attack surface of a service. Example command to test this: systemd-run -p PrivateUsers=1 -p User=foobar -t /bin/sh This runs a shell as user "foobar". When typing "ps" only processes owned by "root", by "foobar", and by "nobody" should be visible.
2016-08-04 00:44:51 +08:00
<listitem><para>Takes a directory path relative to the service's root directory specified by
<varname>RootDirectory=</varname>, or the special value <literal>~</literal>. Sets the working directory for
executed processes. If set to <literal>~</literal>, the home directory of the user specified in
<varname>User=</varname> is used. If not set, defaults to the root directory when systemd is running as a
system instance and the respective user's home directory if run as user. If the setting is prefixed with the
<literal>-</literal> character, a missing working directory is not considered fatal. If
core: add RootImage= setting for using a specific image file as root directory for a service This is similar to RootDirectory= but mounts the root file system from a block device or loopback file instead of another directory. This reuses the image dissector code now used by nspawn and gpt-auto-discovery.
2016-12-23 21:26:05 +08:00
<varname>RootDirectory=</varname>/<varname>RootImage=</varname> is not set, then
man: Add some punctuation; remove double spaces.
2022-06-15 01:42:59 +08:00
<varname>WorkingDirectory=</varname> is relative to the root of the system running the service manager. Note
core: add RootImage= setting for using a specific image file as root directory for a service This is similar to RootDirectory= but mounts the root file system from a block device or loopback file instead of another directory. This reuses the image dissector code now used by nspawn and gpt-auto-discovery.
2016-12-23 21:26:05 +08:00
that setting this parameter might result in additional dependencies to be added to the unit (see
above).</para></listitem>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
</varlistentry>
<varlistentry>
<term><varname>RootDirectory=</varname></term>
core: add new PrivateUsers= option to service execution This setting adds minimal user namespacing support to a service. When set the invoked processes will run in their own user namespace. Only a trivial mapping will be set up: the root user/group is mapped to root, and the user/group of the service will be mapped to itself, everything else is mapped to nobody. If this setting is used the service runs with no capabilities on the host, but configurable capabilities within the service. This setting is particularly useful in conjunction with RootDirectory= as the need to synchronize /etc/passwd and /etc/group between the host and the service OS tree is reduced, as only three UID/GIDs need to match: root, nobody and the user of the service itself. But even outside the RootDirectory= case this setting is useful to substantially reduce the attack surface of a service. Example command to test this: systemd-run -p PrivateUsers=1 -p User=foobar -t /bin/sh This runs a shell as user "foobar". When typing "ps" only processes owned by "root", by "foobar", and by "nobody" should be visible.
2016-08-04 00:44:51 +08:00
<listitem><para>Takes a directory path relative to the host's root directory (i.e. the root of the system
running the service manager). Sets the root directory for executed processes, with the <citerefentry
project='man-pages'><refentrytitle>chroot</refentrytitle><manvolnum>2</manvolnum></citerefentry> system
call. If this is used, it must be ensured that the process binary and all its auxiliary files are available in
the <function>chroot()</function> jail. Note that setting this parameter might result in additional
dependencies to be added to the unit (see above).</para>
core: add a per-unit setting MountAPIVFS= for mounting /dev, /proc, /sys in conjunction with RootDirectory= This adds a boolean unit file setting MountAPIVFS=. If set, the three main API VFS mounts will be mounted for the service. This only has an effect on RootDirectory=, which it makes a ton times more useful. (This is basically the /dev + /proc + /sys mounting code posted in the original #4727, but rebased on current git, and with the automatic logic replaced by explicit logic controlled by a unit file setting)
2016-12-23 06:34:35 +08:00
<para>The <varname>MountAPIVFS=</varname> and <varname>PrivateUsers=</varname> settings are particularly useful
man: say explicitly which settings are not available in --user services Fixes: #3944
2019-03-14 00:24:24 +08:00
in conjunction with <varname>RootDirectory=</varname>. For details, see below.</para>
man: document how get logging to work in a RootDirectory=/RootImage= environment Fixes: #18051
2021-01-21 05:27:41 +08:00
<para>If <varname>RootDirectory=</varname>/<varname>RootImage=</varname> are used together with
<varname>NotifyAccess=</varname> the notification socket is automatically mounted from the host into
the root environment, to ensure the notification interface can work correctly.</para>
<para>Note that services using <varname>RootDirectory=</varname>/<varname>RootImage=</varname> will
not be able to log via the syslog or journal protocols to the host logging infrastructure, unless the
relevant sockets are mounted from the host, specifically:</para>
core: copy the host's os-release for /run/host/os-release Currently for portable services we automatically add a bind mount os-release -> /run/host/os-release. This becomes problematic for the soft-reboot case, as it's likely that portable services will be configured to survive it, and thus would forever keep a reference to the old host's os-release, which would be a problem because it becomes outdated, and also it stops the old rootfs from being garbage collected. Create a copy when the manager starts under /run/systemd/propagate instead, and bind mount that for all services using RootDirectory=/RootImage=, so that on soft-reboot the content gets updated (without creating a new file, so the existing bind mounts will see the new content too). This expands the /run/host/os-release protocol to more services, but I think that's a nice thing to have too. Closes https://github.com/systemd/systemd/issues/28023
2023-07-18 22:44:27 +08:00
<para>The host's
<citerefentry><refentrytitle>os-release</refentrytitle><manvolnum>5</manvolnum></citerefentry>
file will be made available for the service (read-only) as
<filename>/run/host/os-release</filename>.
It will be updated automatically on soft reboot (see:
<citerefentry><refentrytitle>systemd-soft-reboot.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>),
in case the service is configured to survive it.</para>
man: document how get logging to work in a RootDirectory=/RootImage= environment Fixes: #18051
2021-01-21 05:27:41 +08:00
<example>
<title>Mounting logging sockets into root environment</title>
<programlisting>BindReadOnlyPaths=/dev/log /run/systemd/journal/socket /run/systemd/journal/stdout</programlisting>
Add tests and documentation for all remaining sandboxing in user manager
2022-03-13 05:16:32 +08:00
</example>
<xi:include href="system-or-user-ns.xml" xpointer="singular"/></listitem>
core: add a per-unit setting MountAPIVFS= for mounting /dev, /proc, /sys in conjunction with RootDirectory= This adds a boolean unit file setting MountAPIVFS=. If set, the three main API VFS mounts will be mounted for the service. This only has an effect on RootDirectory=, which it makes a ton times more useful. (This is basically the /dev + /proc + /sys mounting code posted in the original #4727, but rebased on current git, and with the automatic logic replaced by explicit logic controlled by a unit file setting)
2016-12-23 06:34:35 +08:00
</varlistentry>
core: add RootImage= setting for using a specific image file as root directory for a service This is similar to RootDirectory= but mounts the root file system from a block device or loopback file instead of another directory. This reuses the image dissector code now used by nspawn and gpt-auto-discovery.
2016-12-23 21:26:05 +08:00
<varlistentry>
<term><varname>RootImage=</varname></term>
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
docs: import discoverable partitions spec This was previously available here: https://www.freedesktop.org/wiki/Specifications/DiscoverablePartitionsSpec/ Let's pull it into our repository.
2019-12-19 16:27:10 +08:00
<listitem><para>Takes a path to a block device node or regular file as argument. This call is similar
to <varname>RootDirectory=</varname> however mounts a file system hierarchy from a block device node
or loopback file instead of a directory. The device node or file system image file needs to contain a
file system without a partition table, or a file system within an MBR/MS-DOS or GPT partition table
with only a single Linux-compatible partition, or a set of file systems within a GPT partition table
tree-wide: BLS and DPS are now on uapi-group website
2022-11-14 16:44:39 +08:00
that follows the <ulink url="https://uapi-group.org/specifications/specs/discoverable_partitions_specification">Discoverable Partitions
namespace: implicitly adds DeviceAllow= when RootImage= is set RootImage= may require the following settings ``` DeviceAllow=/dev/loop-control rw DeviceAllow=block-loop rwm DeviceAllow=block-blkext rwm ``` This adds the following settings implicitly when RootImage= is specified. Fixes #9737.
2018-08-06 13:02:28 +08:00
Specification</ulink>.</para>
man: say explicitly which settings are not available in --user services Fixes: #3944
2019-03-14 00:24:24 +08:00
<para>When <varname>DevicePolicy=</varname> is set to <literal>closed</literal> or
<literal>strict</literal>, or set to <literal>auto</literal> and <varname>DeviceAllow=</varname> is
set, then this setting adds <filename>/dev/loop-control</filename> with <constant>rw</constant> mode,
<literal>block-loop</literal> and <literal>block-blkext</literal> with <constant>rwm</constant> mode
to <varname>DeviceAllow=</varname>. See
namespace: implicitly adds DeviceAllow= when RootImage= is set RootImage= may require the following settings ``` DeviceAllow=/dev/loop-control rw DeviceAllow=block-loop rwm DeviceAllow=block-blkext rwm ``` This adds the following settings implicitly when RootImage= is specified. Fixes #9737.
2018-08-06 13:02:28 +08:00
<citerefentry><refentrytitle>systemd.resource-control</refentrytitle><manvolnum>5</manvolnum></citerefentry>
for the details about <varname>DevicePolicy=</varname> or <varname>DeviceAllow=</varname>. Also, see
man: say explicitly which settings are not available in --user services Fixes: #3944
2019-03-14 00:24:24 +08:00
<varname>PrivateDevices=</varname> below, as it may change the setting of
<varname>DevicePolicy=</varname>.</para>
core: automatically add udev dependency for units using RootImage= We use udev to wait for /dev/loopX devices to be fully proped hence we need an implicit ordering dependency on it, for RootImage= to work reliably in early boot, too. Fixes: #14972
2020-04-21 19:04:39 +08:00
<para>Units making use of <varname>RootImage=</varname> automatically gain an
<varname>After=</varname> dependency on <filename>systemd-udevd.service</filename>.</para>
core: copy the host's os-release for /run/host/os-release Currently for portable services we automatically add a bind mount os-release -> /run/host/os-release. This becomes problematic for the soft-reboot case, as it's likely that portable services will be configured to survive it, and thus would forever keep a reference to the old host's os-release, which would be a problem because it becomes outdated, and also it stops the old rootfs from being garbage collected. Create a copy when the manager starts under /run/systemd/propagate instead, and bind mount that for all services using RootDirectory=/RootImage=, so that on soft-reboot the content gets updated (without creating a new file, so the existing bind mounts will see the new content too). This expands the /run/host/os-release protocol to more services, but I think that's a nice thing to have too. Closes https://github.com/systemd/systemd/issues/28023
2023-07-18 22:44:27 +08:00
<para>The host's
<citerefentry><refentrytitle>os-release</refentrytitle><manvolnum>5</manvolnum></citerefentry>
file will be made available for the service (read-only) as
<filename>/run/host/os-release</filename>.
It will be updated automatically on soft reboot (see:
<citerefentry><refentrytitle>systemd-soft-reboot.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>),
in case the service is configured to survive it.</para>
man: update version information As I noticed a lot of missing information when trying to implement checking for missing info. I reimplemented the version information script to be more robust, and here is the result. Follow up to ec07c3c80b2b1bfa6788500202006ff85f5ae4f4
2023-09-18 23:03:38 +08:00
<xi:include href="system-only.xml" xpointer="singular"/>
<xi:include href="version-info.xml" xpointer="v233"/></listitem>
core: add RootImage= setting for using a specific image file as root directory for a service This is similar to RootDirectory= but mounts the root file system from a block device or loopback file instead of another directory. This reuses the image dissector code now used by nspawn and gpt-auto-discovery.
2016-12-23 21:26:05 +08:00
</varlistentry>
service: add new RootImageOptions feature Allows to specify mount options for RootImage. In case of multi-partition images, the partition number can be prefixed followed by colon. Eg: RootImageOptions=1:ro,dev 2:nosuid nodev In absence of a partition number, 0 is assumed.
2020-06-29 20:19:31 +08:00
<varlistentry>
<term><varname>RootImageOptions=</varname></term>
<listitem><para>Takes a comma-separated list of mount options that will be used on disk images specified by
core: change RootImageOptions to use names instead of partition numbers Follow the designations from the Discoverable Partitions Specification
2020-08-15 01:50:46 +08:00
<varname>RootImage=</varname>. Optionally a partition name can be prefixed, followed by colon, in
case the image has multiple partitions, otherwise partition name <literal>root</literal> is implied.
service: add new RootImageOptions feature Allows to specify mount options for RootImage. In case of multi-partition images, the partition number can be prefixed followed by colon. Eg: RootImageOptions=1:ro,dev 2:nosuid nodev In absence of a partition number, 0 is assumed.
2020-06-29 20:19:31 +08:00
Options for multiple partitions can be specified in a single line with space separators. Assigning an empty
core: change RootImageOptions to use names instead of partition numbers Follow the designations from the Discoverable Partitions Specification
2020-08-15 01:50:46 +08:00
string removes previous assignments. Duplicated options are ignored. For a list of valid mount options, please
man: correct various links As usual, linkchecker ftw!
2020-09-30 20:57:21 +08:00
refer to
<citerefentry project='man-pages'><refentrytitle>mount</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
</para>
core: change RootImageOptions to use names instead of partition numbers Follow the designations from the Discoverable Partitions Specification
2020-08-15 01:50:46 +08:00
man: shorten list of partition types a bit Tables with only one column aren't really tables, they are lists. And if each cell only consists of a single word, they are probably better written in a single line. Hence, shorten the man page a bit, and list boot loader spec partition types in a simple sentence. Also, drop "root-secondary" from the list. When dissecting images we'll upgrade "root-secondary" to "root" if we mount it, and do so only if "root" doesn't exist. Hence never mention "root-secondary" as we never will mount a partition under that id.
2021-03-11 17:00:17 +08:00
<para>Valid partition names follow the <ulink
tree-wide: BLS and DPS are now on uapi-group website
2022-11-14 16:44:39 +08:00
url="https://uapi-group.org/specifications/specs/discoverable_partitions_specification">Discoverable Partitions Specification</ulink>:
man: shorten list of partition types a bit Tables with only one column aren't really tables, they are lists. And if each cell only consists of a single word, they are probably better written in a single line. Hence, shorten the man page a bit, and list boot loader spec partition types in a simple sentence. Also, drop "root-secondary" from the list. When dissecting images we'll upgrade "root-secondary" to "root" if we mount it, and do so only if "root" doesn't exist. Hence never mention "root-secondary" as we never will mount a partition under that id.
2021-03-11 17:00:17 +08:00
<constant>root</constant>, <constant>usr</constant>, <constant>home</constant>, <constant>srv</constant>,
<constant>esp</constant>, <constant>xbootldr</constant>, <constant>tmp</constant>,
<constant>var</constant>.</para>
service: add new RootImageOptions feature Allows to specify mount options for RootImage. In case of multi-partition images, the partition number can be prefixed followed by colon. Eg: RootImageOptions=1:ro,dev 2:nosuid nodev In absence of a partition number, 0 is assumed.
2020-06-29 20:19:31 +08:00
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-23 00:52:36 +08:00
<xi:include href="system-only.xml" xpointer="singular"/>
<xi:include href="version-info.xml" xpointer="v247"/></listitem>
service: add new RootImageOptions feature Allows to specify mount options for RootImage. In case of multi-partition images, the partition number can be prefixed followed by colon. Eg: RootImageOptions=1:ro,dev 2:nosuid nodev In absence of a partition number, 0 is assumed.
2020-06-29 20:19:31 +08:00
</varlistentry>
core: Add RootEphemeral= setting This setting allows services to run in an ephemeral copy of the root directory or root image. To make sure the ephemeral copies are always cleaned up, we add a tmpfiles snippet to unconditionally clean up /var/lib/systemd/ephemeral. To prevent in use ephemeral copies from being cleaned up by tmpfiles, we use the newly added COPY_LOCK_BSD and BTRFS_SNAPSHOT_LOCK_BSD flags to take a BSD lock on the ephemeral copies which instruct tmpfiles to not touch those ephemeral copies as long as the BSD lock is held.
2023-06-06 23:44:09 +08:00
<varlistentry>
<term><varname>RootEphemeral=</varname></term>
<listitem><para>Takes a boolean argument. If enabled, executed processes will run in an ephemeral
copy of the root directory or root image. The ephemeral copy is placed in
<filename>/var/lib/systemd/ephemeral-trees/</filename> while the service is active and is cleaned up
when the service is stopped or restarted. If <varname>RootDirectory=</varname> is used and the root
directory is a subvolume, the ephemeral copy will be created by making a snapshot of the subvolume.
</para>
<para>To make sure making ephemeral copies can be made efficiently, the root directory or root image
should be located on the same filesystem as <filename>/var/lib/systemd/ephemeral-trees/</filename>.
When using <varname>RootEphemeral=</varname> with root directories, btrfs should be used as the
filesystem and the root directory should ideally be a subvolume which <command>systemd</command> can
snapshot to make the ephemeral copy. For root images, a filesystem with support for reflinks should
be used to ensure an efficient ephemeral copy.</para>
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-23 00:52:36 +08:00
<xi:include href="system-only.xml" xpointer="singular"/>
<xi:include href="version-info.xml" xpointer="v254"/></listitem>
core: Add RootEphemeral= setting This setting allows services to run in an ephemeral copy of the root directory or root image. To make sure the ephemeral copies are always cleaned up, we add a tmpfiles snippet to unconditionally clean up /var/lib/systemd/ephemeral. To prevent in use ephemeral copies from being cleaned up by tmpfiles, we use the newly added COPY_LOCK_BSD and BTRFS_SNAPSHOT_LOCK_BSD flags to take a BSD lock on the ephemeral copies which instruct tmpfiles to not touch those ephemeral copies as long as the BSD lock is held.
2023-06-06 23:44:09 +08:00
</varlistentry>
core: add RootHash and RootVerity service parameters Allow to explicitly pass root hash (explicitly or as a file) and verity device/file as unit options. Take precedence over implicit checks.
2020-06-03 16:50:45 +08:00
<varlistentry>
<term><varname>RootHash=</varname></term>
<listitem><para>Takes a data integrity (dm-verity) root hash specified in hexadecimal, or the path to a file
containing a root hash in ASCII hexadecimal format. This option enables data integrity checks using dm-verity,
if the used image contains the appropriate integrity data (see above) or if <varname>RootVerity=</varname> is used.
The specified hash must match the root hash of integrity data, and is usually at least 256 bits (and hence 64
formatted hexadecimal characters) long (in case of SHA256 for example). If this option is not specified, but
the image file carries the <literal>user.verity.roothash</literal> extended file attribute (see <citerefentry
project='man-pages'><refentrytitle>xattr</refentrytitle><manvolnum>7</manvolnum></citerefentry>), then the root
hash is read from it, also as formatted hexadecimal characters. If the extended file attribute is not found (or
is not supported by the underlying file system), but a file with the <filename>.roothash</filename> suffix is
found next to the image file, bearing otherwise the same name (except if the image has the
<filename>.raw</filename> suffix, in which case the root hash file must not have it in its name), the root hash
is read from it and automatically used, also as formatted hexadecimal characters.</para>
doc: document the new GPT partition type UUIDs
2020-09-18 00:57:27 +08:00
<para>If the disk image contains a separate <filename>/usr/</filename> partition it may also be
Verity protected, in which case the root hash may configured via an extended attribute
<literal>user.verity.usrhash</literal> or a <filename>.usrhash</filename> file adjacent to the disk
image. There's currently no option to configure the root hash for the <filename>/usr/</filename> file
system via the unit file directly.</para>
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-23 00:52:36 +08:00
<xi:include href="system-only.xml" xpointer="singular"/>
<xi:include href="version-info.xml" xpointer="v246"/></listitem>
core: add RootHash and RootVerity service parameters Allow to explicitly pass root hash (explicitly or as a file) and verity device/file as unit options. Take precedence over implicit checks.
2020-06-03 16:50:45 +08:00
</varlistentry>
core: add RootHashSignature service parameter Allow to explicitly pass root hash signature as a unit option. Takes precedence over implicit checks.
2020-06-08 21:02:55 +08:00
<varlistentry>
<term><varname>RootHashSignature=</varname></term>
man: assorted small fixes This is almost all of #17177.
2020-09-29 18:31:27 +08:00
<listitem><para>Takes a PKCS7 signature of the <varname>RootHash=</varname> option as a path to a
DER-encoded signature file, or as an ASCII base64 string encoding of a DER-encoded signature prefixed
by <literal>base64:</literal>. The dm-verity volume will only be opened if the signature of the root
hash is valid and signed by a public key present in the kernel keyring. If this option is not
specified, but a file with the <filename>.roothash.p7s</filename> suffix is found next to the image
file, bearing otherwise the same name (except if the image has the <filename>.raw</filename> suffix,
in which case the signature file must not have it in its name), the signature is read from it and
automatically used.</para>
core: add RootHashSignature service parameter Allow to explicitly pass root hash signature as a unit option. Takes precedence over implicit checks.
2020-06-08 21:02:55 +08:00
doc: document the new GPT partition type UUIDs
2020-09-18 00:57:27 +08:00
<para>If the disk image contains a separate <filename>/usr/</filename> partition it may also be
Verity protected, in which case the signature for the root hash may configured via a
<filename>.usrhash.p7s</filename> file adjacent to the disk image. There's currently no option to
configure the root hash signature for the <filename>/usr/</filename> via the unit file
directly.</para>
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-23 00:52:36 +08:00
<xi:include href="system-only.xml" xpointer="singular"/>
<xi:include href="version-info.xml" xpointer="v246"/></listitem>
core: add RootHashSignature service parameter Allow to explicitly pass root hash signature as a unit option. Takes precedence over implicit checks.
2020-06-08 21:02:55 +08:00
</varlistentry>
core: add RootHash and RootVerity service parameters Allow to explicitly pass root hash (explicitly or as a file) and verity device/file as unit options. Take precedence over implicit checks.
2020-06-03 16:50:45 +08:00
<varlistentry>
<term><varname>RootVerity=</varname></term>
<listitem><para>Takes the path to a data integrity (dm-verity) file. This option enables data integrity checks
using dm-verity, if <varname>RootImage=</varname> is used and a root-hash is passed and if the used image itself
man: exec,nspawn: fix typo
2023-01-10 14:39:49 +08:00
does not contain the integrity data. The integrity data must be matched by the root hash. If this option is not
core: add RootHash and RootVerity service parameters Allow to explicitly pass root hash (explicitly or as a file) and verity device/file as unit options. Take precedence over implicit checks.
2020-06-03 16:50:45 +08:00
specified, but a file with the <filename>.verity</filename> suffix is found next to the image file, bearing otherwise
the same name (except if the image has the <filename>.raw</filename> suffix, in which case the verity data file must
not have it in its name), the verity data is read from it and automatically used.</para>
man: fix link markup
2020-07-29 23:37:33 +08:00
<para>This option is supported only for disk images that contain a single file system, without an
enveloping partition table. Images that contain a GPT partition table should instead include both
root file system and matching Verity data in the same image, implementing the <ulink
tree-wide: BLS and DPS are now on uapi-group website
2022-11-14 16:44:39 +08:00
url="https://uapi-group.org/specifications/specs/discoverable_partitions_specification">Discoverable Partitions Specification</ulink>.</para>
core: add RootHash and RootVerity service parameters Allow to explicitly pass root hash (explicitly or as a file) and verity device/file as unit options. Take precedence over implicit checks.
2020-06-03 16:50:45 +08:00
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-23 00:52:36 +08:00
<xi:include href="system-only.xml" xpointer="singular"/>
<xi:include href="version-info.xml" xpointer="v246"/></listitem>
core: add RootHash and RootVerity service parameters Allow to explicitly pass root hash (explicitly or as a file) and verity device/file as unit options. Take precedence over implicit checks.
2020-06-03 16:50:45 +08:00
</varlistentry>
man: document image policy syntax and semantics, and the hooks in the various components
2022-12-02 05:41:47 +08:00
<varlistentry>
<term><varname>RootImagePolicy=</varname></term>
<term><varname>MountImagePolicy=</varname></term>
<term><varname>ExtensionImagePolicy=</varname></term>
<listitem><para>Takes an image policy string as per
<citerefentry><refentrytitle>systemd.image-policy</refentrytitle><manvolnum>7</manvolnum></citerefentry>
to use when mounting the disk images (DDI) specified in <varname>RootImage=</varname>,
<varname>MountImage=</varname>, <varname>ExtensionImage=</varname>, respectively. If not specified
the following policy string is the default for <varname>RootImagePolicy=</varname> and <varname>MountImagePolicy</varname>:</para>
<programlisting>root=verity+signed+encrypted+unprotected+absent: \
usr=verity+signed+encrypted+unprotected+absent: \
home=encrypted+unprotected+absent: \
srv=encrypted+unprotected+absent: \
tmp=encrypted+unprotected+absent: \
var=encrypted+unprotected+absent</programlisting>
<para>The default policy for <varname>ExtensionImagePolicy=</varname> is:</para>
<programlisting>root=verity+signed+encrypted+unprotected+absent: \
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-23 00:52:36 +08:00
usr=verity+signed+encrypted+unprotected+absent</programlisting>
<xi:include href="version-info.xml" xpointer="v254"/></listitem>
man: document image policy syntax and semantics, and the hooks in the various components
2022-12-02 05:41:47 +08:00
</varlistentry>
core: add a per-unit setting MountAPIVFS= for mounting /dev, /proc, /sys in conjunction with RootDirectory= This adds a boolean unit file setting MountAPIVFS=. If set, the three main API VFS mounts will be mounted for the service. This only has an effect on RootDirectory=, which it makes a ton times more useful. (This is basically the /dev + /proc + /sys mounting code posted in the original #4727, but rebased on current git, and with the automatic logic replaced by explicit logic controlled by a unit file setting)
2016-12-23 06:34:35 +08:00
<varlistentry>
<term><varname>MountAPIVFS=</varname></term>
<listitem><para>Takes a boolean argument. If on, a private mount namespace for the unit's processes is created
MountAPIVFS: always mount a tmpfs on /run We need a writable /run for most operations, but in case a read-only RootImage (or similar) is used, by default there's no additional tmpfs mount on /run. Change this behaviour and document it.
2020-12-19 00:16:46 +08:00
and the API file systems <filename>/proc/</filename>, <filename>/sys/</filename>, <filename>/dev/</filename> and
<filename>/run/</filename> (as an empty <literal>tmpfs</literal>) are mounted inside of it, unless they are
already mounted. Note that this option has no effect unless used in conjunction with
<varname>RootDirectory=</varname>/<varname>RootImage=</varname> as these four mounts are
man: add more commas for clarify and reword a few sentences
2017-02-09 11:53:16 +08:00
generally mounted in the host anyway, and unless the root directory is changed, the private mount namespace
MountAPIVFS: always mount a tmpfs on /run We need a writable /run for most operations, but in case a read-only RootImage (or similar) is used, by default there's no additional tmpfs mount on /run. Change this behaviour and document it.
2020-12-19 00:16:46 +08:00
will be a 1:1 copy of the host's, and include these four mounts. Note that the <filename>/dev/</filename> file
man: add more commas for clarify and reword a few sentences
2017-02-09 11:53:16 +08:00
system of the host is bind mounted if this option is used without <varname>PrivateDevices=</varname>. To run
the service with a private, minimal version of <filename>/dev/</filename>, combine this option with
man: say explicitly which settings are not available in --user services Fixes: #3944
2019-03-14 00:24:24 +08:00
<varname>PrivateDevices=</varname>.</para>
man/systemd.exec: suffix one more directory with /
2023-10-05 05:30:46 +08:00
<para>In order to allow propagating mounts at runtime in a safe manner, <filename>/run/systemd/propagate/</filename>
core: add DBUS method to bind mount new nodes without service restart Allow to setup new bind mounts for a service at runtime (via either DBUS or a new 'systemctl bind' verb) with a new helper that forks into the unit's mount namespace. Add a new integration test to cover this. Useful for zero-downtime addition to services that are running inside mount namespaces, especially when using RootImage/RootDirectory. If a service runs with a read-only root, a tmpfs is added on /run to ensure we can create the airlock directory for incoming mounts under /run/host/incoming.
2020-07-31 02:37:10 +08:00
on the host will be used to set up new mounts, and <filename>/run/host/incoming/</filename> in the private namespace
man: update version information As I noticed a lot of missing information when trying to implement checking for missing info. I reimplemented the version information script to be more robust, and here is the result. Follow up to ec07c3c80b2b1bfa6788500202006ff85f5ae4f4
2023-09-18 23:03:38 +08:00
will be used as an intermediate step to store them before being moved to the final mount point.</para>
<xi:include href="version-info.xml" xpointer="v233"/></listitem>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
</varlistentry>
man: document ProtectProc= and ProcSubset=
2020-08-06 21:26:53 +08:00
<varlistentry>
<term><varname>ProtectProc=</varname></term>
<listitem><para>Takes one of <literal>noaccess</literal>, <literal>invisible</literal>,
<literal>ptraceable</literal> or <literal>default</literal> (which it defaults to). When set, this
controls the <literal>hidepid=</literal> mount option of the <literal>procfs</literal> instance for
the unit that controls which directories with process metainformation
(<filename>/proc/<replaceable>PID</replaceable></filename>) are visible and accessible: when set to
<literal>noaccess</literal> the ability to access most of other users' process metadata in
<filename>/proc/</filename> is taken away for processes of the service. When set to
<literal>invisible</literal> processes owned by other users are hidden from
<filename>/proc/</filename>. If <literal>ptraceable</literal> all processes that cannot be
<function>ptrace()</function>'ed by a process are hidden to it. If <literal>default</literal> no
restrictions on <filename>/proc/</filename> access or visibility are made. For further details see
tree-wide: link to docs.kernel.org for kernel documentation https://www.kernel.org/ links to https://docs.kernel.org/ for the documentation. See https://git.kernel.org/pub/scm/docs/kernel/website.git/commit/?id=ebc1c372850f249dd143c6d942e66c88ec610520 These URLs are shorter and nicer looking.
2022-07-04 22:26:30 +08:00
<ulink url="https://docs.kernel.org/filesystems/proc.html#mount-options">The /proc
man: document ProtectProc= and ProcSubset=
2020-08-06 21:26:53 +08:00
Filesystem</ulink>. It is generally recommended to run most system services with this option set to
<literal>invisible</literal>. This option is implemented via file system namespacing, and thus cannot
be used with services that shall be able to install mount points in the host file system
man: specify that ProtectProc= does not work with root/cap_sys_ptrace When using hidepid=invisible on procfs, the kernel will check if the gid of the process trying to access /proc is the same as the gid of the process that mounted the /proc instance, or if it has the ptrace capability: https://github.com/torvalds/linux/blob/v5.10/fs/proc/base.c#L723 https://github.com/torvalds/linux/blob/v5.10/fs/proc/root.c#L155 Given we set up the /proc instance as root for system services, The same restriction applies to CAP_SYS_PTRACE, if a process runs with it then hidepid=invisible has no effect. ProtectProc effectively can only be used with User= or DynamicUser=yes, without CAP_SYS_PTRACE. Update the documentation to explicitly state these limitations. Fixes #18997
2021-03-14 20:36:15 +08:00
hierarchy. Note that the root user is unaffected by this option, so to be effective it has to be used
together with <varname>User=</varname> or <varname>DynamicUser=yes</varname>, and also without the
<literal>CAP_SYS_PTRACE</literal> capability, which also allows a process to bypass this feature. It
cannot be used for services that need to access metainformation about other users' processes. This
option implies <varname>MountAPIVFS=</varname>.</para>
man: document ProtectProc= and ProcSubset=
2020-08-06 21:26:53 +08:00
<para>If the kernel doesn't support per-mount point <option>hidepid=</option> mount options this
setting remains without effect, and the unit's processes will be able to access and see other process
as if the option was not used.</para>
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-23 00:52:36 +08:00
<xi:include href="system-only.xml" xpointer="singular"/>
<xi:include href="version-info.xml" xpointer="v247"/></listitem>
man: document ProtectProc= and ProcSubset=
2020-08-06 21:26:53 +08:00
</varlistentry>
<varlistentry>
<term><varname>ProcSubset=</varname></term>
<listitem><para>Takes one of <literal>all</literal> (the default) and <literal>pid</literal>. If
man: various typos and other small issues Fixes #18397.
2021-01-29 03:38:27 +08:00
<literal>pid</literal>, all files and directories not directly associated with process management and
introspection are made invisible in the <filename>/proc/</filename> file system configured for the
unit's processes. This controls the <literal>subset=</literal> mount option of the
<literal>procfs</literal> instance for the unit. For further details see <ulink
tree-wide: link to docs.kernel.org for kernel documentation https://www.kernel.org/ links to https://docs.kernel.org/ for the documentation. See https://git.kernel.org/pub/scm/docs/kernel/website.git/commit/?id=ebc1c372850f249dd143c6d942e66c88ec610520 These URLs are shorter and nicer looking.
2022-07-04 22:26:30 +08:00
url="https://docs.kernel.org/filesystems/proc.html#mount-options">The /proc
man: document ProtectProc= and ProcSubset=
2020-08-06 21:26:53 +08:00
Filesystem</ulink>. Note that Linux exposes various kernel APIs via <filename>/proc/</filename>,
which are made unavailable with this setting. Since these APIs are used frequently this option is
useful only in a few, specific cases, and is not suitable for most non-trivial programs.</para>
<para>Much like <varname>ProtectProc=</varname> above, this is implemented via file system mount
namespacing, and hence the same restrictions apply: it is only available to system services, it
disables mount propagation to the host mount table, and it implies
<varname>MountAPIVFS=</varname>. Also, like <varname>ProtectProc=</varname> this setting is gracefully
disabled if the used kernel does not support the <literal>subset=</literal> mount option of
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-23 00:52:36 +08:00
<literal>procfs</literal>.</para>
<xi:include href="version-info.xml" xpointer="v247"/></listitem>
man: document ProtectProc= and ProcSubset=
2020-08-06 21:26:53 +08:00
</varlistentry>
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
<varlistentry>
<term><varname>BindPaths=</varname></term>
<term><varname>BindReadOnlyPaths=</varname></term>
<listitem><para>Configures unit-specific bind mounts. A bind mount makes a particular file or directory
available at an additional place in the unit's view of the file system. Any bind mounts created with this
option are specific to the unit, and are not visible in the host's mount table. This option expects a
whitespace separated list of bind mount definitions. Each definition consists of a colon-separated triple of
source path, destination path and option string, where the latter two are optional. If only a source path is
specified the source and destination is taken to be the same. The option string may be either
<literal>rbind</literal> or <literal>norbind</literal> for configuring a recursive or non-recursive bind
core/namespace: make '-' prefix in Bind{,ReadOnly}Paths= work Each path in `Bind{ReadOnly}Paths=` accept '-' prefix. However, the prefix is completely ignored. This makes it work as expected.
2018-02-21 08:07:56 +08:00
mount. If the destination path is omitted, the option string must be omitted too.
Each bind mount definition may be prefixed with <literal>-</literal>, in which case it will be ignored
when its source path does not exist.</para>
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
<para><varname>BindPaths=</varname> creates regular writable bind mounts (unless the source file system mount
is already marked read-only), while <varname>BindReadOnlyPaths=</varname> creates read-only bind mounts. These
settings may be used more than once, each usage appends to the unit's list of bind mounts. If the empty string
is assigned to either of these two options the entire list of bind mounts defined prior to this is reset. Note
that in this case both read-only and regular bind mounts are reset, regardless which of the two settings is
used.</para>
<para>This option is particularly useful when <varname>RootDirectory=</varname>/<varname>RootImage=</varname>
is used. In this case the source path refers to a path on the host file system, while the destination path
man: say explicitly which settings are not available in --user services Fixes: #3944
2019-03-14 00:24:24 +08:00
refers to a path below the root directory of the unit.</para>
man: Add some punctuation; remove double spaces.
2022-06-15 01:42:59 +08:00
<para>Note that the destination directory must exist or systemd must be able to create it. Thus, it
man: describe interaction with ProtectHome=/InaccessiblePaths= in BindMount= https://github.com/systemd/systemd/issues/7153#issuecomment-485252308 Apparently this is still confusing for people. Longer-term, I think we should just make BindMount= automatically "upgrade" (or "downgrade", depending on how you look at this), any InaccessiblePath= mountpoints to "tmpfs". I don't see much point in forcing users to remember this interaction. But let's at least document the status quo, we can always update the docs if the code changes.
2019-04-23 16:28:38 +08:00
is not possible to use those options for mount points nested underneath paths specified in
<varname>InaccessiblePaths=</varname>, or under <filename>/home/</filename> and other protected
directories if <varname>ProtectHome=yes</varname> is
specified. <varname>TemporaryFileSystem=</varname> with <literal>:ro</literal> or
man: update version information As I noticed a lot of missing information when trying to implement checking for missing info. I reimplemented the version information script to be more robust, and here is the result. Follow up to ec07c3c80b2b1bfa6788500202006ff85f5ae4f4
2023-09-18 23:03:38 +08:00
<varname>ProtectHome=tmpfs</varname> should be used instead.</para>
<xi:include href="version-info.xml" xpointer="v233"/></listitem>
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
</varlistentry>
core: new feature MountImages Follows the same pattern and features as RootImage, but allows an arbitrary mount point under / to be specified by the user, and multiple values - like BindPaths. Original implementation by @topimiettinen at: https://github.com/systemd/systemd/pull/14451 Reworked to use dissect's logic instead of bare libmount() calls and other review comments. Thanks Topi for the initial work to come up with and implement this useful feature.
2020-07-14 23:18:41 +08:00
<varlistentry>
<term><varname>MountImages=</varname></term>
<listitem><para>This setting is similar to <varname>RootImage=</varname> in that it mounts a file
system hierarchy from a block device node or loopback file, but the destination directory can be
specified as well as mount options. This option expects a whitespace separated list of mount
definitions. Each definition consists of a colon-separated tuple of source path and destination
core: add mount options support for MountImages Follow the same model established for RootImage and RootImageOptions, and allow to either append a single list of options or tuples of partition_number:options.
2020-07-31 22:06:15 +08:00
definitions, optionally followed by another colon and a list of mount options.</para>
<para>Mount options may be defined as a single comma-separated list of options, in which case they
will be implicitly applied to the root partition on the image, or a series of colon-separated tuples
of partition name and mount options. Valid partition names and mount options are the same as for
<varname>RootImageOptions=</varname> setting described above.</para>
<para>Each mount definition may be prefixed with <literal>-</literal>, in which case it will be
core: new feature MountImages Follows the same pattern and features as RootImage, but allows an arbitrary mount point under / to be specified by the user, and multiple values - like BindPaths. Original implementation by @topimiettinen at: https://github.com/systemd/systemd/pull/14451 Reworked to use dissect's logic instead of bare libmount() calls and other review comments. Thanks Topi for the initial work to come up with and implement this useful feature.
2020-07-14 23:18:41 +08:00
ignored when its source path does not exist. The source argument is a path to a block device node or
regular file. If source or destination contain a <literal>:</literal>, it needs to be escaped as
core: add mount options support for MountImages Follow the same model established for RootImage and RootImageOptions, and allow to either append a single list of options or tuples of partition_number:options.
2020-07-31 22:06:15 +08:00
<literal>\:</literal>. The device node or file system image file needs to follow the same rules as
specified for <varname>RootImage=</varname>. Any mounts created with this option are specific to the
unit, and are not visible in the host's mount table.</para>
core: new feature MountImages Follows the same pattern and features as RootImage, but allows an arbitrary mount point under / to be specified by the user, and multiple values - like BindPaths. Original implementation by @topimiettinen at: https://github.com/systemd/systemd/pull/14451 Reworked to use dissect's logic instead of bare libmount() calls and other review comments. Thanks Topi for the initial work to come up with and implement this useful feature.
2020-07-14 23:18:41 +08:00
<para>These settings may be used more than once, each usage appends to the unit's list of mount
paths. If the empty string is assigned, the entire list of mount paths defined prior to this is
reset.</para>
man: Add some punctuation; remove double spaces.
2022-06-15 01:42:59 +08:00
<para>Note that the destination directory must exist or systemd must be able to create it. Thus, it
core: new feature MountImages Follows the same pattern and features as RootImage, but allows an arbitrary mount point under / to be specified by the user, and multiple values - like BindPaths. Original implementation by @topimiettinen at: https://github.com/systemd/systemd/pull/14451 Reworked to use dissect's logic instead of bare libmount() calls and other review comments. Thanks Topi for the initial work to come up with and implement this useful feature.
2020-07-14 23:18:41 +08:00
is not possible to use those options for mount points nested underneath paths specified in
<varname>InaccessiblePaths=</varname>, or under <filename>/home/</filename> and other protected
directories if <varname>ProtectHome=yes</varname> is specified.</para>
<para>When <varname>DevicePolicy=</varname> is set to <literal>closed</literal> or
<literal>strict</literal>, or set to <literal>auto</literal> and <varname>DeviceAllow=</varname> is
set, then this setting adds <filename>/dev/loop-control</filename> with <constant>rw</constant> mode,
<literal>block-loop</literal> and <literal>block-blkext</literal> with <constant>rwm</constant> mode
to <varname>DeviceAllow=</varname>. See
Add ExtensionImages directive to form overlays Add support for overlaying images for services on top of their root fs, using a read-only overlay.
2021-02-22 20:20:33 +08:00
<citerefentry><refentrytitle>systemd.resource-control</refentrytitle><manvolnum>5</manvolnum></citerefentry>
for the details about <varname>DevicePolicy=</varname> or <varname>DeviceAllow=</varname>. Also, see
<varname>PrivateDevices=</varname> below, as it may change the setting of
<varname>DevicePolicy=</varname>.</para>
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-23 00:52:36 +08:00
<xi:include href="system-only.xml" xpointer="singular"/>
<xi:include href="version-info.xml" xpointer="v247"/></listitem>
Add ExtensionImages directive to form overlays Add support for overlaying images for services on top of their root fs, using a read-only overlay.
2021-02-22 20:20:33 +08:00
</varlistentry>
<varlistentry>
<term><varname>ExtensionImages=</varname></term>
<listitem><para>This setting is similar to <varname>MountImages=</varname> in that it mounts a file
man: fix assorted issues reported by the manpage-l10n project Fixes #20297.
2021-07-27 15:37:29 +08:00
system hierarchy from a block device node or loopback file, but instead of providing a destination
path, an overlay will be set up. This option expects a whitespace separated list of mount
definitions. Each definition consists of a source path, optionally followed by a colon and a list of
mount options.</para>
Add ExtensionImages directive to form overlays Add support for overlaying images for services on top of their root fs, using a read-only overlay.
2021-02-22 20:20:33 +08:00
<para>A read-only OverlayFS will be set up on top of <filename>/usr/</filename> and
documentation: add man page data for confext
2023-08-17 00:57:31 +08:00
<filename>/opt/</filename> hierarchies for sysext images and <filename>/etc/</filename>
hierarchy for confext images. The order in which the images are listed will determine the
man: fix assorted issues reported by the manpage-l10n project Fixes #20297.
2021-07-27 15:37:29 +08:00
order in which the overlay is laid down: images specified first to last will result in overlayfs
layers bottom to top.</para>
Add ExtensionImages directive to form overlays Add support for overlaying images for services on top of their root fs, using a read-only overlay.
2021-02-22 20:20:33 +08:00
<para>Mount options may be defined as a single comma-separated list of options, in which case they
will be implicitly applied to the root partition on the image, or a series of colon-separated tuples
of partition name and mount options. Valid partition names and mount options are the same as for
<varname>RootImageOptions=</varname> setting described above.</para>
<para>Each mount definition may be prefixed with <literal>-</literal>, in which case it will be
ignored when its source path does not exist. The source argument is a path to a block device node or
regular file. If the source path contains a <literal>:</literal>, it needs to be escaped as
<literal>\:</literal>. The device node or file system image file needs to follow the same rules as
specified for <varname>RootImage=</varname>. Any mounts created with this option are specific to the
unit, and are not visible in the host's mount table.</para>
<para>These settings may be used more than once, each usage appends to the unit's list of image
paths. If the empty string is assigned, the entire list of mount paths defined prior to this is
reset.</para>
documentation: add man page data for confext
2023-08-17 00:57:31 +08:00
<para>Each sysext image must carry a <filename>/usr/lib/extension-release.d/extension-release.IMAGE</filename>
file while each confext image must carry a <filename>/etc/extension-release.d/extension-release.IMAGE</filename>
man: further document extension-release
2021-07-23 21:45:38 +08:00
file, with the appropriate metadata which matches <varname>RootImage=</varname>/<varname>RootDirectory=</varname>
or the host. See:
portable: allow caller to override extension-release name check When the --force flag is used, do not insist that the extension-release file has to match the extension image name
2022-10-12 01:58:33 +08:00
<citerefentry><refentrytitle>os-release</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
To disable the safety check that the extension-release file name matches the image file name, the
<varname>x-systemd.relax-extension-release-check</varname> mount option may be appended.</para>
man: further document extension-release
2021-07-23 21:45:38 +08:00
Add ExtensionImages directive to form overlays Add support for overlaying images for services on top of their root fs, using a read-only overlay.
2021-02-22 20:20:33 +08:00
<para>When <varname>DevicePolicy=</varname> is set to <literal>closed</literal> or
<literal>strict</literal>, or set to <literal>auto</literal> and <varname>DeviceAllow=</varname> is
set, then this setting adds <filename>/dev/loop-control</filename> with <constant>rw</constant> mode,
<literal>block-loop</literal> and <literal>block-blkext</literal> with <constant>rwm</constant> mode
to <varname>DeviceAllow=</varname>. See
core: new feature MountImages Follows the same pattern and features as RootImage, but allows an arbitrary mount point under / to be specified by the user, and multiple values - like BindPaths. Original implementation by @topimiettinen at: https://github.com/systemd/systemd/pull/14451 Reworked to use dissect's logic instead of bare libmount() calls and other review comments. Thanks Topi for the initial work to come up with and implement this useful feature.
2020-07-14 23:18:41 +08:00
<citerefentry><refentrytitle>systemd.resource-control</refentrytitle><manvolnum>5</manvolnum></citerefentry>
for the details about <varname>DevicePolicy=</varname> or <varname>DeviceAllow=</varname>. Also, see
<varname>PrivateDevices=</varname> below, as it may change the setting of
<varname>DevicePolicy=</varname>.</para>
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-23 00:52:36 +08:00
<xi:include href="system-only.xml" xpointer="singular"/>
<xi:include href="version-info.xml" xpointer="v248"/></listitem>
core: new feature MountImages Follows the same pattern and features as RootImage, but allows an arbitrary mount point under / to be specified by the user, and multiple values - like BindPaths. Original implementation by @topimiettinen at: https://github.com/systemd/systemd/pull/14451 Reworked to use dissect's logic instead of bare libmount() calls and other review comments. Thanks Topi for the initial work to come up with and implement this useful feature.
2020-07-14 23:18:41 +08:00
</varlistentry>
core: add ExtensionDirectories= setting Add a new setting that follows the same principle and implementation as ExtensionImages, but using directories as sources. It will be used to implement support for extending portable images with directories, since portable services can already use a directory as root.
2022-01-17 09:14:14 +08:00
<varlistentry>
<term><varname>ExtensionDirectories=</varname></term>
<listitem><para>This setting is similar to <varname>BindReadOnlyPaths=</varname> in that it mounts a file
system hierarchy from a directory, but instead of providing a destination path, an overlay will be set
up. This option expects a whitespace separated list of source directories.</para>
<para>A read-only OverlayFS will be set up on top of <filename>/usr/</filename> and
documentation: add man page data for confext
2023-08-17 00:57:31 +08:00
<filename>/opt/</filename> hierarchies for sysext images and <filename>/etc/</filename>
hierarchy for confext images. The order in which the directories are listed will determine
core: add ExtensionDirectories= setting Add a new setting that follows the same principle and implementation as ExtensionImages, but using directories as sources. It will be used to implement support for extending portable images with directories, since portable services can already use a directory as root.
2022-01-17 09:14:14 +08:00
the order in which the overlay is laid down: directories specified first to last will result in overlayfs
layers bottom to top.</para>
<para>Each directory listed in <varname>ExtensionDirectories=</varname> may be prefixed with <literal>-</literal>,
in which case it will be ignored when its source path does not exist. Any mounts created with this option are
specific to the unit, and are not visible in the host's mount table.</para>
<para>These settings may be used more than once, each usage appends to the unit's list of directories
paths. If the empty string is assigned, the entire list of mount paths defined prior to this is
reset.</para>
documentation: add man page data for confext
2023-08-17 00:57:31 +08:00
<para>Each sysext directory must contain a <filename>/usr/lib/extension-release.d/extension-release.IMAGE</filename>
file while each confext directory must carry a <filename>/etc/extension-release.d/extension-release.IMAGE</filename>
core: add ExtensionDirectories= setting Add a new setting that follows the same principle and implementation as ExtensionImages, but using directories as sources. It will be used to implement support for extending portable images with directories, since portable services can already use a directory as root.
2022-01-17 09:14:14 +08:00
file, with the appropriate metadata which matches <varname>RootImage=</varname>/<varname>RootDirectory=</varname>
or the host. See:
<citerefentry><refentrytitle>os-release</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para>
core: support ExtensionDirectories in user manager Unprivileged overlayfs is supported since Linux 5.11. The only change needed to get ExtensionDirectories to work is to avoid hard-coding the staging directory to the system manager runtime directory, everything else just works (TM).
2022-03-10 09:30:08 +08:00
<para>Note that usage from user units requires overlayfs support in unprivileged user namespaces,
Add tests and documentation for all remaining sandboxing in user manager
2022-03-13 05:16:32 +08:00
which was first introduced in kernel v5.11.</para>
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-23 00:52:36 +08:00
<xi:include href="system-or-user-ns.xml" xpointer="singular"/>
<xi:include href="version-info.xml" xpointer="v251"/></listitem>
core: add ExtensionDirectories= setting Add a new setting that follows the same principle and implementation as ExtensionImages, but using directories as sources. It will be used to implement support for extending portable images with directories, since portable services can already use a directory as root.
2022-01-17 09:14:14 +08:00
</varlistentry>
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
</variablelist>
</refsect1>
<refsect1>
man: Rename duplicate Credentials section name A "Credentials" section name in systemd.exec man page was used both for User/Group and for actual credentials support in systemd. Rename the first instance to "User/Group Identity"
2021-02-18 22:08:48 +08:00
<title>User/Group Identity</title>
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
man: say explicitly which settings are not available in --user services Fixes: #3944
2019-03-14 00:24:24 +08:00
<xi:include href="system-only.xml" xpointer="plural"/>
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
<variablelist class='unit-directives'>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
<varlistentry>
<term><varname>User=</varname></term>
<term><varname>Group=</varname></term>
core: add a concept of "dynamic" user ids, that are allocated as long as a service is running This adds a new boolean setting DynamicUser= to service files. If set, a new user will be allocated dynamically when the unit is started, and released when it is stopped. The user ID is allocated from the range 61184..65519. The user will not be added to /etc/passwd (but an NSS module to be added later should make it show up in getent passwd). For now, care should be taken that the service writes no files to disk, since this might result in files owned by UIDs that might get assigned dynamically to a different service later on. Later patches will tighten sandboxing in order to ensure that this cannot happen, except for a few selected directories. A simple way to test this is: systemd-run -p DynamicUser=1 /bin/sleep 99999
2016-07-14 18:37:28 +08:00
<listitem><para>Set the UNIX user or group that the processes are executed as, respectively. Takes a single
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
user or group name, or a numeric ID as argument. For system services (services run by the system service
manager, i.e. managed by PID 1) and for user services of the root user (services managed by root's instance of
man: document default for User= Replaces: #4375
2016-10-20 05:40:31 +08:00
<command>systemd --user</command>), the default is <literal>root</literal>, but <varname>User=</varname> may be
used to specify a different user. For user services of any other user, switching user identity is not
permitted, hence the only valid setting is the same user the user's service manager is running as. If no group
is set, the default group of the user is used. This setting does not affect commands whose command line is
man: briefly document permitted user/group name syntax for User=/Group= and syusers.d (#6321) As discussed here: https://lists.freedesktop.org/archives/systemd-devel/2017-July/039237.html
2017-07-11 01:44:06 +08:00
prefixed with <literal>+</literal>.</para>
docs: hook up the new USER_NAMES document everywhere (Also correct the set of names we accept in User=, which was forgotten to be updated in ae480f0b09aec815b64579bb1828ea935d8ee236.
2020-04-07 17:04:59 +08:00
<para>Note that this enforces only weak restrictions on the user/group name syntax, but will generate
warnings in many cases where user/group names do not adhere to the following rules: the specified
name should consist only of the characters a-z, A-Z, 0-9, <literal>_</literal> and
<literal>-</literal>, except for the first character which must be one of a-z, A-Z and
<literal>_</literal> (i.e. digits and <literal>-</literal> are not permitted as first character). The
user/group name must have at least one character, and at most 31. These restrictions are made in
order to avoid ambiguities and to ensure user/group names and unit files remain portable among Linux
systems. For further details on the names accepted and the names warned about see <ulink
url="https://systemd.io/USER_NAMES">User/Group Name Syntax</ulink>.</para>
man: briefly document permitted user/group name syntax for User=/Group= and syusers.d (#6321) As discussed here: https://lists.freedesktop.org/archives/systemd-devel/2017-July/039237.html
2017-07-11 01:44:06 +08:00
<para>When used in conjunction with <varname>DynamicUser=</varname> the user/group name specified is
man: document that program invocation will fail if the User= does not exist Fixes: #14565
2020-01-16 19:14:03 +08:00
dynamically allocated at the time the service is started, and released at the time the service is
stopped — unless it is already allocated statically (see below). If <varname>DynamicUser=</varname>
is not used the specified user and group must have been created statically in the user database no
later than the moment the service is started, for example using the
<citerefentry><refentrytitle>sysusers.d</refentrytitle><manvolnum>5</manvolnum></citerefentry>
facility, which is applied at boot or package install time. If the user does not exist by then
program invocation will fail.</para>
man: document that the supplementary groups list is initialized from User='s database entry Fixes: #12936
2019-07-12 15:18:59 +08:00
<para>If the <varname>User=</varname> setting is used the supplementary group list is initialized
from the specified user's default group list, as defined in the system's user and group
database. Additional groups may be configured through the <varname>SupplementaryGroups=</varname>
setting (see below).</para></listitem>
core: add a concept of "dynamic" user ids, that are allocated as long as a service is running This adds a new boolean setting DynamicUser= to service files. If set, a new user will be allocated dynamically when the unit is started, and released when it is stopped. The user ID is allocated from the range 61184..65519. The user will not be added to /etc/passwd (but an NSS module to be added later should make it show up in getent passwd). For now, care should be taken that the service writes no files to disk, since this might result in files owned by UIDs that might get assigned dynamically to a different service later on. Later patches will tighten sandboxing in order to ensure that this cannot happen, except for a few selected directories. A simple way to test this is: systemd-run -p DynamicUser=1 /bin/sleep 99999
2016-07-14 18:37:28 +08:00
</varlistentry>
<varlistentry>
<term><varname>DynamicUser=</varname></term>
man: mention that DynamicUser= should not be mixed with ReadWriteDirectory= or AF_UNIX dir fd passing
2019-03-12 22:57:25 +08:00
<listitem><para>Takes a boolean parameter. If set, a UNIX user and group pair is allocated
dynamically when the unit is started, and released as soon as it is stopped. The user and group will
not be added to <filename>/etc/passwd</filename> or <filename>/etc/group</filename>, but are managed
transiently during runtime. The
<citerefentry><refentrytitle>nss-systemd</refentrytitle><manvolnum>8</manvolnum></citerefentry> glibc
NSS module provides integration of these dynamic users/groups into the system's user and group
core: add a concept of "dynamic" user ids, that are allocated as long as a service is running This adds a new boolean setting DynamicUser= to service files. If set, a new user will be allocated dynamically when the unit is started, and released when it is stopped. The user ID is allocated from the range 61184..65519. The user will not be added to /etc/passwd (but an NSS module to be added later should make it show up in getent passwd). For now, care should be taken that the service writes no files to disk, since this might result in files owned by UIDs that might get assigned dynamically to a different service later on. Later patches will tighten sandboxing in order to ensure that this cannot happen, except for a few selected directories. A simple way to test this is: systemd-run -p DynamicUser=1 /bin/sleep 99999
2016-07-14 18:37:28 +08:00
databases. The user and group name to use may be configured via <varname>User=</varname> and
man: mention that DynamicUser= should not be mixed with ReadWriteDirectory= or AF_UNIX dir fd passing
2019-03-12 22:57:25 +08:00
<varname>Group=</varname> (see above). If these options are not used and dynamic user/group
allocation is enabled for a unit, the name of the dynamic user/group is implicitly derived from the
unit name. If the unit name without the type suffix qualifies as valid user name it is used directly,
otherwise a name incorporating a hash of it is used. If a statically allocated user or group of the
configured name already exists, it is used and no dynamic user/group is allocated. Note that if
<varname>User=</varname> is specified and the static group with the name exists, then it is required
that the static user with the name already exists. Similarly, if <varname>Group=</varname> is
specified and the static user with the name exists, then it is required that the static group with
the name already exists. Dynamic users/groups are allocated from the UID/GID range 61184…65519. It is
man: Add some punctuation; remove double spaces.
2022-06-15 01:42:59 +08:00
recommended to avoid this range for regular system or login users. At any point in time each UID/GID
man: mention that DynamicUser= should not be mixed with ReadWriteDirectory= or AF_UNIX dir fd passing
2019-03-12 22:57:25 +08:00
from this range is only assigned to zero or one dynamically allocated users/groups in use. However,
UID/GIDs are recycled after a unit is terminated. Care should be taken that any processes running as
part of a unit for which dynamic users/groups are enabled do not leave files or directories owned by
these users/groups around, as a different unit might get the same UID/GID assigned later on, and thus
gain access to these files or directories. If <varname>DynamicUser=</varname> is enabled,
man: document that DynamicUser=1 implied sandboxing cannot be turned off Fixes: #12476
2019-06-24 20:20:36 +08:00
<varname>RemoveIPC=</varname> and <varname>PrivateTmp=</varname> are implied (and cannot be turned
off). This ensures that the lifetime of IPC objects and temporary files created by the executed
processes is bound to the runtime of the service, and hence the lifetime of the dynamic
user/group. Since <filename>/tmp/</filename> and <filename>/var/tmp/</filename> are usually the only
world-writable directories on a system this ensures that a unit making use of dynamic user/group
allocation cannot leave files around after unit termination. Furthermore
<varname>NoNewPrivileges=</varname> and <varname>RestrictSUIDSGID=</varname> are implicitly enabled
(and cannot be disabled), to ensure that processes invoked cannot take benefit or create SUID/SGID
files or directories. Moreover <varname>ProtectSystem=strict</varname> and
man: mention that DynamicUser= should not be mixed with ReadWriteDirectory= or AF_UNIX dir fd passing
2019-03-12 22:57:25 +08:00
<varname>ProtectHome=read-only</varname> are implied, thus prohibiting the service to write to
arbitrary file system locations. In order to allow the service to write to certain directories, they
tree-wide: avoid some loaded terms https://tools.ietf.org/html/draft-knodel-terminology-02 https://lwn.net/Articles/823224/ This gets rid of most but not occasions of these loaded terms: 1. scsi_id and friends are something that is supposed to be removed from our tree (see #7594) 2. The test suite defines an API used by the ubuntu CI. We can remove this too later, but this needs to be done in sync with the ubuntu CI. 3. In some cases the terms are part of APIs we call or where we expose concepts the kernel names the way it names them. (In particular all remaining uses of the word "slave" in our codebase are like this, it's used by the POSIX PTY layer, by the network subsystem, the mount API and the block device subsystem). Getting rid of the term in these contexts would mean doing some major fixes of the kernel ABI first. Regarding the replacements: when whitelist/blacklist is used as noun we replace with with allow list/deny list, and when used as verb with allow-list/deny-list.
2020-06-23 14:31:16 +08:00
have to be allow-listed using <varname>ReadWritePaths=</varname>, but care must be taken so that
man: mention that DynamicUser= should not be mixed with ReadWriteDirectory= or AF_UNIX dir fd passing
2019-03-12 22:57:25 +08:00
UID/GID recycling doesn't create security issues involving files created by the service. Use
<varname>RuntimeDirectory=</varname> (see below) in order to assign a writable runtime directory to a
service, owned by the dynamic user/group and removed automatically when the unit is terminated. Use
<varname>StateDirectory=</varname>, <varname>CacheDirectory=</varname> and
<varname>LogsDirectory=</varname> in order to assign a set of writable directories for specific
purposes to the service in a way that they are protected from vulnerabilities due to UID reuse (see
below). If this option is enabled, care should be taken that the unit's processes do not get access
to directories outside of these explicitly configured and managed ones. Specifically, do not use
<varname>BindPaths=</varname> and be careful with <constant>AF_UNIX</constant> file descriptor
passing for directory file descriptors, as this would permit processes to create files or directories
tree-wide: spell "lifecycle" without hyphen everywhere We had 10 instances of unhyphentated spelling, and 4 of the hyphenated one. Consistency trumps ispell.
2019-02-21 14:45:45 +08:00
owned by the dynamic user/group that are not subject to the lifecycle and access guarantees of the
man: note that DynamicUser=yes is incompatible with D-Bus Due to policy checks against system users this cannot currently work, and it is non-obvious. In the future it might be implemented if support is added to dbus-broker/dbus-daemon, e.g.: https://github.com/bus1/dbus-broker/issues/259
2022-12-29 00:27:37 +08:00
service. Note that this option is currently incompatible with D-Bus policies, thus a service using
this option may currently not allocate a D-Bus service name (note that this does not affect calling
man: update version information As I noticed a lot of missing information when trying to implement checking for missing info. I reimplemented the version information script to be more robust, and here is the result. Follow up to ec07c3c80b2b1bfa6788500202006ff85f5ae4f4
2023-09-18 23:03:38 +08:00
into other D-Bus services). Defaults to off.</para>
<xi:include href="version-info.xml" xpointer="v232"/></listitem>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
</varlistentry>
<varlistentry>
<term><varname>SupplementaryGroups=</varname></term>
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
<listitem><para>Sets the supplementary Unix groups the processes are executed as. This takes a space-separated
list of group names or IDs. This option may be specified more than once, in which case all listed groups are
set as supplementary groups. When the empty string is assigned, the list of supplementary groups is reset, and
all assignments prior to this one will have no effect. In any way, this option does not override, but extends
the list of supplementary groups configured in the system group database for the user. This does not affect
commands prefixed with <literal>+</literal>.</para></listitem>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
</varlistentry>
core/execute: always set $USER and introduce SetLoginEnvironment= Before this commit, $USER, $HOME, $LOGNAME and $SHELL are only set when User= is set for the unit. For system service, this results in different behaviors depending on whether User=root is set. $USER always makes sense on its own, so let's set it unconditionally. Ideally $HOME should be set too, but it causes trouble when e.g. getty passes '-p' to login(1), which then doesn't override $HOME. $LOGNAME and $SHELL are more like "login environments", and are generally not suitable for system services. Therefore, a new option SetLoginEnvironment= is also added to control the latter three variables. Fixes #23438 Replaces #8227
2023-10-07 20:08:21 +08:00
<varlistentry>
<term><varname>SetLoginEnvironment=</varname></term>
man/systemd.exec: document behavior of SetLoginEnvironment= when unset Follow-up for 854eca4a95993bb1bd77a18de39efe1ed1a44bbd Addresses https://github.com/systemd/systemd/pull/29493#discussion_r1351980046
2023-10-10 18:08:08 +08:00
<listitem><para>Takes a boolean parameter that controls whether to set <varname>$HOME</varname>,
<varname>$LOGNAME</varname>, and <varname>$SHELL</varname> environment variables. If unset, this is
controlled by whether <varname>User=</varname> is set. If true, they will always be set for system services,
i.e. even when the default user <literal>root</literal> is used. If false, the mentioned variables are not set
by systemd, no matter whether <varname>User=</varname> is used or not. This option normally has no effect
on user services, since these variables are typically inherited from user manager's own environment anyway.</para>
core/execute: always set $USER and introduce SetLoginEnvironment= Before this commit, $USER, $HOME, $LOGNAME and $SHELL are only set when User= is set for the unit. For system service, this results in different behaviors depending on whether User=root is set. $USER always makes sense on its own, so let's set it unconditionally. Ideally $HOME should be set too, but it causes trouble when e.g. getty passes '-p' to login(1), which then doesn't override $HOME. $LOGNAME and $SHELL are more like "login environments", and are generally not suitable for system services. Therefore, a new option SetLoginEnvironment= is also added to control the latter three variables. Fixes #23438 Replaces #8227
2023-10-07 20:08:21 +08:00
<xi:include href="version-info.xml" xpointer="v255"/></listitem>
</varlistentry>
core: add RemoveIPC= setting This adds the boolean RemoveIPC= setting to service, socket, mount and swap units (i.e. all unit types that may invoke processes). if turned on, and the unit's user/group is not root, all IPC objects of the user/group are removed when the service is shut down. The life-cycle of the IPC objects is hence bound to the unit life-cycle. This is particularly relevant for units with dynamic users, as it is essential that no objects owned by the dynamic users survive the service exiting. In fact, this patch adds code to imply RemoveIPC= if DynamicUser= is set. In order to communicate the UID/GID of an executed process back to PID 1 this adds a new "user lookup" socket pair, that is inherited into the forked processes, and closed before the exec(). This is needed since we cannot do NSS from PID 1 due to deadlock risks, However need to know the used UID/GID in order to clean up IPC owned by it if the unit shuts down.
2016-08-02 01:24:40 +08:00
<varlistentry>
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
<term><varname>PAMName=</varname></term>
core: add RemoveIPC= setting This adds the boolean RemoveIPC= setting to service, socket, mount and swap units (i.e. all unit types that may invoke processes). if turned on, and the unit's user/group is not root, all IPC objects of the user/group are removed when the service is shut down. The life-cycle of the IPC objects is hence bound to the unit life-cycle. This is particularly relevant for units with dynamic users, as it is essential that no objects owned by the dynamic users survive the service exiting. In fact, this patch adds code to imply RemoveIPC= if DynamicUser= is set. In order to communicate the UID/GID of an executed process back to PID 1 this adds a new "user lookup" socket pair, that is inherited into the forked processes, and closed before the exec(). This is needed since we cannot do NSS from PID 1 due to deadlock risks, However need to know the used UID/GID in order to clean up IPC owned by it if the unit shuts down.
2016-08-02 01:24:40 +08:00
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
<listitem><para>Sets the PAM service name to set up a session as. If set, the executed process will be
registered as a PAM session under the specified service name. This is only useful in conjunction with the
<varname>User=</varname> setting, and is otherwise ignored. If not set, no PAM session will be opened for the
executed processes. See <citerefentry
project='man-pages'><refentrytitle>pam</refentrytitle><manvolnum>8</manvolnum></citerefentry> for
details.</para>
core: add RemoveIPC= setting This adds the boolean RemoveIPC= setting to service, socket, mount and swap units (i.e. all unit types that may invoke processes). if turned on, and the unit's user/group is not root, all IPC objects of the user/group are removed when the service is shut down. The life-cycle of the IPC objects is hence bound to the unit life-cycle. This is particularly relevant for units with dynamic users, as it is essential that no objects owned by the dynamic users survive the service exiting. In fact, this patch adds code to imply RemoveIPC= if DynamicUser= is set. In order to communicate the UID/GID of an executed process back to PID 1 this adds a new "user lookup" socket pair, that is inherited into the forked processes, and closed before the exec(). This is needed since we cannot do NSS from PID 1 due to deadlock risks, However need to know the used UID/GID in order to clean up IPC owned by it if the unit shuts down.
2016-08-02 01:24:40 +08:00
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
<para>Note that for each unit making use of this option a PAM session handler process will be maintained as
part of the unit and stays around as long as the unit is active, to ensure that appropriate actions can be
taken when the unit and hence the PAM session terminates. This process is named <literal>(sd-pam)</literal> and
is an immediate child process of the unit's main process.</para>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
<para>Note that when this option is used for a unit it is very likely (depending on PAM configuration) that the
main unit process will be migrated to its own session scope unit when it is activated. This process will hence
be associated with two units: the unit it was originally started from (and for which
<varname>PAMName=</varname> was configured), and the session scope unit. Any child processes of that process
will however be associated with the session scope unit only. This has implications when used in combination
with <varname>NotifyAccess=</varname><option>all</option>, as these child processes will not be able to affect
changes in the original unit through notification messages. These messages will be considered belonging to the
session scope unit and not the original unit. It is hence not recommended to use <varname>PAMName=</varname> in
combination with <varname>NotifyAccess=</varname><option>all</option>.</para>
</listitem>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
</varlistentry>
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
</variablelist>
</refsect1>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
<refsect1>
<title>Capabilities</title>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
Add tests and documentation for all remaining sandboxing in user manager
2022-03-13 05:16:32 +08:00
<xi:include href="system-or-user-ns.xml" xpointer="plural"/>
man: say explicitly which settings are not available in --user services Fixes: #3944
2019-03-14 00:24:24 +08:00
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
<variablelist class='unit-directives'>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
<varlistentry>
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
<term><varname>CapabilityBoundingSet=</varname></term>
analyze: add 'capability' verb for dumping all known and unknown caps
2020-08-27 21:45:53 +08:00
<listitem><para>Controls which capabilities to include in the capability bounding set for the
executed process. See <citerefentry
project='man-pages'><refentrytitle>capabilities</refentrytitle><manvolnum>7</manvolnum></citerefentry>
for details. Takes a whitespace-separated list of capability names,
e.g. <constant>CAP_SYS_ADMIN</constant>, <constant>CAP_DAC_OVERRIDE</constant>,
<constant>CAP_SYS_PTRACE</constant>. Capabilities listed will be included in the bounding set, all
others are removed. If the list of capabilities is prefixed with <literal>~</literal>, all but the
listed capabilities will be included, the effect of the assignment inverted. Note that this option
also affects the respective capabilities in the effective, permitted and inheritable capability
sets. If this option is not used, the capability bounding set is not modified on process execution,
hence no limits on the capabilities of the process are enforced. This option may appear more than
once, in which case the bounding sets are merged by <constant>OR</constant>, or by
<constant>AND</constant> if the lines are prefixed with <literal>~</literal> (see below). If the
empty string is assigned to this option, the bounding set is reset to the empty capability set, and
man: Add some punctuation; remove double spaces.
2022-06-15 01:42:59 +08:00
all prior settings have no effect. If set to <literal>~</literal> (without any further argument),
analyze: add 'capability' verb for dumping all known and unknown caps
2020-08-27 21:45:53 +08:00
the bounding set is reset to the full set of available capabilities, also undoing any previous
settings. This does not affect commands prefixed with <literal>+</literal>.</para>
<para>Use
<citerefentry><refentrytitle>systemd-analyze</refentrytitle><manvolnum>1</manvolnum></citerefentry>'s
<command>capability</command> command to retrieve a list of capabilities defined on the local
system.</para>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
<para>Example: if a unit has the following,
<programlisting>CapabilityBoundingSet=CAP_A CAP_B
CapabilityBoundingSet=CAP_B CAP_C</programlisting>
man: fix a few bogus entries in directives index When wrong element types are used, directives are sometimes placed in the wrong section. Also, strip part of text starting with "'", which is used in a few places and which is displayed improperly in the index.
2019-11-22 03:33:26 +08:00
then <constant index='false'>CAP_A</constant>, <constant index='false'>CAP_B</constant>, and
man: Add some punctuation; remove double spaces.
2022-06-15 01:42:59 +08:00
<constant index='false'>CAP_C</constant> are set. If the second line is prefixed with
man: fix a few bogus entries in directives index When wrong element types are used, directives are sometimes placed in the wrong section. Also, strip part of text starting with "'", which is used in a few places and which is displayed improperly in the index.
2019-11-22 03:33:26 +08:00
<literal>~</literal>, e.g.,
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
<programlisting>CapabilityBoundingSet=CAP_A CAP_B
CapabilityBoundingSet=~CAP_B CAP_C</programlisting>
man: fix a few bogus entries in directives index When wrong element types are used, directives are sometimes placed in the wrong section. Also, strip part of text starting with "'", which is used in a few places and which is displayed improperly in the index.
2019-11-22 03:33:26 +08:00
then, only <constant index='false'>CAP_A</constant> is set.</para></listitem>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
</varlistentry>
<varlistentry>
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
<term><varname>AmbientCapabilities=</varname></term>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
<listitem><para>Controls which capabilities to include in the ambient capability set for the executed
process. Takes a whitespace-separated list of capability names, e.g. <constant>CAP_SYS_ADMIN</constant>,
<constant>CAP_DAC_OVERRIDE</constant>, <constant>CAP_SYS_PTRACE</constant>. This option may appear more than
man: Add some punctuation; remove double spaces.
2022-06-15 01:42:59 +08:00
once, in which case the ambient capability sets are merged (see the above examples in
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
<varname>CapabilityBoundingSet=</varname>). If the list of capabilities is prefixed with <literal>~</literal>,
all but the listed capabilities will be included, the effect of the assignment inverted. If the empty string is
assigned to this option, the ambient capability set is reset to the empty capability set, and all prior
man: Add some punctuation; remove double spaces.
2022-06-15 01:42:59 +08:00
settings have no effect. If set to <literal>~</literal> (without any further argument), the ambient capability
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
set is reset to the full set of available capabilities, also undoing any previous settings. Note that adding
man: Add some punctuation; remove double spaces.
2022-06-15 01:42:59 +08:00
capabilities to the ambient capability set adds them to the process's inherited capability set. </para><para>
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
Ambient capability sets are useful if you want to execute a process as a non-privileged user but still want to
man: Add some punctuation; remove double spaces.
2022-06-15 01:42:59 +08:00
give it some capabilities. Note that in this case option <constant>keep-caps</constant> is automatically added
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
to <varname>SecureBits=</varname> to retain the capabilities over the user
change. <varname>AmbientCapabilities=</varname> does not affect commands prefixed with
man: update version information As I noticed a lot of missing information when trying to implement checking for missing info. I reimplemented the version information script to be more robust, and here is the result. Follow up to ec07c3c80b2b1bfa6788500202006ff85f5ae4f4
2023-09-18 23:03:38 +08:00
<literal>+</literal>.</para>
<xi:include href="version-info.xml" xpointer="v229"/></listitem>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
</varlistentry>
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
</variablelist>
</refsect1>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
<refsect1>
<title>Security</title>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
<variablelist class='unit-directives'>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
<varlistentry>
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
<term><varname>NoNewPrivileges=</varname></term>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
man: document the new RestrictSUIDSGID= setting
2019-03-21 02:45:32 +08:00
<listitem><para>Takes a boolean argument. If true, ensures that the service process and all its
children can never gain new privileges through <function>execve()</function> (e.g. via setuid or
setgid bits, or filesystem capabilities). This is the simplest and most effective way to ensure that
a process and its children can never elevate privileges again. Defaults to false, but certain
man: Add some punctuation; remove double spaces.
2022-06-15 01:42:59 +08:00
settings override this and ignore the value of this setting. This is the case when
man: make clear NNP has no effect on processes invoked through systemd-run/at/crontab and such things
2022-10-31 19:13:26 +08:00
<varname>DynamicUser=</varname>, <varname>LockPersonality=</varname>,
<varname>MemoryDenyWriteExecute=</varname>, <varname>PrivateDevices=</varname>,
<varname>ProtectClock=</varname>, <varname>ProtectHostname=</varname>,
<varname>ProtectKernelLogs=</varname>, <varname>ProtectKernelModules=</varname>,
<varname>ProtectKernelTunables=</varname>, <varname>RestrictAddressFamilies=</varname>,
<varname>RestrictNamespaces=</varname>, <varname>RestrictRealtime=</varname>,
<varname>RestrictSUIDSGID=</varname>, <varname>SystemCallArchitectures=</varname>,
<varname>SystemCallFilter=</varname>, or <varname>SystemCallLog=</varname> are specified. Note that
even if this setting is overridden by them, <command>systemctl show</command> shows the original
value of this setting. In case the service will be run in a new mount namespace anyway and SELinux is
disabled, all file systems are mounted with <constant>MS_NOSUID</constant> flag. Also see <ulink
url="https://docs.kernel.org/userspace-api/no_new_privs.html">No New Privileges
Flag</ulink>.</para>
<para>Note that this setting only has an effect on the unit's processes themselves (or any processes
directly or indirectly forked off them). It has no effect on processes potentially invoked on request
of them through tools such as <citerefentry
man: fix issues reported by the manpage-l10n project Fixes #25780. > Man page: crypttab.5 > Issue 1: Missing fullstop > Issue 2: I<cipher=>, I<hash=>, I<size=> → B<cipher=>, B<hash=>, B<size=> > > "Force LUKS mode\\&. When this mode is used, the following options are " > "ignored since they are provided by the LUKS header on the device: " > "I<cipher=>, I<hash=>, I<size=>" Seems OK to me. The full stop is there and has been for at least a few years. And we use <option> for the markup, which is appropriate here. > Man page: crypttab.5 > Issue 1: Missing fullstop > Issue 2: I<cipher=>, I<hash=>, I<keyfile-offset=>, I<keyfile-size=>, I<size=> → B<cipher=>, B<hash=>, B<keyfile-offset=>, B<keyfile-size=>, B<size=> > > "Use TrueCrypt encryption mode\\&. When this mode is used, the following " > "options are ignored since they are provided by the TrueCrypt header on the " > "device or do not apply: I<cipher=>, I<hash=>, I<keyfile-offset=>, I<keyfile-" > "size=>, I<size=>" Same. > Man page: journalctl.1 > Issue 1: make be → may be Fixed. > Issue 2: below\\&. → below: Fixed. > Man page: journalctl.1 > Issue: Colon at the end? > > "The following commands are understood\\&. If none is specified the default " > "is to display journal records\\&." > msgstr "" > "Die folgenden Befehle werden verstanden\\&. Falls keiner festgelegt ist, ist " > "die Anzeige von Journal-Datensätzen die Vorgabe\\&." This is a bit awkward, but I'm not sure how to fix it. > Man page: kernel-install.8 > Issue: methods a fallback → methods fallback It was correct, but I added a comma to make the sense clearer. > Man page: loader.conf.5 > Issue 1: secure boot variables → Secure Boot variables > Issue 2: one → one for (multiple times) > > "Supported secure boot variables are one database for authorized images, one " > "key exchange key (KEK) and one platform key (PK)\\&. For more information, " > "refer to the \\m[blue]B<UEFI specification>\\m[]\\&\\s-2\\u[2]\\d\\s+2, " > "under Secure Boot and Driver Signing\\&. Another resource that describe the " > "interplay of the different variables is the \\m[blue]B<EDK2 " > "documentation>\\m[]\\&\\s-2\\u[3]\\d\\s+2\\&." "one of" would sound strange. "One this and one that" is OK. > Man page: loader.conf.5 > Issue: systemd-boot → B<systemd-boot>(7) Fixed. > Man page: logind.conf.5 > Issue: systemd-logind → B<systemd-logind>(8) We use <filename>systemd-logind</> on subsequent references… I think that's good enough. > Man page: nss-myhostname.8 > Issue: B<getent> → B<getent>(1) Fixed. > Man page: nss-resolve.8 > Issue: B<systemd-resolved> → B<systemd-resolved>(8) The first reference does this, subsequent are shorter. > Man page: os-release.5 > Issue: Portable Services → Portable Services Documentation? Updated. > Man page: pam_systemd_home.8 > Issue: auth and account use "reason", while session and password do not? Reworded. > Man page: portablectl.1 > Issue: In systemd-portabled.service(8): Portable Services Documentation Updated. > Man page: repart.d.5 > Issue: The partition → the partition Fixed. > Man page: repart.d.5 > Issue: B<systemd-repart> → B<systemd-repart>(8) The first reference does this. I also change this one, because it's pretty far down in the text. > Man page: systemd.1 > Issue: kernel command line twice? > > "Takes a boolean argument\\&. If false disables importing credentials from " > "the kernel command line, qemu_fw_cfg subsystem or the kernel command line\\&." Apparently this was fixed already. > Man page: systemd-boot.7 > Issue: enrollement → enrollment Fixed. > Man page: systemd-cryptenroll.1 > Issue: multiple cases: any specified → the specified Reworded. > Man page: systemd-cryptenroll.1 > Issue: If this this → If this Fixed tree-wide. > Man page: systemd-cryptsetup-generator.8 > Issue: and the initrd → and in the initrd "Is honoured by the initrd" is OK, because we often speak about the initrd as a single unit. But in the same paragraph we also used "in the initrd", which makes the other use look sloppy. I changed it to "in the initrd" everywhere in that file. > Man page: systemd.directives.7 > Issue: Why are these two quoted (but not others)? > > "B<\\*(Aqh\\*(Aq>" > > B<\\*(Aqs\\*(Aq>" > > "B<\\*(Aqy\\*(Aq>" This is autogenerated from files… We use slightly different markup in different files, and it's just too hard to make it consistent. We gave up on this. > Man page: systemd.exec.5 > Issue 1: B<at>(1p) → B<at>(1) > Issue 2: B<crontab>(1p) → B<crontab>(1) Fixed. > Man page: systemd.exec.5 > Issue: B<select()> → B<select>(2) Fixed. > Man page: systemd.exec.5 > Issue: qemu → B<qemu>(1) The man page doesn't seem to be in any of the canonical places on the web. I added a link to online docs. > Man page: systemd.exec.5 > Issue: variable → variables Seems to be fixed already. > Man page: systemd-integritysetup-generator.8 > Issue: systemd-integritysetup-generator → B<systemd-integritysetup-generator> I changed <filename> to <command>. > Man page: systemd-integritysetup-generator.8 > Issue: superfluous comma at the end Already fixed. > Man page: systemd-measure.1 > Issue: (see B<--pcr-bank=>) below → (see B<--pcr-bank=> below) Reworded. > Man page: systemd-measure.1 > Issue: =PATH> → =>I<PATH> Fixed. > Man page: systemd-measure.1.po > Issue: B<--bank=DIGEST> → B<--bank=>I<DIGEST> Fixed. > Man page: systemd.netdev.5 > Issue: os the → on the Appears to have been fixed already. > Man page: systemd.netdev.5 > Issue: Onboard → On-board (as in previous string) Updated. > Man page: systemd.network.5 > Issue: B<systemd-networkd> -> B<systemd-networkd>(8) First reference does this, subsequent do not. > Man page: systemd.network.5 > Issue: B<netlabelctl> → B<netlabelctl>(8) First reference does this, subsequent do not. > Man page: systemd.network.5 > Issue: Missing verb (aquired? configured?) in the half sentence starting with "or by a " I dropped the comma. > Man page: systemd-nspawn.1 > Issue: All host users outside of that range → All other host users Reworded. > # FIXME no effect → no effect\\&. > #. type: Plain text > #: archlinux debian-unstable fedora-rawhide mageia-cauldron opensuse-tumbleweed > msgid "" > "Whichever ID mapping option is used, the same mapping will be used for users " > "and groups IDs\\&. If B<rootidmap> is used, the group owning the bind " > "mounted directory will have no effect" A period is added. Not sure if there's some other issue. > Man page: systemd-oomd.service.8 > Issue: B<systemd> → B<systemd>(1) Done. > Man page: systemd.path.5 > Issue 1: B<systemd.exec>(1) → B<systemd.exec>(5) > Issue 2: This section does not (yet?) exist Fixed. > Man page: systemd-pcrphase.service.8 > Issue 1: indicate phases into TPM2 PCR 11 ?? > Issue 2: Colon at the end of the paragraph? Fixed. > Man page: systemd-pcrphase.service.8 > Issue: final boot phase → final shutdown phase? Updated. > Man page: systemd-pcrphase.service.8 > Issue: for the the → for the Fixed tree-wide. > Man page: systemd-portabled.service.8 > Issue: In systemd-portabled.service(8): Portable Services Documentation Updated. > Man page: systemd-pstore.service.8 > Issue: Here and the following paragraphs: . → \\&. // Upstream: What does this comment mean? // You normally write \\&. for a full dot (full stop etc.); here you write only "." (i.e. a plain dot). > > "and we look up \"localhost\", nss-dns will send the following queries to " > "systemd-resolved listening on 127.0.0.53:53: first \"localhost.foobar.com\", " > "then \"localhost.barbar.com\", and finally \"localhost\". If (hopefully) the " > "first two queries fail, systemd-resolved will synthesize an answer for the " > "third query." Looks all OK to me. > Man page: systemd.resource-control.5 > Issue: Missing closing bracket after link to Control Groups version 1 Fixed. > Man page: systemd-sysext.8 > Issue: In systemd-portabled.service(8): Portable Services Documentation Updated. > Man page: systemd.timer.5 > Issue 1: B<systemd.exec>(1) → B<systemd.exec>(5) > Issue 2: This section does not (yet?) exist Fixed. > Man page: systemd.unit.5 > Issue: that is → that are Fixed. > Man page: systemd-veritysetup-generator.8 > Issue: systemd-veritysetup-generator → B<systemd-veritysetup-generator> > > "systemd-veritysetup-generator implements B<systemd.generator>(7)\\&." > > "systemd-veritysetup-generator understands the following kernel command line " > "parameters:" Updated. > Man page: systemd-volatile-root.service.8 > Issue: initrdyes → Initrd Fixed. > Man page: sysupdate.d.5 > Issue: : → \\&. (As above in TRANSFER) Updated. > Man page: sysupdate.d.5 > Issue: some → certain Updated. > Man page: sysupdate.d.5 > Issue 1: i\\&.e\\& → I\\&.e\\& Fixed. > Issue 2: the image → the system "image" seems correct. > Man page: tmpfiles.d.5 > Issue: systemd-tmpfiles → B<systemd-tmpfiles>(8) Updated.
2023-01-11 23:45:59 +08:00
project='man-pages'><refentrytitle>at</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
man: make clear NNP has no effect on processes invoked through systemd-run/at/crontab and such things
2022-10-31 19:13:26 +08:00
<citerefentry
man: fix issues reported by the manpage-l10n project Fixes #25780. > Man page: crypttab.5 > Issue 1: Missing fullstop > Issue 2: I<cipher=>, I<hash=>, I<size=> → B<cipher=>, B<hash=>, B<size=> > > "Force LUKS mode\\&. When this mode is used, the following options are " > "ignored since they are provided by the LUKS header on the device: " > "I<cipher=>, I<hash=>, I<size=>" Seems OK to me. The full stop is there and has been for at least a few years. And we use <option> for the markup, which is appropriate here. > Man page: crypttab.5 > Issue 1: Missing fullstop > Issue 2: I<cipher=>, I<hash=>, I<keyfile-offset=>, I<keyfile-size=>, I<size=> → B<cipher=>, B<hash=>, B<keyfile-offset=>, B<keyfile-size=>, B<size=> > > "Use TrueCrypt encryption mode\\&. When this mode is used, the following " > "options are ignored since they are provided by the TrueCrypt header on the " > "device or do not apply: I<cipher=>, I<hash=>, I<keyfile-offset=>, I<keyfile-" > "size=>, I<size=>" Same. > Man page: journalctl.1 > Issue 1: make be → may be Fixed. > Issue 2: below\\&. → below: Fixed. > Man page: journalctl.1 > Issue: Colon at the end? > > "The following commands are understood\\&. If none is specified the default " > "is to display journal records\\&." > msgstr "" > "Die folgenden Befehle werden verstanden\\&. Falls keiner festgelegt ist, ist " > "die Anzeige von Journal-Datensätzen die Vorgabe\\&." This is a bit awkward, but I'm not sure how to fix it. > Man page: kernel-install.8 > Issue: methods a fallback → methods fallback It was correct, but I added a comma to make the sense clearer. > Man page: loader.conf.5 > Issue 1: secure boot variables → Secure Boot variables > Issue 2: one → one for (multiple times) > > "Supported secure boot variables are one database for authorized images, one " > "key exchange key (KEK) and one platform key (PK)\\&. For more information, " > "refer to the \\m[blue]B<UEFI specification>\\m[]\\&\\s-2\\u[2]\\d\\s+2, " > "under Secure Boot and Driver Signing\\&. Another resource that describe the " > "interplay of the different variables is the \\m[blue]B<EDK2 " > "documentation>\\m[]\\&\\s-2\\u[3]\\d\\s+2\\&." "one of" would sound strange. "One this and one that" is OK. > Man page: loader.conf.5 > Issue: systemd-boot → B<systemd-boot>(7) Fixed. > Man page: logind.conf.5 > Issue: systemd-logind → B<systemd-logind>(8) We use <filename>systemd-logind</> on subsequent references… I think that's good enough. > Man page: nss-myhostname.8 > Issue: B<getent> → B<getent>(1) Fixed. > Man page: nss-resolve.8 > Issue: B<systemd-resolved> → B<systemd-resolved>(8) The first reference does this, subsequent are shorter. > Man page: os-release.5 > Issue: Portable Services → Portable Services Documentation? Updated. > Man page: pam_systemd_home.8 > Issue: auth and account use "reason", while session and password do not? Reworded. > Man page: portablectl.1 > Issue: In systemd-portabled.service(8): Portable Services Documentation Updated. > Man page: repart.d.5 > Issue: The partition → the partition Fixed. > Man page: repart.d.5 > Issue: B<systemd-repart> → B<systemd-repart>(8) The first reference does this. I also change this one, because it's pretty far down in the text. > Man page: systemd.1 > Issue: kernel command line twice? > > "Takes a boolean argument\\&. If false disables importing credentials from " > "the kernel command line, qemu_fw_cfg subsystem or the kernel command line\\&." Apparently this was fixed already. > Man page: systemd-boot.7 > Issue: enrollement → enrollment Fixed. > Man page: systemd-cryptenroll.1 > Issue: multiple cases: any specified → the specified Reworded. > Man page: systemd-cryptenroll.1 > Issue: If this this → If this Fixed tree-wide. > Man page: systemd-cryptsetup-generator.8 > Issue: and the initrd → and in the initrd "Is honoured by the initrd" is OK, because we often speak about the initrd as a single unit. But in the same paragraph we also used "in the initrd", which makes the other use look sloppy. I changed it to "in the initrd" everywhere in that file. > Man page: systemd.directives.7 > Issue: Why are these two quoted (but not others)? > > "B<\\*(Aqh\\*(Aq>" > > B<\\*(Aqs\\*(Aq>" > > "B<\\*(Aqy\\*(Aq>" This is autogenerated from files… We use slightly different markup in different files, and it's just too hard to make it consistent. We gave up on this. > Man page: systemd.exec.5 > Issue 1: B<at>(1p) → B<at>(1) > Issue 2: B<crontab>(1p) → B<crontab>(1) Fixed. > Man page: systemd.exec.5 > Issue: B<select()> → B<select>(2) Fixed. > Man page: systemd.exec.5 > Issue: qemu → B<qemu>(1) The man page doesn't seem to be in any of the canonical places on the web. I added a link to online docs. > Man page: systemd.exec.5 > Issue: variable → variables Seems to be fixed already. > Man page: systemd-integritysetup-generator.8 > Issue: systemd-integritysetup-generator → B<systemd-integritysetup-generator> I changed <filename> to <command>. > Man page: systemd-integritysetup-generator.8 > Issue: superfluous comma at the end Already fixed. > Man page: systemd-measure.1 > Issue: (see B<--pcr-bank=>) below → (see B<--pcr-bank=> below) Reworded. > Man page: systemd-measure.1 > Issue: =PATH> → =>I<PATH> Fixed. > Man page: systemd-measure.1.po > Issue: B<--bank=DIGEST> → B<--bank=>I<DIGEST> Fixed. > Man page: systemd.netdev.5 > Issue: os the → on the Appears to have been fixed already. > Man page: systemd.netdev.5 > Issue: Onboard → On-board (as in previous string) Updated. > Man page: systemd.network.5 > Issue: B<systemd-networkd> -> B<systemd-networkd>(8) First reference does this, subsequent do not. > Man page: systemd.network.5 > Issue: B<netlabelctl> → B<netlabelctl>(8) First reference does this, subsequent do not. > Man page: systemd.network.5 > Issue: Missing verb (aquired? configured?) in the half sentence starting with "or by a " I dropped the comma. > Man page: systemd-nspawn.1 > Issue: All host users outside of that range → All other host users Reworded. > # FIXME no effect → no effect\\&. > #. type: Plain text > #: archlinux debian-unstable fedora-rawhide mageia-cauldron opensuse-tumbleweed > msgid "" > "Whichever ID mapping option is used, the same mapping will be used for users " > "and groups IDs\\&. If B<rootidmap> is used, the group owning the bind " > "mounted directory will have no effect" A period is added. Not sure if there's some other issue. > Man page: systemd-oomd.service.8 > Issue: B<systemd> → B<systemd>(1) Done. > Man page: systemd.path.5 > Issue 1: B<systemd.exec>(1) → B<systemd.exec>(5) > Issue 2: This section does not (yet?) exist Fixed. > Man page: systemd-pcrphase.service.8 > Issue 1: indicate phases into TPM2 PCR 11 ?? > Issue 2: Colon at the end of the paragraph? Fixed. > Man page: systemd-pcrphase.service.8 > Issue: final boot phase → final shutdown phase? Updated. > Man page: systemd-pcrphase.service.8 > Issue: for the the → for the Fixed tree-wide. > Man page: systemd-portabled.service.8 > Issue: In systemd-portabled.service(8): Portable Services Documentation Updated. > Man page: systemd-pstore.service.8 > Issue: Here and the following paragraphs: . → \\&. // Upstream: What does this comment mean? // You normally write \\&. for a full dot (full stop etc.); here you write only "." (i.e. a plain dot). > > "and we look up \"localhost\", nss-dns will send the following queries to " > "systemd-resolved listening on 127.0.0.53:53: first \"localhost.foobar.com\", " > "then \"localhost.barbar.com\", and finally \"localhost\". If (hopefully) the " > "first two queries fail, systemd-resolved will synthesize an answer for the " > "third query." Looks all OK to me. > Man page: systemd.resource-control.5 > Issue: Missing closing bracket after link to Control Groups version 1 Fixed. > Man page: systemd-sysext.8 > Issue: In systemd-portabled.service(8): Portable Services Documentation Updated. > Man page: systemd.timer.5 > Issue 1: B<systemd.exec>(1) → B<systemd.exec>(5) > Issue 2: This section does not (yet?) exist Fixed. > Man page: systemd.unit.5 > Issue: that is → that are Fixed. > Man page: systemd-veritysetup-generator.8 > Issue: systemd-veritysetup-generator → B<systemd-veritysetup-generator> > > "systemd-veritysetup-generator implements B<systemd.generator>(7)\\&." > > "systemd-veritysetup-generator understands the following kernel command line " > "parameters:" Updated. > Man page: systemd-volatile-root.service.8 > Issue: initrdyes → Initrd Fixed. > Man page: sysupdate.d.5 > Issue: : → \\&. (As above in TRANSFER) Updated. > Man page: sysupdate.d.5 > Issue: some → certain Updated. > Man page: sysupdate.d.5 > Issue 1: i\\&.e\\& → I\\&.e\\& Fixed. > Issue 2: the image → the system "image" seems correct. > Man page: tmpfiles.d.5 > Issue: systemd-tmpfiles → B<systemd-tmpfiles>(8) Updated.
2023-01-11 23:45:59 +08:00
project='man-pages'><refentrytitle>crontab</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
man: make clear NNP has no effect on processes invoked through systemd-run/at/crontab and such things
2022-10-31 19:13:26 +08:00
<citerefentry><refentrytitle>systemd-run</refentrytitle><manvolnum>1</manvolnum></citerefentry>, or
man: update version information As I noticed a lot of missing information when trying to implement checking for missing info. I reimplemented the version information script to be more robust, and here is the result. Follow up to ec07c3c80b2b1bfa6788500202006ff85f5ae4f4
2023-09-18 23:03:38 +08:00
arbitrary IPC services.</para>
<xi:include href="version-info.xml" xpointer="v187"/></listitem>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
</varlistentry>
<varlistentry>
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
<term><varname>SecureBits=</varname></term>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
<listitem><para>Controls the secure bits set for the executed process. Takes a space-separated combination of
options from the following list: <option>keep-caps</option>, <option>keep-caps-locked</option>,
<option>no-setuid-fixup</option>, <option>no-setuid-fixup-locked</option>, <option>noroot</option>, and
man: Add some punctuation; remove double spaces.
2022-06-15 01:42:59 +08:00
<option>noroot-locked</option>. This option may appear more than once, in which case the secure bits are
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
ORed. If the empty string is assigned to this option, the bits are reset to 0. This does not affect commands
man: Add some punctuation; remove double spaces.
2022-06-15 01:42:59 +08:00
prefixed with <literal>+</literal>. See <citerefentry
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
project='man-pages'><refentrytitle>capabilities</refentrytitle><manvolnum>7</manvolnum></citerefentry> for
details.</para></listitem>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
</varlistentry>
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
</variablelist>
</refsect1>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
<refsect1>
<title>Mandatory Access Control</title>
man: say explicitly which settings are not available in --user services Fixes: #3944
2019-03-14 00:24:24 +08:00
<xi:include href="system-only.xml" xpointer="plural"/>
man: move entries to the right section in systemd.directives They were in "miscellaneuos" because of the missing class= assignment. Probably introduced when the split into sections was done.
2019-02-13 17:17:49 +08:00
<variablelist class='unit-directives'>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
<varlistentry>
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
<term><varname>SELinuxContext=</varname></term>
<listitem><para>Set the SELinux security context of the executed process. If set, this will override the
automated domain transition. However, the policy still needs to authorize the transition. This directive is
execute: always log a warning when setting SELinux context fails Update also manual page to explain how the transition can still fail.
2021-11-12 06:33:01 +08:00
ignored if SELinux is disabled. If prefixed by <literal>-</literal>, failing to set the SELinux
security context will be ignored, but it's still possible that the subsequent
<function>execve()</function> may fail if the policy doesn't allow the transition for the
man: Add some punctuation; remove double spaces.
2022-06-15 01:42:59 +08:00
non-overridden context. This does not affect commands prefixed with <literal>+</literal>. See
execute: always log a warning when setting SELinux context fails Update also manual page to explain how the transition can still fail.
2021-11-12 06:33:01 +08:00
<citerefentry
project='die-net'><refentrytitle>setexeccon</refentrytitle><manvolnum>3</manvolnum></citerefentry>
man: update version information As I noticed a lot of missing information when trying to implement checking for missing info. I reimplemented the version information script to be more robust, and here is the result. Follow up to ec07c3c80b2b1bfa6788500202006ff85f5ae4f4
2023-09-18 23:03:38 +08:00
for details.</para>
<xi:include href="version-info.xml" xpointer="v209"/></listitem>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
</varlistentry>
execute: Add new PassEnvironment= directive This directive allows passing environment variables from the system manager to spawned services. Variables in the system manager can be set inside a container by passing `--set-env=...` options to systemd-spawn. Tested with an on-disk test.service unit. Tested using multiple variable names on a single line, with an empty setting to clear the current list of variables, with non-existing variables. Tested using `systemd-run -p PassEnvironment=VARNAME` to confirm it works with transient units. Confirmed that `systemctl show` will display the PassEnvironment settings. Checked that man pages are generated correctly. No regressions in `make check`.
2015-09-07 14:06:53 +08:00
<varlistentry>
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
<term><varname>AppArmorProfile=</varname></term>
execute: Add new PassEnvironment= directive This directive allows passing environment variables from the system manager to spawned services. Variables in the system manager can be set inside a container by passing `--set-env=...` options to systemd-spawn. Tested with an on-disk test.service unit. Tested using multiple variable names on a single line, with an empty setting to clear the current list of variables, with non-existing variables. Tested using `systemd-run -p PassEnvironment=VARNAME` to confirm it works with transient units. Confirmed that `systemctl show` will display the PassEnvironment settings. Checked that man pages are generated correctly. No regressions in `make check`.
2015-09-07 14:06:53 +08:00
tree-wide: fixes for assorted grammar and spelling issues Fixes #16363. Also includes some changes where I generalized the pattern.
2020-07-06 16:49:59 +08:00
<listitem><para>Takes a profile name as argument. The process executed by the unit will switch to
this profile when started. Profiles must already be loaded in the kernel, or the unit will fail. If
prefixed by <literal>-</literal>, all errors will be ignored. This setting has no effect if AppArmor
man: assorted small fixes This is almost all of #17177.
2020-09-29 18:31:27 +08:00
is not enabled. This setting does not affect commands prefixed with <literal>+</literal>.</para>
man: update version information As I noticed a lot of missing information when trying to implement checking for missing info. I reimplemented the version information script to be more robust, and here is the result. Follow up to ec07c3c80b2b1bfa6788500202006ff85f5ae4f4
2023-09-18 23:03:38 +08:00
<xi:include href="version-info.xml" xpointer="v210"/>
tree-wide: fixes for assorted grammar and spelling issues Fixes #16363. Also includes some changes where I generalized the pattern.
2020-07-06 16:49:59 +08:00
</listitem>
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
</varlistentry>
core: add new UnsetEnvironment= setting for unit files With this setting we can explicitly unset specific variables for processes of a unit, as last step of assembling the environment block for them. This is useful to fix #6407. While we are at it, greatly expand the documentation on how the environment block for forked off processes is assembled.
2017-09-10 18:16:44 +08:00
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
<varlistentry>
<term><varname>SmackProcessLabel=</varname></term>
execute: Add new PassEnvironment= directive This directive allows passing environment variables from the system manager to spawned services. Variables in the system manager can be set inside a container by passing `--set-env=...` options to systemd-spawn. Tested with an on-disk test.service unit. Tested using multiple variable names on a single line, with an empty setting to clear the current list of variables, with non-existing variables. Tested using `systemd-run -p PassEnvironment=VARNAME` to confirm it works with transient units. Confirmed that `systemctl show` will display the PassEnvironment settings. Checked that man pages are generated correctly. No regressions in `make check`.
2015-09-07 14:06:53 +08:00
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
<listitem><para>Takes a <option>SMACK64</option> security label as argument. The process executed by the unit
will be started under this label and SMACK will decide whether the process is allowed to run or not, based on
it. The process will continue to run under the label specified here unless the executable has its own
<option>SMACK64EXEC</option> label, in which case the process will transition to run under that label. When not
specified, the label that systemd is running under is used. This directive is ignored if SMACK is
disabled.</para>
execute: Add new PassEnvironment= directive This directive allows passing environment variables from the system manager to spawned services. Variables in the system manager can be set inside a container by passing `--set-env=...` options to systemd-spawn. Tested with an on-disk test.service unit. Tested using multiple variable names on a single line, with an empty setting to clear the current list of variables, with non-existing variables. Tested using `systemd-run -p PassEnvironment=VARNAME` to confirm it works with transient units. Confirmed that `systemctl show` will display the PassEnvironment settings. Checked that man pages are generated correctly. No regressions in `make check`.
2015-09-07 14:06:53 +08:00
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
<para>The value may be prefixed by <literal>-</literal>, in which case all errors will be ignored. An empty
value may be specified to unset previous assignments. This does not affect commands prefixed with
man: update version information As I noticed a lot of missing information when trying to implement checking for missing info. I reimplemented the version information script to be more robust, and here is the result. Follow up to ec07c3c80b2b1bfa6788500202006ff85f5ae4f4
2023-09-18 23:03:38 +08:00
<literal>+</literal>.</para>
<xi:include href="version-info.xml" xpointer="v218"/></listitem>
execute: Add new PassEnvironment= directive This directive allows passing environment variables from the system manager to spawned services. Variables in the system manager can be set inside a container by passing `--set-env=...` options to systemd-spawn. Tested with an on-disk test.service unit. Tested using multiple variable names on a single line, with an empty setting to clear the current list of variables, with non-existing variables. Tested using `systemd-run -p PassEnvironment=VARNAME` to confirm it works with transient units. Confirmed that `systemctl show` will display the PassEnvironment settings. Checked that man pages are generated correctly. No regressions in `make check`.
2015-09-07 14:06:53 +08:00
</varlistentry>
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
</variablelist>
</refsect1>
core: add new UnsetEnvironment= setting for unit files With this setting we can explicitly unset specific variables for processes of a unit, as last step of assembling the environment block for them. This is useful to fix #6407. While we are at it, greatly expand the documentation on how the environment block for forked off processes is assembled.
2017-09-10 18:16:44 +08:00
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
<refsect1>
<title>Process Properties</title>
core: add new UnsetEnvironment= setting for unit files With this setting we can explicitly unset specific variables for processes of a unit, as last step of assembling the environment block for them. This is useful to fix #6407. While we are at it, greatly expand the documentation on how the environment block for forked off processes is assembled.
2017-09-10 18:16:44 +08:00
man: move entries to the right section in systemd.directives They were in "miscellaneuos" because of the missing class= assignment. Probably introduced when the split into sections was done.
2019-02-13 17:17:49 +08:00
<variablelist class='unit-directives'>
core: add new UnsetEnvironment= setting for unit files With this setting we can explicitly unset specific variables for processes of a unit, as last step of assembling the environment block for them. This is useful to fix #6407. While we are at it, greatly expand the documentation on how the environment block for forked off processes is assembled.
2017-09-10 18:16:44 +08:00
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
<varlistentry>
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
<term><varname>LimitCPU=</varname></term>
<term><varname>LimitFSIZE=</varname></term>
<term><varname>LimitDATA=</varname></term>
<term><varname>LimitSTACK=</varname></term>
<term><varname>LimitCORE=</varname></term>
<term><varname>LimitRSS=</varname></term>
<term><varname>LimitNOFILE=</varname></term>
<term><varname>LimitAS=</varname></term>
<term><varname>LimitNPROC=</varname></term>
<term><varname>LimitMEMLOCK=</varname></term>
<term><varname>LimitLOCKS=</varname></term>
<term><varname>LimitSIGPENDING=</varname></term>
<term><varname>LimitMSGQUEUE=</varname></term>
<term><varname>LimitNICE=</varname></term>
<term><varname>LimitRTPRIO=</varname></term>
<term><varname>LimitRTTIME=</varname></term>
man: document all the new options we acquired
2017-10-28 00:10:34 +08:00
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
<listitem><para>Set soft and hard limits on various resources for executed processes. See
man: clarify that user rlimits cannot go beyond limits set for service mgr Fixes: #10758
2020-01-17 02:22:30 +08:00
<citerefentry><refentrytitle>setrlimit</refentrytitle><manvolnum>2</manvolnum></citerefentry> for
man: explain why various resource limits don't make sense and should not be used.
2022-07-15 00:50:52 +08:00
details on the process resource limit concept. Process resource limits may be specified in two formats:
either as single value to set a specific soft and hard limit to the same value, or as colon-separated
pair <option>soft:hard</option> to set both limits individually
(e.g. <literal>LimitAS=4G:16G</literal>). Use the string <option>infinity</option> to configure no
limit on a specific resource. The multiplicative suffixes K, M, G, T, P and E (to the base 1024) may
be used for resource limits measured in bytes (e.g. <literal>LimitAS=16G</literal>). For the limits
referring to time values, the usual time units ms, s, min, h and so on may be used (see
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
<citerefentry><refentrytitle>systemd.time</refentrytitle><manvolnum>7</manvolnum></citerefentry> for
man: clarify that user rlimits cannot go beyond limits set for service mgr Fixes: #10758
2020-01-17 02:22:30 +08:00
details). Note that if no time unit is specified for <varname>LimitCPU=</varname> the default unit of
seconds is implied, while for <varname>LimitRTTIME=</varname> the default unit of microseconds is
implied. Also, note that the effective granularity of the limits might influence their
enforcement. For example, time limits specified for <varname>LimitCPU=</varname> will be rounded up
implicitly to multiples of 1s. For <varname>LimitNICE=</varname> the value may be specified in two
syntaxes: if prefixed with <literal>+</literal> or <literal>-</literal>, the value is understood as
man: use ellipses for ranges in range descriptions … and in few other places ;)
2021-01-29 03:42:37 +08:00
regular Linux nice value in the range -20…19. If not prefixed like this the value is understood as
raw resource limit parameter in the range 0…40 (with 0 being equivalent to 1).</para>
man: clarify that user rlimits cannot go beyond limits set for service mgr Fixes: #10758
2020-01-17 02:22:30 +08:00
<para>Note that most process resource limits configured with these options are per-process, and
processes may fork in order to acquire a new set of resources that are accounted independently of the
original process, and may thus escape limits set. Also note that <varname>LimitRSS=</varname> is not
implemented on Linux, and setting it has no effect. Often it is advisable to prefer the resource
controls listed in
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
<citerefentry><refentrytitle>systemd.resource-control</refentrytitle><manvolnum>5</manvolnum></citerefentry>
man: clarify that user rlimits cannot go beyond limits set for service mgr Fixes: #10758
2020-01-17 02:22:30 +08:00
over these per-process limits, as they apply to services as a whole, may be altered dynamically at
runtime, and are generally more expressive. For example, <varname>MemoryMax=</varname> is a more
powerful (and working) replacement for <varname>LimitRSS=</varname>.</para>
man: document all the new options we acquired
2017-10-28 00:10:34 +08:00
Amend documentation for LimitNPROC=
2022-05-02 04:52:39 +08:00
<para>Note that <varname>LimitNPROC=</varname> will limit the number of processes from one (real) UID and
not the number of processes started (forked) by the service. Therefore the limit is cumulative for all
processes running under the same UID. Please also note that the <varname>LimitNPROC=</varname> will not be
enforced if the service is running as root (and not dropping privileges). Due to these limitations,
<varname>TasksMax=</varname> (see <citerefentry><refentrytitle>systemd.resource-control</refentrytitle>
<manvolnum>5</manvolnum></citerefentry>) is typically a better choice than <varname>LimitNPROC=</varname>.
</para>
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
<para>Resource limits not configured explicitly for a unit default to the value configured in the various
<varname>DefaultLimitCPU=</varname>, <varname>DefaultLimitFSIZE=</varname>, … options available in
<citerefentry><refentrytitle>systemd-system.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>, and –
if not configured there – the kernel or per-user defaults, as defined by the OS (the latter only for user
man: clarify that user rlimits cannot go beyond limits set for service mgr Fixes: #10758
2020-01-17 02:22:30 +08:00
services, see below).</para>
<para>For system units these resource limits may be chosen freely. When these settings are configured
in a user service (i.e. a service run by the per-user instance of the service manager) they cannot be
used to raise the limits above those set for the user manager itself when it was first invoked, as
the user's service manager generally lacks the privileges to do so. In user context these
configuration options are hence only useful to lower the limits passed in or to raise the soft limit
to the maximum of the hard limit as configured for the user. To raise the user's limits further, the
available configuration mechanisms differ between operating systems, but typically require
privileges. In most cases it is possible to configure higher per-user resource limits via PAM or by
setting limits on the system service encapsulating the user's service manager, i.e. the user's
instance of <filename>user@.service</filename>. After making such changes, make sure to restart the
user's service manager.</para>
man: document all the new options we acquired
2017-10-28 00:10:34 +08:00
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
<table>
<title>Resource limit directives, their equivalent <command>ulimit</command> shell commands and the unit used</title>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
man: explain why various resource limits don't make sense and should not be used.
2022-07-15 00:50:52 +08:00
<tgroup cols='4'>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
<colspec colname='directive' />
<colspec colname='equivalent' />
core: accept time units for time-based resource limits Let's make sure "LimitCPU=30min" can be parsed properly, following the usual logic how we parse time values. Similar for LimitRTTIME=. While we are at it, extend a bit on the man page section about resource limits. Fixes: #1772
2015-11-10 23:52:52 +08:00
<colspec colname='unit' />
man: explain why various resource limits don't make sense and should not be used.
2022-07-15 00:50:52 +08:00
<colspec colname='notes' />
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
<thead>
<row>
<entry>Directive</entry>
man: beef up documentation on per-unit resource limits a bit Let's clarify that for user services some OS-defined limits bound the settings in the unit files. Fixes: #4232
2016-10-12 00:42:22 +08:00
<entry><command>ulimit</command> equivalent</entry>
core: accept time units for time-based resource limits Let's make sure "LimitCPU=30min" can be parsed properly, following the usual logic how we parse time values. Similar for LimitRTTIME=. While we are at it, extend a bit on the man page section about resource limits. Fixes: #1772
2015-11-10 23:52:52 +08:00
<entry>Unit</entry>
man: explain why various resource limits don't make sense and should not be used.
2022-07-15 00:50:52 +08:00
<entry>Notes</entry>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
</row>
</thead>
<tbody>
<row>
core: accept time units for time-based resource limits Let's make sure "LimitCPU=30min" can be parsed properly, following the usual logic how we parse time values. Similar for LimitRTTIME=. While we are at it, extend a bit on the man page section about resource limits. Fixes: #1772
2015-11-10 23:52:52 +08:00
<entry>LimitCPU=</entry>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
<entry>ulimit -t</entry>
core: accept time units for time-based resource limits Let's make sure "LimitCPU=30min" can be parsed properly, following the usual logic how we parse time values. Similar for LimitRTTIME=. While we are at it, extend a bit on the man page section about resource limits. Fixes: #1772
2015-11-10 23:52:52 +08:00
<entry>Seconds</entry>
man: explain why various resource limits don't make sense and should not be used.
2022-07-15 00:50:52 +08:00
<entry>-</entry>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
</row>
<row>
core: accept time units for time-based resource limits Let's make sure "LimitCPU=30min" can be parsed properly, following the usual logic how we parse time values. Similar for LimitRTTIME=. While we are at it, extend a bit on the man page section about resource limits. Fixes: #1772
2015-11-10 23:52:52 +08:00
<entry>LimitFSIZE=</entry>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
<entry>ulimit -f</entry>
core: accept time units for time-based resource limits Let's make sure "LimitCPU=30min" can be parsed properly, following the usual logic how we parse time values. Similar for LimitRTTIME=. While we are at it, extend a bit on the man page section about resource limits. Fixes: #1772
2015-11-10 23:52:52 +08:00
<entry>Bytes</entry>
man: explain why various resource limits don't make sense and should not be used.
2022-07-15 00:50:52 +08:00
<entry>-</entry>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
</row>
<row>
core: accept time units for time-based resource limits Let's make sure "LimitCPU=30min" can be parsed properly, following the usual logic how we parse time values. Similar for LimitRTTIME=. While we are at it, extend a bit on the man page section about resource limits. Fixes: #1772
2015-11-10 23:52:52 +08:00
<entry>LimitDATA=</entry>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
<entry>ulimit -d</entry>
core: accept time units for time-based resource limits Let's make sure "LimitCPU=30min" can be parsed properly, following the usual logic how we parse time values. Similar for LimitRTTIME=. While we are at it, extend a bit on the man page section about resource limits. Fixes: #1772
2015-11-10 23:52:52 +08:00
<entry>Bytes</entry>
man: explain why various resource limits don't make sense and should not be used.
2022-07-15 00:50:52 +08:00
<entry>Don't use. This limits the allowed address range, not memory use! Defaults to unlimited and should not be lowered. To limit memory use, see <varname>MemoryMax=</varname> in <citerefentry><refentrytitle>systemd.resource-control</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</entry>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
</row>
<row>
core: accept time units for time-based resource limits Let's make sure "LimitCPU=30min" can be parsed properly, following the usual logic how we parse time values. Similar for LimitRTTIME=. While we are at it, extend a bit on the man page section about resource limits. Fixes: #1772
2015-11-10 23:52:52 +08:00
<entry>LimitSTACK=</entry>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
<entry>ulimit -s</entry>
core: accept time units for time-based resource limits Let's make sure "LimitCPU=30min" can be parsed properly, following the usual logic how we parse time values. Similar for LimitRTTIME=. While we are at it, extend a bit on the man page section about resource limits. Fixes: #1772
2015-11-10 23:52:52 +08:00
<entry>Bytes</entry>
man: explain why various resource limits don't make sense and should not be used.
2022-07-15 00:50:52 +08:00
<entry>-</entry>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
</row>
<row>
core: accept time units for time-based resource limits Let's make sure "LimitCPU=30min" can be parsed properly, following the usual logic how we parse time values. Similar for LimitRTTIME=. While we are at it, extend a bit on the man page section about resource limits. Fixes: #1772
2015-11-10 23:52:52 +08:00
<entry>LimitCORE=</entry>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
<entry>ulimit -c</entry>
core: accept time units for time-based resource limits Let's make sure "LimitCPU=30min" can be parsed properly, following the usual logic how we parse time values. Similar for LimitRTTIME=. While we are at it, extend a bit on the man page section about resource limits. Fixes: #1772
2015-11-10 23:52:52 +08:00
<entry>Bytes</entry>
man: explain why various resource limits don't make sense and should not be used.
2022-07-15 00:50:52 +08:00
<entry>-</entry>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
</row>
<row>
core: accept time units for time-based resource limits Let's make sure "LimitCPU=30min" can be parsed properly, following the usual logic how we parse time values. Similar for LimitRTTIME=. While we are at it, extend a bit on the man page section about resource limits. Fixes: #1772
2015-11-10 23:52:52 +08:00
<entry>LimitRSS=</entry>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
<entry>ulimit -m</entry>
core: accept time units for time-based resource limits Let's make sure "LimitCPU=30min" can be parsed properly, following the usual logic how we parse time values. Similar for LimitRTTIME=. While we are at it, extend a bit on the man page section about resource limits. Fixes: #1772
2015-11-10 23:52:52 +08:00
<entry>Bytes</entry>
man: explain why various resource limits don't make sense and should not be used.
2022-07-15 00:50:52 +08:00
<entry>Don't use. No effect on Linux.</entry>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
</row>
<row>
core: accept time units for time-based resource limits Let's make sure "LimitCPU=30min" can be parsed properly, following the usual logic how we parse time values. Similar for LimitRTTIME=. While we are at it, extend a bit on the man page section about resource limits. Fixes: #1772
2015-11-10 23:52:52 +08:00
<entry>LimitNOFILE=</entry>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
<entry>ulimit -n</entry>
core: accept time units for time-based resource limits Let's make sure "LimitCPU=30min" can be parsed properly, following the usual logic how we parse time values. Similar for LimitRTTIME=. While we are at it, extend a bit on the man page section about resource limits. Fixes: #1772
2015-11-10 23:52:52 +08:00
<entry>Number of File Descriptors</entry>
man: fix issues reported by the manpage-l10n project Fixes #25780. > Man page: crypttab.5 > Issue 1: Missing fullstop > Issue 2: I<cipher=>, I<hash=>, I<size=> → B<cipher=>, B<hash=>, B<size=> > > "Force LUKS mode\\&. When this mode is used, the following options are " > "ignored since they are provided by the LUKS header on the device: " > "I<cipher=>, I<hash=>, I<size=>" Seems OK to me. The full stop is there and has been for at least a few years. And we use <option> for the markup, which is appropriate here. > Man page: crypttab.5 > Issue 1: Missing fullstop > Issue 2: I<cipher=>, I<hash=>, I<keyfile-offset=>, I<keyfile-size=>, I<size=> → B<cipher=>, B<hash=>, B<keyfile-offset=>, B<keyfile-size=>, B<size=> > > "Use TrueCrypt encryption mode\\&. When this mode is used, the following " > "options are ignored since they are provided by the TrueCrypt header on the " > "device or do not apply: I<cipher=>, I<hash=>, I<keyfile-offset=>, I<keyfile-" > "size=>, I<size=>" Same. > Man page: journalctl.1 > Issue 1: make be → may be Fixed. > Issue 2: below\\&. → below: Fixed. > Man page: journalctl.1 > Issue: Colon at the end? > > "The following commands are understood\\&. If none is specified the default " > "is to display journal records\\&." > msgstr "" > "Die folgenden Befehle werden verstanden\\&. Falls keiner festgelegt ist, ist " > "die Anzeige von Journal-Datensätzen die Vorgabe\\&." This is a bit awkward, but I'm not sure how to fix it. > Man page: kernel-install.8 > Issue: methods a fallback → methods fallback It was correct, but I added a comma to make the sense clearer. > Man page: loader.conf.5 > Issue 1: secure boot variables → Secure Boot variables > Issue 2: one → one for (multiple times) > > "Supported secure boot variables are one database for authorized images, one " > "key exchange key (KEK) and one platform key (PK)\\&. For more information, " > "refer to the \\m[blue]B<UEFI specification>\\m[]\\&\\s-2\\u[2]\\d\\s+2, " > "under Secure Boot and Driver Signing\\&. Another resource that describe the " > "interplay of the different variables is the \\m[blue]B<EDK2 " > "documentation>\\m[]\\&\\s-2\\u[3]\\d\\s+2\\&." "one of" would sound strange. "One this and one that" is OK. > Man page: loader.conf.5 > Issue: systemd-boot → B<systemd-boot>(7) Fixed. > Man page: logind.conf.5 > Issue: systemd-logind → B<systemd-logind>(8) We use <filename>systemd-logind</> on subsequent references… I think that's good enough. > Man page: nss-myhostname.8 > Issue: B<getent> → B<getent>(1) Fixed. > Man page: nss-resolve.8 > Issue: B<systemd-resolved> → B<systemd-resolved>(8) The first reference does this, subsequent are shorter. > Man page: os-release.5 > Issue: Portable Services → Portable Services Documentation? Updated. > Man page: pam_systemd_home.8 > Issue: auth and account use "reason", while session and password do not? Reworded. > Man page: portablectl.1 > Issue: In systemd-portabled.service(8): Portable Services Documentation Updated. > Man page: repart.d.5 > Issue: The partition → the partition Fixed. > Man page: repart.d.5 > Issue: B<systemd-repart> → B<systemd-repart>(8) The first reference does this. I also change this one, because it's pretty far down in the text. > Man page: systemd.1 > Issue: kernel command line twice? > > "Takes a boolean argument\\&. If false disables importing credentials from " > "the kernel command line, qemu_fw_cfg subsystem or the kernel command line\\&." Apparently this was fixed already. > Man page: systemd-boot.7 > Issue: enrollement → enrollment Fixed. > Man page: systemd-cryptenroll.1 > Issue: multiple cases: any specified → the specified Reworded. > Man page: systemd-cryptenroll.1 > Issue: If this this → If this Fixed tree-wide. > Man page: systemd-cryptsetup-generator.8 > Issue: and the initrd → and in the initrd "Is honoured by the initrd" is OK, because we often speak about the initrd as a single unit. But in the same paragraph we also used "in the initrd", which makes the other use look sloppy. I changed it to "in the initrd" everywhere in that file. > Man page: systemd.directives.7 > Issue: Why are these two quoted (but not others)? > > "B<\\*(Aqh\\*(Aq>" > > B<\\*(Aqs\\*(Aq>" > > "B<\\*(Aqy\\*(Aq>" This is autogenerated from files… We use slightly different markup in different files, and it's just too hard to make it consistent. We gave up on this. > Man page: systemd.exec.5 > Issue 1: B<at>(1p) → B<at>(1) > Issue 2: B<crontab>(1p) → B<crontab>(1) Fixed. > Man page: systemd.exec.5 > Issue: B<select()> → B<select>(2) Fixed. > Man page: systemd.exec.5 > Issue: qemu → B<qemu>(1) The man page doesn't seem to be in any of the canonical places on the web. I added a link to online docs. > Man page: systemd.exec.5 > Issue: variable → variables Seems to be fixed already. > Man page: systemd-integritysetup-generator.8 > Issue: systemd-integritysetup-generator → B<systemd-integritysetup-generator> I changed <filename> to <command>. > Man page: systemd-integritysetup-generator.8 > Issue: superfluous comma at the end Already fixed. > Man page: systemd-measure.1 > Issue: (see B<--pcr-bank=>) below → (see B<--pcr-bank=> below) Reworded. > Man page: systemd-measure.1 > Issue: =PATH> → =>I<PATH> Fixed. > Man page: systemd-measure.1.po > Issue: B<--bank=DIGEST> → B<--bank=>I<DIGEST> Fixed. > Man page: systemd.netdev.5 > Issue: os the → on the Appears to have been fixed already. > Man page: systemd.netdev.5 > Issue: Onboard → On-board (as in previous string) Updated. > Man page: systemd.network.5 > Issue: B<systemd-networkd> -> B<systemd-networkd>(8) First reference does this, subsequent do not. > Man page: systemd.network.5 > Issue: B<netlabelctl> → B<netlabelctl>(8) First reference does this, subsequent do not. > Man page: systemd.network.5 > Issue: Missing verb (aquired? configured?) in the half sentence starting with "or by a " I dropped the comma. > Man page: systemd-nspawn.1 > Issue: All host users outside of that range → All other host users Reworded. > # FIXME no effect → no effect\\&. > #. type: Plain text > #: archlinux debian-unstable fedora-rawhide mageia-cauldron opensuse-tumbleweed > msgid "" > "Whichever ID mapping option is used, the same mapping will be used for users " > "and groups IDs\\&. If B<rootidmap> is used, the group owning the bind " > "mounted directory will have no effect" A period is added. Not sure if there's some other issue. > Man page: systemd-oomd.service.8 > Issue: B<systemd> → B<systemd>(1) Done. > Man page: systemd.path.5 > Issue 1: B<systemd.exec>(1) → B<systemd.exec>(5) > Issue 2: This section does not (yet?) exist Fixed. > Man page: systemd-pcrphase.service.8 > Issue 1: indicate phases into TPM2 PCR 11 ?? > Issue 2: Colon at the end of the paragraph? Fixed. > Man page: systemd-pcrphase.service.8 > Issue: final boot phase → final shutdown phase? Updated. > Man page: systemd-pcrphase.service.8 > Issue: for the the → for the Fixed tree-wide. > Man page: systemd-portabled.service.8 > Issue: In systemd-portabled.service(8): Portable Services Documentation Updated. > Man page: systemd-pstore.service.8 > Issue: Here and the following paragraphs: . → \\&. // Upstream: What does this comment mean? // You normally write \\&. for a full dot (full stop etc.); here you write only "." (i.e. a plain dot). > > "and we look up \"localhost\", nss-dns will send the following queries to " > "systemd-resolved listening on 127.0.0.53:53: first \"localhost.foobar.com\", " > "then \"localhost.barbar.com\", and finally \"localhost\". If (hopefully) the " > "first two queries fail, systemd-resolved will synthesize an answer for the " > "third query." Looks all OK to me. > Man page: systemd.resource-control.5 > Issue: Missing closing bracket after link to Control Groups version 1 Fixed. > Man page: systemd-sysext.8 > Issue: In systemd-portabled.service(8): Portable Services Documentation Updated. > Man page: systemd.timer.5 > Issue 1: B<systemd.exec>(1) → B<systemd.exec>(5) > Issue 2: This section does not (yet?) exist Fixed. > Man page: systemd.unit.5 > Issue: that is → that are Fixed. > Man page: systemd-veritysetup-generator.8 > Issue: systemd-veritysetup-generator → B<systemd-veritysetup-generator> > > "systemd-veritysetup-generator implements B<systemd.generator>(7)\\&." > > "systemd-veritysetup-generator understands the following kernel command line " > "parameters:" Updated. > Man page: systemd-volatile-root.service.8 > Issue: initrdyes → Initrd Fixed. > Man page: sysupdate.d.5 > Issue: : → \\&. (As above in TRANSFER) Updated. > Man page: sysupdate.d.5 > Issue: some → certain Updated. > Man page: sysupdate.d.5 > Issue 1: i\\&.e\\& → I\\&.e\\& Fixed. > Issue 2: the image → the system "image" seems correct. > Man page: tmpfiles.d.5 > Issue: systemd-tmpfiles → B<systemd-tmpfiles>(8) Updated.
2023-01-11 23:45:59 +08:00
<entry>Don't use. Be careful when raising the soft limit above 1024, since <citerefentry project='man-pages'><refentrytitle>select</refentrytitle><manvolnum>2</manvolnum></citerefentry> cannot function with file descriptors above 1023 on Linux. Nowadays, the hard limit defaults to 524288, a very high value compared to historical defaults. Typically applications should increase their soft limit to the hard limit on their own, if they are OK with working with file descriptors above 1023, i.e. do not use <citerefentry project='man-pages'><refentrytitle>select</refentrytitle><manvolnum>2</manvolnum></citerefentry>. Note that file descriptors are nowadays accounted like any other form of memory, thus there should not be any need to lower the hard limit. Use <varname>MemoryMax=</varname> to control overall service memory use, including file descriptor memory.</entry>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
</row>
<row>
core: accept time units for time-based resource limits Let's make sure "LimitCPU=30min" can be parsed properly, following the usual logic how we parse time values. Similar for LimitRTTIME=. While we are at it, extend a bit on the man page section about resource limits. Fixes: #1772
2015-11-10 23:52:52 +08:00
<entry>LimitAS=</entry>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
<entry>ulimit -v</entry>
core: accept time units for time-based resource limits Let's make sure "LimitCPU=30min" can be parsed properly, following the usual logic how we parse time values. Similar for LimitRTTIME=. While we are at it, extend a bit on the man page section about resource limits. Fixes: #1772
2015-11-10 23:52:52 +08:00
<entry>Bytes</entry>
man: explain why various resource limits don't make sense and should not be used.
2022-07-15 00:50:52 +08:00
<entry>Don't use. This limits the allowed address range, not memory use! Defaults to unlimited and should not be lowered. To limit memory use, see <varname>MemoryMax=</varname> in <citerefentry><refentrytitle>systemd.resource-control</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</entry>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
</row>
<row>
core: accept time units for time-based resource limits Let's make sure "LimitCPU=30min" can be parsed properly, following the usual logic how we parse time values. Similar for LimitRTTIME=. While we are at it, extend a bit on the man page section about resource limits. Fixes: #1772
2015-11-10 23:52:52 +08:00
<entry>LimitNPROC=</entry>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
<entry>ulimit -u</entry>
core: accept time units for time-based resource limits Let's make sure "LimitCPU=30min" can be parsed properly, following the usual logic how we parse time values. Similar for LimitRTTIME=. While we are at it, extend a bit on the man page section about resource limits. Fixes: #1772
2015-11-10 23:52:52 +08:00
<entry>Number of Processes</entry>
man: explain why various resource limits don't make sense and should not be used.
2022-07-15 00:50:52 +08:00
<entry>This limit is enforced based on the number of processes belonging to the user. Typically it's better to track processes per service, i.e. use <varname>TasksMax=</varname>, see <citerefentry><refentrytitle>systemd.resource-control</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</entry>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
</row>
<row>
core: accept time units for time-based resource limits Let's make sure "LimitCPU=30min" can be parsed properly, following the usual logic how we parse time values. Similar for LimitRTTIME=. While we are at it, extend a bit on the man page section about resource limits. Fixes: #1772
2015-11-10 23:52:52 +08:00
<entry>LimitMEMLOCK=</entry>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
<entry>ulimit -l</entry>
core: accept time units for time-based resource limits Let's make sure "LimitCPU=30min" can be parsed properly, following the usual logic how we parse time values. Similar for LimitRTTIME=. While we are at it, extend a bit on the man page section about resource limits. Fixes: #1772
2015-11-10 23:52:52 +08:00
<entry>Bytes</entry>
man: explain why various resource limits don't make sense and should not be used.
2022-07-15 00:50:52 +08:00
<entry>-</entry>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
</row>
<row>
core: accept time units for time-based resource limits Let's make sure "LimitCPU=30min" can be parsed properly, following the usual logic how we parse time values. Similar for LimitRTTIME=. While we are at it, extend a bit on the man page section about resource limits. Fixes: #1772
2015-11-10 23:52:52 +08:00
<entry>LimitLOCKS=</entry>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
<entry>ulimit -x</entry>
core: accept time units for time-based resource limits Let's make sure "LimitCPU=30min" can be parsed properly, following the usual logic how we parse time values. Similar for LimitRTTIME=. While we are at it, extend a bit on the man page section about resource limits. Fixes: #1772
2015-11-10 23:52:52 +08:00
<entry>Number of Locks</entry>
man: explain why various resource limits don't make sense and should not be used.
2022-07-15 00:50:52 +08:00
<entry>-</entry>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
</row>
<row>
core: accept time units for time-based resource limits Let's make sure "LimitCPU=30min" can be parsed properly, following the usual logic how we parse time values. Similar for LimitRTTIME=. While we are at it, extend a bit on the man page section about resource limits. Fixes: #1772
2015-11-10 23:52:52 +08:00
<entry>LimitSIGPENDING=</entry>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
<entry>ulimit -i</entry>
core: accept time units for time-based resource limits Let's make sure "LimitCPU=30min" can be parsed properly, following the usual logic how we parse time values. Similar for LimitRTTIME=. While we are at it, extend a bit on the man page section about resource limits. Fixes: #1772
2015-11-10 23:52:52 +08:00
<entry>Number of Queued Signals</entry>
man: explain why various resource limits don't make sense and should not be used.
2022-07-15 00:50:52 +08:00
<entry>-</entry>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
</row>
<row>
core: accept time units for time-based resource limits Let's make sure "LimitCPU=30min" can be parsed properly, following the usual logic how we parse time values. Similar for LimitRTTIME=. While we are at it, extend a bit on the man page section about resource limits. Fixes: #1772
2015-11-10 23:52:52 +08:00
<entry>LimitMSGQUEUE=</entry>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
<entry>ulimit -q</entry>
core: accept time units for time-based resource limits Let's make sure "LimitCPU=30min" can be parsed properly, following the usual logic how we parse time values. Similar for LimitRTTIME=. While we are at it, extend a bit on the man page section about resource limits. Fixes: #1772
2015-11-10 23:52:52 +08:00
<entry>Bytes</entry>
man: explain why various resource limits don't make sense and should not be used.
2022-07-15 00:50:52 +08:00
<entry>-</entry>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
</row>
<row>
core: accept time units for time-based resource limits Let's make sure "LimitCPU=30min" can be parsed properly, following the usual logic how we parse time values. Similar for LimitRTTIME=. While we are at it, extend a bit on the man page section about resource limits. Fixes: #1772
2015-11-10 23:52:52 +08:00
<entry>LimitNICE=</entry>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
<entry>ulimit -e</entry>
core: accept time units for time-based resource limits Let's make sure "LimitCPU=30min" can be parsed properly, following the usual logic how we parse time values. Similar for LimitRTTIME=. While we are at it, extend a bit on the man page section about resource limits. Fixes: #1772
2015-11-10 23:52:52 +08:00
<entry>Nice Level</entry>
man: explain why various resource limits don't make sense and should not be used.
2022-07-15 00:50:52 +08:00
<entry>-</entry>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
</row>
<row>
core: accept time units for time-based resource limits Let's make sure "LimitCPU=30min" can be parsed properly, following the usual logic how we parse time values. Similar for LimitRTTIME=. While we are at it, extend a bit on the man page section about resource limits. Fixes: #1772
2015-11-10 23:52:52 +08:00
<entry>LimitRTPRIO=</entry>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
<entry>ulimit -r</entry>
core: accept time units for time-based resource limits Let's make sure "LimitCPU=30min" can be parsed properly, following the usual logic how we parse time values. Similar for LimitRTTIME=. While we are at it, extend a bit on the man page section about resource limits. Fixes: #1772
2015-11-10 23:52:52 +08:00
<entry>Realtime Priority</entry>
man: explain why various resource limits don't make sense and should not be used.
2022-07-15 00:50:52 +08:00
<entry>-</entry>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
</row>
<row>
core: accept time units for time-based resource limits Let's make sure "LimitCPU=30min" can be parsed properly, following the usual logic how we parse time values. Similar for LimitRTTIME=. While we are at it, extend a bit on the man page section about resource limits. Fixes: #1772
2015-11-10 23:52:52 +08:00
<entry>LimitRTTIME=</entry>
man: explain why various resource limits don't make sense and should not be used.
2022-07-15 00:50:52 +08:00
<entry>ulimit -R</entry>
core: accept time units for time-based resource limits Let's make sure "LimitCPU=30min" can be parsed properly, following the usual logic how we parse time values. Similar for LimitRTTIME=. While we are at it, extend a bit on the man page section about resource limits. Fixes: #1772
2015-11-10 23:52:52 +08:00
<entry>Microseconds</entry>
man: explain why various resource limits don't make sense and should not be used.
2022-07-15 00:50:52 +08:00
<entry>-</entry>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
</row>
</tbody>
</tgroup>
core: accept time units for time-based resource limits Let's make sure "LimitCPU=30min" can be parsed properly, following the usual logic how we parse time values. Similar for LimitRTTIME=. While we are at it, extend a bit on the man page section about resource limits. Fixes: #1772
2015-11-10 23:52:52 +08:00
</table></listitem>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
</varlistentry>
<varlistentry>
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
<term><varname>UMask=</varname></term>
man: add brief documentation for the (sd-pam) processes created due to PAMName= (#4967) A follow-up for #4942, adding a brief but more correct explanation of the processes.
2016-12-29 17:55:27 +08:00
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
<listitem><para>Controls the file mode creation mask. Takes an access mode in octal notation. See
pid1: by default make user units inherit their umask from the user manager This patch changes the way user managers set the default umask for the units it manages. Indeed one can expect that if user manager's umask is redefined through PAM (via /etc/login.defs or pam_umask), all its children including the units it spawns have their umask set to the new value. Hence make user units inherit their umask value from their parent instead of the hard coded value 0022 but allow them to override this value via their unit file. Note that reexecuting managers with 'systemctl daemon-reexec' after changing UMask= has no effect. To take effect managers need to be restarted with 'systemct restart' instead. This behavior was already present before this patch. Fixes #6077.
2020-04-03 16:00:25 +08:00
<citerefentry><refentrytitle>umask</refentrytitle><manvolnum>2</manvolnum></citerefentry> for
man: rework UMask= explanation Mention the JSON user record stuff. Mention pam_umask explicitly. Mention that UMask= of the per-user user@.service instance can be used too. Fixes: #16963
2020-09-14 17:03:59 +08:00
details. Defaults to 0022 for system units. For user units the default value is inherited from the
per-user service manager (whose default is in turn inherited from the system service manager, and
tree-wide: fix typos found by Fossies codespell report
2020-10-24 11:07:19 +08:00
thus typically also is 0022 — unless overridden by a PAM module). In order to change the per-user mask
man: rework UMask= explanation Mention the JSON user record stuff. Mention pam_umask explicitly. Mention that UMask= of the per-user user@.service instance can be used too. Fixes: #16963
2020-09-14 17:03:59 +08:00
for all user services, consider setting the <varname>UMask=</varname> setting of the user's
<filename>user@.service</filename> system service instance. The per-user umask may also be set via
the <varname>umask</varname> field of a user's <ulink url="https://systemd.io/USER_RECORD">JSON User
Record</ulink> (for users managed by
<citerefentry><refentrytitle>systemd-homed.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
this field may be controlled via <command>homectl --umask=</command>). It may also be set via a PAM
module, such as <citerefentry
project='man-pages'><refentrytitle>pam_umask</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para></listitem>
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
</varlistentry>
manager: add CoredumpFilter= setting Fixes #6685.
2020-04-04 22:43:25 +08:00
<varlistentry>
<term><varname>CoredumpFilter=</varname></term>
<listitem><para>Controls which types of memory mappings will be saved if the process dumps core
(using the <filename>/proc/<replaceable>pid</replaceable>/coredump_filter</filename> file). Takes a
whitespace-separated combination of mapping type names or numbers (with the default base 16). Mapping
type names are <constant>private-anonymous</constant>, <constant>shared-anonymous</constant>,
<constant>private-file-backed</constant>, <constant>shared-file-backed</constant>,
<constant>elf-headers</constant>, <constant>private-huge</constant>,
<constant>shared-huge</constant>, <constant>private-dax</constant>, <constant>shared-dax</constant>,
and the special values <constant>all</constant> (all types) and <constant>default</constant> (the
kernel default of <literal><constant>private-anonymous</constant>
<constant>shared-anonymous</constant> <constant>elf-headers</constant>
<constant>private-huge</constant></literal>). See
man: fix links to various external man pages In cases where we used both die-net and man-pages for the same reference, I switched to use man-pages everywhere.
2020-06-25 20:37:24 +08:00
<citerefentry project='man-pages'><refentrytitle>core</refentrytitle><manvolnum>5</manvolnum></citerefentry>
for the meaning of the mapping types. When specified multiple times, all specified masks are
ORed. When not set, or if the empty value is assigned, the inherited value is not changed.</para>
manager: add CoredumpFilter= setting Fixes #6685.
2020-04-04 22:43:25 +08:00
<example>
<title>Add DAX pages to the dump filter</title>
<programlisting>CoredumpFilter=default private-dax shared-dax</programlisting>
</example>
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-23 00:52:36 +08:00
<xi:include href="version-info.xml" xpointer="v246"/>
manager: add CoredumpFilter= setting Fixes #6685.
2020-04-04 22:43:25 +08:00
</listitem>
</varlistentry>
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
<varlistentry>
<term><varname>KeyringMode=</varname></term>
<listitem><para>Controls how the kernel session keyring is set up for the service (see <citerefentry
project='man-pages'><refentrytitle>session-keyring</refentrytitle><manvolnum>7</manvolnum></citerefentry> for
details on the session keyring). Takes one of <option>inherit</option>, <option>private</option>,
<option>shared</option>. If set to <option>inherit</option> no special keyring setup is done, and the kernel's
default behaviour is applied. If <option>private</option> is used a new session keyring is allocated when a
service process is invoked, and it is not linked up with any user keyring. This is the recommended setting for
system services, as this ensures that multiple services running under the same system user ID (in particular
the root user) do not share their key material among each other. If <option>shared</option> is used a new
session keyring is allocated as for <option>private</option>, but the user keyring of the user configured with
<varname>User=</varname> is linked into it, so that keys assigned to the user may be requested by the unit's
man: fix typos
2023-06-21 14:35:03 +08:00
processes. In this mode multiple units running processes under the same user ID may share key material. Unless
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
<option>inherit</option> is selected the unique invocation ID for the unit (see below) is added as a protected
key by the name <literal>invocation_id</literal> to the newly created session keyring. Defaults to
core: change KeyringMode= to "shared" by default for non-service units in the system manager (#8172) Before this change all unit types would default to "private" in the system service manager and "inherit" to in the user service manager. With this change this is slightly altered: non-service units of the system service manager are now run with KeyringMode=shared. This appears to be the more appropriate choice as isolation is not as desirable for mount tools, which regularly consume key material. After all mounts are a shared resource themselves as they appear system-wide hence it makes a lot of sense to share their key material too. Fixes: #8159
2018-02-20 15:53:34 +08:00
<option>private</option> for services of the system service manager and to <option>inherit</option> for
man: update version information As I noticed a lot of missing information when trying to implement checking for missing info. I reimplemented the version information script to be more robust, and here is the result. Follow up to ec07c3c80b2b1bfa6788500202006ff85f5ae4f4
2023-09-18 23:03:38 +08:00
non-service units and for services of the user service manager.</para>
<xi:include href="version-info.xml" xpointer="v235"/></listitem>
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
</varlistentry>
<varlistentry>
<term><varname>OOMScoreAdjust=</varname></term>
man: document new OOMPolicy= setting
2019-03-20 02:54:08 +08:00
<listitem><para>Sets the adjustment value for the Linux kernel's Out-Of-Memory (OOM) killer score for
executed processes. Takes an integer between -1000 (to disable OOM killing of processes of this unit)
and 1000 (to make killing of processes of this unit under memory pressure very likely). See <ulink
tree-wide: link to docs.kernel.org for kernel documentation https://www.kernel.org/ links to https://docs.kernel.org/ for the documentation. See https://git.kernel.org/pub/scm/docs/kernel/website.git/commit/?id=ebc1c372850f249dd143c6d942e66c88ec610520 These URLs are shorter and nicer looking.
2022-07-04 22:26:30 +08:00
url="https://docs.kernel.org/filesystems/proc.html">The /proc Filesystem</ulink> for
tree-wide: use html links for kernel docs Instead of using "*.txt" as reference name, use the actual destination title.
2022-07-02 00:03:09 +08:00
details. If not specified defaults to the OOM score adjustment level of the service manager itself,
which is normally at 0.</para>
man: document new OOMPolicy= setting
2019-03-20 02:54:08 +08:00
<para>Use the <varname>OOMPolicy=</varname> setting of service units to configure how the service
man: Add some punctuation; remove double spaces.
2022-06-15 01:42:59 +08:00
manager shall react to the kernel OOM killer or <command>systemd-oomd</command> terminating a process of the service. See
man: document new OOMPolicy= setting
2019-03-20 02:54:08 +08:00
<citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>
for details.</para></listitem>
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
</varlistentry>
<varlistentry>
<term><varname>TimerSlackNSec=</varname></term>
<listitem><para>Sets the timer slack in nanoseconds for the executed processes. The timer slack controls the
accuracy of wake-ups triggered by timers. See
<citerefentry><refentrytitle>prctl</refentrytitle><manvolnum>2</manvolnum></citerefentry> for more
information. Note that in contrast to most other time span definitions this parameter takes an integer value in
nano-seconds if no unit is specified. The usual time units are understood too.</para></listitem>
</varlistentry>
<varlistentry>
<term><varname>Personality=</varname></term>
<listitem><para>Controls which kernel architecture <citerefentry
man: extend Personality= docs a bit Let's make clear personalities are supported on ARM (as per https://github.com/systemd/systemd/pull/26152#issuecomment-1400321944). Also, clarify that on many archs this functionality is pretty pointless, i.e. where only a single native arch was ever known.
2023-01-24 23:08:09 +08:00
project='man-pages'><refentrytitle>uname</refentrytitle><manvolnum>2</manvolnum></citerefentry> shall
report, when invoked by unit processes. Takes one of the architecture identifiers
<constant>arm64</constant>, <constant>arm64-be</constant>, <constant>arm</constant>,
<constant>arm-be</constant>, <constant>x86</constant>, <constant>x86-64</constant>,
<constant>ppc</constant>, <constant>ppc-le</constant>, <constant>ppc64</constant>,
<constant>ppc64-le</constant>, <constant>s390</constant> or <constant>s390x</constant>. Which
personality architectures are supported depends on the kernel's native architecture. Usually the
tree-wide: "<n>bit" → "<n>-bit" In some places, "<n> bits" is used when more appropriate.
2023-07-02 05:33:20 +08:00
64-bit versions of the various system architectures support their immediate 32-bit personality
man: extend Personality= docs a bit Let's make clear personalities are supported on ARM (as per https://github.com/systemd/systemd/pull/26152#issuecomment-1400321944). Also, clarify that on many archs this functionality is pretty pointless, i.e. where only a single native arch was ever known.
2023-01-24 23:08:09 +08:00
architecture counterpart, but no others. For example, <constant>x86-64</constant> systems support the
<constant>x86-64</constant> and <constant>x86</constant> personalities but no others. The personality
feature is useful when running 32-bit services on a 64-bit host system. If not specified, the
personality is left unmodified and thus reflects the personality of the host system's kernel. This
option is not useful on architectures for which only one native word width was ever available, such
man: update version information As I noticed a lot of missing information when trying to implement checking for missing info. I reimplemented the version information script to be more robust, and here is the result. Follow up to ec07c3c80b2b1bfa6788500202006ff85f5ae4f4
2023-09-18 23:03:38 +08:00
as <constant>m68k</constant> (32-bit only) or <constant>alpha</constant> (64-bit only).</para>
<xi:include href="version-info.xml" xpointer="v209"/></listitem>
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
</varlistentry>
<varlistentry>
<term><varname>IgnoreSIGPIPE=</varname></term>
<listitem><para>Takes a boolean argument. If true, causes <constant>SIGPIPE</constant> to be ignored in the
executed process. Defaults to true because <constant>SIGPIPE</constant> generally is useful only in shell
pipelines.</para></listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>Scheduling</title>
man: move entries to the right section in systemd.directives They were in "miscellaneuos" because of the missing class= assignment. Probably introduced when the split into sections was done.
2019-02-13 17:17:49 +08:00
<variablelist class='unit-directives'>
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
<varlistentry>
<term><varname>Nice=</varname></term>
man: explicit say for priority/weight values whether more is more or less Fixes: #17523
2021-05-26 17:23:06 +08:00
<listitem><para>Sets the default nice level (scheduling priority) for executed processes. Takes an
integer between -20 (highest priority) and 19 (lowest priority). In case of resource contention,
smaller values mean more resources will be made available to the unit's processes, larger values mean
less resources will be made available. See
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
<citerefentry><refentrytitle>setpriority</refentrytitle><manvolnum>2</manvolnum></citerefentry> for
details.</para></listitem>
</varlistentry>
<varlistentry>
<term><varname>CPUSchedulingPolicy=</varname></term>
<listitem><para>Sets the CPU scheduling policy for executed processes. Takes one of <option>other</option>,
<option>batch</option>, <option>idle</option>, <option>fifo</option> or <option>rr</option>. See
man: correct various links As usual, linkchecker ftw!
2020-09-30 20:57:21 +08:00
<citerefentry project='man-pages'><refentrytitle>sched_setscheduler</refentrytitle><manvolnum>2</manvolnum></citerefentry> for
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
details.</para></listitem>
</varlistentry>
<varlistentry>
<term><varname>CPUSchedulingPriority=</varname></term>
man: explicit say for priority/weight values whether more is more or less Fixes: #17523
2021-05-26 17:23:06 +08:00
<listitem><para>Sets the CPU scheduling priority for executed processes. The available priority range
depends on the selected CPU scheduling policy (see above). For real-time scheduling policies an
integer between 1 (lowest priority) and 99 (highest priority) can be used. In case of CPU resource
contention, smaller values mean less CPU time is made available to the service, larger values mean
more. See <citerefentry
project='man-pages'><refentrytitle>sched_setscheduler</refentrytitle><manvolnum>2</manvolnum></citerefentry>
for details. </para></listitem>
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
</varlistentry>
<varlistentry>
<term><varname>CPUSchedulingResetOnFork=</varname></term>
man: link to fork(2) more prominently For #17177.
2020-09-29 16:10:35 +08:00
<listitem><para>Takes a boolean argument. If true, elevated CPU scheduling priorities and policies
will be reset when the executed processes call
<citerefentry project='man-pages'><refentrytitle>fork</refentrytitle><manvolnum>2</manvolnum></citerefentry>,
and can hence not leak into child processes. See
man: correct various links As usual, linkchecker ftw!
2020-09-30 20:57:21 +08:00
<citerefentry project='man-pages'><refentrytitle>sched_setscheduler</refentrytitle><manvolnum>2</manvolnum></citerefentry>
man: link to fork(2) more prominently For #17177.
2020-09-29 16:10:35 +08:00
for details. Defaults to false.</para></listitem>
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
</varlistentry>
<varlistentry>
<term><varname>CPUAffinity=</varname></term>
<listitem><para>Controls the CPU affinity of the executed processes. Takes a list of CPU indices or ranges
core: add support for setting CPUAffinity= to special "numa" value systemd will automatically derive CPU affinity mask from NUMA node mask. Fixes #13248
2020-02-17 20:50:31 +08:00
separated by either whitespace or commas. Alternatively, takes a special "numa" value in which case systemd
automatically derives allowed CPU range based on the value of <varname>NUMAMask=</varname> option. CPU ranges
are specified by the lower and upper CPU indices separated by a dash. This option may be specified more than
once, in which case the specified CPU affinity masks are merged. If the empty string is assigned, the mask
is reset, all assignments prior to this will have no effect. See
man: correct various links As usual, linkchecker ftw!
2020-09-30 20:57:21 +08:00
<citerefentry project='man-pages'><refentrytitle>sched_setaffinity</refentrytitle><manvolnum>2</manvolnum></citerefentry> for
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
details.</para></listitem>
</varlistentry>
core: introduce NUMAPolicy and NUMAMask options Make possible to set NUMA allocation policy for manager. Manager's policy is by default inherited to all forked off processes. However, it is possible to override the policy on per-service basis. Currently we support, these policies: default, prefer, bind, interleave, local. See man 2 set_mempolicy for details on each policy. Overall NUMA policy actually consists of two parts. Policy itself and bitmask representing NUMA nodes where is policy effective. Node mask can be specified using related option, NUMAMask. Default mask can be overwritten on per-service level.
2019-03-13 01:58:26 +08:00
<varlistentry>
<term><varname>NUMAPolicy=</varname></term>
<listitem><para>Controls the NUMA memory policy of the executed processes. Takes a policy type, one of:
<option>default</option>, <option>preferred</option>, <option>bind</option>, <option>interleave</option> and
<option>local</option>. A list of NUMA nodes that should be associated with the policy must be specified
in <varname>NUMAMask=</varname>. For more details on each policy please see,
<citerefentry><refentrytitle>set_mempolicy</refentrytitle><manvolnum>2</manvolnum></citerefentry>. For overall
overview of NUMA support in Linux see,
tree-wide: fixes for assorted grammar and spelling issues Fixes #16363. Also includes some changes where I generalized the pattern.
2020-07-06 16:49:59 +08:00
<citerefentry project='man-pages'><refentrytitle>numa</refentrytitle><manvolnum>7</manvolnum></citerefentry>.
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-23 00:52:36 +08:00
</para>
<xi:include href="version-info.xml" xpointer="v243"/></listitem>
core: introduce NUMAPolicy and NUMAMask options Make possible to set NUMA allocation policy for manager. Manager's policy is by default inherited to all forked off processes. However, it is possible to override the policy on per-service basis. Currently we support, these policies: default, prefer, bind, interleave, local. See man 2 set_mempolicy for details on each policy. Overall NUMA policy actually consists of two parts. Policy itself and bitmask representing NUMA nodes where is policy effective. Node mask can be specified using related option, NUMAMask. Default mask can be overwritten on per-service level.
2019-03-13 01:58:26 +08:00
</varlistentry>
<varlistentry>
<term><varname>NUMAMask=</varname></term>
<listitem><para>Controls the NUMA node list which will be applied alongside with selected NUMA policy.
Takes a list of NUMA nodes and has the same syntax as a list of CPUs for <varname>CPUAffinity=</varname>
core: introduce support for setting NUMAMask= to special "all" value Fixes #14113
2020-09-01 18:12:32 +08:00
option or special "all" value which will include all available NUMA nodes in the mask. Note that the list
of NUMA nodes is not required for <option>default</option> and <option>local</option>
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-23 00:52:36 +08:00
policies and for <option>preferred</option> policy we expect a single NUMA node.</para>
<xi:include href="version-info.xml" xpointer="v243"/></listitem>
core: introduce NUMAPolicy and NUMAMask options Make possible to set NUMA allocation policy for manager. Manager's policy is by default inherited to all forked off processes. However, it is possible to override the policy on per-service basis. Currently we support, these policies: default, prefer, bind, interleave, local. See man 2 set_mempolicy for details on each policy. Overall NUMA policy actually consists of two parts. Policy itself and bitmask representing NUMA nodes where is policy effective. Node mask can be specified using related option, NUMAMask. Default mask can be overwritten on per-service level.
2019-03-13 01:58:26 +08:00
</varlistentry>
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
<varlistentry>
<term><varname>IOSchedulingClass=</varname></term>
man: don't mention IOSchedulingClass=none anymore in the docs Let's not mention a redundant setting of "none". Let's instead only mention "best-effort", which is the same. Also mention the default settings properly. (Also, while we are at it, don#t document the numeric alias, that's totally redundant and harder to use, so no need to push people towards it.)
2021-11-24 22:54:29 +08:00
<listitem><para>Sets the I/O scheduling class for executed processes. Takes one of the strings
<option>realtime</option>, <option>best-effort</option> or <option>idle</option>. The kernel's
default scheduling class is <option>best-effort</option> at a priority of 4. If the empty string is
assigned to this option, all prior assignments to both <varname>IOSchedulingClass=</varname> and
<varname>IOSchedulingPriority=</varname> have no effect. See
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
<citerefentry><refentrytitle>ioprio_set</refentrytitle><manvolnum>2</manvolnum></citerefentry> for
details.</para></listitem>
</varlistentry>
<varlistentry>
<term><varname>IOSchedulingPriority=</varname></term>
man: explicit say for priority/weight values whether more is more or less Fixes: #17523
2021-05-26 17:23:06 +08:00
<listitem><para>Sets the I/O scheduling priority for executed processes. Takes an integer between 0
(highest priority) and 7 (lowest priority). In case of I/O contention, smaller values mean more I/O
bandwidth is made available to the unit's processes, larger values mean less bandwidth. The available
priorities depend on the selected I/O scheduling class (see above). If the empty string is assigned
to this option, all prior assignments to both <varname>IOSchedulingClass=</varname> and
man: don't mention IOSchedulingClass=none anymore in the docs Let's not mention a redundant setting of "none". Let's instead only mention "best-effort", which is the same. Also mention the default settings properly. (Also, while we are at it, don#t document the numeric alias, that's totally redundant and harder to use, so no need to push people towards it.)
2021-11-24 22:54:29 +08:00
<varname>IOSchedulingPriority=</varname> have no effect. For the kernel's default scheduling class
(<option>best-effort</option>) this defaults to 4. See
man: explicit say for priority/weight values whether more is more or less Fixes: #17523
2021-05-26 17:23:06 +08:00
<citerefentry><refentrytitle>ioprio_set</refentrytitle><manvolnum>2</manvolnum></citerefentry> for
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
details.</para></listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>Sandboxing</title>
man: document that most sandboxing options are best effort only
2018-08-10 21:26:32 +08:00
<para>The following sandboxing options are an effective way to limit the exposure of the system towards the unit's
processes. It is recommended to turn on as many of these options for each unit as is possible without negatively
affecting the process' ability to operate. Note that many of these sandboxing features are gracefully turned off on
systems where the underlying security mechanism is not available. For example, <varname>ProtectSystem=</varname>
has no effect if the kernel is built without file system namespacing or if the service manager runs in a container
man: similar → similarly Something *is* similar Something *works* similarly Something does something, similarly to how something else does something See https://sites.ulethbridge.ca/roussel/2017/11/29/similar-and-similarly-are-they-similar/ for a clear explanation.
2022-08-23 18:12:28 +08:00
manager that makes file system namespacing unavailable to its payload. Similarly,
man: document that most sandboxing options are best effort only
2018-08-10 21:26:32 +08:00
<varname>RestrictRealtime=</varname> has no effect on systems that lack support for SECCOMP system call filtering,
or in containers where support for this is turned off.</para>
man: document that various sandboxing settings are not available in --user services This is brief and doesn't go into detail, but should at least indicate to those searching for it that some stuff is not available. Fixes: #9870
2018-10-30 03:24:06 +08:00
<para>Also note that some sandboxing functionality is generally not available in user services (i.e. services run
by the per-user service manager). Specifically, the various settings requiring file system namespacing support
(such as <varname>ProtectSystem=</varname>) are not available, as the underlying kernel functionality is only
core: PrivateUsers=true for (unprivileged) user managers Let per-user service managers have user namespaces too. For unprivileged users, user namespaces are set up much earlier (before the mount, network, and UTS namespaces vs after) in order to obtain capbilities in the new user namespace and enable use of the other listed namespaces. However for privileged users (root), the set up for the user namspace is still done at the end to avoid any restrictions with combining namespaces inside a user namespace (see inline comments). Closes #10576
2019-10-23 08:37:47 +08:00
accessible to privileged processes. However, most namespacing settings, that will not work on their own in user
services, will work when used in conjunction with <varname>PrivateUsers=</varname><option>true</option>.</para>
man: document that various sandboxing settings are not available in --user services This is brief and doesn't go into detail, but should at least indicate to those searching for it that some stuff is not available. Fixes: #9870
2018-10-30 03:24:06 +08:00
man: move entries to the right section in systemd.directives They were in "miscellaneuos" because of the missing class= assignment. Probably introduced when the split into sections was done.
2019-02-13 17:17:49 +08:00
<variablelist class='unit-directives'>
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
<varlistentry>
<term><varname>ProtectSystem=</varname></term>
<listitem><para>Takes a boolean argument or the special values <literal>full</literal> or
man: use trailing slash on directories in more places
2020-10-06 00:08:21 +08:00
<literal>strict</literal>. If true, mounts the <filename>/usr/</filename> and the boot loader
man: mention that ProtectSystem= also takes care of /efi
2020-04-30 00:22:46 +08:00
directories (<filename>/boot</filename> and <filename>/efi</filename>) read-only for processes
man: use trailing slash on directories in more places
2020-10-06 00:08:21 +08:00
invoked by this unit. If set to <literal>full</literal>, the <filename>/etc/</filename> directory is
man: mention that ProtectSystem= also takes care of /efi
2020-04-30 00:22:46 +08:00
mounted read-only, too. If set to <literal>strict</literal> the entire file system hierarchy is
man: use trailing slash on directories in more places
2020-10-06 00:08:21 +08:00
mounted read-only, except for the API file system subtrees <filename>/dev/</filename>,
<filename>/proc/</filename> and <filename>/sys/</filename> (protect these directories using
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
<varname>PrivateDevices=</varname>, <varname>ProtectKernelTunables=</varname>,
<varname>ProtectControlGroups=</varname>). This setting ensures that any modification of the vendor-supplied
man: Add some punctuation; remove double spaces.
2022-06-15 01:42:59 +08:00
operating system (and optionally its configuration, and local mounts) is prohibited for the service. It is
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
recommended to enable this setting for all long-running services, unless they are involved with system updates
or need to modify the operating system in other ways. If this option is used,
<varname>ReadWritePaths=</varname> may be used to exclude specific directories from being made read-only. This
man: emphasize the ReadOnlyPaths= mount propagation "hole" This changes the ProtectSystem= documentation to refer in more explicit words to the restrictions of ReadOnlyPath=, as sugegsted in #9857. THis also extends the paragraph in ReadOnlyPath= that explains the hole. Fixes: #9857
2018-10-30 03:45:04 +08:00
setting is implied if <varname>DynamicUser=</varname> is set. This setting cannot ensure protection in all
cases. In general it has the same limitations as <varname>ReadOnlyPaths=</varname>, see below. Defaults to
man: update version information As I noticed a lot of missing information when trying to implement checking for missing info. I reimplemented the version information script to be more robust, and here is the result. Follow up to ec07c3c80b2b1bfa6788500202006ff85f5ae4f4
2023-09-18 23:03:38 +08:00
off.</para>
<xi:include href="version-info.xml" xpointer="v214"/></listitem>
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
</varlistentry>
<varlistentry>
<term><varname>ProtectHome=</varname></term>
core: add new option 'tmpfs' to ProtectHome= This make ProtectHome= setting can take 'tmpfs'. This is mostly equivalent to `TemporaryFileSystem=/home /run/user /root`.
2018-02-21 08:13:11 +08:00
<listitem><para>Takes a boolean argument or the special values <literal>read-only</literal> or
man: use trailing slash on directories in more places
2020-10-06 00:08:21 +08:00
<literal>tmpfs</literal>. If true, the directories <filename>/home/</filename>,
man: describe interaction with ProtectHome=/InaccessiblePaths= in BindMount= https://github.com/systemd/systemd/issues/7153#issuecomment-485252308 Apparently this is still confusing for people. Longer-term, I think we should just make BindMount= automatically "upgrade" (or "downgrade", depending on how you look at this), any InaccessiblePath= mountpoints to "tmpfs". I don't see much point in forcing users to remember this interaction. But let's at least document the status quo, we can always update the docs if the code changes.
2019-04-23 16:28:38 +08:00
<filename>/root</filename>, and <filename>/run/user</filename> are made inaccessible and empty for
processes invoked by this unit. If set to <literal>read-only</literal>, the three directories are
made read-only instead. If set to <literal>tmpfs</literal>, temporary file systems are mounted on the
three directories in read-only mode. The value <literal>tmpfs</literal> is useful to hide home
directories not relevant to the processes invoked by the unit, while still allowing necessary
directories to be made visible when listed in <varname>BindPaths=</varname> or
<varname>BindReadOnlyPaths=</varname>.</para>
core: add new option 'tmpfs' to ProtectHome= This make ProtectHome= setting can take 'tmpfs'. This is mostly equivalent to `TemporaryFileSystem=/home /run/user /root`.
2018-02-21 08:13:11 +08:00
man: Minor punctuation and word tweak
2022-08-29 10:24:56 +08:00
<para>Setting this to <literal>yes</literal> is mostly equivalent to setting the three directories in
doc: more spelling fixes
2018-06-12 22:19:21 +08:00
<varname>InaccessiblePaths=</varname>. Similarly, <literal>read-only</literal> is mostly equivalent to
core: add new option 'tmpfs' to ProtectHome= This make ProtectHome= setting can take 'tmpfs'. This is mostly equivalent to `TemporaryFileSystem=/home /run/user /root`.
2018-02-21 08:13:11 +08:00
<varname>ReadOnlyPaths=</varname>, and <literal>tmpfs</literal> is mostly equivalent to
man: describe interaction with ProtectHome=/InaccessiblePaths= in BindMount= https://github.com/systemd/systemd/issues/7153#issuecomment-485252308 Apparently this is still confusing for people. Longer-term, I think we should just make BindMount= automatically "upgrade" (or "downgrade", depending on how you look at this), any InaccessiblePath= mountpoints to "tmpfs". I don't see much point in forcing users to remember this interaction. But let's at least document the status quo, we can always update the docs if the code changes.
2019-04-23 16:28:38 +08:00
<varname>TemporaryFileSystem=</varname> with <literal>:ro</literal>.</para>
core: add new option 'tmpfs' to ProtectHome= This make ProtectHome= setting can take 'tmpfs'. This is mostly equivalent to `TemporaryFileSystem=/home /run/user /root`.
2018-02-21 08:13:11 +08:00
man: describe interaction with ProtectHome=/InaccessiblePaths= in BindMount= https://github.com/systemd/systemd/issues/7153#issuecomment-485252308 Apparently this is still confusing for people. Longer-term, I think we should just make BindMount= automatically "upgrade" (or "downgrade", depending on how you look at this), any InaccessiblePath= mountpoints to "tmpfs". I don't see much point in forcing users to remember this interaction. But let's at least document the status quo, we can always update the docs if the code changes.
2019-04-23 16:28:38 +08:00
<para>It is recommended to enable this setting for all long-running services (in particular
network-facing ones), to ensure they cannot get access to private user data, unless the services
actually require access to the user's private data. This setting is implied if
<varname>DynamicUser=</varname> is set. This setting cannot ensure protection in all cases. In
general it has the same limitations as <varname>ReadOnlyPaths=</varname>, see below.</para>
man: say explicitly which settings are not available in --user services Fixes: #3944
2019-03-14 00:24:24 +08:00
man: update version information As I noticed a lot of missing information when trying to implement checking for missing info. I reimplemented the version information script to be more robust, and here is the result. Follow up to ec07c3c80b2b1bfa6788500202006ff85f5ae4f4
2023-09-18 23:03:38 +08:00
<xi:include href="system-or-user-ns.xml" xpointer="singular"/>
<xi:include href="version-info.xml" xpointer="v214"/></listitem>
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
</varlistentry>
<varlistentry>
<term><varname>RuntimeDirectory=</varname></term>
<term><varname>StateDirectory=</varname></term>
<term><varname>CacheDirectory=</varname></term>
<term><varname>LogsDirectory=</varname></term>
<term><varname>ConfigurationDirectory=</varname></term>
man: assorted small fixes This is almost all of #17177.
2020-09-29 18:31:27 +08:00
<listitem><para>These options take a whitespace-separated list of directory names. The specified
directory names must be relative, and may not include <literal>..</literal>. If set, when the unit is
started, one or more directories by the specified names will be created (including their parents)
below the locations defined in the following table. Also, the corresponding environment variable will
be defined with the full paths of the directories. If multiple directories are set, then in the
environment variable the paths are concatenated with colon (<literal>:</literal>).</para>
Table is easier to grasp State goes in CONFIG for users 3rd review
2018-06-07 23:38:10 +08:00
<table>
man: document RUNTIME_DIRECTORY= or friends
2018-09-11 13:24:47 +08:00
<title>Automatic directory creation and environment variables</title>
<tgroup cols='4'>
Table is easier to grasp State goes in CONFIG for users 3rd review
2018-06-07 23:38:10 +08:00
<thead>
<row>
man: tweak XyzDirectory= table a bit
2019-04-01 23:29:02 +08:00
<entry>Directory</entry>
<entry>Below path for system units</entry>
<entry>Below path for user units</entry>
<entry>Environment variable set</entry>
Table is easier to grasp State goes in CONFIG for users 3rd review
2018-06-07 23:38:10 +08:00
</row>
</thead>
<tbody>
<row>
<entry><varname>RuntimeDirectory=</varname></entry>
man: tweak XyzDirectory= table a bit
2019-04-01 23:29:02 +08:00
<entry><filename>/run/</filename></entry>
Table is easier to grasp State goes in CONFIG for users 3rd review
2018-06-07 23:38:10 +08:00
<entry><varname>$XDG_RUNTIME_DIR</varname></entry>
man: document RUNTIME_DIRECTORY= or friends
2018-09-11 13:24:47 +08:00
<entry><varname>$RUNTIME_DIRECTORY</varname></entry>
Table is easier to grasp State goes in CONFIG for users 3rd review
2018-06-07 23:38:10 +08:00
</row>
<row>
<entry><varname>StateDirectory=</varname></entry>
man: tweak XyzDirectory= table a bit
2019-04-01 23:29:02 +08:00
<entry><filename>/var/lib/</filename></entry>
execute: add support for XDG_STATE_HOME for placing service state data in --user mode This adds support for the new XDG_STATE_HOME env var that was added to the xdg basedir spec. Previously, because the basedir spec didn't know the concept we'd alias the backing dir for StateDirectory= to the one for ConfigurationDirectory= when runnin in --user mode. With this change we'll make separate. This brings us various benefits, such as proper "systemctl clean" support, where we can clear service state separately from service configuration, now in user mode too. This does not come without complications: retaining compatibility with older setups is difficult, because we cannot possibly identitfy which files in existing populated config dirs are actually "state" and which one are true" configuration. Hence let's deal with this pragmatically: if we detect that a service that has both dirs configured only has the configuration dir existing, then symlink the state dir to the configuration dir to retain compatibility. This is not great, but it's the only somewhat reasonable way out I can see. Fixes: #25739
2023-06-27 04:42:33 +08:00
<entry><varname>$XDG_STATE_HOME</varname></entry>
man: document RUNTIME_DIRECTORY= or friends
2018-09-11 13:24:47 +08:00
<entry><varname>$STATE_DIRECTORY</varname></entry>
Table is easier to grasp State goes in CONFIG for users 3rd review
2018-06-07 23:38:10 +08:00
</row>
<row>
<entry><varname>CacheDirectory=</varname></entry>
man: tweak XyzDirectory= table a bit
2019-04-01 23:29:02 +08:00
<entry><filename>/var/cache/</filename></entry>
Table is easier to grasp State goes in CONFIG for users 3rd review
2018-06-07 23:38:10 +08:00
<entry><varname>$XDG_CACHE_HOME</varname></entry>
man: document RUNTIME_DIRECTORY= or friends
2018-09-11 13:24:47 +08:00
<entry><varname>$CACHE_DIRECTORY</varname></entry>
Table is easier to grasp State goes in CONFIG for users 3rd review
2018-06-07 23:38:10 +08:00
</row>
<row>
<entry><varname>LogsDirectory=</varname></entry>
man: tweak XyzDirectory= table a bit
2019-04-01 23:29:02 +08:00
<entry><filename>/var/log/</filename></entry>
execute: add support for XDG_STATE_HOME for placing service state data in --user mode This adds support for the new XDG_STATE_HOME env var that was added to the xdg basedir spec. Previously, because the basedir spec didn't know the concept we'd alias the backing dir for StateDirectory= to the one for ConfigurationDirectory= when runnin in --user mode. With this change we'll make separate. This brings us various benefits, such as proper "systemctl clean" support, where we can clear service state separately from service configuration, now in user mode too. This does not come without complications: retaining compatibility with older setups is difficult, because we cannot possibly identitfy which files in existing populated config dirs are actually "state" and which one are true" configuration. Hence let's deal with this pragmatically: if we detect that a service that has both dirs configured only has the configuration dir existing, then symlink the state dir to the configuration dir to retain compatibility. This is not great, but it's the only somewhat reasonable way out I can see. Fixes: #25739
2023-06-27 04:42:33 +08:00
<entry><varname>$XDG_STATE_HOME</varname><filename>/log/</filename></entry>
man: document RUNTIME_DIRECTORY= or friends
2018-09-11 13:24:47 +08:00
<entry><varname>$LOGS_DIRECTORY</varname></entry>
Table is easier to grasp State goes in CONFIG for users 3rd review
2018-06-07 23:38:10 +08:00
</row>
<row>
<entry><varname>ConfigurationDirectory=</varname></entry>
man: tweak XyzDirectory= table a bit
2019-04-01 23:29:02 +08:00
<entry><filename>/etc/</filename></entry>
Table is easier to grasp State goes in CONFIG for users 3rd review
2018-06-07 23:38:10 +08:00
<entry><varname>$XDG_CONFIG_HOME</varname></entry>
man: document RUNTIME_DIRECTORY= or friends
2018-09-11 13:24:47 +08:00
<entry><varname>$CONFIGURATION_DIRECTORY</varname></entry>
Table is easier to grasp State goes in CONFIG for users 3rd review
2018-06-07 23:38:10 +08:00
</row>
</tbody>
</tgroup>
</table>
tree-wide: drop trailing whitespace
2018-06-12 18:03:28 +08:00
man: refer to innermost directory as innermost, not as "lowest" Let's avoid confusion whether the root is at the top or of the bottom of the directory tree. Moreover we use "innermost" further down for the same concept, so let's stick to the same terminology here.
2019-04-01 23:29:12 +08:00
<para>In case of <varname>RuntimeDirectory=</varname> the innermost subdirectories are removed when
the unit is stopped. It is possible to preserve the specified directories in this case if
<varname>RuntimeDirectoryPreserve=</varname> is configured to <option>restart</option> or
<option>yes</option> (see below). The directories specified with <varname>StateDirectory=</varname>,
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
<varname>CacheDirectory=</varname>, <varname>LogsDirectory=</varname>,
<varname>ConfigurationDirectory=</varname> are not removed when the unit is stopped.</para>
<para>Except in case of <varname>ConfigurationDirectory=</varname>, the innermost specified directories will be
owned by the user and group specified in <varname>User=</varname> and <varname>Group=</varname>. If the
specified directories already exist and their owning user or group do not match the configured ones, all files
and directories below the specified directories as well as the directories themselves will have their file
ownership recursively changed to match what is configured. As an optimization, if the specified directories are
already owned by the right user and group, files and directories below of them are left as-is, even if they do
not match what is requested. The innermost specified directories will have their access mode adjusted to the
what is specified in <varname>RuntimeDirectoryMode=</varname>, <varname>StateDirectoryMode=</varname>,
<varname>CacheDirectoryMode=</varname>, <varname>LogsDirectoryMode=</varname> and
<varname>ConfigurationDirectoryMode=</varname>.</para>
man: document that PAMName= and NotifyAccess=all don't mix well. See: #6045
2017-09-29 22:56:51 +08:00
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
<para>These options imply <varname>BindPaths=</varname> for the specified paths. When combined with
<varname>RootDirectory=</varname> or <varname>RootImage=</varname> these paths always reside on the host and
are mounted from there into the unit's file system namespace.</para>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
man: fix incorrect description regarding DynamicUser= and StateDirectory=
2021-06-26 20:23:20 +08:00
<para>If <varname>DynamicUser=</varname> is used, the logic for <varname>CacheDirectory=</varname>,
<varname>LogsDirectory=</varname> and <varname>StateDirectory=</varname> is slightly altered: the directories are created below
<filename>/var/cache/private</filename>, <filename>/var/log/private</filename> and <filename>/var/lib/private</filename>,
respectively, which are host directories made inaccessible to
tree-wide: fixes for assorted grammar and spelling issues Fixes #16363. Also includes some changes where I generalized the pattern.
2020-07-06 16:49:59 +08:00
unprivileged users, which ensures that access to these directories cannot be gained through dynamic
user ID recycling. Symbolic links are created to hide this difference in behaviour. Both from
perspective of the host and from inside the unit, the relevant directories hence always appear
man: fix incorrect description regarding DynamicUser= and StateDirectory=
2021-06-26 20:23:20 +08:00
directly below <filename>/var/cache</filename>, <filename>/var/log</filename> and
<filename>/var/lib</filename>.</para>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
<para>Use <varname>RuntimeDirectory=</varname> to manage one or more runtime directories for the unit and bind
their lifetime to the daemon runtime. This is particularly useful for unprivileged daemons that cannot create
man: use trailing slash on directories in more places
2020-10-06 00:08:21 +08:00
runtime directories in <filename>/run/</filename> due to lack of privileges, and to make sure the runtime
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
directory is cleaned up automatically after use. For runtime directories that require more complex or different
configuration or lifetime guarantees, please consider using
<citerefentry><refentrytitle>tmpfiles.d</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para>
man: add examples for CapabilityBoundingSet= Follow-up for c792ec2e3512a672881fc847ff432e26b641c9c9.
2017-09-04 15:20:47 +08:00
core: add [State|Runtime|Cache|Logs]Directory symlink as second parameter When combined with a tmpfs on /run or /var/lib, allows to create arbitrary and ephemeral symlinks for StateDirectory or RuntimeDirectory. This is especially useful when sharing these directories between different services, to make the same state/runtime directory 'backend' appear as different names to each service, so that they can be added/removed to a sharing agreement transparently, without code changes. An example (simplified, but real) use case: foo.service: StateDirectory=foo bar.service: StateDirectory=bar foo.service.d/shared.conf: StateDirectory= StateDirectory=shared:foo bar.service.d/shared.conf: StateDirectory= StateDirectory=shared:bar foo and bar use respectively /var/lib/foo and /var/lib/bar. Then the orchestration layer decides to stop this sharing, the drop-in can be removed. The services won't need any update and will keep working and being able to store state, transparently. To keep backward compatibility, new DBUS messages are added.
2021-07-15 01:22:21 +08:00
<para><varname>RuntimeDirectory=</varname>, <varname>StateDirectory=</varname>, <varname>CacheDirectory=</varname>
and <varname>LogsDirectory=</varname> optionally support a second parameter, separated by <literal>:</literal>.
The second parameter will be interpreted as a destination path that will be created as a symlink to the directory.
The symlinks will be created after any <varname>BindPaths=</varname> or <varname>TemporaryFileSystem=</varname>
options have been set up, to make ephemeral symlinking possible. The same source can have multiple symlinks, by
man: properly close XML tags
2023-06-27 16:32:11 +08:00
using the same first parameter, but a different second parameter.</para>
core: add [State|Runtime|Cache|Logs]Directory symlink as second parameter When combined with a tmpfs on /run or /var/lib, allows to create arbitrary and ephemeral symlinks for StateDirectory or RuntimeDirectory. This is especially useful when sharing these directories between different services, to make the same state/runtime directory 'backend' appear as different names to each service, so that they can be added/removed to a sharing agreement transparently, without code changes. An example (simplified, but real) use case: foo.service: StateDirectory=foo bar.service: StateDirectory=bar foo.service.d/shared.conf: StateDirectory= StateDirectory=shared:foo bar.service.d/shared.conf: StateDirectory= StateDirectory=shared:bar foo and bar use respectively /var/lib/foo and /var/lib/bar. Then the orchestration layer decides to stop this sharing, the drop-in can be removed. The services won't need any update and will keep working and being able to store state, transparently. To keep backward compatibility, new DBUS messages are added.
2021-07-15 01:22:21 +08:00
man: Add some notes about variable $prefix for StateDirectory= tl;dr: It isn’t supported. Wording by Zbigniew Jędrzejewski-Szmek. See https://twitter.com/pid_eins/status/1102639279614906369 and https://gitlab.freedesktop.org/libfprint/fprintd/merge_requests/5#note_125536 onwards. Signed-off-by: Philip Withnall <withnall@endlessm.com>
2019-07-03 21:00:48 +08:00
<para>The directories defined by these options are always created under the standard paths used by systemd
man: use trailing slash on directories in more places
2020-10-06 00:08:21 +08:00
(<filename>/var/</filename>, <filename>/run/</filename>, <filename>/etc/</filename>, …). If the service needs
man: Add some notes about variable $prefix for StateDirectory= tl;dr: It isn’t supported. Wording by Zbigniew Jędrzejewski-Szmek. See https://twitter.com/pid_eins/status/1102639279614906369 and https://gitlab.freedesktop.org/libfprint/fprintd/merge_requests/5#note_125536 onwards. Signed-off-by: Philip Withnall <withnall@endlessm.com>
2019-07-03 21:00:48 +08:00
directories in a different location, a different mechanism has to be used to create them.</para>
<para><citerefentry><refentrytitle>tmpfiles.d</refentrytitle><manvolnum>5</manvolnum></citerefentry> provides
functionality that overlaps with these options. Using these options is recommended, because the lifetime of
the directories is tied directly to the lifetime of the unit, and it is not necessary to ensure that the
<filename>tmpfiles.d</filename> configuration is executed before the unit is started.</para>
man: document new "systemctl clean…" operation
2019-04-01 23:28:29 +08:00
<para>To remove any of the directories created by these settings, use the <command>systemctl clean
…</command> command on the relevant units, see
<citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry> for
details.</para>
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
<para>Example: if a system service unit has the following,
<programlisting>RuntimeDirectory=foo/bar baz</programlisting>
man: do not index various /foobar/ paths For #17177.
2020-09-29 16:04:12 +08:00
the service manager creates <filename index='false'>/run/foo</filename> (if it does not exist),
man: fix a few bogus entries in directives index When wrong element types are used, directives are sometimes placed in the wrong section. Also, strip part of text starting with "'", which is used in a few places and which is displayed improperly in the index.
2019-11-22 03:33:26 +08:00
<filename index='false'>/run/foo/bar</filename>, and <filename index='false'>/run/baz</filename>. The
directories <filename index='false'>/run/foo/bar</filename> and
<filename index='false'>/run/baz</filename> except <filename index='false'>/run/foo</filename> are
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
owned by the user and group specified in <varname>User=</varname> and <varname>Group=</varname>, and removed
man: document RUNTIME_DIRECTORY= or friends
2018-09-11 13:24:47 +08:00
when the service is stopped.</para>
<para>Example: if a system service unit has the following,
<programlisting>RuntimeDirectory=foo/bar
StateDirectory=aaa/bbb ccc</programlisting>
then the environment variable <literal>RUNTIME_DIRECTORY</literal> is set with <literal>/run/foo/bar</literal>, and
core: add [State|Runtime|Cache|Logs]Directory symlink as second parameter When combined with a tmpfs on /run or /var/lib, allows to create arbitrary and ephemeral symlinks for StateDirectory or RuntimeDirectory. This is especially useful when sharing these directories between different services, to make the same state/runtime directory 'backend' appear as different names to each service, so that they can be added/removed to a sharing agreement transparently, without code changes. An example (simplified, but real) use case: foo.service: StateDirectory=foo bar.service: StateDirectory=bar foo.service.d/shared.conf: StateDirectory= StateDirectory=shared:foo bar.service.d/shared.conf: StateDirectory= StateDirectory=shared:bar foo and bar use respectively /var/lib/foo and /var/lib/bar. Then the orchestration layer decides to stop this sharing, the drop-in can be removed. The services won't need any update and will keep working and being able to store state, transparently. To keep backward compatibility, new DBUS messages are added.
2021-07-15 01:22:21 +08:00
<literal>STATE_DIRECTORY</literal> is set with <literal>/var/lib/aaa/bbb:/var/lib/ccc</literal>.</para>
<para>Example: if a system service unit has the following,
<programlisting>RuntimeDirectory=foo:bar foo:baz</programlisting>
the service manager creates <filename index='false'>/run/foo</filename> (if it does not exist), and
<filename index='false'>/run/bar</filename> plus <filename index='false'>/run/baz</filename> as symlinks to
man: update version information As I noticed a lot of missing information when trying to implement checking for missing info. I reimplemented the version information script to be more robust, and here is the result. Follow up to ec07c3c80b2b1bfa6788500202006ff85f5ae4f4
2023-09-18 23:03:38 +08:00
<filename index='false'>/run/foo</filename>.</para>
<xi:include href="version-info.xml" xpointer="v211"/></listitem>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
</varlistentry>
man: add AmbientCapabilities entry.
2016-01-11 15:36:14 +08:00
<varlistentry>
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
<term><varname>RuntimeDirectoryMode=</varname></term>
<term><varname>StateDirectoryMode=</varname></term>
<term><varname>CacheDirectoryMode=</varname></term>
<term><varname>LogsDirectoryMode=</varname></term>
<term><varname>ConfigurationDirectoryMode=</varname></term>
man: add AmbientCapabilities entry.
2016-01-11 15:36:14 +08:00
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
<listitem><para>Specifies the access mode of the directories specified in <varname>RuntimeDirectory=</varname>,
<varname>StateDirectory=</varname>, <varname>CacheDirectory=</varname>, <varname>LogsDirectory=</varname>, or
man: Add some punctuation; remove double spaces.
2022-06-15 01:42:59 +08:00
<varname>ConfigurationDirectory=</varname>, respectively, as an octal number. Defaults to
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
<constant>0755</constant>. See "Permissions" in <citerefentry
project='man-pages'><refentrytitle>path_resolution</refentrytitle><manvolnum>7</manvolnum></citerefentry> for a
man: update version information As I noticed a lot of missing information when trying to implement checking for missing info. I reimplemented the version information script to be more robust, and here is the result. Follow up to ec07c3c80b2b1bfa6788500202006ff85f5ae4f4
2023-09-18 23:03:38 +08:00
discussion of the meaning of permission bits.</para>
<xi:include href="version-info.xml" xpointer="v234"/></listitem>
man: add AmbientCapabilities entry.
2016-01-11 15:36:14 +08:00
</varlistentry>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
<varlistentry>
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
<term><varname>RuntimeDirectoryPreserve=</varname></term>
man: Add some punctuation; remove double spaces.
2022-06-15 01:42:59 +08:00
<listitem><para>Takes a boolean argument or <option>restart</option>. If set to <option>no</option> (the
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
default), the directories specified in <varname>RuntimeDirectory=</varname> are always removed when the service
stops. If set to <option>restart</option> the directories are preserved when the service is both automatically
and manually restarted. Here, the automatic restart means the operation specified in
<varname>Restart=</varname>, and manual restart means the one triggered by <command>systemctl restart
foo.service</command>. If set to <option>yes</option>, then the directories are not removed when the service is
man: use trailing slash on directories in more places
2020-10-06 00:08:21 +08:00
stopped. Note that since the runtime directory <filename>/run/</filename> is a mount point of
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
<literal>tmpfs</literal>, then for system services the directories specified in
man: update version information As I noticed a lot of missing information when trying to implement checking for missing info. I reimplemented the version information script to be more robust, and here is the result. Follow up to ec07c3c80b2b1bfa6788500202006ff85f5ae4f4
2023-09-18 23:03:38 +08:00
<varname>RuntimeDirectory=</varname> are removed when the system is rebooted.</para>
<xi:include href="version-info.xml" xpointer="v235"/></listitem>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
</varlistentry>
man: move TimeoutCleanSec= entry from .service to .exec Follow-up for 12213aed128456af33ff6131a14b637318227346. Closes #13546.
2019-09-13 16:12:59 +08:00
<varlistentry>
<term><varname>TimeoutCleanSec=</varname></term>
<listitem><para>Configures a timeout on the clean-up operation requested through <command>systemctl
clean …</command>, see
<citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry> for
details. Takes the usual time values and defaults to <constant>infinity</constant>, i.e. by default
tree-wide: s/time-out/timeout/g See 3f9a0a522f2029e9295ea5e9984259022be88413 for justification.
2020-05-22 15:39:36 +08:00
no timeout is applied. If a timeout is configured the clean operation will be aborted forcibly when
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-23 00:52:36 +08:00
the timeout is reached, potentially leaving resources on disk.</para>
<xi:include href="version-info.xml" xpointer="v244"/></listitem>
man: move TimeoutCleanSec= entry from .service to .exec Follow-up for 12213aed128456af33ff6131a14b637318227346. Closes #13546.
2019-09-13 16:12:59 +08:00
</varlistentry>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
<varlistentry>
doc,core: Read{Write,Only}Paths= and InaccessiblePaths= This patch renames Read{Write,Only}Directories= and InaccessibleDirectories= to Read{Write,Only}Paths= and InaccessiblePaths=, previous names are kept as aliases but they are not advertised in the documentation. Renamed variables: `read_write_dirs` --> `read_write_paths` `read_only_dirs` --> `read_only_paths` `inaccessible_dirs` --> `inaccessible_paths`
2016-07-07 17:17:00 +08:00
<term><varname>ReadWritePaths=</varname></term>
<term><varname>ReadOnlyPaths=</varname></term>
<term><varname>InaccessiblePaths=</varname></term>
New directives NoExecPaths= ExecPaths= Implement directives `NoExecPaths=` and `ExecPaths=` to control `MS_NOEXEC` mount flag for the file system tree. This can be used to implement file system W^X policies, and for example with allow-listing mode (NoExecPaths=/) a compromised service would not be able to execute a shell, if that was not explicitly allowed. Example: [Service] NoExecPaths=/ ExecPaths=/usr/bin/daemon /usr/lib64 /usr/lib Closes: #17942.
2021-01-16 19:49:32 +08:00
<term><varname>ExecPaths=</varname></term>
<term><varname>NoExecPaths=</varname></term>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
man: assorted small fixes This is almost all of #17177.
2020-09-29 18:31:27 +08:00
<listitem><para>Sets up a new file system namespace for executed processes. These options may be used
to limit access a process has to the file system. Each setting takes a space-separated list of paths
relative to the host's root directory (i.e. the system running the service manager). Note that if
paths contain symlinks, they are resolved relative to the root directory set with
core: add RootImage= setting for using a specific image file as root directory for a service This is similar to RootDirectory= but mounts the root file system from a block device or loopback file instead of another directory. This reuses the image dissector code now used by nspawn and gpt-auto-discovery.
2016-12-23 21:26:05 +08:00
<varname>RootDirectory=</varname>/<varname>RootImage=</varname>.</para>
man: rework documentation for ReadOnlyPaths= and related settings This reworks the documentation for ReadOnlyPaths=, ReadWritePaths=, InaccessiblePaths=. It no longer claims that we'd follow symlinks relative to the host file system. (Which wasn't true actually, as we didn't follow symlinks at all in the most recent releases, and we know do follow them, but relative to RootDirectory=). This also replaces all references to the fact that all fs namespacing options can be undone with enough privileges and disable propagation by a single one in the documentation of ReadOnlyPaths= and friends, and then directs the read to this in all other places. Moreover a hint is added to the documentation of SystemCallFilter=, suggesting usage of ~@mount in case any of the fs namespacing related options are used.
2016-08-26 18:24:37 +08:00
tree-wide: avoid some loaded terms https://tools.ietf.org/html/draft-knodel-terminology-02 https://lwn.net/Articles/823224/ This gets rid of most but not occasions of these loaded terms: 1. scsi_id and friends are something that is supposed to be removed from our tree (see #7594) 2. The test suite defines an API used by the ubuntu CI. We can remove this too later, but this needs to be done in sync with the ubuntu CI. 3. In some cases the terms are part of APIs we call or where we expose concepts the kernel names the way it names them. (In particular all remaining uses of the word "slave" in our codebase are like this, it's used by the POSIX PTY layer, by the network subsystem, the mount API and the block device subsystem). Getting rid of the term in these contexts would mean doing some major fixes of the kernel ABI first. Regarding the replacements: when whitelist/blacklist is used as noun we replace with with allow list/deny list, and when used as verb with allow-list/deny-list.
2020-06-23 14:31:16 +08:00
<para>Paths listed in <varname>ReadWritePaths=</varname> are accessible from within the namespace
with the same access modes as from outside of it. Paths listed in <varname>ReadOnlyPaths=</varname>
are accessible for reading only, writing will be refused even if the usual file access controls would
permit this. Nest <varname>ReadWritePaths=</varname> inside of <varname>ReadOnlyPaths=</varname> in
order to provide writable subdirectories within read-only directories. Use
<varname>ReadWritePaths=</varname> in order to allow-list specific paths for write access if
<varname>ProtectSystem=strict</varname> is used.</para>
man: suggests TemporaryFileSystem= when people want to nest bind mounts inside InaccessiblePaths= (#8288) Suggested by @sourcejedi in #8242. Closes #7895, #7153, and #2780.
2018-02-27 15:59:03 +08:00
<para>Paths listed in <varname>InaccessiblePaths=</varname> will be made inaccessible for processes inside
the namespace along with everything below them in the file system hierarchy. This may be more restrictive than
desired, because it is not possible to nest <varname>ReadWritePaths=</varname>, <varname>ReadOnlyPaths=</varname>,
<varname>BindPaths=</varname>, or <varname>BindReadOnlyPaths=</varname> inside it. For a more flexible option,
see <varname>TemporaryFileSystem=</varname>.</para>
man: rework documentation for ReadOnlyPaths= and related settings This reworks the documentation for ReadOnlyPaths=, ReadWritePaths=, InaccessiblePaths=. It no longer claims that we'd follow symlinks relative to the host file system. (Which wasn't true actually, as we didn't follow symlinks at all in the most recent releases, and we know do follow them, but relative to RootDirectory=). This also replaces all references to the fact that all fs namespacing options can be undone with enough privileges and disable propagation by a single one in the documentation of ReadOnlyPaths= and friends, and then directs the read to this in all other places. Moreover a hint is added to the documentation of SystemCallFilter=, suggesting usage of ~@mount in case any of the fs namespacing related options are used.
2016-08-26 18:24:37 +08:00
New directives NoExecPaths= ExecPaths= Implement directives `NoExecPaths=` and `ExecPaths=` to control `MS_NOEXEC` mount flag for the file system tree. This can be used to implement file system W^X policies, and for example with allow-listing mode (NoExecPaths=/) a compromised service would not be able to execute a shell, if that was not explicitly allowed. Example: [Service] NoExecPaths=/ ExecPaths=/usr/bin/daemon /usr/lib64 /usr/lib Closes: #17942.
2021-01-16 19:49:32 +08:00
<para>Content in paths listed in <varname>NoExecPaths=</varname> are not executable even if the usual
file access controls would permit this. Nest <varname>ExecPaths=</varname> inside of
<varname>NoExecPaths=</varname> in order to provide executable content within non-executable
directories.</para>
man: emphasize the ReadOnlyPaths= mount propagation "hole" This changes the ProtectSystem= documentation to refer in more explicit words to the restrictions of ReadOnlyPath=, as sugegsted in #9857. THis also extends the paragraph in ReadOnlyPath= that explains the hole. Fixes: #9857
2018-10-30 03:45:04 +08:00
<para>Non-directory paths may be specified as well. These options may be specified more than once,
man: rework documentation for ReadOnlyPaths= and related settings This reworks the documentation for ReadOnlyPaths=, ReadWritePaths=, InaccessiblePaths=. It no longer claims that we'd follow symlinks relative to the host file system. (Which wasn't true actually, as we didn't follow symlinks at all in the most recent releases, and we know do follow them, but relative to RootDirectory=). This also replaces all references to the fact that all fs namespacing options can be undone with enough privileges and disable propagation by a single one in the documentation of ReadOnlyPaths= and friends, and then directs the read to this in all other places. Moreover a hint is added to the documentation of SystemCallFilter=, suggesting usage of ~@mount in case any of the fs namespacing related options are used.
2016-08-26 18:24:37 +08:00
in which case all paths listed will have limited access from within the namespace. If the empty string is
assigned to this option, the specific list is reset, and all prior assignments have no effect.</para>
New directives NoExecPaths= ExecPaths= Implement directives `NoExecPaths=` and `ExecPaths=` to control `MS_NOEXEC` mount flag for the file system tree. This can be used to implement file system W^X policies, and for example with allow-listing mode (NoExecPaths=/) a compromised service would not be able to execute a shell, if that was not explicitly allowed. Example: [Service] NoExecPaths=/ ExecPaths=/usr/bin/daemon /usr/lib64 /usr/lib Closes: #17942.
2021-01-16 19:49:32 +08:00
<para>Paths in <varname>ReadWritePaths=</varname>, <varname>ReadOnlyPaths=</varname>,
<varname>InaccessiblePaths=</varname>, <varname>ExecPaths=</varname> and
<varname>NoExecPaths=</varname> may be prefixed with <literal>-</literal>, in which case they will be
namespace: simplify, optimize and extend handling of mounts for namespace This changes a couple of things in the namespace handling: It merges the BindMount and TargetMount structures. They are mostly the same, hence let's just use the same structue, and rely on C's implicit zero initialization of partially initialized structures for the unneeded fields. This reworks memory management of each entry a bit. It now contains one "const" and one "malloc" path. We use the former whenever we can, but use the latter when we have to, which is the case when we have to chase symlinks or prefix a root directory. This means in the common case we don't actually need to allocate any dynamic memory. To make this easy to use we add an accessor function bind_mount_path() which retrieves the right path string from a BindMount structure. While we are at it, also permit "+" as prefix for dirs configured with ReadOnlyPaths= and friends: if specified the root directory of the unit is implicited prefixed. This also drops set_bind_mount() and uses C99 structure initialization instead, which I think is more readable and clarifies what is being done. This drops append_protect_kernel_tunables() and append_protect_kernel_modules() as append_static_mounts() is now simple enough to be called directly. Prefixing with the root dir is now done in an explicit step in prefix_where_needed(). It will prepend the root directory on each entry that doesn't have it prefixed yet. The latter is determined depending on an extra bit in the BindMount structure.
2016-11-15 08:42:54 +08:00
ignored when they do not exist. If prefixed with <literal>+</literal> the paths are taken relative to the root
core: add RootImage= setting for using a specific image file as root directory for a service This is similar to RootDirectory= but mounts the root file system from a block device or loopback file instead of another directory. This reuses the image dissector code now used by nspawn and gpt-auto-discovery.
2016-12-23 21:26:05 +08:00
directory of the unit, as configured with <varname>RootDirectory=</varname>/<varname>RootImage=</varname>,
instead of relative to the root directory of the host (see above). When combining <literal>-</literal> and
<literal>+</literal> on the same path make sure to specify <literal>-</literal> first, and <literal>+</literal>
second.</para>
namespace: simplify, optimize and extend handling of mounts for namespace This changes a couple of things in the namespace handling: It merges the BindMount and TargetMount structures. They are mostly the same, hence let's just use the same structue, and rely on C's implicit zero initialization of partially initialized structures for the unneeded fields. This reworks memory management of each entry a bit. It now contains one "const" and one "malloc" path. We use the former whenever we can, but use the latter when we have to, which is the case when we have to chase symlinks or prefix a root directory. This means in the common case we don't actually need to allocate any dynamic memory. To make this easy to use we add an accessor function bind_mount_path() which retrieves the right path string from a BindMount structure. While we are at it, also permit "+" as prefix for dirs configured with ReadOnlyPaths= and friends: if specified the root directory of the unit is implicited prefixed. This also drops set_bind_mount() and uses C99 structure initialization instead, which I think is more readable and clarifies what is being done. This drops append_protect_kernel_tunables() and append_protect_kernel_modules() as append_static_mounts() is now simple enough to be called directly. Prefixing with the root dir is now done in an explicit step in prefix_where_needed(). It will prepend the root directory on each entry that doesn't have it prefixed yet. The latter is determined depending on an extra bit in the BindMount structure.
2016-11-15 08:42:54 +08:00
man: emphasize the ReadOnlyPaths= mount propagation "hole" This changes the ProtectSystem= documentation to refer in more explicit words to the restrictions of ReadOnlyPath=, as sugegsted in #9857. THis also extends the paragraph in ReadOnlyPath= that explains the hole. Fixes: #9857
2018-10-30 03:45:04 +08:00
<para>Note that these settings will disconnect propagation of mounts from the unit's processes to the
host. This means that this setting may not be used for services which shall be able to install mount points in
man: Minor punctuation and word tweak
2022-08-29 10:24:56 +08:00
the main mount namespace. For <varname>ReadWritePaths=</varname> and <varname>ReadOnlyPaths=</varname>,
man: emphasize the ReadOnlyPaths= mount propagation "hole" This changes the ProtectSystem= documentation to refer in more explicit words to the restrictions of ReadOnlyPath=, as sugegsted in #9857. THis also extends the paragraph in ReadOnlyPath= that explains the hole. Fixes: #9857
2018-10-30 03:45:04 +08:00
propagation in the other direction is not affected, i.e. mounts created on the host generally appear in the
unit processes' namespace, and mounts removed on the host also disappear there too. In particular, note that
mount propagation from host to unit will result in unmodified mounts to be created in the unit's namespace,
i.e. writable mounts appearing on the host will be writable in the unit's namespace too, even when propagated
below a path marked with <varname>ReadOnlyPaths=</varname>! Restricting access with these options hence does
not extend to submounts of a directory that are created later on. This means the lock-down offered by that
man/systemd.exec: document that API fs are required to setup namespacing Closes #27997
2023-10-05 05:04:12 +08:00
setting is not complete, and does not offer full protection.</para>
man: emphasize the ReadOnlyPaths= mount propagation "hole" This changes the ProtectSystem= documentation to refer in more explicit words to the restrictions of ReadOnlyPath=, as sugegsted in #9857. THis also extends the paragraph in ReadOnlyPath= that explains the hole. Fixes: #9857
2018-10-30 03:45:04 +08:00
<para>Note that the effect of these settings may be undone by privileged processes. In order to set up an
effective sandboxed environment for a unit it is thus recommended to combine these settings with either
man/systemd.exec: document that API fs are required to setup namespacing Closes #27997
2023-10-05 05:04:12 +08:00
<varname>CapabilityBoundingSet=~CAP_SYS_ADMIN</varname> or <varname>SystemCallFilter=~@mount</varname>.</para>
<para>Please be extra careful when applying these options to API file systems (a list of them could be
found in <varname>MountAPIVPS=</varname>), since they may be required for basic system functionalities.
Moreover, <filename>/run/</filename> needs to be writable for setting up mount namespace and propagation.</para>
man: say explicitly which settings are not available in --user services Fixes: #3944
2019-03-14 00:24:24 +08:00
New directives NoExecPaths= ExecPaths= Implement directives `NoExecPaths=` and `ExecPaths=` to control `MS_NOEXEC` mount flag for the file system tree. This can be used to implement file system W^X policies, and for example with allow-listing mode (NoExecPaths=/) a compromised service would not be able to execute a shell, if that was not explicitly allowed. Example: [Service] NoExecPaths=/ ExecPaths=/usr/bin/daemon /usr/lib64 /usr/lib Closes: #17942.
2021-01-16 19:49:32 +08:00
<para>Simple allow-list example using these directives:
<programlisting>[Service]
ReadOnlyPaths=/
ReadWritePaths=/var /run
InaccessiblePaths=-/lost+found
NoExecPaths=/
ExecPaths=/usr/sbin/my_daemon /usr/lib /usr/lib64
</programlisting></para>
man: update version information As I noticed a lot of missing information when trying to implement checking for missing info. I reimplemented the version information script to be more robust, and here is the result. Follow up to ec07c3c80b2b1bfa6788500202006ff85f5ae4f4
2023-09-18 23:03:38 +08:00
<xi:include href="system-or-user-ns.xml" xpointer="plural"/>
<xi:include href="version-info.xml" xpointer="v231"/></listitem>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
</varlistentry>
man: add documents for TemporaryFileSystem=
2018-02-21 08:10:27 +08:00
<varlistentry>
<term><varname>TemporaryFileSystem=</varname></term>
<listitem><para>Takes a space-separated list of mount points for temporary file systems (tmpfs). If set, a new file
system namespace is set up for executed processes, and a temporary file system is mounted on each mount point.
This option may be specified more than once, in which case temporary file systems are mounted on all listed mount
points. If the empty string is assigned to this option, the list is reset, and all prior assignments have no effect.
Each mount point may optionally be suffixed with a colon (<literal>:</literal>) and mount options such as
<literal>size=10%</literal> or <literal>ro</literal>. By default, each temporary file system is mounted
with <literal>nodev,strictatime,mode=0755</literal>. These can be disabled by explicitly specifying the corresponding
mount options, e.g., <literal>dev</literal> or <literal>nostrictatime</literal>.</para>
<para>This is useful to hide files or directories not relevant to the processes invoked by the unit, while necessary
files or directories can be still accessed by combining with <varname>BindPaths=</varname> or
man: describe interaction with ProtectHome=/InaccessiblePaths= in BindMount= https://github.com/systemd/systemd/issues/7153#issuecomment-485252308 Apparently this is still confusing for people. Longer-term, I think we should just make BindMount= automatically "upgrade" (or "downgrade", depending on how you look at this), any InaccessiblePath= mountpoints to "tmpfs". I don't see much point in forcing users to remember this interaction. But let's at least document the status quo, we can always update the docs if the code changes.
2019-04-23 16:28:38 +08:00
<varname>BindReadOnlyPaths=</varname>:</para>
man: add documents for TemporaryFileSystem=
2018-02-21 08:10:27 +08:00
<para>Example: if a unit has the following,
<programlisting>TemporaryFileSystem=/var:ro
BindReadOnlyPaths=/var/lib/systemd</programlisting>
man: use trailing slash on directories in more places
2020-10-06 00:08:21 +08:00
then the invoked processes by the unit cannot see any files or directories under <filename>/var/</filename> except for
man: say explicitly which settings are not available in --user services Fixes: #3944
2019-03-14 00:24:24 +08:00
<filename>/var/lib/systemd</filename> or its contents.</para>
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-23 00:52:36 +08:00
<xi:include href="system-or-user-ns.xml" xpointer="singular"/>
<xi:include href="version-info.xml" xpointer="v238"/></listitem>
man: add documents for TemporaryFileSystem=
2018-02-21 08:10:27 +08:00
</varlistentry>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
<varlistentry>
<term><varname>PrivateTmp=</varname></term>
man: use trailing slash on directories in more places
2020-10-06 00:08:21 +08:00
<listitem><para>Takes a boolean argument. If true, sets up a new file system namespace for the
executed processes and mounts private <filename>/tmp/</filename> and <filename>/var/tmp/</filename>
directories inside it that are not shared by processes outside of the namespace. This is useful to
secure access to temporary files of the process, but makes sharing between processes via
man: various typos and other small issues Fixes #18397.
2021-01-29 03:38:27 +08:00
<filename>/tmp/</filename> or <filename>/var/tmp/</filename> impossible. If true, all temporary files
created by a service in these directories will be removed after the service is stopped. Defaults to
false. It is possible to run two or more units within the same private <filename>/tmp/</filename> and
<filename>/var/tmp/</filename> namespace by using the <varname>JoinsNamespaceOf=</varname> directive,
see <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>
man: Add some punctuation; remove double spaces.
2022-06-15 01:42:59 +08:00
for details. This setting is implied if <varname>DynamicUser=</varname> is set. For this setting, the
man: various typos and other small issues Fixes #18397.
2021-01-29 03:38:27 +08:00
same restrictions regarding mount propagation and privileges apply as for
man: use trailing slash on directories in more places
2020-10-06 00:08:21 +08:00
<varname>ReadOnlyPaths=</varname> and related calls, see above. Enabling this setting has the side
effect of adding <varname>Requires=</varname> and <varname>After=</varname> dependencies on all mount
units necessary to access <filename>/tmp/</filename> and <filename>/var/tmp/</filename>. Moreover an
implicitly <varname>After=</varname> ordering on
core: implicitly order units with PrivateTmp= after systemd-tmpfiles-setup.service Preparation for fixing #4401.
2016-12-28 06:25:24 +08:00
<citerefentry><refentrytitle>systemd-tmpfiles-setup.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
man: add warnings that Private*= settings are not always applied
2017-07-12 01:36:15 +08:00
is added.</para>
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
<para>Note that the implementation of this setting might be impossible (for example if mount namespaces are not
available), and the unit should be written in a way that does not solely rely on this setting for
man: say explicitly which settings are not available in --user services Fixes: #3944
2019-03-14 00:24:24 +08:00
security.</para>
Add tests and documentation for all remaining sandboxing in user manager
2022-03-13 05:16:32 +08:00
<xi:include href="system-or-user-ns.xml" xpointer="singular"/></listitem>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
</varlistentry>
<varlistentry>
<term><varname>PrivateDevices=</varname></term>
man: cross-reference DeviceAllow= and PrivateDevices= They are somewhat similar, but not easy to discover, esp. considering that they are described in different pages. For PrivateDevices=, split out the first paragraph that gives the high-level overview. (The giant second paragraph could also use some heavy editing to break it up into more digestible chunks, alas.)
2021-09-08 21:46:17 +08:00
<listitem><para>Takes a boolean argument. If true, sets up a new <filename>/dev/</filename> mount for
the executed processes and only adds API pseudo devices such as <filename>/dev/null</filename>,
<filename>/dev/zero</filename> or <filename>/dev/random</filename> (as well as the pseudo TTY
subsystem) to it, but no physical devices such as <filename>/dev/sda</filename>, system memory
<filename>/dev/mem</filename>, system ports <filename>/dev/port</filename> and others. This is useful
to turn off physical device access by the executed process. Defaults to false.</para>
<para>Enabling this option will install a system call filter to block low-level I/O system calls that
are grouped in the <varname>@raw-io</varname> set, remove <constant>CAP_MKNOD</constant> and
<constant>CAP_SYS_RAWIO</constant> from the capability bounding set for the unit, and set
<varname>DevicePolicy=closed</varname> (see
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
<citerefentry><refentrytitle>systemd.resource-control</refentrytitle><manvolnum>5</manvolnum></citerefentry>
man: cross-reference DeviceAllow= and PrivateDevices= They are somewhat similar, but not easy to discover, esp. considering that they are described in different pages. For PrivateDevices=, split out the first paragraph that gives the high-level overview. (The giant second paragraph could also use some heavy editing to break it up into more digestible chunks, alas.)
2021-09-08 21:46:17 +08:00
for details). Note that using this setting will disconnect propagation of mounts from the service to
the host (propagation in the opposite direction continues to work). This means that this setting may
not be used for services which shall be able to install mount points in the main mount namespace. The
new <filename>/dev/</filename> will be mounted read-only and 'noexec'. The latter may break old
programs which try to set up executable memory by using
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
<citerefentry><refentrytitle>mmap</refentrytitle><manvolnum>2</manvolnum></citerefentry> of
man: cross-reference DeviceAllow= and PrivateDevices= They are somewhat similar, but not easy to discover, esp. considering that they are described in different pages. For PrivateDevices=, split out the first paragraph that gives the high-level overview. (The giant second paragraph could also use some heavy editing to break it up into more digestible chunks, alas.)
2021-09-08 21:46:17 +08:00
<filename>/dev/zero</filename> instead of using <constant>MAP_ANON</constant>. For this setting the
same restrictions regarding mount propagation and privileges apply as for
<varname>ReadOnlyPaths=</varname> and related calls, see above. If turned on and if running in user
mode, or in system mode, but without the <constant>CAP_SYS_ADMIN</constant> capability (e.g. setting
<varname>User=</varname>), <varname>NoNewPrivileges=yes</varname> is implied.</para>
man: add warnings that Private*= settings are not always applied
2017-07-12 01:36:15 +08:00
man: cross-reference DeviceAllow= and PrivateDevices= They are somewhat similar, but not easy to discover, esp. considering that they are described in different pages. For PrivateDevices=, split out the first paragraph that gives the high-level overview. (The giant second paragraph could also use some heavy editing to break it up into more digestible chunks, alas.)
2021-09-08 21:46:17 +08:00
<para>Note that the implementation of this setting might be impossible (for example if mount
namespaces are not available), and the unit should be written in a way that does not solely rely on
this setting for security.</para>
man: say explicitly which settings are not available in --user services Fixes: #3944
2019-03-14 00:24:24 +08:00
Add tests and documentation for all remaining sandboxing in user manager
2022-03-13 05:16:32 +08:00
<xi:include href="system-or-user-ns.xml" xpointer="singular"/>
man: cross-reference DeviceAllow= and PrivateDevices= They are somewhat similar, but not easy to discover, esp. considering that they are described in different pages. For PrivateDevices=, split out the first paragraph that gives the high-level overview. (The giant second paragraph could also use some heavy editing to break it up into more digestible chunks, alas.)
2021-09-08 21:46:17 +08:00
<para>When access to some but not all devices must be possible, the <varname>DeviceAllow=</varname>
setting might be used instead. See
<citerefentry><refentrytitle>systemd.resource-control</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
man: update version information As I noticed a lot of missing information when trying to implement checking for missing info. I reimplemented the version information script to be more robust, and here is the result. Follow up to ec07c3c80b2b1bfa6788500202006ff85f5ae4f4
2023-09-18 23:03:38 +08:00
</para>
<xi:include href="version-info.xml" xpointer="v209"/></listitem>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
</varlistentry>
<varlistentry>
<term><varname>PrivateNetwork=</varname></term>
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
<listitem><para>Takes a boolean argument. If true, sets up a new network namespace for the executed processes
and configures only the loopback network device <literal>lo</literal> inside it. No other network devices will
be available to the executed process. This is useful to turn off network access by the executed process.
Defaults to false. It is possible to run two or more units within the same private network namespace by using
the <varname>JoinsNamespaceOf=</varname> directive, see
<citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry> for
man: elaborate a bit on the effect of PrivateNetwork= Triggered by this thread: https://lists.freedesktop.org/archives/systemd-devel/2018-July/040992.html
2018-07-13 03:03:53 +08:00
details. Note that this option will disconnect all socket families from the host, including
<constant>AF_NETLINK</constant> and <constant>AF_UNIX</constant>. Effectively, for
<constant>AF_NETLINK</constant> this means that device configuration events received from
<citerefentry><refentrytitle>systemd-udevd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry> are
not delivered to the unit's processes. And for <constant>AF_UNIX</constant> this has the effect that
<constant>AF_UNIX</constant> sockets in the abstract socket namespace of the host will become unavailable to
the unit's processes (however, those located in the file system will continue to be accessible).</para>
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
<para>Note that the implementation of this setting might be impossible (for example if network namespaces are
not available), and the unit should be written in a way that does not solely rely on this setting for
man: document NetworkNamespacePath=
2019-03-08 04:20:36 +08:00
security.</para>
core/namespace: mount new sysfs when new network namespace is requested Even when a mount namespace is created, previously host's sysfs is used, especially with RootDirectory= or RootImage=, thus service processes can still access the properties of the network interfaces in the main network namespace through sysfs. This makes, sysfs is remounted with the new network namespace tag, except when PrivateMounts= is explicitly disabled. Hence, the properties of the network interfaces in the main network namespace cannot be accessed by service processes through sysfs. Fixes #26422.
2023-02-17 12:50:17 +08:00
<para>When this option is enabled, <varname>PrivateMounts=</varname> is implied unless it is
explicitly disabled, and <filename>/sys</filename> will be remounted to associate it with the new
network namespace.</para>
man: document NetworkNamespacePath=
2019-03-08 04:20:36 +08:00
<para>When this option is used on a socket unit any sockets bound on behalf of this unit will be
bound within a private network namespace. This may be combined with
<varname>JoinsNamespaceOf=</varname> to listen on sockets inside of network namespaces of other
man: say explicitly which settings are not available in --user services Fixes: #3944
2019-03-14 00:24:24 +08:00
services.</para>
Add tests and documentation for all remaining sandboxing in user manager
2022-03-13 05:16:32 +08:00
<xi:include href="system-or-user-ns.xml" xpointer="singular"/></listitem>
man: document NetworkNamespacePath=
2019-03-08 04:20:36 +08:00
</varlistentry>
<varlistentry>
<term><varname>NetworkNamespacePath=</varname></term>
man: fix typos
2023-06-21 14:35:03 +08:00
<listitem><para>Takes an absolute file system path referring to a Linux network namespace
man: document NetworkNamespacePath=
2019-03-08 04:20:36 +08:00
pseudo-file (i.e. a file like <filename>/proc/$PID/ns/net</filename> or a bind mount or symlink to
one). When set the invoked processes are added to the network namespace referenced by that path. The
path has to point to a valid namespace file at the moment the processes are forked off. If this
option is used <varname>PrivateNetwork=</varname> has no effect. If this option is used together with
<varname>JoinsNamespaceOf=</varname> then it only has an effect if this unit is started before any of
the listed units that have <varname>PrivateNetwork=</varname> or
<varname>NetworkNamespacePath=</varname> configured, as otherwise the network namespace of those
units is reused.</para>
core/namespace: mount new sysfs when new network namespace is requested Even when a mount namespace is created, previously host's sysfs is used, especially with RootDirectory= or RootImage=, thus service processes can still access the properties of the network interfaces in the main network namespace through sysfs. This makes, sysfs is remounted with the new network namespace tag, except when PrivateMounts= is explicitly disabled. Hence, the properties of the network interfaces in the main network namespace cannot be accessed by service processes through sysfs. Fixes #26422.
2023-02-17 12:50:17 +08:00
<para>When this option is enabled, <varname>PrivateMounts=</varname> is implied unless it is
explicitly disabled, and <filename>/sys</filename> will be remounted to associate it with the new
network namespace.</para>
man: document NetworkNamespacePath=
2019-03-08 04:20:36 +08:00
<para>When this option is used on a socket unit any sockets bound on behalf of this unit will be
man: say explicitly which settings are not available in --user services Fixes: #3944
2019-03-14 00:24:24 +08:00
bound within the specified network namespace.</para>
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-23 00:52:36 +08:00
<xi:include href="system-or-user-ns.xml" xpointer="singular"/>
<xi:include href="version-info.xml" xpointer="v242"/></listitem>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
</varlistentry>
New directives PrivateIPC and IPCNamespacePath
2021-02-16 23:58:56 +08:00
<varlistentry>
<term><varname>PrivateIPC=</varname></term>
<listitem><para>Takes a boolean argument. If true, sets up a new IPC namespace for the executed processes.
Each IPC namespace has its own set of System V IPC identifiers and its own POSIX message queue file system.
This is useful to avoid name clash of IPC identifiers. Defaults to false. It is possible to run two or
more units within the same private IPC namespace by using the <varname>JoinsNamespaceOf=</varname> directive,
see <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry> for
details.</para>
<para>Note that IPC namespacing does not have an effect on
<constant>AF_UNIX</constant> sockets, which are the most common
form of IPC used on Linux. Instead, <constant>AF_UNIX</constant>
sockets in the file system are subject to mount namespacing, and
those in the abstract namespace are subject to network namespacing.
IPC namespacing only has an effect on SysV IPC (which is mostly
legacy) as well as POSIX message queues (for which
<constant>AF_UNIX</constant>/<constant>SOCK_SEQPACKET</constant>
sockets are typically a better replacement). IPC namespacing also
has no effect on POSIX shared memory (which is subject to mount
namespacing) either. See
man: fix html links to two external man pages
2021-03-12 17:57:59 +08:00
<citerefentry project='man-pages'><refentrytitle>ipc_namespaces</refentrytitle><manvolnum>7</manvolnum></citerefentry> for
New directives PrivateIPC and IPCNamespacePath
2021-02-16 23:58:56 +08:00
the details.</para>
<para>Note that the implementation of this setting might be impossible (for example if IPC namespaces are
not available), and the unit should be written in a way that does not solely rely on this setting for
security.</para>
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-23 00:52:36 +08:00
<xi:include href="system-or-user-ns.xml" xpointer="singular"/>
<xi:include href="version-info.xml" xpointer="v248"/></listitem>
New directives PrivateIPC and IPCNamespacePath
2021-02-16 23:58:56 +08:00
</varlistentry>
<varlistentry>
<term><varname>IPCNamespacePath=</varname></term>
man: fix typos
2023-06-21 14:35:03 +08:00
<listitem><para>Takes an absolute file system path referring to a Linux IPC namespace
New directives PrivateIPC and IPCNamespacePath
2021-02-16 23:58:56 +08:00
pseudo-file (i.e. a file like <filename>/proc/$PID/ns/ipc</filename> or a bind mount or symlink to
one). When set the invoked processes are added to the network namespace referenced by that path. The
path has to point to a valid namespace file at the moment the processes are forked off. If this
option is used <varname>PrivateIPC=</varname> has no effect. If this option is used together with
<varname>JoinsNamespaceOf=</varname> then it only has an effect if this unit is started before any of
the listed units that have <varname>PrivateIPC=</varname> or
<varname>IPCNamespacePath=</varname> configured, as otherwise the network namespace of those
units is reused.</para>
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-23 00:52:36 +08:00
<xi:include href="system-or-user-ns.xml" xpointer="singular"/>
<xi:include href="version-info.xml" xpointer="v248"/></listitem>
New directives PrivateIPC and IPCNamespacePath
2021-02-16 23:58:56 +08:00
</varlistentry>
add support for KSM This adds support for KSM (kernel samepage merging). It adds a new boolean parameter called MemoryKSM to enable the feature. The feature can only be enabled with newer kernels.
2023-03-01 04:39:35 +08:00
<varlistentry>
<term><varname>MemoryKSM=</varname></term>
<listitem><para>Takes a boolean argument. When set, it enables KSM (kernel samepage merging) for
the processes. KSM is a memory-saving de-duplication feature. Anonymous memory pages with identical
content can be replaced by a single write-protected page. This feature should only be enabled for
jobs that share the same security domain. For details, see
<ulink url="https://docs.kernel.org/admin-guide/mm/ksm.html">Kernel Samepage Merging</ulink> in the
kernel documentation.</para>
<para>Note that this functionality might not be available, for example if KSM is disabled in the
kernel, or the kernel doesn't support controlling KSM at the process level through
<function>prctl()</function>.</para>
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-23 00:52:36 +08:00
<xi:include href="version-info.xml" xpointer="v254"/>
add support for KSM This adds support for KSM (kernel samepage merging). It adds a new boolean parameter called MemoryKSM to enable the feature. The feature can only be enabled with newer kernels.
2023-03-01 04:39:35 +08:00
</listitem>
</varlistentry>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
<varlistentry>
core: add new PrivateUsers= option to service execution This setting adds minimal user namespacing support to a service. When set the invoked processes will run in their own user namespace. Only a trivial mapping will be set up: the root user/group is mapped to root, and the user/group of the service will be mapped to itself, everything else is mapped to nobody. If this setting is used the service runs with no capabilities on the host, but configurable capabilities within the service. This setting is particularly useful in conjunction with RootDirectory= as the need to synchronize /etc/passwd and /etc/group between the host and the service OS tree is reduced, as only three UID/GIDs need to match: root, nobody and the user of the service itself. But even outside the RootDirectory= case this setting is useful to substantially reduce the attack surface of a service. Example command to test this: systemd-run -p PrivateUsers=1 -p User=foobar -t /bin/sh This runs a shell as user "foobar". When typing "ps" only processes owned by "root", by "foobar", and by "nobody" should be visible.
2016-08-04 00:44:51 +08:00
<term><varname>PrivateUsers=</varname></term>
<listitem><para>Takes a boolean argument. If true, sets up a new user namespace for the executed processes and
configures a minimal user and group mapping, that maps the <literal>root</literal> user and group as well as
the unit's own user and group to themselves and everything else to the <literal>nobody</literal> user and
group. This is useful to securely detach the user and group databases used by the unit from the rest of the
system, and thus to create an effective sandbox environment. All files, directories, processes, IPC objects and
man: typo fixes A mix of fixes for typos and UK english
2016-10-13 05:02:44 +08:00
other resources owned by users/groups not equaling <literal>root</literal> or the unit's own will stay visible
core: add new PrivateUsers= option to service execution This setting adds minimal user namespacing support to a service. When set the invoked processes will run in their own user namespace. Only a trivial mapping will be set up: the root user/group is mapped to root, and the user/group of the service will be mapped to itself, everything else is mapped to nobody. If this setting is used the service runs with no capabilities on the host, but configurable capabilities within the service. This setting is particularly useful in conjunction with RootDirectory= as the need to synchronize /etc/passwd and /etc/group between the host and the service OS tree is reduced, as only three UID/GIDs need to match: root, nobody and the user of the service itself. But even outside the RootDirectory= case this setting is useful to substantially reduce the attack surface of a service. Example command to test this: systemd-run -p PrivateUsers=1 -p User=foobar -t /bin/sh This runs a shell as user "foobar". When typing "ps" only processes owned by "root", by "foobar", and by "nobody" should be visible.
2016-08-04 00:44:51 +08:00
from within the unit but appear owned by the <literal>nobody</literal> user and group. If this mode is enabled,
all unit processes are run without privileges in the host user namespace (regardless if the unit's own
user/group is <literal>root</literal> or not). Specifically this means that the process will have zero process
capabilities on the host's user namespace, but full capabilities within the service's user namespace. Settings
such as <varname>CapabilityBoundingSet=</varname> will affect only the latter, and there's no way to acquire
additional capabilities in the host's user namespace. Defaults to off.</para>
core: PrivateUsers=true for (unprivileged) user managers Let per-user service managers have user namespaces too. For unprivileged users, user namespaces are set up much earlier (before the mount, network, and UTS namespaces vs after) in order to obtain capbilities in the new user namespace and enable use of the other listed namespaces. However for privileged users (root), the set up for the user namspace is still done at the end to avoid any restrictions with combining namespaces inside a user namespace (see inline comments). Closes #10576
2019-10-23 08:37:47 +08:00
<para>When this setting is set up by a per-user instance of the service manager, the mapping of the
<literal>root</literal> user and group to itself is omitted (unless the user manager is root).
Additionally, in the per-user instance manager case, the
user namespace will be set up before most other namespaces. This means that combining
<varname>PrivateUsers=</varname><option>true</option> with other namespaces will enable use of features not
normally supported by the per-user instances of the service manager.</para>
core: add RootImage= setting for using a specific image file as root directory for a service This is similar to RootDirectory= but mounts the root file system from a block device or loopback file instead of another directory. This reuses the image dissector code now used by nspawn and gpt-auto-discovery.
2016-12-23 21:26:05 +08:00
<para>This setting is particularly useful in conjunction with
<varname>RootDirectory=</varname>/<varname>RootImage=</varname>, as the need to synchronize the user and group
databases in the root directory and on the host is reduced, as the only users and groups who need to be matched
man: add warnings that Private*= settings are not always applied
2017-07-12 01:36:15 +08:00
are <literal>root</literal>, <literal>nobody</literal> and the unit's own user and group.</para>
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
<para>Note that the implementation of this setting might be impossible (for example if user namespaces are not
available), and the unit should be written in a way that does not solely rely on this setting for
man: update version information As I noticed a lot of missing information when trying to implement checking for missing info. I reimplemented the version information script to be more robust, and here is the result. Follow up to ec07c3c80b2b1bfa6788500202006ff85f5ae4f4
2023-09-18 23:03:38 +08:00
security.</para>
<xi:include href="version-info.xml" xpointer="v232"/></listitem>
core: add new PrivateUsers= option to service execution This setting adds minimal user namespacing support to a service. When set the invoked processes will run in their own user namespace. Only a trivial mapping will be set up: the root user/group is mapped to root, and the user/group of the service will be mapped to itself, everything else is mapped to nobody. If this setting is used the service runs with no capabilities on the host, but configurable capabilities within the service. This setting is particularly useful in conjunction with RootDirectory= as the need to synchronize /etc/passwd and /etc/group between the host and the service OS tree is reduced, as only three UID/GIDs need to match: root, nobody and the user of the service itself. But even outside the RootDirectory= case this setting is useful to substantially reduce the attack surface of a service. Example command to test this: systemd-run -p PrivateUsers=1 -p User=foobar -t /bin/sh This runs a shell as user "foobar". When typing "ps" only processes owned by "root", by "foobar", and by "nobody" should be visible.
2016-08-04 00:44:51 +08:00
</varlistentry>
core: ProtectHostname= feature Let services use a private UTS namespace. In addition, a seccomp filter is installed on set{host,domain}name and a ro bind mounts on /proc/sys/kernel/{host,domain}name.
2019-02-09 01:25:00 +08:00
<varlistentry>
<term><varname>ProtectHostname=</varname></term>
<listitem><para>Takes a boolean argument. When set, sets up a new UTS namespace for the executed
processes. In addition, changing hostname or domainname is prevented. Defaults to off.</para>
man: document that ProtectHostname= disables hostname change notifications
2019-03-07 21:38:07 +08:00
<para>Note that the implementation of this setting might be impossible (for example if UTS namespaces
are not available), and the unit should be written in a way that does not solely rely on this setting
for security.</para>
<para>Note that when this option is enabled for a service hostname changes no longer propagate from
the system into the service, it is hence not suitable for services that need to take notice of system
man: say explicitly which settings are not available in --user services Fixes: #3944
2019-03-14 00:24:24 +08:00
hostname changes dynamically.</para>
man: update document about NoNewPrivileges= Fixes #18914.
2021-03-08 09:36:49 +08:00
<para>If this setting is on, but the unit doesn't have the <constant>CAP_SYS_ADMIN</constant>
capability (e.g. services for which <varname>User=</varname> is set),
<varname>NoNewPrivileges=yes</varname> is implied.</para>
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-23 00:52:36 +08:00
<xi:include href="system-or-user-ns.xml" xpointer="singular"/>
<xi:include href="version-info.xml" xpointer="v242"/></listitem>
core: ProtectHostname= feature Let services use a private UTS namespace. In addition, a seccomp filter is installed on set{host,domain}name and a ro bind mounts on /proc/sys/kernel/{host,domain}name.
2019-02-09 01:25:00 +08:00
</varlistentry>
man: doc: Document ProtectClock=
2020-01-27 04:47:50 +08:00
<varlistentry>
<term><varname>ProtectClock=</varname></term>
man: say that ProtectClock= also affects reads Fixes #26413: the docs said that the filter prevents writes, but it just a filter at the system call level, and some of those calls are used for writing and reading. This is confusing esp. when a higher level library call like ntp_gettime() is denied. I don't think it's realistic that we'll make the filter smarter in the near future, so let's change the docs to describe the implementation. Also, split out the advice part into a separate paragraph.
2023-05-17 15:52:17 +08:00
<listitem><para>Takes a boolean argument. If set, writes to the hardware clock or system clock will
be denied. Defaults to off. Enabling this option removes <constant>CAP_SYS_TIME</constant> and
<constant>CAP_WAKE_ALARM</constant> from the capability bounding set for this unit, installs a system
call filter to block calls that can set the clock, and <varname>DeviceAllow=char-rtc r</varname> is
implied. Note that the system calls are blocked altogether, the filter does not take into account
that some of the calls can be used to read the clock state with some parameter combinations.
Effectively, <filename>/dev/rtc0</filename>, <filename>/dev/rtc1</filename>, etc. are made read-only
to the service. See
man: doc: Document ProtectClock=
2020-01-27 04:47:50 +08:00
<citerefentry><refentrytitle>systemd.resource-control</refentrytitle><manvolnum>5</manvolnum></citerefentry>
man: say that ProtectClock= also affects reads Fixes #26413: the docs said that the filter prevents writes, but it just a filter at the system call level, and some of those calls are used for writing and reading. This is confusing esp. when a higher level library call like ntp_gettime() is denied. I don't think it's realistic that we'll make the filter smarter in the near future, so let's change the docs to describe the implementation. Also, split out the advice part into a separate paragraph.
2023-05-17 15:52:17 +08:00
for the details about <varname>DeviceAllow=</varname>. If this setting is on, but the unit doesn't
have the <constant>CAP_SYS_ADMIN</constant> capability (e.g. services for which
man: update document about NoNewPrivileges= Fixes #18914.
2021-03-08 09:36:49 +08:00
<varname>User=</varname> is set), <varname>NoNewPrivileges=yes</varname> is implied.</para>
man: doc: Document ProtectClock=
2020-01-27 04:47:50 +08:00
man: say that ProtectClock= also affects reads Fixes #26413: the docs said that the filter prevents writes, but it just a filter at the system call level, and some of those calls are used for writing and reading. This is confusing esp. when a higher level library call like ntp_gettime() is denied. I don't think it's realistic that we'll make the filter smarter in the near future, so let's change the docs to describe the implementation. Also, split out the advice part into a separate paragraph.
2023-05-17 15:52:17 +08:00
<para>It is recommended to turn this on for most services that do not need modify the clock or check
its state.</para>
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-23 00:52:36 +08:00
<xi:include href="system-or-user-ns.xml" xpointer="singular"/>
<xi:include href="version-info.xml" xpointer="v245"/></listitem>
man: doc: Document ProtectClock=
2020-01-27 04:47:50 +08:00
</varlistentry>
core: add two new service settings ProtectKernelTunables= and ProtectControlGroups= If enabled, these will block write access to /sys, /proc/sys and /proc/sys/fs/cgroup.
2016-08-23 00:43:59 +08:00
<varlistentry>
<term><varname>ProtectKernelTunables=</varname></term>
<listitem><para>Takes a boolean argument. If true, kernel variables accessible through
man: use trailing slash on directories in more places
2020-10-06 00:08:21 +08:00
<filename>/proc/sys/</filename>, <filename>/sys/</filename>, <filename>/proc/sysrq-trigger</filename>,
core:sandbox: add more /proc/* entries to ProtectKernelTunables= Make ALSA entries, latency interface, mtrr, apm/acpi, suspend interface, filesystems configuration and IRQ tuning readonly. Most of these interfaces now days should be in /sys but they are still available through /proc, so just protect them. This patch does not touch /proc/net/...
2016-09-25 17:30:11 +08:00
<filename>/proc/latency_stats</filename>, <filename>/proc/acpi</filename>,
<filename>/proc/timer_stats</filename>, <filename>/proc/fs</filename> and <filename>/proc/irq</filename> will
man: document that ProtectKernelTunables= and ProtectControlGroups= implies MountAPIVFS= See: #5384
2017-02-22 00:48:59 +08:00
be made read-only to all processes of the unit. Usually, tunable kernel variables should be initialized only at
boot-time, for example with the
<citerefentry><refentrytitle>sysctl.d</refentrytitle><manvolnum>5</manvolnum></citerefentry> mechanism. Few
services need to write to these at runtime; it is hence recommended to turn this on for most services. For this
setting the same restrictions regarding mount propagation and privileges apply as for
man: update document about NoNewPrivileges= Fixes #18914.
2021-03-08 09:36:49 +08:00
<varname>ReadOnlyPaths=</varname> and related calls, see above. Defaults to off. If this
setting is on, but the unit doesn't have the <constant>CAP_SYS_ADMIN</constant> capability
(e.g. services for which <varname>User=</varname> is set),
<varname>NoNewPrivileges=yes</varname> is implied. Note that this option does not prevent
indirect changes to kernel tunables effected by IPC calls to other processes. However,
<varname>InaccessiblePaths=</varname> may be used to make relevant IPC file system objects
inaccessible. If <varname>ProtectKernelTunables=</varname> is set,
<varname>MountAPIVFS=yes</varname> is implied.</para>
man: say explicitly which settings are not available in --user services Fixes: #3944
2019-03-14 00:24:24 +08:00
man: update version information As I noticed a lot of missing information when trying to implement checking for missing info. I reimplemented the version information script to be more robust, and here is the result. Follow up to ec07c3c80b2b1bfa6788500202006ff85f5ae4f4
2023-09-18 23:03:38 +08:00
<xi:include href="system-or-user-ns.xml" xpointer="singular"/>
<xi:include href="version-info.xml" xpointer="v232"/></listitem>
core: add two new service settings ProtectKernelTunables= and ProtectControlGroups= If enabled, these will block write access to /sys, /proc/sys and /proc/sys/fs/cgroup.
2016-08-23 00:43:59 +08:00
</varlistentry>
doc: move ProtectKernelModules= documentation near ProtectKernelTunalbes=
2016-11-14 15:32:06 +08:00
<varlistentry>
<term><varname>ProtectKernelModules=</varname></term>
doc: more spelling fixes
2018-06-12 22:19:21 +08:00
<listitem><para>Takes a boolean argument. If true, explicit module loading will be denied. This allows
module load and unload operations to be turned off on modular kernels. It is recommended to turn this on for most services
man: fix typo
2017-12-04 14:25:08 +08:00
that do not need special file systems or extra kernel modules to work. Defaults to off. Enabling this option
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
removes <constant>CAP_SYS_MODULE</constant> from the capability bounding set for the unit, and installs a
system call filter to block module system calls, also <filename>/usr/lib/modules</filename> is made
inaccessible. For this setting the same restrictions regarding mount propagation and privileges apply as for
man: Add some punctuation; remove double spaces.
2022-06-15 01:42:59 +08:00
<varname>ReadOnlyPaths=</varname> and related calls, see above. Note that limited automatic module loading due
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
to user configuration or kernel mapping tables might still happen as side effect of requested user operations,
doc: move ProtectKernelModules= documentation near ProtectKernelTunalbes=
2016-11-14 15:32:06 +08:00
both privileged and unprivileged. To disable module auto-load feature please see
<citerefentry><refentrytitle>sysctl.d</refentrytitle><manvolnum>5</manvolnum></citerefentry>
<constant>kernel.modules_disabled</constant> mechanism and
man: update document about NoNewPrivileges= Fixes #18914.
2021-03-08 09:36:49 +08:00
<filename>/proc/sys/kernel/modules_disabled</filename> documentation. If this setting is on,
but the unit doesn't have the <constant>CAP_SYS_ADMIN</constant> capability (e.g. services for
which <varname>User=</varname> is set), <varname>NoNewPrivileges=yes</varname> is implied.</para>
man: say explicitly which settings are not available in --user services Fixes: #3944
2019-03-14 00:24:24 +08:00
man: update version information As I noticed a lot of missing information when trying to implement checking for missing info. I reimplemented the version information script to be more robust, and here is the result. Follow up to ec07c3c80b2b1bfa6788500202006ff85f5ae4f4
2023-09-18 23:03:38 +08:00
<xi:include href="system-or-user-ns.xml" xpointer="singular"/>
<xi:include href="version-info.xml" xpointer="v232"/></listitem>
doc: move ProtectKernelModules= documentation near ProtectKernelTunalbes=
2016-11-14 15:32:06 +08:00
</varlistentry>
man: Add description for ProtectKernelLogs=
2019-11-11 13:27:29 +08:00
<varlistentry>
<term><varname>ProtectKernelLogs=</varname></term>
<listitem><para>Takes a boolean argument. If true, access to the kernel log ring buffer will be denied. It is
recommended to turn this on for most services that do not need to read from or write to the kernel log ring
buffer. Enabling this option removes <constant>CAP_SYSLOG</constant> from the capability bounding set for this
unit, and installs a system call filter to block the
<citerefentry project='man-pages'><refentrytitle>syslog</refentrytitle><manvolnum>2</manvolnum></citerefentry>
system call (not to be confused with the libc API
<citerefentry project='man-pages'><refentrytitle>syslog</refentrytitle><manvolnum>3</manvolnum></citerefentry>
for userspace logging). The kernel exposes its log buffer to userspace via <filename>/dev/kmsg</filename> and
man: update document about NoNewPrivileges= Fixes #18914.
2021-03-08 09:36:49 +08:00
<filename>/proc/kmsg</filename>. If enabled, these are made inaccessible to all the processes in the unit.
If this setting is on, but the unit doesn't have the <constant>CAP_SYS_ADMIN</constant>
capability (e.g. services for which <varname>User=</varname> is set),
<varname>NoNewPrivileges=yes</varname> is implied.</para>
man: Add description for ProtectKernelLogs=
2019-11-11 13:27:29 +08:00
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-23 00:52:36 +08:00
<xi:include href="system-or-user-ns.xml" xpointer="singular"/>
<xi:include href="version-info.xml" xpointer="v244"/></listitem>
man: Add description for ProtectKernelLogs=
2019-11-11 13:27:29 +08:00
</varlistentry>
core: add two new service settings ProtectKernelTunables= and ProtectControlGroups= If enabled, these will block write access to /sys, /proc/sys and /proc/sys/fs/cgroup.
2016-08-23 00:43:59 +08:00
<varlistentry>
<term><varname>ProtectControlGroups=</varname></term>
man: rework documentation for ReadOnlyPaths= and related settings This reworks the documentation for ReadOnlyPaths=, ReadWritePaths=, InaccessiblePaths=. It no longer claims that we'd follow symlinks relative to the host file system. (Which wasn't true actually, as we didn't follow symlinks at all in the most recent releases, and we know do follow them, but relative to RootDirectory=). This also replaces all references to the fact that all fs namespacing options can be undone with enough privileges and disable propagation by a single one in the documentation of ReadOnlyPaths= and friends, and then directs the read to this in all other places. Moreover a hint is added to the documentation of SystemCallFilter=, suggesting usage of ~@mount in case any of the fs namespacing related options are used.
2016-08-26 18:24:37 +08:00
<listitem><para>Takes a boolean argument. If true, the Linux Control Groups (<citerefentry
project='man-pages'><refentrytitle>cgroups</refentrytitle><manvolnum>7</manvolnum></citerefentry>) hierarchies
man: use trailing slash on directories in more places
2020-10-06 00:08:21 +08:00
accessible through <filename>/sys/fs/cgroup/</filename> will be made read-only to all processes of the
man: rework documentation for ReadOnlyPaths= and related settings This reworks the documentation for ReadOnlyPaths=, ReadWritePaths=, InaccessiblePaths=. It no longer claims that we'd follow symlinks relative to the host file system. (Which wasn't true actually, as we didn't follow symlinks at all in the most recent releases, and we know do follow them, but relative to RootDirectory=). This also replaces all references to the fact that all fs namespacing options can be undone with enough privileges and disable propagation by a single one in the documentation of ReadOnlyPaths= and friends, and then directs the read to this in all other places. Moreover a hint is added to the documentation of SystemCallFilter=, suggesting usage of ~@mount in case any of the fs namespacing related options are used.
2016-08-26 18:24:37 +08:00
unit. Except for container managers no services should require write access to the control groups hierarchies;
it is hence recommended to turn this on for most services. For this setting the same restrictions regarding
mount propagation and privileges apply as for <varname>ReadOnlyPaths=</varname> and related calls, see
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
above. Defaults to off. If <varname>ProtectControlGroups=</varname> is set, <varname>MountAPIVFS=yes</varname>
man: say explicitly which settings are not available in --user services Fixes: #3944
2019-03-14 00:24:24 +08:00
is implied.</para>
man: update version information As I noticed a lot of missing information when trying to implement checking for missing info. I reimplemented the version information script to be more robust, and here is the result. Follow up to ec07c3c80b2b1bfa6788500202006ff85f5ae4f4
2023-09-18 23:03:38 +08:00
<xi:include href="system-only.xml" xpointer="singular"/>
<xi:include href="version-info.xml" xpointer="v232"/></listitem>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
</varlistentry>
<varlistentry>
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
<term><varname>RestrictAddressFamilies=</varname></term>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
tree-wide: avoid some loaded terms https://tools.ietf.org/html/draft-knodel-terminology-02 https://lwn.net/Articles/823224/ This gets rid of most but not occasions of these loaded terms: 1. scsi_id and friends are something that is supposed to be removed from our tree (see #7594) 2. The test suite defines an API used by the ubuntu CI. We can remove this too later, but this needs to be done in sync with the ubuntu CI. 3. In some cases the terms are part of APIs we call or where we expose concepts the kernel names the way it names them. (In particular all remaining uses of the word "slave" in our codebase are like this, it's used by the POSIX PTY layer, by the network subsystem, the mount API and the block device subsystem). Getting rid of the term in these contexts would mean doing some major fixes of the kernel ABI first. Regarding the replacements: when whitelist/blacklist is used as noun we replace with with allow list/deny list, and when used as verb with allow-list/deny-list.
2020-06-23 14:31:16 +08:00
<listitem><para>Restricts the set of socket address families accessible to the processes of this
core: add RestrictAddressFamilies=none to deny all address families Closes #15753.
2021-04-17 12:04:28 +08:00
unit. Takes <literal>none</literal>, or a space-separated list of address family names to
allow-list, such as <constant>AF_UNIX</constant>, <constant>AF_INET</constant> or
<constant>AF_INET6</constant>. When <literal>none</literal> is specified, then all address
families will be denied. When prefixed with <literal>~</literal> the listed address
families will be applied as deny list, otherwise as allow list. Note that this restricts access
to the
<citerefentry project='man-pages'><refentrytitle>socket</refentrytitle><manvolnum>2</manvolnum></citerefentry>
tree-wide: avoid some loaded terms https://tools.ietf.org/html/draft-knodel-terminology-02 https://lwn.net/Articles/823224/ This gets rid of most but not occasions of these loaded terms: 1. scsi_id and friends are something that is supposed to be removed from our tree (see #7594) 2. The test suite defines an API used by the ubuntu CI. We can remove this too later, but this needs to be done in sync with the ubuntu CI. 3. In some cases the terms are part of APIs we call or where we expose concepts the kernel names the way it names them. (In particular all remaining uses of the word "slave" in our codebase are like this, it's used by the POSIX PTY layer, by the network subsystem, the mount API and the block device subsystem). Getting rid of the term in these contexts would mean doing some major fixes of the kernel ABI first. Regarding the replacements: when whitelist/blacklist is used as noun we replace with with allow list/deny list, and when used as verb with allow-list/deny-list.
2020-06-23 14:31:16 +08:00
system call only. Sockets passed into the process by other means (for example, by using socket
activation with socket units, see
<citerefentry><refentrytitle>systemd.socket</refentrytitle><manvolnum>5</manvolnum></citerefentry>)
are unaffected. Also, sockets created with <function>socketpair()</function> (which creates connected
AF_UNIX sockets only) are unaffected. Note that this option has no effect on 32-bit x86, s390, s390x,
tree-wide: fixes for assorted grammar and spelling issues Fixes #16363. Also includes some changes where I generalized the pattern.
2020-07-06 16:49:59 +08:00
mips, mips-le, ppc, ppc-le, ppc64, ppc64-le and is ignored (but works correctly on other ABIs,
tree-wide: avoid some loaded terms https://tools.ietf.org/html/draft-knodel-terminology-02 https://lwn.net/Articles/823224/ This gets rid of most but not occasions of these loaded terms: 1. scsi_id and friends are something that is supposed to be removed from our tree (see #7594) 2. The test suite defines an API used by the ubuntu CI. We can remove this too later, but this needs to be done in sync with the ubuntu CI. 3. In some cases the terms are part of APIs we call or where we expose concepts the kernel names the way it names them. (In particular all remaining uses of the word "slave" in our codebase are like this, it's used by the POSIX PTY layer, by the network subsystem, the mount API and the block device subsystem). Getting rid of the term in these contexts would mean doing some major fixes of the kernel ABI first. Regarding the replacements: when whitelist/blacklist is used as noun we replace with with allow list/deny list, and when used as verb with allow-list/deny-list.
2020-06-23 14:31:16 +08:00
including x86-64). Note that on systems supporting multiple ABIs (such as x86/x86-64) it is
recommended to turn off alternative ABIs for services, so that they cannot be used to circumvent the
restrictions of this option. Specifically, it is recommended to combine this option with
<varname>SystemCallArchitectures=native</varname> or similar. If running in user mode, or in system
mode, but without the <constant>CAP_SYS_ADMIN</constant> capability (e.g. setting
man: update document about NoNewPrivileges= Fixes #18914.
2021-03-08 09:36:49 +08:00
<varname>User=</varname>), <varname>NoNewPrivileges=yes</varname> is implied. By default, no
tree-wide: avoid some loaded terms https://tools.ietf.org/html/draft-knodel-terminology-02 https://lwn.net/Articles/823224/ This gets rid of most but not occasions of these loaded terms: 1. scsi_id and friends are something that is supposed to be removed from our tree (see #7594) 2. The test suite defines an API used by the ubuntu CI. We can remove this too later, but this needs to be done in sync with the ubuntu CI. 3. In some cases the terms are part of APIs we call or where we expose concepts the kernel names the way it names them. (In particular all remaining uses of the word "slave" in our codebase are like this, it's used by the POSIX PTY layer, by the network subsystem, the mount API and the block device subsystem). Getting rid of the term in these contexts would mean doing some major fixes of the kernel ABI first. Regarding the replacements: when whitelist/blacklist is used as noun we replace with with allow list/deny list, and when used as verb with allow-list/deny-list.
2020-06-23 14:31:16 +08:00
restrictions apply, all address families are accessible to processes. If assigned the empty string,
any previous address family restriction changes are undone. This setting does not affect commands
prefixed with <literal>+</literal>.</para>
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
<para>Use this option to limit exposure of processes to remote access, in particular via exotic and sensitive
network protocols, such as <constant>AF_PACKET</constant>. Note that in most cases, the local
tree-wide: avoid some loaded terms https://tools.ietf.org/html/draft-knodel-terminology-02 https://lwn.net/Articles/823224/ This gets rid of most but not occasions of these loaded terms: 1. scsi_id and friends are something that is supposed to be removed from our tree (see #7594) 2. The test suite defines an API used by the ubuntu CI. We can remove this too later, but this needs to be done in sync with the ubuntu CI. 3. In some cases the terms are part of APIs we call or where we expose concepts the kernel names the way it names them. (In particular all remaining uses of the word "slave" in our codebase are like this, it's used by the POSIX PTY layer, by the network subsystem, the mount API and the block device subsystem). Getting rid of the term in these contexts would mean doing some major fixes of the kernel ABI first. Regarding the replacements: when whitelist/blacklist is used as noun we replace with with allow list/deny list, and when used as verb with allow-list/deny-list.
2020-06-23 14:31:16 +08:00
<constant>AF_UNIX</constant> address family should be included in the configured allow list as it is frequently
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
used for local communication, including for
<citerefentry><refentrytitle>syslog</refentrytitle><manvolnum>2</manvolnum></citerefentry>
man: update version information As I noticed a lot of missing information when trying to implement checking for missing info. I reimplemented the version information script to be more robust, and here is the result. Follow up to ec07c3c80b2b1bfa6788500202006ff85f5ae4f4
2023-09-18 23:03:38 +08:00
logging.</para>
<xi:include href="version-info.xml" xpointer="v211"/></listitem>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
</varlistentry>
man: add RestrictFileSystems= documentation
2021-02-08 22:06:22 +08:00
<varlistentry>
<term><varname>RestrictFileSystems=</varname></term>
<listitem><para>Restricts the set of filesystems processes of this unit can open files on. Takes a space-separated
list of filesystem names. Any filesystem listed is made accessible to the unit's processes, access to filesystem
types not listed is prohibited (allow-listing). If the first character of the list is <literal>~</literal>, the
effect is inverted: access to the filesystems listed is prohibited (deny-listing). If the empty string is assigned,
access to filesystems is not restricted.</para>
<para>If you specify both types of this option (i.e. allow-listing and deny-listing), the first encountered will take
precedence and will dictate the default action (allow access to the filesystem or deny it). Then the next occurrences
of this option will add or delete the listed filesystems from the set of the restricted filesystems, depending on its
type and the default action.</para>
<para>Example: if a unit has the following,
<programlisting>RestrictFileSystems=ext4 tmpfs
RestrictFileSystems=ext2 ext4</programlisting>
then access to <constant>ext4</constant>, <constant>tmpfs</constant>, and <constant>ext2</constant> is allowed
and access to other filesystems is denied.</para>
<para>Example: if a unit has the following,
<programlisting>RestrictFileSystems=ext4 tmpfs
RestrictFileSystems=~ext4</programlisting>
then only access <constant>tmpfs</constant> is allowed.</para>
<para>Example: if a unit has the following,
<programlisting>RestrictFileSystems=~ext4 tmpfs
RestrictFileSystems=ext4</programlisting>
then only access to <constant>tmpfs</constant> is denied.</para>
man: Add some punctuation; remove double spaces.
2022-06-15 01:42:59 +08:00
<para>As the number of possible filesystems is large, predefined sets of filesystems are provided. A set
man: add RestrictFileSystems= documentation
2021-02-08 22:06:22 +08:00
starts with <literal>@</literal> character, followed by name of the set.</para>
<table>
<title>Currently predefined filesystem sets</title>
<tgroup cols='2'>
<colspec colname='set' />
<colspec colname='description' />
<thead>
<row>
<entry>Set</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry>@basic-api</entry>
<entry>Basic filesystem API.</entry>
</row>
<row>
<entry>@auxiliary-api</entry>
<entry>Auxiliary filesystem API.</entry>
</row>
<row>
<entry>@common-block</entry>
<entry>Common block device filesystems.</entry>
</row>
<row>
<entry>@historical-block</entry>
<entry>Historical block device filesystems.</entry>
</row>
<row>
<entry>@network</entry>
<entry>Well-known network filesystems.</entry>
</row>
<row>
<entry>@privileged-api</entry>
<entry>Privileged filesystem API.</entry>
</row>
<row>
<entry>@temporary</entry>
<entry>Temporary filesystems: tmpfs, ramfs.</entry>
</row>
<row>
<entry>@known</entry>
man: various issues reported in #22432 Fixes #22432.
2022-02-23 05:54:23 +08:00
<entry>All known filesystems defined by the kernel. This list is defined statically in systemd based on a kernel version that was available when this systemd version was released. It will become progressively more out-of-date as the kernel is updated.</entry>
man: add RestrictFileSystems= documentation
2021-02-08 22:06:22 +08:00
</row>
</tbody>
</tgroup>
</table>
<para>Use
<citerefentry><refentrytitle>systemd-analyze</refentrytitle><manvolnum>1</manvolnum></citerefentry>'s
<command>filesystems</command> command to retrieve a list of filesystems defined on the local
system.</para>
<para>Note that this setting might not be supported on some systems (for example if the LSM eBPF hook is
not enabled in the underlying kernel or if not using the unified control group hierarchy). In that case this setting
man: note that cgroup-based sandboxing is not bypassed by '+' DeviceAllow= and others are applied to the whole cgroup via bpf, so using '+' on an Exec line will not bypass them. Explain this in the manpage. Fixes https://github.com/systemd/systemd/issues/26035
2023-01-16 02:54:16 +08:00
has no effect.</para>
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-23 00:52:36 +08:00
<xi:include href="cgroup-sandboxing.xml" xpointer="singular"/>
<xi:include href="version-info.xml" xpointer="v250"/></listitem>
man: add RestrictFileSystems= documentation
2021-02-08 22:06:22 +08:00
</varlistentry>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
<varlistentry>
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
<term><varname>RestrictNamespaces=</varname></term>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
<listitem><para>Restricts access to Linux namespace functionality for the processes of this unit. For details
about Linux namespaces, see <citerefentry
project='man-pages'><refentrytitle>namespaces</refentrytitle><manvolnum>7</manvolnum></citerefentry>. Either
takes a boolean argument, or a space-separated list of namespace type identifiers. If false (the default), no
restrictions on namespace creation and switching are made. If true, access to any kind of namespacing is
prohibited. Otherwise, a space-separated list of namespace type identifiers must be specified, consisting of
any combination of: <constant>cgroup</constant>, <constant>ipc</constant>, <constant>net</constant>,
<constant>mnt</constant>, <constant>pid</constant>, <constant>user</constant> and <constant>uts</constant>. Any
namespace type listed is made accessible to the unit's processes, access to namespace types not listed is
tree-wide: avoid some loaded terms https://tools.ietf.org/html/draft-knodel-terminology-02 https://lwn.net/Articles/823224/ This gets rid of most but not occasions of these loaded terms: 1. scsi_id and friends are something that is supposed to be removed from our tree (see #7594) 2. The test suite defines an API used by the ubuntu CI. We can remove this too later, but this needs to be done in sync with the ubuntu CI. 3. In some cases the terms are part of APIs we call or where we expose concepts the kernel names the way it names them. (In particular all remaining uses of the word "slave" in our codebase are like this, it's used by the POSIX PTY layer, by the network subsystem, the mount API and the block device subsystem). Getting rid of the term in these contexts would mean doing some major fixes of the kernel ABI first. Regarding the replacements: when whitelist/blacklist is used as noun we replace with with allow list/deny list, and when used as verb with allow-list/deny-list.
2020-06-23 14:31:16 +08:00
prohibited (allow-listing). By prepending the list with a single tilde character (<literal>~</literal>) the
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
effect may be inverted: only the listed namespace types will be made inaccessible, all unlisted ones are
tree-wide: avoid some loaded terms https://tools.ietf.org/html/draft-knodel-terminology-02 https://lwn.net/Articles/823224/ This gets rid of most but not occasions of these loaded terms: 1. scsi_id and friends are something that is supposed to be removed from our tree (see #7594) 2. The test suite defines an API used by the ubuntu CI. We can remove this too later, but this needs to be done in sync with the ubuntu CI. 3. In some cases the terms are part of APIs we call or where we expose concepts the kernel names the way it names them. (In particular all remaining uses of the word "slave" in our codebase are like this, it's used by the POSIX PTY layer, by the network subsystem, the mount API and the block device subsystem). Getting rid of the term in these contexts would mean doing some major fixes of the kernel ABI first. Regarding the replacements: when whitelist/blacklist is used as noun we replace with with allow list/deny list, and when used as verb with allow-list/deny-list.
2020-06-23 14:31:16 +08:00
permitted (deny-listing). If the empty string is assigned, the default namespace restrictions are applied,
man: mention that RestrictNamespaces= can be specified multiple times
2018-04-26 23:22:10 +08:00
which is equivalent to false. This option may appear more than once, in which case the namespace types are
merged by <constant>OR</constant>, or by <constant>AND</constant> if the lines are prefixed with
<literal>~</literal> (see examples below). Internally, this setting limits access to the
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
<citerefentry><refentrytitle>unshare</refentrytitle><manvolnum>2</manvolnum></citerefentry>,
<citerefentry><refentrytitle>clone</refentrytitle><manvolnum>2</manvolnum></citerefentry> and
<citerefentry><refentrytitle>setns</refentrytitle><manvolnum>2</manvolnum></citerefentry> system calls, taking
the specified flags parameters into account. Note that — if this option is used — in addition to restricting
creation and switching of the specified types of namespaces (or all of them, if true) access to the
man: Add some punctuation; remove double spaces.
2022-06-15 01:42:59 +08:00
<function>setns()</function> system call with a zero flags parameter is prohibited. This setting is only
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
supported on x86, x86-64, mips, mips-le, mips64, mips64-le, mips64-n32, mips64-le-n32, ppc64, ppc64-le, s390
and s390x, and enforces no restrictions on other architectures. If running in user mode, or in system mode, but
without the <constant>CAP_SYS_ADMIN</constant> capability (e.g. setting <varname>User=</varname>),
man: mention that RestrictNamespaces= can be specified multiple times
2018-04-26 23:22:10 +08:00
<varname>NoNewPrivileges=yes</varname> is implied.</para>
<para>Example: if a unit has the following,
<programlisting>RestrictNamespaces=cgroup ipc
RestrictNamespaces=cgroup net</programlisting>
then <constant>cgroup</constant>, <constant>ipc</constant>, and <constant>net</constant> are set.
If the second line is prefixed with <literal>~</literal>, e.g.,
<programlisting>RestrictNamespaces=cgroup ipc
RestrictNamespaces=~cgroup net</programlisting>
man: update version information As I noticed a lot of missing information when trying to implement checking for missing info. I reimplemented the version information script to be more robust, and here is the result. Follow up to ec07c3c80b2b1bfa6788500202006ff85f5ae4f4
2023-09-18 23:03:38 +08:00
then, only <constant>ipc</constant> is set.</para>
<xi:include href="version-info.xml" xpointer="v233"/></listitem>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
</varlistentry>
core: optionally create LOGIN_PROCESS or USER_PROCESS utmp entries When generating utmp/wtmp entries, optionally add both LOGIN_PROCESS and INIT_PROCESS entries or even all three of LOGIN_PROCESS, INIT_PROCESS and USER_PROCESS entries, instead of just a single INIT_PROCESS entry. With this change systemd may be used to not only invoke a getty directly in a SysV-compliant way but alternatively also a login(1) implementation or even forego getty and login entirely, and invoke arbitrary shells in a way that they appear in who(1) or w(1). This is preparation for a later commit that adds a "machinectl shell" operation to invoke a shell in a container, in a way that is compatible with who(1) and w(1).
2015-08-23 19:14:04 +08:00
<varlistentry>
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
<term><varname>LockPersonality=</varname></term>
core: optionally create LOGIN_PROCESS or USER_PROCESS utmp entries When generating utmp/wtmp entries, optionally add both LOGIN_PROCESS and INIT_PROCESS entries or even all three of LOGIN_PROCESS, INIT_PROCESS and USER_PROCESS entries, instead of just a single INIT_PROCESS entry. With this change systemd may be used to not only invoke a getty directly in a SysV-compliant way but alternatively also a login(1) implementation or even forego getty and login entirely, and invoke arbitrary shells in a way that they appear in who(1) or w(1). This is preparation for a later commit that adds a "machinectl shell" operation to invoke a shell in a container, in a way that is compatible with who(1) and w(1).
2015-08-23 19:14:04 +08:00
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
<listitem><para>Takes a boolean argument. If set, locks down the <citerefentry
project='man-pages'><refentrytitle>personality</refentrytitle><manvolnum>2</manvolnum></citerefentry> system
call so that the kernel execution domain may not be changed from the default or the personality selected with
<varname>Personality=</varname> directive. This may be useful to improve security, because odd personality
emulations may be poorly tested and source of vulnerabilities. If running in user mode, or in system mode, but
without the <constant>CAP_SYS_ADMIN</constant> capability (e.g. setting <varname>User=</varname>),
man: update version information As I noticed a lot of missing information when trying to implement checking for missing info. I reimplemented the version information script to be more robust, and here is the result. Follow up to ec07c3c80b2b1bfa6788500202006ff85f5ae4f4
2023-09-18 23:03:38 +08:00
<varname>NoNewPrivileges=yes</varname> is implied.</para>
<xi:include href="version-info.xml" xpointer="v235"/></listitem>
core: optionally create LOGIN_PROCESS or USER_PROCESS utmp entries When generating utmp/wtmp entries, optionally add both LOGIN_PROCESS and INIT_PROCESS entries or even all three of LOGIN_PROCESS, INIT_PROCESS and USER_PROCESS entries, instead of just a single INIT_PROCESS entry. With this change systemd may be used to not only invoke a getty directly in a SysV-compliant way but alternatively also a login(1) implementation or even forego getty and login entirely, and invoke arbitrary shells in a way that they appear in who(1) or w(1). This is preparation for a later commit that adds a "machinectl shell" operation to invoke a shell in a container, in a way that is compatible with who(1) and w(1).
2015-08-23 19:14:04 +08:00
</varlistentry>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
<varlistentry>
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
<term><varname>MemoryDenyWriteExecute=</varname></term>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
<listitem><para>Takes a boolean argument. If set, attempts to create memory mappings that are writable and
executable at the same time, or to change existing memory mappings to become executable, or mapping shared
execute: use prctl(PR_SET_MDWE) for MemoryDenyWriteExecute=yes On some ARM platforms, the dynamic linker could use PROT_BTI memory protection flag with `mprotect(..., PROT_BTI | PROT_EXEC)` to enable additional memory protection for executable pages. But `MemoryDenyWriteExecute=yes` blocks this with seccomp filter denying all `mprotect(..., x | PROT_EXEC)`. Newly preferred method is to use prctl(PR_SET_MDWE) on supported kernels. Then in-kernel implementation can allow PROT_BTI as necessary, without weakening MDWE. In-kernel version may also be extended to more sophisticated protections in the future.
2022-11-07 03:12:45 +08:00
memory segments as executable, are prohibited. Specifically, a system call filter is added (or
preferably, an equivalent kernel check is enabled with
<citerefentry><refentrytitle>prctl</refentrytitle><manvolnum>2</manvolnum></citerefentry>) that
rejects <citerefentry><refentrytitle>mmap</refentrytitle><manvolnum>2</manvolnum></citerefentry>
system calls with both <constant>PROT_EXEC</constant> and <constant>PROT_WRITE</constant> set,
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
<citerefentry><refentrytitle>mprotect</refentrytitle><manvolnum>2</manvolnum></citerefentry> or
<citerefentry><refentrytitle>pkey_mprotect</refentrytitle><manvolnum>2</manvolnum></citerefentry> system calls
with <constant>PROT_EXEC</constant> set and
<citerefentry><refentrytitle>shmat</refentrytitle><manvolnum>2</manvolnum></citerefentry> system calls with
<constant>SHM_EXEC</constant> set. Note that this option is incompatible with programs and libraries that
generate program code dynamically at runtime, including JIT execution engines, executable stacks, and code
"trampoline" feature of various C compilers. This option improves service security, as it makes harder for
Document weaknesses with MDWE and suggest hardening Closes #11473
2019-01-19 05:32:28 +08:00
software exploits to change running code dynamically. However, the protection can be circumvented, if
the service can write to a filesystem, which is not mounted with <constant>noexec</constant> (such as
man: Add some punctuation; remove double spaces.
2022-06-15 01:42:59 +08:00
<filename>/dev/shm</filename>), or it can use <function>memfd_create()</function>. This can be
Document weaknesses with MDWE and suggest hardening Closes #11473
2019-01-19 05:32:28 +08:00
prevented by making such file systems inaccessible to the service
(e.g. <varname>InaccessiblePaths=/dev/shm</varname>) and installing further system call filters
(<varname>SystemCallFilter=~memfd_create</varname>). Note that this feature is fully available on
x86-64, and partially on x86. Specifically, the <function>shmat()</function> protection is not
available on x86. Note that on systems supporting multiple ABIs (such as x86/x86-64) it is
recommended to turn off alternative ABIs for services, so that they cannot be used to circumvent the
restrictions of this option. Specifically, it is recommended to combine this option with
<varname>SystemCallArchitectures=native</varname> or similar. If running in user mode, or in system
mode, but without the <constant>CAP_SYS_ADMIN</constant> capability (e.g. setting
man: update version information As I noticed a lot of missing information when trying to implement checking for missing info. I reimplemented the version information script to be more robust, and here is the result. Follow up to ec07c3c80b2b1bfa6788500202006ff85f5ae4f4
2023-09-18 23:03:38 +08:00
<varname>User=</varname>), <varname>NoNewPrivileges=yes</varname> is implied.</para>
<xi:include href="version-info.xml" xpointer="v231"/></listitem>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
</varlistentry>
<varlistentry>
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
<term><varname>RestrictRealtime=</varname></term>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
<listitem><para>Takes a boolean argument. If set, any attempts to enable realtime scheduling in a process of
the unit are refused. This restricts access to realtime task scheduling policies such as
<constant>SCHED_FIFO</constant>, <constant>SCHED_RR</constant> or <constant>SCHED_DEADLINE</constant>. See
<citerefentry project='man-pages'><refentrytitle>sched</refentrytitle><manvolnum>7</manvolnum></citerefentry>
for details about these scheduling policies. If running in user mode, or in system mode, but without the
<constant>CAP_SYS_ADMIN</constant> capability (e.g. setting <varname>User=</varname>),
<varname>NoNewPrivileges=yes</varname> is implied. Realtime scheduling policies may be used to monopolize CPU
time for longer periods of time, and may hence be used to lock up or otherwise trigger Denial-of-Service
situations on the system. It is hence recommended to restrict access to realtime scheduling to the few programs
man: update version information As I noticed a lot of missing information when trying to implement checking for missing info. I reimplemented the version information script to be more robust, and here is the result. Follow up to ec07c3c80b2b1bfa6788500202006ff85f5ae4f4
2023-09-18 23:03:38 +08:00
that actually require them. Defaults to off.</para>
<xi:include href="version-info.xml" xpointer="v231"/></listitem>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
</varlistentry>
man: document the new RestrictSUIDSGID= setting
2019-03-21 02:45:32 +08:00
<varlistentry>
<term><varname>RestrictSUIDSGID=</varname></term>
<listitem><para>Takes a boolean argument. If set, any attempts to set the set-user-ID (SUID) or
set-group-ID (SGID) bits on files or directories will be denied (for details on these bits see
<citerefentry
project='man-pages'><refentrytitle>inode</refentrytitle><manvolnum>7</manvolnum></citerefentry>). If
running in user mode, or in system mode, but without the <constant>CAP_SYS_ADMIN</constant>
capability (e.g. setting <varname>User=</varname>), <varname>NoNewPrivileges=yes</varname> is
man: Add some punctuation; remove double spaces.
2022-06-15 01:42:59 +08:00
implied. As the SUID/SGID bits are mechanisms to elevate privileges, and allow users to acquire the
man: document the new RestrictSUIDSGID= setting
2019-03-21 02:45:32 +08:00
identity of other users, it is recommended to restrict creation of SUID/SGID files to the few
programs that actually require them. Note that this restricts marking of any type of file system
object with these bits, including both regular files and directories (where the SGID is a different
core: imply NNP and SUID/SGID restriction for DynamicUser=yes service Let's be safe, rather than sorry. This way DynamicUser=yes services can neither take benefit of, nor create SUID/SGID binaries. Given that DynamicUser= is a recent addition only we should be able to get away with turning this on, even though this is strictly speaking a binary compatibility breakage.
2019-03-21 03:19:38 +08:00
meaning than for files, see documentation). This option is implied if <varname>DynamicUser=</varname>
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-23 00:52:36 +08:00
is enabled. Defaults to off.</para>
<xi:include href="version-info.xml" xpointer="v242"/></listitem>
man: document the new RestrictSUIDSGID= setting
2019-03-21 02:45:32 +08:00
</varlistentry>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
<varlistentry>
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
<term><varname>RemoveIPC=</varname></term>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
<listitem><para>Takes a boolean parameter. If set, all System V and POSIX IPC objects owned by the user and
group the processes of this unit are run as are removed when the unit is stopped. This setting only has an
effect if at least one of <varname>User=</varname>, <varname>Group=</varname> and
<varname>DynamicUser=</varname> are used. It has no effect on IPC objects owned by the root user. Specifically,
this removes System V semaphores, as well as System V and POSIX shared memory segments and message queues. If
multiple units use the same user or group the IPC objects are removed when the last of these units is
man: say explicitly which settings are not available in --user services Fixes: #3944
2019-03-14 00:24:24 +08:00
stopped. This setting is implied if <varname>DynamicUser=</varname> is set.</para>
man: update version information As I noticed a lot of missing information when trying to implement checking for missing info. I reimplemented the version information script to be more robust, and here is the result. Follow up to ec07c3c80b2b1bfa6788500202006ff85f5ae4f4
2023-09-18 23:03:38 +08:00
<xi:include href="system-only.xml" xpointer="singular"/>
<xi:include href="version-info.xml" xpointer="v232"/></listitem>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
</varlistentry>
man: document the new PrivateMounts= setting Also, extend the documentation on MountFlags= substantially, hopefully addressing all the questions of #4393 Fixes: #4393
2018-06-01 17:23:51 +08:00
<varlistentry>
<term><varname>PrivateMounts=</varname></term>
<listitem><para>Takes a boolean parameter. If set, the processes of this unit will be run in their own private
file system (mount) namespace with all mount propagation from the processes towards the host's main file system
namespace turned off. This means any file system mount points established or removed by the unit's processes
will be private to them and not be visible to the host. However, file system mount points established or
removed on the host will be propagated to the unit's processes. See <citerefentry
project='man-pages'><refentrytitle>mount_namespaces</refentrytitle><manvolnum>7</manvolnum></citerefentry> for
details on file system namespaces. Defaults to off.</para>
<para>When turned on, this executes three operations for each invoked process: a new
<constant>CLONE_NEWNS</constant> namespace is created, after which all existing mounts are remounted to
<constant>MS_SLAVE</constant> to disable propagation from the unit's processes to the host (but leaving
propagation in the opposite direction in effect). Finally, the mounts are remounted again to the propagation
mode configured with <varname>MountFlags=</varname>, see below.</para>
<para>File system namespaces are set up individually for each process forked off by the service manager. Mounts
established in the namespace of the process created by <varname>ExecStartPre=</varname> will hence be cleaned
up automatically as soon as that process exits and will not be available to subsequent processes forked off for
<varname>ExecStart=</varname> (and similar applies to the various other commands configured for
units). Similarly, <varname>JoinsNamespaceOf=</varname> does not permit sharing kernel mount namespaces between
units, it only enables sharing of the <filename>/tmp/</filename> and <filename>/var/tmp/</filename>
directories.</para>
<para>Other file system namespace unit settings — <varname>PrivateMounts=</varname>,
<varname>PrivateTmp=</varname>, <varname>PrivateDevices=</varname>, <varname>ProtectSystem=</varname>,
<varname>ProtectHome=</varname>, <varname>ReadOnlyPaths=</varname>, <varname>InaccessiblePaths=</varname>,
<varname>ReadWritePaths=</varname>, … — also enable file system namespacing in a fashion equivalent to this
option. Hence it is primarily useful to explicitly request this behaviour if none of the other settings are
man: say explicitly which settings are not available in --user services Fixes: #3944
2019-03-14 00:24:24 +08:00
used.</para>
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-23 00:52:36 +08:00
<xi:include href="system-or-user-ns.xml" xpointer="singular"/>
<xi:include href="version-info.xml" xpointer="v239"/></listitem>
man: document the new PrivateMounts= setting Also, extend the documentation on MountFlags= substantially, hopefully addressing all the questions of #4393 Fixes: #4393
2018-06-01 17:23:51 +08:00
</varlistentry>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
<varlistentry>
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
<term><varname>MountFlags=</varname></term>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
man: document the new PrivateMounts= setting Also, extend the documentation on MountFlags= substantially, hopefully addressing all the questions of #4393 Fixes: #4393
2018-06-01 17:23:51 +08:00
<listitem><para>Takes a mount propagation setting: <option>shared</option>, <option>slave</option> or
<option>private</option>, which controls whether file system mount points in the file system namespaces set up
for this unit's processes will receive or propagate mounts and unmounts from other file system namespaces. See
<citerefentry project='man-pages'><refentrytitle>mount</refentrytitle><manvolnum>2</manvolnum></citerefentry>
for details on mount propagation, and the three propagation flags in particular.</para>
<para>This setting only controls the <emphasis>final</emphasis> propagation setting in effect on all mount
points of the file system namespace created for each process of this unit. Other file system namespacing unit
settings (see the discussion in <varname>PrivateMounts=</varname> above) will implicitly disable mount and
unmount propagation from the unit's processes towards the host by changing the propagation setting of all mount
tree-wide: fix spelling errors Based on a report from Fossies.org using Codespell. Followup to #15436
2020-04-22 02:46:53 +08:00
points in the unit's file system namespace to <option>slave</option> first. Setting this option to
man/systemd.exec: MountFlags=shared behaviour was changed (fixed?) The behaviour described *was* observed on Fedora 28 (systemd-238-9.git0e0aa59), with and without SELinux. I don't actually know why though! It contradicts my understanding of the code, including an explicit comment in the code. Testing in a VM upgraded to v239-792-g1327f272d, this behaviour goes away. Test case: # /etc/systemd/system/mount-test.service [Service] MountFlags=shared Type=oneshot ExecStart=/usr/bin/ls -l /proc/1/ns/mnt /proc/self/ns/mnt ExecStart=/usr/bin/grep ext4 /proc/self/mountinfo Weird old behaviour: new mount namespace but / is fully shared. lrwxrwxrwx. 1 root root 0 Sep 14 11:18 /proc/1/ns/mnt -> mnt:[4026531840] lrwxrwxrwx. 1 root root 0 Sep 14 11:48 /proc/self/ns/mnt -> mnt:[4026532851] 968 967 253:0 / / rw,relatime shared:1 - ext4 /dev/mapper/alan_dell_2016... Current behaviour: / is not fully shared lrwxrwxrwx. 1 root root 0 Sep 14 11:39 /proc/1/ns/mnt -> mnt:[4026531840] lrwxrwxrwx. 1 root root 0 Sep 14 11:41 /proc/self/ns/mnt -> mnt:[4026532329] 591 558 8:3 / / rw,relatime shared:313 master:1 - ext4 /dev/sda3 rw,secl...
2018-09-14 18:57:57 +08:00
<option>shared</option> does not reestablish propagation in that case.</para>
man: document the new PrivateMounts= setting Also, extend the documentation on MountFlags= substantially, hopefully addressing all the questions of #4393 Fixes: #4393
2018-06-01 17:23:51 +08:00
<para>If not set – but file system namespaces are enabled through another file system namespace unit setting –
<option>shared</option> mount propagation is used, but — as mentioned — as <option>slave</option> is applied
first, propagation from the unit's processes to the host is still turned off.</para>
tree-wide: more repeated words
2020-07-07 18:08:22 +08:00
<para>It is not recommended to use <option>private</option> mount propagation for units, as this means
man: document the new PrivateMounts= setting Also, extend the documentation on MountFlags= substantially, hopefully addressing all the questions of #4393 Fixes: #4393
2018-06-01 17:23:51 +08:00
temporary mounts (such as removable media) of the host will stay mounted and thus indefinitely busy in forked
off processes, as unmount propagation events won't be received by the file system namespace of the unit.</para>
<para>Usually, it is best to leave this setting unmodified, and use higher level file system namespacing
options instead, in particular <varname>PrivateMounts=</varname>, see above.</para>
man: say explicitly which settings are not available in --user services Fixes: #3944
2019-03-14 00:24:24 +08:00
Add tests and documentation for all remaining sandboxing in user manager
2022-03-13 05:16:32 +08:00
<xi:include href="system-or-user-ns.xml" xpointer="singular"/></listitem>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
</varlistentry>
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
</variablelist>
</refsect1>
man: add link to kernel docs about no_new_privs
2017-11-19 18:58:45 +08:00
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
<refsect1>
<title>System Call Filtering</title>
man: move entries to the right section in systemd.directives They were in "miscellaneuos" because of the missing class= assignment. Probably introduced when the split into sections was done.
2019-02-13 17:17:49 +08:00
<variablelist class='unit-directives'>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
<varlistentry>
<term><varname>SystemCallFilter=</varname></term>
man: beef up systemd.exec(5) Prompted by: https://lists.freedesktop.org/archives/systemd-devel/2019-May/042773.html
2019-05-28 22:50:10 +08:00
<listitem><para>Takes a space-separated list of system call names. If this setting is used, all
system calls executed by the unit processes except for the listed ones will result in immediate
tree-wide: avoid some loaded terms https://tools.ietf.org/html/draft-knodel-terminology-02 https://lwn.net/Articles/823224/ This gets rid of most but not occasions of these loaded terms: 1. scsi_id and friends are something that is supposed to be removed from our tree (see #7594) 2. The test suite defines an API used by the ubuntu CI. We can remove this too later, but this needs to be done in sync with the ubuntu CI. 3. In some cases the terms are part of APIs we call or where we expose concepts the kernel names the way it names them. (In particular all remaining uses of the word "slave" in our codebase are like this, it's used by the POSIX PTY layer, by the network subsystem, the mount API and the block device subsystem). Getting rid of the term in these contexts would mean doing some major fixes of the kernel ABI first. Regarding the replacements: when whitelist/blacklist is used as noun we replace with with allow list/deny list, and when used as verb with allow-list/deny-list.
2020-06-23 14:31:16 +08:00
process termination with the <constant>SIGSYS</constant> signal (allow-listing). (See
man: beef up systemd.exec(5) Prompted by: https://lists.freedesktop.org/archives/systemd-devel/2019-May/042773.html
2019-05-28 22:50:10 +08:00
<varname>SystemCallErrorNumber=</varname> below for changing the default action). If the first
character of the list is <literal>~</literal>, the effect is inverted: only the listed system calls
tree-wide: avoid some loaded terms https://tools.ietf.org/html/draft-knodel-terminology-02 https://lwn.net/Articles/823224/ This gets rid of most but not occasions of these loaded terms: 1. scsi_id and friends are something that is supposed to be removed from our tree (see #7594) 2. The test suite defines an API used by the ubuntu CI. We can remove this too later, but this needs to be done in sync with the ubuntu CI. 3. In some cases the terms are part of APIs we call or where we expose concepts the kernel names the way it names them. (In particular all remaining uses of the word "slave" in our codebase are like this, it's used by the POSIX PTY layer, by the network subsystem, the mount API and the block device subsystem). Getting rid of the term in these contexts would mean doing some major fixes of the kernel ABI first. Regarding the replacements: when whitelist/blacklist is used as noun we replace with with allow list/deny list, and when used as verb with allow-list/deny-list.
2020-06-23 14:31:16 +08:00
will result in immediate process termination (deny-listing). Deny-listed system calls and system call
man: beef up systemd.exec(5) Prompted by: https://lists.freedesktop.org/archives/systemd-devel/2019-May/042773.html
2019-05-28 22:50:10 +08:00
groups may optionally be suffixed with a colon (<literal>:</literal>) and <literal>errno</literal>
error number (between 0 and 4095) or errno name such as <constant>EPERM</constant>,
<constant>EACCES</constant> or <constant>EUCLEAN</constant> (see <citerefentry
project='man-pages'><refentrytitle>errno</refentrytitle><manvolnum>3</manvolnum></citerefentry> for a
tree-wide: avoid some loaded terms https://tools.ietf.org/html/draft-knodel-terminology-02 https://lwn.net/Articles/823224/ This gets rid of most but not occasions of these loaded terms: 1. scsi_id and friends are something that is supposed to be removed from our tree (see #7594) 2. The test suite defines an API used by the ubuntu CI. We can remove this too later, but this needs to be done in sync with the ubuntu CI. 3. In some cases the terms are part of APIs we call or where we expose concepts the kernel names the way it names them. (In particular all remaining uses of the word "slave" in our codebase are like this, it's used by the POSIX PTY layer, by the network subsystem, the mount API and the block device subsystem). Getting rid of the term in these contexts would mean doing some major fixes of the kernel ABI first. Regarding the replacements: when whitelist/blacklist is used as noun we replace with with allow list/deny list, and when used as verb with allow-list/deny-list.
2020-06-23 14:31:16 +08:00
full list). This value will be returned when a deny-listed system call is triggered, instead of
exec: Add kill action to system call filters Define explicit action "kill" for SystemCallErrorNumber=. In addition to errno code, allow specifying "kill" as action for SystemCallFilter=. --- v7: seccomp_parse_errno_or_action() returns -EINVAL if !HAVE_SECCOMP v6: use streq_ptr(), let errno_to_name() handle bad values, kill processes, init syscall_errno v5: actually use seccomp_errno_or_action_to_string(), don't fail bus unit parsing without seccomp v4: fix build without seccomp v3: drop log action v2: action -> number
2020-08-05 21:31:26 +08:00
terminating the processes immediately. Special setting <literal>kill</literal> can be used to
explicitly specify killing. This value takes precedence over the one given in
man: Add some punctuation; remove double spaces.
2022-06-15 01:42:59 +08:00
<varname>SystemCallErrorNumber=</varname>, see below. If running in user mode, or in system mode,
man: beef up systemd.exec(5) Prompted by: https://lists.freedesktop.org/archives/systemd-devel/2019-May/042773.html
2019-05-28 22:50:10 +08:00
but without the <constant>CAP_SYS_ADMIN</constant> capability (e.g. setting
man: update document about NoNewPrivileges= Fixes #18914.
2021-03-08 09:36:49 +08:00
<varname>User=</varname>), <varname>NoNewPrivileges=yes</varname> is implied. This feature
man: beef up systemd.exec(5) Prompted by: https://lists.freedesktop.org/archives/systemd-devel/2019-May/042773.html
2019-05-28 22:50:10 +08:00
makes use of the Secure Computing Mode 2 interfaces of the kernel ('seccomp filtering') and is useful
man: append parentheses for function name
2020-11-10 05:38:36 +08:00
for enforcing a minimal sandboxing environment. Note that the <function>execve()</function>,
<function>exit()</function>, <function>exit_group()</function>, <function>getrlimit()</function>,
<function>rt_sigreturn()</function>, <function>sigreturn()</function> system calls and the system calls
tree-wide: avoid some loaded terms https://tools.ietf.org/html/draft-knodel-terminology-02 https://lwn.net/Articles/823224/ This gets rid of most but not occasions of these loaded terms: 1. scsi_id and friends are something that is supposed to be removed from our tree (see #7594) 2. The test suite defines an API used by the ubuntu CI. We can remove this too later, but this needs to be done in sync with the ubuntu CI. 3. In some cases the terms are part of APIs we call or where we expose concepts the kernel names the way it names them. (In particular all remaining uses of the word "slave" in our codebase are like this, it's used by the POSIX PTY layer, by the network subsystem, the mount API and the block device subsystem). Getting rid of the term in these contexts would mean doing some major fixes of the kernel ABI first. Regarding the replacements: when whitelist/blacklist is used as noun we replace with with allow list/deny list, and when used as verb with allow-list/deny-list.
2020-06-23 14:31:16 +08:00
for querying time and sleeping are implicitly allow-listed and do not need to be listed
man: beef up systemd.exec(5) Prompted by: https://lists.freedesktop.org/archives/systemd-devel/2019-May/042773.html
2019-05-28 22:50:10 +08:00
explicitly. This option may be specified more than once, in which case the filter masks are
merged. If the empty string is assigned, the filter is reset, all prior assignments will have no
effect. This does not affect commands prefixed with <literal>+</literal>.</para>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
man: improve documentation on seccomp regarding alternative ABIs Let's clarify that RestrictAddressFamilies= and MemoryDenyWriteExecute= are only fully effective if non-native system call architectures are disabled, since they otherwise may be used to circumvent the filters, as the filters aren't equally effective on all ABIs. Fixes: #5277
2017-02-10 01:27:02 +08:00
<para>Note that on systems supporting multiple ABIs (such as x86/x86-64) it is recommended to turn off
alternative ABIs for services, so that they cannot be used to circumvent the restrictions of this
option. Specifically, it is recommended to combine this option with
<varname>SystemCallArchitectures=native</varname> or similar.</para>
man: document that too strict system call filters may affect the service manager If execve() or socket() is filtered the service manager might get into trouble executing the service binary, or handling any failures when this fails. Mention this in the documentation. The other option would be to implicitly whitelist all system calls that are required for these codepaths. However, that appears less than desirable as this would mean socket() and many related calls have to be whitelisted unconditionally. As writing system call filters requires a certain level of expertise anyway it sounds like the better option to simply document these issues and suggest that the user disables system call filters in the service temporarily in order to debug any such failures. See: #3993.
2016-10-25 22:08:38 +08:00
<para>Note that strict system call filters may impact execution and error handling code paths of the service
man: append parentheses for function name
2020-11-10 05:38:36 +08:00
invocation. Specifically, access to the <function>execve()</function> system call is required for the execution
man: document that too strict system call filters may affect the service manager If execve() or socket() is filtered the service manager might get into trouble executing the service binary, or handling any failures when this fails. Mention this in the documentation. The other option would be to implicitly whitelist all system calls that are required for these codepaths. However, that appears less than desirable as this would mean socket() and many related calls have to be whitelisted unconditionally. As writing system call filters requires a certain level of expertise anyway it sounds like the better option to simply document these issues and suggest that the user disables system call filters in the service temporarily in order to debug any such failures. See: #3993.
2016-10-25 22:08:38 +08:00
of the service binary — if it is blocked service invocation will necessarily fail. Also, if execution of the
service binary fails for some reason (for example: missing service executable), the error handling logic might
require access to an additional set of system calls in order to process and log this failure correctly. It
might be necessary to temporarily disable system call filters in order to simplify debugging of such
failures.</para>
man: Add some punctuation; remove double spaces.
2022-06-15 01:42:59 +08:00
<para>If you specify both types of this option (i.e. allow-listing and deny-listing), the first
tree-wide: avoid some loaded terms https://tools.ietf.org/html/draft-knodel-terminology-02 https://lwn.net/Articles/823224/ This gets rid of most but not occasions of these loaded terms: 1. scsi_id and friends are something that is supposed to be removed from our tree (see #7594) 2. The test suite defines an API used by the ubuntu CI. We can remove this too later, but this needs to be done in sync with the ubuntu CI. 3. In some cases the terms are part of APIs we call or where we expose concepts the kernel names the way it names them. (In particular all remaining uses of the word "slave" in our codebase are like this, it's used by the POSIX PTY layer, by the network subsystem, the mount API and the block device subsystem). Getting rid of the term in these contexts would mean doing some major fixes of the kernel ABI first. Regarding the replacements: when whitelist/blacklist is used as noun we replace with with allow list/deny list, and when used as verb with allow-list/deny-list.
2020-06-23 14:31:16 +08:00
encountered will take precedence and will dictate the default action (termination or approval of a
system call). Then the next occurrences of this option will add or delete the listed system calls
from the set of the filtered system calls, depending of its type and the default action. (For
man: append parentheses for function name
2020-11-10 05:38:36 +08:00
example, if you have started with an allow list rule for <function>read()</function> and
<function>write()</function>, and right after it add a deny list rule for <function>write()</function>,
then <function>write()</function> will be removed from the set.)</para>
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
man: Add some punctuation; remove double spaces.
2022-06-15 01:42:59 +08:00
<para>As the number of possible system calls is large, predefined sets of system calls are provided. A set
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
starts with <literal>@</literal> character, followed by name of the set.
core: add pre-defined syscall groups to SystemCallFilter= (#3053) (#3157) Implement sets of system calls to help constructing system call filters. A set starts with '@' to distinguish from a system call. Closes: #3053, #3157
2016-06-01 17:56:01 +08:00
<table>
<title>Currently predefined system call sets</title>
<tgroup cols='2'>
<colspec colname='set' />
<colspec colname='description' />
<thead>
<row>
<entry>Set</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
seccomp: add three more seccomp groups @aio → asynchronous IO calls @sync → msync/fsync/... and friends @chown → changing file ownership (Also, change @privileged to reference @chown now, instead of the individual syscalls it contains)
2017-09-30 20:34:50 +08:00
<row>
<entry>@aio</entry>
<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>
</row>
seccomp: add two new syscall groups @resources contains various syscalls that alter resource limits and memory and scheduling parameters of processes. As such they are good candidates to block for most services. @basic-io contains a number of basic syscalls for I/O, similar to the list seccomp v1 permitted but slightly more complete. It should be useful for building basic whitelisting for minimal sandboxes
2016-11-02 22:46:18 +08:00
<row>
<entry>@basic-io</entry>
<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>
</row>
seccomp: add three more seccomp groups @aio → asynchronous IO calls @sync → msync/fsync/... and friends @chown → changing file ownership (Also, change @privileged to reference @chown now, instead of the individual syscalls it contains)
2017-09-30 20:34:50 +08:00
<row>
<entry>@chown</entry>
<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>
</row>
core: add pre-defined syscall groups to SystemCallFilter= (#3053) (#3157) Implement sets of system calls to help constructing system call filters. A set starts with '@' to distinguish from a system call. Closes: #3053, #3157
2016-06-01 17:56:01 +08:00
<row>
<entry>@clock</entry>
core: improve seccomp syscall grouping a bit This adds three new seccomp syscall groups: @keyring for kernel keyring access, @cpu-emulation for CPU emulation features, for exampe vm86() for dosemu and suchlike, and @debug for ptrace() and related calls. Also, the @clock group is updated with more syscalls that alter the system clock. capset() is added to @privileged, and pciconfig_iobase() is added to @raw-io. Finally, @obsolete is a cleaned up. A number of syscalls that never existed on Linux and have no number assigned on any architecture are removed, as they only exist in the man pages and other operating sytems, but not in code at all. create_module() is moved from @module to @obsolete, as it is an obsolete system call. mem_getpolicy() is removed from the @obsolete list, as it is not obsolete, but simply a NUMA API.
2016-06-10 23:43:38 +08:00
<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>
</row>
<row>
<entry>@cpu-emulation</entry>
<entry>System calls for CPU emulation functionality (<citerefentry project='man-pages'><refentrytitle>vm86</refentrytitle><manvolnum>2</manvolnum></citerefentry> and related calls)</entry>
</row>
<row>
<entry>@debug</entry>
<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>
core: add pre-defined syscall groups to SystemCallFilter= (#3053) (#3157) Implement sets of system calls to help constructing system call filters. A set starts with '@' to distinguish from a system call. Closes: #3053, #3157
2016-06-01 17:56:01 +08:00
</row>
seccomp: add @filesystem syscall group (#4537) @filesystem groups various file system operations, such as opening files and directories for read/write and stat()ing them, plus renaming, deleting, symlinking, hardlinking.
2016-11-22 08:29:12 +08:00
<row>
<entry>@file-system</entry>
tree-wide: fixes for assorted grammar and spelling issues Fixes #16363. Also includes some changes where I generalized the pattern.
2020-07-06 16:49:59 +08:00
<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>
seccomp: add @filesystem syscall group (#4537) @filesystem groups various file system operations, such as opening files and directories for read/write and stat()ing them, plus renaming, deleting, symlinking, hardlinking.
2016-11-22 08:29:12 +08:00
</row>
core: add pre-defined syscall groups to SystemCallFilter= (#3053) (#3157) Implement sets of system calls to help constructing system call filters. A set starts with '@' to distinguish from a system call. Closes: #3053, #3157
2016-06-01 17:56:01 +08:00
<row>
<entry>@io-event</entry>
core: improve seccomp syscall grouping a bit This adds three new seccomp syscall groups: @keyring for kernel keyring access, @cpu-emulation for CPU emulation features, for exampe vm86() for dosemu and suchlike, and @debug for ptrace() and related calls. Also, the @clock group is updated with more syscalls that alter the system clock. capset() is added to @privileged, and pciconfig_iobase() is added to @raw-io. Finally, @obsolete is a cleaned up. A number of syscalls that never existed on Linux and have no number assigned on any architecture are removed, as they only exist in the man pages and other operating sytems, but not in code at all. create_module() is moved from @module to @obsolete, as it is an obsolete system call. mem_getpolicy() is removed from the @obsolete list, as it is not obsolete, but simply a NUMA API.
2016-06-10 23:43:38 +08:00
<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>
core: add pre-defined syscall groups to SystemCallFilter= (#3053) (#3157) Implement sets of system calls to help constructing system call filters. A set starts with '@' to distinguish from a system call. Closes: #3053, #3157
2016-06-01 17:56:01 +08:00
</row>
<row>
<entry>@ipc</entry>
seccomp: include pipes and memfd in @ipc These system calls clearly fall in the @ipc category, hence should be listed there, simply to avoid confusion and surprise by the user.
2016-10-25 21:43:31 +08:00
<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>
core: improve seccomp syscall grouping a bit This adds three new seccomp syscall groups: @keyring for kernel keyring access, @cpu-emulation for CPU emulation features, for exampe vm86() for dosemu and suchlike, and @debug for ptrace() and related calls. Also, the @clock group is updated with more syscalls that alter the system clock. capset() is added to @privileged, and pciconfig_iobase() is added to @raw-io. Finally, @obsolete is a cleaned up. A number of syscalls that never existed on Linux and have no number assigned on any architecture are removed, as they only exist in the man pages and other operating sytems, but not in code at all. create_module() is moved from @module to @obsolete, as it is an obsolete system call. mem_getpolicy() is removed from the @obsolete list, as it is not obsolete, but simply a NUMA API.
2016-06-10 23:43:38 +08:00
</row>
<row>
<entry>@keyring</entry>
<entry>Kernel keyring access (<citerefentry project='man-pages'><refentrytitle>keyctl</refentrytitle><manvolnum>2</manvolnum></citerefentry> and related calls)</entry>
core: add pre-defined syscall groups to SystemCallFilter= (#3053) (#3157) Implement sets of system calls to help constructing system call filters. A set starts with '@' to distinguish from a system call. Closes: #3053, #3157
2016-06-01 17:56:01 +08:00
</row>
seccomp: add four new syscall groups These groups should be useful shortcuts for sets of closely related syscalls where it usually makes more sense to allow them altogether or not at all.
2017-09-14 01:55:16 +08:00
<row>
<entry>@memlock</entry>
tree-wide: fixes for assorted grammar and spelling issues Fixes #16363. Also includes some changes where I generalized the pattern.
2020-07-06 16:49:59 +08:00
<entry>Locking of memory in 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>
seccomp: add four new syscall groups These groups should be useful shortcuts for sets of closely related syscalls where it usually makes more sense to allow them altogether or not at all.
2017-09-14 01:55:16 +08:00
</row>
core: add pre-defined syscall groups to SystemCallFilter= (#3053) (#3157) Implement sets of system calls to help constructing system call filters. A set starts with '@' to distinguish from a system call. Closes: #3053, #3157
2016-06-01 17:56:01 +08:00
<row>
<entry>@module</entry>
seccomp-util, analyze: export comments as a help string Just to make the whole thing easier for users.
2016-11-03 00:24:34 +08:00
<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>
core: add pre-defined syscall groups to SystemCallFilter= (#3053) (#3157) Implement sets of system calls to help constructing system call filters. A set starts with '@' to distinguish from a system call. Closes: #3053, #3157
2016-06-01 17:56:01 +08:00
</row>
<row>
<entry>@mount</entry>
seccomp-util, analyze: export comments as a help string Just to make the whole thing easier for users.
2016-11-03 00:24:34 +08:00
<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>
core: add pre-defined syscall groups to SystemCallFilter= (#3053) (#3157) Implement sets of system calls to help constructing system call filters. A set starts with '@' to distinguish from a system call. Closes: #3053, #3157
2016-06-01 17:56:01 +08:00
</row>
<row>
<entry>@network-io</entry>
core: improve seccomp syscall grouping a bit This adds three new seccomp syscall groups: @keyring for kernel keyring access, @cpu-emulation for CPU emulation features, for exampe vm86() for dosemu and suchlike, and @debug for ptrace() and related calls. Also, the @clock group is updated with more syscalls that alter the system clock. capset() is added to @privileged, and pciconfig_iobase() is added to @raw-io. Finally, @obsolete is a cleaned up. A number of syscalls that never existed on Linux and have no number assigned on any architecture are removed, as they only exist in the man pages and other operating sytems, but not in code at all. create_module() is moved from @module to @obsolete, as it is an obsolete system call. mem_getpolicy() is removed from the @obsolete list, as it is not obsolete, but simply a NUMA API.
2016-06-10 23:43:38 +08:00
<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>
core: add pre-defined syscall groups to SystemCallFilter= (#3053) (#3157) Implement sets of system calls to help constructing system call filters. A set starts with '@' to distinguish from a system call. Closes: #3053, #3157
2016-06-01 17:56:01 +08:00
</row>
<row>
<entry>@obsolete</entry>
core: improve seccomp syscall grouping a bit This adds three new seccomp syscall groups: @keyring for kernel keyring access, @cpu-emulation for CPU emulation features, for exampe vm86() for dosemu and suchlike, and @debug for ptrace() and related calls. Also, the @clock group is updated with more syscalls that alter the system clock. capset() is added to @privileged, and pciconfig_iobase() is added to @raw-io. Finally, @obsolete is a cleaned up. A number of syscalls that never existed on Linux and have no number assigned on any architecture are removed, as they only exist in the man pages and other operating sytems, but not in code at all. create_module() is moved from @module to @obsolete, as it is an obsolete system call. mem_getpolicy() is removed from the @obsolete list, as it is not obsolete, but simply a NUMA API.
2016-06-10 23:43:38 +08:00
<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>
core: add pre-defined syscall groups to SystemCallFilter= (#3053) (#3157) Implement sets of system calls to help constructing system call filters. A set starts with '@' to distinguish from a system call. Closes: #3053, #3157
2016-06-01 17:56:01 +08:00
</row>
man: update syscal filter group list
2023-03-24 21:52:34 +08:00
<row>
<entry>@pkey</entry>
<entry>System calls that deal with memory protection keys (<citerefentry project='man-pages'><refentrytitle>pkeys</refentrytitle><manvolnum>7</manvolnum></citerefentry>)</entry>
</row>
core: add pre-defined syscall groups to SystemCallFilter= (#3053) (#3157) Implement sets of system calls to help constructing system call filters. A set starts with '@' to distinguish from a system call. Closes: #3053, #3157
2016-06-01 17:56:01 +08:00
<row>
<entry>@privileged</entry>
core: improve seccomp syscall grouping a bit This adds three new seccomp syscall groups: @keyring for kernel keyring access, @cpu-emulation for CPU emulation features, for exampe vm86() for dosemu and suchlike, and @debug for ptrace() and related calls. Also, the @clock group is updated with more syscalls that alter the system clock. capset() is added to @privileged, and pciconfig_iobase() is added to @raw-io. Finally, @obsolete is a cleaned up. A number of syscalls that never existed on Linux and have no number assigned on any architecture are removed, as they only exist in the man pages and other operating sytems, but not in code at all. create_module() is moved from @module to @obsolete, as it is an obsolete system call. mem_getpolicy() is removed from the @obsolete list, as it is not obsolete, but simply a NUMA API.
2016-06-10 23:43:38 +08:00
<entry>All system calls which need super-user capabilities (<citerefentry project='man-pages'><refentrytitle>capabilities</refentrytitle><manvolnum>7</manvolnum></citerefentry>)</entry>
core: add pre-defined syscall groups to SystemCallFilter= (#3053) (#3157) Implement sets of system calls to help constructing system call filters. A set starts with '@' to distinguish from a system call. Closes: #3053, #3157
2016-06-01 17:56:01 +08:00
</row>
<row>
<entry>@process</entry>
man: fix typos
2020-10-03 19:56:50 +08:00
<entry>Process control, execution, namespacing 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>
core: add pre-defined syscall groups to SystemCallFilter= (#3053) (#3157) Implement sets of system calls to help constructing system call filters. A set starts with '@' to distinguish from a system call. Closes: #3053, #3157
2016-06-01 17:56:01 +08:00
</row>
<row>
<entry>@raw-io</entry>
man: two minor fixes
2016-10-25 21:44:54 +08:00
<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>
core: add pre-defined syscall groups to SystemCallFilter= (#3053) (#3157) Implement sets of system calls to help constructing system call filters. A set starts with '@' to distinguish from a system call. Closes: #3053, #3157
2016-06-01 17:56:01 +08:00
</row>
seccomp: add two new filter sets: @reboot and @swap These groupe reboot()/kexec() and swapon()/swapoff() respectively
2016-12-27 21:26:55 +08:00
<row>
<entry>@reboot</entry>
<entry>System calls for rebooting and reboot preparation (<citerefentry project='man-pages'><refentrytitle>reboot</refentrytitle><manvolnum>2</manvolnum></citerefentry>, <function>kexec()</function>, …)</entry>
</row>
seccomp: add two new syscall groups @resources contains various syscalls that alter resource limits and memory and scheduling parameters of processes. As such they are good candidates to block for most services. @basic-io contains a number of basic syscalls for I/O, similar to the list seccomp v1 permitted but slightly more complete. It should be useful for building basic whitelisting for minimal sandboxes
2016-11-02 22:46:18 +08:00
<row>
<entry>@resources</entry>
<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>
</row>
man: update syscal filter group list
2023-03-24 21:52:34 +08:00
<row>
<entry>@sandbox</entry>
<entry>System calls for sandboxing programs (<citerefentry project='man-pages'><refentrytitle>seccomp</refentrytitle><manvolnum>2</manvolnum></citerefentry>, Landlock system calls, …)</entry>
</row>
seccomp: add new @setuid seccomp group This new group lists all UID/GID credential changing syscalls (which are quite a number these days). This will become particularly useful in a later commit, which uses this group to optionally permit user credential changing to daemons in case ambient capabilities are not available.
2017-08-09 21:04:05 +08:00
<row>
<entry>@setuid</entry>
<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>
</row>
seccomp: add four new syscall groups These groups should be useful shortcuts for sets of closely related syscalls where it usually makes more sense to allow them altogether or not at all.
2017-09-14 01:55:16 +08:00
<row>
<entry>@signal</entry>
<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>
</row>
seccomp: add two new filter sets: @reboot and @swap These groupe reboot()/kexec() and swapon()/swapoff() respectively
2016-12-27 21:26:55 +08:00
<row>
<entry>@swap</entry>
<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>
</row>
seccomp: add three more seccomp groups @aio → asynchronous IO calls @sync → msync/fsync/... and friends @chown → changing file ownership (Also, change @privileged to reference @chown now, instead of the individual syscalls it contains)
2017-09-30 20:34:50 +08:00
<row>
<entry>@sync</entry>
tree-wide: fixes for assorted grammar and spelling issues Fixes #16363. Also includes some changes where I generalized the pattern.
2020-07-06 16:49:59 +08:00
<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>
seccomp: add three more seccomp groups @aio → asynchronous IO calls @sync → msync/fsync/... and friends @chown → changing file ownership (Also, change @privileged to reference @chown now, instead of the individual syscalls it contains)
2017-09-30 20:34:50 +08:00
</row>
seccomp: add new system call filter, suitable as default whitelist for system services Currently we employ mostly system call blacklisting for our system services. Let's add a new system call filter group @system-service that helps turning this around into a whitelist by default. The new group is very similar to nspawn's default filter list, but in some ways more restricted (as sethostname() and suchlike shouldn't be available to most system services just like that) and in others more relaxed (for example @keyring is blocked in nspawn since it's not properly virtualized yet in the kernel, but is fine for regular system services).
2018-04-19 03:19:54 +08:00
<row>
<entry>@system-service</entry>
tree-wide: avoid some loaded terms https://tools.ietf.org/html/draft-knodel-terminology-02 https://lwn.net/Articles/823224/ This gets rid of most but not occasions of these loaded terms: 1. scsi_id and friends are something that is supposed to be removed from our tree (see #7594) 2. The test suite defines an API used by the ubuntu CI. We can remove this too later, but this needs to be done in sync with the ubuntu CI. 3. In some cases the terms are part of APIs we call or where we expose concepts the kernel names the way it names them. (In particular all remaining uses of the word "slave" in our codebase are like this, it's used by the POSIX PTY layer, by the network subsystem, the mount API and the block device subsystem). Getting rid of the term in these contexts would mean doing some major fixes of the kernel ABI first. Regarding the replacements: when whitelist/blacklist is used as noun we replace with with allow list/deny list, and when used as verb with allow-list/deny-list.
2020-06-23 14:31:16 +08:00
<entry>A reasonable set of system calls used by common system services, excluding any special purpose calls. This is the recommended starting point for allow-listing 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>
seccomp: add new system call filter, suitable as default whitelist for system services Currently we employ mostly system call blacklisting for our system services. Let's add a new system call filter group @system-service that helps turning this around into a whitelist by default. The new group is very similar to nspawn's default filter list, but in some ways more restricted (as sethostname() and suchlike shouldn't be available to most system services just like that) and in others more relaxed (for example @keyring is blocked in nspawn since it's not properly virtualized yet in the kernel, but is fine for regular system services).
2018-04-19 03:19:54 +08:00
</row>
seccomp: add four new syscall groups These groups should be useful shortcuts for sets of closely related syscalls where it usually makes more sense to allow them altogether or not at all.
2017-09-14 01:55:16 +08:00
<row>
<entry>@timer</entry>
<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>
</row>
shared: add @known syscall list
2020-08-19 23:43:23 +08:00
<row>
<entry>@known</entry>
man: fix typo systmed → systemd
2020-10-05 17:40:05 +08:00
<entry>All system calls defined by the kernel. This list is defined statically in systemd based on a kernel version that was available when this systemd version was released. It will become progressively more out-of-date as the kernel is updated.</entry>
shared: add @known syscall list
2020-08-19 23:43:23 +08:00
</row>
core: add pre-defined syscall groups to SystemCallFilter= (#3053) (#3157) Implement sets of system calls to help constructing system call filters. A set starts with '@' to distinguish from a system call. Closes: #3053, #3157
2016-06-01 17:56:01 +08:00
</tbody>
</tgroup>
</table>
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
Note, that as new system calls are added to the kernel, additional system calls might be added to the groups
above. Contents of the sets may also change between systemd versions. In addition, the list of system calls
depends on the kernel version and architecture for which systemd was compiled. Use
<command>systemd-analyze syscall-filter</command> to list the actual list of system calls in each
filter.</para>
man: rework documentation for ReadOnlyPaths= and related settings This reworks the documentation for ReadOnlyPaths=, ReadWritePaths=, InaccessiblePaths=. It no longer claims that we'd follow symlinks relative to the host file system. (Which wasn't true actually, as we didn't follow symlinks at all in the most recent releases, and we know do follow them, but relative to RootDirectory=). This also replaces all references to the fact that all fs namespacing options can be undone with enough privileges and disable propagation by a single one in the documentation of ReadOnlyPaths= and friends, and then directs the read to this in all other places. Moreover a hint is added to the documentation of SystemCallFilter=, suggesting usage of ~@mount in case any of the fs namespacing related options are used.
2016-08-26 18:24:37 +08:00
tree-wide: avoid some loaded terms https://tools.ietf.org/html/draft-knodel-terminology-02 https://lwn.net/Articles/823224/ This gets rid of most but not occasions of these loaded terms: 1. scsi_id and friends are something that is supposed to be removed from our tree (see #7594) 2. The test suite defines an API used by the ubuntu CI. We can remove this too later, but this needs to be done in sync with the ubuntu CI. 3. In some cases the terms are part of APIs we call or where we expose concepts the kernel names the way it names them. (In particular all remaining uses of the word "slave" in our codebase are like this, it's used by the POSIX PTY layer, by the network subsystem, the mount API and the block device subsystem). Getting rid of the term in these contexts would mean doing some major fixes of the kernel ABI first. Regarding the replacements: when whitelist/blacklist is used as noun we replace with with allow list/deny list, and when used as verb with allow-list/deny-list.
2020-06-23 14:31:16 +08:00
<para>Generally, allow-listing system calls (rather than deny-listing) is the safer mode of
operation. It is recommended to enforce system call allow lists for all long-running system
services. Specifically, the following lines are a relatively safe basic choice for the majority of
system services:</para>
seccomp: add new system call filter, suitable as default whitelist for system services Currently we employ mostly system call blacklisting for our system services. Let's add a new system call filter group @system-service that helps turning this around into a whitelist by default. The new group is very similar to nspawn's default filter list, but in some ways more restricted (as sethostname() and suchlike shouldn't be available to most system services just like that) and in others more relaxed (for example @keyring is blocked in nspawn since it's not properly virtualized yet in the kernel, but is fine for regular system services).
2018-04-19 03:19:54 +08:00
<programlisting>[Service]
SystemCallFilter=@system-service
SystemCallErrorNumber=EPERM</programlisting>
man: beef up systemd.exec(5) Prompted by: https://lists.freedesktop.org/archives/systemd-devel/2019-May/042773.html
2019-05-28 22:50:10 +08:00
<para>Note that various kernel system calls are defined redundantly: there are multiple system calls
for executing the same operation. For example, the <function>pidfd_send_signal()</function> system
call may be used to execute operations similar to what can be done with the older
<function>kill()</function> system call, hence blocking the latter without the former only provides
weak protection. Since new system calls are added regularly to the kernel as development progresses,
tree-wide: avoid some loaded terms https://tools.ietf.org/html/draft-knodel-terminology-02 https://lwn.net/Articles/823224/ This gets rid of most but not occasions of these loaded terms: 1. scsi_id and friends are something that is supposed to be removed from our tree (see #7594) 2. The test suite defines an API used by the ubuntu CI. We can remove this too later, but this needs to be done in sync with the ubuntu CI. 3. In some cases the terms are part of APIs we call or where we expose concepts the kernel names the way it names them. (In particular all remaining uses of the word "slave" in our codebase are like this, it's used by the POSIX PTY layer, by the network subsystem, the mount API and the block device subsystem). Getting rid of the term in these contexts would mean doing some major fixes of the kernel ABI first. Regarding the replacements: when whitelist/blacklist is used as noun we replace with with allow list/deny list, and when used as verb with allow-list/deny-list.
2020-06-23 14:31:16 +08:00
keeping system call deny lists comprehensive requires constant work. It is thus recommended to use
allow-listing instead, which offers the benefit that new system calls are by default implicitly
blocked until the allow list is updated.</para>
man: beef up systemd.exec(5) Prompted by: https://lists.freedesktop.org/archives/systemd-devel/2019-May/042773.html
2019-05-28 22:50:10 +08:00
<para>Also note that a number of system calls are required to be accessible for the dynamic linker to
work. The dynamic linker is required for running most regular programs (specifically: all dynamic ELF
binaries, which is how most distributions build packaged programs). This means that blocking these
system calls (which include <function>open()</function>, <function>openat()</function> or
<function>mmap()</function>) will make most programs typically shipped with generic distributions
unusable.</para>
man: rework documentation for ReadOnlyPaths= and related settings This reworks the documentation for ReadOnlyPaths=, ReadWritePaths=, InaccessiblePaths=. It no longer claims that we'd follow symlinks relative to the host file system. (Which wasn't true actually, as we didn't follow symlinks at all in the most recent releases, and we know do follow them, but relative to RootDirectory=). This also replaces all references to the fact that all fs namespacing options can be undone with enough privileges and disable propagation by a single one in the documentation of ReadOnlyPaths= and friends, and then directs the read to this in all other places. Moreover a hint is added to the documentation of SystemCallFilter=, suggesting usage of ~@mount in case any of the fs namespacing related options are used.
2016-08-26 18:24:37 +08:00
<para>It is recommended to combine the file system namespacing related options with
<varname>SystemCallFilter=~@mount</varname>, in order to prohibit the unit's processes to undo the
mappings. Specifically these are the options <varname>PrivateTmp=</varname>,
<varname>PrivateDevices=</varname>, <varname>ProtectSystem=</varname>, <varname>ProtectHome=</varname>,
<varname>ProtectKernelTunables=</varname>, <varname>ProtectControlGroups=</varname>,
man: doc: Document ProtectClock=
2020-01-27 04:47:50 +08:00
<varname>ProtectKernelLogs=</varname>, <varname>ProtectClock=</varname>, <varname>ReadOnlyPaths=</varname>,
man: update version information As I noticed a lot of missing information when trying to implement checking for missing info. I reimplemented the version information script to be more robust, and here is the result. Follow up to ec07c3c80b2b1bfa6788500202006ff85f5ae4f4
2023-09-18 23:03:38 +08:00
<varname>InaccessiblePaths=</varname> and <varname>ReadWritePaths=</varname>.</para>
<xi:include href="version-info.xml" xpointer="v187"/></listitem>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
</varlistentry>
<varlistentry>
<term><varname>SystemCallErrorNumber=</varname></term>
man: beef up systemd.exec(5) Prompted by: https://lists.freedesktop.org/archives/systemd-devel/2019-May/042773.html
2019-05-28 22:50:10 +08:00
<listitem><para>Takes an <literal>errno</literal> error number (between 1 and 4095) or errno name
such as <constant>EPERM</constant>, <constant>EACCES</constant> or <constant>EUCLEAN</constant>, to
return when the system call filter configured with <varname>SystemCallFilter=</varname> is triggered,
instead of terminating the process immediately. See <citerefentry
project='man-pages'><refentrytitle>errno</refentrytitle><manvolnum>3</manvolnum></citerefentry> for a
exec: Add kill action to system call filters Define explicit action "kill" for SystemCallErrorNumber=. In addition to errno code, allow specifying "kill" as action for SystemCallFilter=. --- v7: seccomp_parse_errno_or_action() returns -EINVAL if !HAVE_SECCOMP v6: use streq_ptr(), let errno_to_name() handle bad values, kill processes, init syscall_errno v5: actually use seccomp_errno_or_action_to_string(), don't fail bus unit parsing without seccomp v4: fix build without seccomp v3: drop log action v2: action -> number
2020-08-05 21:31:26 +08:00
full list of error codes. When this setting is not used, or when the empty string or the special
setting <literal>kill</literal> is assigned, the process will be terminated immediately when the
man: update version information As I noticed a lot of missing information when trying to implement checking for missing info. I reimplemented the version information script to be more robust, and here is the result. Follow up to ec07c3c80b2b1bfa6788500202006ff85f5ae4f4
2023-09-18 23:03:38 +08:00
filter is triggered.</para>
<xi:include href="version-info.xml" xpointer="v209"/></listitem>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
</varlistentry>
<varlistentry>
<term><varname>SystemCallArchitectures=</varname></term>
man: improve documentation on seccomp regarding alternative ABIs Let's clarify that RestrictAddressFamilies= and MemoryDenyWriteExecute= are only fully effective if non-native system call architectures are disabled, since they otherwise may be used to circumvent the filters, as the filters aren't equally effective on all ABIs. Fixes: #5277
2017-02-10 01:27:02 +08:00
<listitem><para>Takes a space-separated list of architecture identifiers to include in the system call
filter. The known architecture identifiers are the same as for <varname>ConditionArchitecture=</varname>
described in <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
as well as <constant>x32</constant>, <constant>mips64-n32</constant>, <constant>mips64-le-n32</constant>, and
man: Add some punctuation; remove double spaces.
2022-06-15 01:42:59 +08:00
the special identifier <constant>native</constant>. The special identifier <constant>native</constant>
man: systemd.exec: cleanup "only X will be permitted" ... "but X=X+1" > Only system calls of the *specified* architectures will be permitted to > processes of this unit. (my emphasis) > Note that setting this option to a non-empty list implies that > native is included too. Attempting to use "implies" in the later sentence, in a way that contradicts the very clear meaning of the earlier sentence... it's too much.
2018-01-31 23:39:13 +08:00
implicitly maps to the native architecture of the system (or more precisely: to the architecture the system
manager is compiled for). If running in user mode, or in system mode, but without the
man: update document about NoNewPrivileges= Fixes #18914.
2021-03-08 09:36:49 +08:00
<constant>CAP_SYS_ADMIN</constant> capability (e.g. setting <varname>User=</varname>),
man: systemd.exec: cleanup "only X will be permitted" ... "but X=X+1" > Only system calls of the *specified* architectures will be permitted to > processes of this unit. (my emphasis) > Note that setting this option to a non-empty list implies that > native is included too. Attempting to use "implies" in the later sentence, in a way that contradicts the very clear meaning of the earlier sentence... it's too much.
2018-01-31 23:39:13 +08:00
<varname>NoNewPrivileges=yes</varname> is implied. By default, this option is set to the empty list, i.e. no
tree-wide: fixes for assorted grammar and spelling issues Fixes #16363. Also includes some changes where I generalized the pattern.
2020-07-06 16:49:59 +08:00
filtering is applied.</para>
man: improve documentation on seccomp regarding alternative ABIs Let's clarify that RestrictAddressFamilies= and MemoryDenyWriteExecute= are only fully effective if non-native system call architectures are disabled, since they otherwise may be used to circumvent the filters, as the filters aren't equally effective on all ABIs. Fixes: #5277
2017-02-10 01:27:02 +08:00
seccomp: allow x86-64 syscalls on x32, used by the VDSO (fix #8060) The VDSO provided by the kernel for x32, uses x86-64 syscalls instead of x32 ones. I think we can safely allow this; the set of x86-64 syscalls should be very similar to the x32 ones. The real point is not to allow *x86* syscalls, because some of those are inconveniently multiplexed and we're apparently not able to block the specific actions we want to.
2018-02-03 00:06:32 +08:00
<para>If this setting is used, processes of this unit will only be permitted to call native system calls, and
system calls of the specified architectures. For the purposes of this option, the x32 architecture is treated
as including x86-64 system calls. However, this setting still fulfills its purpose, as explained below, on
x32.</para>
<para>System call filtering is not equally effective on all architectures. For example, on x86
man: improve documentation on seccomp regarding alternative ABIs Let's clarify that RestrictAddressFamilies= and MemoryDenyWriteExecute= are only fully effective if non-native system call architectures are disabled, since they otherwise may be used to circumvent the filters, as the filters aren't equally effective on all ABIs. Fixes: #5277
2017-02-10 01:27:02 +08:00
filtering of network socket-related calls is not possible, due to ABI limitations — a limitation that x86-64
does not have, however. On systems supporting multiple ABIs at the same time — such as x86/x86-64 — it is hence
recommended to limit the set of permitted system call architectures so that secondary ABIs may not be used to
circumvent the restrictions applied to the native ABI of the system. In particular, setting
Fix typo in man/systemd.exec.xml (#6683)
2017-08-29 00:38:29 +08:00
<varname>SystemCallArchitectures=native</varname> is a good choice for disabling non-native ABIs.</para>
man: improve documentation on seccomp regarding alternative ABIs Let's clarify that RestrictAddressFamilies= and MemoryDenyWriteExecute= are only fully effective if non-native system call architectures are disabled, since they otherwise may be used to circumvent the filters, as the filters aren't equally effective on all ABIs. Fixes: #5277
2017-02-10 01:27:02 +08:00
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
<para>System call architectures may also be restricted system-wide via the
<varname>SystemCallArchitectures=</varname> option in the global configuration. See
<citerefentry><refentrytitle>systemd-system.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry> for
man: update version information As I noticed a lot of missing information when trying to implement checking for missing info. I reimplemented the version information script to be more robust, and here is the result. Follow up to ec07c3c80b2b1bfa6788500202006ff85f5ae4f4
2023-09-18 23:03:38 +08:00
details.</para>
<xi:include href="version-info.xml" xpointer="v209"/></listitem>
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
</varlistentry>
exec: SystemCallLog= directive With new directive SystemCallLog= it's possible to list system calls to be logged. This can be used for auditing or temporarily when constructing system call filters. --- v5: drop intermediary, update HASHMAP_FOREACH_KEY() use v4: skip useless debug messages, actually parse directive v3: don't declare unused variables with old libseccomp v2: fix build without seccomp or old libseccomp
2020-08-31 02:56:13 +08:00
<varlistentry>
<term><varname>SystemCallLog=</varname></term>
<listitem><para>Takes a space-separated list of system call names. If this setting is used, all
system calls executed by the unit processes for the listed ones will be logged. If the first
character of the list is <literal>~</literal>, the effect is inverted: all system calls except the
listed system calls will be logged. If running in user mode, or in system mode, but without the
man: update document about NoNewPrivileges= Fixes #18914.
2021-03-08 09:36:49 +08:00
<constant>CAP_SYS_ADMIN</constant> capability (e.g. setting <varname>User=</varname>),
exec: SystemCallLog= directive With new directive SystemCallLog= it's possible to list system calls to be logged. This can be used for auditing or temporarily when constructing system call filters. --- v5: drop intermediary, update HASHMAP_FOREACH_KEY() use v4: skip useless debug messages, actually parse directive v3: don't declare unused variables with old libseccomp v2: fix build without seccomp or old libseccomp
2020-08-31 02:56:13 +08:00
<varname>NoNewPrivileges=yes</varname> is implied. This feature makes use of the Secure Computing
Mode 2 interfaces of the kernel ('seccomp filtering') and is useful for auditing or setting up a
minimal sandboxing environment. This option may be specified more than once, in which case the filter
masks are merged. If the empty string is assigned, the filter is reset, all prior assignments will
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-23 00:52:36 +08:00
have no effect. This does not affect commands prefixed with <literal>+</literal>.</para>
<xi:include href="version-info.xml" xpointer="v247"/></listitem>
exec: SystemCallLog= directive With new directive SystemCallLog= it's possible to list system calls to be logged. This can be used for auditing or temporarily when constructing system call filters. --- v5: drop intermediary, update HASHMAP_FOREACH_KEY() use v4: skip useless debug messages, actually parse directive v3: don't declare unused variables with old libseccomp v2: fix build without seccomp or old libseccomp
2020-08-31 02:56:13 +08:00
</varlistentry>
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
</variablelist>
</refsect1>
<refsect1>
<title>Environment</title>
man: move entries to the right section in systemd.directives They were in "miscellaneuos" because of the missing class= assignment. Probably introduced when the split into sections was done.
2019-02-13 17:17:49 +08:00
<variablelist class='unit-directives'>
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
<varlistentry>
<term><varname>Environment=</varname></term>
man: describe quoting and specifiers in Environment= Fixes #10604.
2021-03-01 01:37:01 +08:00
<listitem><para>Sets environment variables for executed processes. Each line is unquoted using the
rules described in "Quoting" section in
man: fix assorted issues reported by the manpage-l10n project Fixes #20297.
2021-07-27 15:37:29 +08:00
<citerefentry><refentrytitle>systemd.syntax</refentrytitle><manvolnum>7</manvolnum></citerefentry>
man: describe quoting and specifiers in Environment= Fixes #10604.
2021-03-01 01:37:01 +08:00
and becomes a list of variable assignments. If you need to assign a value containing spaces or the
equals sign to a variable, put quotes around the whole assignment. Variable expansion is not
performed inside the strings and the <literal>$</literal> character has no special meaning. Specifier
expansion is performed, see the "Specifiers" section in
<citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
</para>
<para>This option may be specified more than once, in which case all listed variables will be set. If
the same variable is listed twice, the later setting will override the earlier setting. If the empty
string is assigned to this option, the list of environment variables is reset, all prior assignments
have no effect.</para>
<para>The names of the variables can contain ASCII letters, digits, and the underscore character.
Variable names cannot be empty or start with a digit. In variable values, most characters are
allowed, but non-printable characters are currently rejected.</para>
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
<para>Example:
<programlisting>Environment="VAR1=word1 word2" VAR2=word3 "VAR3=$word 5 6"</programlisting>
gives three variables <literal>VAR1</literal>,
<literal>VAR2</literal>, <literal>VAR3</literal>
with the values <literal>word1 word2</literal>,
<literal>word3</literal>, <literal>$word 5 6</literal>.
</para>
man: describe quoting and specifiers in Environment= Fixes #10604.
2021-03-01 01:37:01 +08:00
<para>See <citerefentry
project='man-pages'><refentrytitle>environ</refentrytitle><manvolnum>7</manvolnum></citerefentry> for
details about environment variables.</para>
man: document that env vars are not suitable for passing secrets Prompted by the thread around: https://lists.freedesktop.org/archives/systemd-devel/2018-November/041665.html
2018-11-14 06:09:32 +08:00
man: document pid1's new credentials logic
2020-07-24 00:05:54 +08:00
<para>Note that environment variables are not suitable for passing secrets (such as passwords, key
material, …) to service processes. Environment variables set for a unit are exposed to unprivileged
clients via D-Bus IPC, and generally not understood as being data that requires protection. Moreover,
environment variables are propagated down the process tree, including across security boundaries
(such as setuid/setgid executables), and hence might leak to processes that should not have access to
man: document the new (Load|Set)CredentialEncrypted= settings
2021-06-24 00:15:02 +08:00
the secret data. Use <varname>LoadCredential=</varname>, <varname>LoadCredentialEncrypted=</varname>
or <varname>SetCredentialEncrypted=</varname> (see below) to pass data to unit processes
man: document pid1's new credentials logic
2020-07-24 00:05:54 +08:00
securely.</para></listitem>
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
</varlistentry>
<varlistentry>
<term><varname>EnvironmentFile=</varname></term>
man: similar → similarly Something *is* similar Something *works* similarly Something does something, similarly to how something else does something See https://sites.ulethbridge.ca/roussel/2017/11/29/similar-and-similarly-are-they-similar/ for a clear explanation.
2022-08-23 18:12:28 +08:00
<listitem><para>Similar to <varname>Environment=</varname>, but reads the environment variables from
a text file. The text file should contain newline-separated variable assignments. Empty lines, lines
without an <literal>=</literal> separator, or lines starting with <literal>;</literal> or
<literal>#</literal> will be ignored, which may be used for commenting. The file must be UTF-8
encoded. Valid characters are <ulink
url="https://www.unicode.org/glossary/#unicode_scalar_value">unicode scalar values</ulink> other than
<ulink url="https://www.unicode.org/glossary/#noncharacter">noncharacters</ulink>, U+0000 NUL, and
U+FEFF <ulink url="https://www.unicode.org/glossary/#byte_order_mark">byte order mark</ulink>.
Control codes other than NUL are allowed.</para>
man: clarify Environmentfile format Remove incorrect claim that C escapes (such as \t and \n) are recognized and that control characters are disallowed. Specify the allowed characters and escapes with single quotes, with double quotes, and without quotes.
2021-12-27 09:12:00 +08:00
<para>In the file, an unquoted value after the <literal>=</literal> is parsed with the same backslash-escape
rules as <ulink
url="https://pubs.opengroup.org/onlinepubs/9699919799/utilities/V3_chap02.html#tag_18_02_01">unquoted
text</ulink> in a POSIX shell, but unlike in a shell, interior whitespace is preserved and quotes after the
first non-whitespace character are preserved. Leading and trailing whitespace (space, tab, carriage return) is
discarded, but interior whitespace within the line is preserved verbatim. A line ending with a backslash will be
continued to the following one, with the newline itself discarded. A backslash
<literal>\</literal> followed by any character other than newline will preserve the following character, so that
<literal>\\</literal> will become the value <literal>\</literal>.</para>
<para>In the file, a <literal>'</literal>-quoted value after the <literal>=</literal> can span multiple lines
and contain any character verbatim other than single quote, like <ulink
url="https://pubs.opengroup.org/onlinepubs/9699919799/utilities/V3_chap02.html#tag_18_02_02">single-quoted
text</ulink> in a POSIX shell. No backslash-escape sequences are recognized. Leading and trailing whitespace
outside of the single quotes is discarded.</para>
<para>In the file, a <literal>"</literal>-quoted value after the <literal>=</literal> can span multiple lines,
and the same escape sequences are recognized as in <ulink
url="https://pubs.opengroup.org/onlinepubs/9699919799/utilities/V3_chap02.html#tag_18_02_03">double-quoted
text</ulink> of a POSIX shell. Backslash (<literal>\</literal>) followed by any of <literal>"\`$</literal> will
preserve that character. A backslash followed by newline is a line continuation, and the newline itself is
discarded. A backslash followed by any other character is ignored; both the backslash and the following
character are preserved verbatim. Leading and trailing whitespace outside of the double quotes is
discarded.</para>
man: document updated newline support Since v239 newlines have been allowed for PassEnvironment= and EnvironmentFile=, due to #8471. This PR documents the behavior change.
2019-10-04 04:26:42 +08:00
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
<para>The argument passed should be an absolute filename or wildcard expression, optionally prefixed with
<literal>-</literal>, which indicates that if the file does not exist, it will not be read and no error or
warning message is logged. This option may be specified more than once in which case all specified files are
read. If the empty string is assigned to this option, the list of file to read is reset, all prior assignments
have no effect.</para>
<para>The files listed with this directive will be read shortly before the process is executed (more
man: Add some punctuation; remove double spaces.
2022-06-15 01:42:59 +08:00
specifically, after all processes from a previous unit state terminated. This means you can generate these
files in one unit state, and read it with this option in the next. The files are read from the file
systemd.exec: document the file system for EnvironmentFile paths Files specified with EnvironmentFile are read from PID1 mount namespace, before any file system operations like RootImage or BindPaths are in effect.
2019-12-29 01:38:27 +08:00
system of the service manager, before any file system changes like bind mounts take place).</para>
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
<para>Settings from these files override settings made with <varname>Environment=</varname>. If the same
variable is set twice from these files, the files will be read in the order they are specified and the later
setting will override the earlier setting.</para></listitem>
</varlistentry>
<varlistentry>
<term><varname>PassEnvironment=</varname></term>
<listitem><para>Pass environment variables set for the system service manager to executed processes. Takes a
space-separated list of variable names. This option may be specified more than once, in which case all listed
variables will be passed. If the empty string is assigned to this option, the list of environment variables to
pass is reset, all prior assignments have no effect. Variables specified that are not set for the system
manager will not be passed and will be silently ignored. Note that this option is only relevant for the system
service manager, as system services by default do not automatically inherit any environment variables set for
the service manager itself. However, in case of the user service manager all environment variables are passed
to the executed processes anyway, hence this option is without effect for the user service manager.</para>
<para>Variables set for invoked processes due to this setting are subject to being overridden by those
configured with <varname>Environment=</varname> or <varname>EnvironmentFile=</varname>.</para>
<para>Example:
<programlisting>PassEnvironment=VAR1 VAR2 VAR3</programlisting>
passes three variables <literal>VAR1</literal>,
<literal>VAR2</literal>, <literal>VAR3</literal>
with the values set for those variables in PID1.</para>
<para>
See <citerefentry
project='man-pages'><refentrytitle>environ</refentrytitle><manvolnum>7</manvolnum></citerefentry> for details
man: update version information As I noticed a lot of missing information when trying to implement checking for missing info. I reimplemented the version information script to be more robust, and here is the result. Follow up to ec07c3c80b2b1bfa6788500202006ff85f5ae4f4
2023-09-18 23:03:38 +08:00
about environment variables.</para>
<xi:include href="version-info.xml" xpointer="v228"/></listitem>
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
</varlistentry>
<varlistentry>
<term><varname>UnsetEnvironment=</varname></term>
<listitem><para>Explicitly unset environment variable assignments that would normally be passed from the
service manager to invoked processes of this unit. Takes a space-separated list of variable names or variable
assignments. This option may be specified more than once, in which case all listed variables/assignments will
be unset. If the empty string is assigned to this option, the list of environment variables/assignments to
unset is reset. If a variable assignment is specified (that is: a variable name, followed by
<literal>=</literal>, followed by its value), then any environment variable matching this precise assignment is
removed. If a variable name is specified (that is a variable name without any following <literal>=</literal> or
value), then any assignment matching the variable name, regardless of its value is removed. Note that the
effect of <varname>UnsetEnvironment=</varname> is applied as final step when the environment list passed to
executed processes is compiled. That means it may undo assignments from any configuration source, including
assignments made through <varname>Environment=</varname> or <varname>EnvironmentFile=</varname>, inherited from
the system manager's global set of environment variables, inherited via <varname>PassEnvironment=</varname>,
set by the service manager itself (such as <varname>$NOTIFY_SOCKET</varname> and such), or set by a PAM module
(in case <varname>PAMName=</varname> is used).</para>
man: improve description of environment block creation This adds a general description of "philosphy" of keeping the environemnt block small and hints about systemd-run -P env. The list of generated variables is split out to a subsection. Viewing the patch with ignoring whitespace changes is recommended. We don't ignore invalid assignments (except in import-environment to some extent), previous description was wrong. For https://bugzilla.redhat.com/show_bug.cgi?id=1912046#c17.
2021-01-05 18:17:14 +08:00
<para>See "Environment Variables in Spawned Processes" below for a description of how those
settings combine to form the inherited environment. See <citerefentry
project='man-pages'><refentrytitle>environ</refentrytitle><manvolnum>7</manvolnum></citerefentry> for general
man: update version information As I noticed a lot of missing information when trying to implement checking for missing info. I reimplemented the version information script to be more robust, and here is the result. Follow up to ec07c3c80b2b1bfa6788500202006ff85f5ae4f4
2023-09-18 23:03:38 +08:00
information about environment variables.</para>
<xi:include href="version-info.xml" xpointer="v235"/></listitem>
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>Logging and Standard Input/Output</title>
man: move entries to the right section in systemd.directives They were in "miscellaneuos" because of the missing class= assignment. Probably introduced when the split into sections was done.
2019-02-13 17:17:49 +08:00
<variablelist class='unit-directives'>
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
<varlistentry>
<term><varname>StandardInput=</varname></term>
<listitem><para>Controls where file descriptor 0 (STDIN) of the executed processes is connected to. Takes one
of <option>null</option>, <option>tty</option>, <option>tty-force</option>, <option>tty-fail</option>,
<option>data</option>, <option>file:<replaceable>path</replaceable></option>, <option>socket</option> or
<option>fd:<replaceable>name</replaceable></option>.</para>
<para>If <option>null</option> is selected, standard input will be connected to <filename>/dev/null</filename>,
i.e. all read attempts by the process will result in immediate EOF.</para>
<para>If <option>tty</option> is selected, standard input is connected to a TTY (as configured by
<varname>TTYPath=</varname>, see below) and the executed process becomes the controlling process of the
terminal. If the terminal is already being controlled by another process, the executed process waits until the
current controlling process releases the terminal.</para>
<para><option>tty-force</option> is similar to <option>tty</option>, but the executed process is forcefully and
immediately made the controlling process of the terminal, potentially removing previous controlling processes
from the terminal.</para>
<para><option>tty-fail</option> is similar to <option>tty</option>, but if the terminal already has a
controlling process start-up of the executed process fails.</para>
<para>The <option>data</option> option may be used to configure arbitrary textual or binary data to pass via
standard input to the executed process. The data to pass is configured via
<varname>StandardInputText=</varname>/<varname>StandardInputData=</varname> (see below). Note that the actual
file descriptor type passed (memory file, regular file, UNIX pipe, …) might depend on the kernel and available
privileges. In any case, the file descriptor is read-only, and when read returns the specified data followed by
EOF.</para>
<para>The <option>file:<replaceable>path</replaceable></option> option may be used to connect a specific file
system object to standard input. An absolute path following the <literal>:</literal> character is expected,
which may refer to a regular file, a FIFO or special file. If an <constant>AF_UNIX</constant> socket in the
file system is specified, a stream socket is connected to it. The latter is useful for connecting standard
input of processes to arbitrary system services.</para>
<para>The <option>socket</option> option is valid in socket-activated services only, and requires the relevant
socket unit file (see
<citerefentry><refentrytitle>systemd.socket</refentrytitle><manvolnum>5</manvolnum></citerefentry> for details)
to have <varname>Accept=yes</varname> set, or to specify a single socket only. If this option is set, standard
input will be connected to the socket the service was activated from, which is primarily useful for
compatibility with daemons designed for use with the traditional <citerefentry
project='freebsd'><refentrytitle>inetd</refentrytitle><manvolnum>8</manvolnum></citerefentry> socket activation
daemon.</para>
<para>The <option>fd:<replaceable>name</replaceable></option> option connects standard input to a specific,
man: Add some punctuation; remove double spaces.
2022-06-15 01:42:59 +08:00
named file descriptor provided by a socket unit. The name may be specified as part of this option, following a
<literal>:</literal> character (e.g. <literal>fd:foobar</literal>). If no name is specified, the name
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
<literal>stdin</literal> is implied (i.e. <literal>fd</literal> is equivalent to <literal>fd:stdin</literal>).
At least one socket unit defining the specified name must be provided via the <varname>Sockets=</varname>
man: Add some punctuation; remove double spaces.
2022-06-15 01:42:59 +08:00
option, and the file descriptor name may differ from the name of its containing socket unit. If multiple
matches are found, the first one will be used. See <varname>FileDescriptorName=</varname> in
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
<citerefentry><refentrytitle>systemd.socket</refentrytitle><manvolnum>5</manvolnum></citerefentry> for more
details about named file descriptors and their ordering.</para>
man: correct documentaiton of StandardInput='s defaults in regards to "data" Fixes: #18710
2021-02-23 00:52:20 +08:00
<para>This setting defaults to <option>null</option>, unless
<varname>StandardInputText=</varname>/<varname>StandardInputData=</varname> are set, in which case it
defaults to <option>data</option>.</para></listitem>
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
</varlistentry>
<varlistentry>
<term><varname>StandardOutput=</varname></term>
man: apparently we lowercased STDOUT/STDERR everywhere else in docs, do so here too
2019-11-28 17:01:49 +08:00
<listitem><para>Controls where file descriptor 1 (stdout) of the executed processes is connected
man: drop references to "syslog" and "syslog+console" from man page These options are pretty much equivalent to "journal" and "journal+console" anyway, let's simplify things, and drop them from the documentation hence. For compat reasons let's keep them in the code. (Note that they are not 100% identical to 'journal', but I doubt the distinction in behaviour is really relevant to keep this in the docs. And we should probably should drop 'syslog' entirely from our codebase eventually, but it's problematic as long as we semi-support udev on non-systemd systems still.)
2019-06-24 21:21:22 +08:00
to. Takes one of <option>inherit</option>, <option>null</option>, <option>tty</option>,
<option>journal</option>, <option>kmsg</option>, <option>journal+console</option>,
<option>kmsg+console</option>, <option>file:<replaceable>path</replaceable></option>,
Add truncate: to StandardOutput= etc. This adds the ability to specify truncate:PATH for StandardOutput= and StandardError=, similar to the existing append:PATH. The code is mostly copied from the related append: code. Fixes #8983.
2021-01-15 05:32:55 +08:00
<option>append:<replaceable>path</replaceable></option>, <option>truncate:<replaceable>path</replaceable></option>,
<option>socket</option> or <option>fd:<replaceable>name</replaceable></option>.</para>
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
<para><option>inherit</option> duplicates the file descriptor of standard input for standard output.</para>
<para><option>null</option> connects standard output to <filename>/dev/null</filename>, i.e. everything written
to it will be lost.</para>
<para><option>tty</option> connects standard output to a tty (as configured via <varname>TTYPath=</varname>,
see below). If the TTY is used for output only, the executed process will not become the controlling process of
the terminal, and will not fail or wait for other processes to release the terminal.</para>
man: drop references to "syslog" and "syslog+console" from man page These options are pretty much equivalent to "journal" and "journal+console" anyway, let's simplify things, and drop them from the documentation hence. For compat reasons let's keep them in the code. (Note that they are not 100% identical to 'journal', but I doubt the distinction in behaviour is really relevant to keep this in the docs. And we should probably should drop 'syslog' entirely from our codebase eventually, but it's problematic as long as we semi-support udev on non-systemd systems still.)
2019-06-24 21:21:22 +08:00
<para><option>journal</option> connects standard output with the journal, which is accessible via
<citerefentry><refentrytitle>journalctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>. Note
that everything that is written to kmsg (see below) is implicitly stored in the journal as well, the
specific option listed below is hence a superset of this one. (Also note that any external,
additional syslog daemons receive their log data from the journal, too, hence this is the option to
use when logging shall be processed with such a daemon.)</para>
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
<para><option>kmsg</option> connects standard output with the kernel log buffer which is accessible via
<citerefentry project='man-pages'><refentrytitle>dmesg</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
in addition to the journal. The journal daemon might be configured to send all logs to kmsg anyway, in which
case this option is no different from <option>journal</option>.</para>
man: drop references to "syslog" and "syslog+console" from man page These options are pretty much equivalent to "journal" and "journal+console" anyway, let's simplify things, and drop them from the documentation hence. For compat reasons let's keep them in the code. (Note that they are not 100% identical to 'journal', but I doubt the distinction in behaviour is really relevant to keep this in the docs. And we should probably should drop 'syslog' entirely from our codebase eventually, but it's problematic as long as we semi-support udev on non-systemd systems still.)
2019-06-24 21:21:22 +08:00
<para><option>journal+console</option> and <option>kmsg+console</option> work in a similar way as the
two options above but copy the output to the system console as well.</para>
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
<para>The <option>file:<replaceable>path</replaceable></option> option may be used to connect a specific file
system object to standard output. The semantics are similar to the same option of
Add support for opening files for appending Addresses part of #8983
2018-07-04 03:22:29 +08:00
<varname>StandardInput=</varname>, see above. If <replaceable>path</replaceable> refers to a regular file
on the filesystem, it is opened (created if it doesn't exist yet) for writing at the beginning of the file,
but without truncating it.
man/systemd.exec: tweak markup a bit
2022-03-09 21:45:59 +08:00
If standard input and output are directed to the same file path, it is opened only once — for reading as well
as writing — and duplicated. This is particularly useful when the specified path refers to an
Add support for opening files for appending Addresses part of #8983
2018-07-04 03:22:29 +08:00
<constant>AF_UNIX</constant> socket in the file system, as in that case only a
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
single stream connection is created for both input and output.</para>
tree-wide: fixes for assorted grammar and spelling issues Fixes #16363. Also includes some changes where I generalized the pattern.
2020-07-06 16:49:59 +08:00
<para><option>append:<replaceable>path</replaceable></option> is similar to
<option>file:<replaceable>path</replaceable></option> above, but it opens the file in append mode.
</para>
Add support for opening files for appending Addresses part of #8983
2018-07-04 03:22:29 +08:00
Add truncate: to StandardOutput= etc. This adds the ability to specify truncate:PATH for StandardOutput= and StandardError=, similar to the existing append:PATH. The code is mostly copied from the related append: code. Fixes #8983.
2021-01-15 05:32:55 +08:00
<para><option>truncate:<replaceable>path</replaceable></option> is similar to
man: document that truncate:file happens per command line
2021-01-16 03:10:51 +08:00
<option>file:<replaceable>path</replaceable></option> above, but it truncates the file when opening
it. For units with multiple command lines, e.g. <varname>Type=oneshot</varname> services with
multiple <varname>ExecStart=</varname>, or services with <varname>ExecCondition=</varname>,
<varname>ExecStartPre=</varname> or <varname>ExecStartPost=</varname>, the output file is reopened
man: document effects of concurrent truncation Co-authored-by: Lennart Poettering <lennart@poettering.net>
2021-01-19 04:58:28 +08:00
and therefore re-truncated for each command line. If the output file is truncated while another
process still has the file open, e.g. by an <varname>ExecReload=</varname> running concurrently with
an <varname>ExecStart=</varname>, and the other process continues writing to the file without
adjusting its offset, then the space between the file pointers of the two processes may be filled
with <constant>NUL</constant> bytes, producing a sparse file. Thus,
<option>truncate:<replaceable>path</replaceable></option> is typically only useful for units where
only one process runs at a time, such as services with a single <varname>ExecStart=</varname> and no
<varname>ExecStartPost=</varname>, <varname>ExecReload=</varname>, <varname>ExecStop=</varname> or
similar.</para>
Add truncate: to StandardOutput= etc. This adds the ability to specify truncate:PATH for StandardOutput= and StandardError=, similar to the existing append:PATH. The code is mostly copied from the related append: code. Fixes #8983.
2021-01-15 05:32:55 +08:00
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
<para><option>socket</option> connects standard output to a socket acquired via socket activation. The
semantics are similar to the same option of <varname>StandardInput=</varname>, see above.</para>
man/systemd.exec: tweak markup a bit
2022-03-09 21:45:59 +08:00
<para>The <option>fd:<replaceable>name</replaceable></option> option connects standard output to a
man: Add some punctuation; remove double spaces.
2022-06-15 01:42:59 +08:00
specific, named file descriptor provided by a socket unit. A name may be specified as part of this
man/systemd.exec: tweak markup a bit
2022-03-09 21:45:59 +08:00
option, following a <literal>:</literal> character
(e.g. <literal>fd:<replaceable>foobar</replaceable></literal>). If no name is specified, the name
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
<literal>stdout</literal> is implied (i.e. <literal>fd</literal> is equivalent to
man/systemd.exec: tweak markup a bit
2022-03-09 21:45:59 +08:00
<literal>fd:stdout</literal>). At least one socket unit defining the specified name must be provided
via the <varname>Sockets=</varname> option, and the file descriptor name may differ from the name of
its containing socket unit. If multiple matches are found, the first one will be used. See
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
<varname>FileDescriptorName=</varname> in
man/systemd.exec: tweak markup a bit
2022-03-09 21:45:59 +08:00
<citerefentry><refentrytitle>systemd.socket</refentrytitle><manvolnum>5</manvolnum></citerefentry>
for more details about named descriptors and their ordering.</para>
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
man: drop references to "syslog" and "syslog+console" from man page These options are pretty much equivalent to "journal" and "journal+console" anyway, let's simplify things, and drop them from the documentation hence. For compat reasons let's keep them in the code. (Note that they are not 100% identical to 'journal', but I doubt the distinction in behaviour is really relevant to keep this in the docs. And we should probably should drop 'syslog' entirely from our codebase eventually, but it's problematic as long as we semi-support udev on non-systemd systems still.)
2019-06-24 21:21:22 +08:00
<para>If the standard output (or error output, see below) of a unit is connected to the journal or
the kernel log buffer, the unit will implicitly gain a dependency of type <varname>After=</varname>
on <filename>systemd-journald.socket</filename> (also see the "Implicit Dependencies" section
above). Also note that in this case stdout (or stderr, see below) will be an
<constant>AF_UNIX</constant> stream socket, and not a pipe or FIFO that can be re-opened. This means
when executing shell scripts the construct <command>echo "hello" &gt; /dev/stderr</command> for
writing text to stderr will not work. To mitigate this use the construct <command>echo "hello"
>&amp;2</command> instead, which is mostly equivalent and avoids this pitfall.</para>
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
docs: Correct StandartOutput documentation fix #2114
2022-07-30 14:46:27 +08:00
<para>If <varname>StandardInput=</varname> is set to one of <option>tty</option>, <option>tty-force</option>,
<option>tty-fail</option>, <option>socket</option>, or <option>fd:<replaceable>name</replaceable></option>, this
setting defaults to <option>inherit</option>.</para>
<para>In other cases, this setting defaults to the value set with <varname>DefaultStandardOutput=</varname> in
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
<citerefentry><refentrytitle>systemd-system.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>, which
defaults to <option>journal</option>. Note that setting this parameter might result in additional dependencies
to be added to the unit (see above).</para></listitem>
</varlistentry>
<varlistentry>
<term><varname>StandardError=</varname></term>
man: apparently we lowercased STDOUT/STDERR everywhere else in docs, do so here too
2019-11-28 17:01:49 +08:00
<listitem><para>Controls where file descriptor 2 (stderr) of the executed processes is connected to. The
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
available options are identical to those of <varname>StandardOutput=</varname>, with some exceptions: if set to
<option>inherit</option> the file descriptor used for standard output is duplicated for standard error, while
<option>fd:<replaceable>name</replaceable></option> will use a default file descriptor name of
<literal>stderr</literal>.</para>
<para>This setting defaults to the value set with <varname>DefaultStandardError=</varname> in
<citerefentry><refentrytitle>systemd-system.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>, which
defaults to <option>inherit</option>. Note that setting this parameter might result in additional dependencies
to be added to the unit (see above).</para></listitem>
</varlistentry>
<varlistentry>
<term><varname>StandardInputText=</varname></term>
<term><varname>StandardInputData=</varname></term>
man: correct documentaiton of StandardInput='s defaults in regards to "data" Fixes: #18710
2021-02-23 00:52:20 +08:00
<listitem><para>Configures arbitrary textual or binary data to pass via file descriptor 0 (STDIN) to
the executed processes. These settings have no effect unless <varname>StandardInput=</varname> is set
to <option>data</option> (which is the default if <varname>StandardInput=</varname> is not set
otherwise, but <varname>StandardInputText=</varname>/<varname>StandardInputData=</varname> is). Use
this option to embed process input data directly in the unit file.</para>
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
<para><varname>StandardInputText=</varname> accepts arbitrary textual data. C-style escapes for special
characters as well as the usual <literal>%</literal>-specifiers are resolved. Each time this setting is used
doc: more spelling fixes
2018-06-12 22:19:21 +08:00
the specified text is appended to the per-unit data buffer, followed by a newline character (thus every use
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
appends a new line to the end of the buffer). Note that leading and trailing whitespace of lines configured
with this option is removed. If an empty line is specified the buffer is cleared (hence, in order to insert an
empty line, add an additional <literal>\n</literal> to the end or beginning of a line).</para>
<para><varname>StandardInputData=</varname> accepts arbitrary binary data, encoded in <ulink
url="https://tools.ietf.org/html/rfc2045#section-6.8">Base64</ulink>. No escape sequences or specifiers are
resolved. Any whitespace in the encoded version is ignored during decoding.</para>
<para>Note that <varname>StandardInputText=</varname> and <varname>StandardInputData=</varname> operate on the
same data buffer, and may be mixed in order to configure both binary and textual data for the same input
stream. The textual or binary data is joined strictly in the order the settings appear in the unit
file. Assigning an empty string to either will reset the data buffer.</para>
<para>Please keep in mind that in order to maintain readability long unit file settings may be split into
multiple lines, by suffixing each line (except for the last) with a <literal>\</literal> character (see
<citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry> for
details). This is particularly useful for large data configured with these two options. Example:</para>
<programlisting>…
StandardInput=data
man: correct a major missed opportunity I don't know why this didn't occur to me earlier, but of course, it *has* to be this data. (This replaces some German prose about Berlin, that i guess only very few people will get. With the new blob I think we have a much broader chance of delivering smiles.)
2022-05-02 22:49:17 +08:00
StandardInputData=V2XigLJyZSBubyBzdHJhbmdlcnMgdG8gbG92ZQpZb3Uga25vdyB0aGUgcnVsZXMgYW5kIHNvIGRv \
IEkKQSBmdWxsIGNvbW1pdG1lbnQncyB3aGF0IEnigLJtIHRoaW5raW5nIG9mCllvdSB3b3VsZG4n \
dCBnZXQgdGhpcyBmcm9tIGFueSBvdGhlciBndXkKSSBqdXN0IHdhbm5hIHRlbGwgeW91IGhvdyBJ \
J20gZmVlbGluZwpHb3R0YSBtYWtlIHlvdSB1bmRlcnN0YW5kCgpOZXZlciBnb25uYSBnaXZlIHlv \
dSB1cApOZXZlciBnb25uYSBsZXQgeW91IGRvd24KTmV2ZXIgZ29ubmEgcnVuIGFyb3VuZCBhbmQg \
ZGVzZXJ0IHlvdQpOZXZlciBnb25uYSBtYWtlIHlvdSBjcnkKTmV2ZXIgZ29ubmEgc2F5IGdvb2Ri \
eWUKTmV2ZXIgZ29ubmEgdGVsbCBhIGxpZSBhbmQgaHVydCB5b3UK
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-23 00:52:36 +08:00
…</programlisting>
<xi:include href="version-info.xml" xpointer="v236"/></listitem>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
</varlistentry>
<varlistentry>
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
<term><varname>LogLevelMax=</varname></term>
man: Document that RestrictAddressFamilies= doesn't work on s390/s390x/... We already say that it doesn't work on i386, but there are more archs like that apparently.
2017-02-04 01:33:04 +08:00
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
<listitem><para>Configures filtering by log level of log messages generated by this unit. Takes a
<command>syslog</command> log level, one of <option>emerg</option> (lowest log level, only highest priority
messages), <option>alert</option>, <option>crit</option>, <option>err</option>, <option>warning</option>,
<option>notice</option>, <option>info</option>, <option>debug</option> (highest log level, also lowest priority
messages). See <citerefentry
project='man-pages'><refentrytitle>syslog</refentrytitle><manvolnum>3</manvolnum></citerefentry> for
details. By default no filtering is applied (i.e. the default maximum log level is <option>debug</option>). Use
this option to configure the logging system to drop log messages of a specific service above the specified
level. For example, set <varname>LogLevelMax=</varname><option>info</option> in order to turn off debug logging
doc: more spelling fixes
2018-06-12 22:19:21 +08:00
of a particularly chatty unit. Note that the configured level is applied to any log messages written by any
core: apply LogLevelMax to messages about units This commit applies the filtering imposed by LogLevelMax on a unit's processes to messages logged by PID1 about the unit as well. The target use case for this feature is a service that runs on a timer many times an hour, where the system administrator decides that writing a generic success message to the journal every few minutes or seconds adds no diagnostic value and isn't worth the clutter or disk I/O.
2021-05-01 00:47:10 +08:00
of the processes belonging to this unit, as well as any log messages written by the system manager process
(PID 1) in reference to this unit, sent via any supported logging protocol. The filtering is applied
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
early in the logging pipeline, before any kind of further processing is done. Moreover, messages which pass
through this filter successfully might still be dropped by filters applied at a later stage in the logging
subsystem. For example, <varname>MaxLevelStore=</varname> configured in
<citerefentry><refentrytitle>journald.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry> might
prohibit messages of higher log levels to be stored on disk, even though the per-unit
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-23 00:52:36 +08:00
<varname>LogLevelMax=</varname> permitted it to be processed.</para>
<xi:include href="version-info.xml" xpointer="v236"/></listitem>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
</varlistentry>
core: add new RestrictNamespaces= unit file setting This new setting permits restricting whether namespaces may be created and managed by processes started by a unit. It installs a seccomp filter blocking certain invocations of unshare(), clone() and setns(). RestrictNamespaces=no is the default, and does not restrict namespaces in any way. RestrictNamespaces=yes takes away the ability to create or manage any kind of namspace. "RestrictNamespaces=mnt ipc" restricts the creation of namespaces so that only mount and IPC namespaces may be created/managed, but no other kind of namespaces. This setting should be improve security quite a bit as in particular user namespacing was a major source of CVEs in the kernel in the past, and is accessible to unprivileged processes. With this setting the entire attack surface may be removed for system services that do not make use of namespaces.
2016-11-02 10:25:19 +08:00
<varlistentry>
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
<term><varname>LogExtraFields=</varname></term>
core: add new RestrictNamespaces= unit file setting This new setting permits restricting whether namespaces may be created and managed by processes started by a unit. It installs a seccomp filter blocking certain invocations of unshare(), clone() and setns(). RestrictNamespaces=no is the default, and does not restrict namespaces in any way. RestrictNamespaces=yes takes away the ability to create or manage any kind of namspace. "RestrictNamespaces=mnt ipc" restricts the creation of namespaces so that only mount and IPC namespaces may be created/managed, but no other kind of namespaces. This setting should be improve security quite a bit as in particular user namespacing was a major source of CVEs in the kernel in the past, and is accessible to unprivileged processes. With this setting the entire attack surface may be removed for system services that do not make use of namespaces.
2016-11-02 10:25:19 +08:00
manager: put bin before sbin for user instances Traditionally, user logins had a $PATH in which /bin was before /sbin, while root logins had a $PATH with /sbin first. This allows the tricks that consolehelper is doing to work. But even if we ignore consolehelper, having the path in this order might have been used by admins for other purposes, and keeping the order in user sessions will make it easier the adoption of systemd user sessions a bit easier. Fixes #733. https://bugzilla.redhat.com/show_bug.cgi?id=1744059 OOM handling in manager_default_environment wasn't really correct. Now the (theorertical) malloc failure in strv_new() is handled. Please note that this has no effect on: - systems with merged /bin-/sbin (e.g. arch) - when there are no binaries that differ between the two locations. E.g. on my F30 laptop there is exactly one program that is affected: /usr/bin/setup -> consolehelper. There is less and less stuff that relies on consolehelper, but there's still some. So for "clean" systems this makes no difference, but helps with legacy setups. $ dnf repoquery --releasever=31 --qf %{name} --whatrequires usermode anaconda-live audit-viewer beesu chkrootkit driftnet drobo-utils-gui hddtemp mate-system-log mock pure-ftpd setuptool subscription-manager system-config-httpd system-config-rootpassword system-switch-java system-switch-mail usermode-gtk vpnc-consoleuser wifi-radar xawtv
2015-08-07 09:34:15 +08:00
<listitem><para>Configures additional log metadata fields to include in all log records generated by
core: append LogExtraFields= values to log_unit* messages This ensure messages from PID1 regarding a unit also contain those fields. For example, portable services have PORTABLE=<image> as extra fields, which is useful to identify which version of a portable image produced a log message like an error or an oomd kill.
2023-03-14 05:34:37 +08:00
processes associated with this unit, including systemd. This setting takes one or more journal field
assignments in the format <literal>FIELD=VALUE</literal> separated by whitespace. See
manager: put bin before sbin for user instances Traditionally, user logins had a $PATH in which /bin was before /sbin, while root logins had a $PATH with /sbin first. This allows the tricks that consolehelper is doing to work. But even if we ignore consolehelper, having the path in this order might have been used by admins for other purposes, and keeping the order in user sessions will make it easier the adoption of systemd user sessions a bit easier. Fixes #733. https://bugzilla.redhat.com/show_bug.cgi?id=1744059 OOM handling in manager_default_environment wasn't really correct. Now the (theorertical) malloc failure in strv_new() is handled. Please note that this has no effect on: - systems with merged /bin-/sbin (e.g. arch) - when there are no binaries that differ between the two locations. E.g. on my F30 laptop there is exactly one program that is affected: /usr/bin/setup -> consolehelper. There is less and less stuff that relies on consolehelper, but there's still some. So for "clean" systems this makes no difference, but helps with legacy setups. $ dnf repoquery --releasever=31 --qf %{name} --whatrequires usermode anaconda-live audit-viewer beesu chkrootkit driftnet drobo-utils-gui hddtemp mate-system-log mock pure-ftpd setuptool subscription-manager system-config-httpd system-config-rootpassword system-switch-java system-switch-mail usermode-gtk vpnc-consoleuser wifi-radar xawtv
2015-08-07 09:34:15 +08:00
<citerefentry><refentrytitle>systemd.journal-fields</refentrytitle><manvolnum>7</manvolnum></citerefentry>
for details on the journal field concept. Even though the underlying journal implementation permits
binary field values, this setting accepts only valid UTF-8 values. To include space characters in a
journal field value, enclose the assignment in double quotes ("). <!-- " fake closing quote for emacs-->
The usual specifiers are expanded in all assignments (see below). Note that this setting is not only
useful for attaching additional metadata to log records of a unit, but given that all fields and
values are indexed may also be used to implement cross-unit log record matching. Assign an empty
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-23 00:52:36 +08:00
string to reset the list.</para>
<xi:include href="version-info.xml" xpointer="v236"/></listitem>
core: add new RestrictNamespaces= unit file setting This new setting permits restricting whether namespaces may be created and managed by processes started by a unit. It installs a seccomp filter blocking certain invocations of unshare(), clone() and setns(). RestrictNamespaces=no is the default, and does not restrict namespaces in any way. RestrictNamespaces=yes takes away the ability to create or manage any kind of namspace. "RestrictNamespaces=mnt ipc" restricts the creation of namespaces so that only mount and IPC namespaces may be created/managed, but no other kind of namespaces. This setting should be improve security quite a bit as in particular user namespacing was a major source of CVEs in the kernel in the past, and is accessible to unprivileged processes. With this setting the entire attack surface may be removed for system services that do not make use of namespaces.
2016-11-02 10:25:19 +08:00
</varlistentry>
core: implement per unit journal rate limiting Add LogRateLimitIntervalSec= and LogRateLimitBurst= options for services. If provided, these values get passed to the journald client context, and those values are used in the rate limiting function in the journal over the the journald.conf values. Part of #10230
2018-10-08 11:28:36 +08:00
<varlistentry>
<term><varname>LogRateLimitIntervalSec=</varname></term>
<term><varname>LogRateLimitBurst=</varname></term>
man: fixes for assorted issues reported by the manpage-l10n project Fixes #26761.
2023-05-17 18:24:04 +08:00
<listitem><para>Configures the rate limiting that is applied to log messages generated by this unit.
If, in the time interval defined by <varname>LogRateLimitIntervalSec=</varname>, more messages than
specified in <varname>LogRateLimitBurst=</varname> are logged by a service, all further messages
man: document explicitly that LogRateLimit= has no effect on StandardOutput=file:… Fixes: #25951
2023-01-06 18:00:48 +08:00
within the interval are dropped until the interval is over. A message about the number of dropped
messages is generated. The time specification for <varname>LogRateLimitIntervalSec=</varname> may be
man: fixes for assorted issues reported by the manpage-l10n project Fixes #26761.
2023-05-17 18:24:04 +08:00
specified in the following units: "s", "min", "h", "ms", "us". See
man: document explicitly that LogRateLimit= has no effect on StandardOutput=file:… Fixes: #25951
2023-01-06 18:00:48 +08:00
<citerefentry><refentrytitle>systemd.time</refentrytitle><manvolnum>7</manvolnum></citerefentry> for
man: fixes for assorted issues reported by the manpage-l10n project Fixes #26761.
2023-05-17 18:24:04 +08:00
details. The default settings are set by <varname>RateLimitIntervalSec=</varname> and
man: document explicitly that LogRateLimit= has no effect on StandardOutput=file:… Fixes: #25951
2023-01-06 18:00:48 +08:00
<varname>RateLimitBurst=</varname> configured in
man: fixes for assorted issues reported by the manpage-l10n project Fixes #26761.
2023-05-17 18:24:04 +08:00
<citerefentry><refentrytitle>journald.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
Note that this only applies to log messages that are processed by the logging subsystem, i.e. by
<citerefentry><refentrytitle>systemd-journald.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
This means that if you connect a service's stderr directly to a file via
<varname>StandardOutput=file:…</varname> or a similar setting, the rate limiting will not be applied
to messages written that way (but it will be enforced for messages generated via
<citerefentry project='man-pages'><refentrytitle>syslog</refentrytitle><manvolnum>3</manvolnum></citerefentry>
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-23 00:52:36 +08:00
and similar functions).</para>
<xi:include href="version-info.xml" xpointer="v240"/></listitem>
core: implement per unit journal rate limiting Add LogRateLimitIntervalSec= and LogRateLimitBurst= options for services. If provided, these values get passed to the journald client context, and those values are used in the rate limiting function in the journal over the the journald.conf values. Part of #10230
2018-10-08 11:28:36 +08:00
</varlistentry>
man: document LogNamespace= unit setting
2019-11-28 17:02:02 +08:00
<varlistentry>
journal: log filtering options support in PID1 Define new unit parameter (LogFilterPatterns) to filter logs processed by journald. This option is used to store a regular expression which is carried from PID1 to systemd-journald through a cgroup xattrs: `user.journald_log_filter_patterns`.
2022-11-08 03:30:01 +08:00
<term><varname>LogFilterPatterns=</varname></term>
<listitem><para>Define an extended regular expression to filter log messages based on the
<varname>MESSAGE=</varname> field of the structured message. If the first character of the pattern is
<literal>~</literal>, log entries matching the pattern should be discarded. This option takes a single
pattern as an argument but can be used multiple times to create a list of allowed and denied patterns.
If the empty string is assigned, the filter is reset, and all prior assignments will have no effect.</para>
<para>Because the <literal>~</literal> character is used to define denied patterns, it must be replaced
with <literal>\x7e</literal> to allow a message starting with <literal>~</literal>. For example,
<literal>~foobar</literal> would add a pattern matching <literal>foobar</literal> to the deny list, while
<literal>\x7efoobar</literal> would add a pattern matching <literal>~foobar</literal> to the allow list.</para>
<para>Log messages are tested against denied patterns (if any), then against allowed patterns
(if any). If a log message matches any of the denied patterns, it will be discarded, whatever the
allowed patterns. Then, remaining log messages are tested against allowed patterns. Messages matching
against none of the allowed pattern are discarded. If no allowed patterns are defined, then all
messages are processed directly after going through denied filters.</para>
<para>Filtering is based on the unit for which <varname>LogFilterPatterns=</varname> is defined, meaning log
messages coming from
<citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry> about the
unit are not taken into account. Filtered log messages won't be forwarded to traditional syslog daemons,
the kernel log buffer (kmsg), the systemd console, or sent as wall messages to all logged-in
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-23 00:52:36 +08:00
users.</para>
<xi:include href="version-info.xml" xpointer="v253"/></listitem>
journal: log filtering options support in PID1 Define new unit parameter (LogFilterPatterns) to filter logs processed by journald. This option is used to store a regular expression which is carried from PID1 to systemd-journald through a cgroup xattrs: `user.journald_log_filter_patterns`.
2022-11-08 03:30:01 +08:00
</varlistentry>
<varlistentry>
man: document LogNamespace= unit setting
2019-11-28 17:02:02 +08:00
<term><varname>LogNamespace=</varname></term>
<listitem><para>Run the unit's processes in the specified journal namespace. Expects a short
user-defined string identifying the namespace. If not used the processes of the service are run in
the default journal namespace, i.e. their log stream is collected and processed by
<filename>systemd-journald.service</filename>. If this option is used any log data generated by
processes of this unit (regardless if via the <function>syslog()</function>, journal native logging
or stdout/stderr logging) is collected and processed by an instance of the
<filename>systemd-journald@.service</filename> template unit, which manages the specified
namespace. The log data is stored in a data store independent from the default log namespace's data
store. See
<citerefentry><refentrytitle>systemd-journald.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
for details about journal namespaces.</para>
<para>Internally, journal namespaces are implemented through Linux mount namespacing and
over-mounting the directory that contains the relevant <constant>AF_UNIX</constant> sockets used for
logging in the unit's mount namespace. Since mount namespaces are used this setting disconnects
man: similar → similarly Something *is* similar Something *works* similarly Something does something, similarly to how something else does something See https://sites.ulethbridge.ca/roussel/2017/11/29/similar-and-similarly-are-they-similar/ for a clear explanation.
2022-08-23 18:12:28 +08:00
propagation of mounts from the unit's processes to the host, similarly to how
<varname>ReadOnlyPaths=</varname> and similar settings describe above work. Journal namespaces may hence
man: document LogNamespace= unit setting
2019-11-28 17:02:02 +08:00
not be used for services that need to establish mount points on the host.</para>
<para>When this option is used the unit will automatically gain ordering and requirement dependencies
on the two socket units associated with the <filename>systemd-journald@.service</filename> instance
so that they are automatically established prior to the unit starting up. Note that when this option
is used log output of this service does not appear in the regular
<citerefentry><refentrytitle>journalctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>
man: clarify that LogNamespace= is for system services only Fixes: #16638
2020-08-06 21:27:00 +08:00
output, unless the <option>--namespace=</option> option is used.</para>
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-23 00:52:36 +08:00
<xi:include href="system-only.xml" xpointer="singular"/>
<xi:include href="version-info.xml" xpointer="v245"/></listitem>
man: document LogNamespace= unit setting
2019-11-28 17:02:02 +08:00
</varlistentry>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
<varlistentry>
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
<term><varname>SyslogIdentifier=</varname></term>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
man: drop references to "syslog" and "syslog+console" from man page These options are pretty much equivalent to "journal" and "journal+console" anyway, let's simplify things, and drop them from the documentation hence. For compat reasons let's keep them in the code. (Note that they are not 100% identical to 'journal', but I doubt the distinction in behaviour is really relevant to keep this in the docs. And we should probably should drop 'syslog' entirely from our codebase eventually, but it's problematic as long as we semi-support udev on non-systemd systems still.)
2019-06-24 21:21:22 +08:00
<listitem><para>Sets the process name ("<command>syslog</command> tag") to prefix log lines sent to
the logging system or the kernel log buffer with. If not set, defaults to the process name of the
man: Add some punctuation; remove double spaces.
2022-06-15 01:42:59 +08:00
executed process. This option is only useful when <varname>StandardOutput=</varname> or
man: drop references to "syslog" and "syslog+console" from man page These options are pretty much equivalent to "journal" and "journal+console" anyway, let's simplify things, and drop them from the documentation hence. For compat reasons let's keep them in the code. (Note that they are not 100% identical to 'journal', but I doubt the distinction in behaviour is really relevant to keep this in the docs. And we should probably should drop 'syslog' entirely from our codebase eventually, but it's problematic as long as we semi-support udev on non-systemd systems still.)
2019-06-24 21:21:22 +08:00
<varname>StandardError=</varname> are set to <option>journal</option> or <option>kmsg</option> (or to
the same settings in combination with <option>+console</option>) and only applies to log messages
written to stdout or stderr.</para></listitem>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
</varlistentry>
<varlistentry>
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
<term><varname>SyslogFacility=</varname></term>
seccomp: LockPersonality boolean (#6193) Add LockPersonality boolean to allow locking down personality(2) system call so that the execution domain can't be changed. This may be useful to improve security because odd emulations may be poorly tested and source of vulnerabilities, while system services shouldn't need any weird personalities.
2017-07-04 20:48:18 +08:00
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
<listitem><para>Sets the <command>syslog</command> facility identifier to use when logging. One of
<option>kern</option>, <option>user</option>, <option>mail</option>, <option>daemon</option>,
<option>auth</option>, <option>syslog</option>, <option>lpr</option>, <option>news</option>,
<option>uucp</option>, <option>cron</option>, <option>authpriv</option>, <option>ftp</option>,
<option>local0</option>, <option>local1</option>, <option>local2</option>, <option>local3</option>,
man: drop references to "syslog" and "syslog+console" from man page These options are pretty much equivalent to "journal" and "journal+console" anyway, let's simplify things, and drop them from the documentation hence. For compat reasons let's keep them in the code. (Note that they are not 100% identical to 'journal', but I doubt the distinction in behaviour is really relevant to keep this in the docs. And we should probably should drop 'syslog' entirely from our codebase eventually, but it's problematic as long as we semi-support udev on non-systemd systems still.)
2019-06-24 21:21:22 +08:00
<option>local4</option>, <option>local5</option>, <option>local6</option> or
<option>local7</option>. See <citerefentry
project='man-pages'><refentrytitle>syslog</refentrytitle><manvolnum>3</manvolnum></citerefentry> for
details. This option is only useful when <varname>StandardOutput=</varname> or
<varname>StandardError=</varname> are set to <option>journal</option> or <option>kmsg</option> (or to
the same settings in combination with <option>+console</option>), and only applies to log messages
written to stdout or stderr. Defaults to <option>daemon</option>.</para></listitem>
seccomp: LockPersonality boolean (#6193) Add LockPersonality boolean to allow locking down personality(2) system call so that the execution domain can't be changed. This may be useful to improve security because odd emulations may be poorly tested and source of vulnerabilities, while system services shouldn't need any weird personalities.
2017-07-04 20:48:18 +08:00
</varlistentry>
core: add new per-unit setting KeyringMode= for controlling kernel keyring setup Usually, it's a good thing that we isolate the kernel session keyring for the various services and disconnect them from the user keyring. However, in case of the cryptsetup key caching we actually want that multiple instances of the cryptsetup service can share the keys in the root user's user keyring, hence we need to be able to disable this logic for them. This adds KeyringMode=inherit|private|shared: inherit: don't do any keyring magic (this is the default in systemd --user) private: a private keyring as before (default in systemd --system) shared: the new setting
2017-09-15 03:19:05 +08:00
<varlistentry>
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
<term><varname>SyslogLevel=</varname></term>
core: add new per-unit setting KeyringMode= for controlling kernel keyring setup Usually, it's a good thing that we isolate the kernel session keyring for the various services and disconnect them from the user keyring. However, in case of the cryptsetup key caching we actually want that multiple instances of the cryptsetup service can share the keys in the root user's user keyring, hence we need to be able to disable this logic for them. This adds KeyringMode=inherit|private|shared: inherit: don't do any keyring magic (this is the default in systemd --user) private: a private keyring as before (default in systemd --system) shared: the new setting
2017-09-15 03:19:05 +08:00
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
<listitem><para>The default <command>syslog</command> log level to use when logging to the logging system or
the kernel log buffer. One of <option>emerg</option>, <option>alert</option>, <option>crit</option>,
<option>err</option>, <option>warning</option>, <option>notice</option>, <option>info</option>,
<option>debug</option>. See <citerefentry
project='man-pages'><refentrytitle>syslog</refentrytitle><manvolnum>3</manvolnum></citerefentry> for
details. This option is only useful when <varname>StandardOutput=</varname> or
man: drop references to "syslog" and "syslog+console" from man page These options are pretty much equivalent to "journal" and "journal+console" anyway, let's simplify things, and drop them from the documentation hence. For compat reasons let's keep them in the code. (Note that they are not 100% identical to 'journal', but I doubt the distinction in behaviour is really relevant to keep this in the docs. And we should probably should drop 'syslog' entirely from our codebase eventually, but it's problematic as long as we semi-support udev on non-systemd systems still.)
2019-06-24 21:21:22 +08:00
<varname>StandardError=</varname> are set to <option>journal</option> or
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
<option>kmsg</option> (or to the same settings in combination with <option>+console</option>), and only applies
to log messages written to stdout or stderr. Note that individual lines output by executed processes may be
prefixed with a different log level which can be used to override the default log level specified here. The
interpretation of these prefixes may be disabled with <varname>SyslogLevelPrefix=</varname>, see below. For
details, see <citerefentry><refentrytitle>sd-daemon</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
Defaults to <option>info</option>.</para></listitem>
seccomp: LockPersonality boolean (#6193) Add LockPersonality boolean to allow locking down personality(2) system call so that the execution domain can't be changed. This may be useful to improve security because odd emulations may be poorly tested and source of vulnerabilities, while system services shouldn't need any weird personalities.
2017-07-04 20:48:18 +08:00
</varlistentry>
<varlistentry>
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
<term><varname>SyslogLevelPrefix=</varname></term>
man: document the new logic
2017-09-29 01:14:10 +08:00
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
<listitem><para>Takes a boolean argument. If true and <varname>StandardOutput=</varname> or
man: drop references to "syslog" and "syslog+console" from man page These options are pretty much equivalent to "journal" and "journal+console" anyway, let's simplify things, and drop them from the documentation hence. For compat reasons let's keep them in the code. (Note that they are not 100% identical to 'journal', but I doubt the distinction in behaviour is really relevant to keep this in the docs. And we should probably should drop 'syslog' entirely from our codebase eventually, but it's problematic as long as we semi-support udev on non-systemd systems still.)
2019-06-24 21:21:22 +08:00
<varname>StandardError=</varname> are set to <option>journal</option> or <option>kmsg</option> (or to
the same settings in combination with <option>+console</option>), log lines written by the executed
process that are prefixed with a log level will be processed with this log level set but the prefix
removed. If set to false, the interpretation of these prefixes is disabled and the logged lines are
passed on as-is. This only applies to log messages written to stdout or stderr. For details about
this prefixing see
<citerefentry><refentrytitle>sd-daemon</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
Defaults to true.</para></listitem>
</varlistentry>
man: update documents for RuntimeDirectory= and friends
2017-11-08 14:52:08 +08:00
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
<varlistentry>
<term><varname>TTYPath=</varname></term>
man: document the new logic
2017-09-29 01:14:10 +08:00
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
<listitem><para>Sets the terminal device node to use if standard input, output, or error are connected to a TTY
(see above). Defaults to <filename>/dev/console</filename>.</para></listitem>
</varlistentry>
core: support subdirectories in RuntimeDirectory= option
2017-07-17 15:30:53 +08:00
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
<varlistentry>
<term><varname>TTYReset=</varname></term>
core: add {State,Cache,Log,Configuration}Directory= (#6384) This introduces {State,Cache,Log,Configuration}Directory= those are similar to RuntimeDirectory=. They create the directories under /var/lib, /var/cache/, /var/log, or /etc, respectively, with the mode specified in {State,Cache,Log,Configuration}DirectoryMode=. This also fixes #6391.
2017-07-18 20:34:52 +08:00
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
<listitem><para>Reset the terminal device specified with <varname>TTYPath=</varname> before and after
man: Add some punctuation; remove double spaces.
2022-06-15 01:42:59 +08:00
execution. Defaults to <literal>no</literal>.</para></listitem>
core: add {State,Cache,Log,Configuration}Directory= (#6384) This introduces {State,Cache,Log,Configuration}Directory= those are similar to RuntimeDirectory=. They create the directories under /var/lib, /var/cache/, /var/log, or /etc, respectively, with the mode specified in {State,Cache,Log,Configuration}DirectoryMode=. This also fixes #6391.
2017-07-18 20:34:52 +08:00
</varlistentry>
man: describe RuntimeDirectoryMode= Fixes #5509.
2017-06-18 03:23:02 +08:00
<varlistentry>
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
<term><varname>TTYVHangup=</varname></term>
man: describe RuntimeDirectoryMode= Fixes #5509.
2017-06-18 03:23:02 +08:00
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
<listitem><para>Disconnect all clients which have opened the terminal device specified with
<varname>TTYPath=</varname> before and after execution. Defaults to <literal>no</literal>.</para></listitem>
man: describe RuntimeDirectoryMode= Fixes #5509.
2017-06-18 03:23:02 +08:00
</varlistentry>
exec: Add TTYRows and TTYColumns properties to set TTY dimensions
2021-10-28 23:26:50 +08:00
<varlistentry>
<term><varname>TTYRows=</varname></term>
<term><varname>TTYColumns=</varname></term>
<listitem><para>Configure the size of the TTY specified with <varname>TTYPath=</varname>. If unset or
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-23 00:52:36 +08:00
set to the empty string, the kernel default is used.</para>
<xi:include href="version-info.xml" xpointer="v250"/></listitem>
exec: Add TTYRows and TTYColumns properties to set TTY dimensions
2021-10-28 23:26:50 +08:00
</varlistentry>
core: allow preserving contents of RuntimeDirectory= over process restart This introduces RuntimeDirectoryPreserve= option which takes a boolean argument or 'restart'. Closes #6087.
2017-07-17 15:22:25 +08:00
<varlistentry>
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
<term><varname>TTYVTDisallocate=</varname></term>
core: allow preserving contents of RuntimeDirectory= over process restart This introduces RuntimeDirectoryPreserve= option which takes a boolean argument or 'restart'. Closes #6087.
2017-07-17 15:22:25 +08:00
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
<listitem><para>If the terminal device specified with <varname>TTYPath=</varname> is a virtual console
terminal, try to deallocate the TTY before and after execution. This ensures that the screen and scrollback
buffer is cleared. Defaults to <literal>no</literal>.</para></listitem>
man: describe RuntimeDirectoryMode= Fixes #5509.
2017-06-18 03:23:02 +08:00
</varlistentry>
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
</variablelist>
</refsect1>
man: document pid1's new credentials logic
2020-07-24 00:05:54 +08:00
<refsect1>
<title>Credentials</title>
<variablelist class='unit-directives'>
<varlistentry>
core: allow omitting second part of LoadCredentials= argument This allows "LoadCredentials=foo" to be used as shortcut for "LoadCredentials=foo:foo", i.e. it's a very short way to inherit a credential under its original name from the service manager into a service.
2021-03-11 17:02:46 +08:00
<term><varname>LoadCredential=</varname><replaceable>ID</replaceable><optional>:<replaceable>PATH</replaceable></optional></term>
man: document the new (Load|Set)CredentialEncrypted= settings
2021-06-24 00:15:02 +08:00
<term><varname>LoadCredentialEncrypted=</varname><replaceable>ID</replaceable><optional>:<replaceable>PATH</replaceable></optional></term>
man: document pid1's new credentials logic
2020-07-24 00:05:54 +08:00
<listitem><para>Pass a credential to the unit. Credentials are limited-size binary or textual objects
that may be passed to unit processes. They are primarily used for passing cryptographic keys (both
public and private) or certificates, user account information or identity information from host to
services. The data is accessible from the unit's processes via the file system, at a read-only
location that (if possible and permitted) is backed by non-swappable memory. The data is only
accessible to the user associated with the unit, via the
<varname>User=</varname>/<varname>DynamicUser=</varname> settings (as well as the superuser). When
available, the location of credentials is exported as the <varname>$CREDENTIALS_DIRECTORY</varname>
environment variable to the unit's processes.</para>
<para>The <varname>LoadCredential=</varname> setting takes a textual ID to use as name for a
core: allow omitting second part of LoadCredentials= argument This allows "LoadCredentials=foo" to be used as shortcut for "LoadCredentials=foo:foo", i.e. it's a very short way to inherit a credential under its original name from the service manager into a service.
2021-03-11 17:02:46 +08:00
credential plus a file system path, separated by a colon. The ID must be a short ASCII string
suitable as filename in the filesystem, and may be chosen freely by the user. If the specified path
is absolute it is opened as regular file and the credential data is read from it. If the absolute
path refers to an <constant>AF_UNIX</constant> stream socket in the file system a connection is made
to it (only once at unit start-up) and the credential data read from the connection, providing an
man: document the new credentials features
2022-04-22 21:41:53 +08:00
easy IPC integration point for dynamically transferring credentials from other services.</para>
<para>If the specified path is not absolute and itself qualifies as valid credential identifier it is
attempted to find a credential that the service manager itself received under the specified name —
which may be used to propagate credentials from an invoking environment (e.g. a container manager
that invoked the service manager) into a service. If no matching system credential is found, the
directories <filename>/etc/credstore/</filename>, <filename>/run/credstore/</filename> and
<filename>/usr/lib/credstore/</filename> are searched for files under the credential's name — which
hence are recommended locations for credential data on disk. If
<varname>LoadCredentialEncrypted=</varname> is used <filename>/run/credstore.encrypted/</filename>,
<filename>/etc/credstore.encrypted/</filename>, and
<filename>/usr/lib/credstore.encrypted/</filename> are searched as well.</para>
<para>If the file system path is omitted it is chosen identical to the credential name, i.e. this is
a terse way to declare credentials to inherit from the service manager into a service. This option
may be used multiple times, each time defining an additional credential to pass to the unit.</para>
<para>If an absolute path referring to a directory is specified, every file in that directory
(recursively) will be loaded as a separate credential. The ID for each credential will be the
core: teach LoadCredential= to load from a directory
2021-07-25 00:38:22 +08:00
provided ID suffixed with <literal>_$FILENAME</literal> (e.g., <literal>Key_file1</literal>). When
loading from a directory, symlinks will be ignored.</para>
man: document pid1's new credentials logic
2020-07-24 00:05:54 +08:00
man: document the new credentials features
2022-04-22 21:41:53 +08:00
<para>The contents of the file/socket may be arbitrary binary or textual data, including newline
characters and <constant>NUL</constant> bytes.</para>
man: document the new (Load|Set)CredentialEncrypted= settings
2021-06-24 00:15:02 +08:00
<para>The <varname>LoadCredentialEncrypted=</varname> setting is identical to
man: make clear that encrypted credentials are also authenticated We use authenticated encryption, and that deserves mention. This in particular relevant as the fact they are authenticated makes the credentials useful as initrd parameterization items.
2022-04-21 21:36:03 +08:00
<varname>LoadCredential=</varname>, except that the credential data is decrypted and authenticated
before being passed on to the executed processes. Specifically, the referenced path should refer to a
file or socket with an encrypted credential, as implemented by
man: document the new (Load|Set)CredentialEncrypted= settings
2021-06-24 00:15:02 +08:00
<citerefentry><refentrytitle>systemd-creds</refentrytitle><manvolnum>1</manvolnum></citerefentry>. This
man: make clear that encrypted credentials are also authenticated We use authenticated encryption, and that deserves mention. This in particular relevant as the fact they are authenticated makes the credentials useful as initrd parameterization items.
2022-04-21 21:36:03 +08:00
credential is loaded, decrypted, authenticated and then passed to the application in plaintext form,
in the same way a regular credential specified via <varname>LoadCredential=</varname> would be. A
credential configured this way may be symmetrically encrypted/authenticated with a secret key derived
from the system's TPM2 security chip, or with a secret key stored in
<filename>/var/lib/systemd/credentials.secret</filename>, or with both. Using encrypted and
authenticated credentials improves security as credentials are not stored in plaintext and only
authenticated and decrypted into plaintext the moment a service requiring them is started. Moreover,
credentials may be bound to the local hardware and installations, so that they cannot easily be
core: imply DeviceAllow=/dev/tpmrm0 with LoadCredentialEncrypted If the device access policy is restricted, add implicitly access to the TPM if at least one encrypted credential needs to be loaded. Fixes https://github.com/systemd/systemd/issues/26042
2023-02-08 08:25:00 +08:00
analyzed offline, or be generated externally. When <varname>DevicePolicy=</varname> is set to
<literal>closed</literal> or <literal>strict</literal>, or set to <literal>auto</literal> and
<varname>DeviceAllow=</varname> is set, or <varname>PrivateDevices=</varname> is set, then this
setting adds <filename>/dev/tpmrm0</filename> with <constant>rw</constant> mode to
<varname>DeviceAllow=</varname>. See
<citerefentry><refentrytitle>systemd.resource-control</refentrytitle><manvolnum>5</manvolnum></citerefentry>
for the details about <varname>DevicePolicy=</varname> or <varname>DeviceAllow=</varname>.</para>
man: document the new (Load|Set)CredentialEncrypted= settings
2021-06-24 00:15:02 +08:00
man: document pid1's new credentials logic
2020-07-24 00:05:54 +08:00
<para>The credential files/IPC sockets must be accessible to the service manager, but don't have to
be directly accessible to the unit's processes: the credential data is read and copied into separate,
read-only copies for the unit that are accessible to appropriately privileged processes. This is
particularly useful in combination with <varname>DynamicUser=</varname> as this way privileged data
can be made available to processes running under a dynamic UID (i.e. not a previously known one)
without having to open up access to all users.</para>
<para>In order to reference the path a credential may be read from within a
<varname>ExecStart=</varname> command line use <literal>${CREDENTIALS_DIRECTORY}/mycred</literal>,
man: document the new credentials features
2022-04-22 21:41:53 +08:00
e.g. <literal>ExecStart=cat ${CREDENTIALS_DIRECTORY}/mycred</literal>. In order to reference the path
a credential may be read from within a <varname>Environment=</varname> line use
<literal>%d/mycred</literal>, e.g. <literal>Environment=MYCREDPATH=%d/mycred</literal>.</para>
man: document pid1's new credentials logic
2020-07-24 00:05:54 +08:00
man: various typos and other small issues Fixes #18397.
2021-01-29 03:38:27 +08:00
<para>Currently, an accumulated credential size limit of 1 MB per unit is enforced.</para>
fileio: beef up READ_FULL_FILE_CONNECT_SOCKET to allow setting sender socket name This beefs up the READ_FULL_FILE_CONNECT_SOCKET logic of read_full_file_full() a bit: when used a sender socket name may be specified. If specified as NULL behaviour is as before: the client socket name is picked by the kernel. But if specified as non-NULL the client can pick a socket name to use when connecting. This is useful to communicate a minimal amount of metainformation from client to server, outside of the transport payload. Specifically, these beefs up the service credential logic to pass an abstract AF_UNIX socket name as client socket name when connecting via READ_FULL_FILE_CONNECT_SOCKET, that includes the requesting unit name and the eventual credential name. This allows servers implementing the trivial credential socket logic to distinguish clients: via a simple getpeername() it can be determined which unit is requesting a credential, and which credential specifically. Example: with this patch in place, in a unit file "waldo.service" a configuration line like the following: LoadCredential=foo:/run/quux/creds.sock will result in a connection to the AF_UNIX socket /run/quux/creds.sock, originating from an abstract namespace AF_UNIX socket: @$RANDOM/unit/waldo.service/foo (The $RANDOM is replaced by some randomized string. This is included in the socket name order to avoid namespace squatting issues: the abstract socket namespace is open to unprivileged users after all, and care needs to be taken not to use guessable names) The services listening on the /run/quux/creds.sock socket may thus easily retrieve the name of the unit the credential is requested for plus the credential name, via a simpler getpeername(), discarding the random preifx and the /unit/ string. This logic uses "/" as separator between the fields, since both unit names and credential names appear in the file system, and thus are designed to use "/" as outer separators. Given that it's a good safe choice to use as separators here, too avoid any conflicts. This is a minimal patch only: the new logic is used only for the unit file credential logic. For other places where we use READ_FULL_FILE_CONNECT_SOCKET it is probably a good idea to use this scheme too, but this should be done carefully in later patches, since the socket names become API that way, and we should determine the right amount of info to pass over.
2020-11-02 19:07:51 +08:00
man: document the new credentials features
2022-04-22 21:41:53 +08:00
<para>The service manager itself may receive system credentials that can be propagated to services
from a hosting container manager or VM hypervisor. See the <ulink
url="https://systemd.io/CONTAINER_INTERFACE">Container Interface</ulink> documentation for details
pid1: import creds from SMBIOS too, not just qemu's fw_cfg This imports credentials also via SMBIOS' "OEM vendor string" section, similar to the existing import logic from fw_cfg. Functionality-wise this is very similar to the existing fw_cfg logic, both of which are easily settable on the qemu command line. Pros and cons of each: SMBIOS OEM vendor strings: - pro: fast, because memory mapped - pro: somewhat VMM independent, at least in theory - pro: qemu upstream sees this as the future - pro: no additional kernel module needed - con: strings only, thus binary data is base64 encoded fw_cfg: - pro: has been supported for longer in qemu - pro: supports binary data - con: slow, because IO port based - con: only qemu - con: requires qemu_fw_cfg.ko kernel module - con: qemu upstream sees this as legacy
2022-07-14 00:26:44 +08:00
about the former. For the latter, pass <ulink
url="https://www.dmtf.org/standards/smbios">DMI/SMBIOS</ulink> OEM string table entries (field type
11) with a prefix of <literal>io.systemd.credential:</literal> or
<literal>io.systemd.credential.binary:</literal>. In both cases a key/value pair separated by
<literal>=</literal> is expected, in the latter case the right-hand side is Base64 decoded when
import-creds: define a new dir where initrd configurators can pass credentials to host
2023-06-23 23:49:44 +08:00
parsed (thus permitting binary data to be passed in). Example <ulink
url="https://www.qemu.org/docs/master/system/index.html">qemu</ulink> switch: <literal>-smbios
pid1: import creds from SMBIOS too, not just qemu's fw_cfg This imports credentials also via SMBIOS' "OEM vendor string" section, similar to the existing import logic from fw_cfg. Functionality-wise this is very similar to the existing fw_cfg logic, both of which are easily settable on the qemu command line. Pros and cons of each: SMBIOS OEM vendor strings: - pro: fast, because memory mapped - pro: somewhat VMM independent, at least in theory - pro: qemu upstream sees this as the future - pro: no additional kernel module needed - con: strings only, thus binary data is base64 encoded fw_cfg: - pro: has been supported for longer in qemu - pro: supports binary data - con: slow, because IO port based - con: only qemu - con: requires qemu_fw_cfg.ko kernel module - con: qemu upstream sees this as legacy
2022-07-14 00:26:44 +08:00
type=11,value=io.systemd.credential:xx=yy</literal>, or <literal>-smbios
type=11,value=io.systemd.credential.binary:rick=TmV2ZXIgR29ubmEgR2l2ZSBZb3UgVXA=</literal>. Alternatively,
use the <command>qemu</command> <literal>fw_cfg</literal> node
import-creds: define a new dir where initrd configurators can pass credentials to host
2023-06-23 23:49:44 +08:00
<literal>opt/io.systemd.credentials/</literal>. Example <command>qemu</command> switch:
<literal>-fw_cfg name=opt/io.systemd.credentials/mycred,string=supersecret</literal>. They may also
be passed from the UEFI firmware environment via
<citerefentry><refentrytitle>systemd-stub</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
from the initrd (see
<citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>), or be
import-creds: add support for binary credentials specified on the kernel cmdline
2023-07-04 17:46:37 +08:00
specified on the kernel command line using the <literal>systemd.set_credential=</literal> and
<literal>systemd.set_credential_binary=</literal> switches (see
import-creds: define a new dir where initrd configurators can pass credentials to host
2023-06-23 23:49:44 +08:00
<citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry> – this is
not recommended since unprivileged userspace can read the kernel command line). </para>
man: document the new credentials features
2022-04-22 21:41:53 +08:00
fileio: beef up READ_FULL_FILE_CONNECT_SOCKET to allow setting sender socket name This beefs up the READ_FULL_FILE_CONNECT_SOCKET logic of read_full_file_full() a bit: when used a sender socket name may be specified. If specified as NULL behaviour is as before: the client socket name is picked by the kernel. But if specified as non-NULL the client can pick a socket name to use when connecting. This is useful to communicate a minimal amount of metainformation from client to server, outside of the transport payload. Specifically, these beefs up the service credential logic to pass an abstract AF_UNIX socket name as client socket name when connecting via READ_FULL_FILE_CONNECT_SOCKET, that includes the requesting unit name and the eventual credential name. This allows servers implementing the trivial credential socket logic to distinguish clients: via a simple getpeername() it can be determined which unit is requesting a credential, and which credential specifically. Example: with this patch in place, in a unit file "waldo.service" a configuration line like the following: LoadCredential=foo:/run/quux/creds.sock will result in a connection to the AF_UNIX socket /run/quux/creds.sock, originating from an abstract namespace AF_UNIX socket: @$RANDOM/unit/waldo.service/foo (The $RANDOM is replaced by some randomized string. This is included in the socket name order to avoid namespace squatting issues: the abstract socket namespace is open to unprivileged users after all, and care needs to be taken not to use guessable names) The services listening on the /run/quux/creds.sock socket may thus easily retrieve the name of the unit the credential is requested for plus the credential name, via a simpler getpeername(), discarding the random preifx and the /unit/ string. This logic uses "/" as separator between the fields, since both unit names and credential names appear in the file system, and thus are designed to use "/" as outer separators. Given that it's a good safe choice to use as separators here, too avoid any conflicts. This is a minimal patch only: the new logic is used only for the unit file credential logic. For other places where we use READ_FULL_FILE_CONNECT_SOCKET it is probably a good idea to use this scheme too, but this should be done carefully in later patches, since the socket names become API that way, and we should determine the right amount of info to pass over.
2020-11-02 19:07:51 +08:00
<para>If referencing an <constant>AF_UNIX</constant> stream socket to connect to, the connection will
originate from an abstract namespace socket, that includes information about the unit and the
credential ID in its socket name. Use <citerefentry
project='man-pages'><refentrytitle>getpeername</refentrytitle><manvolnum>2</manvolnum></citerefentry>
to query this information. The returned socket name is formatted as <constant>NUL</constant>
<replaceable>RANDOM</replaceable> <literal>/unit/</literal> <replaceable>UNIT</replaceable>
<literal>/</literal> <replaceable>ID</replaceable>, i.e. a <constant>NUL</constant> byte (as required
for abstract namespace socket names), followed by a random string (consisting of alphadecimal
characters), followed by the literal string <literal>/unit/</literal>, followed by the requesting
unit name, followed by the literal character <literal>/</literal>, followed by the textual credential
ID requested. Example: <literal>\0adf9d86b6eda275e/unit/foobar.service/credx</literal> in case the
credential <literal>credx</literal> is requested for a unit <literal>foobar.service</literal>. This
functionality is useful for using a single listening socket to serve credentials to multiple
doc: add new markdown docs for credentials
2022-04-22 21:43:11 +08:00
consumers.</para>
<para>For further information see <ulink url="https://systemd.io/CREDENTIALS">System and Service
man: update version information As I noticed a lot of missing information when trying to implement checking for missing info. I reimplemented the version information script to be more robust, and here is the result. Follow up to ec07c3c80b2b1bfa6788500202006ff85f5ae4f4
2023-09-18 23:03:38 +08:00
Credentials</ulink> documentation.</para>
<xi:include href="version-info.xml" xpointer="v247"/></listitem>
man: document pid1's new credentials logic
2020-07-24 00:05:54 +08:00
</varlistentry>
creds: Add ImportCredential= ImportCredential= takes a credential name and searches for a matching credential in all the credential stores we know about it. It supports globs which are expanded so that all matching credentials are loaded.
2023-01-13 23:22:46 +08:00
<varlistentry>
<term><varname>ImportCredential=</varname><replaceable>GLOB</replaceable></term>
<listitem><para>Pass one or more credentials to the unit. Takes a credential name for which we'll
attempt to find a credential that the service manager itself received under the specified name —
which may be used to propagate credentials from an invoking environment (e.g. a container manager
that invoked the service manager) into a service. If the credential name is a glob, all credentials
matching the glob are passed to the unit. Matching credentials are searched for in the system
credentials, the encrypted system credentials, and under <filename>/etc/credstore/</filename>,
<filename>/run/credstore/</filename>, <filename>/usr/lib/credstore/</filename>,
<filename>/run/credstore.encrypted/</filename>, <filename>/etc/credstore.encrypted/</filename>, and
<filename>/usr/lib/credstore.encrypted/</filename> in that order. When multiple credentials of the
same name are found, the first one found is used.</para>
core: restrict ImportCredential= globbing Let's restrict how we apply credential globbing in ImportCredential=, so that we have some flexibility in automatically extending the glob expression with per-instance data eventually without getting into conflict with the globbing parts. In our current uses we only allow globbing at the end of the expression, and this is a new, unreleased feature hence let's be restrictive on this initially. We can still relax this later if we feel the need to after all. Fixes: #28022
2023-06-21 16:53:24 +08:00
<para>The globbing expression implements a restrictive subset of <citerefentry
project='man-pages'><refentrytitle>glob</refentrytitle><manvolnum>7</manvolnum></citerefentry>: only
a single trailing <literal>*</literal> wildcard may be specified. Both <literal>?</literal> and
<literal>[]</literal> wildcards are not permitted, nor are <literal>*</literal> wildcards anywhere
except at the end of the glob expression.</para>
creds: Add ImportCredential= ImportCredential= takes a credential name and searches for a matching credential in all the credential stores we know about it. It supports globs which are expanded so that all matching credentials are loaded.
2023-01-13 23:22:46 +08:00
<para>When multiple credentials of the same name are found, credentials found by
<varname>LoadCredential=</varname> and <varname>LoadCredentialEncrypted=</varname> take priority over
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-23 00:52:36 +08:00
credentials found by <varname>ImportCredential=</varname>.</para>
<xi:include href="version-info.xml" xpointer="v254"/></listitem>
creds: Add ImportCredential= ImportCredential= takes a credential name and searches for a matching credential in all the credential stores we know about it. It supports globs which are expanded so that all matching credentials are loaded.
2023-01-13 23:22:46 +08:00
</varlistentry>
man: document pid1's new credentials logic
2020-07-24 00:05:54 +08:00
<varlistentry>
<term><varname>SetCredential=</varname><replaceable>ID</replaceable>:<replaceable>VALUE</replaceable></term>
man: document the new (Load|Set)CredentialEncrypted= settings
2021-06-24 00:15:02 +08:00
<term><varname>SetCredentialEncrypted=</varname><replaceable>ID</replaceable>:<replaceable>VALUE</replaceable></term>
man: document pid1's new credentials logic
2020-07-24 00:05:54 +08:00
<listitem><para>The <varname>SetCredential=</varname> setting is similar to
<varname>LoadCredential=</varname> but accepts a literal value to use as data for the credential,
instead of a file system path to read the data from. Do not use this option for data that is supposed
to be secret, as it is accessible to unprivileged processes via IPC. It's only safe to use this for
user IDs, public key material and similar non-sensitive data. For everything else use
<varname>LoadCredential=</varname>. In order to embed binary data into the credential data use
C-style escaping (i.e. <literal>\n</literal> to embed a newline, or <literal>\x00</literal> to embed
man: set constant tag to NUL or NULL
2020-11-12 15:58:00 +08:00
a <constant>NUL</constant> byte).</para>
man: document pid1's new credentials logic
2020-07-24 00:05:54 +08:00
man: document the new (Load|Set)CredentialEncrypted= settings
2021-06-24 00:15:02 +08:00
<para>The <varname>SetCredentialEncrypted=</varname> setting is identical to
<varname>SetCredential=</varname> but expects an encrypted credential in literal form as value. This
allows embedding confidential credentials securely directly in unit files. Use
<citerefentry><refentrytitle>systemd-creds</refentrytitle><manvolnum>1</manvolnum></citerefentry>'
<option>-p</option> switch to generate suitable <varname>SetCredentialEncrypted=</varname> lines
directly from plaintext credentials. For further details see
<varname>LoadCredentialEncrypted=</varname> above.</para>
creds: Add ImportCredential= ImportCredential= takes a credential name and searches for a matching credential in all the credential stores we know about it. It supports globs which are expanded so that all matching credentials are loaded.
2023-01-13 23:22:46 +08:00
<para>When multiple credentials of the same name are found, credentials found by
<varname>LoadCredential=</varname>, <varname>LoadCredentialEncrypted=</varname> and
<varname>ImportCredential=</varname> take priority over credentials found by
<varname>SetCredential=</varname>. As such, <varname>SetCredential=</varname> will act as default if
no credentials are found by any of the former. In this case not being able to retrieve the credential
from the path specified in <varname>LoadCredential=</varname> or
man: update version information As I noticed a lot of missing information when trying to implement checking for missing info. I reimplemented the version information script to be more robust, and here is the result. Follow up to ec07c3c80b2b1bfa6788500202006ff85f5ae4f4
2023-09-18 23:03:38 +08:00
<varname>LoadCredentialEncrypted=</varname> is not considered fatal.</para>
<xi:include href="version-info.xml" xpointer="v247"/></listitem>
man: document pid1's new credentials logic
2020-07-24 00:05:54 +08:00
</varlistentry>
</variablelist>
</refsect1>
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
<refsect1>
<title>System V Compatibility</title>
man: move entries to the right section in systemd.directives They were in "miscellaneuos" because of the missing class= assignment. Probably introduced when the split into sections was done.
2019-02-13 17:17:49 +08:00
<variablelist class='unit-directives'>
man: describe RuntimeDirectoryMode= Fixes #5509.
2017-06-18 03:23:02 +08:00
core: Restrict mmap and mprotect with PAGE_WRITE|PAGE_EXEC (#3319) (#3379) New exec boolean MemoryDenyWriteExecute, when set, installs a seccomp filter to reject mmap(2) with PAGE_WRITE|PAGE_EXEC and mprotect(2) with PAGE_EXEC.
2016-06-03 23:58:18 +08:00
<varlistentry>
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
<term><varname>UtmpIdentifier=</varname></term>
core: Restrict mmap and mprotect with PAGE_WRITE|PAGE_EXEC (#3319) (#3379) New exec boolean MemoryDenyWriteExecute, when set, installs a seccomp filter to reject mmap(2) with PAGE_WRITE|PAGE_EXEC and mprotect(2) with PAGE_EXEC.
2016-06-03 23:58:18 +08:00
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
<listitem><para>Takes a four character identifier string for an <citerefentry
project='man-pages'><refentrytitle>utmp</refentrytitle><manvolnum>5</manvolnum></citerefentry> and wtmp entry
for this service. This should only be set for services such as <command>getty</command> implementations (such
as <citerefentry
project='die-net'><refentrytitle>agetty</refentrytitle><manvolnum>8</manvolnum></citerefentry>) where utmp/wtmp
entries must be created and cleared before and after execution, or for services that shall be executed as if
they were run by a <command>getty</command> process (see below). If the configured string is longer than four
characters, it is truncated and the terminal four characters are used. This setting interprets %I style string
replacements. This setting is unset by default, i.e. no utmp/wtmp entries are created or cleaned up for this
service.</para></listitem>
core: Restrict mmap and mprotect with PAGE_WRITE|PAGE_EXEC (#3319) (#3379) New exec boolean MemoryDenyWriteExecute, when set, installs a seccomp filter to reject mmap(2) with PAGE_WRITE|PAGE_EXEC and mprotect(2) with PAGE_EXEC.
2016-06-03 23:58:18 +08:00
</varlistentry>
execute: add a new easy-to-use RestrictRealtime= option to units It takes a boolean value. If true, access to SCHED_RR, SCHED_FIFO and SCHED_DEADLINE is blocked, which my be used to lock up the system.
2016-06-23 07:45:45 +08:00
<varlistentry>
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
<term><varname>UtmpMode=</varname></term>
execute: add a new easy-to-use RestrictRealtime= option to units It takes a boolean value. If true, access to SCHED_RR, SCHED_FIFO and SCHED_DEADLINE is blocked, which my be used to lock up the system.
2016-06-23 07:45:45 +08:00
man: reorder/add sections to systemd.exec(5) (#7412) The long long list of settings is getting too confusing, let's add some sections and reorder things in them. This makes no changes regarding contents, it only reorders things, sometimes reindents them, and adds sections that made sense to me to some degree. Within each sections the settings are ordered by relevance (at least according to how relevant I personally find them), and not alphabetically.
2017-11-24 04:20:48 +08:00
<listitem><para>Takes one of <literal>init</literal>, <literal>login</literal> or <literal>user</literal>. If
<varname>UtmpIdentifier=</varname> is set, controls which type of <citerefentry
project='man-pages'><refentrytitle>utmp</refentrytitle><manvolnum>5</manvolnum></citerefentry>/wtmp entries
for this service are generated. This setting has no effect unless <varname>UtmpIdentifier=</varname> is set
too. If <literal>init</literal> is set, only an <constant>INIT_PROCESS</constant> entry is generated and the
invoked process must implement a <command>getty</command>-compatible utmp/wtmp logic. If
<literal>login</literal> is set, first an <constant>INIT_PROCESS</constant> entry, followed by a
<constant>LOGIN_PROCESS</constant> entry is generated. In this case, the invoked process must implement a
<citerefentry
project='die-net'><refentrytitle>login</refentrytitle><manvolnum>1</manvolnum></citerefentry>-compatible
utmp/wtmp logic. If <literal>user</literal> is set, first an <constant>INIT_PROCESS</constant> entry, then a
<constant>LOGIN_PROCESS</constant> entry and finally a <constant>USER_PROCESS</constant> entry is
generated. In this case, the invoked process may be any process that is suitable to be run as session
man: update version information As I noticed a lot of missing information when trying to implement checking for missing info. I reimplemented the version information script to be more robust, and here is the result. Follow up to ec07c3c80b2b1bfa6788500202006ff85f5ae4f4
2023-09-18 23:03:38 +08:00
leader. Defaults to <literal>init</literal>.</para>
<xi:include href="version-info.xml" xpointer="v225"/></listitem>
execute: add a new easy-to-use RestrictRealtime= option to units It takes a boolean value. If true, access to SCHED_RR, SCHED_FIFO and SCHED_DEADLINE is blocked, which my be used to lock up the system.
2016-06-23 07:45:45 +08:00
</varlistentry>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
</variablelist>
</refsect1>
<refsect1>
man: improve description of environment block creation This adds a general description of "philosphy" of keeping the environemnt block small and hints about systemd-run -P env. The list of generated variables is split out to a subsection. Viewing the patch with ignoring whitespace changes is recommended. We don't ignore invalid assignments (except in import-environment to some extent), previous description was wrong. For https://bugzilla.redhat.com/show_bug.cgi?id=1912046#c17.
2021-01-05 18:17:14 +08:00
<title>Environment Variables in Spawned Processes</title>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
core: add new UnsetEnvironment= setting for unit files With this setting we can explicitly unset specific variables for processes of a unit, as last step of assembling the environment block for them. This is useful to fix #6407. While we are at it, greatly expand the documentation on how the environment block for forked off processes is assembled.
2017-09-10 18:16:44 +08:00
<para>Processes started by the service manager are executed with an environment variable block assembled from
multiple sources. Processes started by the system service manager generally do not inherit environment variables
set for the service manager itself (but this may be altered via <varname>PassEnvironment=</varname>), but processes
started by the user service manager instances generally do inherit all environment variables set for the service
manager itself.</para>
<para>For each invoked process the list of environment variables set is compiled from the following sources:</para>
<itemizedlist>
<listitem><para>Variables globally configured for the service manager, using the
<varname>DefaultEnvironment=</varname> setting in
man: improve description of environment block creation This adds a general description of "philosphy" of keeping the environemnt block small and hints about systemd-run -P env. The list of generated variables is split out to a subsection. Viewing the patch with ignoring whitespace changes is recommended. We don't ignore invalid assignments (except in import-environment to some extent), previous description was wrong. For https://bugzilla.redhat.com/show_bug.cgi?id=1912046#c17.
2021-01-05 18:17:14 +08:00
<citerefentry><refentrytitle>systemd-system.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
the kernel command line option <varname>systemd.setenv=</varname> understood by
<citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, or via
<citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>
<command>set-environment</command> verb.</para></listitem>
core: add new UnsetEnvironment= setting for unit files With this setting we can explicitly unset specific variables for processes of a unit, as last step of assembling the environment block for them. This is useful to fix #6407. While we are at it, greatly expand the documentation on how the environment block for forked off processes is assembled.
2017-09-10 18:16:44 +08:00
man: improve description of environment block creation This adds a general description of "philosphy" of keeping the environemnt block small and hints about systemd-run -P env. The list of generated variables is split out to a subsection. Viewing the patch with ignoring whitespace changes is recommended. We don't ignore invalid assignments (except in import-environment to some extent), previous description was wrong. For https://bugzilla.redhat.com/show_bug.cgi?id=1912046#c17.
2021-01-05 18:17:14 +08:00
<listitem><para>Variables defined by the service manager itself (see the list below).</para></listitem>
core: add new UnsetEnvironment= setting for unit files With this setting we can explicitly unset specific variables for processes of a unit, as last step of assembling the environment block for them. This is useful to fix #6407. While we are at it, greatly expand the documentation on how the environment block for forked off processes is assembled.
2017-09-10 18:16:44 +08:00
man: improve description of environment block creation This adds a general description of "philosphy" of keeping the environemnt block small and hints about systemd-run -P env. The list of generated variables is split out to a subsection. Viewing the patch with ignoring whitespace changes is recommended. We don't ignore invalid assignments (except in import-environment to some extent), previous description was wrong. For https://bugzilla.redhat.com/show_bug.cgi?id=1912046#c17.
2021-01-05 18:17:14 +08:00
<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>
core: add new UnsetEnvironment= setting for unit files With this setting we can explicitly unset specific variables for processes of a unit, as last step of assembling the environment block for them. This is useful to fix #6407. While we are at it, greatly expand the documentation on how the environment block for forked off processes is assembled.
2017-09-10 18:16:44 +08:00
man: improve description of environment block creation This adds a general description of "philosphy" of keeping the environemnt block small and hints about systemd-run -P env. The list of generated variables is split out to a subsection. Viewing the patch with ignoring whitespace changes is recommended. We don't ignore invalid assignments (except in import-environment to some extent), previous description was wrong. For https://bugzilla.redhat.com/show_bug.cgi?id=1912046#c17.
2021-01-05 18:17:14 +08:00
<listitem><para>Variables set via <varname>Environment=</varname> in the unit file.</para></listitem>
core: add new UnsetEnvironment= setting for unit files With this setting we can explicitly unset specific variables for processes of a unit, as last step of assembling the environment block for them. This is useful to fix #6407. While we are at it, greatly expand the documentation on how the environment block for forked off processes is assembled.
2017-09-10 18:16:44 +08:00
man: improve description of environment block creation This adds a general description of "philosphy" of keeping the environemnt block small and hints about systemd-run -P env. The list of generated variables is split out to a subsection. Viewing the patch with ignoring whitespace changes is recommended. We don't ignore invalid assignments (except in import-environment to some extent), previous description was wrong. For https://bugzilla.redhat.com/show_bug.cgi?id=1912046#c17.
2021-01-05 18:17:14 +08:00
<listitem><para>Variables read from files specified via <varname>EnvironmentFile=</varname> in the unit
file.</para></listitem>
core: add new UnsetEnvironment= setting for unit files With this setting we can explicitly unset specific variables for processes of a unit, as last step of assembling the environment block for them. This is useful to fix #6407. While we are at it, greatly expand the documentation on how the environment block for forked off processes is assembled.
2017-09-10 18:16:44 +08:00
man: don't claim we'd set XDG_SEAT and XDG_VTNR as part of service management Previously, reading through systemd.exec(5) one might get the idea that XDG_SEAT and XDG_VTNR are part of the service management logic, but they are not, they are only set if pam_systemd is part of a PAM stack an pam_systemd is used. Hence, let's drop these env vars from the list of env vars, and instead add a paragraph after the list mentioning that pam_systemd might add more systemd-specific env vars if included in the PAM stack for a service that uses PAMName=.
2018-04-24 17:51:21 +08:00
<listitem><para>Variables set by any PAM modules in case <varname>PAMName=</varname> is in effect,
cf. <citerefentry
man: improve description of environment block creation This adds a general description of "philosphy" of keeping the environemnt block small and hints about systemd-run -P env. The list of generated variables is split out to a subsection. Viewing the patch with ignoring whitespace changes is recommended. We don't ignore invalid assignments (except in import-environment to some extent), previous description was wrong. For https://bugzilla.redhat.com/show_bug.cgi?id=1912046#c17.
2021-01-05 18:17:14 +08:00
project='man-pages'><refentrytitle>pam_env</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
</para></listitem>
core: add new UnsetEnvironment= setting for unit files With this setting we can explicitly unset specific variables for processes of a unit, as last step of assembling the environment block for them. This is useful to fix #6407. While we are at it, greatly expand the documentation on how the environment block for forked off processes is assembled.
2017-09-10 18:16:44 +08:00
</itemizedlist>
man: improve description of environment block creation This adds a general description of "philosphy" of keeping the environemnt block small and hints about systemd-run -P env. The list of generated variables is split out to a subsection. Viewing the patch with ignoring whitespace changes is recommended. We don't ignore invalid assignments (except in import-environment to some extent), previous description was wrong. For https://bugzilla.redhat.com/show_bug.cgi?id=1912046#c17.
2021-01-05 18:17:14 +08:00
<para>If the same environment variable is set by multiple of these sources, the later source — according
to the order of the list above — wins. Note that as the final step all variables listed in
<varname>UnsetEnvironment=</varname> are removed from the compiled environment variable list, immediately
core: add new UnsetEnvironment= setting for unit files With this setting we can explicitly unset specific variables for processes of a unit, as last step of assembling the environment block for them. This is useful to fix #6407. While we are at it, greatly expand the documentation on how the environment block for forked off processes is assembled.
2017-09-10 18:16:44 +08:00
before it is passed to the executed process.</para>
man: improve description of environment block creation This adds a general description of "philosphy" of keeping the environemnt block small and hints about systemd-run -P env. The list of generated variables is split out to a subsection. Viewing the patch with ignoring whitespace changes is recommended. We don't ignore invalid assignments (except in import-environment to some extent), previous description was wrong. For https://bugzilla.redhat.com/show_bug.cgi?id=1912046#c17.
2021-01-05 18:17:14 +08:00
<para>The general philosophy is to expose a small curated list of environment variables to processes.
Services started by the system manager (PID 1) will be started, without additional service-specific
configuration, with just a few environment variables. The user manager inherits environment variables as
any other system service, but in addition may receive additional environment variables from PAM, and,
typically, additional imported variables when the user starts a graphical session. It is recommended to
man: remove unintentionally repetitive words
2021-11-11 17:01:19 +08:00
keep the environment blocks in both the system and user managers lean. Importing all variables
systemctl: deprecate blanket import-environment Importing the full environment is convenient, but it doesn't work too well in practice, because we get a metric ton of shell-specific crap that should never end up in the global environment block: $ systemctl --user show-environment ... SHELL=/bin/zsh AUTOJUMP_ERROR_PATH=/home/zbyszek/.local/share/autojump/errors.log AUTOJUMP_SOURCED=1 CONDA_SHLVL=0 CVS_RSH=ssh DBUS_SESSION_BUS_ADDRESS=unix:path=/run/user/1000/bus DESKTOP_SESSION=gnome DISPLAY=:0 FPATH=/usr/share/Modules/init/zsh-functions:/usr/local/share/zsh/site-functions:/usr/share/zsh/site-functions:/usr/share/zsh/5.8/functions GDMSESSION=gnome GDM_LANG=en_US.UTF-8 GNOME_SETUP_DISPLAY=:1 GUESTFISH_INIT=$'\\e[1;34m' GUESTFISH_OUTPUT=$'\\e[0m' GUESTFISH_PS1=$'\\[\\e[1;32m\\]><fs>\\[\\e[0;31m\\] ' GUESTFISH_RESTORE=$'\\e[0m' HISTCONTROL=ignoredups HISTSIZE=1000 LOADEDMODULES= OLDPWD=/home/zbyszek PWD=/home/zbyszek QTDIR=/usr/lib64/qt-3.3 QTINC=/usr/lib64/qt-3.3/include QTLIB=/usr/lib64/qt-3.3/lib QT_IM_MODULE=ibus SDL_VIDEO_MINIMIZE_ON_FOCUS_LOSS=0 SESSION_MANAGER=local/unix:@/tmp/.ICE-unix/2612,unix/unix:/tmp/.ICE-unix/2612 SHLVL=0 STEAM_FRAME_FORCE_CLOSE=1 TERM=xterm-256color USERNAME=zbyszek WISECONFIGDIR=/usr/share/wise2/ ... Plenty of shell-specific and terminal-specific stuff that have no global significance. Let's start warning when this is used to push people towards importing only specific variables. Putative NEWS entry: * systemctl import-environment will now emit a warning when called without any arguments (i.e. to import the full environment block of the called program). This command will usually be invoked from a shell, which means that it'll inherit a bunch of variables which are specific to that shell, and usually to the tty the shell is connected to, and don't have any meaning in the global context of the system or user service manager. Instead, only specific variables should be imported into the manager environment block. Similarly, programs which update the manager environment block by directly calling the D-Bus API of the manager, should also push specific variables, and not the full inherited environment.
2021-01-05 18:24:03 +08:00
inherited by the graphical session or by one of the user shells is strongly discouraged.</para>
man: improve description of environment block creation This adds a general description of "philosphy" of keeping the environemnt block small and hints about systemd-run -P env. The list of generated variables is split out to a subsection. Viewing the patch with ignoring whitespace changes is recommended. We don't ignore invalid assignments (except in import-environment to some extent), previous description was wrong. For https://bugzilla.redhat.com/show_bug.cgi?id=1912046#c17.
2021-01-05 18:17:14 +08:00
<para>Hint: <command>systemd-run -P env</command> and <command>systemd-run --user -P env</command> print
the effective system and user service environment blocks.</para>
<refsect2>
<title>Environment Variables Set or Propagated by the Service Manager</title>
<para>The following environment variables are propagated by the service manager or generated internally
for each invoked process:</para>
<variablelist class='environment-variables'>
<varlistentry>
<term><varname>$PATH</varname></term>
<listitem><para>Colon-separated list of directories to use when launching
executables. <command>systemd</command> uses a fixed value of
<literal><filename>/usr/local/sbin</filename>:<filename>/usr/local/bin</filename>:<filename>/usr/sbin</filename>:<filename>/usr/bin</filename></literal>
Drop split-usr and unmerged-usr support As previously announced, execute order 66: https://lists.freedesktop.org/archives/systemd-devel/2022-September/048352.html The meson options split-usr, rootlibdir and rootprefix become no-ops that print a warning if they are set to anything other than the default values. We can remove them in a future release.
2023-06-12 09:15:19 +08:00
in the system manager. In case of the user manager, a different path may be configured by the
distribution. It is recommended to not rely on the order of entries, and have only one program
man: update version information As I noticed a lot of missing information when trying to implement checking for missing info. I reimplemented the version information script to be more robust, and here is the result. Follow up to ec07c3c80b2b1bfa6788500202006ff85f5ae4f4
2023-09-18 23:03:38 +08:00
with a given name in <varname>$PATH</varname>.</para>
<xi:include href="version-info.xml" xpointer="v208"/></listitem>
man: improve description of environment block creation This adds a general description of "philosphy" of keeping the environemnt block small and hints about systemd-run -P env. The list of generated variables is split out to a subsection. Viewing the patch with ignoring whitespace changes is recommended. We don't ignore invalid assignments (except in import-environment to some extent), previous description was wrong. For https://bugzilla.redhat.com/show_bug.cgi?id=1912046#c17.
2021-01-05 18:17:14 +08:00
</varlistentry>
<varlistentry>
<term><varname>$LANG</varname></term>
<listitem><para>Locale. Can be set in <citerefentry
project='man-pages'><refentrytitle>locale.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>
or on the kernel command line (see
<citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry> and
<citerefentry><refentrytitle>kernel-command-line</refentrytitle><manvolnum>7</manvolnum></citerefentry>).
man: update version information As I noticed a lot of missing information when trying to implement checking for missing info. I reimplemented the version information script to be more robust, and here is the result. Follow up to ec07c3c80b2b1bfa6788500202006ff85f5ae4f4
2023-09-18 23:03:38 +08:00
</para>
<xi:include href="version-info.xml" xpointer="v208"/></listitem>
man: improve description of environment block creation This adds a general description of "philosphy" of keeping the environemnt block small and hints about systemd-run -P env. The list of generated variables is split out to a subsection. Viewing the patch with ignoring whitespace changes is recommended. We don't ignore invalid assignments (except in import-environment to some extent), previous description was wrong. For https://bugzilla.redhat.com/show_bug.cgi?id=1912046#c17.
2021-01-05 18:17:14 +08:00
</varlistentry>
<varlistentry>
<term><varname>$USER</varname></term>
<term><varname>$LOGNAME</varname></term>
<term><varname>$HOME</varname></term>
<term><varname>$SHELL</varname></term>
core/execute: always set $USER and introduce SetLoginEnvironment= Before this commit, $USER, $HOME, $LOGNAME and $SHELL are only set when User= is set for the unit. For system service, this results in different behaviors depending on whether User=root is set. $USER always makes sense on its own, so let's set it unconditionally. Ideally $HOME should be set too, but it causes trouble when e.g. getty passes '-p' to login(1), which then doesn't override $HOME. $LOGNAME and $SHELL are more like "login environments", and are generally not suitable for system services. Therefore, a new option SetLoginEnvironment= is also added to control the latter three variables. Fixes #23438 Replaces #8227
2023-10-07 20:08:21 +08:00
<listitem><para>User name (twice), home directory, and the login shell. <varname>$USER</varname> is
set unconditionally, while <varname>$HOME</varname>, <varname>$LOGNAME</varname>, and <varname>$SHELL</varname>
are only set for the units that have <varname>User=</varname> set and <varname>SetLoginEnvironment=</varname>
unset or set to true. For user services, these variables are typically inherited from the user manager itself. See
man: improve description of environment block creation This adds a general description of "philosphy" of keeping the environemnt block small and hints about systemd-run -P env. The list of generated variables is split out to a subsection. Viewing the patch with ignoring whitespace changes is recommended. We don't ignore invalid assignments (except in import-environment to some extent), previous description was wrong. For https://bugzilla.redhat.com/show_bug.cgi?id=1912046#c17.
2021-01-05 18:17:14 +08:00
<citerefentry project='die-net'><refentrytitle>passwd</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
man: update version information As I noticed a lot of missing information when trying to implement checking for missing info. I reimplemented the version information script to be more robust, and here is the result. Follow up to ec07c3c80b2b1bfa6788500202006ff85f5ae4f4
2023-09-18 23:03:38 +08:00
</para>
<xi:include href="version-info.xml" xpointer="v208"/></listitem>
man: improve description of environment block creation This adds a general description of "philosphy" of keeping the environemnt block small and hints about systemd-run -P env. The list of generated variables is split out to a subsection. Viewing the patch with ignoring whitespace changes is recommended. We don't ignore invalid assignments (except in import-environment to some extent), previous description was wrong. For https://bugzilla.redhat.com/show_bug.cgi?id=1912046#c17.
2021-01-05 18:17:14 +08:00
</varlistentry>
<varlistentry>
<term><varname>$INVOCATION_ID</varname></term>
tree-wide: "<n>bit" → "<n>-bit" In some places, "<n> bits" is used when more appropriate.
2023-07-02 05:33:20 +08:00
<listitem><para>Contains a randomized, unique 128-bit ID identifying each runtime cycle of the unit, formatted
man: improve description of environment block creation This adds a general description of "philosphy" of keeping the environemnt block small and hints about systemd-run -P env. The list of generated variables is split out to a subsection. Viewing the patch with ignoring whitespace changes is recommended. We don't ignore invalid assignments (except in import-environment to some extent), previous description was wrong. For https://bugzilla.redhat.com/show_bug.cgi?id=1912046#c17.
2021-01-05 18:17:14 +08:00
as 32 character hexadecimal string. A new ID is assigned each time the unit changes from an inactive state into
an activating or active state, and may be used to identify this specific runtime cycle, in particular in data
stored offline, such as the journal. The same ID is passed to all processes run as part of the
man: update version information As I noticed a lot of missing information when trying to implement checking for missing info. I reimplemented the version information script to be more robust, and here is the result. Follow up to ec07c3c80b2b1bfa6788500202006ff85f5ae4f4
2023-09-18 23:03:38 +08:00
unit.</para>
<xi:include href="version-info.xml" xpointer="v232"/></listitem>
man: improve description of environment block creation This adds a general description of "philosphy" of keeping the environemnt block small and hints about systemd-run -P env. The list of generated variables is split out to a subsection. Viewing the patch with ignoring whitespace changes is recommended. We don't ignore invalid assignments (except in import-environment to some extent), previous description was wrong. For https://bugzilla.redhat.com/show_bug.cgi?id=1912046#c17.
2021-01-05 18:17:14 +08:00
</varlistentry>
<varlistentry>
<term><varname>$XDG_RUNTIME_DIR</varname></term>
<listitem><para>The directory to use for runtime objects (such as IPC objects) and volatile state. Set for all
services run by the user <command>systemd</command> instance, as well as any system services that use
<varname>PAMName=</varname> with a PAM stack that includes <command>pam_systemd</command>. See below and
<citerefentry><refentrytitle>pam_systemd</refentrytitle><manvolnum>8</manvolnum></citerefentry> for more
man: update version information As I noticed a lot of missing information when trying to implement checking for missing info. I reimplemented the version information script to be more robust, and here is the result. Follow up to ec07c3c80b2b1bfa6788500202006ff85f5ae4f4
2023-09-18 23:03:38 +08:00
information.</para>
<xi:include href="version-info.xml" xpointer="v208"/></listitem>
man: improve description of environment block creation This adds a general description of "philosphy" of keeping the environemnt block small and hints about systemd-run -P env. The list of generated variables is split out to a subsection. Viewing the patch with ignoring whitespace changes is recommended. We don't ignore invalid assignments (except in import-environment to some extent), previous description was wrong. For https://bugzilla.redhat.com/show_bug.cgi?id=1912046#c17.
2021-01-05 18:17:14 +08:00
</varlistentry>
<varlistentry>
<term><varname>$RUNTIME_DIRECTORY</varname></term>
<term><varname>$STATE_DIRECTORY</varname></term>
<term><varname>$CACHE_DIRECTORY</varname></term>
<term><varname>$LOGS_DIRECTORY</varname></term>
<term><varname>$CONFIGURATION_DIRECTORY</varname></term>
<listitem><para>Absolute paths to the directories defined with
<varname>RuntimeDirectory=</varname>, <varname>StateDirectory=</varname>,
<varname>CacheDirectory=</varname>, <varname>LogsDirectory=</varname>, and
<varname>ConfigurationDirectory=</varname> when those settings are used.</para>
man: update version information As I noticed a lot of missing information when trying to implement checking for missing info. I reimplemented the version information script to be more robust, and here is the result. Follow up to ec07c3c80b2b1bfa6788500202006ff85f5ae4f4
2023-09-18 23:03:38 +08:00
<xi:include href="version-info.xml" xpointer="v244"/>
man: improve description of environment block creation This adds a general description of "philosphy" of keeping the environemnt block small and hints about systemd-run -P env. The list of generated variables is split out to a subsection. Viewing the patch with ignoring whitespace changes is recommended. We don't ignore invalid assignments (except in import-environment to some extent), previous description was wrong. For https://bugzilla.redhat.com/show_bug.cgi?id=1912046#c17.
2021-01-05 18:17:14 +08:00
</listitem>
</varlistentry>
<varlistentry>
<term><varname>$CREDENTIALS_DIRECTORY</varname></term>
<listitem><para>An absolute path to the per-unit directory with credentials configured via
creds: Add ImportCredential= ImportCredential= takes a credential name and searches for a matching credential in all the credential stores we know about it. It supports globs which are expanded so that all matching credentials are loaded.
2023-01-13 23:22:46 +08:00
<varname>ImportCredential=</varname>/<varname>LoadCredential=</varname>/<varname>SetCredential=</varname>.
The directory is marked read-only and is placed in unswappable memory (if supported and permitted),
and is only accessible to the UID associated with the unit via <varname>User=</varname> or
man: update version information As I noticed a lot of missing information when trying to implement checking for missing info. I reimplemented the version information script to be more robust, and here is the result. Follow up to ec07c3c80b2b1bfa6788500202006ff85f5ae4f4
2023-09-18 23:03:38 +08:00
<varname>DynamicUser=</varname> (and the superuser).</para>
<xi:include href="version-info.xml" xpointer="v247"/></listitem>
man: improve description of environment block creation This adds a general description of "philosphy" of keeping the environemnt block small and hints about systemd-run -P env. The list of generated variables is split out to a subsection. Viewing the patch with ignoring whitespace changes is recommended. We don't ignore invalid assignments (except in import-environment to some extent), previous description was wrong. For https://bugzilla.redhat.com/show_bug.cgi?id=1912046#c17.
2021-01-05 18:17:14 +08:00
</varlistentry>
<varlistentry>
<term><varname>$MAINPID</varname></term>
<listitem><para>The PID of the unit's main process if it is
known. This is only set for control processes as invoked by
man: update version information As I noticed a lot of missing information when trying to implement checking for missing info. I reimplemented the version information script to be more robust, and here is the result. Follow up to ec07c3c80b2b1bfa6788500202006ff85f5ae4f4
2023-09-18 23:03:38 +08:00
<varname>ExecReload=</varname> and similar.</para>
<xi:include href="version-info.xml" xpointer="v209"/></listitem>
man: improve description of environment block creation This adds a general description of "philosphy" of keeping the environemnt block small and hints about systemd-run -P env. The list of generated variables is split out to a subsection. Viewing the patch with ignoring whitespace changes is recommended. We don't ignore invalid assignments (except in import-environment to some extent), previous description was wrong. For https://bugzilla.redhat.com/show_bug.cgi?id=1912046#c17.
2021-01-05 18:17:14 +08:00
</varlistentry>
<varlistentry>
<term><varname>$MANAGERPID</varname></term>
<listitem><para>The PID of the user <command>systemd</command>
man: update version information As I noticed a lot of missing information when trying to implement checking for missing info. I reimplemented the version information script to be more robust, and here is the result. Follow up to ec07c3c80b2b1bfa6788500202006ff85f5ae4f4
2023-09-18 23:03:38 +08:00
instance, set for processes spawned by it.</para>
<xi:include href="version-info.xml" xpointer="v208"/></listitem>
man: improve description of environment block creation This adds a general description of "philosphy" of keeping the environemnt block small and hints about systemd-run -P env. The list of generated variables is split out to a subsection. Viewing the patch with ignoring whitespace changes is recommended. We don't ignore invalid assignments (except in import-environment to some extent), previous description was wrong. For https://bugzilla.redhat.com/show_bug.cgi?id=1912046#c17.
2021-01-05 18:17:14 +08:00
</varlistentry>
<varlistentry>
<term><varname>$LISTEN_FDS</varname></term>
<term><varname>$LISTEN_PID</varname></term>
<term><varname>$LISTEN_FDNAMES</varname></term>
<listitem><para>Information about file descriptors passed to a
service for socket activation. See
<citerefentry><refentrytitle>sd_listen_fds</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
man: update version information As I noticed a lot of missing information when trying to implement checking for missing info. I reimplemented the version information script to be more robust, and here is the result. Follow up to ec07c3c80b2b1bfa6788500202006ff85f5ae4f4
2023-09-18 23:03:38 +08:00
</para>
<xi:include href="version-info.xml" xpointer="v208"/></listitem>
man: improve description of environment block creation This adds a general description of "philosphy" of keeping the environemnt block small and hints about systemd-run -P env. The list of generated variables is split out to a subsection. Viewing the patch with ignoring whitespace changes is recommended. We don't ignore invalid assignments (except in import-environment to some extent), previous description was wrong. For https://bugzilla.redhat.com/show_bug.cgi?id=1912046#c17.
2021-01-05 18:17:14 +08:00
</varlistentry>
<varlistentry>
<term><varname>$NOTIFY_SOCKET</varname></term>
service: tell service processes that the fdstore is available via an env var
2023-04-05 21:48:31 +08:00
<listitem><para>The socket <function>sd_notify()</function> talks to. See
man: improve description of environment block creation This adds a general description of "philosphy" of keeping the environemnt block small and hints about systemd-run -P env. The list of generated variables is split out to a subsection. Viewing the patch with ignoring whitespace changes is recommended. We don't ignore invalid assignments (except in import-environment to some extent), previous description was wrong. For https://bugzilla.redhat.com/show_bug.cgi?id=1912046#c17.
2021-01-05 18:17:14 +08:00
<citerefentry><refentrytitle>sd_notify</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
man: update version information As I noticed a lot of missing information when trying to implement checking for missing info. I reimplemented the version information script to be more robust, and here is the result. Follow up to ec07c3c80b2b1bfa6788500202006ff85f5ae4f4
2023-09-18 23:03:38 +08:00
</para>
<xi:include href="version-info.xml" xpointer="v229"/></listitem>
man: improve description of environment block creation This adds a general description of "philosphy" of keeping the environemnt block small and hints about systemd-run -P env. The list of generated variables is split out to a subsection. Viewing the patch with ignoring whitespace changes is recommended. We don't ignore invalid assignments (except in import-environment to some extent), previous description was wrong. For https://bugzilla.redhat.com/show_bug.cgi?id=1912046#c17.
2021-01-05 18:17:14 +08:00
</varlistentry>
<varlistentry>
<term><varname>$WATCHDOG_PID</varname></term>
<term><varname>$WATCHDOG_USEC</varname></term>
<listitem><para>Information about watchdog keep-alive notifications. See
<citerefentry><refentrytitle>sd_watchdog_enabled</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
man: update version information As I noticed a lot of missing information when trying to implement checking for missing info. I reimplemented the version information script to be more robust, and here is the result. Follow up to ec07c3c80b2b1bfa6788500202006ff85f5ae4f4
2023-09-18 23:03:38 +08:00
</para>
<xi:include href="version-info.xml" xpointer="v229"/></listitem>
man: improve description of environment block creation This adds a general description of "philosphy" of keeping the environemnt block small and hints about systemd-run -P env. The list of generated variables is split out to a subsection. Viewing the patch with ignoring whitespace changes is recommended. We don't ignore invalid assignments (except in import-environment to some extent), previous description was wrong. For https://bugzilla.redhat.com/show_bug.cgi?id=1912046#c17.
2021-01-05 18:17:14 +08:00
</varlistentry>
core: set $SYSTEMD_EXEC_PID= environment variable for executed commands It may be useful to detect a command is directly executed by systemd manager, or indirectly as a child of another process.
2021-01-26 14:56:42 +08:00
<varlistentry>
<term><varname>$SYSTEMD_EXEC_PID</varname></term>
<listitem><para>The PID of the unit process (e.g. process invoked by
<varname>ExecStart=</varname>). The child process can use this information to determine
whether the process is directly invoked by the service manager or indirectly as a child of
man: similar → similarly Something *is* similar Something *works* similarly Something does something, similarly to how something else does something See https://sites.ulethbridge.ca/roussel/2017/11/29/similar-and-similarly-are-they-similar/ for a clear explanation.
2022-08-23 18:12:28 +08:00
another process by comparing this value with the current PID (similarly to the scheme used in
core: set $SYSTEMD_EXEC_PID= environment variable for executed commands It may be useful to detect a command is directly executed by systemd manager, or indirectly as a child of another process.
2021-01-26 14:56:42 +08:00
<citerefentry><refentrytitle>sd_listen_fds</refentrytitle><manvolnum>3</manvolnum></citerefentry>
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-23 00:52:36 +08:00
with <varname>$LISTEN_PID</varname> and <varname>$LISTEN_FDS</varname>).</para>
<xi:include href="version-info.xml" xpointer="v248"/></listitem>
core: set $SYSTEMD_EXEC_PID= environment variable for executed commands It may be useful to detect a command is directly executed by systemd manager, or indirectly as a child of another process.
2021-01-26 14:56:42 +08:00
</varlistentry>
man: improve description of environment block creation This adds a general description of "philosphy" of keeping the environemnt block small and hints about systemd-run -P env. The list of generated variables is split out to a subsection. Viewing the patch with ignoring whitespace changes is recommended. We don't ignore invalid assignments (except in import-environment to some extent), previous description was wrong. For https://bugzilla.redhat.com/show_bug.cgi?id=1912046#c17.
2021-01-05 18:17:14 +08:00
<varlistentry>
<term><varname>$TERM</varname></term>
<listitem><para>Terminal type, set only for units connected to
a terminal (<varname>StandardInput=tty</varname>,
<varname>StandardOutput=tty</varname>, or
<varname>StandardError=tty</varname>). See
<citerefentry project='man-pages'><refentrytitle>termcap</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
man: update version information As I noticed a lot of missing information when trying to implement checking for missing info. I reimplemented the version information script to be more robust, and here is the result. Follow up to ec07c3c80b2b1bfa6788500202006ff85f5ae4f4
2023-09-18 23:03:38 +08:00
</para>
<xi:include href="version-info.xml" xpointer="v209"/></listitem>
man: improve description of environment block creation This adds a general description of "philosphy" of keeping the environemnt block small and hints about systemd-run -P env. The list of generated variables is split out to a subsection. Viewing the patch with ignoring whitespace changes is recommended. We don't ignore invalid assignments (except in import-environment to some extent), previous description was wrong. For https://bugzilla.redhat.com/show_bug.cgi?id=1912046#c17.
2021-01-05 18:17:14 +08:00
</varlistentry>
<varlistentry>
<term><varname>$LOG_NAMESPACE</varname></term>
<listitem><para>Contains the name of the selected logging namespace when the
man: update version information As I noticed a lot of missing information when trying to implement checking for missing info. I reimplemented the version information script to be more robust, and here is the result. Follow up to ec07c3c80b2b1bfa6788500202006ff85f5ae4f4
2023-09-18 23:03:38 +08:00
<varname>LogNamespace=</varname> service setting is used.</para>
<xi:include href="version-info.xml" xpointer="v246"/></listitem>
man: improve description of environment block creation This adds a general description of "philosphy" of keeping the environemnt block small and hints about systemd-run -P env. The list of generated variables is split out to a subsection. Viewing the patch with ignoring whitespace changes is recommended. We don't ignore invalid assignments (except in import-environment to some extent), previous description was wrong. For https://bugzilla.redhat.com/show_bug.cgi?id=1912046#c17.
2021-01-05 18:17:14 +08:00
</varlistentry>
<varlistentry>
<term><varname>$JOURNAL_STREAM</varname></term>
<listitem><para>If the standard output or standard error output of the executed processes are connected to the
journal (for example, by setting <varname>StandardError=journal</varname>) <varname>$JOURNAL_STREAM</varname>
contains the device and inode numbers of the connection file descriptor, formatted in decimal, separated by a
colon (<literal>:</literal>). This permits invoked processes to safely detect whether their standard output or
standard error output are connected to the journal. The device and inode numbers of the file descriptors should
be compared with the values set in the environment variable to determine whether the process output is still
connected to the journal. Note that it is generally not sufficient to only check whether
<varname>$JOURNAL_STREAM</varname> is set at all as services might invoke external processes replacing their
standard output or standard error output, without unsetting the environment variable.</para>
<para>If both standard output and standard error of the executed processes are connected to the journal via a
stream socket, this environment variable will contain information about the standard error stream, as that's
usually the preferred destination for log data. (Note that typically the same stream is used for both standard
output and standard error, hence very likely the environment variable contains device and inode information
matching both stream file descriptors.)</para>
<para>This environment variable is primarily useful to allow services to optionally upgrade their used log
protocol to the native journal protocol (using
<citerefentry><refentrytitle>sd_journal_print</refentrytitle><manvolnum>3</manvolnum></citerefentry> and other
functions) if their standard output or standard error output is connected to the journal anyway, thus enabling
man: update version information As I noticed a lot of missing information when trying to implement checking for missing info. I reimplemented the version information script to be more robust, and here is the result. Follow up to ec07c3c80b2b1bfa6788500202006ff85f5ae4f4
2023-09-18 23:03:38 +08:00
delivery of structured metadata along with logged messages.</para>
<xi:include href="version-info.xml" xpointer="v231"/></listitem>
man: improve description of environment block creation This adds a general description of "philosphy" of keeping the environemnt block small and hints about systemd-run -P env. The list of generated variables is split out to a subsection. Viewing the patch with ignoring whitespace changes is recommended. We don't ignore invalid assignments (except in import-environment to some extent), previous description was wrong. For https://bugzilla.redhat.com/show_bug.cgi?id=1912046#c17.
2021-01-05 18:17:14 +08:00
</varlistentry>
<varlistentry>
<term><varname>$SERVICE_RESULT</varname></term>
core: split $MONITOR_METADATA and return it only if a single unit triggers OnFailure/OnSuccess Remove the list logic, and simply skip passing metadata if more than one unit triggered an OnFailure/OnSuccess handler. Instead of a single env var to loop over, provide each separate item as its own variable. Fixes https://github.com/systemd/systemd/issues/22370
2022-02-09 19:48:30 +08:00
<listitem><para>Only used for the service unit type. This environment variable is passed to all
man: improve description of environment block creation This adds a general description of "philosphy" of keeping the environemnt block small and hints about systemd-run -P env. The list of generated variables is split out to a subsection. Viewing the patch with ignoring whitespace changes is recommended. We don't ignore invalid assignments (except in import-environment to some extent), previous description was wrong. For https://bugzilla.redhat.com/show_bug.cgi?id=1912046#c17.
2021-01-05 18:17:14 +08:00
<varname>ExecStop=</varname> and <varname>ExecStopPost=</varname> processes, and encodes the service
"result". Currently, the following values are defined:</para>
<table>
<title>Defined <varname>$SERVICE_RESULT</varname> values</title>
<tgroup cols='2'>
<colspec colname='result'/>
<colspec colname='meaning'/>
<thead>
<row>
<entry>Value</entry>
<entry>Meaning</entry>
</row>
</thead>
<tbody>
<row>
<entry><literal>success</literal></entry>
<entry>The service ran successfully and exited cleanly.</entry>
</row>
<row>
<entry><literal>protocol</literal></entry>
<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>
</row>
<row>
<entry><literal>timeout</literal></entry>
<entry>One of the steps timed out.</entry>
</row>
<row>
<entry><literal>exit-code</literal></entry>
<entry>Service process exited with a non-zero exit code; see <varname>$EXIT_CODE</varname> below for the actual exit code returned.</entry>
</row>
<row>
<entry><literal>signal</literal></entry>
<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>
</row>
<row>
<entry><literal>core-dump</literal></entry>
<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>
</row>
<row>
<entry><literal>watchdog</literal></entry>
<entry>Watchdog keep-alive ping was enabled for the service, but the deadline was missed.</entry>
</row>
man/systemd.exec: Update service result table exec-condition and oom-kill were added without updating this table.
2023-10-10 20:49:22 +08:00
<row>
<entry><literal>exec-condition</literal></entry>
<entry>Service did not run because <varname>ExecCondition=</varname> failed.</entry>
</row>
<row>
<entry><literal>oom-kill</literal></entry>
<entry>A service process was terminated by the Out-Of-Memory (OOM) killer.</entry>
</row>
man: improve description of environment block creation This adds a general description of "philosphy" of keeping the environemnt block small and hints about systemd-run -P env. The list of generated variables is split out to a subsection. Viewing the patch with ignoring whitespace changes is recommended. We don't ignore invalid assignments (except in import-environment to some extent), previous description was wrong. For https://bugzilla.redhat.com/show_bug.cgi?id=1912046#c17.
2021-01-05 18:17:14 +08:00
<row>
<entry><literal>start-limit-hit</literal></entry>
<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>
</row>
<row>
<entry><literal>resources</literal></entry>
<entry>A catch-all condition in case a system operation failed.</entry>
</row>
</tbody>
</tgroup>
</table>
<para>This environment variable is useful to monitor failure or successful termination of a service. Even
though this variable is available in both <varname>ExecStop=</varname> and <varname>ExecStopPost=</varname>, it
is usually a better choice to place monitoring tools in the latter, as the former is only invoked for services
that managed to start up correctly, and the latter covers both services that failed during their start-up and
man: update version information As I noticed a lot of missing information when trying to implement checking for missing info. I reimplemented the version information script to be more robust, and here is the result. Follow up to ec07c3c80b2b1bfa6788500202006ff85f5ae4f4
2023-09-18 23:03:38 +08:00
those which failed during their runtime.</para>
<xi:include href="version-info.xml" xpointer="v232"/></listitem>
man: improve description of environment block creation This adds a general description of "philosphy" of keeping the environemnt block small and hints about systemd-run -P env. The list of generated variables is split out to a subsection. Viewing the patch with ignoring whitespace changes is recommended. We don't ignore invalid assignments (except in import-environment to some extent), previous description was wrong. For https://bugzilla.redhat.com/show_bug.cgi?id=1912046#c17.
2021-01-05 18:17:14 +08:00
</varlistentry>
<varlistentry>
<term><varname>$EXIT_CODE</varname></term>
<term><varname>$EXIT_STATUS</varname></term>
core: split $MONITOR_METADATA and return it only if a single unit triggers OnFailure/OnSuccess Remove the list logic, and simply skip passing metadata if more than one unit triggered an OnFailure/OnSuccess handler. Instead of a single env var to loop over, provide each separate item as its own variable. Fixes https://github.com/systemd/systemd/issues/22370
2022-02-09 19:48:30 +08:00
<listitem><para>Only defined for the service unit type. These environment variables are passed to all
man: improve description of environment block creation This adds a general description of "philosphy" of keeping the environemnt block small and hints about systemd-run -P env. The list of generated variables is split out to a subsection. Viewing the patch with ignoring whitespace changes is recommended. We don't ignore invalid assignments (except in import-environment to some extent), previous description was wrong. For https://bugzilla.redhat.com/show_bug.cgi?id=1912046#c17.
2021-01-05 18:17:14 +08:00
<varname>ExecStop=</varname>, <varname>ExecStopPost=</varname> processes and contain exit status/code
information of the main process of the service. For the precise definition of the exit code and status, see
<citerefentry><refentrytitle>wait</refentrytitle><manvolnum>2</manvolnum></citerefentry>. <varname>$EXIT_CODE</varname>
is one of <literal>exited</literal>, <literal>killed</literal>,
<literal>dumped</literal>. <varname>$EXIT_STATUS</varname> contains the numeric exit code formatted as string
if <varname>$EXIT_CODE</varname> is <literal>exited</literal>, and the signal name in all other cases. Note
that these environment variables are only set if the service manager succeeded to start and identify the main
process of the service.</para>
<table>
<title>Summary of possible service result variable values</title>
<tgroup cols='3'>
<colspec colname='result' />
<colspec colname='code' />
<colspec colname='status' />
<thead>
<row>
<entry><varname>$SERVICE_RESULT</varname></entry>
<entry><varname>$EXIT_CODE</varname></entry>
<entry><varname>$EXIT_STATUS</varname></entry>
</row>
</thead>
<tbody>
<row>
<entry morerows="1" valign="top"><literal>success</literal></entry>
<entry valign="top"><literal>killed</literal></entry>
<entry><literal>HUP</literal>, <literal>INT</literal>, <literal>TERM</literal>, <literal>PIPE</literal></entry>
</row>
<row>
<entry valign="top"><literal>exited</literal></entry>
<entry><literal>0</literal></entry>
</row>
<row>
<entry morerows="1" valign="top"><literal>protocol</literal></entry>
<entry valign="top">not set</entry>
<entry>not set</entry>
</row>
<row>
<entry><literal>exited</literal></entry>
<entry><literal>0</literal></entry>
</row>
<row>
<entry morerows="1" valign="top"><literal>timeout</literal></entry>
<entry valign="top"><literal>killed</literal></entry>
<entry><literal>TERM</literal>, <literal>KILL</literal></entry>
</row>
<row>
<entry valign="top"><literal>exited</literal></entry>
<entry><literal>0</literal>, <literal>1</literal>, <literal>2</literal>, <literal
>3</literal>, …, <literal>255</literal></entry>
</row>
<row>
<entry valign="top"><literal>exit-code</literal></entry>
<entry valign="top"><literal>exited</literal></entry>
<entry><literal>1</literal>, <literal>2</literal>, <literal
>3</literal>, …, <literal>255</literal></entry>
</row>
<row>
<entry valign="top"><literal>signal</literal></entry>
<entry valign="top"><literal>killed</literal></entry>
<entry><literal>HUP</literal>, <literal>INT</literal>, <literal>KILL</literal>, …</entry>
</row>
<row>
<entry valign="top"><literal>core-dump</literal></entry>
<entry valign="top"><literal>dumped</literal></entry>
<entry><literal>ABRT</literal>, <literal>SEGV</literal>, <literal>QUIT</literal>, …</entry>
</row>
<row>
<entry morerows="2" valign="top"><literal>watchdog</literal></entry>
<entry><literal>dumped</literal></entry>
<entry><literal>ABRT</literal></entry>
</row>
<row>
<entry><literal>killed</literal></entry>
<entry><literal>TERM</literal>, <literal>KILL</literal></entry>
</row>
<row>
<entry><literal>exited</literal></entry>
<entry><literal>0</literal>, <literal>1</literal>, <literal>2</literal>, <literal
>3</literal>, …, <literal>255</literal></entry>
</row>
<row>
<entry valign="top"><literal>exec-condition</literal></entry>
<entry><literal>exited</literal></entry>
<entry><literal>1</literal>, <literal>2</literal>, <literal>3</literal>, <literal
>4</literal>, …, <literal>254</literal></entry>
</row>
<row>
<entry valign="top"><literal>oom-kill</literal></entry>
<entry valign="top"><literal>killed</literal></entry>
<entry><literal>TERM</literal>, <literal>KILL</literal></entry>
</row>
<row>
<entry><literal>start-limit-hit</literal></entry>
<entry>not set</entry>
<entry>not set</entry>
</row>
<row>
<entry><literal>resources</literal></entry>
<entry>any of the above</entry>
<entry>any of the above</entry>
</row>
<row>
<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>
</row>
</tbody>
</tgroup>
man: update version information As I noticed a lot of missing information when trying to implement checking for missing info. I reimplemented the version information script to be more robust, and here is the result. Follow up to ec07c3c80b2b1bfa6788500202006ff85f5ae4f4
2023-09-18 23:03:38 +08:00
</table>
<xi:include href="version-info.xml" xpointer="v232"/></listitem>
man: improve description of environment block creation This adds a general description of "philosphy" of keeping the environemnt block small and hints about systemd-run -P env. The list of generated variables is split out to a subsection. Viewing the patch with ignoring whitespace changes is recommended. We don't ignore invalid assignments (except in import-environment to some extent), previous description was wrong. For https://bugzilla.redhat.com/show_bug.cgi?id=1912046#c17.
2021-01-05 18:17:14 +08:00
</varlistentry>
man: document $MONITOR_METADATA usage Decsribe when $MONITOR_METADATA will be set and how it's contents are defined.
2021-12-10 23:55:36 +08:00
<varlistentry>
core: split $MONITOR_METADATA and return it only if a single unit triggers OnFailure/OnSuccess Remove the list logic, and simply skip passing metadata if more than one unit triggered an OnFailure/OnSuccess handler. Instead of a single env var to loop over, provide each separate item as its own variable. Fixes https://github.com/systemd/systemd/issues/22370
2022-02-09 19:48:30 +08:00
<term><varname>$MONITOR_SERVICE_RESULT</varname></term>
<term><varname>$MONITOR_EXIT_CODE</varname></term>
<term><varname>$MONITOR_EXIT_STATUS</varname></term>
<term><varname>$MONITOR_INVOCATION_ID</varname></term>
<term><varname>$MONITOR_UNIT</varname></term>
man: Miscellaneous fixes Fixes: #24056
2022-07-19 16:57:33 +08:00
<listitem><para>Only defined for the service unit type. Those environment variables are passed to
core: split $MONITOR_METADATA and return it only if a single unit triggers OnFailure/OnSuccess Remove the list logic, and simply skip passing metadata if more than one unit triggered an OnFailure/OnSuccess handler. Instead of a single env var to loop over, provide each separate item as its own variable. Fixes https://github.com/systemd/systemd/issues/22370
2022-02-09 19:48:30 +08:00
all <varname>ExecStart=</varname> and <varname>ExecStartPre=</varname> processes which run in
services triggered by <varname>OnFailure=</varname> or <varname>OnSuccess=</varname> dependencies.
man: document $MONITOR_METADATA usage Decsribe when $MONITOR_METADATA will be set and how it's contents are defined.
2021-12-10 23:55:36 +08:00
</para>
core: split $MONITOR_METADATA and return it only if a single unit triggers OnFailure/OnSuccess Remove the list logic, and simply skip passing metadata if more than one unit triggered an OnFailure/OnSuccess handler. Instead of a single env var to loop over, provide each separate item as its own variable. Fixes https://github.com/systemd/systemd/issues/22370
2022-02-09 19:48:30 +08:00
<para>Variables <varname>$MONITOR_SERVICE_RESULT</varname>, <varname>$MONITOR_EXIT_CODE</varname>
and <varname>$MONITOR_EXIT_STATUS</varname> take the same values as for
<varname>ExecStop=</varname> and <varname>ExecStopPost=</varname> processes. Variables
<varname>$MONITOR_INVOCATION_ID</varname> and <varname>$MONITOR_UNIT</varname> are set to the
man: Miscellaneous fixes Fixes: #24056
2022-07-19 16:57:33 +08:00
invocation id and unit name of the service which triggered the dependency.</para>
core: split $MONITOR_METADATA and return it only if a single unit triggers OnFailure/OnSuccess Remove the list logic, and simply skip passing metadata if more than one unit triggered an OnFailure/OnSuccess handler. Instead of a single env var to loop over, provide each separate item as its own variable. Fixes https://github.com/systemd/systemd/issues/22370
2022-02-09 19:48:30 +08:00
<para>Note that when multiple services trigger the same unit, those variables will be
<emphasis>not</emphasis> be passed. Consider using a template handler unit for that case instead:
<literal>OnFailure=<replaceable>handler</replaceable>@%n.service</literal> for non-templated units,
or <literal>OnFailure=<replaceable>handler</replaceable>@%p-%i.service</literal> for templated
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-23 00:52:36 +08:00
units.</para>
<xi:include href="version-info.xml" xpointer="v251"/></listitem>
man: document $MONITOR_METADATA usage Decsribe when $MONITOR_METADATA will be set and how it's contents are defined.
2021-12-10 23:55:36 +08:00
</varlistentry>
man: improve description of environment block creation This adds a general description of "philosphy" of keeping the environemnt block small and hints about systemd-run -P env. The list of generated variables is split out to a subsection. Viewing the patch with ignoring whitespace changes is recommended. We don't ignore invalid assignments (except in import-environment to some extent), previous description was wrong. For https://bugzilla.redhat.com/show_bug.cgi?id=1912046#c17.
2021-01-05 18:17:14 +08:00
<varlistentry>
<term><varname>$PIDFILE</varname></term>
<listitem><para>The path to the configured PID file, in case the process is forked off on behalf of
a service that uses the <varname>PIDFile=</varname> setting, see
<citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>
for details. Service code may use this environment variable to automatically generate a PID file at
the location configured in the unit file. This field is set to an absolute path in the file
man: update version information As I noticed a lot of missing information when trying to implement checking for missing info. I reimplemented the version information script to be more robust, and here is the result. Follow up to ec07c3c80b2b1bfa6788500202006ff85f5ae4f4
2023-09-18 23:03:38 +08:00
system.</para>
<xi:include href="version-info.xml" xpointer="v242"/></listitem>
man: improve description of environment block creation This adds a general description of "philosphy" of keeping the environemnt block small and hints about systemd-run -P env. The list of generated variables is split out to a subsection. Viewing the patch with ignoring whitespace changes is recommended. We don't ignore invalid assignments (except in import-environment to some extent), previous description was wrong. For https://bugzilla.redhat.com/show_bug.cgi?id=1912046#c17.
2021-01-05 18:17:14 +08:00
</varlistentry>
man: document REMOTE_ADDR/REMOTE_PORT along with the other env vars
2023-02-24 17:21:49 +08:00
<varlistentry>
<term><varname>$REMOTE_ADDR</varname></term>
<term><varname>$REMOTE_PORT</varname></term>
<listitem><para>If this is a unit started via per-connection socket activation (i.e. via a socket
unit with <varname>Accept=yes</varname>), these environment variables contain the IP address and
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-23 00:52:36 +08:00
port number of the remote peer of the socket connection.</para>
<xi:include href="version-info.xml" xpointer="v254"/></listitem>
man: document REMOTE_ADDR/REMOTE_PORT along with the other env vars
2023-02-24 17:21:49 +08:00
</varlistentry>
service: set TRIGGER_UNIT= and TRIGGER_PATH= on activation by path unit When a service is triggered by a path unit, pass the path unit name and the path that triggered it via env vars to the spawned processes. Note that this is best-effort, as there might be many triggers at the same time, but we only get woken up by one.
2022-08-03 03:07:35 +08:00
<varlistentry>
<term><varname>$TRIGGER_UNIT</varname></term>
<term><varname>$TRIGGER_PATH</varname></term>
service: set TRIGGER_UNIT= and TRIGGER_TIMER_REALTIME_USEC/MONOTONIC_USEC on activation by timer unit Same as path unit, best effort.
2022-08-03 03:15:12 +08:00
<term><varname>$TRIGGER_TIMER_REALTIME_USEC</varname></term>
<term><varname>$TRIGGER_TIMER_MONOTONIC_USEC</varname></term>
service: set TRIGGER_UNIT= and TRIGGER_PATH= on activation by path unit When a service is triggered by a path unit, pass the path unit name and the path that triggered it via env vars to the spawned processes. Note that this is best-effort, as there might be many triggers at the same time, but we only get woken up by one.
2022-08-03 03:07:35 +08:00
service: set TRIGGER_UNIT= and TRIGGER_TIMER_REALTIME_USEC/MONOTONIC_USEC on activation by timer unit Same as path unit, best effort.
2022-08-03 03:15:12 +08:00
<listitem><para>If the unit was activated dynamically (e.g.: a corresponding path unit or timer unit), the
service: set TRIGGER_UNIT= and TRIGGER_PATH= on activation by path unit When a service is triggered by a path unit, pass the path unit name and the path that triggered it via env vars to the spawned processes. Note that this is best-effort, as there might be many triggers at the same time, but we only get woken up by one.
2022-08-03 03:07:35 +08:00
unit that triggered it and other type-dependent information will be passed via these variables. Note that
this information is provided in a best-effort way. For example, multiple triggers happening one after
another will be coalesced and only one will be reported, with no guarantee as to which one it will be.
Because of this, in most cases this variable will be primarily informational, i.e. useful for debugging
purposes, is lossy, and should not be relied upon to propagate a comprehensive reason for activation.
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-23 00:52:36 +08:00
</para>
<xi:include href="version-info.xml" xpointer="v252"/></listitem>
service: set TRIGGER_UNIT= and TRIGGER_PATH= on activation by path unit When a service is triggered by a path unit, pass the path unit name and the path that triggered it via env vars to the spawned processes. Note that this is best-effort, as there might be many triggers at the same time, but we only get woken up by one.
2022-08-03 03:07:35 +08:00
</varlistentry>
pid1: add unit file settings to control memory pressure logic
2023-02-16 02:00:14 +08:00
<varlistentry>
<term><varname>$MEMORY_PRESSURE_WATCH</varname></term>
<term><varname>$MEMORY_PRESSURE_WRITE</varname></term>
<listitem><para>If memory pressure monitoring is enabled for this service unit, the path to watch
and the data to write into it. See <ulink url="https://systemd.io/MEMORY_PRESSURE">Memory Pressure
Handling</ulink> for details about these variables and the service protocol data they
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-23 00:52:36 +08:00
convey.</para>
<xi:include href="version-info.xml" xpointer="v254"/></listitem>
pid1: add unit file settings to control memory pressure logic
2023-02-16 02:00:14 +08:00
</varlistentry>
service: tell service processes that the fdstore is available via an env var
2023-04-05 21:48:31 +08:00
<varlistentry>
<term><varname>$FDSTORE</varname></term>
man: make the description of fd storage a bit more accessible The text is split into paragraphs about specific topics. The advice and recommendations parts are moved to the end.
2023-09-15 14:38:28 +08:00
<listitem><para>The maximum number of file descriptors that may be stored in the manager for the
service. This variable is set when the file descriptor store is enabled for the service, i.e.
<varname>FileDescriptorStoreMax=</varname> is set to a non-zero value (see
service: tell service processes that the fdstore is available via an env var
2023-04-05 21:48:31 +08:00
<citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>
man: make the description of fd storage a bit more accessible The text is split into paragraphs about specific topics. The advice and recommendations parts are moved to the end.
2023-09-15 14:38:28 +08:00
for details). Applications may check this environment variable before sending file descriptors to
the service manager via <function>sd_pid_notify_with_fds()</function> (see
service: tell service processes that the fdstore is available via an env var
2023-04-05 21:48:31 +08:00
<citerefentry><refentrytitle>sd_notify</refentrytitle><manvolnum>3</manvolnum></citerefentry> for
man: add version info This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
2023-08-23 00:52:36 +08:00
details).</para>
<xi:include href="version-info.xml" xpointer="v254"/></listitem>
service: tell service processes that the fdstore is available via an env var
2023-04-05 21:48:31 +08:00
</varlistentry>
man: improve description of environment block creation This adds a general description of "philosphy" of keeping the environemnt block small and hints about systemd-run -P env. The list of generated variables is split out to a subsection. Viewing the patch with ignoring whitespace changes is recommended. We don't ignore invalid assignments (except in import-environment to some extent), previous description was wrong. For https://bugzilla.redhat.com/show_bug.cgi?id=1912046#c17.
2021-01-05 18:17:14 +08:00
</variablelist>
<para>For system services, when <varname>PAMName=</varname> is enabled and <command>pam_systemd</command> is part
of the selected PAM stack, additional environment variables defined by systemd may be set for
services. Specifically, these are <varname>$XDG_SEAT</varname>, <varname>$XDG_VTNR</varname>, see
<citerefentry><refentrytitle>pam_systemd</refentrytitle><manvolnum>8</manvolnum></citerefentry> for details.</para>
</refsect2>
man: don't claim we'd set XDG_SEAT and XDG_VTNR as part of service management Previously, reading through systemd.exec(5) one might get the idea that XDG_SEAT and XDG_VTNR are part of the service management logic, but they are not, they are only set if pam_systemd is part of a PAM stack an pam_systemd is used. Hence, let's drop these env vars from the list of env vars, and instead add a paragraph after the list mentioning that pam_systemd might add more systemd-specific env vars if included in the PAM stack for a service that uses PAMName=.
2018-04-24 17:51:21 +08:00
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
</refsect1>
doc: document service exit codes (Heavily reworked by Lennart while rebasing) Fixes: #3545 Replaces: #5159
2017-01-26 20:45:46 +08:00
<refsect1>
man: improve description of environment block creation This adds a general description of "philosphy" of keeping the environemnt block small and hints about systemd-run -P env. The list of generated variables is split out to a subsection. Viewing the patch with ignoring whitespace changes is recommended. We don't ignore invalid assignments (except in import-environment to some extent), previous description was wrong. For https://bugzilla.redhat.com/show_bug.cgi?id=1912046#c17.
2021-01-05 18:17:14 +08:00
<title>Process Exit Codes</title>
doc: document service exit codes (Heavily reworked by Lennart while rebasing) Fixes: #3545 Replaces: #5159
2017-01-26 20:45:46 +08:00
<para>When invoking a unit process the service manager possibly fails to apply the execution parameters configured
with the settings above. In that case the already created service process will exit with a non-zero exit code
before the configured command line is executed. (Or in other words, the child process possibly exits with these
error codes, after having been created by the <citerefentry
project='man-pages'><refentrytitle>fork</refentrytitle><manvolnum>2</manvolnum></citerefentry> system call, but
before the matching <citerefentry
project='man-pages'><refentrytitle>execve</refentrytitle><manvolnum>2</manvolnum></citerefentry> system call is
called.) Specifically, exit codes defined by the C library, by the LSB specification and by the systemd service
manager itself are used.</para>
<para>The following basic service exit codes are defined by the C library.</para>
<table>
<title>Basic C library exit codes</title>
<tgroup cols='3'>
<thead>
<row>
<entry>Exit Code</entry>
<entry>Symbolic Name</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry>0</entry>
<entry><constant>EXIT_SUCCESS</constant></entry>
<entry>Generic success code.</entry>
</row>
<row>
<entry>1</entry>
<entry><constant>EXIT_FAILURE</constant></entry>
<entry>Generic failure or unspecified error.</entry>
</row>
</tbody>
</tgroup>
</table>
<para>The following service exit codes are defined by the <ulink
man: remove trailing space in link in HTML output
2019-07-30 01:25:49 +08:00
url="https://refspecs.linuxbase.org/LSB_5.0.0/LSB-Core-generic/LSB-Core-generic/iniscrptact.html">LSB specification</ulink>.
doc: document service exit codes (Heavily reworked by Lennart while rebasing) Fixes: #3545 Replaces: #5159
2017-01-26 20:45:46 +08:00
</para>
<table>
<title>LSB service exit codes</title>
<tgroup cols='3'>
<thead>
<row>
<entry>Exit Code</entry>
<entry>Symbolic Name</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry>2</entry>
<entry><constant>EXIT_INVALIDARGUMENT</constant></entry>
<entry>Invalid or excess arguments.</entry>
</row>
<row>
<entry>3</entry>
<entry><constant>EXIT_NOTIMPLEMENTED</constant></entry>
<entry>Unimplemented feature.</entry>
</row>
<row>
<entry>4</entry>
<entry><constant>EXIT_NOPERMISSION</constant></entry>
<entry>The user has insufficient privileges.</entry>
</row>
<row>
<entry>5</entry>
<entry><constant>EXIT_NOTINSTALLED</constant></entry>
<entry>The program is not installed.</entry>
</row>
<row>
<entry>6</entry>
<entry><constant>EXIT_NOTCONFIGURED</constant></entry>
<entry>The program is not configured.</entry>
</row>
<row>
<entry>7</entry>
<entry><constant>EXIT_NOTRUNNING</constant></entry>
<entry>The program is not running.</entry>
</row>
</tbody>
</tgroup>
</table>
<para>
The LSB specification suggests that error codes 200 and above are reserved for implementations. Some of them are
used by the service manager to indicate problems during process invocation:
</para>
<table>
<title>systemd-specific exit codes</title>
<tgroup cols='3'>
<thead>
<row>
<entry>Exit Code</entry>
<entry>Symbolic Name</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry>200</entry>
<entry><constant>EXIT_CHDIR</constant></entry>
<entry>Changing to the requested working directory failed. See <varname>WorkingDirectory=</varname> above.</entry>
</row>
<row>
<entry>201</entry>
<entry><constant>EXIT_NICE</constant></entry>
<entry>Failed to set up process scheduling priority (nice level). See <varname>Nice=</varname> above.</entry>
</row>
<row>
<entry>202</entry>
<entry><constant>EXIT_FDS</constant></entry>
<entry>Failed to close unwanted file descriptors, or to adjust passed file descriptors.</entry>
</row>
<row>
<entry>203</entry>
<entry><constant>EXIT_EXEC</constant></entry>
<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>
</row>
<row>
<entry>204</entry>
<entry><constant>EXIT_MEMORY</constant></entry>
<entry>Failed to perform an action due to memory shortage.</entry>
</row>
<row>
<entry>205</entry>
<entry><constant>EXIT_LIMITS</constant></entry>
man: fix typos (#7029)
2017-10-11 03:59:03 +08:00
<entry>Failed to adjust resource limits. See <varname>LimitCPU=</varname> and related settings above.</entry>
doc: document service exit codes (Heavily reworked by Lennart while rebasing) Fixes: #3545 Replaces: #5159
2017-01-26 20:45:46 +08:00
</row>
<row>
<entry>206</entry>
<entry><constant>EXIT_OOM_ADJUST</constant></entry>
<entry>Failed to adjust the OOM setting. See <varname>OOMScoreAdjust=</varname> above.</entry>
</row>
<row>
<entry>207</entry>
<entry><constant>EXIT_SIGNAL_MASK</constant></entry>
<entry>Failed to set process signal mask.</entry>
</row>
<row>
<entry>208</entry>
<entry><constant>EXIT_STDIN</constant></entry>
<entry>Failed to set up standard input. See <varname>StandardInput=</varname> above.</entry>
</row>
<row>
<entry>209</entry>
<entry><constant>EXIT_STDOUT</constant></entry>
<entry>Failed to set up standard output. See <varname>StandardOutput=</varname> above.</entry>
</row>
<row>
<entry>210</entry>
<entry><constant>EXIT_CHROOT</constant></entry>
<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>
</row>
<row>
<entry>211</entry>
<entry><constant>EXIT_IOPRIO</constant></entry>
<entry>Failed to set up IO scheduling priority. See <varname>IOSchedulingClass=</varname>/<varname>IOSchedulingPriority=</varname> above.</entry>
</row>
<row>
<entry>212</entry>
<entry><constant>EXIT_TIMERSLACK</constant></entry>
<entry>Failed to set up timer slack. See <varname>TimerSlackNSec=</varname> above.</entry>
</row>
<row>
<entry>213</entry>
<entry><constant>EXIT_SECUREBITS</constant></entry>
<entry>Failed to set process secure bits. See <varname>SecureBits=</varname> above.</entry>
</row>
<row>
<entry>214</entry>
<entry><constant>EXIT_SETSCHEDULER</constant></entry>
<entry>Failed to set up CPU scheduling. See <varname>CPUSchedulingPolicy=</varname>/<varname>CPUSchedulingPriority=</varname> above.</entry>
</row>
<row>
<entry>215</entry>
<entry><constant>EXIT_CPUAFFINITY</constant></entry>
<entry>Failed to set up CPU affinity. See <varname>CPUAffinity=</varname> above.</entry>
</row>
<row>
<entry>216</entry>
<entry><constant>EXIT_GROUP</constant></entry>
<entry>Failed to determine or change group credentials. See <varname>Group=</varname>/<varname>SupplementaryGroups=</varname> above.</entry>
</row>
<row>
<entry>217</entry>
<entry><constant>EXIT_USER</constant></entry>
<entry>Failed to determine or change user credentials, or to set up user namespacing. See <varname>User=</varname>/<varname>PrivateUsers=</varname> above.</entry>
</row>
<row>
<entry>218</entry>
<entry><constant>EXIT_CAPABILITIES</constant></entry>
<entry>Failed to drop capabilities, or apply ambient capabilities. See <varname>CapabilityBoundingSet=</varname>/<varname>AmbientCapabilities=</varname> above.</entry>
</row>
<row>
<entry>219</entry>
<entry><constant>EXIT_CGROUP</constant></entry>
<entry>Setting up the service control group failed.</entry>
</row>
<row>
<entry>220</entry>
<entry><constant>EXIT_SETSID</constant></entry>
<entry>Failed to create new process session.</entry>
</row>
<row>
<entry>221</entry>
<entry><constant>EXIT_CONFIRM</constant></entry>
<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>
</row>
<row>
<entry>222</entry>
<entry><constant>EXIT_STDERR</constant></entry>
<entry>Failed to set up standard error output. See <varname>StandardError=</varname> above.</entry>
</row>
<row>
<entry>224</entry>
<entry><constant>EXIT_PAM</constant></entry>
<entry>Failed to set up PAM session. See <varname>PAMName=</varname> above.</entry>
</row>
<row>
<entry>225</entry>
<entry><constant>EXIT_NETWORK</constant></entry>
<entry>Failed to set up network namespacing. See <varname>PrivateNetwork=</varname> above.</entry>
</row>
<row>
<entry>226</entry>
<entry><constant>EXIT_NAMESPACE</constant></entry>
New directives PrivateIPC and IPCNamespacePath
2021-02-16 23:58:56 +08:00
<entry>Failed to set up mount, UTS, or IPC namespacing. See <varname>ReadOnlyPaths=</varname>, <varname>ProtectHostname=</varname>, <varname>PrivateIPC=</varname>, and related settings above.</entry>
doc: document service exit codes (Heavily reworked by Lennart while rebasing) Fixes: #3545 Replaces: #5159
2017-01-26 20:45:46 +08:00
</row>
<row>
<entry>227</entry>
<entry><constant>EXIT_NO_NEW_PRIVILEGES</constant></entry>
man: fix typos (#7029)
2017-10-11 03:59:03 +08:00
<entry>Failed to disable new privileges. See <varname>NoNewPrivileges=yes</varname> above.</entry>
doc: document service exit codes (Heavily reworked by Lennart while rebasing) Fixes: #3545 Replaces: #5159
2017-01-26 20:45:46 +08:00
</row>
<row>
<entry>228</entry>
<entry><constant>EXIT_SECCOMP</constant></entry>
<entry>Failed to apply system call filters. See <varname>SystemCallFilter=</varname> and related settings above.</entry>
</row>
<row>
<entry>229</entry>
<entry><constant>EXIT_SELINUX_CONTEXT</constant></entry>
<entry>Determining or changing SELinux context failed. See <varname>SELinuxContext=</varname> above.</entry>
</row>
<row>
<entry>230</entry>
<entry><constant>EXIT_PERSONALITY</constant></entry>
man: fix typos (#7029)
2017-10-11 03:59:03 +08:00
<entry>Failed to set up an execution domain (personality). See <varname>Personality=</varname> above.</entry>
doc: document service exit codes (Heavily reworked by Lennart while rebasing) Fixes: #3545 Replaces: #5159
2017-01-26 20:45:46 +08:00
</row>
<row>
<entry>231</entry>
<entry><constant>EXIT_APPARMOR_PROFILE</constant></entry>
<entry>Failed to prepare changing AppArmor profile. See <varname>AppArmorProfile=</varname> above.</entry>
</row>
<row>
<entry>232</entry>
<entry><constant>EXIT_ADDRESS_FAMILIES</constant></entry>
<entry>Failed to restrict address families. See <varname>RestrictAddressFamilies=</varname> above.</entry>
</row>
<row>
<entry>233</entry>
<entry><constant>EXIT_RUNTIME_DIRECTORY</constant></entry>
<entry>Setting up runtime directory failed. See <varname>RuntimeDirectory=</varname> and related settings above.</entry>
</row>
<row>
<entry>235</entry>
<entry><constant>EXIT_CHOWN</constant></entry>
<entry>Failed to adjust socket ownership. Used for socket units only.</entry>
</row>
<row>
<entry>236</entry>
<entry><constant>EXIT_SMACK_PROCESS_LABEL</constant></entry>
<entry>Failed to set SMACK label. See <varname>SmackProcessLabel=</varname> above.</entry>
</row>
<row>
<entry>237</entry>
<entry><constant>EXIT_KEYRING</constant></entry>
<entry>Failed to set up kernel keyring.</entry>
</row>
<row>
<entry>238</entry>
<entry><constant>EXIT_STATE_DIRECTORY</constant></entry>
man: fix typos (#7029)
2017-10-11 03:59:03 +08:00
<entry>Failed to set up unit's state directory. See <varname>StateDirectory=</varname> above.</entry>
doc: document service exit codes (Heavily reworked by Lennart while rebasing) Fixes: #3545 Replaces: #5159
2017-01-26 20:45:46 +08:00
</row>
<row>
<entry>239</entry>
<entry><constant>EXIT_CACHE_DIRECTORY</constant></entry>
man: fix typos (#7029)
2017-10-11 03:59:03 +08:00
<entry>Failed to set up unit's cache directory. See <varname>CacheDirectory=</varname> above.</entry>
doc: document service exit codes (Heavily reworked by Lennart while rebasing) Fixes: #3545 Replaces: #5159
2017-01-26 20:45:46 +08:00
</row>
<row>
<entry>240</entry>
<entry><constant>EXIT_LOGS_DIRECTORY</constant></entry>
man: fix typos (#7029)
2017-10-11 03:59:03 +08:00
<entry>Failed to set up unit's logging directory. See <varname>LogsDirectory=</varname> above.</entry>
doc: document service exit codes (Heavily reworked by Lennart while rebasing) Fixes: #3545 Replaces: #5159
2017-01-26 20:45:46 +08:00
</row>
<row>
<entry>241</entry>
<entry><constant>EXIT_CONFIGURATION_DIRECTORY</constant></entry>
man: fix typos (#7029)
2017-10-11 03:59:03 +08:00
<entry>Failed to set up unit's configuration directory. See <varname>ConfigurationDirectory=</varname> above.</entry>
doc: document service exit codes (Heavily reworked by Lennart while rebasing) Fixes: #3545 Replaces: #5159
2017-01-26 20:45:46 +08:00
</row>
core: introduce NUMAPolicy and NUMAMask options Make possible to set NUMA allocation policy for manager. Manager's policy is by default inherited to all forked off processes. However, it is possible to override the policy on per-service basis. Currently we support, these policies: default, prefer, bind, interleave, local. See man 2 set_mempolicy for details on each policy. Overall NUMA policy actually consists of two parts. Policy itself and bitmask representing NUMA nodes where is policy effective. Node mask can be specified using related option, NUMAMask. Default mask can be overwritten on per-service level.
2019-03-13 01:58:26 +08:00
<row>
<entry>242</entry>
<entry><constant>EXIT_NUMA_POLICY</constant></entry>
tree-wide: fixes for assorted grammar and spelling issues Fixes #16363. Also includes some changes where I generalized the pattern.
2020-07-06 16:49:59 +08:00
<entry>Failed to set up unit's NUMA memory policy. See <varname>NUMAPolicy=</varname> and <varname>NUMAMask=</varname> above.</entry>
core: introduce NUMAPolicy and NUMAMask options Make possible to set NUMA allocation policy for manager. Manager's policy is by default inherited to all forked off processes. However, it is possible to override the policy on per-service basis. Currently we support, these policies: default, prefer, bind, interleave, local. See man 2 set_mempolicy for details on each policy. Overall NUMA policy actually consists of two parts. Policy itself and bitmask representing NUMA nodes where is policy effective. Node mask can be specified using related option, NUMAMask. Default mask can be overwritten on per-service level.
2019-03-13 01:58:26 +08:00
</row>
man: document pid1's new credentials logic
2020-07-24 00:05:54 +08:00
<row>
<entry>243</entry>
<entry><constant>EXIT_CREDENTIALS</constant></entry>
creds: Add ImportCredential= ImportCredential= takes a credential name and searches for a matching credential in all the credential stores we know about it. It supports globs which are expanded so that all matching credentials are loaded.
2023-01-13 23:22:46 +08:00
<entry>Failed to set up unit's credentials. See <varname>ImportCredential=</varname>, <varname>LoadCredential=</varname> and <varname>SetCredential=</varname> above.</entry>
man: document pid1's new credentials logic
2020-07-24 00:05:54 +08:00
</row>
man: document EXIT_BPF status
2021-02-08 22:06:29 +08:00
<row>
<entry>245</entry>
<entry><constant>EXIT_BPF</constant></entry>
<entry>Failed to apply BPF restrictions. See <varname>RestrictFileSystems=</varname> above.</entry>
</row>
doc: document service exit codes (Heavily reworked by Lennart while rebasing) Fixes: #3545 Replaces: #5159
2017-01-26 20:45:46 +08:00
</tbody>
</tgroup>
</table>
man: document BSD exit codes in systemd.exec(5) too Our own tools use them now, and we probably should encourage that, hence let's document them along with the other exit codes we use.
2018-04-24 01:25:23 +08:00
<para>Finally, the BSD operating systems define a set of exit codes, typically defined on Linux systems too:</para>
<table>
<title>BSD exit codes</title>
<tgroup cols='3'>
<thead>
<row>
<entry>Exit Code</entry>
<entry>Symbolic Name</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry>64</entry>
<entry><constant>EX_USAGE</constant></entry>
<entry>Command line usage error</entry>
</row>
<row>
<entry>65</entry>
<entry><constant>EX_DATAERR</constant></entry>
<entry>Data format error</entry>
</row>
<row>
<entry>66</entry>
<entry><constant>EX_NOINPUT</constant></entry>
<entry>Cannot open input</entry>
</row>
<row>
<entry>67</entry>
<entry><constant>EX_NOUSER</constant></entry>
<entry>Addressee unknown</entry>
</row>
<row>
<entry>68</entry>
<entry><constant>EX_NOHOST</constant></entry>
<entry>Host name unknown</entry>
</row>
<row>
<entry>69</entry>
<entry><constant>EX_UNAVAILABLE</constant></entry>
<entry>Service unavailable</entry>
</row>
<row>
<entry>70</entry>
<entry><constant>EX_SOFTWARE</constant></entry>
<entry>internal software error</entry>
</row>
<row>
<entry>71</entry>
<entry><constant>EX_OSERR</constant></entry>
<entry>System error (e.g., can't fork)</entry>
</row>
<row>
<entry>72</entry>
<entry><constant>EX_OSFILE</constant></entry>
<entry>Critical OS file missing</entry>
</row>
<row>
<entry>73</entry>
<entry><constant>EX_CANTCREAT</constant></entry>
<entry>Can't create (user) output file</entry>
</row>
<row>
<entry>74</entry>
<entry><constant>EX_IOERR</constant></entry>
<entry>Input/output error</entry>
</row>
<row>
<entry>75</entry>
<entry><constant>EX_TEMPFAIL</constant></entry>
<entry>Temporary failure; user is invited to retry</entry>
</row>
<row>
<entry>76</entry>
<entry><constant>EX_PROTOCOL</constant></entry>
<entry>Remote error in protocol</entry>
</row>
<row>
<entry>77</entry>
<entry><constant>EX_NOPERM</constant></entry>
<entry>Permission denied</entry>
</row>
<row>
<entry>78</entry>
<entry><constant>EX_CONFIG</constant></entry>
<entry>Configuration error</entry>
</row>
</tbody>
</tgroup>
</table>
doc: document service exit codes (Heavily reworked by Lennart while rebasing) Fixes: #3545 Replaces: #5159
2017-01-26 20:45:46 +08:00
</refsect1>
man: document $MONITOR_METADATA usage Decsribe when $MONITOR_METADATA will be set and how it's contents are defined.
2021-12-10 23:55:36 +08:00
<refsect1>
<title>Examples</title>
<example>
core: split $MONITOR_METADATA and return it only if a single unit triggers OnFailure/OnSuccess Remove the list logic, and simply skip passing metadata if more than one unit triggered an OnFailure/OnSuccess handler. Instead of a single env var to loop over, provide each separate item as its own variable. Fixes https://github.com/systemd/systemd/issues/22370
2022-02-09 19:48:30 +08:00
<title><varname>$MONITOR_<replaceable>*</replaceable></varname> usage</title>
man: document $MONITOR_METADATA usage Decsribe when $MONITOR_METADATA will be set and how it's contents are defined.
2021-12-10 23:55:36 +08:00
<para>A service <filename index="false">myfailer.service</filename> which can trigger an
<varname>OnFailure=</varname> dependency.</para>
<programlisting>
[Unit]
Description=Service which can trigger an OnFailure= dependency
OnFailure=myhandler.service
[Service]
ExecStart=/bin/myprogram
</programlisting>
<para>A service <filename index="false">mysuccess.service</filename> which can trigger an
<varname>OnSuccess=</varname> dependency.</para>
<programlisting>
[Unit]
Description=Service which can trigger an OnSuccess= dependency
OnSuccess=myhandler.service
[Service]
ExecStart=/bin/mysecondprogram
</programlisting>
<para>A service <filename index="false">myhandler.service</filename> which can be triggered
by any of the above services.</para>
<programlisting>
[Unit]
Description=Acts on service failing or succeeding
[Service]
core: split $MONITOR_METADATA and return it only if a single unit triggers OnFailure/OnSuccess Remove the list logic, and simply skip passing metadata if more than one unit triggered an OnFailure/OnSuccess handler. Instead of a single env var to loop over, provide each separate item as its own variable. Fixes https://github.com/systemd/systemd/issues/22370
2022-02-09 19:48:30 +08:00
ExecStart=/bin/bash -c "echo $MONITOR_SERVICE_RESULT $MONITOR_EXIT_CODE $MONITOR_EXIT_STATUS $MONITOR_INVOCATION_ID $MONITOR_UNIT"
man: document $MONITOR_METADATA usage Decsribe when $MONITOR_METADATA will be set and how it's contents are defined.
2021-12-10 23:55:36 +08:00
</programlisting>
<para>If <filename index="false">myfailer.service</filename> were to run and exit in failure,
then <filename index="false">myhandler.service</filename> would be triggered and the
core: split $MONITOR_METADATA and return it only if a single unit triggers OnFailure/OnSuccess Remove the list logic, and simply skip passing metadata if more than one unit triggered an OnFailure/OnSuccess handler. Instead of a single env var to loop over, provide each separate item as its own variable. Fixes https://github.com/systemd/systemd/issues/22370
2022-02-09 19:48:30 +08:00
monitor variables would be set as follows:</para>
man: document $MONITOR_METADATA usage Decsribe when $MONITOR_METADATA will be set and how it's contents are defined.
2021-12-10 23:55:36 +08:00
<programlisting>
core: split $MONITOR_METADATA and return it only if a single unit triggers OnFailure/OnSuccess Remove the list logic, and simply skip passing metadata if more than one unit triggered an OnFailure/OnSuccess handler. Instead of a single env var to loop over, provide each separate item as its own variable. Fixes https://github.com/systemd/systemd/issues/22370
2022-02-09 19:48:30 +08:00
MONITOR_SERVICE_RESULT=exit-code
MONITOR_EXIT_CODE=exited
MONITOR_EXIT_STATUS=1
MONITOR_INVOCATION_ID=cc8fdc149b2b4ca698d4f259f4054236
MONITOR_UNIT=myfailer.service
man: document $MONITOR_METADATA usage Decsribe when $MONITOR_METADATA will be set and how it's contents are defined.
2021-12-10 23:55:36 +08:00
</programlisting>
<para>If <filename index="false">mysuccess.service</filename> were to run and exit in success,
then <filename index="false">myhandler.service</filename> would be triggered and the
core: split $MONITOR_METADATA and return it only if a single unit triggers OnFailure/OnSuccess Remove the list logic, and simply skip passing metadata if more than one unit triggered an OnFailure/OnSuccess handler. Instead of a single env var to loop over, provide each separate item as its own variable. Fixes https://github.com/systemd/systemd/issues/22370
2022-02-09 19:48:30 +08:00
monitor variables would be set as follows:</para>
man: document $MONITOR_METADATA usage Decsribe when $MONITOR_METADATA will be set and how it's contents are defined.
2021-12-10 23:55:36 +08:00
<programlisting>
core: split $MONITOR_METADATA and return it only if a single unit triggers OnFailure/OnSuccess Remove the list logic, and simply skip passing metadata if more than one unit triggered an OnFailure/OnSuccess handler. Instead of a single env var to loop over, provide each separate item as its own variable. Fixes https://github.com/systemd/systemd/issues/22370
2022-02-09 19:48:30 +08:00
MONITOR_SERVICE_RESULT=success
MONITOR_EXIT_CODE=exited
MONITOR_EXIT_STATUS=0
MONITOR_INVOCATION_ID=6ab9af147b8c4a3ebe36e7a5f8611697
MONITOR_UNIT=mysuccess.service
man: document $MONITOR_METADATA usage Decsribe when $MONITOR_METADATA will be set and how it's contents are defined.
2021-12-10 23:55:36 +08:00
</programlisting>
</example>
</refsect1>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
<refsect1>
<title>See Also</title>
<para>
<citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
analyze: add syscall-filter verb This should make it easier for users to understand what each filter means as the list of syscalls is updated in subsequent systemd versions.
2016-11-02 23:58:18 +08:00
<citerefentry><refentrytitle>systemd-analyze</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
man: fix volume num of journalctl
2019-02-01 19:30:36 +08:00
<citerefentry><refentrytitle>journalctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
man: add referecne to systemd-system.conf
2019-02-01 19:31:51 +08:00
<citerefentry><refentrytitle>systemd-system.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
<citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
<citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
<citerefentry><refentrytitle>systemd.socket</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
<citerefentry><refentrytitle>systemd.swap</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
<citerefentry><refentrytitle>systemd.mount</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
<citerefentry><refentrytitle>systemd.kill</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
<citerefentry><refentrytitle>systemd.resource-control</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
core: accept time units for time-based resource limits Let's make sure "LimitCPU=30min" can be parsed properly, following the usual logic how we parse time values. Similar for LimitRTTIME=. While we are at it, extend a bit on the man page section about resource limits. Fixes: #1772
2015-11-10 23:52:52 +08:00
<citerefentry><refentrytitle>systemd.time</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
<citerefentry><refentrytitle>systemd.directives</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
<citerefentry><refentrytitle>tmpfiles.d</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
man: link to fork(2) more prominently For #17177.
2020-09-29 16:10:35 +08:00
<citerefentry project='man-pages'><refentrytitle>exec</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
<citerefentry project='man-pages'><refentrytitle>fork</refentrytitle><manvolnum>2</manvolnum></citerefentry>
Reindent man pages to 2ch
2015-02-04 10:14:13 +08:00
</para>
</refsect1>
man: document execution context related settings
2010-07-03 05:24:38 +08:00
</refentry>
Reference in New Issue Copy Permalink