[thirdparty/systemd.git] / man / pam_systemd.xml

<?xml version='1.0'?> <!--*-nxml-*-->
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
        "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">

<!--
  This file is part of systemd.

  Copyright 2010 Lennart Poettering

  systemd is free software; you can redistribute it and/or modify it
  under the terms of the GNU Lesser General Public License as published by
  the Free Software Foundation; either version 2.1 of the License, or
  (at your option) any later version.

  systemd is distributed in the hope that it will be useful, but
  WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  Lesser General Public License for more details.

  You should have received a copy of the GNU Lesser General Public License
  along with systemd; If not, see <http://www.gnu.org/licenses/>.
-->

<refentry id="pam_systemd" conditional='HAVE_PAM'>

        <refentryinfo>
                <title>pam_systemd</title>
                <productname>systemd</productname>

                <authorgroup>
                        <author>
                                <contrib>Developer</contrib>
                                <firstname>Lennart</firstname>
                                <surname>Poettering</surname>
                                <email>lennart@poettering.net</email>
                        </author>
                </authorgroup>
        </refentryinfo>

        <refmeta>
                <refentrytitle>pam_systemd</refentrytitle>
                <manvolnum>8</manvolnum>
        </refmeta>

        <refnamediv>
                <refname>pam_systemd</refname>
                <refpurpose>Register user sessions in the systemd login manager</refpurpose>
        </refnamediv>

        <refsynopsisdiv>
                <para><filename>pam_systemd.so</filename></para>
        </refsynopsisdiv>

        <refsect1>
                <title>Description</title>

                <para><command>pam_systemd</command> registers user
                sessions with the systemd login manager
                <citerefentry><refentrytitle>systemd-logind.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
                and hence the systemd control group hierarchy.</para>

                <para>On login, this module ensures the following:</para>

                <orderedlist>
                        <listitem><para>If it does not exist yet, the
                        user runtime directory
                        <filename>/run/user/$USER</filename> is
                        created and its ownership changed to the user
                        that is logging in.</para></listitem>

                        <listitem><para>The
                        <varname>$XDG_SESSION_ID</varname> environment
                        variable is initialized. If auditing is
                        available and
                        <command>pam_loginuid.so</command> run before
                        this module (which is highly recommended), the
                        variable is initialized from the auditing
                        session id
                        (<filename>/proc/self/sessionid</filename>). Otherwise
                        an independent session counter is
                        used.</para></listitem>

                        <listitem><para>A new systemd scope unit is
                        created for the session. If this is the first
                        concurrent session of the user, an implicit
                        slice below <filename>user.slice</filename> is
                        automatically created and the scope placed in
                        it. In instance of the system service
                        <filename>user@.service</filename> which runs
                        the systemd user manager
                        instance.</para></listitem>
                </orderedlist>

                <para>On logout, this module ensures the following:</para>

                <orderedlist>
                        <listitem><para>If this is enabled, all
                        processes of the session are terminated. If
                        the last concurrent session of a user ends, his
                        user systemd instance will be terminated too,
                        and so will the user's slice
                        unit.</para></listitem>

                        <listitem><para>If the last concurrent session
                        of a user ends, the
                        <varname>$XDG_RUNTIME_DIR</varname> directory
                        and all its contents are removed,
                        too.</para></listitem>
                </orderedlist>

                <para>If the system was not booted up with systemd as
                init system, this module does nothing and immediately
                returns PAM_SUCCESS.</para>

        </refsect1>

        <refsect1>
                <title>Options</title>

                <para>The following options are understood:</para>

                <variablelist class='pam-directives'>

                        <varlistentry>
                                <term><option>class=</option></term>

                                <listitem><para>Takes a string
                                argument which sets the session class.
                                The XDG_SESSION_CLASS environmental variable
                                takes precedence. One of
                                <literal>user</literal>,
                                <literal>greeter</literal>,
                                <literal>lock-screen</literal> or
                                <literal>background</literal>. See
                                <citerefentry><refentrytitle>sd_session_get_class</refentrytitle><manvolnum>3</manvolnum></citerefentry>
                                for details about the session class.</para></listitem>
                        </varlistentry>

                        <varlistentry>
                                <term><option>type=</option></term>

                                <listitem><para>Takes a string
                                argument which sets the session type.
                                The XDG_SESSION_TYPE environmental
                                variable takes precedence. One of
                                <literal>unspecified</literal>,
                                <literal>tty</literal>,
                                <literal>x11</literal>,
                                <literal>wayland</literal> or
                                <literal>mir</literal>. See
                                <citerefentry><refentrytitle>sd_session_get_type</refentrytitle><manvolnum>3</manvolnum></citerefentry>
                                for details about the session type.</para></listitem>
                        </varlistentry>

                        <varlistentry>
                                <term><option>debug<optional>=</optional></option></term>

                                <listitem><para>Takes an optional
                                boolean argument. If yes or without
                                the argument, the module will log
                                debugging information as it
                                operates.</para></listitem>
                        </varlistentry>
                </variablelist>
        </refsect1>

        <refsect1>
                <title>Module Types Provided</title>

                <para>Only <option>session</option> is provided.</para>
        </refsect1>

        <refsect1>
                <title>Environment</title>

                <para>The following environment variables are set for the processes of the user's session:</para>

                <variablelist class='environment-variables'>
                        <varlistentry>
                                <term><varname>$XDG_SESSION_ID</varname></term>

                                <listitem><para>A session identifier,
                                suitable to be used in filenames. The
                                string itself should be considered
                                opaque, although often it is just the
                                audit session ID as reported by
                                <filename>/proc/self/sessionid</filename>. Each
                                ID will be assigned only once during
                                machine uptime. It may hence be used
                                to uniquely label files or other
                                resources of this
                                session.</para></listitem>
                        </varlistentry>

                        <varlistentry>
                                <term><varname>$XDG_RUNTIME_DIR</varname></term>

                                <listitem><para>Path to a user-private
                                user-writable directory that is bound
                                to the user login time on the
                                machine. It is automatically created
                                the first time a user logs in and
                                removed on his final logout. If a user
                                logs in twice at the same time, both
                                sessions will see the same
                                <varname>$XDG_RUNTIME_DIR</varname>
                                and the same contents. If a user logs
                                in once, then logs out again, and logs
                                in again, the directory contents will
                                have been lost in between, but
                                applications should not rely on this
                                behavior and must be able to deal with
                                stale files. To store session-private
                                data in this directory, the user should
                                include the value of <varname>$XDG_SESSION_ID</varname>
                                in the filename. This directory shall
                                be used for runtime file system
                                objects such as <constant>AF_UNIX</constant> sockets,
                                FIFOs, PID files and similar. It is
                                guaranteed that this directory is
                                local and offers the greatest possible
                                file system feature set the
                                operating system
                                provides.</para></listitem>
                        </varlistentry>

                </variablelist>

                <para>The following environment variables are read by
                the module and may be used by the PAM service to pass
                metadata to the module:</para>

                <variablelist class='environment-variables'>
                        <varlistentry>
                                <term><varname>$XDG_SESSION_TYPE</varname></term>

                                <listitem><para>The session type. This
                                may be used instead of
                                <option>session=</option> on the
                                module parameter line, and is usually
                                preferred.</para></listitem>
                        </varlistentry>

                        <varlistentry>
                                <term><varname>$XDG_SESSION_CLASS</varname></term>

                                <listitem><para>The session class. This
                                may be used instead of
                                <option>class=</option> on the
                                module parameter line, and is usually
                                preferred.</para></listitem>
                        </varlistentry>

                        <varlistentry>
                                <term><varname>$XDG_SESSION_DESKTOP</varname></term>

                                <listitem><para>The session
                                deskop. This may be used to indicate
                                the session desktop used, where this
                                applies. This should be a short,
                                lowercase string identifying the
                                desktop environment used if this
                                information is available. For example:
                                <literal>gnome</literal>, or
                                <literal>kde</literal>.</para></listitem>
                        </varlistentry>

                        <varlistentry>
                                <term><varname>$XDG_SEAT</varname></term>

                                <listitem><para>The seat name the session
                                shall be registered for, if
                                any.</para></listitem>
                        </varlistentry>

                        <varlistentry>
                                <term><varname>$XDG_VTNR</varname></term>

                                <listitem><para>The VT number the
                                session shall be registered for, if
                                any. (Only applies to seats with a VT
                                available, such as
                                <literal>seat0</literal>)</para></listitem>
                        </varlistentry>

                </variablelist>
        </refsect1>

        <refsect1>
                <title>Example</title>

                <programlisting>#%PAM-1.0
