MUC http auth #894
Merged
MUC http auth #894
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Member
chrzaszcz
commented
Jul 28, 2016
•
chrzaszcz
commented
- generic way of managing pools of outgoing http connections
- an option to enable checking passwords for password-protected rooms by an external HTTP service
Notes:
- the module has to be started before any modules using the connections
- ‘ejabberd_auth_http’ and ‘mod_http_notification’ modules will use
this module in the future.
To enable the module, add the corresponding config to ejabberd.cfg, eg.
{mod_http_client, [{pools, [{pool1, [{host, “http://host.com”},
{pool_size, 100}]
}]
}
This should be added before any module using the pool.
To enable, set the following options in ejabberd.cfg
1. Enable ‘mod_http_client’, specifying a connection pool:
{mod_http_client, [{pools, [{muc_http_auth, [{host, "http://localhost:8080"},
{path_prefix, "/muc/auth/"},
{pool_size, 20}]}
The above config has to occur before the MUC config to provide the pool
when the MUC module starts.
For details, see the ‘mod_http_client’ module.
2. Use the pool in MUC config:
{mod_muc, [{host, "muc.@host@"},
{access, muc},
{access_create, muc_create},
{http_auth_pool, muc_http_auth}]}
As a result, all rooms will:
- become password-protected by default
- call the external HTTP service instead of checking the configured
password, whenever a new user enters the room
The external HTTP service has to respond with:
- code 200 and body ‘true’ when the password is accepted;
- code 200 and other body when the password is rejected - the body will
be sent back to the entity in the XMPP error response in the <text>
element
- other code when an error occurs, this will result in a
‘service-unavailable’ XMPP error
Also make overflow configurable and add tests for mod_http_client
Motivation:
* Tests using the same server configuration can be run in parallel,
* Adding basic features like parsing GET/POST requests
was like reinventing the wheel.
chrzaszcz
force-pushed
the
muc_http_auth
branch
from
1ac6bbe
to
934ed82
Compare
| %% API | ||
|
|
||
| start_link([Host, Opts]) -> | ||
| fusco:start_link(Host, Opts). |
There was a problem hiding this comment.
Can we use fusco directly and not through this short module? Or is there a plan to add more functionality to this module?
This prevents race condition when another user would step in while the owner is still authenticating.
Motivation: * In case of multiple hosts one pool per host is not efficient * The module would need to be started first, complicating module deps * Riak connectivity layer was not a module * ejabberd.cfg is easier to understand without the extra module
(copy from small tests, maybe improve it later)
| #pool{name = Name, | ||
| host = Host, | ||
| http_host = gen_mod:get_opt(host, Opts, "http://localhost"), |
There was a problem hiding this comment.
I guess the http(s):// prefix is required here. If so I'd rather call the option URL instead of host. For me host refers only to the part of URL after the prefix and before first /.
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.