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">
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.0</refmiscinfo>
15 <refname>pam_winbind</refname>
16 <refpurpose>PAM module for Winbind</refpurpose>
20 <title>DESCRIPTION</title>
22 <para>This tool is part of the <citerefentry><refentrytitle>samba</refentrytitle>
23 <manvolnum>7</manvolnum></citerefentry> suite.</para>
26 pam_winbind is a PAM module that can authenticate users against the local domain by talking to the Winbind daemon.
32 <title>SYNOPSIS</title>
35 Edit the PAM system config /etc/pam.d/service and modify it as the following example shows:
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
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.
57 <title>OPTIONS</title>
60 pam_winbind supports several options which can either be set in
61 the PAM configuration files or in the pam_winbind configuration
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>
73 <listitem><para>Gives debugging output to syslog.</para></listitem>
77 <term>debug_state</term>
78 <listitem><para>Gives detailed PAM state debugging output to syslog.</para></listitem>
82 <term>require_membership_of=[SID or NAME]</term>
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>.
94 <term>use_first_pass</term>
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.
103 <term>try_first_pass</term>
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.
111 <term>use_authtok</term>
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.
119 <term>krb5_auth</term>
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.
136 <term>krb5_ccache_type=[type]</term>
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
154 <term>cached_login</term>
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.
163 Do not emit any messages.
168 <term>mkhomedir</term>
170 Create homedirectory for a user on-the-fly, option is valid in
176 <term>warn_pwd_expire</term>
178 Defines number of days before pam_winbind starts to warn about passwords that are
179 going to expire. Defaults to 14 days.
190 <title>PAM DATA EXPORTS</title>
192 <para>This section describes the data exported in the PAM stack which could be used in other PAM modules.</para>
195 <term>PAM_WINBIND_HOMEDIR</term>
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.
205 <term>PAM_WINBIND_LOGONSCRIPT</term>
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.
214 <term>PAM_WINBIND_LOGONSERVER</term>
217 This exports the Active Directory server we are authenticating against. This can be
218 used as a variable later.
223 <term>PAM_WINBIND_PROFILEPATH</term>
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.
234 <title>SEE ALSO</title>
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>
247 <title>VERSION</title>
249 <para>This man page is correct for version 3 of Samba.</para>
253 <title>AUTHOR</title>
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.
260 <para>This manpage was written by Jelmer Vernooij and Guenther Deschner.</para>