auth       required     pam_unix.so
auth       required     pam_nologin.so
account    required     pam_unix.so
password   required     pam_unix.so
session    required     pam_unix.so
session    required     pam_loginuid.so
session    required     pam_systemd.so</programlisting>
        </refsect1>

        <refsect1>
                <title>See Also</title>
                <para>
                        <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
                        <citerefentry><refentrytitle>systemd-logind.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
                        <citerefentry><refentrytitle>logind.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
                        <citerefentry><refentrytitle>loginctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
                        <citerefentry><refentrytitle>pam.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
                        <citerefentry><refentrytitle>pam.d</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
                        <citerefentry><refentrytitle>pam</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
                        <citerefentry><refentrytitle>pam_loginuid</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
                        <citerefentry><refentrytitle>systemd.scope</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
                        <citerefentry><refentrytitle>systemd.slice</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
                        <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>
                </para>
        </refsect1>

</refentry>
Commit	Line	Data
160cd5c9 LP	1	<?xml version='1.0'?> <!---nxml--->
	2	<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
	3	"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
	4
	5	<!--
	6	This file is part of systemd.
	7
	8	Copyright 2010 Lennart Poettering
	9
	10	systemd is free software; you can redistribute it and/or modify it
5430f7f2 LP	11	under the terms of the GNU Lesser General Public License as published by
5430f7f2 LP	12	the Free Software Foundation; either version 2.1 of the License, or
160cd5c9 LP	13	(at your option) any later version.
	14
	15	systemd is distributed in the hope that it will be useful, but
	16	WITHOUT ANY WARRANTY; without even the implied warranty of
	17	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
