bus: add sd_bus_track object for tracking peers, and port core over to it

[elogind.git] / man / systemd.exec.xml

diff --git a/man/systemd.exec.xml b/man/systemd.exec.xml
index 01356e4c459ac9b1b01874cb313331a0f6d3c53e..9224f1ef3d5e38afcb6e2d83b4fc08f3a1f24244 100644 (file)
--- a/man/systemd.exec.xml
+++ b/man/systemd.exec.xml
@@ -248,7 +248,7 @@
                                 <listitem><para>Controls the CPU
                                 affinity of the executed
                                 processes. Takes a space-separated
                                 <listitem><para>Controls the CPU
                                 affinity of the executed
                                 processes. Takes a space-separated

-                                list of CPU indexes. This option may
+                                list of CPU indices. This option may

                                 be specified more than once in which
                                 case the specificed CPU affinity masks
                                 are merged. If the empty string is
                                 be specified more than once in which
                                 case the specificed CPU affinity masks
                                 are merged. If the empty string is


@@ -472,9 +472,9 @@
                         <varlistentry>
                                 <term><varname>StandardError=</varname></term>
                                 <listitem><para>Controls where file
                         <varlistentry>
                                 <term><varname>StandardError=</varname></term>
                                 <listitem><para>Controls where file

-                                descriptor 2 (STDERR) of the executed
-                                processes is connected to. The
-                                available options are identical to
+                                descriptor 2 (STDERR) of the
+                                executed processes is connected to.
+                                The available options are identical to

                                 those of
                                 <varname>StandardOutput=</varname>,
                                 with one exception: if set to
                                 those of
                                 <varname>StandardOutput=</varname>,
                                 with one exception: if set to


@@ -491,8 +491,8 @@
                         <varlistentry>
                                 <term><varname>TTYPath=</varname></term>
                                 <listitem><para>Sets the terminal
                         <varlistentry>
                                 <term><varname>TTYPath=</varname></term>
                                 <listitem><para>Sets the terminal

-                                device node to use if standard input,
-                                output or stderr are connected to a
+                                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>
                                 TTY (see above). Defaults to
                                 <filename>/dev/console</filename>.</para></listitem>
                         </varlistentry>


@@ -967,6 +967,19 @@
                                 for details.</para></listitem>
                         </varlistentry>
 
                                 for details.</para></listitem>
                         </varlistentry>
 

+                        <varlistentry>
+                                <term><varname>AppArmorProfile=</varname></term>
+
+                                <listitem><para>Take 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.
+                                This result in a non operation if AppArmor is not
+                                enabled. If prefixed by <literal>-</literal>, all errors
+                                will be ignored.
+                                </para></listitem>
+                        </varlistentry>
+

                         <varlistentry>
                                 <term><varname>IgnoreSIGPIPE=</varname></term>
 
                         <varlistentry>
                                 <term><varname>IgnoreSIGPIPE=</varname></term>
 


@@ -997,8 +1010,8 @@
                         <varlistentry>
                                 <term><varname>SystemCallFilter=</varname></term>
 
                         <varlistentry>
                                 <term><varname>SystemCallFilter=</varname></term>
 

-                                <listitem><para>Takes a space-separated
-                                list of system call
+                                <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
                                 names. If this setting is used, all
                                 system calls executed by the unit
                                 processes except for the listed ones


@@ -1010,12 +1023,13 @@
                                 the effect is inverted: only the
                                 listed system calls will result in
                                 immediate process termination
                                 the effect is inverted: only the
                                 listed system calls will result in
                                 immediate process termination

-                                (blacklisting). If this option is used,
+                                (blacklisting). If running in user
+                                mode and this option is used,

                                 <varname>NoNewPrivileges=yes</varname>
                                 <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 enforcing a minimal
+                                is implied. This feature makes use of the
+                                Secure Computing Mode 2 interfaces of
+                                the kernel ('seccomp filtering') and
+                                is useful for enforcing a minimal

                                 sandboxing environment. Note that the
                                 <function>execve</function>,
                                 <function>rt_sigreturn</function>,
                                 sandboxing environment. Note that the
                                 <function>execve</function>,
                                 <function>rt_sigreturn</function>,


