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">3.5</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></listitem> 91 </varlistentry> 92 93 <varlistentry> 94 <term>use_first_pass</term> 95 <listitem><para> 96 By default, pam_winbind tries to get the authentication token from a previous module. If no token is available 97 it asks the user for the old password. With this option, pam_winbind aborts with an error if no authentication 98 token from a previous module is available. 99 </para></listitem> 100 </varlistentry> 101 102 <varlistentry> 103 <term>try_first_pass</term> 104 <listitem><para> 105 Same as the use_first_pass option (previous item), except that if the primary password is not 106 valid, PAM will prompt for a password. 107 </para></listitem> 108 </varlistentry> 109 110 <varlistentry> 111 <term>use_authtok</term> 112 <listitem><para> 113 Set the new password to the one provided by the previously stacked password module. If this option is not set 114 pam_winbind will ask the user for the new password. 115 </para></listitem> 116 </varlistentry> 117 118 <varlistentry> 119 <term>krb5_auth</term> 120 <listitem><para> 121 122 pam_winbind can authenticate using Kerberos when winbindd is 123 talking to an Active Directory domain controller. Kerberos 124 authentication must be enabled with this parameter. When 125 Kerberos authentication can not succeed (e.g. due to clock 126 skew), winbindd will fallback to samlogon authentication over 127 MSRPC. When this parameter is used in conjunction with 128 <parameter>winbind refresh tickets</parameter>, winbind will 129 keep your Ticket Granting Ticket (TGT) uptodate by refreshing 130 it whenever necessary. 131 132 </para></listitem> 133 </varlistentry> 134 135 <varlistentry> 136 <term>krb5_ccache_type=[type]</term> 137 <listitem><para> 138 139 When pam_winbind is configured to try kerberos authentication 140 by enabling the <parameter>krb5_auth</parameter> option, it can 141 store the retrieved Ticket Granting Ticket (TGT) in a 142 credential cache. The type of credential cache can be set with 143 this option. Currently the only supported value is: 144 <parameter>FILE</parameter>. In that case a credential cache in 145 the form of /tmp/krb5cc_UID will be created, where UID is 146 replaced with the numeric user id. Leave empty to just do 147 kerberos authentication without having a ticket cache after the 148 logon has succeeded. 149 150 </para></listitem> 151 </varlistentry> 152 153 <varlistentry> 154 <term>cached_login</term> 155 <listitem><para> 156 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. 157 </para></listitem> 158 </varlistentry> 159 160 <varlistentry> 161 <term>silent</term> 162 <listitem><para> 163 Do not emit any messages. 164 </para></listitem> 165 </varlistentry> 166 167 <varlistentry> 168 <term>mkhomedir</term> 169 <listitem><para> 170 Create homedirectory for a user on-the-fly, option is valid in 171 PAM session block. 172 </para></listitem> 173 </varlistentry> 174 175 <varlistentry> 176 <term>warn_pwd_expire</term> 177 <listitem><para> 178 Defines number of days before pam_winbind starts to warn about passwords that are 179 going to expire. Defaults to 14 days. 180 </para></listitem> 181 </varlistentry> 182 183 </variablelist> 184 185 </para> 186 187</refsect1> 188 189<refsect1> 190 <title>PAM DATA EXPORTS</title> 191 192 <para>This section describes the data exported in the PAM stack which could be used in other PAM modules.</para> 193 194 <varlistentry> 195 <term>PAM_WINBIND_HOMEDIR</term> 196 <listitem> 197 <para> 198 This is the Windows Home Directory set in the profile tab in the user settings 199 on the Active Directory Server. This could be a local path or a directory on a 200 share mapped to a drive. 201 </para> 202 </listitem> 203 </varlistentry> 204 <varlistentry> 205 <term>PAM_WINBIND_LOGONSCRIPT</term> 206 <listitem> 207 <para> 208 The path to the logon script which should be executed if a user logs in. This is 209 normally a relative path to the script stored on the server. 210 </para> 211 </listitem> 212 </varlistentry> 213 <varlistentry> 214 <term>PAM_WINBIND_LOGONSERVER</term> 215 <listitem> 216 <para> 217 This exports the Active Directory server we are authenticating against. This can be 218 used as a variable later. 219 </para> 220 </listitem> 221 </varlistentry> 222 <varlistentry> 223 <term>PAM_WINBIND_PROFILEPATH</term> 224 <listitem> 225 <para> 226 This is the profile path set in the profile tab in the user settings. Normally 227 the home directory is synced with this directory on a share. 228 </para> 229 </listitem> 230 </varlistentry> 231</refsect1> 232 233<refsect1> 234 <title>SEE ALSO</title> 235 <para><citerefentry> 236 <refentrytitle>pam_winbind.conf</refentrytitle> 237 <manvolnum>5</manvolnum></citerefentry>, <citerefentry> 238 <refentrytitle>wbinfo</refentrytitle> 239 <manvolnum>1</manvolnum></citerefentry>, <citerefentry> 240 <refentrytitle>winbindd</refentrytitle> 241 <manvolnum>8</manvolnum></citerefentry>, <citerefentry> 242 <refentrytitle>smb.conf</refentrytitle> 243 <manvolnum>5</manvolnum></citerefentry></para> 244</refsect1> 245 246<refsect1> 247 <title>VERSION</title> 248 249 <para>This man page is correct for version 3 of Samba.</para> 250</refsect1> 251 252<refsect1> 253 <title>AUTHOR</title> 254 255 <para> 256 The original Samba software and related utilities were created by Andrew Tridgell. Samba is now developed by 257 the Samba Team as an Open Source project similar to the way the Linux kernel is developed. 258 </para> 259 260 <para>This manpage was written by Jelmer Vernooij and Guenther Deschner.</para> 261 262</refsect1> 263 264</refentry> 265