modules/pam_userdb/README

   1 pam_userdb — PAM module to authenticate against a db database
   2
   3 ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
   4
   5 DESCRIPTION
   6
   7 The pam_userdb module is used to verify a username/password pair against values
   8 stored in a Berkeley DB database. The database is indexed by the username, and
   9 the data fields corresponding to the username keys are the passwords.
  10
  11 OPTIONS
  12
  13 crypt=[crypt|none]
  14
  15     Indicates whether encrypted or plaintext passwords are stored in the
  16     database. If it is crypt, passwords should be stored in the database in
  17     crypt(3) form. If none is selected, passwords should be stored in the
  18     database as plaintext.
  19
  20 db=/path/database
  21
  22     Use the /path/database database for performing lookup. There is no default;
  23     the module will return PAM_IGNORE if no database is provided.
  24
  25 debug
  26
  27     Print debug information.
  28
  29 dump
  30
  31     Dump all the entries in the database to the log. Don't do this by default!
  32
  33 icase
  34
  35     Make the password verification to be case insensitive (ie when working with
  36     registration numbers and such). Only works with plaintext password storage.
  37
  38 try_first_pass
  39
  40     Use the authentication token previously obtained by another module that did
  41     the conversation with the application. If this token can not be obtained
  42     then the module will try to converse. This option can be used for stacking
  43     different modules that need to deal with the authentication tokens.
  44
  45 use_first_pass
  46
  47     Use the authentication token previously obtained by another module that did
  48     the conversation with the application. If this token can not be obtained
  49     then the module will fail. This option can be used for stacking different
  50     modules that need to deal with the authentication tokens.
  51
  52 unknown_ok
  53
  54     Do not return error when checking for a user that is not in the database.
  55     This can be used to stack more than one pam_userdb module that will check a
  56     username/password pair in more than a database.
  57
  58 key_only
  59
  60     The username and password are concatenated together in the database hash as
  61     'username-password' with a random value. if the concatenation of the
  62     username and password with a dash in the middle returns any result, the
  63     user is valid. this is useful in cases where the username may not be unique
  64     but the username and password pair are.
  65
  66 EXAMPLES
  67
  68 auth  sufficient pam_userdb.so icase db=/etc/dbtest.db
  69
  70
  71 AUTHOR
  72
  73 pam_userdb was written by Cristian Gafton >gafton@redhat.com<.
  74