docs/manpages-3/pam_winbind.7.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.7">
   4
   5 <refmeta>
   6         <refentrytitle>pam_winbind</refentrytitle>
   7         <manvolnum>7</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>
  23         pam_winbind is a PAM module that can authenticate users against the local domain by talking to the Winbind daemon.
  24         </para>
  25
  26 </refsect1>
  27
  28 <refsect1>
  29         <title>OPTIONS</title>
  30         <para>
  31
  32                 pam_winbind supports several options which can either be set in
  33                 the PAM configuration files or in the pam_winbind configuration
  34                 file situated at
  35                 <filename>/etc/security/pam_winbind.conf</filename>. Options
  36                 from the PAM configuration file take precedence to those from
  37                 the configuration file.
  38
  39                 <variablelist>
  40
  41                 <varlistentry>
  42                 <term>debug</term>
  43                 <listitem><para>Gives debugging output to syslog.</para></listitem>
  44                 </varlistentry>
  45
  46                 <varlistentry>
  47                 <term>debug_state</term>
  48                 <listitem><para>Gives detailed PAM state debugging output to syslog.</para></listitem>
  49                 </varlistentry>
  50
  51                 <varlistentry>
  52                 <term>require_membership_of=[SID or NAME]</term>
  53                 <listitem><para>
  54                 If this option is set, pam_winbind will only succeed if the user is a member of the given SID or NAME. A SID
  55                 can be either a group-SID, an alias-SID or even an user-SID. It is also possible to give a NAME instead of the
  56                 SID. That name must have the form: <parameter>MYDOMAIN\\mygroup</parameter> or
  57                 <parameter>MYDOMAIN\\myuser</parameter>.  pam_winbind will, in that case, lookup the SID internally. Note that
  58                 NAME may not contain any spaces. It is thus recommended to only use SIDs. You can verify the list of SIDs a
  59                 user is a member of with <command>wbinfo --user-sids=SID</command>.
  60                 </para></listitem>
  61                 </varlistentry>
  62
  63                 <varlistentry>
  64                 <term>try_first_pass</term>
  65                 <listitem><para></para></listitem>
  66                 </varlistentry>
  67
  68                 <varlistentry>
  69                 <term>use_first_pass</term>
  70                 <listitem><para>
  71                 By default, pam_winbind tries to get the authentication token from a previous module. If no token is available
  72                 it asks the user for the old password. With this option, pam_winbind aborts with an error if no authentication
  73                 token from a previous module is available.
  74                 </para></listitem>
  75                 </varlistentry>
  76
  77                 <varlistentry>
  78                 <term>use_authtok</term>
  79                 <listitem><para>
  80                 Set the new password to the one provided by the previously stacked password module. If this option is not set
  81                 pam_winbind will ask the user for the new password.
  82                 </para></listitem>
  83                 </varlistentry>
  84
  85                 <varlistentry>
  86                 <term>krb5_auth</term>
  87                 <listitem><para>
  88
  89                 pam_winbind can authenticate using Kerberos when winbindd is
  90                 talking to an Active Directory domain controller. Kerberos
  91                 authentication must be enabled with this parameter. When
  92                 Kerberos authentication can not succeed (e.g. due to clock
  93                 skew), winbindd will fallback to samlogon authentication over
  94                 MSRPC. When this parameter is used in conjunction with
  95                 <parameter>winbind refresh tickets</parameter>, winbind will
  96                 keep your Ticket Granting Ticket (TGT) uptodate by refreshing
  97                 it whenever necessary.
  98
  99                 </para></listitem>
 100                 </varlistentry>
 101
 102                 <varlistentry>
 103                 <term>krb5_ccache_type=[type]</term>
 104                 <listitem><para>
 105
 106                 When pam_winbind is configured to try kerberos authentication
 107                 by enabling the <parameter>krb5_auth</parameter> option, it can
 108                 store the retrieved Ticket Granting Ticket (TGT) in a
 109                 credential cache. The type of credential cache can be set with
 110                 this option. Currently the only supported value is:
 111                 <parameter>FILE</parameter>. In that case a credential cache in
 112                 the form of /tmp/krb5cc_UID will be created, where UID is
 113                 replaced with the numeric user id.  Leave empty to just do
 114                 kerberos authentication without having a ticket cache after the
 115                 logon has succeeded.
 116
 117                 </para></listitem>
 118                 </varlistentry>
 119
 120                 <varlistentry>
 121                 <term>cached_login</term>
 122                 <listitem><para>
 123                 Winbind allows to logon using cached credentials when <parameter>winbind offline logon</parameter> is enabled. To use this feature from the PAM module this option must be set.
 124                 </para></listitem>
 125                 </varlistentry>
 126
 127                 <varlistentry>
 128                 <term>silent</term>
 129                 <listitem><para>
 130                 Do not emit any messages.
 131                 </para></listitem>
 132                 </varlistentry>
 133
 134                 </variablelist>
 135
 136
 137         </para>
 138
 139 </refsect1>
 140
 141 <refsect1>
 142         <title>SEE ALSO</title>
 143         <para><citerefentry>
 144         <refentrytitle>wbinfo</refentrytitle>
 145         <manvolnum>1</manvolnum></citerefentry>, <citerefentry>
 146         <refentrytitle>winbindd</refentrytitle>
 147         <manvolnum>8</manvolnum></citerefentry>, <citerefentry>
 148         <refentrytitle>smb.conf</refentrytitle>
 149         <manvolnum>5</manvolnum></citerefentry></para>
 150 </refsect1>
 151
 152 <refsect1>
 153         <title>VERSION</title>
 154
 155         <para>This man page is correct for version 3.0 of Samba.</para>
 156 </refsect1>
 157
 158 <refsect1>
 159         <title>AUTHOR</title>
 160
 161         <para>
 162         The original Samba software and related utilities were created by Andrew Tridgell. Samba is now developed by
 163         the Samba Team as an Open Source project similar to the way the Linux kernel is developed.
 164         </para>
 165
 166         <para>This manpage was written by Jelmer Vernooij and Guenther Deschner.</para>
 167
 168 </refsect1>
 169
 170 </refentry>