Reformat of source only.
[tprouty/samba.git] / docs / manpages-3 / pam_winbind.7.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.7">
4
5 <refmeta>
6         <refentrytitle>pam_winbind</refentrytitle>
7         <manvolnum>7</manvolnum>
8 </refmeta>
9
10
11 <refnamediv>
12         <refname>pam_winbind</refname>
13         <refpurpose>PAM module for Winbind</refpurpose>
14 </refnamediv>
15
16 <refsect1>
17         <title>DESCRIPTION</title>
18
19         <para>This tool is part of the <citerefentry><refentrytitle>samba</refentrytitle>
20         <manvolnum>7</manvolnum></citerefentry> suite.</para>
21
22         <para>
23         pam_winbind is a PAM module that can authenticate users against the local domain by talking to the Winbind daemon.
24         </para>
25
26 </refsect1>
27
28 <refsect1>
29         <title>OPTIONS</title>
30         <para>
31                 pam_winbind supports several options:
32                 <variablelist>
33
34                 <varlistentry>
35                 <term>debug</term>
36                 <listitem><para>Gives debugging output to syslog.</para></listitem>
37                 </varlistentry>
38
39                 <varlistentry>
40                 <term>require_membership_of=[SID or NAME]</term>
41                 <listitem><para>
42                 If this option is set, pam_winbind will only succeed if the user is a member of the given SID or NAME. A SID
43                 can be either a group-SID, a alias-SID or even a user-SID. It is also possible to give a NAME instead of the
44                 SID. That name must have the form: <parameter>MYDOMAIN\mygroup</parameter> or
45                 <parameter>MYDOMAIN\myuser</parameter>.  pam_winbind will, in that case, lookup the SID internally. Note that
46                 NAME may not contain any spaces. It is thus recommended to only use SIDs. You can verify the list of SIDs a
47                 user is a member of with <command>wbinfo --user-sids=SID</command>.
48                 </para></listitem>
49                 </varlistentry>
50
51                 <varlistentry>
52                 <term>try_first_pass</term>
53                 <listitem><para></para></listitem>
54                 </varlistentry>
55
56                 <varlistentry>
57                 <term>use_first_pass</term>
58                 <listitem><para>
59                 By default, pam_winbind tries to get the authentication token from a previous module. If no token is available
60                 it asks the user for the old password. With this option, pam_winbind aborts with an error if no authentication
61                 token from a previous module is available.
62                 </para></listitem>
63                 </varlistentry>
64
65                 <varlistentry>
66                 <term>use_authtok</term>
67                 <listitem><para>
68                 Set the new password to the one provided by the previously stacked password module. If this option is not set 
69                 pam_winbind will ask the user for the new password.
70                 </para></listitem>
71                 </varlistentry>
72
73                 </variablelist>
74
75
76         </para>
77
78 </refsect1>
79
80 <refsect1>
81         <title>SEE ALSO</title>
82         <para><citerefentry>
83         <refentrytitle>wbinfo</refentrytitle>
84         <manvolnum>1</manvolnum></citerefentry>, <citerefentry>
85         <refentrytitle>winbindd</refentrytitle>
86         <manvolnum>8</manvolnum></citerefentry></para>
87 </refsect1>
88
89 <refsect1>
90         <title>VERSION</title>
91
92         <para>This man page is correct for version 3.0 of Samba.</para>
93 </refsect1>
94
95 <refsect1>
96         <title>AUTHOR</title>
97         
98         <para>
99         The original Samba software and related utilities were created by Andrew Tridgell. Samba is now developed by
100         the Samba Team as an Open Source project similar to the way the Linux kernel is developed.
101         </para>
102         
103         <para>This manpage was written by Jelmer Vernooij and Guenther Deschner.</para>
104
105 </refsect1>
106
107 </refentry>