Changeset 734ef4f

Timestamp:

Apr 20, 2010, 7:24:54 PM (15 years ago)

Author:

Alex Dehnert <adehnert@…>

Branches:

master, client

Children:

e1ae8b3

Parents:

dbb39a2

git-author:

Alex Dehnert <adehnert@…> (04/20/10 19:24:54)

git-committer:

Alex Dehnert <adehnert@…> (04/20/10 19:24:54)

Message:

Add docs for SocketAuthBackend?

File:

• remit/util/SocketAuth.py (modified) (1 diff)

remit/util/SocketAuth.py

@@ -4 +4 @@
 
 class SocketAuthBackend():
+    """
+    SocketAuthBackend provides a simple way to authenticate with another process.
+
+    The protocol is simple:
+    * Open a connection to a socket.
+    * On the first line, pass the name of the operation
+    * Then, on successive lines, pass additional arguments, one per line
+    * Close the write half of the socket
+    * The authentication server sends back a reply, one tuple element
+      per line
+
+    Queries include:
+    * AUTHENTICATE(username, password) => boolean
+    * FINGER(username) => (first name, last name, email, )
+    """
     def authenticate(self, username, password, ):
         (result,) = query("AUTHENTICATE", username, password, )