5430f7f2	18	Lesser General Public License for more details.
160cd5c9	19
5430f7f2	20	You should have received a copy of the GNU Lesser General Public License
160cd5c9 LP	21	along with systemd; If not, see <http://www.gnu.org/licenses/>.
	22	-->
	23
47c49034	24	<refentry id="pam_systemd" conditional='HAVE_PAM'>
160cd5c9 LP	25
	26	<refentryinfo>
	27	<title>pam_systemd</title>
	28	<productname>systemd</productname>
	29
	30	<authorgroup>
	31	<author>
	32	<contrib>Developer</contrib>
	33	<firstname>Lennart</firstname>
	34	<surname>Poettering</surname>
	35	<email>lennart@poettering.net</email>
	36	</author>
	37	</authorgroup>
	38	</refentryinfo>
	39
	40	<refmeta>
	41	<refentrytitle>pam_systemd</refentrytitle>
	42	<manvolnum>8</manvolnum>
	43	</refmeta>
	44
	45	<refnamediv>
	46	<refname>pam_systemd</refname>
af3bccd6	47	<refpurpose>Register user sessions in the systemd login manager</refpurpose>
160cd5c9 LP	48	</refnamediv>
	49
	50	<refsynopsisdiv>
e670b166	51	<para><filename>pam_systemd.so</filename></para>
160cd5c9 LP	52	</refsynopsisdiv>
	53
	54	<refsect1>
	55	<title>Description</title>
	56
	57	<para><command>pam_systemd</command> registers user
3fde5f30	58	sessions with the systemd login manager
af3bccd6 LP	59	<citerefentry><refentrytitle>systemd-logind.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
af3bccd6 LP	60	and hence the systemd control group hierarchy.</para>
160cd5c9 LP	61
	62	<para>On login, this module ensures the following:</para>
	63
	64	<orderedlist>
af62c704	65	<listitem><para>If it does not exist yet, the
160cd5c9	66	user runtime directory
bb29785e	67	<filename>/run/user/$USER</filename> is
160cd5c9 LP	68	created and its ownership changed to the user
	69	that is logging in.</para></listitem>
	70
c36eecdf	71	<listitem><para>The
160cd5c9 LP	72	<varname>$XDG_SESSION_ID</varname> environment
	73	variable is initialized. If auditing is
	74	available and
	75	<command>pam_loginuid.so</command> run before
af62c704	76	this module (which is highly recommended), the
160cd5c9 LP	77	variable is initialized from the auditing
	78	session id
	79	(<filename>/proc/self/sessionid</filename>). Otherwise
	80	an independent session counter is
	81	used.</para></listitem>
	82
3e2f69b7 LP	83	<listitem><para>A new systemd scope unit is
3e2f69b7 LP	84	created for the session. If this is the first
fbce1139	85	concurrent session of the user, an implicit
3e2f69b7 LP	86	slice below <filename>user.slice</filename> is
	87	automatically created and the scope placed in
	88	it. In instance of the system service
