mod_sasl2_fast/README.md
author Jonas Schäfer <jonas@wielicki.name>
Wed, 29 Mar 2023 17:52:21 +0200
changeset 5294 dddac5a3f447
parent 5099 745c7f4cca40
child 5881 70fa3f8de249
permissions -rw-r--r--
mod_vcard_muc: take roles into account for access check This allows admins on the MUC component to force-set avatars, even if they are not owners in a particular MUC, similar to how they are granted auto-ownership in other contexts.

---
labels:
- Stage-Beta
summary: "Fast Authentication Streamlining Tokens"
rockspec:
  dependencies:
  - mod_sasl2
---

This module implements a mechanism via which clients can exchange a password
for a secure token, improving security and streamlining future reconnections.

At the time of writing, the XEP that describes the FAST protocol is still
working its way through the XSF standards process. You can [view the FAST XEP
proposal here](https://xmpp.org/extensions/inbox/xep-fast.html).

This module depends on [mod_sasl2].

## Configuration

| Name                      | Description                                            | Default               |
|---------------------------|--------------------------------------------------------|-----------------------|
| sasl2_fast_token_ttl      | Default token expiry (seconds)                         | `86400*21` (21 days)  |
| sasl2_fast_token_min_ttl  | Time before tokens are eligible for rotation (seconds) | `86400` (1 day)       |

The `sasl2_fast_token_ttl` option determines the length of time a client can
remain disconnected before being "logged out" and needing to authenticate with
a password. Clients must perform at least one FAST authentication within this
period to remain active.

The `sasl2_fast_token_min_ttl` option defines how long before a token will be
rotated by the server. By default a token is rotated if it is older than 24
hours. This value should be less than `sasl2_fast_token_ttl` to prevent
clients being logged out unexpectedly.