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.2</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>
  76                 <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>
  77                 </listitem>
  78                 </varlistentry>
  79
  80                 <varlistentry>
  81                 <term>try_first_pass = yes|no</term>
  82                 <listitem><para>
  83                 By default, pam_winbind tries to get the authentication token from a previous module. If no token is available
  84                 it asks the user for the old password. With this option, pam_winbind aborts with an error if no authentication
  85                 token from a previous module is available. If a primary password is not valid, PAM will prompt for a password.
  86                 Default to "no".
  87                 </para></listitem>
  88                 </varlistentry>
  89
  90                 <varlistentry>
  91                 <term>krb5_auth = yes|no</term>
  92                 <listitem><para>
  93
  94                 pam_winbind can authenticate using Kerberos when winbindd is
  95                 talking to an Active Directory domain controller. Kerberos
  96                 authentication must be enabled with this parameter. When
  97                 Kerberos authentication can not succeed (e.g. due to clock
  98                 skew), winbindd will fallback to samlogon authentication over
  99                 MSRPC. When this parameter is used in conjunction with
 100                 <parameter>winbind refresh tickets</parameter>, winbind will
 101                 keep your Ticket Granting Ticket (TGT) uptodate by refreshing
 102                 it whenever necessary. Defaults to "no".
 103
 104                 </para></listitem>
 105                 </varlistentry>
 106
 107                 <varlistentry>
 108                 <term>krb5_ccache_type = [type]</term>
 109                 <listitem><para>
 110
 111                 When pam_winbind is configured to try kerberos authentication
 112                 by enabling the <parameter>krb5_auth</parameter> option, it can
 113                 store the retrieved Ticket Granting Ticket (TGT) in a
 114                 credential cache. The type of credential cache can be
 115                 controlled with this option.  The supported values are:
 116                 <parameter>KEYRING</parameter> (when supported by the system's
 117                 Kerberos library and Kernel), <parameter>FILE</parameter> and
 118                 <parameter>DIR</parameter> (when the DIR type is supported by
 119                 the system's Kerberos library). In case of FILE a credential
 120                 cache in the form of /tmp/krb5cc_UID will be created -  in case
 121                 of DIR you NEED to specify a directory. UID is replaced with
 122                 the numeric user id.</para>
 123
 124                 <para>When using the KEYRING type, the supported mechanism is
 125                 <quote>KEYRING:persistent:UID</quote>, which uses the Linux
 126                 kernel keyring to store credentials on a per-UID basis. This is
 127                 the recommended choice on latest Linux distributions, as it is
 128                 the most secure and predictable method.</para>
 129
 130                 <para>It is also possible to define custom filepaths and use the "%u"
 131                 pattern in order to substitue the numeric user id.
 132                 Examples:</para>
 133
 134                 <variablelist>
 135                         <varlistentry>
 136                                 <term>krb5_ccache_type = DIR:/run/user/%u/krb5cc</term>
 137                                         <listitem><para>This will create a credential cache file in the specified directory.</para></listitem>
 138                         </varlistentry>
 139                         <varlistentry>
 140                                 <term>krb5_ccache_type = FILE:/tmp/krb5cc_%u</term>
 141                                         <listitem><para>This will create a credential cache file.</para></listitem>
 142                         </varlistentry>
 143                 </variablelist>
 144
 145                 <para> Leave empty to just do kerberos authentication without
 146                         having a ticket cache after the logon has succeeded.
 147                         This setting is empty by default.
 148
 149                 </para></listitem>
 150                 </varlistentry>
 151
 152                 <varlistentry>
 153                 <term>cached_login = yes|no</term>
 154                 <listitem><para>
 155                 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".
 156                 </para></listitem>
 157                 </varlistentry>
 158
 159                 <varlistentry>
 160                 <term>silent = yes|no</term>
 161                 <listitem><para>
 162                 Do not emit any messages. Defaults to "no".
 163                 </para></listitem>
 164                 </varlistentry>
 165
 166                 <varlistentry>
 167                 <term>mkhomedir = yes|no</term>
 168                 <listitem><para>
 169                 Create homedirectory for a user on-the-fly, option is valid in
 170                 PAM session block. Defaults to "no".
 171                 </para></listitem>
 172                 </varlistentry>
 173
 174                 <varlistentry>
 175                 <term>warn_pwd_expire = days</term>
 176                 <listitem><para>
 177                 Defines number of days before pam_winbind starts to warn about passwords that are
 178                 going to expire. Defaults to 14 days.
 179                 </para></listitem>
 180                 </varlistentry>
 181
 182                 </variablelist>
 183
 184         </para>
 185
 186 </refsect1>
 187
 188 <refsect1>
 189         <title>SEE ALSO</title>
 190         <para><citerefentry>
 191         <refentrytitle>pam_winbind</refentrytitle>
 192         <manvolnum>8</manvolnum></citerefentry>, <citerefentry>
 193         <refentrytitle>wbinfo</refentrytitle>
 194         <manvolnum>1</manvolnum></citerefentry>, <citerefentry>
 195         <refentrytitle>winbindd</refentrytitle>
 196         <manvolnum>8</manvolnum></citerefentry>, <citerefentry>
 197         <refentrytitle>smb.conf</refentrytitle>
 198         <manvolnum>5</manvolnum></citerefentry></para>
 199 </refsect1>
 200
 201 <refsect1>
 202         <title>VERSION</title>
 203
 204         <para>This man page is correct for version 3 of Samba.</para>
 205 </refsect1>
 206
 207 <refsect1>
 208         <title>AUTHOR</title>
 209
 210         <para>
 211         The original Samba software and related utilities were created by Andrew Tridgell. Samba is now developed by
 212         the Samba Team as an Open Source project similar to the way the Linux kernel is developed.
 213         </para>
 214
 215         <para>This manpage was written by Jelmer Vernooij and Guenther Deschner.</para>
 216
 217 </refsect1>
 218
 219 </refentry>