granicus.if.org Git - linux-pam/blob - modules/pam_rhosts/pam_rhosts.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_rhosts">
   6
   7   <refmeta>
   8     <refentrytitle>pam_rhosts</refentrytitle>
   9     <manvolnum>8</manvolnum>
  10     <refmiscinfo class="sectdesc">Linux-PAM Manual</refmiscinfo>
  11   </refmeta>
  12
  13   <refnamediv id="pam_rhosts-name">
  14     <refname>pam_rhosts</refname>
  15     <refpurpose>The rhosts PAM module</refpurpose>
  16   </refnamediv>
  17
  18   <refsynopsisdiv>
  19     <cmdsynopsis id="pam_rhosts-cmdsynopsis">
  20       <command>pam_rhosts.so</command>
  21     </cmdsynopsis>
  22   </refsynopsisdiv>
  23
  24   <refsect1 id="pam_rhosts-description">
  25
  26     <title>DESCRIPTION</title>
  27
  28     <para>
  29       This module performs the standard network authentication for services,
  30       as used by traditional implementations of <command>rlogin</command>
  31       and <command>rsh</command> etc.
  32     </para>
  33     <para>
  34       The authentication mechanism of this module is based on the contents
  35       of two files; <filename>/etc/hosts.equiv</filename> (or
  36       and <filename>~/.rhosts</filename>. Firstly, hosts listed in the
  37       former file are treated as equivalent to the localhost. Secondly,
  38       entries in the user's own copy of the latter file is used to map
  39       "<emphasis>remote-host remote-user</emphasis>" pairs to that user's
  40       account on the current host. Access is granted to the user if their
  41       host is present in <filename>/etc/hosts.equiv</filename> and their
  42       remote account is identical to their local one, or if their remote
  43       account has an entry in their personal configuration file.
  44     </para>
  45     <para>
  46       The module authenticates a remote user (internally specified by the
  47       item <parameter>PAM_RUSER</parameter> connecting from the remote
  48       host (internally specified by the item <command>PAM_RHOST</command>).
  49       Accordingly, for applications to be compatible this authentication
  50       module they must set these items prior to calling
  51       <function>pam_authenticate()</function>.  The module is not capable
  52       of independently probing the network connection for such information.
  53     </para>
  54   </refsect1>
  55
  56   <refsect1 id="pam_rhosts-options">
  57     <title>OPTIONS</title>
  58     <variablelist>
  59       <varlistentry>
  60         <term>
  61           <option>debug</option>
  62         </term>
  63         <listitem>
  64           <para>
  65             Print debug information.
  66           </para>
  67         </listitem>
  68       </varlistentry>
  69       <varlistentry>
  70         <term>
  71           <option>silent</option>
  72         </term>
  73         <listitem>
  74           <para>
  75             Don't print informative messages.
  76           </para>
  77         </listitem>
  78       </varlistentry>
  79       <varlistentry>
  80         <term>
  81           <option>superuser=<replaceable>account</replaceable></option>
  82         </term>
  83         <listitem>
  84           <para>
  85             Handle <replaceable>account</replaceable> as root.
  86           </para>
  87         </listitem>
  88       </varlistentry>
  89     </variablelist>
  90   </refsect1>
  91
  92   <refsect1 id="pam_rhosts-types">
  93     <title>MODULE TYPES PROVIDED</title>
  94     <para>
  95       Only the <option>auth</option> module type is provided.
  96     </para>
  97   </refsect1>
  98
  99   <refsect1 id='pam_rhosts-return_values'>
 100     <title>RETURN VALUES</title>
 101     <variablelist>
 102       <varlistentry>
 103       <term>PAM_AUTH_ERR</term>
 104         <listitem>
 105           <para>
 106             The remote host, remote user name or the local user name
 107             couldn't be determined or access was denied by
 108             <filename>.rhosts</filename> file.
 109           </para>
 110         </listitem>
 111       </varlistentry>
 112       <varlistentry>
 113         <term>PAM_USER_UNKNOWN</term>
 114         <listitem>
 115           <para>
 116             User is not known to system.
 117           </para>
 118         </listitem>
 119       </varlistentry>
 120     </variablelist>
 121   </refsect1>
 122
 123   <refsect1 id='pam_rhosts-examples'>
 124     <title>EXAMPLES</title>
 125     <para>
 126       To grant a remote user access by <filename>/etc/hosts.equiv</filename>
 127       or <filename>.rhosts</filename> for <command>rsh</command> add the
 128       following lines to <filename>/etc/pam.d/rsh</filename>:
 129       <programlisting>
 130 #%PAM-1.0
 131 #
 132 auth     required       pam_rhosts.so
 133 auth     required       pam_nologin.so
 134 auth     required       pam_env.so
 135 auth     required       pam_unix.so
 136       </programlisting>
 137     </para>
 138   </refsect1>
 139
 140   <refsect1 id='pam_rhosts-see_also'>
 141     <title>SEE ALSO</title>
 142     <para>
 143       <citerefentry>
 144         <refentrytitle>rootok</refentrytitle><manvolnum>3</manvolnum>
 145       </citerefentry>,
 146       <citerefentry>
 147         <refentrytitle>hosts.equiv</refentrytitle><manvolnum>5</manvolnum>
 148       </citerefentry>,
 149       <citerefentry>
 150         <refentrytitle>rhosts</refentrytitle><manvolnum>5</manvolnum>
 151       </citerefentry>,
 152       <citerefentry>
 153         <refentrytitle>pam.conf</refentrytitle><manvolnum>5</manvolnum>
 154       </citerefentry>,
 155       <citerefentry>
 156         <refentrytitle>pam.d</refentrytitle><manvolnum>5</manvolnum>
 157       </citerefentry>,
 158       <citerefentry>
 159         <refentrytitle>pam</refentrytitle><manvolnum>8</manvolnum>
 160       </citerefentry>
 161     </para>
 162   </refsect1>
 163
 164   <refsect1 id='pam_rhosts-author'>
 165     <title>AUTHOR</title>
 166       <para>
 167         pam_rhosts was written by Thorsten Kukuk &lt;kukuk@thkukuk.de&gt;
 168       </para>
 169   </refsect1>
 170
 171 </refentry>