fbce1139	89	<filename>user@.service</filename> which runs
3e2f69b7 LP	90	the systemd user manager
3e2f69b7 LP	91	instance.</para></listitem>
160cd5c9 LP	92	</orderedlist>
	93
	94	<para>On logout, this module ensures the following:</para>
	95
	96	<orderedlist>
fbce1139	97	<listitem><para>If this is enabled, all
3e2f69b7	98	processes of the session are terminated. If
fbce1139	99	the last concurrent session of a user ends, his
3e2f69b7 LP	100	user systemd instance will be terminated too,
	101	and so will the user's slice
	102	unit.</para></listitem>
	103
fbce1139 JE	104	<listitem><para>If the last concurrent session
fbce1139 JE	105	of a user ends, the
160cd5c9	106	<varname>$XDG_RUNTIME_DIR</varname> directory
3e2f69b7 LP	107	and all its contents are removed,
3e2f69b7 LP	108	too.</para></listitem>
160cd5c9 LP	109	</orderedlist>
	110
	111	<para>If the system was not booted up with systemd as
af62c704	112	init system, this module does nothing and immediately
160cd5c9 LP	113	returns PAM_SUCCESS.</para>
	114
	115	</refsect1>
	116
	117	<refsect1>
	118	<title>Options</title>
	119
	120	<para>The following options are understood:</para>
	121
ccc9a4f9	122	<variablelist class='pam-directives'>
0e318cad	123
485507b8 MM	124	<varlistentry>
	125	<term><option>class=</option></term>
	126
	127	<listitem><para>Takes a string
	128	argument which sets the session class.
	129	The XDG_SESSION_CLASS environmental variable
49ebd11f LP	130	takes precedence. One of
	131	<literal>user</literal>,
	132	<literal>greeter</literal>,
	133	<literal>lock-screen</literal> or
	134	<literal>background</literal>. See
	135	<citerefentry><refentrytitle>sd_session_get_class</refentrytitle><manvolnum>3</manvolnum></citerefentry>
	136	for details about the session class.</para></listitem>
	137	</varlistentry>
	138
	139	<varlistentry>
	140	<term><option>type=</option></term>
	141
	142	<listitem><para>Takes a string
	143	argument which sets the session type.
	144	The XDG_SESSION_TYPE environmental
	145	variable takes precedence. One of
	146	<literal>unspecified</literal>,
	147	<literal>tty</literal>,
9541666b DH	148	<literal>x11</literal>,
	149	<literal>wayland</literal> or
	150	<literal>mir</literal>. See
49ebd11f LP	151	<citerefentry><refentrytitle>sd_session_get_type</refentrytitle><manvolnum>3</manvolnum></citerefentry>
49ebd11f LP	152	for details about the session type.</para></listitem>
485507b8 MM	153	</varlistentry>
485507b8 MM	154
0e318cad	155	<varlistentry>
05a049cc	156	<term><option>debug<optional>=</optional></option></term>
0e318cad	157
05a049cc ZJS	158	<listitem><para>Takes an optional
	159	boolean argument. If yes or without
	160	the argument, the module will log
c36eecdf LP	161	debugging information as it
c36eecdf LP	162	operates.</para></listitem>
0e318cad	163	</varlistentry>
160cd5c9	164	</variablelist>
160cd5c9 LP	165	</refsect1>
	166
	167	<refsect1>
	168	<title>Module Types Provided</title>
	169
	170	<para>Only <option>session</option> is provided.</para>
	171	</refsect1>
	172
	173	<refsect1>
	174	<title>Environment</title>
	175
58474090 LP	176	<para>The following environment variables are set for the processes of the user's session:</para>
58474090 LP	177
ccc9a4f9	178	<variablelist class='environment-variables'>
160cd5c9 LP	179	<varlistentry>
	180	<term><varname>$XDG_SESSION_ID</varname></term>
	181
	182	<listitem><para>A session identifier,
e9dd9f95	183	suitable to be used in filenames. The
160cd5c9 LP	184	string itself should be considered
	185	opaque, although often it is just the
	186	audit session ID as reported by
	187	<filename>/proc/self/sessionid</filename>. Each
	188	ID will be assigned only once during
	189	machine uptime. It may hence be used
	190	to uniquely label files or other
	191	resources of this
	192	session.</para></listitem>
	193	</varlistentry>
	194
	195	<varlistentry>
	196	<term><varname>$XDG_RUNTIME_DIR</varname></term>
	197
	198	<listitem><para>Path to a user-private
	199	user-writable directory that is bound
	200	to the user login time on the
	201	machine. It is automatically created
	202	the first time a user logs in and
	203	removed on his final logout. If a user
	204	logs in twice at the same time, both
	205	sessions will see the same
	206	<varname>$XDG_RUNTIME_DIR</varname>
	207	and the same contents. If a user logs
	208	in once, then logs out again, and logs
	209	in again, the directory contents will
	210	have been lost in between, but
	211	applications should not rely on this
