Mercurial > prosody-modules

view mod_http_rest/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 79432b859d21
children
line wrap: on
line source

---
labels:
- 'Stage-Alpha'
summary: Send XMPP stanzas via REST/HTTP
...

This module provides a [REST](https://en.wikipedia.org/wiki/Representational_state_transfer)ful
method for sending XMPP stanzas.

This enables you to send stanzas by making HTTP requests to `http://${prosody-url}/rest`.

**DANGER/ACHTUNG!: This module does NOT enforce any authentication or user-checking.
This means that by default stanzas can be sent *anyone* on behalf of *any* user.**

You should enable [mod_http_authentication](https://modules.prosody.im/mod_http_authentication.html),
to require authentication for calls made to this module, or alternatively, you
could use a reverse proxy like Nginx.

# To enable this module

Add `"http_rest"` to `modules_enabled`, either globally or for a particular virtual
host.

# How to test:

You can use curl to make the HTTP request to Prosody, to test whether this
module is working properly:

    curl -k http://localhost:5280/rest -u username:password -H "Content-Type: text/xml" -d '<iq to="pubsub.localhost" type="set" id="4dd1a1e3-ef91-4017-a5aa-eaba0a82eb94-1" from="user@localhost"><pubsub xmlns="http://jabber.org/protocol/pubsub"><publish node="Test mod_rest.lua"><item>Hello World!</item></publish></pubsub></iq>'