Make a branch to make krunner Good Enough For Aaron™.
[kdebase/uwolfer.git] / workspace / kcheckpass / README
blobba7cb4714184958b2aee50b46e134cfd3862b87d
1 The KCheckPass authentication software:
2 -----------------------------------------
4 KCheckPass is KDE's authentication program. It is meant to be
5 used by any software in need of user authentication, most
6 notably screensavers.
8 It enhances security be the following means:
10 - It's only a small program, which is hopefully simple enough to
11   allow it to be SUID root. Setting it to SUID root is necessary
12   on Shadow Password systems.
13 - No other program in need of user authentication, must be
14   SUID root.
15 - It provides a single implementation to check passwords. So one
16   only must take a closer look at KCheckPass to ensure password
17   security. It's much easier for programs using KCheckPass to
18   preserve security.
21 Technique:
22 ----------
23 KCheckPass is a simple password checker. Just invoke and
24 send it the password on stdin.
26 If the password was accepted, the program exits with 0;
27 if it was rejected, it exits with 1. Any other exit
28 code signals an error.
32 Compilation hints:
33 ------------------
34 Compile with -DHAVE_VSYSLOG if you have vsyslog().
35 Compile with -DHAVE_PAM if you have a PAM system, and link with -lpam -ldl
36   (If libdl is present).
37 Compile with -DHAVE_SHADOW if you have a shadow password system.
39 Copyright, Author and License notice:
40 -------------------------------------
41 Copyright (C) 1998, Caldera, Inc.
42 Released under the GNU General Public License
44 Olaf Kirch <okir@caldera.de>      General Framework and PAM support
45 Christian Esken <esken@kde.org>   Shadow and /etc/passwd support
47 Some parts were taken from kscreensaver's passwd.cpp
49 Currently this Software is maintained by Oswald Buddenhagen <ossi@kde.org>.
50 Please send new authentication modules (checkpass_*.cpp) to me.