{ "content": [ { "type": "text", "text": "# pam_userdb (man)\n\n## NAME\n\npamuserdb - PAM module to authenticate against a db database\n\n## SYNOPSIS\n\npamuserdb.so db=/path/database [debug] [crypt=[crypt|none]] [icase] [dump] [tryfirstpass]\n[usefirstpass] [unknownok] [keyonly]\n\n## DESCRIPTION\n\nThe pamuserdb module is used to verify a username/password pair against values stored in a\nBerkeley DB database. The database is indexed by the username, and the data fields\ncorresponding to the username keys are the passwords.\n\n## Sections\n\n- **NAME**\n- **SYNOPSIS**\n- **DESCRIPTION**\n- **OPTIONS** (4 subsections)\n- **MODULE TYPES PROVIDED**\n- **RETURN VALUES**\n- **EXAMPLES**\n- **SEE ALSO**\n- **AUTHOR**\n\nUse structuredContent.sections for detailed options, examples, and full documentation.\n" } ], "structuredContent": { "command": "pam_userdb", "section": "", "mode": "man", "summary": "pamuserdb - PAM module to authenticate against a db database", "synopsis": "pamuserdb.so db=/path/database [debug] [crypt=[crypt|none]] [icase] [dump] [tryfirstpass]\n[usefirstpass] [unknownok] [keyonly]", "tldr_summary": null, "tldr_examples": [], "tldr_source": null, "flags": [], "examples": [ "auth sufficient pamuserdb.so icase db=/etc/dbtest" ], "see_also": [ { "name": "crypt", "section": "3", "url": "https://www.chedong.com/phpMan.php/man/crypt/3/json" }, { "name": "pam.conf", "section": "5", "url": "https://www.chedong.com/phpMan.php/man/pam.conf/5/json" }, { "name": "pam.d", "section": "5", "url": "https://www.chedong.com/phpMan.php/man/pam.d/5/json" }, { "name": "pam", "section": "7", "url": "https://www.chedong.com/phpMan.php/man/pam/7/json" } ], "section_outline": [ { "name": "NAME", "lines": 2, "subsections": [] }, { "name": "SYNOPSIS", "lines": 3, "subsections": [] }, { "name": "DESCRIPTION", "lines": 4, "subsections": [] }, { "name": "OPTIONS", "lines": 1, "subsections": [ { "name": "crypt=[crypt|none]", "lines": 9 }, { "name": "debug", "lines": 2 }, { "name": "dump", "lines": 2 }, { "name": "icase", "lines": 26 } ] }, { "name": "MODULE TYPES PROVIDED", "lines": 2, "subsections": [] }, { "name": "RETURN VALUES", "lines": 21, "subsections": [] }, { "name": "EXAMPLES", "lines": 3, "subsections": [] }, { "name": "SEE ALSO", "lines": 2, "subsections": [] }, { "name": "AUTHOR", "lines": 5, "subsections": [] } ], "sections": { "NAME": { "content": "pamuserdb - PAM module to authenticate against a db database\n", "subsections": [] }, "SYNOPSIS": { "content": "pamuserdb.so db=/path/database [debug] [crypt=[crypt|none]] [icase] [dump] [tryfirstpass]\n[usefirstpass] [unknownok] [keyonly]\n", "subsections": [] }, "DESCRIPTION": { "content": "The pamuserdb module is used to verify a username/password pair against values stored in a\nBerkeley DB database. The database is indexed by the username, and the data fields\ncorresponding to the username keys are the passwords.\n", "subsections": [] }, "OPTIONS": { "content": "", "subsections": [ { "name": "crypt=[crypt|none]", "content": "Indicates whether encrypted or plaintext passwords are stored in the database. If it is\ncrypt, passwords should be stored in the database in crypt(3) form. If none is selected,\npasswords should be stored in the database as plaintext.\n\ndb=/path/database\nUse the /path/database database for performing lookup. There is no default; the module\nwill return PAMIGNORE if no database is provided. Note that the path to the database\nfile should be specified without the .db suffix.\n" }, { "name": "debug", "content": "Print debug information.\n" }, { "name": "dump", "content": "Dump all the entries in the database to the log. Don't do this by default!\n" }, { "name": "icase", "content": "Make the password verification to be case insensitive (ie when working with registration\nnumbers and such). Only works with plaintext password storage.\n\ntryfirstpass\nUse the authentication token previously obtained by another module that did the\nconversation with the application. If this token can not be obtained then the module will\ntry to converse. This option can be used for stacking different modules that need to deal\nwith the authentication tokens.\n\nusefirstpass\nUse the authentication token previously obtained by another module that did the\nconversation with the application. If this token can not be obtained then the module will\nfail. This option can be used for stacking different modules that need to deal with the\nauthentication tokens.\n\nunknownok\nDo not return error when checking for a user that is not in the database. This can be\nused to stack more than one pamuserdb module that will check a username/password pair in\nmore than a database.\n\nkeyonly\nThe username and password are concatenated together in the database hash as\n'username-password' with a random value. if the concatenation of the username and\npassword with a dash in the middle returns any result, the user is valid. this is useful\nin cases where the username may not be unique but the username and password pair are.\n" } ] }, "MODULE TYPES PROVIDED": { "content": "The auth and account module types are provided.\n", "subsections": [] }, "RETURN VALUES": { "content": "PAMAUTHERR\nAuthentication failure.\n\nPAMAUTHTOKRECOVERYERR\nAuthentication information cannot be recovered.\n\nPAMBUFERR\nMemory buffer error.\n\nPAMCONVERR\nConversation failure.\n\nPAMSERVICEERR\nError in service module.\n\nPAMSUCCESS\nSuccess.\n\nPAMUSERUNKNOWN\nUser not known to the underlying authentication module.\n", "subsections": [] }, "EXAMPLES": { "content": "auth sufficient pamuserdb.so icase db=/etc/dbtest\n\n", "subsections": [] }, "SEE ALSO": { "content": "crypt(3), pam.conf(5), pam.d(5), pam(7)\n", "subsections": [] }, "AUTHOR": { "content": "pamuserdb was written by Cristian Gafton >gafton@redhat.com<.\n\n\n\nLinux-PAM Manual 06/08/2020 PAMUSERDB(8)", "subsections": [] } } } }