summaryrefslogtreecommitdiff
path: root/docs/manpages/pam_winbind.8.xml
blob: 8f8150ec23dff226bb2013c3d77bea81c06f16b4 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
				  
<!ENTITY % globalentities SYSTEM '../entities/global.entities'> %globalentities;
]>
<refentry id="pam_winbind.8">

<refmeta>
	<refentrytitle>pam_winbind</refentrytitle>
	<manvolnum>8</manvolnum>
</refmeta>


<refnamediv>
	<refname>pam_winbind</refname>
	<refpurpose>PAM module for Winbind</refpurpose>
</refnamediv>

<refsect1>
	<title>DESCRIPTION</title>

	<para>This tool is part of the <citerefentry><refentrytitle>samba</refentrytitle>
	<manvolnum>7</manvolnum></citerefentry> suite.</para>

	<para>pam_winbind is a PAM module that can authenticate users against the local domain 
	by talking to the Winbind daemon.</para>

</refsect1>

<refsect1>
	<title>OPTIONS</title>
	<para>
		pam_winbind supports several options:
		<variablelist>

		<varlistentry>
		<term>debug</term>
		<listitem><para>Gives debugging output to syslog.</para></listitem>
		</varlistentry>

		<varlistentry>
		<term>require_membership_of=[SID or NAME]</term>
		<listitem><para>
		If this option is set, pam_winbind will only succeed if the
		user is a member of the given SID or NAME. A SID 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
		SID. That name must have the form: <parameter>MYDOMAIN\mygroup</parameter> or
		<parameter>MYDOMAIN\myuser</parameter>.  pam_winbind will, in that case, lookup
		the SID internally. Note that NAME may not contain any spaces. It is thus 
		recommended to only use SIDs. You can verify the list of SIDs a user is a member 
		of with <command>wbinfo --user-sids=SID</command>.
		</para></listitem>
		</varlistentry>

		<varlistentry>
		<term>try_first_pass</term>
		<listitem><para></para></listitem>
		</varlistentry>

		<varlistentry>
		<term>use_first_pass</term>
		<listitem><para>
		By default, pam_winbind tries to get the
		authentication token from a previous module. If no token is available it asks the user
		for the old password. With this option, pam_winbind aborts with an
		error if no authentication token from a previous module is available.
		</para></listitem>
		</varlistentry>

		<varlistentry>
		<term>use_authtok</term>
		<listitem><para>
		Set the new password to the one provided by the previously
		stacked password module. If this option is not set pam_winbind will ask the
		user for the new password.
		</para></listitem>
		</varlistentry>

		</variablelist>


	</para>

</refsect1>

<refsect1>
	<title>SEE ALSO</title>
	<para><citerefentry>
	<refentrytitle>wbinfo</refentrytitle>
	<manvolnum>1</manvolnum></citerefentry>, <citerefentry>
	<refentrytitle>winbindd</refentrytitle>
	<manvolnum>8</manvolnum></citerefentry></para>
</refsect1>

<refsect1>
	<title>VERSION</title>

	<para>This man page is correct for version 3.0 of Samba.</para>
</refsect1>

<refsect1>
	<title>AUTHOR</title>
	
	<para>The original Samba software and related utilities 
	were created by Andrew Tridgell. Samba is now developed
	by the Samba Team as an Open Source project similar 
	to the way the Linux kernel is developed.</para>
	
	<para>This manpage was written by Jelmer Vernooij and Guenther Deschner.</para>

</refsect1>

</refentry>