source/pam_smbpass/README

   1 25 Mar 2001
   2
   3 pam_smbpass is a PAM module which can be used on conforming systems to
   4 keep the smbpasswd (Samba password) database in sync with the unix
   5 password file. PAM (Pluggable Authentication Modules) is an API supported
   6 under some Unices, such as Solaris, HPUX and Linux, that provides a
   7 generic interface to authentication mechanisms.
   8
   9 For more information on PAM, see http://ftp.kernel.org/pub/linux/libs/pam/
  10
  11 This module authenticates a local smbpasswd user database.  If you require
  12 support for authenticating against a remote SMB server, or if you're
  13 concerned about the presence of suid root binaries on your system, it is
  14 recommended that you use one of the other two following modules
  15
  16   pam_smb - http://www.csn.ul.ie/~airlied/pam_smb/
  17     authenticates against any remote SMB server
  18
  19   pam_ntdom - ftp://ftp.samba.org/pub/samba/pam_ntdom/
  20     authenticates against an NT or Samba domain controller
  21
  22 Options recognized by this module are as follows:
  23
  24         debug           -       log more debugging info
  25         audit           -       like debug, but also logs unknown usernames
  26         use_first_pass  -       don't prompt the user for passwords;
  27                                 take them from PAM_ items instead
  28         try_first_pass  -       try to get the password from a previous
  29                                 PAM module, fall back to prompting the user
  30         use_authtok     -       like try_first_pass, but *fail* if the new
  31                                 PAM_AUTHTOK has not been previously set.
  32                                 (intended for stacking password modules only)
  33         not_set_pass    -       don't make passwords used by this module
  34                                 available to other modules.
  35         nodelay         -       don't insert ~1 second delays on authentication
  36                                 failure.
  37         nullok          -       null passwords are allowed.
  38         nonull          -       null passwords are not allowed. Used to
  39                                 override the Samba configuration.
  40         migrate         -       only meaningful in an "auth" context;
  41                                 used to update smbpasswd file with a
  42                                 password used for successful authentication.
  43         smbconf=<file>  -       specify an alternate path to the smb.conf
  44                                 file.
  45
  46 See the samples/ directory for example PAM configurations using this
  47 module.
  48
  49 Thanks go to the following people:
  50
  51 * Andrew Morgan <morgan@transmeta.com>, for providing the Linux-PAM
  52 framework, without which none of this would have happened
  53
  54 * Christian Gafton <gafton@redhat.com> and Andrew Morgan again, for the
  55 pam_pwdb module upon which pam_smbpass was originally based
  56
  57 * Luke Leighton <lkcl@switchboard.net> for being receptive to the idea,
  58 and for the occasional good-natured complaint about the project's status
  59 that keep me working on it :)
  60
  61 * and of course, all the other members of the Samba team
  62 <http://www.samba.org/samba/team.html>, for creating a great product
  63 and for giving this project a purpose
  64
  65 ---------------------
  66 Stephen Langasek <vorlon@netexpress.net>