Mercurial > prosody-modules
view mod_invites_adhoc/README.markdown @ 5390:f2363e6d9a64
mod_http_oauth2: Advertise the currently supported id_token signing algorithm
This field is REQUIRED. The algorithm RS256 MUST be included, but isn't
because we don't implement it, as that would require implementing a pile
of additional cryptography and JWT stuff. Instead the id_token is
signed using the client secret, which allows verification by the client,
since it's a shared secret per OpenID Connect Core 1.0 ยง 10.1 under
Symmetric Signatures.
OpenID Connect Discovery 1.0 has a lot of REQUIRED and MUST clauses that
are not supported here, but that's okay because this is served from the
RFC 8414 OAuth 2.0 Authorization Server Metadata .well-known endpoint!
| author | Kim Alvefur <zash@zash.se> |
|---|---|
| date | Sun, 30 Apr 2023 16:13:40 +0200 |
| parents | 027fb71ad509 |
| children | 2f7fff6c8c73 |
line wrap: on
line source
--- labels: - 'Stage-Beta' summary: 'Enable ad-hoc command for XMPP clients to create invitations' ... Introduction ============ This module is part of the suite of modules that implement invite-based account registration for Prosody. The other modules are: - [mod_invites] - [mod_invites_page] - [mod_invites_register] - [mod_invites_register_web] - [mod_invites_api] - [mod_register_apps] For details and a full overview, start with the [mod_invites] documentation. Details ======= mod_invites_adhoc allows XMPP clients to create new invites on the server. Clients must support either XEP-0401 (Easy Onboarding) or XEP-0050 (Ad-hoc commands). There are three types of invitation that can be created: | Invite type | Description | |--|--| | Account-only invites | These can be used to register a new account | | Contact-only invites | These can be shared with a contact so they can easily add you to their contact list | | Account-and-contact invites | Like a contact-only invite, but also allows the contact to register on the current server if they don't already have an XMPP account | Only configured admins of the server are able to create account-only invites. By default normal users may only create contact-only invites, but account-and-contact invites can be enabled with the `allow_user_invites` option. Configuration ============= | Name | Description | Default | |-----------------------|-----------------------------------------------------------------------|-------------------------------------------| | allow_user_invites | Whether non-admin users can invite contacts to register on this server| `false` | | allow_contact_invites | Whether non-admin users can invite contacts to their roster | `true` | The `allow_user_invites` option should be set as desired. However it is strongly recommended to leave the other option (`allow_contact_invites`) at its default to provide the best user experience.