Mercurial > prosody-modules
view mod_register_web/README.md @ 6319:04c3273cb81f
mod_auth_cyrus: Add empty 'profile' table to SASL handler objects
This is for compatibility with Prosody's built-in util.sasl objects.
A SASL profile table usually includes methods supported by the backend, which
can be used by SASL mechanism handlers to perform operations (such as testing
the password). It also optionally contains a 'cb' field with channel binding
method handlers.
The Cyrus backend doesn't support channel binding, and doesn't have the same
concept of auth backend methods (it handles all that internally, and Prosody
has no insight or control over it).
Thus, we create an empty profile which informs Prosody that the SASL handler
does not support any of the auth or channel binding methods. Some features
will not work, but they didn't work anyway. This just makes it explicit.
This fixes a traceback in mod_sasl2_fast, which expected SASL handlers to
always contain a 'profile' field.
| author | Matthew Wild <mwild1@gmail.com> |
|---|---|
| date | Thu, 04 Sep 2025 10:14:46 +0100 |
| parents | fe081789f7b5 |
| children |
line wrap: on
line source
--- labels: - 'Stage-Alpha' summary: A web interface to register user accounts rockspec: build: copy_directories: - templates ... Introduction ------------ There are various reasons to prefer web registration instead of "in-band" account registration over XMPP. For example the lack of CAPTCHA support in clients and servers. Details ------- mod\_register\_web has Prosody serve a web page where users can sign up for an account. It implements reCAPTCHA to prevent automated sign-ups (from bots, etc.). Configuration ------------- The module is served on Prosody's default HTTP ports at the path `/register_web`. More details on configuring HTTP modules in Prosody can be found in our [HTTP documentation](http://prosody.im/doc/http). To configure the CAPTCHA you need to supply a 'captcha\_options' option: captcha_options = { recaptcha_private_key = "12345"; recaptcha_public_key = "78901"; } The keys for reCAPTCHA are available in your reCAPTCHA account, visit [reCAPTCHA](https://developers.google.com/recaptcha/) for more info. If no reCaptcha options are set, a simple built in captcha is used. Customization ------------- Copy the files in mod_register_web/templates/ to a new directory. Edit them, and set `register_web_template = "/path/to/your/custom-templates"` in your config file. Compatibility ------------- ----- -------------- 0.10 Works 0.9 Works 0.8 Doesn't work ----- -------------- Todo ---- Different CAPTCHA implementation support Collection of additional data, such as email address The module kept simple!