Mercurial > prosody-modules

comparison mod_auth_ha1/README.markdown @ 1803:4d73a1a6ba68

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Convert all wiki pages to Markdown
author Kim Alvefur <zash@zash.se>
date Fri, 28 Aug 2015 18:03:58 +0200
parents mod_auth_ha1/README.wiki@29f3d6b7ad16
children
comparison
equal deleted inserted replaced
1802:0ab737feada6 1803:4d73a1a6ba68
1 ---
2 labels:
3 - 'Stage-Beta'
4 - 'Type-Auth'
5 summary: |
6 Authentication module for 'HA1' hashed credentials in a text file, as
7 used by reTurnServer
8 ...
9
10 Introduction
11 ============
12
13 This module authenticates users against hashed credentials stored in a
14 plain text file. The format is the same as that used by reTurnServer.
15
16 Configuration
17 =============
18
19 Name Default Description
20 ----------------- ---------- ---------------------------------
21 auth\_ha1\_file auth.txt Path to the authentication file
22
23 Prosody reads the auth file at startup and on reload (e.g. SIGHUP).
24
25 File Format
26 ===========
27
28 The file format is text, with one user per line. Each line is broken
29 into four fields separated by colons (':'):
30
31 username:ha1:host:status
32
33 Field Description
34 ---------- ----------------------------------------------------------------------------------
35 username The user's login name
36 ha1 An MD5 hash of "username:host:password"
37 host The XMPP hostname
38 status The status of the account. Prosody expects this to be just the text "authorized"
39
40 More info can be found
41 [here](https://github.com/resiprocate/resiprocate/blob/master/reTurn/users.txt).
42
43 Example
44 -------
45
46 john:2a236a1a68765361c64da3b502d4e71c:example.com:authorized
47 mary:4ed7cf9cbe81e02dbfb814de6f84edf1:example.com:authorized
48 charlie:83002e42eb4515ec0070489339f2114c:example.org:authorized
49
50 Constructing the hashes can be done manually using any MD5 utility, such
51 as md5sum. For example the user 'john' has the password 'hunter2', and
52 his hash can be calculated like this:
53
54 echo -n "john:example.com:hunter2" | md5sum -
55
56 Compatibility
57 =============
58
59 ------ -------
60 0.9 Works
61 0.10 Works
62 ------ -------