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">&doc.version;</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> (where '\' character corresponds to the value of
  73                 <parameter>winbind separator</parameter> parameter). It is also possible to use a UPN in the form
  74                 <parameter>user@REALM</parameter> or <parameter>group@REALM</parameter>. pam_winbind will, in that case, lookup
  75                 the SID internally. Note that NAME may not contain any spaces. It is thus recommended to only use SIDs. You can
  76                 verify the list of SIDs a user is a member of with <command>wbinfo --user-sids=SID</command>.
  77                 This setting is empty by default.
  78                 </para>
  79                 <para>This option only operates during password authentication, and will not restrict access if a password is not required for any reason (such as SSH key-based login).</para>
  80                 </listitem>
  81                 </varlistentry>
  82
  83                 <varlistentry>
  84                 <term>try_first_pass = yes|no</term>
  85                 <listitem><para>
  86                 By default, pam_winbind tries to get the authentication token from a previous module. If no token is available
  87                 it asks the user for the old password. With this option, pam_winbind aborts with an error if no authentication
  88                 token from a previous module is available. If a primary password is not valid, PAM will prompt for a password.
  89                 Default to "no".
  90                 </para></listitem>
  91                 </varlistentry>
  92
  93                 <varlistentry>
  94                 <term>krb5_auth = yes|no</term>
  95                 <listitem><para>
  96
  97                 pam_winbind can authenticate using Kerberos when winbindd is
  98                 talking to an Active Directory domain controller. Kerberos
  99                 authentication must be enabled with this parameter. When
 100                 Kerberos authentication can not succeed (e.g. due to clock
 101                 skew), winbindd will fallback to samlogon authentication over
 102                 MSRPC. When this parameter is used in conjunction with
 103                 <parameter>winbind refresh tickets</parameter>, winbind will
 104                 keep your Ticket Granting Ticket (TGT) up-to-date by refreshing
 105                 it whenever necessary. Defaults to "no".
 106
 107                 </para></listitem>
 108                 </varlistentry>
 109
 110                 <varlistentry>
 111                 <term>krb5_ccache_type = [type]</term>
 112                 <listitem><para>
 113
 114                 When pam_winbind is configured to try kerberos authentication
 115                 by enabling the <parameter>krb5_auth</parameter> option, it can
 116                 store the retrieved Ticket Granting Ticket (TGT) in a
 117                 credential cache. The type of credential cache can be
 118                 controlled with this option.  The supported values are:
 119                 <parameter>KCM</parameter> or <parameter>KEYRING</parameter>
 120                 (when supported by the system's Kerberos library and
 121                 operating system),
 122                 <parameter>FILE</parameter> and <parameter>DIR</parameter>
 123                 (when the DIR type is supported by the system's Kerberos
 124                 library). In case of FILE a credential cache in the form of
 125                 /tmp/krb5cc_UID will be created -  in case of DIR you NEED
 126                 to specify a directory. UID is replaced with the numeric
 127                 user id. The UID directory is being created. The path up to
 128                 the directory should already exist. Check the details of the
 129                 Kerberos implmentation.</para>
 130
 131                 <para>When using the KEYRING type, the supported mechanism is
 132                 <quote>KEYRING:persistent:UID</quote>, which uses the Linux
 133                 kernel keyring to store credentials on a per-UID basis.
 134                 The KEYRING has its limitations. As it is secure kernel memory,
 135                 for example bulk sorage of credentils is for not possible.</para>
 136
 137                 <para>When using th KCM type, the supported mechanism is
 138                 <quote>KCM:UID</quote>, which uses a Kerberos credential
 139                 manaager to store credentials on a per-UID basis similar to
 140                 KEYRING. This is the recommended choice on latest Linux
 141                 distributions, offering a Kerberos Credential Manager. If not
 142                 we suggest to use KEYRING as those are the most secure and
 143                 predictable method.</para>
 144
 145                 <para>It is also possible to define custom filepaths and use the "%u"
 146                 pattern in order to substitute the numeric user id.
 147                 Examples:</para>
 148
 149                 <variablelist>
 150                         <varlistentry>
 151                                 <term>krb5_ccache_type = DIR:/run/user/%u/krb5cc</term>
 152                                         <listitem><para>This will create a credential cache file in the specified directory.</para></listitem>
 153                         </varlistentry>
 154                         <varlistentry>
 155                                 <term>krb5_ccache_type = FILE:/tmp/krb5cc_%u</term>
 156                                         <listitem><para>This will create a credential cache file.</para></listitem>
 157                         </varlistentry>
 158                 </variablelist>
 159
 160                 <para> Leave empty to just do kerberos authentication without
 161                         having a ticket cache after the logon has succeeded.
 162                         This setting is empty by default.
 163
 164                 </para></listitem>
 165                 </varlistentry>
 166
 167                 <varlistentry>
 168                 <term>cached_login = yes|no</term>
 169                 <listitem><para>
 170                 Winbind allows one 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".
 171                 </para></listitem>
 172                 </varlistentry>
 173
 174                 <varlistentry>
 175                 <term>silent = yes|no</term>
 176                 <listitem><para>
 177                 Do not emit any messages. Defaults to "no".
 178                 </para></listitem>
 179                 </varlistentry>
 180
 181                 <varlistentry>
 182                 <term>mkhomedir = yes|no</term>
 183                 <listitem><para>
 184                 Create homedirectory for a user on-the-fly, option is valid in
 185                 PAM session block. Defaults to "no".
 186                 </para></listitem>
 187                 </varlistentry>
 188
 189                 <varlistentry>
 190                 <term>warn_pwd_expire = days</term>
 191                 <listitem><para>
 192                 Defines number of days before pam_winbind starts to warn about passwords that are
 193                 going to expire. Defaults to 14 days.
 194                 </para></listitem>
 195                 </varlistentry>
 196
 197                 <varlistentry>
 198                 <term>pwd_change_prompt = yes|no</term>
 199                 <listitem><para>
 200                         Generate prompt for changing an expired password. Defaults to "no".
 201                 </para></listitem>
 202                 </varlistentry>
 203
 204                 </variablelist>
 205
 206         </para>
 207
 208 </refsect1>
 209
 210 <refsect1>
 211         <title>SEE ALSO</title>
 212         <para><citerefentry>
 213         <refentrytitle>pam_winbind</refentrytitle>
 214         <manvolnum>8</manvolnum></citerefentry>, <citerefentry>
 215         <refentrytitle>wbinfo</refentrytitle>
 216         <manvolnum>1</manvolnum></citerefentry>, <citerefentry>
 217         <refentrytitle>winbindd</refentrytitle>
 218         <manvolnum>8</manvolnum></citerefentry>, <citerefentry>
 219         <refentrytitle>smb.conf</refentrytitle>
 220         <manvolnum>5</manvolnum></citerefentry></para>
 221 </refsect1>
 222
 223 <refsect1>
 224         <title>VERSION</title>
 225
 226         <para>This man page is part of version &doc.version; of Samba.</para>
 227 </refsect1>
 228
 229 <refsect1>
 230         <title>AUTHOR</title>
 231
 232         <para>
 233         The original Samba software and related utilities were created by Andrew Tridgell. Samba is now developed by
 234         the Samba Team as an Open Source project similar to the way the Linux kernel is developed.
 235         </para>
 236
 237         <para>This manpage was written by Jelmer Vernooij and Guenther Deschner.</para>
 238
 239 </refsect1>
 240
 241 </refentry>