add a readme
authorJoachim Breitner <mail@joachim-breitner.de>
Thu, 7 Aug 2008 22:11:01 +0000 (22:11 +0000)
committerJoachim Breitner <mail@joachim-breitner.de>
Thu, 7 Aug 2008 22:11:01 +0000 (22:11 +0000)
README [new file with mode: 0644]

diff --git a/README b/README
new file mode 100644 (file)
index 0000000..0d9c0d0
--- /dev/null
+++ b/README
@@ -0,0 +1,13 @@
+pam-dbus
+=======
+
+This simple pam module will, when being used to authenticate a (typically 
+remote) user, use dbus to ask any currently logged in (typically local)
+user if that is ok.
+
+It connects to the object "de.nomeata.pam_dbus" at the path "/de/nomeata/pam_dbus",
+expecting the "de.nomeata.pam_dbus" interface and then call the method "MayLogin".
+It passes four strings (service, user, rhost, ruser), some of which might be NULL
+and expectes one boolean value, which should be true if the remote user may login.
+
+It has a timeout of 5 minutes after which the UI may stop waiting for a reply.