--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mod_auth_ha1/README.wiki	Mon Aug 24 16:43:56 2015 +0200
@@ -0,0 +1,47 @@
+#summary Authentication module for 'HA1' hashed credentials in a text file, as used by reTurnServer
+#labels Stage-Beta,Type-Auth
+
+= Introduction =
+
+This module authenticates users against hashed credentials stored in a plain text file. The format is the same as that used by reTurnServer.
+
+= Configuration =
+
+|| *Name* || *Default* || *Description* ||
+|| auth_ha1_file || auth.txt || Path to the authentication file||
+
+Prosody reads the auth file at startup and on reload (e.g. SIGHUP).
+
+= File Format =
+
+The file format is text, with one user per line. Each line is broken into four fields separated by colons (':'):
+
+{{{
+username:ha1:host:status
+}}}
+
+|| *Field* || *Description* ||
+||username||The user's login name||
+||ha1||An MD5 hash of "username:host:password"||
+||host||The XMPP hostname||
+||status||The status of the account. Prosody expects this to be just the text "authorized"||
+
+More info can be found [https://github.com/resiprocate/resiprocate/blob/master/reTurn/users.txt here].
+
+== Example ==
+
+{{{
+john:2a236a1a68765361c64da3b502d4e71c:example.com:authorized
+mary:4ed7cf9cbe81e02dbfb814de6f84edf1:example.com:authorized
+charlie:83002e42eb4515ec0070489339f2114c:example.org:authorized
+}}}
+
+Constructing the hashes can be done manually using any MD5 utility, such as md5sum. For example the user 'john' has the password 'hunter2', and his hash can be calculated like this:
+
+{{{
+echo -n "john:example.com:hunter2" | md5sum -
+}}}
+
+= Compatibility =
+||0.9||Works||
+||0.10||Works||
\ No newline at end of file