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.7">
6 <refentrytitle>pam_winbind</refentrytitle>
7 <manvolnum>7</manvolnum>
8 <refmiscinfo class="source">Samba</refmiscinfo>
9 <refmiscinfo class="manual">7</refmiscinfo>
10 <refmiscinfo class="version">3.5</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.
71 <listitem><para>Gives debugging output to syslog.</para></listitem>
75 <term>debug_state</term>
76 <listitem><para>Gives detailed PAM state debugging output to syslog.</para></listitem>
80 <term>require_membership_of=[SID or NAME]</term>
82 If this option is set, pam_winbind will only succeed if the user is a member of the given SID or NAME. A SID
83 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
84 SID. That name must have the form: <parameter>MYDOMAIN\\mygroup</parameter> or
85 <parameter>MYDOMAIN\\myuser</parameter>. pam_winbind will, in that case, lookup the SID internally. Note that
86 NAME may not contain any spaces. It is thus recommended to only use SIDs. You can verify the list of SIDs a
87 user is a member of with <command>wbinfo --user-sids=SID</command>.
92 <term>try_first_pass</term>
93 <listitem><para></para></listitem>
97 <term>use_first_pass</term>
99 By default, pam_winbind tries to get the authentication token from a previous module. If no token is available
100 it asks the user for the old password. With this option, pam_winbind aborts with an error if no authentication
101 token from a previous module is available.
106 <term>use_authtok</term>
108 Set the new password to the one provided by the previously stacked password module. If this option is not set
109 pam_winbind will ask the user for the new password.
114 <term>krb5_auth</term>
117 pam_winbind can authenticate using Kerberos when winbindd is
118 talking to an Active Directory domain controller. Kerberos
119 authentication must be enabled with this parameter. When
120 Kerberos authentication can not succeed (e.g. due to clock
121 skew), winbindd will fallback to samlogon authentication over
122 MSRPC. When this parameter is used in conjunction with
123 <parameter>winbind refresh tickets</parameter>, winbind will
124 keep your Ticket Granting Ticket (TGT) uptodate by refreshing
125 it whenever necessary.
131 <term>krb5_ccache_type=[type]</term>
134 When pam_winbind is configured to try kerberos authentication
135 by enabling the <parameter>krb5_auth</parameter> option, it can
136 store the retrieved Ticket Granting Ticket (TGT) in a
137 credential cache. The type of credential cache can be set with
138 this option. Currently the only supported value is:
139 <parameter>FILE</parameter>. In that case a credential cache in
140 the form of /tmp/krb5cc_UID will be created, where UID is
141 replaced with the numeric user id. Leave empty to just do
142 kerberos authentication without having a ticket cache after the
149 <term>cached_login</term>
151 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.
158 Do not emit any messages.
163 <term>mkhomedir</term>
165 Create homedirectory for a user on-the-fly, option is valid in
171 <term>warn_pwd_expire</term>
173 Defines number of days before pam_winbind starts to warn about passwords that are
174 going to expire. Defaults to 14 days.
185 <title>SEE ALSO</title>
187 <refentrytitle>wbinfo</refentrytitle>
188 <manvolnum>1</manvolnum></citerefentry>, <citerefentry>
189 <refentrytitle>winbindd</refentrytitle>
190 <manvolnum>8</manvolnum></citerefentry>, <citerefentry>
191 <refentrytitle>smb.conf</refentrytitle>
192 <manvolnum>5</manvolnum></citerefentry></para>
196 <title>VERSION</title>
198 <para>This man page is correct for version 3 of Samba.</para>
202 <title>AUTHOR</title>
205 The original Samba software and related utilities were created by Andrew Tridgell. Samba is now developed by
206 the Samba Team as an Open Source project similar to the way the Linux kernel is developed.
209 <para>This manpage was written by Jelmer Vernooij and Guenther Deschner.</para>