@@ -1033,7 +1047,7 @@
 
                                 <para>If you specify both types of
                                 this option (i.e. whitelisting and
 
                                 <para>If you specify both types of
                                 this option (i.e. whitelisting and

-                                blacklisting) the first encountered
+                                blacklisting), the first encountered

                                 will take precedence and will dictate
                                 the default action (termination or
                                 approval of a system call). Then the
                                 will take precedence and will dictate
                                 the default action (termination or
                                 approval of a system call). Then the


@@ -1041,23 +1055,15 @@
                                 add or delete the listed system calls
                                 from the set of the filtered system
                                 calls, depending of its type and the
                                 add or delete the listed system calls
                                 from the set of the filtered system
                                 calls, depending of its type and the

-                                default action (e.g. You have started
+                                default action. (For example, if you have started

                                 with a whitelisting of
                                 <function>read</function> and
                                 with a whitelisting of
                                 <function>read</function> and

-                                <function>write</function> and right
+                                <function>write</function>, and right

                                 after it add a blacklisting of
                                 <function>write</function>, then
                                 <function>write</function> will be
                                 after it add a blacklisting of
                                 <function>write</function>, then
                                 <function>write</function> will be

-                                removed from the set).
+                                removed from the set.)

                                 </para></listitem>
                                 </para></listitem>

-
-                                <para>Note that setting
-                                <varname>SystemCallFilter=</varname>
-                                implies a
-                                <varname>SystemCallArchitectures=</varname>
-                                setting of <literal>native</literal>
-                                (see below), unless that option is
-                                configured otherwise.</para>

                         </varlistentry>
 
                         <varlistentry>
                         </varlistentry>
 
                         <varlistentry>


@@ -1071,11 +1077,11 @@
                                 is triggered, instead of terminating
                                 the process immediately. Takes an
                                 error name such as
                                 is triggered, instead of terminating
                                 the process immediately. Takes an
                                 error name such as

-                                <literal>EPERM</literal>,
-                                <literal>EACCES</literal> or
-                                <literal>EUCLEAN</literal>. When this
+                                <constant>EPERM</constant>,
+                                <constant>EACCES</constant> or
+                                <constant>EUCLEAN</constant>. When this

                                 setting is not used, or when the empty
                                 setting is not used, or when the empty

-                                string is assigned the process will be
+                                string is assigned, the process will be

                                 terminated immediately when the filter
                                 is triggered.</para></listitem>
                         </varlistentry>
                                 terminated immediately when the filter
                                 is triggered.</para></listitem>
                         </varlistentry>


@@ -1088,38 +1094,105 @@
                                 identifiers to include in the system
                                 call filter. The known architecture
                                 identifiers are
                                 identifiers to include in the system
                                 call filter. The known architecture
                                 identifiers are

