blob: ba9715264ba6514df7bdbd3de41e65f257e07f4a (
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
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
|
<?xml version="1.0" encoding='UTF-8'?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd">
<refentry id="pam_userdb">
<refmeta>
<refentrytitle>pam_userdb</refentrytitle>
<manvolnum>8</manvolnum>
<refmiscinfo class="sectdesc">Linux-PAM Manual</refmiscinfo>
</refmeta>
<refnamediv id="pam_userdb-name">
<refname>pam_userdb</refname>
<refpurpose>PAM module to authenticate against a db database</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis id="pam_userdb-cmdsynopsis">
<command>pam_userdb.so</command>
<arg choice="plain">
db=<replaceable>/path/database</replaceable>
</arg>
<arg choice="opt">
debug
</arg>
<arg choice="opt">
crypt=[crypt|none]
</arg>
<arg choice="opt">
icase
</arg>
<arg choice="opt">
dump
</arg>
<arg choice="opt">
try_first_pass
</arg>
<arg choice="opt">
use_first_pass
</arg>
<arg choice="opt">
unknown_ok
</arg>
<arg choice="opt">
key_only
</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1 id="pam_userdb-description">
<title>DESCRIPTION</title>
<para>
The pam_userdb module is used to verify a username/password pair
against values stored in a Berkeley DB database. The database is
indexed by the username, and the data fields corresponding to the
username keys are the passwords.
</para>
</refsect1>
<refsect1 id="pam_userdb-options">
<title>OPTIONS</title>
<variablelist>
<varlistentry>
<term>
<option>crypt=[crypt|none]</option>
</term>
<listitem>
<para>
Indicates whether encrypted or plaintext passwords are stored
in the database. If it is <option>crypt</option>, passwords
should be stored in the database in
<citerefentry>
<refentrytitle>crypt</refentrytitle><manvolnum>3</manvolnum>
</citerefentry> form. If <option>none</option> is selected,
passwords should be stored in the database as plaintext.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>db=<replaceable>/path/database</replaceable></option>
</term>
<listitem>
<para>
Use the <filename>/path/database</filename> database for
performing lookup. There is no default; the module will
return <emphasis remap='B'>PAM_IGNORE</emphasis> if no
database is provided.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>debug</option>
</term>
<listitem>
<para>
Print debug information.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>dump</option>
</term>
<listitem>
<para>
Dump all the entries in the database to the log.
Don't do this by default!
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>icase</option>
</term>
<listitem>
<para>
Make the password verification to be case insensitive
(ie when working with registration numbers and such).
Only works with plaintext password storage.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>try_first_pass</option>
</term>
<listitem>
<para>
Use the authentication token previously obtained by
another module that did the conversation with the
application. If this token can not be obtained then
the module will try to converse. This option can
be used for stacking different modules that need to
deal with the authentication tokens.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>use_first_pass</option>
</term>
<listitem>
<para>
Use the authentication token previously obtained by
another module that did the conversation with the
application. If this token can not be obtained then
the module will fail. This option can be used for
stacking different modules that need to deal with
the authentication tokens.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>unknown_ok</option>
</term>
<listitem>
<para>
Do not return error when checking for a user that is
not in the database. This can be used to stack more
than one pam_userdb module that will check a
username/password pair in more than a database.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>key_only</option>
</term>
<listitem>
<para>
The username and password are concatenated together
in the database hash as 'username-password' with a
random value. if the concatenation of the username and
password with a dash in the middle returns any result,
the user is valid. this is useful in cases where
the username may not be unique but the username and
password pair are.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 id="pam_userdb-types">
<title>MODULE TYPES PROVIDED</title>
<para>
The <option>auth</option> and <option>account</option> module
types are provided.
</para>
</refsect1>
<refsect1 id='pam_userdb-return_values'>
<title>RETURN VALUES</title>
<variablelist>
<varlistentry>
<term>PAM_AUTH_ERR</term>
<listitem>
<para>Authentication failure.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>PAM_AUTHTOK_RECOVERY_ERR</term>
<listitem>
<para>
Authentication information cannot be recovered.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>PAM_BUF_ERR</term>
<listitem>
<para>
Memory buffer error.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>PAM_CONV_ERR</term>
<listitem>
<para>
Conversation failure.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>PAM_SERVICE_ERR</term>
<listitem>
<para>
Error in service module.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>PAM_SUCCESS</term>
<listitem>
<para>
Success.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>PAM_USER_UNKNOWN</term>
<listitem>
<para>
User not known to the underlying authentication module.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 id='pam_userdb-examples'>
<title>EXAMPLES</title>
<programlisting>
auth sufficient pam_userdb.so icase db=/etc/dbtest.db
</programlisting>
</refsect1>
<refsect1 id='pam_userdb-see_also'>
<title>SEE ALSO</title>
<para>
<citerefentry>
<refentrytitle>crypt</refentrytitle><manvolnum>3</manvolnum>
</citerefentry>,
<citerefentry>
<refentrytitle>pam.conf</refentrytitle><manvolnum>5</manvolnum>
</citerefentry>,
<citerefentry>
<refentrytitle>pam.d</refentrytitle><manvolnum>5</manvolnum>
</citerefentry>,
<citerefentry>
<refentrytitle>pam</refentrytitle><manvolnum>8</manvolnum>
</citerefentry>
</para>
</refsect1>
<refsect1 id='pam_userdb-author'>
<title>AUTHOR</title>
<para>
pam_userdb was written by Cristian Gafton >gafton@redhat.com<.
</para>
</refsect1>
</refentry>
|