c5315881	212	behavior and must be able to deal with
160cd5c9	213	stale files. To store session-private
e9dd9f95	214	data in this directory, the user should
160cd5c9 LP	215	include the value of <varname>$XDG_SESSION_ID</varname>
	216	in the filename. This directory shall
	217	be used for runtime file system
74d00578	218	objects such as <constant>AF_UNIX</constant> sockets,
160cd5c9 LP	219	FIFOs, PID files and similar. It is
	220	guaranteed that this directory is
	221	local and offers the greatest possible
	222	file system feature set the
	223	operating system
	224	provides.</para></listitem>
	225	</varlistentry>
a4cd87e9 LP	226
	227	</variablelist>
	228
	229	<para>The following environment variables are read by
	230	the module and may be used by the PAM service to pass
66f756d4	231	metadata to the module:</para>
a4cd87e9 LP	232
	233	<variablelist class='environment-variables'>
	234	<varlistentry>
	235	<term><varname>$XDG_SESSION_TYPE</varname></term>
	236
	237	<listitem><para>The session type. This
	238	may be used instead of
	239	<option>session=</option> on the
	240	module parameter line, and is usually
	241	preferred.</para></listitem>
	242	</varlistentry>
	243
	244	<varlistentry>
	245	<term><varname>$XDG_SESSION_CLASS</varname></term>
	246
	247	<listitem><para>The session class. This
	248	may be used instead of
	249	<option>class=</option> on the
	250	module parameter line, and is usually
	251	preferred.</para></listitem>
	252	</varlistentry>
	253
	254	<varlistentry>
	255	<term><varname>$XDG_SESSION_DESKTOP</varname></term>
	256
	257	<listitem><para>The session
	258	deskop. This may be used to indicate
	259	the session desktop used, where this
	260	applies. This should be a short,
	261	lowercase string identifying the
	262	desktop environment used if this
	263	information is available. For example:
	264	<literal>gnome</literal>, or
	265	<literal>kde</literal>.</para></listitem>
	266	</varlistentry>
	267
	268	<varlistentry>
	269	<term><varname>$XDG_SEAT</varname></term>
	270
	271	<listitem><para>The seat name the session
	272	shall be registered for, if
	273	any.</para></listitem>
	274	</varlistentry>
	275
	276	<varlistentry>
	277	<term><varname>$XDG_VTNR</varname></term>
	278
	279	<listitem><para>The VT number the
	280	session shall be registered for, if
	281	any. (Only applies to seats with a VT
	282	available, such as
	283	<literal>seat0</literal>)</para></listitem>
	284	</varlistentry>
	285
160cd5c9 LP	286	</variablelist>
	287	</refsect1>
	288
	289	<refsect1>
	290	<title>Example</title>
	291
	292	<programlisting>#%PAM-1.0
	293	auth required pam_unix.so
	294	auth required pam_nologin.so
	295	account required pam_unix.so
	296	password required pam_unix.so
	297	session required pam_unix.so
	298	session required pam_loginuid.so
3e2f69b7	299	session required pam_systemd.so</programlisting>
160cd5c9 LP	300	</refsect1>
	301
	302	<refsect1>
	303	<title>See Also</title>
	304	<para>
af3bccd6 LP	305	<citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
	306	<citerefentry><refentrytitle>systemd-logind.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
	307	<citerefentry><refentrytitle>logind.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
	308	<citerefentry><refentrytitle>loginctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
160cd5c9 LP	309	<citerefentry><refentrytitle>pam.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
	310	<citerefentry><refentrytitle>pam.d</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
	311	<citerefentry><refentrytitle>pam</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
3e2f69b7 LP	312	<citerefentry><refentrytitle>pam_loginuid</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
	313	<citerefentry><refentrytitle>systemd.scope</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
	314	<citerefentry><refentrytitle>systemd.slice</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
	315	<citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>
160cd5c9 LP	316	</para>
	317	</refsect1>
	318
	319	</refentry>