prosody-modules: mod_rest/mod_rest.lua history

mod_rest: Enable HTTP Basic authentication for Components

Sat, 31 May 2025 16:59:35 +0200

mod_rest: Enable HTTP Basic authentication for Components

Not sure if mod_http_oauth2 still works for components

mod_rest: Skip unpacking error object when missing (thanks Martin)

Tue, 22 Apr 2025 09:40:20 +0200

mod_rest: Skip unpacking error object when missing (thanks Martin)

Not every "http-error" event includes a .error field, so it may attempt
to unpack `nil`.

mod_rest: Strip down error payloads to avoid stack overflow

Sun, 16 Mar 2025 17:04:51 +0100

mod_rest: Strip down error payloads to avoid stack overflow

When the util.error feature of including a traceback in the error,
util.json can't serialize it as it is often self-referential.

mod_rest: Wrap mod_tokenauth errors

Sat, 21 Sep 2024 21:10:45 +0200

mod_rest: Wrap mod_tokenauth errors

In some cases of expired or invalid tokens the error from
mod_tokenauth.get_token_session() was returned bare with status 200
instead of via the error formatting handler.

mod_rest: Fix to allow underscores in path of HTTP GET to iq-get mapping

Mon, 19 Aug 2024 18:39:22 +0200

mod_rest: Fix to allow underscores in path of HTTP GET to iq-get mapping

A request like

GET /rest/upload_request/{to}

would fail because the pattern would not the underscore in "upload_request"

mod_rest: Fix authentication

Mon, 15 Jul 2024 16:24:20 +0200

mod_rest: Fix authentication

The :contains check failed because case normalization was applied after

mod_rest: Normalize case after filtering out non-match

Sun, 14 Jul 2024 18:01:24 +0200

mod_rest: Normalize case after filtering out non-match

Prevents an attempt to index a nil value

mod_rest: Fix to allow case sensitive HTTP authentication scheme

Sun, 14 Jul 2024 17:58:48 +0200

mod_rest: Fix to allow case sensitive HTTP authentication scheme

Per RFC 9110 section 11
> It uses a case-insensitive token to identify the authentication scheme

mod_rest: Return specific errors from credential checks

Sat, 06 Jul 2024 19:26:07 +0200

mod_rest: Return specific errors from credential checks

This is a step towards returning details of what went wrong when
checking credentials, distinguishing missing, malformed, and wrong
credentials.

mod_rest: Reject password that fails saslprep earlier (thanks tgy)

Thu, 04 Jul 2024 16:06:32 +0200

mod_rest: Reject password that fails saslprep earlier (thanks tgy)

Prevents an error later if/when passing the password through saslprep a
second time in the authentication module, since the prep functions now
reject nil

The error reporting could be improved but that would involve adding a
way to pass errors back out of the check_credentials() function.

mod_rest: Limit payload size (cf stanza size limits)

Wed, 25 Oct 2023 15:36:20 +0200

mod_rest: Limit payload size (cf stanza size limits)

Otherwise the limit would be defined by the HTTP stack.

mod_rest: Use logger of HTTP request in trunk

Fri, 07 Jul 2023 00:10:37 +0200

mod_rest: Use logger of HTTP request in trunk

In Prosody trunk rev c975dafa4303 each HTTP request gained its own log
sink, to make it easy to log things related to each request and group
those messages. Especially where async is used, spreading the request
and response apart as mod_rest does with iq stanzas, this grouped
logging should help find related messages.

mod_rest: Include full_jid property on origin

Sun, 18 Jun 2023 22:23:24 +0200

mod_rest: Include full_jid property on origin

Fixes permission check in disco#info query to your own account, where
the 'to' would have been stripped since it equals the account JID,
leaving mod_disco passing nil, which triggers an error in module:may()

mod_rest: Get correct type from config

Sat, 08 Apr 2023 19:51:24 +0200

mod_rest: Get correct type from config

Autocomplete?

