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