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