[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 — in conjunction with <filename>systemd-logind.service</filename> — ensures the
    following:</para>

    <orderedlist>
      <listitem><para>If it does not exist yet, the user runtime directory <filename>/run/user/$UID</filename> is
      either created or mounted as new <literal>tmpfs</literal> file system with quota applied, 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> was 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 per-user slice unit below <filename>user.slice</filename> is automatically created and the
      scope placed into it. An instance of the system service <filename>user@.service</filename>, which runs the
      systemd user manager instance, is started.  </para></listitem>
    </orderedlist>

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

    <orderedlist>
      <listitem><para>If enabled in
      <citerefentry><refentrytitle>logind.conf</refentrytitle>
      <manvolnum>5</manvolnum></citerefentry> (<varname>KillUserProcesses=</varname>), all processes of the session are
      terminated. If the last concurrent session of a user ends, the user's 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
    <constant>PAM_SUCCESS</constant>.</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 the user's 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. For further details, see the <ulink
        url="http://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html">XDG
        Base Directory Specification</ulink>.</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>A single, short identifier string for the
        desktop environment. This may be used to indicate the session
        desktop used, where this applies and if this information is
        available. For example: <literal>GNOME</literal>, or
        <literal>KDE</literal>. It is recommended to use the same
        identifiers and capitalization as for
        <varname>$XDG_CURRENT_DESKTOP</varname>, as defined by the
        <ulink
        url="http://standards.freedesktop.org/desktop-entry-spec/latest/">Desktop
        Entry Specification</ulink>. (However, note that
        <varname>$XDG_SESSION_DESKTOP</varname> only takes a single
        item, and not a colon-separated list like
        <varname>$XDG_CURRENT_DESKTOP</varname>.) See
        <citerefentry><refentrytitle>sd_session_get_desktop</refentrytitle><manvolnum>3</manvolnum></citerefentry>
        for more details.</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 project='man-pages'><refentrytitle>pam.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
      <citerefentry project='man-pages'><refentrytitle>pam.d</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
      <citerefentry project='man-pages'><refentrytitle>pam</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
      <citerefentry project='man-pages'><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--->
160cd5c9 LP	2	<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
12b42c76	3	"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
160cd5c9 LP	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	25
798d3a52 ZJS	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>
	47	<refpurpose>Register user sessions in the systemd login manager</refpurpose>
	48	</refnamediv>
	49
	50	<refsynopsisdiv>
	51	<para><filename>pam_systemd.so</filename></para>
	52	</refsynopsisdiv>
	53
	54	<refsect1>
	55	<title>Description</title>
	56
	57	<para><command>pam_systemd</command> registers user sessions with
	58	the systemd login manager
	59	<citerefentry><refentrytitle>systemd-logind.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
	60	and hence the systemd control group hierarchy.</para>
	61
66a5b902 LP	62	<para>On login, this module — in conjunction with <filename>systemd-logind.service</filename> — ensures the
66a5b902 LP	63	following:</para>
798d3a52 ZJS	64
798d3a52 ZJS	65	<orderedlist>
66a5b902 LP	66	<listitem><para>If it does not exist yet, the user runtime directory <filename>/run/user/$UID</filename> is
	67	either created or mounted as new <literal>tmpfs</literal> file system with quota applied, and its ownership
	68	changed to the user that is logging in.</para></listitem>
	69
	70	<listitem><para>The <varname>$XDG_SESSION_ID</varname> environment variable is initialized. If auditing is
	71	available and <command>pam_loginuid.so</command> was run before this module (which is highly recommended), the
	72	variable is initialized from the auditing session id (<filename>/proc/self/sessionid</filename>). Otherwise, an
798d3a52 ZJS	73	independent session counter is used.</para></listitem>
798d3a52 ZJS	74
66a5b902 LP	75	<listitem><para>A new systemd scope unit is created for the session. If this is the first concurrent session of
	76	the user, an implicit per-user slice unit below <filename>user.slice</filename> is automatically created and the
	77	scope placed into it. An instance of the system service <filename>user@.service</filename>, which runs the
	78	systemd user manager instance, is started. </para></listitem>
798d3a52 ZJS	79	</orderedlist>
	80
	81	<para>On logout, this module ensures the following:</para>
	82
	83	<orderedlist>
	84	<listitem><para>If enabled in
	85	<citerefentry><refentrytitle>logind.conf</refentrytitle>
66a5b902 LP	86	<manvolnum>5</manvolnum></citerefentry> (<varname>KillUserProcesses=</varname>), all processes of the session are
	87	terminated. If the last concurrent session of a user ends, the user's systemd instance will be terminated too,
	88	and so will the user's slice unit.</para></listitem>
798d3a52 ZJS	89
	90	<listitem><para>If the last concurrent session of a user ends,
	91	the <varname>$XDG_RUNTIME_DIR</varname> directory and all its
	92	contents are removed, too.</para></listitem>
	93	</orderedlist>
	94
	95	<para>If the system was not booted up with systemd as init system,
	96	this module does nothing and immediately returns
	97	<constant>PAM_SUCCESS</constant>.</para>
	98
	99	</refsect1>
	100
	101	<refsect1>
	102	<title>Options</title>
	103
	104	<para>The following options are understood:</para>
	105
	106	<variablelist class='pam-directives'>
	107
	108	<varlistentry>
	109	<term><option>class=</option></term>
	110
	111	<listitem><para>Takes a string argument which sets the session
	112	class. The XDG_SESSION_CLASS environmental variable takes
	113	precedence. One of
	114	<literal>user</literal>,
	115	<literal>greeter</literal>,
	116	<literal>lock-screen</literal> or
	117	<literal>background</literal>. See
	118	<citerefentry><refentrytitle>sd_session_get_class</refentrytitle><manvolnum>3</manvolnum></citerefentry>
	119	for details about the session class.</para></listitem>
	120	</varlistentry>
	121
	122	<varlistentry>
	123	<term><option>type=</option></term>
	124
	125	<listitem><para>Takes a string argument which sets the session
	126	type. The XDG_SESSION_TYPE environmental variable takes
	127	precedence. One of
	128	<literal>unspecified</literal>,
	129	<literal>tty</literal>,
	130	<literal>x11</literal>,
	131	<literal>wayland</literal> or
	132	<literal>mir</literal>. See
	133	<citerefentry><refentrytitle>sd_session_get_type</refentrytitle><manvolnum>3</manvolnum></citerefentry>
	134	for details about the session type.</para></listitem>
	135	</varlistentry>
	136
	137	<varlistentry>
	138	<term><option>debug<optional>=</optional></option></term>
	139
	140	<listitem><para>Takes an optional
	141	boolean argument. If yes or without
	142	the argument, the module will log
	143	debugging information as it
	144	operates.</para></listitem>
	145	</varlistentry>
	146	</variablelist>
	147	</refsect1>
	148
	149	<refsect1>
	150	<title>Module Types Provided</title>
	151
	152	<para>Only <option>session</option> is provided.</para>
153	</refsect1>
154
155	<refsect1>
156	<title>Environment</title>
157
158	<para>The following environment variables are set for the
159	processes of the user's session:</para>
160
161	<variablelist class='environment-variables'>
162	<varlistentry>
163	<term><varname>$XDG_SESSION_ID</varname></term>
164
165	<listitem><para>A session identifier, suitable to be used in
166	filenames. The string itself should be considered opaque,
167	although often it is just the audit session ID as reported by
168	<filename>/proc/self/sessionid</filename>. Each ID will be
169	assigned only once during machine uptime. It may hence be used
170	to uniquely label files or other resources of this
171	session.</para></listitem>
172	</varlistentry>
173
174	<varlistentry>
175	<term><varname>$XDG_RUNTIME_DIR</varname></term>
176
177	<listitem><para>Path to a user-private user-writable directory
178	that is bound to the user login time on the machine. It is
179	automatically created the first time a user logs in and
180	removed on the user's final logout. If a user logs in twice at
181	the same time, both sessions will see the same
182	<varname>$XDG_RUNTIME_DIR</varname> and the same contents. If
183	a user logs in once, then logs out again, and logs in again,
184	the directory contents will have been lost in between, but
185	applications should not rely on this behavior and must be able
186	to deal with stale files. To store session-private data in
187	this directory, the user should include the value of
188	<varname>$XDG_SESSION_ID</varname> in the filename. This
189	directory shall be used for runtime file system objects such
190	as <constant>AF_UNIX</constant> sockets, FIFOs, PID files and
191	similar. It is guaranteed that this directory is local and
192	offers the greatest possible file system feature set the
b938cb90	193	operating system provides. For further details, see the <ulink
798d3a52 ZJS	194	url="http://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html">XDG
	195	Base Directory Specification</ulink>.</para></listitem>
	196	</varlistentry>
	197
	198	</variablelist>
	199
	200	<para>The following environment variables are read by the module
	201	and may be used by the PAM service to pass metadata to the
	202	module:</para>
	203
	204	<variablelist class='environment-variables'>
	205	<varlistentry>
	206	<term><varname>$XDG_SESSION_TYPE</varname></term>
	207
	208	<listitem><para>The session type. This may be used instead of
	209	<option>session=</option> on the module parameter line, and is
	210	usually preferred.</para></listitem>
	211	</varlistentry>
	212
	213	<varlistentry>
	214	<term><varname>$XDG_SESSION_CLASS</varname></term>
	215
	216	<listitem><para>The session class. This may be used instead of
	217	<option>class=</option> on the module parameter line, and is
	218	usually preferred.</para></listitem>
	219	</varlistentry>
	220
	221	<varlistentry>
	222	<term><varname>$XDG_SESSION_DESKTOP</varname></term>
	223
	224	<listitem><para>A single, short identifier string for the
	225	desktop environment. This may be used to indicate the session
	226	desktop used, where this applies and if this information is
	227	available. For example: <literal>GNOME</literal>, or
	228	<literal>KDE</literal>. It is recommended to use the same
	229	identifiers and capitalization as for
	230	<varname>$XDG_CURRENT_DESKTOP</varname>, as defined by the
	231	<ulink
	232	url="http://standards.freedesktop.org/desktop-entry-spec/latest/">Desktop
	233	Entry Specification</ulink>. (However, note that
	234	<varname>$XDG_SESSION_DESKTOP</varname> only takes a single
	235	item, and not a colon-separated list like
	236	<varname>$XDG_CURRENT_DESKTOP</varname>.) See
	237	<citerefentry><refentrytitle>sd_session_get_desktop</refentrytitle><manvolnum>3</manvolnum></citerefentry>
	238	for more details.</para></listitem>
	239	</varlistentry>
	240
	241	<varlistentry>
	242	<term><varname>$XDG_SEAT</varname></term>
	243
	244	<listitem><para>The seat name the session shall be registered
	245	for, if any.</para></listitem>
	246	</varlistentry>
	247
	248	<varlistentry>
	249	<term><varname>$XDG_VTNR</varname></term>
	250
	251	<listitem><para>The VT number the session shall be registered
	252	for, if any. (Only applies to seats with a VT available, such
	253	as <literal>seat0</literal>)</para></listitem>
	254	</varlistentry>
	255
	256	</variablelist>
	257	</refsect1>
258
259	<refsect1>
260	<title>Example</title>
261
262	<programlisting>#%PAM-1.0
160cd5c9 LP	263	auth required pam_unix.so
	264	auth required pam_nologin.so
	265	account required pam_unix.so
	266	password required pam_unix.so
	267	session required pam_unix.so
	268	session required pam_loginuid.so
3e2f69b7	269	session required pam_systemd.so</programlisting>
798d3a52 ZJS	270	</refsect1>
	271
	272	<refsect1>
	273	<title>See Also</title>
	274	<para>
	275	<citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
	276	<citerefentry><refentrytitle>systemd-logind.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
	277	<citerefentry><refentrytitle>logind.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
	278	<citerefentry><refentrytitle>loginctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
	279	<citerefentry project='man-pages'><refentrytitle>pam.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
	280	<citerefentry project='man-pages'><refentrytitle>pam.d</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
	281	<citerefentry project='man-pages'><refentrytitle>pam</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
	282	<citerefentry project='man-pages'><refentrytitle>pam_loginuid</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
	283	<citerefentry><refentrytitle>systemd.scope</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
	284	<citerefentry><refentrytitle>systemd.slice</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
	285	<citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>
	286	</para>
	287	</refsect1>
160cd5c9 LP	288
160cd5c9 LP	289	</refentry>