chiark / gitweb /
Implement SocketUser= and SocketGroup= for [Socket]
[elogind.git] / man / systemd.socket.xml
index 7885b0748a70e00b2a2f5e3bff082183adaf1b1a..dc0d78f0a208527dee9acdd697d8f74a9c91d3e4 100644 (file)
                                 <term><varname>ListenSequentialPacket=</varname></term>
                                 <listitem><para>Specifies an address
                                 to listen on for a stream
-                                (SOCK_STREAM), datagram (SOCK_DGRAM)
-                                resp. sequential packet
-                                (SOCK_SEQPACKET) socket. The address
+                                (SOCK_STREAM), datagram (SOCK_DGRAM),
+                                or sequential packet
+                                (SOCK_SEQPACKET) socket, respectively. The address
                                 can be written in various formats:</para>
 
                                 <para>If the address starts with a
                         <varlistentry>
                                 <term><varname>DirectoryMode=</varname></term>
                                 <listitem><para>If listening on a file
-                                system socket of FIFO, the parent
+                                system socket or FIFO, the parent
                                 directories are automatically created
                                 if needed. This option specifies the
                                 file system access mode used when
                         <varlistentry>
                                 <term><varname>SocketMode=</varname></term>
                                 <listitem><para>If listening on a file
-                                system socket of FIFO, this option
+                                system socket or FIFO, this option
                                 specifies the file system access mode
                                 used when creating the file
                                 node. Takes an access mode in octal
                                 0666.</para></listitem>
                         </varlistentry>
 
+                        <varlistentry>
+                                <term><varname>SocketUser=</varname></term>
+                                <listitem><para>If listening on a file system
+                                socket or FIFO, this option specifies the
+                                user owner of the created socket. When
+                                defining this, keep in mind that name
+                                switch services for user name lookups may
+                                not be available. It is advisable to use a
+                                numeric UID for this
+                                setting.</para></listitem>
+                        </varlistentry>
+
+                        <varlistentry>
+                                <term><varname>SocketGroup=</varname></term>
+                                <listitem><para>If listening on a file system
+                                socket or FIFO, this option specifies the
+                                group owner of the created socket. When
+                                defining this, keep in mind that name
+                                switch services for group name lookups may
+                                not be available. It is advisable to use a
+                                numeric GID for this
+                                setting.</para></listitem>
+                        </varlistentry>
+
                         <varlistentry>
                                 <term><varname>Accept=</varname></term>
                                 <listitem><para>Takes a boolean
                                 until at least one existing connection
                                 is terminated. This setting has no
                                 effect for sockets configured with
-                                <option>Accept=no</option> or datagram
+                                <option>Accept=false</option> or datagram
                                 sockets. Defaults to
                                 64.</para></listitem>
                         </varlistentry>
                                 <term><varname>SendBuffer=</varname></term>
                                 <listitem><para>Takes an integer
                                 argument controlling the receive
-                                resp. send buffer sizes of this
-                                socket. This controls the SO_RCVBUF
-                                resp. SO_SNDBUF socket options (see
+                                or send buffer sizes of this
+                                socket, respectively. This controls the SO_RCVBUF
+                                and SO_SNDBUF socket options (see
                                 <citerefentry><refentrytitle>socket</refentrytitle><manvolnum>7</manvolnum></citerefentry>
                                 for details.).</para></listitem>
                         </varlistentry>
                                 for details.</para></listitem>
                         </varlistentry>
 
+                        <varlistentry>
+                                <term><varname>SmackLabel=</varname></term>
+                                <term><varname>SmackLabelIPIn=</varname></term>
+                                <term><varname>SmackLabelIPOut=</varname></term>
+                                <listitem><para>Takes a string
+                                value. Controls the extended
+                                attributes
+                                <literal>security.SMACK64</literal>,
+                                <literal>security.SMACK64IPIN</literal>
+                                and
+                                <literal>security.SMACK64IPOUT</literal>,
+                                respectively, i.e. the security label
+                                of the FIFO, or the security label for
+                                the incoming or outgoing connections
+                                of the socket, respectively.  See
+                                <ulink
+                                url="https://www.kernel.org/doc/Documentation/security/Smack.txt">Smack.txt</ulink>
+                                for details.</para></listitem>
+                        </varlistentry>
+
                         <varlistentry>
                                 <term><varname>PipeSize=</varname></term>
                                 <listitem><para>Takes an integer
                                 <varname>MessageQueueMessageSize=</varname></term>
                                 <listitem><para>These two settings
                                 take integer values and control the
-                                mq_maxmsg resp. mq_msgsize field when
+                                mq_maxmsg field or the mq_msgsize field, respectively, when
                                 creating the message queue. Note that
                                 either none or both of these variables
                                 need to be set. See
                                 <term><varname>ExecStartPost=</varname></term>
                                 <listitem><para>Takes one or more
                                 command lines, which are executed
-                                before (resp. after) the listening
+                                before or after the listening
                                 sockets/FIFOs are created and
-                                bound. The first token of the command
+                                bound, respectively. The first token of the command
                                 line must be an absolute file name,
                                 then followed by arguments for the
                                 process. Multiple command lines may be
                                 <term><varname>ExecStopPre=</varname></term>
                                 <term><varname>ExecStopPost=</varname></term>
                                 <listitem><para>Additional commands
-                                that are executed before (resp. after)
+                                that are executed before or after
                                 the listening sockets/FIFOs are closed
-                                and removed. Multiple command lines
+                                and removed, respectively. Multiple command lines
                                 may be specified following the same
                                 scheme as used for
                                 <varname>ExecStartPre=</varname> of