Software /
code /
prosody-modules
File
mod_auth_ha1/README.markdown @ 5516:f25df3af02c1
mod_client_management: Include client software version number in listing
Should you ever wish to revoke a client by version number, e.g. for
security reasons affecting certain versions, then it would be good to at
the very least see which version is used.
Also includes the OAuth2 software ID, an optional unique identifier that
should be the same for all installations of a particular software.
author | Kim Alvefur <zash@zash.se> |
---|---|
date | Sat, 03 Jun 2023 19:21:39 +0200 |
parent | 1803:4d73a1a6ba68 |
line wrap: on
line source
--- labels: - 'Stage-Beta' - 'Type-Auth' summary: | Authentication module for 'HA1' hashed credentials in a text file, as used by reTurnServer ... 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 [here](https://github.com/resiprocate/resiprocate/blob/master/reTurn/users.txt). 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 ------ -------