docs-xml/manpages/pam_winbind.conf.5.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.conf.5">
   4
   5 <refmeta>
   6         <refentrytitle>pam_winbind.conf</refentrytitle>
   7         <manvolnum>5</manvolnum>
   8         <refmiscinfo class="source">Samba</refmiscinfo>
   9         <refmiscinfo class="manual">5</refmiscinfo>
  10         <refmiscinfo class="version">4.0</refmiscinfo>
  11 </refmeta>
  12
  13
  14 <refnamediv>
  15         <refname>pam_winbind.conf</refname>
  16         <refpurpose>Configuration file of PAM module for Winbind</refpurpose>
  17 </refnamediv>
  18
  19 <refsect1>
  20         <title>DESCRIPTION</title>
  21
  22         <para>This configuration file is part of the <citerefentry><refentrytitle>samba</refentrytitle>
  23         <manvolnum>7</manvolnum></citerefentry> suite.</para>
  24
  25         <para>
  26         pam_winbind.conf is the configuration file for the pam_winbind PAM
  27         module. See
  28         <citerefentry><refentrytitle>pam_winbind</refentrytitle><manvolnum>8</manvolnum></citerefentry>
  29         for further details.
  30         </para>
  31 </refsect1>
  32
  33 <refsect1>
  34         <title>SYNOPSIS</title>
  35
  36         <para>
  37                 The pam_winbind.conf configuration file is a classic ini-style
  38                 configuration file. There is only one section (global) where
  39                 various options are defined.
  40         </para>
  41 </refsect1>
  42
  43 <refsect1>
  44         <title>OPTIONS</title>
  45         <para>
  46
  47                 pam_winbind supports several options which can either be set in
  48                 the PAM configuration files or in the pam_winbind configuration
  49                 file situated at
  50                 <filename>/etc/security/pam_winbind.conf</filename>. Options
  51                 from the PAM configuration file take precedence to those from
  52                 the pam_winbind.conf configuration file.
  53
  54                 <variablelist>
  55
  56                 <varlistentry>
  57                 <term>debug = yes|no</term>
  58                 <listitem><para>Gives debugging output to syslog. Defaults to "no".</para></listitem>
  59                 </varlistentry>
  60
  61                 <varlistentry>
  62                 <term>debug_state = yes|no</term>
  63                 <listitem><para>Gives detailed PAM state debugging output to syslog. Defaults to "no".</para></listitem>
  64                 </varlistentry>
  65
  66                 <varlistentry>
  67                 <term>require_membership_of = [SID or NAME]</term>
  68                 <listitem><para>
  69                 If this option is set, pam_winbind will only succeed if the user is a member of the given SID or NAME. A SID
  70                 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
  71                 SID. That name must have the form: <parameter>MYDOMAIN\\mygroup</parameter> or
  72                 <parameter>MYDOMAIN\\myuser</parameter>.  pam_winbind will, in that case, lookup the SID internally. Note that
  73                 NAME may not contain any spaces. It is thus recommended to only use SIDs. You can verify the list of SIDs a
  74                 user is a member of with <command>wbinfo --user-sids=SID</command>. This setting is empty by default.
  75                 </para></listitem>
  76                 </varlistentry>
  77
  78                 <varlistentry>
  79                 <term>try_first_pass = yes|no</term>
  80                 <listitem><para>
  81                 By default, pam_winbind tries to get the authentication token from a previous module. If no token is available
  82                 it asks the user for the old password. With this option, pam_winbind aborts with an error if no authentication
  83                 token from a previous module is available. If a primary password is not valid, PAM will prompt for a password.
  84                 Default to "no".
  85                 </para></listitem>
  86                 </varlistentry>
  87
  88                 <varlistentry>
  89                 <term>krb5_auth = yes|no</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. Defaults to "no".
 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
 113                 controlled with this option.  The supported values are:
 114                 <parameter>KEYRING</parameter> (when supported by the system's
 115                 Kerberos library and Kernel), <parameter>FILE</parameter> and
 116                 <parameter>DIR</parameter> (when the DIR type is supported by
 117                 the system's Kerberos library). In case of FILE a credential
 118                 cache in the form of /tmp/krb5cc_UID will be created -  in case
 119                 of DIR you NEED to specify a directory. UID is replaced with
 120                 the numeric user id.</para>
 121
 122                 <para>When using the KEYRING type, the supported mechanism is
 123                 <quote>KEYRING:persistent:UID</quote>, which uses the Linux
 124                 kernel keyring to store credentials on a per-UID basis. This is
 125                 the recommended choice on latest Linux distributions, as it is
 126                 the most secure and predictable method.</para>
 127
 128                 <para>It is also possible to define custom filepaths and use the "%u"
 129                 pattern in order to substitue the numeric user id.
 130                 Examples:</para>
 131
 132                 <variablelist>
 133                         <varlistentry>
 134                                 <term>krb5_ccache_type = DIR:/run/user/%u/krb5cc</term>
 135                                         <listitem><para>This will create a credential cache file in the specified directory.</para></listitem>
 136                         </varlistentry>
 137                         <varlistentry>
 138                                 <term>krb5_ccache_type = FILE:/tmp/krb5cc_%u</term>
 139                                         <listitem><para>This will create a credential cache file.</para></listitem>
 140                         </varlistentry>
 141                 </variablelist>
 142
 143                 <para> Leave empty to just do kerberos authentication without
 144                         having a ticket cache after the logon has succeeded.
 145                         This setting is empty by default.
 146
 147                 </para></listitem>
 148                 </varlistentry>
 149
 150                 <varlistentry>
 151                 <term>cached_login = yes|no</term>
 152                 <listitem><para>
 153                 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. Defaults to "no".
 154                 </para></listitem>
 155                 </varlistentry>
 156
 157                 <varlistentry>
 158                 <term>silent = yes|no</term>
 159                 <listitem><para>
 160                 Do not emit any messages. Defaults to "no".
 161                 </para></listitem>
 162                 </varlistentry>
 163
 164                 <varlistentry>
 165                 <term>mkhomedir = yes|no</term>
 166                 <listitem><para>
 167                 Create homedirectory for a user on-the-fly, option is valid in
 168                 PAM session block. Defaults to "no".
 169                 </para></listitem>
 170                 </varlistentry>
 171
 172                 <varlistentry>
 173                 <term>warn_pwd_expire = days</term>
 174                 <listitem><para>
 175                 Defines number of days before pam_winbind starts to warn about passwords that are
 176                 going to expire. Defaults to 14 days.
 177                 </para></listitem>
 178                 </varlistentry>
 179
 180                 </variablelist>
 181
 182         </para>
 183
 184 </refsect1>
 185
 186 <refsect1>
 187         <title>SEE ALSO</title>
 188         <para><citerefentry>
 189         <refentrytitle>pam_winbind</refentrytitle>
 190         <manvolnum>8</manvolnum></citerefentry>, <citerefentry>
 191         <refentrytitle>wbinfo</refentrytitle>
 192         <manvolnum>1</manvolnum></citerefentry>, <citerefentry>
 193         <refentrytitle>winbindd</refentrytitle>
 194         <manvolnum>8</manvolnum></citerefentry>, <citerefentry>
 195         <refentrytitle>smb.conf</refentrytitle>
 196         <manvolnum>5</manvolnum></citerefentry></para>
 197 </refsect1>
 198
 199 <refsect1>
 200         <title>VERSION</title>
 201
 202         <para>This man page is correct for version 3 of Samba.</para>
 203 </refsect1>
 204
 205 <refsect1>
 206         <title>AUTHOR</title>
 207
 208         <para>
 209         The original Samba software and related utilities were created by Andrew Tridgell. Samba is now developed by
 210         the Samba Team as an Open Source project similar to the way the Linux kernel is developed.
 211         </para>
 212
 213         <para>This manpage was written by Jelmer Vernooij and Guenther Deschner.</para>
 214
 215 </refsect1>
 216
 217 </refentry>