mod_rest: Allow passing configuring a timeout for responses

Fri, 07 Apr 2023 20:26:33 +0200

mod_rest: Allow passing configuring a timeout for responses

The default 2 minutes is not how long you want to wait, sometimes.

mod_rest: Wrap webhook setup in a function for future reuse

Sun, 27 Nov 2022 00:34:00 +0100

mod_rest: Wrap webhook setup in a function for future reuse

The goal is to allow binding a session to a webhook via API to allow
e.g. bots to set up handling of incoming messages.

mod_rest: Do not allow replies to from webhooks

Sun, 27 Nov 2022 00:10:38 +0100

mod_rest: Do not allow replies to from webhooks

Replying to a result stanza could cause loops, just as replying to an
error.

No stanza.name check here but it should be fine since no other kinds of
stanzas have type=result, and the boolean logic would most definitely be
wrong on the first attempt.

mod_rest: Update for mod_tokenauth API changes (backwards-compatible)

Wed, 13 Jul 2022 11:27:44 +0100

mod_rest: Update for mod_tokenauth API changes (backwards-compatible)

mod_rest: Fill in 'type' field in error registry

Mon, 15 Aug 2022 15:26:14 +0200

mod_rest: Fill in 'type' field in error registry

The 'type' defaults to "modify" in util.error, which doesn't quite fit
many of these error conditions.

LuaFormatter changed ',' to ';'

mod_rest: Provide a log function on temporary session

Sun, 29 May 2022 02:02:07 +0200

mod_rest: Provide a log function on temporary session

Fixes traceback in places using session.log()

mod_rest: Fix attempt to index nil in handling of single iq response

Tue, 17 May 2022 11:44:44 +0200

mod_rest: Fix attempt to index nil in handling of single iq response

