docs-xml/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         <refmiscinfo class="source">Samba</refmiscinfo>
   9         <refmiscinfo class="manual">8</refmiscinfo>
  10         <refmiscinfo class="version">4.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>SYNOPSIS</title>
  33
  34         <para>
  35                 Edit the PAM system config /etc/pam.d/service and modify it as the following example shows:
  36                 <programlisting>
  37                             ...
  38                             auth      required        pam_env.so
  39                             auth      sufficient      pam_unix2.so
  40                         +++ auth      required        pam_winbind.so  use_first_pass
  41                             account   requisite       pam_unix2.so
  42                         +++ account   required        pam_winbind.so  use_first_pass
  43                         +++ password  sufficient      pam_winbind.so
  44                             password  requisite       pam_pwcheck.so  cracklib
  45                             password  required        pam_unix2.so    use_authtok
  46                             session   required        pam_unix2.so
  47                         +++ session   required        pam_winbind.so
  48                             ...
  49                 </programlisting>
  50
  51                 Make sure that pam_winbind is one of the first modules in the session part. It may retrieve
  52                 kerberos tickets which are needed by other modules.
  53         </para>
  54 </refsect1>
  55
  56 <refsect1>
  57         <title>OPTIONS</title>
  58         <para>
  59
  60                 pam_winbind supports several options which can either be set in
  61                 the PAM configuration files or in the pam_winbind configuration
  62                 file situated at
  63                 <filename>/etc/security/pam_winbind.conf</filename>. Options
  64                 from the PAM configuration file take precedence to those from
  65                 the configuration file. See
  66                 <citerefentry><refentrytitle>pam_winbind.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>
  67                 for further details.
  68
  69                 <variablelist>
  70
  71                 <varlistentry>
  72                 <term>debug</term>
  73                 <listitem><para>Gives debugging output to syslog.</para></listitem>
  74                 </varlistentry>
  75
  76                 <varlistentry>
  77                 <term>debug_state</term>
  78                 <listitem><para>Gives detailed PAM state debugging output to syslog.</para></listitem>
  79                 </varlistentry>
  80
  81                 <varlistentry>
  82                 <term>require_membership_of=[SID or NAME]</term>
  83                 <listitem><para>
  84                 If this option is set, pam_winbind will only succeed if the user is a member of the given SID or NAME. A SID
  85                 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
  86                 SID. That name must have the form: <parameter>MYDOMAIN\\mygroup</parameter> or
  87                 <parameter>MYDOMAIN\\myuser</parameter>.  pam_winbind will, in that case, lookup the SID internally. Note that
  88                 NAME may not contain any spaces. It is thus recommended to only use SIDs. You can verify the list of SIDs a
  89                 user is a member of with <command>wbinfo --user-sids=SID</command>.
  90                 </para>
  91
  92                 <para>
  93                 This option must only be specified on a auth
  94                 module declaration, as it only operates in conjunction
  95                 with password authentication.
  96                 </para>
  97                 </listitem>
  98                 </varlistentry>
  99
 100                 <varlistentry>
 101                 <term>use_first_pass</term>
 102                 <listitem><para>
 103                 By default, pam_winbind tries to get the authentication token from a previous module. If no token is available
 104                 it asks the user for the old password. With this option, pam_winbind aborts with an error if no authentication
 105                 token from a previous module is available.
 106                 </para></listitem>
 107                 </varlistentry>
 108
 109                 <varlistentry>
 110                 <term>try_first_pass</term>
 111                 <listitem><para>
 112                                 Same as the use_first_pass option (previous item), except that if the primary password is not
 113                                 valid, PAM will prompt for a password.
 114                 </para></listitem>
 115                 </varlistentry>
 116
 117                 <varlistentry>
 118                 <term>use_authtok</term>
 119                 <listitem><para>
 120                 Set the new password to the one provided by the previously stacked password module. If this option is not set
 121                 pam_winbind will ask the user for the new password.
 122                 </para></listitem>
 123                 </varlistentry>
 124
 125                 <varlistentry>
 126                 <term>krb5_auth</term>
 127                 <listitem><para>
 128
 129                 pam_winbind can authenticate using Kerberos when winbindd is
 130                 talking to an Active Directory domain controller. Kerberos
 131                 authentication must be enabled with this parameter. When
 132                 Kerberos authentication can not succeed (e.g. due to clock
 133                 skew), winbindd will fallback to samlogon authentication over
 134                 MSRPC. When this parameter is used in conjunction with
 135                 <parameter>winbind refresh tickets</parameter>, winbind will
 136                 keep your Ticket Granting Ticket (TGT) uptodate by refreshing
 137                 it whenever necessary.
 138
 139                 </para></listitem>
 140                 </varlistentry>
 141
 142                 <varlistentry>
 143                 <term>krb5_ccache_type=[type]</term>
 144                 <listitem><para>
 145
 146                 When pam_winbind is configured to try kerberos authentication
 147                 by enabling the <parameter>krb5_auth</parameter> option, it can
 148                 store the retrieved Ticket Granting Ticket (TGT) in a
 149                 credential cache. The type of credential cache can be set with
 150                 this option. Currently the only supported value is:
 151                 <parameter>FILE</parameter>. In that case a credential cache in
 152                 the form of /tmp/krb5cc_UID will be created, where UID is
 153                 replaced with the numeric user id.  Leave empty to just do
 154                 kerberos authentication without having a ticket cache after the
 155                 logon has succeeded.
 156
 157                 </para></listitem>
 158                 </varlistentry>
 159
 160                 <varlistentry>
 161                 <term>cached_login</term>
 162                 <listitem><para>
 163                 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.
 164                 </para></listitem>
 165                 </varlistentry>
 166
 167                 <varlistentry>
 168                 <term>silent</term>
 169                 <listitem><para>
 170                 Do not emit any messages.
 171                 </para></listitem>
 172                 </varlistentry>
 173
 174                 <varlistentry>
 175                 <term>mkhomedir</term>
 176                 <listitem><para>
 177                 Create homedirectory for a user on-the-fly, option is valid in
 178                 PAM session block.
 179                 </para></listitem>
 180                 </varlistentry>
 181
 182                 <varlistentry>
 183                 <term>warn_pwd_expire</term>
 184                 <listitem><para>
 185                 Defines number of days before pam_winbind starts to warn about passwords that are
 186                 going to expire. Defaults to 14 days.
 187                 </para></listitem>
 188                 </varlistentry>
 189
 190                 </variablelist>
 191
 192         </para>
 193
 194 </refsect1>
 195
 196 <refsect1>
 197         <title>PAM DATA EXPORTS</title>
 198
 199         <para>This section describes the data exported in the PAM stack which could be used in other PAM modules.</para>
 200
 201         <varlistentry>
 202                 <term>PAM_WINBIND_HOMEDIR</term>
 203                 <listitem>
 204                         <para>
 205                                 This is the Windows Home Directory set in the profile tab in the user settings
 206                                 on the Active Directory Server. This could be a local path or a directory on a
 207                                 share mapped to a drive.
 208                         </para>
 209                 </listitem>
 210         </varlistentry>
 211         <varlistentry>
 212                 <term>PAM_WINBIND_LOGONSCRIPT</term>
 213                 <listitem>
 214                         <para>
 215                                 The path to the logon script which should be executed if a user logs in. This is
 216                                 normally a relative path to the script stored on the server.
 217                         </para>
 218                 </listitem>
 219         </varlistentry>
 220         <varlistentry>
 221                 <term>PAM_WINBIND_LOGONSERVER</term>
 222                 <listitem>
 223                         <para>
 224                                 This exports the Active Directory server we are authenticating against. This can be
 225                                 used as a variable later.
 226                         </para>
 227                 </listitem>
 228         </varlistentry>
 229         <varlistentry>
 230                 <term>PAM_WINBIND_PROFILEPATH</term>
 231                 <listitem>
 232                         <para>
 233                                 This is the profile path set in the profile tab in the user settings. Normally
 234                                 the home directory is synced with this directory on a share.
 235                         </para>
 236                 </listitem>
 237         </varlistentry>
 238 </refsect1>
 239
 240 <refsect1>
 241         <title>SEE ALSO</title>
 242         <para><citerefentry>
 243         <refentrytitle>pam_winbind.conf</refentrytitle>
 244         <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
 245         <refentrytitle>wbinfo</refentrytitle>
 246         <manvolnum>1</manvolnum></citerefentry>, <citerefentry>
 247         <refentrytitle>winbindd</refentrytitle>
 248         <manvolnum>8</manvolnum></citerefentry>, <citerefentry>
 249         <refentrytitle>smb.conf</refentrytitle>
 250         <manvolnum>5</manvolnum></citerefentry></para>
 251 </refsect1>
 252
 253 <refsect1>
 254         <title>VERSION</title>
 255
 256         <para>This man page is correct for version 3 of Samba.</para>
 257 </refsect1>
 258
 259 <refsect1>
 260         <title>AUTHOR</title>
 261
 262         <para>
 263         The original Samba software and related utilities were created by Andrew Tridgell. Samba is now developed by
 264         the Samba Team as an Open Source project similar to the way the Linux kernel is developed.
 265         </para>
 266
 267         <para>This manpage was written by Jelmer Vernooij and Guenther Deschner.</para>
 268
 269 </refsect1>
 270
 271 </refentry>