docs/manpages/pam_winbind.8.xml

   1 <?xml version="1.0" encoding="iso-8859-1"?>
   2 <!DOCTYPE refentry PUBLIC "-//Samba-Team//DTD DocBook V4.2-Based Variant V1.0//EN" "http://www.samba.org/samba/DTD/samba-doc">
   3 <refentry id="pam_winbind.8">
   4
   5 <refmeta>
   6         <refentrytitle>pam_winbind</refentrytitle>
   7         <manvolnum>8</manvolnum>
   8 </refmeta>
   9
  10
  11 <refnamediv>
  12         <refname>pam_winbind</refname>
  13         <refpurpose>PAM module for Winbind</refpurpose>
  14 </refnamediv>
  15
  16 <refsect1>
  17         <title>DESCRIPTION</title>
  18
  19         <para>This tool is part of the <citerefentry><refentrytitle>samba</refentrytitle>
  20         <manvolnum>7</manvolnum></citerefentry> suite.</para>
  21
  22         <para>pam_winbind is a PAM module that can authenticate users against the local domain
  23         by talking to the Winbind daemon.</para>
  24
  25 </refsect1>
  26
  27 <refsect1>
  28         <title>OPTIONS</title>
  29         <para>
  30                 pam_winbind supports several options:
  31                 <variablelist>
  32
  33                 <varlistentry>
  34                 <term>debug</term>
  35                 <listitem><para>Gives debugging output to syslog.</para></listitem>
  36                 </varlistentry>
  37
  38                 <varlistentry>
  39                 <term>require_membership_of=[SID or NAME]</term>
  40                 <listitem><para>
  41                 If this option is set, pam_winbind will only succeed if the
  42                 user is a member of the given SID or NAME. A SID can be either a group-SID, a
  43                 alias-SID or even a user-SID. It is also possible to give a NAME instead of the
  44                 SID. That name must have the form: <parameter>MYDOMAIN\mygroup</parameter> or
  45                 <parameter>MYDOMAIN\myuser</parameter>.  pam_winbind will, in that case, lookup
  46                 the SID internally. Note that NAME may not contain any spaces. It is thus
  47                 recommended to only use SIDs. You can verify the list of SIDs a user is a member
  48                 of with <command>wbinfo --user-sids=SID</command>.
  49                 </para></listitem>
  50                 </varlistentry>
  51
  52                 <varlistentry>
  53                 <term>try_first_pass</term>
  54                 <listitem><para></para></listitem>
  55                 </varlistentry>
  56
  57                 <varlistentry>
  58                 <term>use_first_pass</term>
  59                 <listitem><para>
  60                 By default, pam_winbind tries to get the
  61                 authentication token from a previous module. If no token is available it asks the user
  62                 for the old password. With this option, pam_winbind aborts with an
  63                 error if no authentication token from a previous module is available.
  64                 </para></listitem>
  65                 </varlistentry>
  66
  67                 <varlistentry>
  68                 <term>use_authtok</term>
  69                 <listitem><para>
  70                 Set the new password to the one provided by the previously
  71                 stacked password module. If this option is not set pam_winbind will ask the
  72                 user for the new password.
  73                 </para></listitem>
  74                 </varlistentry>
  75
  76                 </variablelist>
  77
  78
  79         </para>
  80
  81 </refsect1>
  82
  83 <refsect1>
  84         <title>SEE ALSO</title>
  85         <para><citerefentry>
  86         <refentrytitle>wbinfo</refentrytitle>
  87         <manvolnum>1</manvolnum></citerefentry>, <citerefentry>
  88         <refentrytitle>winbindd</refentrytitle>
  89         <manvolnum>8</manvolnum></citerefentry></para>
  90 </refsect1>
  91
  92 <refsect1>
  93         <title>VERSION</title>
  94
  95         <para>This man page is correct for version 3.0 of Samba.</para>
  96 </refsect1>
  97
  98 <refsect1>
  99         <title>AUTHOR</title>
 100
 101         <para>The original Samba software and related utilities
 102         were created by Andrew Tridgell. Samba is now developed
 103         by the Samba Team as an Open Source project similar
 104         to the way the Linux kernel is developed.</para>
 105
 106         <para>This manpage was written by Jelmer Vernooij and Guenther Deschner.</para>
 107
 108 </refsect1>
 109
 110 </refentry>