Mercurial > prosody-modules

view mod_muc_ban_ip/README.markdown @ 5193:2bb29ece216b

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
mod_http_oauth2: Implement stateless dynamic client registration Replaces previous explicit registration that required either the additional module mod_adhoc_oauth2_client or manually editing the database. That method was enough to have something to test with, but would not probably not scale easily. Dynamic client registration allows creating clients on the fly, which may be even easier in theory. In order to not allow basically unauthenticated writes to the database, we implement a stateless model here. per_host_key := HMAC(config -> oauth2_registration_key, hostname) client_id := JWT { client metadata } signed with per_host_key client_secret := HMAC(per_host_key, client_id) This should ensure everything we need to know is part of the client_id, allowing redirects etc to be validated, and the client_secret can be validated with only the client_id and the per_host_key. A nonce injected into the client_id JWT should ensure nobody can submit the same client metadata and retrieve the same client_secret
author Kim Alvefur <zash@zash.se>
date Fri, 03 Mar 2023 21:14:19 +0100
parents 8de50be756e5
children
line wrap: on
line source

---
labels:
- 'Stage-Alpha'
summary: Ban users from chatrooms by their IP address
...

Introduction
============

One frequent complaint about XMPP chatrooms (MUCs) compared to IRC is
the inability for a room admin to ban a user based on their IP address.
This is because an XMPP user is not identified on the network by their
IP address, only their JID.

This means that it is possible to create a new account (usually quite
easily), and rejoin the room that you were banned from.

This module allows the **user's** server to enforce bans by IP address,
which is very desirable for server admins who want to prevent their
server being used for spamming and abusive behaviour.

Details
=======

An important point to note is that this module enforces the IP ban on
the banned user's server, not on the MUC server. This means that:

-   The user's server MUST have this module loaded, however -
-   The module works even when the MUC is on a different server to the
    user
-   The MUC server does not need this module (it only needs to support
    the [standard ban
    protocol](http://xmpp.org/extensions/xep-0045.html#ban))
-   The module works for effectively banning [anonymous
    users](http://prosody.im/doc/anonymous_logins)

Also note that IP bans are not saved permanently, and are reset upon a
server restart.

Configuration
=============

There is no extra configuration for this module except for loading it.
Remember... do not load it on the MUC host, simply add it to your global
`modules_enabled` list, or under a specific host like:

``` lua
VirtualHost "anon.example.com"
  authentication = "anonymous"
  modules_enabled = { "muc_ban_ip" }
```

Compatibility
=============

  ----- --------------
  0.9   Works
  0.8   Doesn't work
  ----- --------------