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