"Fossies" - the Fresh Open Source Software Archive

Member "nss-pam-ldapd-0.9.12/man/pam_ldap.8.xml" (20 Nov 2021, 6785 Bytes) of package /linux/privat/nss-pam-ldapd-0.9.12.tar.gz:


As a special service "Fossies" has tried to format the requested source page into HTML format using (guessed) XML source code syntax highlighting (style: standard) with prefixed line numbers. Alternatively you can here view or download the uninterpreted source code file. See also the latest Fossies "Diffs" side-by-side code changes report for "pam_ldap.8.xml": 0.9.11_vs_0.9.12.

    1 <?xml version="1.0" encoding="utf-8"?>
    2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
    3                    "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
    4 
    5 <!--
    6    pam_ldap.8.xml - docbook manual page for pam_ldap PAM module
    7 
    8    Copyright (C) 2009-2021 Arthur de Jong
    9 
   10    This library is free software; you can redistribute it and/or
   11    modify it under the terms of the GNU Lesser General Public
   12    License as published by the Free Software Foundation; either
   13    version 2.1 of the License, or (at your option) any later version.
   14 
   15    This library is distributed in the hope that it will be useful,
   16    but WITHOUT ANY WARRANTY; without even the implied warranty of
   17    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
   18    Lesser General Public License for more details.
   19 
   20    You should have received a copy of the GNU Lesser General Public
   21    License along with this library; if not, write to the Free Software
   22    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
   23    02110-1301 USA
   24 -->
   25 
   26 <refentry id="pamldap8">
   27 
   28  <refentryinfo>
   29   <author>
   30    <firstname>Arthur</firstname>
   31    <surname>de Jong</surname>
   32   </author>
   33  </refentryinfo>
   34 
   35  <refmeta>
   36   <refentrytitle>pam_ldap</refentrytitle>
   37   <manvolnum>8</manvolnum>
   38   <refmiscinfo class="version">Version 0.9.12</refmiscinfo>
   39   <refmiscinfo class="manual">System Manager's Manual</refmiscinfo>
   40   <refmiscinfo class="date">Nov 2021</refmiscinfo>
   41  </refmeta>
   42 
   43  <refnamediv id="name">
   44   <refname>pam_ldap</refname>
   45   <refpurpose>PAM module for LDAP-based authentication</refpurpose>
   46  </refnamediv>
   47 
   48  <refsynopsisdiv id="synopsis">
   49   <cmdsynopsis>
   50    <command>pam_ldap.so</command>
   51    <arg choice="opt"><replaceable>...</replaceable></arg>
   52   </cmdsynopsis>
   53  </refsynopsisdiv>
   54 
   55  <refsect1 id="description">
   56   <title>Description</title>
   57   <para>
   58    This is a <acronym>PAM</acronym> module that uses an
   59    <acronym>LDAP</acronym> server to verify user access rights and
   60    credentials.
   61   </para>
   62  </refsect1>
   63 
   64  <refsect1 id="options">
   65   <title>Options</title>
   66   <variablelist remap="TP">
   67    <varlistentry id="use_first_pass">
   68     <term>
   69      <option>use_first_pass</option>
   70     </term>
   71     <listitem>
   72      <para>
   73       Specifies that the <acronym>PAM</acronym> module should use the first
   74       password provided in the authentication stack and not prompt the user
   75       for a password.
   76      </para>
   77     </listitem>
   78    </varlistentry>
   79    <varlistentry id="try_first_pass">
   80     <term>
   81      <option>try_first_pass</option>
   82     </term>
   83     <listitem>
   84      <para>
   85       Specifies that the <acronym>PAM</acronym> module should use the first
   86       password provided in the authentication stack and if that fails prompt
   87       the user for a password.
   88      </para>
   89     </listitem>
   90    </varlistentry>
   91    <varlistentry id="nullok">
   92     <term>
   93      <option>nullok</option>
   94     </term>
   95     <listitem>
   96      <para>
   97       Specifying this option allows users to log in with a blank password.
   98       Normally logins without a password are denied.
   99      </para>
  100     </listitem>
  101    </varlistentry>
  102    <varlistentry id="ignore_unknown_user">
  103     <term>
  104      <option>ignore_unknown_user</option>
  105     </term>
  106     <listitem>
  107      <para>
  108       Specifies that the <acronym>PAM</acronym> module should return
  109       PAM_IGNORE for users that are not present in the <acronym>LDAP</acronym>
  110       directory.
  111       This causes the <acronym>PAM</acronym> framework to ignore this module.
  112      </para>
  113     </listitem>
  114    </varlistentry>
  115    <varlistentry id="ignore_authinfo_unavail">
  116     <term>
  117      <option>ignore_authinfo_unavail</option>
  118     </term>
  119     <listitem>
  120      <para>
  121       Specifies that the <acronym>PAM</acronym> module should return
  122       PAM_IGNORE if it cannot contact the <acronym>LDAP</acronym> server.
  123       This causes the <acronym>PAM</acronym> framework to ignore this module.
  124      </para>
  125     </listitem>
  126    </varlistentry>
  127    <varlistentry id="no_warn">
  128     <term>
  129      <option>no_warn</option>
  130     </term>
  131     <listitem>
  132      <para>
  133       Specifies that warning messages should not be propagated to the
  134       <acronym>PAM</acronym> application.
  135      </para>
  136     </listitem>
  137    </varlistentry>
  138    <varlistentry id="use_authtok">
  139     <term>
  140      <option>use_authtok</option>
  141     </term>
  142     <listitem>
  143      <para>
  144       This causes the <acronym>PAM</acronym> module to use the earlier
  145       provided password when changing the password. The module will not
  146       prompt the user for a new password (it is analogous to
  147       <option>use_first_pass</option>).
  148      </para>
  149     </listitem>
  150    </varlistentry>
  151    <varlistentry id="debug">
  152     <term>
  153      <option>debug</option>
  154     </term>
  155     <listitem>
  156      <para>
  157       This option causes the <acronym>PAM</acronym> module to log debugging
  158       information to
  159       <citerefentry><refentrytitle>syslog</refentrytitle><manvolnum>3</manvolnum></citerefentry>.
  160      </para>
  161     </listitem>
  162    </varlistentry>
  163    <varlistentry id="minimum_uid">
  164     <term>
  165      <option>minimum_uid=<replaceable>UID</replaceable></option>
  166     </term>
  167     <listitem>
  168      <para>
  169       This option causes the <acronym>PAM</acronym> module to ignore the user
  170       if the user id is lower than the specified value. This can be used to
  171       bypass <acronym>LDAP</acronym> checks for system users
  172       (e.g. by setting it to <literal>1000</literal>).
  173      </para>
  174     </listitem>
  175    </varlistentry>
  176   </variablelist>
  177  </refsect1>
  178 
  179  <refsect1 id="moduleservices">
  180   <title>Module Services Provided</title>
  181   <para>
  182    All services are provided by this module but currently sessions changes
  183    are not implemented in the nslcd daemon.
  184   </para>
  185  </refsect1>
  186 
  187  <refsect1 id="files">
  188   <title>Files</title>
  189   <variablelist remap="TP">
  190    <varlistentry>
  191     <term><filename>/etc/pam.conf</filename></term>
  192     <listitem><para>the main PAM configuration file</para></listitem>
  193    </varlistentry>
  194    <varlistentry>
  195     <term><filename>/etc/nslcd.conf</filename></term>
  196     <listitem><para>
  197      The configuration file for the <command>nslcd</command> daemon
  198      (see <citerefentry><refentrytitle>nslcd.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>)
  199     </para></listitem>
  200    </varlistentry>
  201   </variablelist>
  202  </refsect1>
  203 
  204  <refsect1 id="see_also">
  205   <title>See Also</title>
  206   <para>
  207    <citerefentry><refentrytitle>pam.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
  208    <citerefentry><refentrytitle>nslcd</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
  209    <citerefentry><refentrytitle>nslcd.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>
  210   </para>
  211  </refsect1>
  212 
  213  <refsect1 id="author">
  214   <title>Author</title>
  215   <para>
  216    This manual was written by Arthur de Jong &lt;arthur@arthurdejong.org&gt;.
  217   </para>
  218  </refsect1>
  219 
  220 </refentry>