modules/pam_tty_audit/pam_tty_audit.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_tty_audit">
   6
   7   <refmeta>
   8     <refentrytitle>pam_tty_audit</refentrytitle>
   9     <manvolnum>8</manvolnum>
  10     <refmiscinfo class="sectdesc">Linux-PAM Manual</refmiscinfo>
  11   </refmeta>
  12
  13   <refnamediv id="pam_tty_audit-name">
  14     <refname>pam_tty_audit</refname>
  15     <refpurpose>Enable or disable TTY auditing for specified users</refpurpose>
  16   </refnamediv>
  17
  18   <refsynopsisdiv>
  19     <cmdsynopsis id="pam_tty_audit-cmdsynopsis">
  20       <command>pam_tty_audit.so</command>
  21       <arg choice="opt">
  22         disable=<replaceable>patterns</replaceable>
  23       </arg>
  24       <arg choice="opt">
  25         enable=<replaceable>patterns</replaceable>
  26       </arg>
  27     </cmdsynopsis>
  28   </refsynopsisdiv>
  29
  30   <refsect1 id="pam_tty_audit-description">
  31     <title>DESCRIPTION</title>
  32     <para>
  33       The pam_tty_audit PAM module is used to enable or disable TTY auditing.
  34       By default, the kernel does not audit input on any TTY.
  35     </para>
  36   </refsect1>
  37
  38   <refsect1 id="pam_tty_audit-options">
  39     <title>OPTIONS</title>
  40     <variablelist>
  41       <varlistentry>
  42         <term>
  43           <option>disable=<replaceable>patterns</replaceable></option>
  44         </term>
  45         <listitem>
  46           <para>
  47             For each user matching one of comma-separated glob
  48             <option><replaceable>patterns</replaceable></option>, disable
  49             TTY auditing.  This overrides any previous <option>enable</option>
  50             option matching the same user name on the command line.
  51           </para>
  52         </listitem>
  53       </varlistentry>
  54       <varlistentry>
  55         <term>
  56           <option>enable=<replaceable>patterns</replaceable></option>
  57         </term>
  58         <listitem>
  59           <para>
  60             For each user matching one of comma-separated glob
  61             <option><replaceable>patterns</replaceable></option>, enable
  62             TTY auditing.  This overrides any previous <option>disable</option>
  63             option matching the same user name on the command line.
  64           </para>
  65         </listitem>
  66       </varlistentry>
  67       <varlistentry>
  68         <term>
  69           <option>open_only</option>
  70         </term>
  71         <listitem>
  72           <para>
  73            Set the TTY audit flag when opening the session, but do not restore
  74            it when closing the session.  Using this option is necessary for
  75            some services that don't <function>fork()</function> to run the
  76            authenticated session, such as <command>sudo</command>.
  77           </para>
  78         </listitem>
  79       </varlistentry>
  80     </variablelist>
  81   </refsect1>
  82
  83   <refsect1 id="pam_tty_audit-types">
  84     <title>MODULE TYPES PROVIDED</title>
  85     <para>
  86       Only the <emphasis remap='B'>session</emphasis> type is supported.
  87     </para>
  88   </refsect1>
  89
  90   <refsect1 id='pam_tty_audit-return_values'>
  91     <title>RETURN VALUES</title>
  92     <variablelist>
  93       <varlistentry>
  94         <term>PAM_SESSION_ERR</term>
  95         <listitem>
  96            <para>
  97              Error reading or modifying the TTY audit flag.  See the system log
  98              for more details.
  99           </para>
 100         </listitem>
 101       </varlistentry>
 102
 103       <varlistentry>
 104         <term>PAM_SUCCESS</term>
 105         <listitem>
 106           <para>
 107             Success.
 108           </para>
 109         </listitem>
 110       </varlistentry>
 111
 112     </variablelist>
 113   </refsect1>
 114
 115   <refsect1 id='pam_tty_audit-notes'>
 116     <title>NOTES</title>
 117     <para>
 118       When TTY auditing is enabled, it is inherited by all processes started by
 119       that user.  In particular, daemons restarted by an user will still have
 120       TTY auditing enabled, and audit TTY input even by other users unless
 121       auditing for these users is explicitly disabled.  Therefore, it is
 122       recommended to use <option>disable=*</option> as the first option for
 123       most daemons using PAM.
 124     </para>
 125     <para>
 126       To view the data that was logged by the kernel to audit use
 127       the command <command>aureport --tty</command>.
 128     </para>
 129   </refsect1>
 130
 131   <refsect1 id='pam_tty_audit-examples'>
 132     <title>EXAMPLES</title>
 133     <para>
 134       Audit all administrative actions.
 135       <programlisting>
 136 session required pam_tty_audit.so disable=* enable=root
 137       </programlisting>
 138     </para>
 139   </refsect1>
 140
 141   <refsect1 id='pam_tty_audit-see_also'>
 142     <title>SEE ALSO</title>
 143     <para>
 144       <citerefentry>
 145         <refentrytitle>aureport</refentrytitle><manvolnum>8</manvolnum>
 146       </citerefentry>,
 147       <citerefentry>
 148         <refentrytitle>pam.conf</refentrytitle><manvolnum>5</manvolnum>
 149       </citerefentry>,
 150       <citerefentry>
 151         <refentrytitle>pam.d</refentrytitle><manvolnum>5</manvolnum>
 152       </citerefentry>,
 153       <citerefentry>
 154         <refentrytitle>pam</refentrytitle><manvolnum>8</manvolnum>
 155       </citerefentry>
 156     </para>
 157   </refsect1>
 158
 159   <refsect1 id='pam_tty_audit-author'>
 160     <title>AUTHOR</title>
 161       <para>
 162         pam_tty_audit was written by Miloslav Trma&ccaron;
 163         &lt;mitr@redhat.com&gt;.
 164       </para>
 165   </refsect1>
 166
 167 </refentry>