Mercurial > prosody-modules
diff mod_client_management/README.md @ 5294:385346b6c81d
mod_client_management: New module for users to view/manage permitted clients
This is just the data and API part.
author | Matthew Wild <mwild1@gmail.com> |
---|---|
date | Thu, 30 Mar 2023 11:32:50 +0100 |
parents | |
children | 7c123d3285de |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/mod_client_management/README.md Thu Mar 30 11:32:50 2023 +0100 @@ -0,0 +1,32 @@ +--- +labels: +- Stage-Beta +summary: "Manage clients with access to your account" +rockspec: + dependencies: + - mod_sasl2_fast +--- + +This module allows a user to identify what currently has access to their +account. + +This module depends on [mod_sasl2_fast] and mod_tokenauth (bundled with +Prosody). Both will be automatically loaded if this module is loaded. + +## Configuration + +| Name | Description | Default | +|---------------------------|--------------------------------------------------------|-----------------| +| enforce_client_ids | Only allow SASL2-compatible clients | `false` | + +When `enforce_client_ids` is not enabled, the client listing may be less accurate due to legacy clients, +which can only be tracked by their resource, which is public information, not necessarily unique to a +client instance, and is also exposed to other XMPP entities the user communicates with. + +When `enforce_client_ids` is enabled, clients that don't support SASL2 and provide a client id will be +denied access. + +## Compatibility + +Requires Prosody trunk (as of 2023-03-29). Not compatible with Prosody 0.12 +and earlier.