Fix handling of many responses, break handling of single response :(

mod_rest: Ensure MAM result-iq is included in results from remote hosts

Mon, 16 May 2022 20:31:58 +0200

mod_rest: Ensure MAM result-iq is included in results from remote hosts

Needed for the same reason as the special message handling, the remote
route does not pass our origin.send() here

mod_rest: Add special handling to catch MAM results from remote hosts

Mon, 16 May 2022 19:47:09 +0200

mod_rest: Add special handling to catch MAM results from remote hosts

Makes MAM queries to remote hosts works.

As the comment says, MAM results from users' local archives or local
MUCs are returned via origin.send() which is provided in the event and
thus already worked. Results from remote hosts go via normal stanza
routing and events, which need this extra handling to catch.

This pattern of iq-set, message+, iq-result is generally limited to MAM.

Closest similar thing might be MUC join, but to really handle that you
would need the webhook callback mechanism.

mod_rest: Add configuration of which stanzas to route to callback

Sat, 09 Apr 2022 01:04:25 +0200

mod_rest: Add configuration of which stanzas to route to callback

Makes it simpler to build APIs that only handle a certain kind of
stanzas, letting them be handled by the unhandled stanza handler instead
of having to write code to ignore certain kinds of stanzas.

mod_rest: Improve logging of results from callback startup probe

Sat, 09 Apr 2022 00:43:18 +0200

mod_rest: Improve logging of results from callback startup probe

Especially interested in logging 500 status codes and their errors, to
diagnose problems with the callback API.

mod_rest: Support parameters in callback URL

Sat, 09 Apr 2022 00:41:18 +0200

mod_rest: Support parameters in callback URL

E.g.

rest_callback_url = "http://myapi.example:5000/api/{kind}/{type}"

which results in e.g. requests to /api/message/chat

Allows using path routing in web frameworks for dispatch instead of
having to pick apart the payload to further dispatch it.

mod_rest: Improve error handling during format mapping

Thu, 07 Apr 2022 17:49:08 +0200

mod_rest: Improve error handling during format mapping

Prevents e.g. a nil, error return going directly into e.g. json
encoding, resulting in "null" being returned.

Further handling improvements down the line is needed.

mod_rest: Catch and coerce errors in echo endpoint

Thu, 07 Apr 2022 17:48:08 +0200

mod_rest: Catch and coerce errors in echo endpoint

This should ensure problems in encode() are reported back

mod_rest: Ensure mod_http is loaded before API demo

Tue, 08 Feb 2022 13:51:41 +0100

mod_rest: Ensure mod_http is loaded before API demo

Fixes an error as it tried to use module:http_url() which doesn't exist
before mod_http is loaded

mod_rest: Fix nested message stanzas in XEP-0297 containers

Wed, 29 Dec 2021 19:40:28 +0100

mod_rest: Fix nested message stanzas in XEP-0297 containers

It's all a bit awkward because it doesn't normally use the whole schema
directly, but rather checks which stanza type is used and picks out that
property as a schema. Which also prevents references from working.

mod_rest: Let 'type' be implied in path based queries

Thu, 04 Nov 2021 20:15:44 +0100

mod_rest: Let 'type' be implied in path based queries

This will make e.g. MAM queries work via GET /archive/{to}

mod_rest: Remove unused variable [luacheck]

Wed, 03 Nov 2021 20:15:14 +0100

mod_rest: Remove unused variable [luacheck]

Copied from core.stanza_router where it was probably used later in some
code not included in the copy.

mod_rest: Fire pre-events

Mon, 01 Nov 2021 15:51:59 +0100

mod_rest: Fire pre-events

Let event handlers on pre-events have effect.

mod_rest: Add an anonymous mode

Mon, 01 Nov 2021 15:08:21 +0100

mod_rest: Add an anonymous mode

Could be useful for a demo instance.

mod_rest: Set type on temp session to satisfy certain auth checks

Tue, 26 Oct 2021 18:07:35 +0200

mod_rest: Set type on temp session to satisfy certain auth checks

E.g. mod_external_services and some others use `origin.type == "c2s"` as
access check, which rejected the previous nil value.

mod_rest: Support returning multiple replies in an container

Wed, 29 Sep 2021 00:26:44 +0200

mod_rest: Support returning multiple replies in an container

Allows retrieving MAM results and possibly other things.

mod_rest: Fix name of entry in error registry for unauth 'from'

Tue, 23 Mar 2021 23:41:10 +0100

mod_rest: Fix name of entry in error registry for unauth 'from'

Wow was this a pain to track down or what?

Symptoms: An error with condition: undefined-condition. No further details.

mod_rest: Remove inaccurate comment

Tue, 23 Mar 2021 20:23:35 +0100

mod_rest: Remove inaccurate comment

It also checks Basic auth here. Removing since it doesn't seem to add
much.

mod_rest: Add an 'echo' endpoint for debugging

Sun, 21 Mar 2021 00:31:53 +0100

mod_rest: Add an 'echo' endpoint for debugging

It returns the XML stanza built from e.g. the JSON format.

mod_rest: Fix typos [codespell]

Tue, 09 Mar 2021 18:44:35 +0100

mod_rest: Fix typos [codespell]

mod_rest: Allow passing e.g. disco 'node' as a ?query variable

Sun, 07 Mar 2021 22:01:50 +0100

mod_rest: Allow passing e.g. disco 'node' as a ?query variable

This enables e.g.
GET /disco/pubsub.example.org?node=princely_musings

Note the hack to skip this for ping.

mod_rest: Allow empty @to to mean to=account is in normal XMPP

Sun, 07 Mar 2021 21:02:18 +0100

mod_rest: Allow empty @to to mean to=account is in normal XMPP

Noticed an XXX in snikket-web-portal wrt needing to explicitly set @to
in order to talk to 'self' services in Prosody, where to=nil is the same
as to=account

mod_rest: Add option for serving interactive openapi documentation

Tue, 02 Mar 2021 18:38:13 +0100

mod_rest: Add option for serving interactive openapi documentation

Swagger not included.

mod_rest: Fix syntax error in previous commit

Mon, 01 Mar 2021 17:33:32 +0100

mod_rest: Fix syntax error in previous commit

mod_rest: Revert leftover of unfinished ?query mapping

Sun, 28 Feb 2021 20:59:53 +0100

mod_rest: Revert leftover of unfinished ?query mapping

Idea was to allow second level data fields to be passed as query
parameters, i.e. /rest/command/{to}/?command=execute&node=foobar but
that's still a work in progress, so reverted here for now.

mod_rest: Support GET for certain IQ queries

Sun, 28 Feb 2021 19:33:09 +0100

mod_rest: Support GET for certain IQ queries

Example:
GET /rest/version/example.com

200 OK
{ version: { name: "thing", version: "1.0.0" } }

mod_rest: Add more REST-looking way to send stanzas

Sun, 28 Feb 2021 19:25:45 +0100

mod_rest: Add more REST-looking way to send stanzas

Example:
POST /rest/message/chat/juliet@example.net
{ body: "Hello" }

Becomes equivalent to
POST /rest
{ kind: "message", type: "chat", to: "juliet@example.net", body: "Hello" }

Sending messages as plain/text also becomes more convenient.

IQ stazas are still weird, but we'll do something special for those.

mod_rest: Ensure no attempt is made to reply to an error stanza

Sun, 15 Nov 2020 16:29:48 +0100

mod_rest: Ensure no attempt is made to reply to an error stanza

Previously it was possible to return an error reply from a callback.

mod_rest: Catch and log errors in callback promise chain

Sun, 15 Nov 2020 16:25:49 +0100

mod_rest: Catch and log errors in callback promise chain

From the code it looks like it should be possible to reply to an error
stanza, but it did not. Turns out I was saved by my local developer mode
module which throws errors if an attempt is made to create an errror
reply to an error stanza. However nothing collects this error from the
promise, so all I got was confusion.

mod_rest: Use promise based HTTP client API

Sun, 15 Nov 2020 15:33:56 +0100

mod_rest: Use promise based HTTP client API

Doesn't really simplify anything much.

mod_rest: Use HTTP error mapping from net.http.errors

Sun, 15 Nov 2020 15:17:50 +0100

mod_rest: Use HTTP error mapping from net.http.errors

This was basically a subset

mod_rest: Use util.error registry datatype

Sat, 14 Nov 2020 22:38:28 +0100

mod_rest: Use util.error registry datatype

Saves a few characters per line.

mod_rest: Add whitespace to improve readability, code navigation

Thu, 12 Nov 2020 20:37:54 +0100

mod_rest: Add whitespace to improve readability, code navigation

I use {} in vim a lot.

mod_rest: Add support for form-encoded output

Mon, 20 Jul 2020 21:42:11 +0200

mod_rest: Add support for form-encoded output

This roughtly matches the input capabilities when given an form-encoded
payload.

mod_rest: Add support for CBOR

Fri, 29 May 2020 12:38:23 +0200

mod_rest: Add support for CBOR

https://www.zash.se/lua-cbor.html

mod_rest: Respond to unknown payload types with HTTP status 415

Fri, 29 May 2020 12:30:15 +0200

mod_rest: Respond to unknown payload types with HTTP status 415

More semantically correct.

mod_rest: Improve auth error reporting

Sun, 12 Apr 2020 18:07:16 +0200

mod_rest: Improve auth error reporting

mod_rest: Avoid interfering with mod_http_oauth2 errors (fixes #1500)

Sun, 08 Mar 2020 12:52:18 +0100

mod_rest: Avoid interfering with mod_http_oauth2 errors (fixes #1500)

mod_rest: Add an XML error formatter (fixes #1499)

Sat, 07 Mar 2020 17:35:09 +0100

mod_rest: Add an XML error formatter (fixes #1499)

mod_rest: Break out POST errors into a registry

Sat, 07 Mar 2020 17:34:17 +0100

mod_rest: Break out POST errors into a registry