modules/pam_loginuid/pam_loginuid.8.xml

   1 <?xml version="1.0" encoding='UTF-8'?>
   2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
   3         "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd">
   4
   5 <refentry id="pam_loginuid">
   6
   7   <refmeta>
   8     <refentrytitle>pam_loginuid</refentrytitle>
   9     <manvolnum>8</manvolnum>
  10     <refmiscinfo class="sectdesc">Linux-PAM Manual</refmiscinfo>
  11   </refmeta>
  12
  13   <refnamediv id="pam_loginuid-name">
  14     <refname>pam_loginuid</refname>
  15     <refpurpose>Record user's login uid to the process attribute</refpurpose>
  16   </refnamediv>
  17
  18   <refsynopsisdiv>
  19     <cmdsynopsis id="pam_loginuid-cmdsynopsis">
  20       <command>pam_loginuid.so</command>
  21       <arg choice="opt">
  22         require_auditd
  23       </arg>
  24     </cmdsynopsis>
  25   </refsynopsisdiv>
  26
  27   <refsect1 id="pam_loginuid-description">
  28
  29     <title>DESCRIPTION</title>
  30
  31     <para>
  32       The pam_loginuid module sets the loginuid process attribute for the
  33       process that was authenticated. This is necessary for applications
  34       to be correctly audited. This PAM module should only be used for entry
  35       point applications like: login, sshd, gdm, vsftpd, crond and atd.
  36       There are probably other entry point applications besides these.
  37       You should not use it for applications like sudo or su as that
  38       defeats the purpose by changing the loginuid to the account they just
  39       switched to.
  40     </para>
  41   </refsect1>
  42
  43   <refsect1 id="pam_loginuid-options">
  44     <title>OPTIONS</title>
  45     <variablelist>
  46       <varlistentry>
  47         <term>
  48           <option>require_auditd</option>
  49         </term>
  50         <listitem>
  51           <para>
  52             This option, when given, will cause this module to query
  53             the audit daemon status and deny logins if it is not running.
  54           </para>
  55         </listitem>
  56       </varlistentry>
  57     </variablelist>
  58   </refsect1>
  59
  60   <refsect1 id="pam_loginuid-types">
  61     <title>MODULE TYPES PROVIDED</title>
  62     <para>
  63       Only the <option>session</option> module type is provided.
  64     </para>
  65   </refsect1>
  66
  67   <refsect1 id='pam_loginuid-return_values'>
  68     <title>RETURN VALUES</title>
  69     <para>
  70       <variablelist>
  71         <varlistentry>
  72           <term>PAM_SESSION_ERR</term>
  73           <listitem>
  74             <para>
  75               An error occurred during session management.
  76             </para>
  77           </listitem>
  78         </varlistentry>
  79
  80       </variablelist>
  81     </para>
  82   </refsect1>
  83
  84   <refsect1 id='pam_loginuid-examples'>
  85     <title>EXAMPLES</title>
  86     <programlisting>
  87 #%PAM-1.0
  88 auth       required     pam_unix.so
  89 auth       required     pam_nologin.so
  90 account    required     pam_unix.so
  91 password   required     pam_unix.so
  92 session    required     pam_unix.so
  93 session    required     pam_loginuid.so
  94     </programlisting>
  95   </refsect1>
  96
  97   <refsect1 id='pam_loginuid-see_also'>
  98     <title>SEE ALSO</title>
  99     <para>
 100       <citerefentry>
 101         <refentrytitle>pam.conf</refentrytitle><manvolnum>5</manvolnum>
 102       </citerefentry>,
 103       <citerefentry>
 104         <refentrytitle>pam.d</refentrytitle><manvolnum>5</manvolnum>
 105       </citerefentry>,
 106       <citerefentry>
 107         <refentrytitle>pam</refentrytitle><manvolnum>8</manvolnum>
 108       </citerefentry>,
 109       <citerefentry>
 110         <refentrytitle>auditctl</refentrytitle><manvolnum>8</manvolnum>
 111       </citerefentry>,
 112       <citerefentry>
 113         <refentrytitle>auditd</refentrytitle><manvolnum>8</manvolnum>
 114       </citerefentry>
 115     </para>
 116   </refsect1>
 117
 118   <refsect1 id='pam_loginuid-author'>
 119     <title>AUTHOR</title>
 120       <para>
 121         pam_loginuid was written by Steve Grubb &lt;sgrubb@redhat.com&gt;
 122       </para>
 123   </refsect1>
 124
 125 </refentry>