-                                <literal>x86</literal>,
-                                <literal>x86-64</literal>,
-                                <literal>x32</literal>,
-                                <literal>arm</literal> as well as the
-                                special identifier
-                                <literal>native</literal>. Only system
-                                calls of the specified architectures
-                                will be permitted to processes of this
-                                unit. This is an effective way to
-                                disable compatibility with non-native
-                                architectures for processes, for
-                                example to prohibit execution of 32bit
-                                x86 binaries on 64bit x86-64
-                                systems. The special
-                                <literal>native</literal> identifier
+                                <constant>x86</constant>,
+                                <constant>x86-64</constant>,
+                                <constant>x32</constant>,
+                                <constant>arm</constant> as well as
+                                the special identifier
+                                <constant>native</constant>. Only
+                                system calls of the specified
+                                architectures will be permitted to
+                                processes of this unit. This is an
+                                effective way to disable compatibility
+                                with non-native architectures for
+                                processes, for example to prohibit
+                                execution of 32-bit x86 binaries on
+                                64-bit x86-64 systems. The special
+                                <constant>native</constant> identifier

                                 implicitly maps to the native
                                 architecture of the system (or more
                                 strictly: to the architecture the
                                 implicitly maps to the native
                                 architecture of the system (or more
                                 strictly: to the architecture the

-                                system manager is compiled for). Note
-                                that setting this option to a
-                                non-empty list implies that
-                                <literal>native</literal> is included
-                                too. By default this option is set to
-                                the empty list, i.e. no architecture
-                                system call filtering is applied. Note
-                                that configuring a system call filter
-                                with
-                                <varname>SystemCallFilter=</varname>
-                                (above) implies a
-                                <literal>native</literal> architecture
-                                list, unless configured
-                                otherwise.</para></listitem>
+                                system manager is compiled for). If
+                                running in user mode and this option
+                                is used,
+                                <varname>NoNewPrivileges=yes</varname>
+                                is implied. Note that setting this
+                                option to a non-empty list implies
+                                that <constant>native</constant> is
+                                included too. By default, this option
+                                is set to the empty list, i.e. no
+                                architecture system call filtering is
+                                applied.</para></listitem>
+                        </varlistentry>
+
+                        <varlistentry>
+                                <term><varname>RestrictAddressFamilies=</varname></term>
+
+                                <listitem><para>Restricts the set of
+                                socket address families accessible to
+                                the processes of this unit. Takes a
+                                space-separated list of address family
+                                names to whitelist, such as
+                                <constant>AF_UNIX</constant>,
+                                <constant>AF_INET</constant> or
+                                <constant>AF_INET6</constant>. When
+                                prefixed with <constant>~</constant>
+                                the listed address families will be
+                                applied as blacklist, otherwise as
+                                whitelist. Note that this restricts
+                                access to the
+                                <citerefentry><refentrytitle>socket</refentrytitle><manvolnum>2</manvolnum></citerefentry>
+                                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
+                                32bit x86 and is ignored (but works
+                                correctly on x86-64). If running in user
+                                mode and this option is used,
+                                <varname>NoNewPrivileges=yes</varname>
+                                is implied. By default no
+                                restriction applies, all address
+                                families are accessible to
+                                processes. If assigned the empty
+                                string any previous list changes are
+                                undone.</para>
+
+                                <para>Use this option to limit
+                                exposure of processes to remote
+                                systems, in particular via exotic
+                                network protocols. Note that in most
+                                cases the local
+                                <constant>AF_UNIX</constant> address
+                                family should be included in the
+                                configured whitelist as it is
+                                frequently used for local
+                                communication, including for
+                                <citerefentry><refentrytitle>syslog</refentrytitle><manvolnum>2</manvolnum></citerefentry>
+                                logging.</para></listitem>
+                        </varlistentry>
+
+                        <varlistentry>
+                                <term><varname>Personality=</varname></term>
+
+                                <listitem><para>Controls which
+                                kernel architecture
+                                <citerefentry><refentrytitle>uname</refentrytitle><manvolnum>2</manvolnum></citerefentry>
+                                shall report, when invoked by unit
+                                processes. Takes one of
+                                <constant>x86</constant> and
+                                <constant>x86-64</constant>. This is
+                                useful when running 32bit services on
+                                a 64bit host system. If not specified
+                                the personality is left unmodified and
+                                thus reflects the personality of the
+                                host system's
+                                kernel.</para></listitem>

                         </varlistentry>
 
                 </variablelist>
                         </varlistentry>
 
                 </variablelist>


@@ -1205,6 +1278,17 @@
                                 tty.</para></listitem>
                         </varlistentry>
 
                                 tty.</para></listitem>
                         </varlistentry>
 

+                        <varlistentry>
+                                <term><varname>$MAINPID</varname></term>
+
+                                <listitem><para>The PID of the units
+                                main process if it is known. This is
+                                only set for control processes as
+                                invoked by
+                                <varname>ExecReload=</varname> and
+                                similar.  </para></listitem>
+                        </varlistentry>
+

                         <varlistentry>
                                 <term><varname>$MANAGERPID</varname></term>
 
                         <varlistentry>
                                 <term><varname>$MANAGERPID</varname></term>