linux-pam/modules/pam_localuser/pam_localuser.8.xml
Stefan Schubert cf2fc5ff7b doc: Update PAM documentation from DockBook 4 to DocBook 5
Changed files
--------------

Make.xml.rules.in:
- Using RNG file instead of DTD file for checking XML files.
- Taking the correct stylesheet for README files.

doc/sag/Makefile.am, doc/adg/Makefile.am, doc/mwg/Makefile.am:
- Using RNG file instead of DTD file for checking XML files.

configure.ac:
- Adding a new option for selecting RNG check file (-enable-docbook-rng)
- Switching stylesheets to docbook 5
- Checking DocBook 5 environment instead of DocBook 4 environment

*.xml:
Update from DockBook 4 to DocBook 5
2022-12-16 10:31:37 +01:00

199 lines
5.2 KiB
XML

<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="pam_localuser">
<refmeta>
<refentrytitle>pam_localuser</refentrytitle>
<manvolnum>8</manvolnum>
<refmiscinfo class="source">Linux-PAM</refmiscinfo>
<refmiscinfo class="manual">Linux-PAM Manual</refmiscinfo>
</refmeta>
<refnamediv xml:id="pam_localuser-name">
<refname>pam_localuser</refname>
<refpurpose>require users to be listed in /etc/passwd</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis xml:id="pam_localuser-cmdsynopsis" sepchar=" ">
<command>pam_localuser.so</command>
<arg choice="opt" rep="norepeat">
debug
</arg>
<arg choice="opt" rep="norepeat">
file=<replaceable>/path/passwd</replaceable>
</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1 xml:id="pam_localuser-description">
<title>DESCRIPTION</title>
<para>
pam_localuser is a PAM module to help implementing site-wide login
policies, where they typically include a subset of the network's
users and a few accounts that are local to a particular workstation.
Using pam_localuser and pam_wheel or pam_listfile is an effective
way to restrict access to either local users and/or a subset of the
network's users.
</para>
<para>
This could also be implemented using pam_listfile.so and a very
short awk script invoked by cron, but it's common enough to have
been separated out.
</para>
</refsect1>
<refsect1 xml:id="pam_localuser-options">
<title>OPTIONS</title>
<para>
<variablelist>
<varlistentry>
<term>
debug
</term>
<listitem>
<para>
Print debug information.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
file=/path/passwd
</term>
<listitem>
<para>
Use a file other than <filename>/etc/passwd</filename>.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 xml:id="pam_localuser-types">
<title>MODULE TYPES PROVIDED</title>
<para>
All module types (<option>account</option>, <option>auth</option>,
<option>password</option> and <option>session</option>) are provided.
</para>
</refsect1>
<refsect1 xml:id="pam_localuser-return_values">
<title>RETURN VALUES</title>
<para>
<variablelist>
<varlistentry>
<term>PAM_SUCCESS</term>
<listitem>
<para>
The new localuser was set successfully.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>PAM_BUF_ERR</term>
<listitem>
<para>
Memory buffer error.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>PAM_CONV_ERR</term>
<listitem>
<para>
The conversation method supplied by the application
failed to obtain the username.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>PAM_INCOMPLETE</term>
<listitem>
<para>
The conversation method supplied by the application
returned PAM_CONV_AGAIN.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>PAM_SERVICE_ERR</term>
<listitem>
<para>
The user name is not valid or the passwd file is unavailable.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>PAM_PERM_DENIED</term>
<listitem>
<para>
The user is not listed in the passwd file.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 xml:id="pam_localuser-examples">
<title>EXAMPLES</title>
<para>
Add the following lines to <filename>/etc/pam.d/su</filename> to
allow only local users or group wheel to use su.
<programlisting>
account sufficient pam_localuser.so
account required pam_wheel.so
</programlisting>
</para>
</refsect1>
<refsect1 xml:id="pam_localuser-files">
<title>FILES</title>
<variablelist>
<varlistentry>
<term>/etc/passwd</term>
<listitem>
<para>Local user account information.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 xml:id="pam_localuser-see_also">
<title>SEE ALSO</title>
<para>
<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>
</para>
</refsect1>
<refsect1 xml:id="pam_localuser-author">
<title>AUTHOR</title>
<para>
pam_localuser was written by Nalin Dahyabhai &lt;nalin@redhat.com&gt;.
</para>
</refsect1>
</refentry>