modules/pam_userdb/pam_userdb.8

   1 .\"     Title: pam_userdb
   2 .\"    Author: [see the "AUTHOR" section]
   3 .\" Generator: DocBook XSL Stylesheets v1.74.0 <http://docbook.sf.net/>
   4 .\"      Date: 08/15/2012
   5 .\"    Manual: Linux-PAM Manual
   6 .\"    Source: Linux-PAM Manual
   7 .\"  Language: English
   8 .\"
   9 .TH "PAM_USERDB" "8" "08/15/2012" "Linux-PAM Manual" "Linux\-PAM Manual"
  10 .\" -----------------------------------------------------------------
  11 .\" * (re)Define some macros
  12 .\" -----------------------------------------------------------------
  13 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  14 .\" toupper - uppercase a string (locale-aware)
  15 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  16 .de toupper
  17 .tr aAbBcCdDeEfFgGhHiIjJkKlLmMnNoOpPqQrRsStTuUvVwWxXyYzZ
  18 \\$*
  19 .tr aabbccddeeffgghhiijjkkllmmnnooppqqrrssttuuvvwwxxyyzz
  20 ..
  21 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  22 .\" SH-xref - format a cross-reference to an SH section
  23 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  24 .de SH-xref
  25 .ie n \{\
  26 .\}
  27 .toupper \\$*
  28 .el \{\
  29 \\$*
  30 .\}
  31 ..
  32 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  33 .\" SH - level-one heading that works better for non-TTY output
  34 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  35 .de1 SH
  36 .\" put an extra blank line of space above the head in non-TTY output
  37 .if t \{\
  38 .sp 1
  39 .\}
  40 .sp \\n[PD]u
  41 .nr an-level 1
  42 .set-an-margin
  43 .nr an-prevailing-indent \\n[IN]
  44 .fi
  45 .in \\n[an-margin]u
  46 .ti 0
  47 .HTML-TAG ".NH \\n[an-level]"
  48 .it 1 an-trap
  49 .nr an-no-space-flag 1
  50 .nr an-break-flag 1
  51 \." make the size of the head bigger
  52 .ps +3
  53 .ft B
  54 .ne (2v + 1u)
  55 .ie n \{\
  56 .\" if n (TTY output), use uppercase
  57 .toupper \\$*
  58 .\}
  59 .el \{\
  60 .nr an-break-flag 0
  61 .\" if not n (not TTY), use normal case (not uppercase)
  62 \\$1
  63 .in \\n[an-margin]u
  64 .ti 0
  65 .\" if not n (not TTY), put a border/line under subheading
  66 .sp -.6
  67 \l'\n(.lu'
  68 .\}
  69 ..
  70 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  71 .\" SS - level-two heading that works better for non-TTY output
  72 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  73 .de1 SS
  74 .sp \\n[PD]u
  75 .nr an-level 1
  76 .set-an-margin
  77 .nr an-prevailing-indent \\n[IN]
  78 .fi
  79 .in \\n[IN]u
  80 .ti \\n[SN]u
  81 .it 1 an-trap
  82 .nr an-no-space-flag 1
  83 .nr an-break-flag 1
  84 .ps \\n[PS-SS]u
  85 \." make the size of the head bigger
  86 .ps +2
  87 .ft B
  88 .ne (2v + 1u)
  89 .if \\n[.$] \&\\$*
  90 ..
  91 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  92 .\" BB/BE - put background/screen (filled box) around block of text
  93 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  94 .de BB
  95 .if t \{\
  96 .sp -.5
  97 .br
  98 .in +2n
  99 .ll -2n
 100 .gcolor red
 101 .di BX
 102 .\}
 103 ..
 104 .de EB
 105 .if t \{\
 106 .if "\\$2"adjust-for-leading-newline" \{\
 107 .sp -1
 108 .\}
 109 .br
 110 .di
 111 .in
 112 .ll
 113 .gcolor
 114 .nr BW \\n(.lu-\\n(.i
 115 .nr BH \\n(dn+.5v
 116 .ne \\n(BHu+.5v
 117 .ie "\\$2"adjust-for-leading-newline" \{\
 118 \M[\\$1]\h'1n'\v'+.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[]
 119 .\}
 120 .el \{\
 121 \M[\\$1]\h'1n'\v'-.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[]
 122 .\}
 123 .in 0
 124 .sp -.5v
 125 .nf
 126 .BX
 127 .in
 128 .sp .5v
 129 .fi
 130 .\}
 131 ..
 132 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 133 .\" BM/EM - put colored marker in margin next to block of text
 134 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 135 .de BM
 136 .if t \{\
 137 .br
 138 .ll -2n
 139 .gcolor red
 140 .di BX
 141 .\}
 142 ..
 143 .de EM
 144 .if t \{\
 145 .br
 146 .di
 147 .ll
 148 .gcolor
 149 .nr BH \\n(dn
 150 .ne \\n(BHu
 151 \M[\\$1]\D'P -.75n 0 0 \\n(BHu -(\\n[.i]u - \\n(INu - .75n) 0 0 -\\n(BHu'\M[]
 152 .in 0
 153 .nf
 154 .BX
 155 .in
 156 .fi
 157 .\}
 158 ..
 159 .\" -----------------------------------------------------------------
 160 .\" * set default formatting
 161 .\" -----------------------------------------------------------------
 162 .\" disable hyphenation
 163 .nh
 164 .\" disable justification (adjust text to left margin only)
 165 .ad l
 166 .\" -----------------------------------------------------------------
 167 .\" * MAIN CONTENT STARTS HERE *
 168 .\" -----------------------------------------------------------------
 169 .SH "Name"
 170 pam_userdb \- PAM module to authenticate against a db database
 171 .SH "Synopsis"
 172 .fam C
 173 .HP \w'\fBpam_userdb\&.so\fR\ 'u
 174 \fBpam_userdb\&.so\fR db=\fI/path/database\fR [debug] [crypt=[crypt|none]] [icase] [dump] [try_first_pass] [use_first_pass] [unknown_ok] [key_only]
 175 .fam
 176 .SH "DESCRIPTION"
 177 .PP
 178 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\&.
 179 .SH "OPTIONS"
 180 .PP
 181 \fBcrypt=[crypt|none]\fR
 182 .RS 4
 183 Indicates whether encrypted or plaintext passwords are stored in the database\&. If it is
 184 \fBcrypt\fR, passwords should be stored in the database in
 185 \fBcrypt\fR(3)
 186 form\&. If
 187 \fBnone\fR
 188 is selected, passwords should be stored in the database as plaintext\&.
 189 .RE
 190 .PP
 191 \fBdb=\fR\fB\fI/path/database\fR\fR
 192 .RS 4
 193 Use the
 194 \FC/path/database\F[]
 195 database for performing lookup\&. There is no default; the module will return
 196 \fBPAM_IGNORE\fR
 197 if no database is provided\&.
 198 .RE
 199 .PP
 200 \fBdebug\fR
 201 .RS 4
 202 Print debug information\&.
 203 .RE
 204 .PP
 205 \fBdump\fR
 206 .RS 4
 207 Dump all the entries in the database to the log\&. Don\'t do this by default!
 208 .RE
 209 .PP
 210 \fBicase\fR
 211 .RS 4
 212 Make the password verification to be case insensitive (ie when working with registration numbers and such)\&. Only works with plaintext password storage\&.
 213 .RE
 214 .PP
 215 \fBtry_first_pass\fR
 216 .RS 4
 217 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\&.
 218 .RE
 219 .PP
 220 \fBuse_first_pass\fR
 221 .RS 4
 222 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\&.
 223 .RE
 224 .PP
 225 \fBunknown_ok\fR
 226 .RS 4
 227 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\&.
 228 .RE
 229 .PP
 230 \fBkey_only\fR
 231 .RS 4
 232 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\&.
 233 .RE
 234 .SH "MODULE TYPES PROVIDED"
 235 .PP
 236 The
 237 \fBauth\fR
 238 and
 239 \fBaccount\fR
 240 module types are provided\&.
 241 .SH "RETURN VALUES"
 242 .PP
 243 PAM_AUTH_ERR
 244 .RS 4
 245 Authentication failure\&.
 246 .RE
 247 .PP
 248 PAM_AUTHTOK_RECOVERY_ERR
 249 .RS 4
 250 Authentication information cannot be recovered\&.
 251 .RE
 252 .PP
 253 PAM_BUF_ERR
 254 .RS 4
 255 Memory buffer error\&.
 256 .RE
 257 .PP
 258 PAM_CONV_ERR
 259 .RS 4
 260 Conversation failure\&.
 261 .RE
 262 .PP
 263 PAM_SERVICE_ERR
 264 .RS 4
 265 Error in service module\&.
 266 .RE
 267 .PP
 268 PAM_SUCCESS
 269 .RS 4
 270 Success\&.
 271 .RE
 272 .PP
 273 PAM_USER_UNKNOWN
 274 .RS 4
 275 User not known to the underlying authentication module\&.
 276 .RE
 277 .SH "EXAMPLES"
 278 .sp
 279 .if n \{\
 280 .RS 4
 281 .\}
 282 .fam C
 283 .ps -1
 284 .nf
 285 .if t \{\
 286 .sp -1
 287 .\}
 288 .BB lightgray adjust-for-leading-newline
 289 .sp -1
 290
 291 auth  sufficient pam_userdb\&.so icase db=/etc/dbtest\&.db
 292
 293 .EB lightgray adjust-for-leading-newline
 294 .if t \{\
 295 .sp 1
 296 .\}
 297 .fi
 298 .fam
 299 .ps +1
 300 .if n \{\
 301 .RE
 302 .\}
 303 .SH "SEE ALSO"
 304 .PP
 305
 306 \fBcrypt\fR(3),
 307 \fBpam.conf\fR(5),
 308 \fBpam.d\fR(5),
 309 \fBpam\fR(8)
 310 .SH "AUTHOR"
 311 .PP
 312 pam_userdb was written by Cristian Gafton >gafton@redhat\&.com<\&.