Move handler to /usr/share
[darcs-mirror-pam-dbus.git] / README
1 pam-dbus
2 ========
3
4 This simple pam module will, when being used to authenticate a (typically 
5 remote) user, use dbus to ask any currently logged in (typically local)
6 user if that is ok.
7
8 It connects to the object "de.nomeata.pam_dbus" at the path "/de/nomeata/pam_dbus",
9 expecting the "de.nomeata.pam_dbus" interface and then call the method "MayLogin".
10 It passes four strings (service, user, rhost, ruser), some of which might be NULL
11 and expectes one boolean value, which should be true if the remote user may login.
12
13 It has a timeout of 5 minutes after which the UI may stop waiting for a reply.
14
15 Configuration
16 =============
17
18 If you want all access to a certain service, (e.g ssh) to be handled by pam_dbus,
19 replace pam_unix (or @include common-auth on Debian systems) by
20
21 >>>>>>>>>snip
22 auth required pam_dbus.so
23 <<<<<<<<<<snip
24
25 in /etc/pam.d/ssh.
26
27 A more advanced configuration can be achieved with pam_succeed_if. The following
28 snippet, if put instead of "@include common-auth", will make all login requests 
29 for the user "gast" be handled by libpam_dbus, while every other request will be
30 handled as usual:
31
32 >>>>>>>>>snip
33 # gast may login using pam-dbus
34 auth [default=2 success=ignore] pam_succeed_if.so quiet user = gast
35 auth [success=ok new_authtok_reqd=done ignore=ignore default=die] pam_dbus.so
36 auth [default=1] pam_permit.so
37
38 # Standard Un*x authentication.
39 @include common-auth
40 <<<<<<<<<<snip
41
42 Credits
43 =======
44
45 pam_dbus was written by Joachim Breitner <mail@joachim-breitner>, during DebConf8,
46 having an application on the OpenMoko Freerunner in mind.