Software `/` code `/` prosody-modules

Annotate

mod_rest/mod_rest.lua @ 4734:e58ec4b3cf90

mod_rest: Add an anonymous mode Could be useful for a demo instance.

author	Kim Alvefur <zash@zash.se>
date	Mon, 01 Nov 2021 15:08:21 +0100
parent	4727:e6f46d1b3337
child	4735:58a20d5ac6e9

rev	line source
3794 4b258329e6e4 mod_rest: Initial commit of another RESTful API module Kim Alvefur <zash@zash.se> parents: diff changeset	1 -- RESTful API
4b258329e6e4 mod_rest: Initial commit of another RESTful API module Kim Alvefur <zash@zash.se> parents: diff changeset	2 --
3803 dc2b5a412286 mod_rest: Log sent and received stanzas in style of mod_c2s etc Kim Alvefur <zash@zash.se> parents: 3802 diff changeset	3 -- Copyright (c) 2019-2020 Kim Alvefur
3794 4b258329e6e4 mod_rest: Initial commit of another RESTful API module Kim Alvefur <zash@zash.se> parents: diff changeset	4 --
4b258329e6e4 mod_rest: Initial commit of another RESTful API module Kim Alvefur <zash@zash.se> parents: diff changeset	5 -- This file is MIT/X11 licensed.
4b258329e6e4 mod_rest: Initial commit of another RESTful API module Kim Alvefur <zash@zash.se> parents: diff changeset	6
3910 49efd1323a1b mod_rest: Add support for token authentication Matthew Wild <mwild1@gmail.com> parents: 3909 diff changeset	7 local encodings = require "util.encodings";
49efd1323a1b mod_rest: Add support for token authentication Matthew Wild <mwild1@gmail.com> parents: 3909 diff changeset	8 local base64 = encodings.base64;
3794 4b258329e6e4 mod_rest: Initial commit of another RESTful API module Kim Alvefur <zash@zash.se> parents: diff changeset	9 local errors = require "util.error";
3795 f51308fcba83 mod_rest: Allow specifying a webhook/callback to handle incoming stanzas Kim Alvefur <zash@zash.se> parents: 3794 diff changeset	10 local http = require "net.http";
3794 4b258329e6e4 mod_rest: Initial commit of another RESTful API module Kim Alvefur <zash@zash.se> parents: diff changeset	11 local id = require "util.id";
4b258329e6e4 mod_rest: Initial commit of another RESTful API module Kim Alvefur <zash@zash.se> parents: diff changeset	12 local jid = require "util.jid";
3813 aa1ad69c7c10 mod_rest: Add JSON support Kim Alvefur <zash@zash.se> parents: 3812 diff changeset	13 local json = require "util.json";
3795 f51308fcba83 mod_rest: Allow specifying a webhook/callback to handle incoming stanzas Kim Alvefur <zash@zash.se> parents: 3794 diff changeset	14 local st = require "util.stanza";
3910 49efd1323a1b mod_rest: Add support for token authentication Matthew Wild <mwild1@gmail.com> parents: 3909 diff changeset	15 local um = require "core.usermanager";
3794 4b258329e6e4 mod_rest: Initial commit of another RESTful API module Kim Alvefur <zash@zash.se> parents: diff changeset	16 local xml = require "util.xml";
4037 991090cb5d18 mod_rest: Add support for CBOR Kim Alvefur <zash@zash.se> parents: 4036 diff changeset	17 local have_cbor, cbor = pcall(require, "cbor");
3794 4b258329e6e4 mod_rest: Initial commit of another RESTful API module Kim Alvefur <zash@zash.se> parents: diff changeset	18
3910 49efd1323a1b mod_rest: Add support for token authentication Matthew Wild <mwild1@gmail.com> parents: 3909 diff changeset	19 local jsonmap = module:require"jsonmap";
49efd1323a1b mod_rest: Add support for token authentication Matthew Wild <mwild1@gmail.com> parents: 3909 diff changeset	20
3915 80dffbbd056b mod_rest, mod_http_oauth2: Switch from mod_authtokens to mod_tokenauth per Prosody bf81523e2ff4 Matthew Wild <mwild1@gmail.com> parents: 3911 diff changeset	21 local tokens = module:depends("tokenauth");
3910 49efd1323a1b mod_rest: Add support for token authentication Matthew Wild <mwild1@gmail.com> parents: 3909 diff changeset	22
49efd1323a1b mod_rest: Add support for token authentication Matthew Wild <mwild1@gmail.com> parents: 3909 diff changeset	23 local auth_mechanisms = module:get_option_set("rest_auth_mechanisms", { "Basic", "Bearer" });
3802 f88e07630e4e mod_rest: Add support for simple Bearer token auth Kim Alvefur <zash@zash.se> parents: 3801 diff changeset	24
3910 49efd1323a1b mod_rest: Add support for token authentication Matthew Wild <mwild1@gmail.com> parents: 3909 diff changeset	25 local www_authenticate_header;
49efd1323a1b mod_rest: Add support for token authentication Matthew Wild <mwild1@gmail.com> parents: 3909 diff changeset	26 do
49efd1323a1b mod_rest: Add support for token authentication Matthew Wild <mwild1@gmail.com> parents: 3909 diff changeset	27 local header, realm = {}, module.host.."/"..module.name;
49efd1323a1b mod_rest: Add support for token authentication Matthew Wild <mwild1@gmail.com> parents: 3909 diff changeset	28 for mech in auth_mechanisms do
49efd1323a1b mod_rest: Add support for token authentication Matthew Wild <mwild1@gmail.com> parents: 3909 diff changeset	29 header[#header+1] = ("%s realm=%q"):format(mech, realm);
49efd1323a1b mod_rest: Add support for token authentication Matthew Wild <mwild1@gmail.com> parents: 3909 diff changeset	30 end
49efd1323a1b mod_rest: Add support for token authentication Matthew Wild <mwild1@gmail.com> parents: 3909 diff changeset	31 www_authenticate_header = table.concat(header, ", ");
49efd1323a1b mod_rest: Add support for token authentication Matthew Wild <mwild1@gmail.com> parents: 3909 diff changeset	32 end
49efd1323a1b mod_rest: Add support for token authentication Matthew Wild <mwild1@gmail.com> parents: 3909 diff changeset	33
3802 f88e07630e4e mod_rest: Add support for simple Bearer token auth Kim Alvefur <zash@zash.se> parents: 3801 diff changeset	34 local function check_credentials(request)
3910 49efd1323a1b mod_rest: Add support for token authentication Matthew Wild <mwild1@gmail.com> parents: 3909 diff changeset	35 local auth_type, auth_data = string.match(request.headers.authorization, "^(%S+)%s(.+)$");
49efd1323a1b mod_rest: Add support for token authentication Matthew Wild <mwild1@gmail.com> parents: 3909 diff changeset	36 if not (auth_type and auth_data) or not auth_mechanisms:contains(auth_type) then
49efd1323a1b mod_rest: Add support for token authentication Matthew Wild <mwild1@gmail.com> parents: 3909 diff changeset	37 return false;
49efd1323a1b mod_rest: Add support for token authentication Matthew Wild <mwild1@gmail.com> parents: 3909 diff changeset	38 end
3876 75b330d4fa6f mod_rest: Add support for HTTP Basic username and password authentication Kim Alvefur <zash@zash.se> parents: 3874 diff changeset	39
3910 49efd1323a1b mod_rest: Add support for token authentication Matthew Wild <mwild1@gmail.com> parents: 3909 diff changeset	40 if auth_type == "Basic" then
49efd1323a1b mod_rest: Add support for token authentication Matthew Wild <mwild1@gmail.com> parents: 3909 diff changeset	41 local creds = base64.decode(auth_data);
3876 75b330d4fa6f mod_rest: Add support for HTTP Basic username and password authentication Kim Alvefur <zash@zash.se> parents: 3874 diff changeset	42 if not creds then return false; end
75b330d4fa6f mod_rest: Add support for HTTP Basic username and password authentication Kim Alvefur <zash@zash.se> parents: 3874 diff changeset	43 local username, password = string.match(creds, "^([^:]+):(.*)$");
75b330d4fa6f mod_rest: Add support for HTTP Basic username and password authentication Kim Alvefur <zash@zash.se> parents: 3874 diff changeset	44 if not username then return false; end
75b330d4fa6f mod_rest: Add support for HTTP Basic username and password authentication Kim Alvefur <zash@zash.se> parents: 3874 diff changeset	45 username, password = encodings.stringprep.nodeprep(username), encodings.stringprep.saslprep(password);
75b330d4fa6f mod_rest: Add support for HTTP Basic username and password authentication Kim Alvefur <zash@zash.se> parents: 3874 diff changeset	46 if not username then return false; end
75b330d4fa6f mod_rest: Add support for HTTP Basic username and password authentication Kim Alvefur <zash@zash.se> parents: 3874 diff changeset	47 if not um.test_password(username, module.host, password) then
75b330d4fa6f mod_rest: Add support for HTTP Basic username and password authentication Kim Alvefur <zash@zash.se> parents: 3874 diff changeset	48 return false;
75b330d4fa6f mod_rest: Add support for HTTP Basic username and password authentication Kim Alvefur <zash@zash.se> parents: 3874 diff changeset	49 end
3910 49efd1323a1b mod_rest: Add support for token authentication Matthew Wild <mwild1@gmail.com> parents: 3909 diff changeset	50 return { username = username, host = module.host };
49efd1323a1b mod_rest: Add support for token authentication Matthew Wild <mwild1@gmail.com> parents: 3909 diff changeset	51 elseif auth_type == "Bearer" then
49efd1323a1b mod_rest: Add support for token authentication Matthew Wild <mwild1@gmail.com> parents: 3909 diff changeset	52 local token_info = tokens.get_token_info(auth_data);
49efd1323a1b mod_rest: Add support for token authentication Matthew Wild <mwild1@gmail.com> parents: 3909 diff changeset	53 if not token_info or not token_info.session then
49efd1323a1b mod_rest: Add support for token authentication Matthew Wild <mwild1@gmail.com> parents: 3909 diff changeset	54 return false;
49efd1323a1b mod_rest: Add support for token authentication Matthew Wild <mwild1@gmail.com> parents: 3909 diff changeset	55 end
49efd1323a1b mod_rest: Add support for token authentication Matthew Wild <mwild1@gmail.com> parents: 3909 diff changeset	56 return token_info.session;
3876 75b330d4fa6f mod_rest: Add support for HTTP Basic username and password authentication Kim Alvefur <zash@zash.se> parents: 3874 diff changeset	57 end
3910 49efd1323a1b mod_rest: Add support for token authentication Matthew Wild <mwild1@gmail.com> parents: 3909 diff changeset	58 return nil;
3876 75b330d4fa6f mod_rest: Add support for HTTP Basic username and password authentication Kim Alvefur <zash@zash.se> parents: 3874 diff changeset	59 end
3794 4b258329e6e4 mod_rest: Initial commit of another RESTful API module Kim Alvefur <zash@zash.se> parents: diff changeset	60
4734 e58ec4b3cf90 mod_rest: Add an anonymous mode Kim Alvefur <zash@zash.se> parents: 4727 diff changeset	61 if module:get_option_string("authentication") == "anonymous" and module:get_option_boolean("anonymous_rest") then
e58ec4b3cf90 mod_rest: Add an anonymous mode Kim Alvefur <zash@zash.se> parents: 4727 diff changeset	62 www_authenticate_header = nil;
e58ec4b3cf90 mod_rest: Add an anonymous mode Kim Alvefur <zash@zash.se> parents: 4727 diff changeset	63 function check_credentials(request) -- luacheck: ignore 212/request
e58ec4b3cf90 mod_rest: Add an anonymous mode Kim Alvefur <zash@zash.se> parents: 4727 diff changeset	64 return {
e58ec4b3cf90 mod_rest: Add an anonymous mode Kim Alvefur <zash@zash.se> parents: 4727 diff changeset	65 username = id.medium():lower();
e58ec4b3cf90 mod_rest: Add an anonymous mode Kim Alvefur <zash@zash.se> parents: 4727 diff changeset	66 host = module.host;
e58ec4b3cf90 mod_rest: Add an anonymous mode Kim Alvefur <zash@zash.se> parents: 4727 diff changeset	67 }
e58ec4b3cf90 mod_rest: Add an anonymous mode Kim Alvefur <zash@zash.se> parents: 4727 diff changeset	68 end
e58ec4b3cf90 mod_rest: Add an anonymous mode Kim Alvefur <zash@zash.se> parents: 4727 diff changeset	69 end
e58ec4b3cf90 mod_rest: Add an anonymous mode Kim Alvefur <zash@zash.se> parents: 4727 diff changeset	70
4477 8df6cc648963 mod_rest: Add more REST-looking way to send stanzas Kim Alvefur <zash@zash.se> parents: 4250 diff changeset	71 -- (table, string) -> table
8df6cc648963 mod_rest: Add more REST-looking way to send stanzas Kim Alvefur <zash@zash.se> parents: 4250 diff changeset	72 local function amend_from_path(data, path)
8df6cc648963 mod_rest: Add more REST-looking way to send stanzas Kim Alvefur <zash@zash.se> parents: 4250 diff changeset	73 local st_kind, st_type, st_to = path:match("^([mpi]%w+)/(%w+)/(.*)$");
8df6cc648963 mod_rest: Add more REST-looking way to send stanzas Kim Alvefur <zash@zash.se> parents: 4250 diff changeset	74 if not st_kind then return; end
4478 7ab0c423688a mod_rest: Support GET for certain IQ queries Kim Alvefur <zash@zash.se> parents: 4477 diff changeset	75 if st_kind == "iq" and st_type ~= "get" and st_type ~= "set" then
7ab0c423688a mod_rest: Support GET for certain IQ queries Kim Alvefur <zash@zash.se> parents: 4477 diff changeset	76 -- GET /iq/disco/jid
4503 80912726405d mod_rest: Allow passing e.g. disco 'node' as a ?query variable Kim Alvefur <zash@zash.se> parents: 4502 diff changeset	77 data = {
80912726405d mod_rest: Allow passing e.g. disco 'node' as a ?query variable Kim Alvefur <zash@zash.se> parents: 4502 diff changeset	78 kind = "iq";
80912726405d mod_rest: Allow passing e.g. disco 'node' as a ?query variable Kim Alvefur <zash@zash.se> parents: 4502 diff changeset	79 type = "get";
80912726405d mod_rest: Allow passing e.g. disco 'node' as a ?query variable Kim Alvefur <zash@zash.se> parents: 4502 diff changeset	80 [st_type] = st_type == "ping" or data or {};
80912726405d mod_rest: Allow passing e.g. disco 'node' as a ?query variable Kim Alvefur <zash@zash.se> parents: 4502 diff changeset	81 };
4478 7ab0c423688a mod_rest: Support GET for certain IQ queries Kim Alvefur <zash@zash.se> parents: 4477 diff changeset	82 else
7ab0c423688a mod_rest: Support GET for certain IQ queries Kim Alvefur <zash@zash.se> parents: 4477 diff changeset	83 data.kind = st_kind;
7ab0c423688a mod_rest: Support GET for certain IQ queries Kim Alvefur <zash@zash.se> parents: 4477 diff changeset	84 data.type = st_type;
7ab0c423688a mod_rest: Support GET for certain IQ queries Kim Alvefur <zash@zash.se> parents: 4477 diff changeset	85 end
4477 8df6cc648963 mod_rest: Add more REST-looking way to send stanzas Kim Alvefur <zash@zash.se> parents: 4250 diff changeset	86 if st_to and st_to ~= "" then
8df6cc648963 mod_rest: Add more REST-looking way to send stanzas Kim Alvefur <zash@zash.se> parents: 4250 diff changeset	87 data.to = st_to;
8df6cc648963 mod_rest: Add more REST-looking way to send stanzas Kim Alvefur <zash@zash.se> parents: 4250 diff changeset	88 end
8df6cc648963 mod_rest: Add more REST-looking way to send stanzas Kim Alvefur <zash@zash.se> parents: 4250 diff changeset	89 return data;
8df6cc648963 mod_rest: Add more REST-looking way to send stanzas Kim Alvefur <zash@zash.se> parents: 4250 diff changeset	90 end
8df6cc648963 mod_rest: Add more REST-looking way to send stanzas Kim Alvefur <zash@zash.se> parents: 4250 diff changeset	91
8df6cc648963 mod_rest: Add more REST-looking way to send stanzas Kim Alvefur <zash@zash.se> parents: 4250 diff changeset	92 local function parse(mimetype, data, path) --> Stanza, error enum
3825 802087d3155a mod_rest: Fix traceback on missing content-type header Kim Alvefur <zash@zash.se> parents: 3824 diff changeset	93 mimetype = mimetype and mimetype:match("^[^; ]*");
3810 91ff86fc3b20 mod_rest: Factor out payload parsing Kim Alvefur <zash@zash.se> parents: 3807 diff changeset	94 if mimetype == "application/xmpp+xml" then
91ff86fc3b20 mod_rest: Factor out payload parsing Kim Alvefur <zash@zash.se> parents: 3807 diff changeset	95 return xml.parse(data);
3813 aa1ad69c7c10 mod_rest: Add JSON support Kim Alvefur <zash@zash.se> parents: 3812 diff changeset	96 elseif mimetype == "application/json" then
aa1ad69c7c10 mod_rest: Add JSON support Kim Alvefur <zash@zash.se> parents: 3812 diff changeset	97 local parsed, err = json.decode(data);
aa1ad69c7c10 mod_rest: Add JSON support Kim Alvefur <zash@zash.se> parents: 3812 diff changeset	98 if not parsed then
aa1ad69c7c10 mod_rest: Add JSON support Kim Alvefur <zash@zash.se> parents: 3812 diff changeset	99 return parsed, err;
aa1ad69c7c10 mod_rest: Add JSON support Kim Alvefur <zash@zash.se> parents: 3812 diff changeset	100 end
4503 80912726405d mod_rest: Allow passing e.g. disco 'node' as a ?query variable Kim Alvefur <zash@zash.se> parents: 4502 diff changeset	101 if path then
80912726405d mod_rest: Allow passing e.g. disco 'node' as a ?query variable Kim Alvefur <zash@zash.se> parents: 4502 diff changeset	102 parsed = amend_from_path(parsed, path);
80912726405d mod_rest: Allow passing e.g. disco 'node' as a ?query variable Kim Alvefur <zash@zash.se> parents: 4502 diff changeset	103 if not parsed then return nil, "invalid-path"; end
80912726405d mod_rest: Allow passing e.g. disco 'node' as a ?query variable Kim Alvefur <zash@zash.se> parents: 4502 diff changeset	104 end
3813 aa1ad69c7c10 mod_rest: Add JSON support Kim Alvefur <zash@zash.se> parents: 3812 diff changeset	105 return jsonmap.json2st(parsed);
4037 991090cb5d18 mod_rest: Add support for CBOR Kim Alvefur <zash@zash.se> parents: 4036 diff changeset	106 elseif mimetype == "application/cbor" and have_cbor then
991090cb5d18 mod_rest: Add support for CBOR Kim Alvefur <zash@zash.se> parents: 4036 diff changeset	107 local parsed, err = cbor.decode(data);
991090cb5d18 mod_rest: Add support for CBOR Kim Alvefur <zash@zash.se> parents: 4036 diff changeset	108 if not parsed then
991090cb5d18 mod_rest: Add support for CBOR Kim Alvefur <zash@zash.se> parents: 4036 diff changeset	109 return parsed, err;
991090cb5d18 mod_rest: Add support for CBOR Kim Alvefur <zash@zash.se> parents: 4036 diff changeset	110 end
991090cb5d18 mod_rest: Add support for CBOR Kim Alvefur <zash@zash.se> parents: 4036 diff changeset	111 return jsonmap.json2st(parsed);
3911 064c32a5be7c mod_rest: Support urlencoded form data (does a subset of JSON mapping) Kim Alvefur <zash@zash.se> parents: 3910 diff changeset	112 elseif mimetype == "application/x-www-form-urlencoded"then
064c32a5be7c mod_rest: Support urlencoded form data (does a subset of JSON mapping) Kim Alvefur <zash@zash.se> parents: 3910 diff changeset	113 local parsed = http.formdecode(data);
064c32a5be7c mod_rest: Support urlencoded form data (does a subset of JSON mapping) Kim Alvefur <zash@zash.se> parents: 3910 diff changeset	114 if type(parsed) == "string" then
4503 80912726405d mod_rest: Allow passing e.g. disco 'node' as a ?query variable Kim Alvefur <zash@zash.se> parents: 4502 diff changeset	115 -- This should reject GET /iq/query/to?messagebody
80912726405d mod_rest: Allow passing e.g. disco 'node' as a ?query variable Kim Alvefur <zash@zash.se> parents: 4502 diff changeset	116 if path then
80912726405d mod_rest: Allow passing e.g. disco 'node' as a ?query variable Kim Alvefur <zash@zash.se> parents: 4502 diff changeset	117 return nil, "invalid-query";
80912726405d mod_rest: Allow passing e.g. disco 'node' as a ?query variable Kim Alvefur <zash@zash.se> parents: 4502 diff changeset	118 end
3911 064c32a5be7c mod_rest: Support urlencoded form data (does a subset of JSON mapping) Kim Alvefur <zash@zash.se> parents: 3910 diff changeset	119 return parse("text/plain", parsed);
064c32a5be7c mod_rest: Support urlencoded form data (does a subset of JSON mapping) Kim Alvefur <zash@zash.se> parents: 3910 diff changeset	120 end
064c32a5be7c mod_rest: Support urlencoded form data (does a subset of JSON mapping) Kim Alvefur <zash@zash.se> parents: 3910 diff changeset	121 for i = #parsed, 1, -1 do
064c32a5be7c mod_rest: Support urlencoded form data (does a subset of JSON mapping) Kim Alvefur <zash@zash.se> parents: 3910 diff changeset	122 parsed[i] = nil;
064c32a5be7c mod_rest: Support urlencoded form data (does a subset of JSON mapping) Kim Alvefur <zash@zash.se> parents: 3910 diff changeset	123 end
4503 80912726405d mod_rest: Allow passing e.g. disco 'node' as a ?query variable Kim Alvefur <zash@zash.se> parents: 4502 diff changeset	124 if path then
80912726405d mod_rest: Allow passing e.g. disco 'node' as a ?query variable Kim Alvefur <zash@zash.se> parents: 4502 diff changeset	125 parsed = amend_from_path(parsed, path);
80912726405d mod_rest: Allow passing e.g. disco 'node' as a ?query variable Kim Alvefur <zash@zash.se> parents: 4502 diff changeset	126 if not parsed then return nil, "invalid-path"; end
80912726405d mod_rest: Allow passing e.g. disco 'node' as a ?query variable Kim Alvefur <zash@zash.se> parents: 4502 diff changeset	127 end
3911 064c32a5be7c mod_rest: Support urlencoded form data (does a subset of JSON mapping) Kim Alvefur <zash@zash.se> parents: 3910 diff changeset	128 return jsonmap.json2st(parsed);
3810 91ff86fc3b20 mod_rest: Factor out payload parsing Kim Alvefur <zash@zash.se> parents: 3807 diff changeset	129 elseif mimetype == "text/plain" then
4477 8df6cc648963 mod_rest: Add more REST-looking way to send stanzas Kim Alvefur <zash@zash.se> parents: 4250 diff changeset	130 if not path then
8df6cc648963 mod_rest: Add more REST-looking way to send stanzas Kim Alvefur <zash@zash.se> parents: 4250 diff changeset	131 return st.message({ type = "chat" }, data);
8df6cc648963 mod_rest: Add more REST-looking way to send stanzas Kim Alvefur <zash@zash.se> parents: 4250 diff changeset	132 end
8df6cc648963 mod_rest: Add more REST-looking way to send stanzas Kim Alvefur <zash@zash.se> parents: 4250 diff changeset	133 local parsed = {};
4503 80912726405d mod_rest: Allow passing e.g. disco 'node' as a ?query variable Kim Alvefur <zash@zash.se> parents: 4502 diff changeset	134 if path then
80912726405d mod_rest: Allow passing e.g. disco 'node' as a ?query variable Kim Alvefur <zash@zash.se> parents: 4502 diff changeset	135 parsed = amend_from_path(parsed, path);
80912726405d mod_rest: Allow passing e.g. disco 'node' as a ?query variable Kim Alvefur <zash@zash.se> parents: 4502 diff changeset	136 if not parsed then return nil, "invalid-path"; end
80912726405d mod_rest: Allow passing e.g. disco 'node' as a ?query variable Kim Alvefur <zash@zash.se> parents: 4502 diff changeset	137 end
4477 8df6cc648963 mod_rest: Add more REST-looking way to send stanzas Kim Alvefur <zash@zash.se> parents: 4250 diff changeset	138 if parsed.kind == "message" then
8df6cc648963 mod_rest: Add more REST-looking way to send stanzas Kim Alvefur <zash@zash.se> parents: 4250 diff changeset	139 parsed.body = data;
8df6cc648963 mod_rest: Add more REST-looking way to send stanzas Kim Alvefur <zash@zash.se> parents: 4250 diff changeset	140 elseif parsed.kind == "presence" then
8df6cc648963 mod_rest: Add more REST-looking way to send stanzas Kim Alvefur <zash@zash.se> parents: 4250 diff changeset	141 parsed.show = data;
8df6cc648963 mod_rest: Add more REST-looking way to send stanzas Kim Alvefur <zash@zash.se> parents: 4250 diff changeset	142 else
8df6cc648963 mod_rest: Add more REST-looking way to send stanzas Kim Alvefur <zash@zash.se> parents: 4250 diff changeset	143 return nil, "invalid-path";
8df6cc648963 mod_rest: Add more REST-looking way to send stanzas Kim Alvefur <zash@zash.se> parents: 4250 diff changeset	144 end
8df6cc648963 mod_rest: Add more REST-looking way to send stanzas Kim Alvefur <zash@zash.se> parents: 4250 diff changeset	145 return jsonmap.json2st(parsed);
4478 7ab0c423688a mod_rest: Support GET for certain IQ queries Kim Alvefur <zash@zash.se> parents: 4477 diff changeset	146 elseif not mimetype and path then
7ab0c423688a mod_rest: Support GET for certain IQ queries Kim Alvefur <zash@zash.se> parents: 4477 diff changeset	147 local parsed = amend_from_path({}, path);
7ab0c423688a mod_rest: Support GET for certain IQ queries Kim Alvefur <zash@zash.se> parents: 4477 diff changeset	148 if not parsed then return nil, "invalid-path"; end
7ab0c423688a mod_rest: Support GET for certain IQ queries Kim Alvefur <zash@zash.se> parents: 4477 diff changeset	149 return jsonmap.json2st(parsed);
3810 91ff86fc3b20 mod_rest: Factor out payload parsing Kim Alvefur <zash@zash.se> parents: 3807 diff changeset	150 end
91ff86fc3b20 mod_rest: Factor out payload parsing Kim Alvefur <zash@zash.se> parents: 3807 diff changeset	151 return nil, "unknown-payload-type";
91ff86fc3b20 mod_rest: Factor out payload parsing Kim Alvefur <zash@zash.se> parents: 3807 diff changeset	152 end
91ff86fc3b20 mod_rest: Factor out payload parsing Kim Alvefur <zash@zash.se> parents: 3807 diff changeset	153
3929 bd687d586a8a mod_rest: Separate lists of mediatypes for input, output and errors Kim Alvefur <zash@zash.se> parents: 3926 diff changeset	154 local function decide_type(accept, supported_types)
3813 aa1ad69c7c10 mod_rest: Add JSON support Kim Alvefur <zash@zash.se> parents: 3812 diff changeset	155 -- assumes the accept header is sorted
aa1ad69c7c10 mod_rest: Add JSON support Kim Alvefur <zash@zash.se> parents: 3812 diff changeset	156 local ret = supported_types[1];
aa1ad69c7c10 mod_rest: Add JSON support Kim Alvefur <zash@zash.se> parents: 3812 diff changeset	157 for i = 2, #supported_types do
aa1ad69c7c10 mod_rest: Add JSON support Kim Alvefur <zash@zash.se> parents: 3812 diff changeset	158 if (accept:find(supported_types[i], 1, true) or 1000) < (accept:find(ret, 1, true) or 1000) then
aa1ad69c7c10 mod_rest: Add JSON support Kim Alvefur <zash@zash.se> parents: 3812 diff changeset	159 ret = supported_types[i];
aa1ad69c7c10 mod_rest: Add JSON support Kim Alvefur <zash@zash.se> parents: 3812 diff changeset	160 end
aa1ad69c7c10 mod_rest: Add JSON support Kim Alvefur <zash@zash.se> parents: 3812 diff changeset	161 end
aa1ad69c7c10 mod_rest: Add JSON support Kim Alvefur <zash@zash.se> parents: 3812 diff changeset	162 return ret;
3811 eb25110696cd mod_rest: Factor out response content type selection Kim Alvefur <zash@zash.se> parents: 3810 diff changeset	163 end
eb25110696cd mod_rest: Factor out response content type selection Kim Alvefur <zash@zash.se> parents: 3810 diff changeset	164
3929 bd687d586a8a mod_rest: Separate lists of mediatypes for input, output and errors Kim Alvefur <zash@zash.se> parents: 3926 diff changeset	165 local supported_inputs = {
bd687d586a8a mod_rest: Separate lists of mediatypes for input, output and errors Kim Alvefur <zash@zash.se> parents: 3926 diff changeset	166 "application/xmpp+xml",
bd687d586a8a mod_rest: Separate lists of mediatypes for input, output and errors Kim Alvefur <zash@zash.se> parents: 3926 diff changeset	167 "application/json",
bd687d586a8a mod_rest: Separate lists of mediatypes for input, output and errors Kim Alvefur <zash@zash.se> parents: 3926 diff changeset	168 "application/x-www-form-urlencoded",
bd687d586a8a mod_rest: Separate lists of mediatypes for input, output and errors Kim Alvefur <zash@zash.se> parents: 3926 diff changeset	169 "text/plain",
bd687d586a8a mod_rest: Separate lists of mediatypes for input, output and errors Kim Alvefur <zash@zash.se> parents: 3926 diff changeset	170 };
bd687d586a8a mod_rest: Separate lists of mediatypes for input, output and errors Kim Alvefur <zash@zash.se> parents: 3926 diff changeset	171
bd687d586a8a mod_rest: Separate lists of mediatypes for input, output and errors Kim Alvefur <zash@zash.se> parents: 3926 diff changeset	172 local supported_outputs = {
bd687d586a8a mod_rest: Separate lists of mediatypes for input, output and errors Kim Alvefur <zash@zash.se> parents: 3926 diff changeset	173 "application/xmpp+xml",
bd687d586a8a mod_rest: Separate lists of mediatypes for input, output and errors Kim Alvefur <zash@zash.se> parents: 3926 diff changeset	174 "application/json",
4066 07ae583bc565 mod_rest: Add support for form-encoded output Kim Alvefur <zash@zash.se> parents: 4037 diff changeset	175 "application/x-www-form-urlencoded",
3929 bd687d586a8a mod_rest: Separate lists of mediatypes for input, output and errors Kim Alvefur <zash@zash.se> parents: 3926 diff changeset	176 };
bd687d586a8a mod_rest: Separate lists of mediatypes for input, output and errors Kim Alvefur <zash@zash.se> parents: 3926 diff changeset	177
4037 991090cb5d18 mod_rest: Add support for CBOR Kim Alvefur <zash@zash.se> parents: 4036 diff changeset	178 if have_cbor then
991090cb5d18 mod_rest: Add support for CBOR Kim Alvefur <zash@zash.se> parents: 4036 diff changeset	179 table.insert(supported_inputs, "application/cbor");
991090cb5d18 mod_rest: Add support for CBOR Kim Alvefur <zash@zash.se> parents: 4036 diff changeset	180 table.insert(supported_outputs, "application/cbor");
991090cb5d18 mod_rest: Add support for CBOR Kim Alvefur <zash@zash.se> parents: 4036 diff changeset	181 end
991090cb5d18 mod_rest: Add support for CBOR Kim Alvefur <zash@zash.se> parents: 4036 diff changeset	182
4066 07ae583bc565 mod_rest: Add support for form-encoded output Kim Alvefur <zash@zash.se> parents: 4037 diff changeset	183 -- Only { string : string } can be form-encoded, discard the rest
07ae583bc565 mod_rest: Add support for form-encoded output Kim Alvefur <zash@zash.se> parents: 4037 diff changeset	184 -- (jsonmap also discards anything unknown or unsupported)
07ae583bc565 mod_rest: Add support for form-encoded output Kim Alvefur <zash@zash.se> parents: 4037 diff changeset	185 local function flatten(t)
07ae583bc565 mod_rest: Add support for form-encoded output Kim Alvefur <zash@zash.se> parents: 4037 diff changeset	186 local form = {};
07ae583bc565 mod_rest: Add support for form-encoded output Kim Alvefur <zash@zash.se> parents: 4037 diff changeset	187 for k, v in pairs(t) do
07ae583bc565 mod_rest: Add support for form-encoded output Kim Alvefur <zash@zash.se> parents: 4037 diff changeset	188 if type(v) == "string" then
07ae583bc565 mod_rest: Add support for form-encoded output Kim Alvefur <zash@zash.se> parents: 4037 diff changeset	189 form[k] = v;
07ae583bc565 mod_rest: Add support for form-encoded output Kim Alvefur <zash@zash.se> parents: 4037 diff changeset	190 elseif type(v) == "number" then
07ae583bc565 mod_rest: Add support for form-encoded output Kim Alvefur <zash@zash.se> parents: 4037 diff changeset	191 form[k] = tostring(v);
07ae583bc565 mod_rest: Add support for form-encoded output Kim Alvefur <zash@zash.se> parents: 4037 diff changeset	192 elseif v == true then
07ae583bc565 mod_rest: Add support for form-encoded output Kim Alvefur <zash@zash.se> parents: 4037 diff changeset	193 form[k] = "";
07ae583bc565 mod_rest: Add support for form-encoded output Kim Alvefur <zash@zash.se> parents: 4037 diff changeset	194 end
07ae583bc565 mod_rest: Add support for form-encoded output Kim Alvefur <zash@zash.se> parents: 4037 diff changeset	195 end
07ae583bc565 mod_rest: Add support for form-encoded output Kim Alvefur <zash@zash.se> parents: 4037 diff changeset	196 return form;
07ae583bc565 mod_rest: Add support for form-encoded output Kim Alvefur <zash@zash.se> parents: 4037 diff changeset	197 end
07ae583bc565 mod_rest: Add support for form-encoded output Kim Alvefur <zash@zash.se> parents: 4037 diff changeset	198
3812 f027b8b1e794 mod_rest: Factor out serialization of outgoing stanzas Kim Alvefur <zash@zash.se> parents: 3811 diff changeset	199 local function encode(type, s)
3813 aa1ad69c7c10 mod_rest: Add JSON support Kim Alvefur <zash@zash.se> parents: 3812 diff changeset	200 if type == "application/json" then
aa1ad69c7c10 mod_rest: Add JSON support Kim Alvefur <zash@zash.se> parents: 3812 diff changeset	201 return json.encode(jsonmap.st2json(s));
4066 07ae583bc565 mod_rest: Add support for form-encoded output Kim Alvefur <zash@zash.se> parents: 4037 diff changeset	202 elseif type == "application/x-www-form-urlencoded" then
07ae583bc565 mod_rest: Add support for form-encoded output Kim Alvefur <zash@zash.se> parents: 4037 diff changeset	203 return http.formencode(flatten(jsonmap.st2json(s)));
4037 991090cb5d18 mod_rest: Add support for CBOR Kim Alvefur <zash@zash.se> parents: 4036 diff changeset	204 elseif type == "application/cbor" then
991090cb5d18 mod_rest: Add support for CBOR Kim Alvefur <zash@zash.se> parents: 4036 diff changeset	205 return cbor.encode(jsonmap.st2json(s));
3813 aa1ad69c7c10 mod_rest: Add JSON support Kim Alvefur <zash@zash.se> parents: 3812 diff changeset	206 elseif type == "text/plain" then
aa1ad69c7c10 mod_rest: Add JSON support Kim Alvefur <zash@zash.se> parents: 3812 diff changeset	207 return s:get_child_text("body") or "";
aa1ad69c7c10 mod_rest: Add JSON support Kim Alvefur <zash@zash.se> parents: 3812 diff changeset	208 end
3812 f027b8b1e794 mod_rest: Factor out serialization of outgoing stanzas Kim Alvefur <zash@zash.se> parents: 3811 diff changeset	209 return tostring(s);
f027b8b1e794 mod_rest: Factor out serialization of outgoing stanzas Kim Alvefur <zash@zash.se> parents: 3811 diff changeset	210 end
f027b8b1e794 mod_rest: Factor out serialization of outgoing stanzas Kim Alvefur <zash@zash.se> parents: 3811 diff changeset	211
4244 07c11080027e mod_rest: Use util.error registry datatype Kim Alvefur <zash@zash.se> parents: 4242 diff changeset	212 local post_errors = errors.init("mod_rest", {
3971 ae5ac41c391d mod_rest: Improve auth error reporting Kim Alvefur <zash@zash.se> parents: 3933 diff changeset	213 noauthz = { code = 401, type = "auth", condition = "not-authorized", text = "No credentials provided" },
ae5ac41c391d mod_rest: Improve auth error reporting Kim Alvefur <zash@zash.se> parents: 3933 diff changeset	214 unauthz = { code = 403, type = "auth", condition = "not-authorized", text = "Credentials not accepted" },
3930 d5dafd617cd6 mod_rest: Break out POST errors into a registry Kim Alvefur <zash@zash.se> parents: 3929 diff changeset	215 parse = { code = 400, condition = "not-well-formed", text = "Failed to parse payload", },
d5dafd617cd6 mod_rest: Break out POST errors into a registry Kim Alvefur <zash@zash.se> parents: 3929 diff changeset	216 xmlns = { code = 422, condition = "invalid-namespace", text = "'xmlns' attribute must be empty", },
d5dafd617cd6 mod_rest: Break out POST errors into a registry Kim Alvefur <zash@zash.se> parents: 3929 diff changeset	217 name = { code = 422, condition = "unsupported-stanza-type", text = "Invalid stanza, must be 'message', 'presence' or 'iq'.", },
d5dafd617cd6 mod_rest: Break out POST errors into a registry Kim Alvefur <zash@zash.se> parents: 3929 diff changeset	218 to = { code = 422, condition = "improper-addressing", text = "Invalid destination JID", },
d5dafd617cd6 mod_rest: Break out POST errors into a registry Kim Alvefur <zash@zash.se> parents: 3929 diff changeset	219 from = { code = 422, condition = "invalid-from", text = "Invalid source JID", },
4532 183c2abdc3c4 mod_rest: Fix name of entry in error registry for unauth 'from' Kim Alvefur <zash@zash.se> parents: 4526 diff changeset	220 from_auth = { code = 403, condition = "not-authorized", text = "Not authorized to send stanza with requested 'from'", },
3930 d5dafd617cd6 mod_rest: Break out POST errors into a registry Kim Alvefur <zash@zash.se> parents: 3929 diff changeset	221 iq_type = { code = 422, condition = "invalid-xml", text = "'iq' stanza must be of type 'get' or 'set'", },
d5dafd617cd6 mod_rest: Break out POST errors into a registry Kim Alvefur <zash@zash.se> parents: 3929 diff changeset	222 iq_tags = { code = 422, condition = "bad-format", text = "'iq' stanza must have exactly one child tag", },
4036 04c11b652aeb mod_rest: Respond to unknown payload types with HTTP status 415 Kim Alvefur <zash@zash.se> parents: 3971 diff changeset	223 mediatype = { code = 415, condition = "bad-format", text = "Unsupported media type" },
4244 07c11080027e mod_rest: Use util.error registry datatype Kim Alvefur <zash@zash.se> parents: 4242 diff changeset	224 });
3930 d5dafd617cd6 mod_rest: Break out POST errors into a registry Kim Alvefur <zash@zash.se> parents: 3929 diff changeset	225
4478 7ab0c423688a mod_rest: Support GET for certain IQ queries Kim Alvefur <zash@zash.se> parents: 4477 diff changeset	226 -- GET → iq-get
7ab0c423688a mod_rest: Support GET for certain IQ queries Kim Alvefur <zash@zash.se> parents: 4477 diff changeset	227 local function parse_request(request, path)
7ab0c423688a mod_rest: Support GET for certain IQ queries Kim Alvefur <zash@zash.se> parents: 4477 diff changeset	228 if path and request.method == "GET" then
4506 508cb880b163 mod_rest: Fix typos [codespell] Kim Alvefur <zash@zash.se> parents: 4503 diff changeset	229 -- e.g. /version/{to}
4503 80912726405d mod_rest: Allow passing e.g. disco 'node' as a ?query variable Kim Alvefur <zash@zash.se> parents: 4502 diff changeset	230 if request.url.query then
80912726405d mod_rest: Allow passing e.g. disco 'node' as a ?query variable Kim Alvefur <zash@zash.se> parents: 4502 diff changeset	231 return parse("application/x-www-form-urlencoded", request.url.query, "iq/"..path);
80912726405d mod_rest: Allow passing e.g. disco 'node' as a ?query variable Kim Alvefur <zash@zash.se> parents: 4502 diff changeset	232 end
4478 7ab0c423688a mod_rest: Support GET for certain IQ queries Kim Alvefur <zash@zash.se> parents: 4477 diff changeset	233 return parse(nil, nil, "iq/"..path);
7ab0c423688a mod_rest: Support GET for certain IQ queries Kim Alvefur <zash@zash.se> parents: 4477 diff changeset	234 else
7ab0c423688a mod_rest: Support GET for certain IQ queries Kim Alvefur <zash@zash.se> parents: 4477 diff changeset	235 return parse(request.headers.content_type, request.body, path);
7ab0c423688a mod_rest: Support GET for certain IQ queries Kim Alvefur <zash@zash.se> parents: 4477 diff changeset	236 end
7ab0c423688a mod_rest: Support GET for certain IQ queries Kim Alvefur <zash@zash.se> parents: 4477 diff changeset	237 end
7ab0c423688a mod_rest: Support GET for certain IQ queries Kim Alvefur <zash@zash.se> parents: 4477 diff changeset	238
7ab0c423688a mod_rest: Support GET for certain IQ queries Kim Alvefur <zash@zash.se> parents: 4477 diff changeset	239 local function handle_request(event, path)
3794 4b258329e6e4 mod_rest: Initial commit of another RESTful API module Kim Alvefur <zash@zash.se> parents: diff changeset	240 local request, response = event.request, event.response;
3910 49efd1323a1b mod_rest: Add support for token authentication Matthew Wild <mwild1@gmail.com> parents: 3909 diff changeset	241 local from;
49efd1323a1b mod_rest: Add support for token authentication Matthew Wild <mwild1@gmail.com> parents: 3909 diff changeset	242 local origin;
4514 81d0748bff5b mod_rest: Add an 'echo' endpoint for debugging Kim Alvefur <zash@zash.se> parents: 4506 diff changeset	243 local echo = path == "echo";
81d0748bff5b mod_rest: Add an 'echo' endpoint for debugging Kim Alvefur <zash@zash.se> parents: 4506 diff changeset	244 if echo then path = nil; end
3910 49efd1323a1b mod_rest: Add support for token authentication Matthew Wild <mwild1@gmail.com> parents: 3909 diff changeset	245
4734 e58ec4b3cf90 mod_rest: Add an anonymous mode Kim Alvefur <zash@zash.se> parents: 4727 diff changeset	246 if not request.headers.authorization and www_authenticate_header then
3910 49efd1323a1b mod_rest: Add support for token authentication Matthew Wild <mwild1@gmail.com> parents: 3909 diff changeset	247 response.headers.www_authenticate = www_authenticate_header;
4244 07c11080027e mod_rest: Use util.error registry datatype Kim Alvefur <zash@zash.se> parents: 4242 diff changeset	248 return post_errors.new("noauthz");
3876 75b330d4fa6f mod_rest: Add support for HTTP Basic username and password authentication Kim Alvefur <zash@zash.se> parents: 3874 diff changeset	249 else
3910 49efd1323a1b mod_rest: Add support for token authentication Matthew Wild <mwild1@gmail.com> parents: 3909 diff changeset	250 origin = check_credentials(request);
49efd1323a1b mod_rest: Add support for token authentication Matthew Wild <mwild1@gmail.com> parents: 3909 diff changeset	251 if not origin then
4244 07c11080027e mod_rest: Use util.error registry datatype Kim Alvefur <zash@zash.se> parents: 4242 diff changeset	252 return post_errors.new("unauthz");
3876 75b330d4fa6f mod_rest: Add support for HTTP Basic username and password authentication Kim Alvefur <zash@zash.se> parents: 3874 diff changeset	253 end
3910 49efd1323a1b mod_rest: Add support for token authentication Matthew Wild <mwild1@gmail.com> parents: 3909 diff changeset	254 from = jid.join(origin.username, origin.host, origin.resource);
4727 e6f46d1b3337 mod_rest: Set type on temp session to satisfy certain auth checks Kim Alvefur <zash@zash.se> parents: 4699 diff changeset	255 origin.type = "c2s";
3802 f88e07630e4e mod_rest: Add support for simple Bearer token auth Kim Alvefur <zash@zash.se> parents: 3801 diff changeset	256 end
4478 7ab0c423688a mod_rest: Support GET for certain IQ queries Kim Alvefur <zash@zash.se> parents: 4477 diff changeset	257 local payload, err = parse_request(request, path);
3794 4b258329e6e4 mod_rest: Initial commit of another RESTful API module Kim Alvefur <zash@zash.se> parents: diff changeset	258 if not payload then
4b258329e6e4 mod_rest: Initial commit of another RESTful API module Kim Alvefur <zash@zash.se> parents: diff changeset	259 -- parse fail
4036 04c11b652aeb mod_rest: Respond to unknown payload types with HTTP status 415 Kim Alvefur <zash@zash.se> parents: 3971 diff changeset	260 local ctx = { error = err, type = request.headers.content_type, data = request.body, };
04c11b652aeb mod_rest: Respond to unknown payload types with HTTP status 415 Kim Alvefur <zash@zash.se> parents: 3971 diff changeset	261 if err == "unknown-payload-type" then
4244 07c11080027e mod_rest: Use util.error registry datatype Kim Alvefur <zash@zash.se> parents: 4242 diff changeset	262 return post_errors.new("mediatype", ctx);
4036 04c11b652aeb mod_rest: Respond to unknown payload types with HTTP status 415 Kim Alvefur <zash@zash.se> parents: 3971 diff changeset	263 end
4244 07c11080027e mod_rest: Use util.error registry datatype Kim Alvefur <zash@zash.se> parents: 4242 diff changeset	264 return post_errors.new("parse", ctx);
3794 4b258329e6e4 mod_rest: Initial commit of another RESTful API module Kim Alvefur <zash@zash.se> parents: diff changeset	265 end
4242 6a91d217acc9 mod_rest: Add whitespace to improve readability, code navigation Kim Alvefur <zash@zash.se> parents: 4066 diff changeset	266
3801 d59fb4dcf100 mod_rest: Verify that @xmlns is left empty Kim Alvefur <zash@zash.se> parents: 3799 diff changeset	267 if payload.attr.xmlns then
4244 07c11080027e mod_rest: Use util.error registry datatype Kim Alvefur <zash@zash.se> parents: 4242 diff changeset	268 return post_errors.new("xmlns");
3805 683b06c0348f mod_rest: Validate stanza kind earlier Kim Alvefur <zash@zash.se> parents: 3804 diff changeset	269 elseif payload.name ~= "message" and payload.name ~= "presence" and payload.name ~= "iq" then
4244 07c11080027e mod_rest: Use util.error registry datatype Kim Alvefur <zash@zash.se> parents: 4242 diff changeset	270 return post_errors.new("name");
3801 d59fb4dcf100 mod_rest: Verify that @xmlns is left empty Kim Alvefur <zash@zash.se> parents: 3799 diff changeset	271 end
4242 6a91d217acc9 mod_rest: Add whitespace to improve readability, code navigation Kim Alvefur <zash@zash.se> parents: 4066 diff changeset	272
3794 4b258329e6e4 mod_rest: Initial commit of another RESTful API module Kim Alvefur <zash@zash.se> parents: diff changeset	273 local to = jid.prep(payload.attr.to);
4502 48afaec5d1de mod_rest: Allow empty @to to mean to=account is in normal XMPP Kim Alvefur <zash@zash.se> parents: 4488 diff changeset	274 if payload.attr.to and not to then
4244 07c11080027e mod_rest: Use util.error registry datatype Kim Alvefur <zash@zash.se> parents: 4242 diff changeset	275 return post_errors.new("to");
3794 4b258329e6e4 mod_rest: Initial commit of another RESTful API module Kim Alvefur <zash@zash.se> parents: diff changeset	276 end
4242 6a91d217acc9 mod_rest: Add whitespace to improve readability, code navigation Kim Alvefur <zash@zash.se> parents: 4066 diff changeset	277
3910 49efd1323a1b mod_rest: Add support for token authentication Matthew Wild <mwild1@gmail.com> parents: 3909 diff changeset	278 if payload.attr.from then
49efd1323a1b mod_rest: Add support for token authentication Matthew Wild <mwild1@gmail.com> parents: 3909 diff changeset	279 local requested_from = jid.prep(payload.attr.from);
49efd1323a1b mod_rest: Add support for token authentication Matthew Wild <mwild1@gmail.com> parents: 3909 diff changeset	280 if not requested_from then
4244 07c11080027e mod_rest: Use util.error registry datatype Kim Alvefur <zash@zash.se> parents: 4242 diff changeset	281 return post_errors.new("from");
3794 4b258329e6e4 mod_rest: Initial commit of another RESTful API module Kim Alvefur <zash@zash.se> parents: diff changeset	282 end
3910 49efd1323a1b mod_rest: Add support for token authentication Matthew Wild <mwild1@gmail.com> parents: 3909 diff changeset	283 if jid.compare(requested_from, from) then
49efd1323a1b mod_rest: Add support for token authentication Matthew Wild <mwild1@gmail.com> parents: 3909 diff changeset	284 from = requested_from;
49efd1323a1b mod_rest: Add support for token authentication Matthew Wild <mwild1@gmail.com> parents: 3909 diff changeset	285 else
4244 07c11080027e mod_rest: Use util.error registry datatype Kim Alvefur <zash@zash.se> parents: 4242 diff changeset	286 return post_errors.new("from_auth");
3794 4b258329e6e4 mod_rest: Initial commit of another RESTful API module Kim Alvefur <zash@zash.se> parents: diff changeset	287 end
4b258329e6e4 mod_rest: Initial commit of another RESTful API module Kim Alvefur <zash@zash.se> parents: diff changeset	288 end
4242 6a91d217acc9 mod_rest: Add whitespace to improve readability, code navigation Kim Alvefur <zash@zash.se> parents: 4066 diff changeset	289
3794 4b258329e6e4 mod_rest: Initial commit of another RESTful API module Kim Alvefur <zash@zash.se> parents: diff changeset	290 payload.attr = {
4b258329e6e4 mod_rest: Initial commit of another RESTful API module Kim Alvefur <zash@zash.se> parents: diff changeset	291 from = from,
4b258329e6e4 mod_rest: Initial commit of another RESTful API module Kim Alvefur <zash@zash.se> parents: diff changeset	292 to = to,
4b258329e6e4 mod_rest: Initial commit of another RESTful API module Kim Alvefur <zash@zash.se> parents: diff changeset	293 id = payload.attr.id or id.medium(),
4b258329e6e4 mod_rest: Initial commit of another RESTful API module Kim Alvefur <zash@zash.se> parents: diff changeset	294 type = payload.attr.type,
4b258329e6e4 mod_rest: Initial commit of another RESTful API module Kim Alvefur <zash@zash.se> parents: diff changeset	295 ["xml:lang"] = payload.attr["xml:lang"],
4b258329e6e4 mod_rest: Initial commit of another RESTful API module Kim Alvefur <zash@zash.se> parents: diff changeset	296 };
4242 6a91d217acc9 mod_rest: Add whitespace to improve readability, code navigation Kim Alvefur <zash@zash.se> parents: 4066 diff changeset	297
3803 dc2b5a412286 mod_rest: Log sent and received stanzas in style of mod_c2s etc Kim Alvefur <zash@zash.se> parents: 3802 diff changeset	298 module:log("debug", "Received[rest]: %s", payload:top_tag());
4478 7ab0c423688a mod_rest: Support GET for certain IQ queries Kim Alvefur <zash@zash.se> parents: 4477 diff changeset	299 local send_type = decide_type((request.headers.accept or "") ..",".. (request.headers.content_type or ""), supported_outputs)
4514 81d0748bff5b mod_rest: Add an 'echo' endpoint for debugging Kim Alvefur <zash@zash.se> parents: 4506 diff changeset	300
81d0748bff5b mod_rest: Add an 'echo' endpoint for debugging Kim Alvefur <zash@zash.se> parents: 4506 diff changeset	301 if echo then
81d0748bff5b mod_rest: Add an 'echo' endpoint for debugging Kim Alvefur <zash@zash.se> parents: 4506 diff changeset	302 response.headers.content_type = send_type;
81d0748bff5b mod_rest: Add an 'echo' endpoint for debugging Kim Alvefur <zash@zash.se> parents: 4506 diff changeset	303 return encode(send_type, payload);
81d0748bff5b mod_rest: Add an 'echo' endpoint for debugging Kim Alvefur <zash@zash.se> parents: 4506 diff changeset	304 end
81d0748bff5b mod_rest: Add an 'echo' endpoint for debugging Kim Alvefur <zash@zash.se> parents: 4506 diff changeset	305
3794 4b258329e6e4 mod_rest: Initial commit of another RESTful API module Kim Alvefur <zash@zash.se> parents: diff changeset	306 if payload.name == "iq" then
4699 a8af632daf48 mod_rest: Support returning multiple replies in an <xmpp> container Kim Alvefur <zash@zash.se> parents: 4532 diff changeset	307 local responses = st.stanza("xmpp");
3910 49efd1323a1b mod_rest: Add support for token authentication Matthew Wild <mwild1@gmail.com> parents: 3909 diff changeset	308 function origin.send(stanza)
4699 a8af632daf48 mod_rest: Support returning multiple replies in an <xmpp> container Kim Alvefur <zash@zash.se> parents: 4532 diff changeset	309 responses:add_direct_child(stanza);
3910 49efd1323a1b mod_rest: Add support for token authentication Matthew Wild <mwild1@gmail.com> parents: 3909 diff changeset	310 end
4242 6a91d217acc9 mod_rest: Add whitespace to improve readability, code navigation Kim Alvefur <zash@zash.se> parents: 4066 diff changeset	311
3794 4b258329e6e4 mod_rest: Initial commit of another RESTful API module Kim Alvefur <zash@zash.se> parents: diff changeset	312 if payload.attr.type ~= "get" and payload.attr.type ~= "set" then
4244 07c11080027e mod_rest: Use util.error registry datatype Kim Alvefur <zash@zash.se> parents: 4242 diff changeset	313 return post_errors.new("iq_type");
3832 0d4146cf9fbc mod_rest: Enforce single child policy for outgoing it stanzas Kim Alvefur <zash@zash.se> parents: 3825 diff changeset	314 elseif #payload.tags ~= 1 then
4244 07c11080027e mod_rest: Use util.error registry datatype Kim Alvefur <zash@zash.se> parents: 4242 diff changeset	315 return post_errors.new("iq_tags");
3794 4b258329e6e4 mod_rest: Initial commit of another RESTful API module Kim Alvefur <zash@zash.se> parents: diff changeset	316 end
4242 6a91d217acc9 mod_rest: Add whitespace to improve readability, code navigation Kim Alvefur <zash@zash.se> parents: 4066 diff changeset	317
3910 49efd1323a1b mod_rest: Add support for token authentication Matthew Wild <mwild1@gmail.com> parents: 3909 diff changeset	318 return module:send_iq(payload, origin):next(
3794 4b258329e6e4 mod_rest: Initial commit of another RESTful API module Kim Alvefur <zash@zash.se> parents: diff changeset	319 function (result)
3803 dc2b5a412286 mod_rest: Log sent and received stanzas in style of mod_c2s etc Kim Alvefur <zash@zash.se> parents: 3802 diff changeset	320 module:log("debug", "Sending[rest]: %s", result.stanza:top_tag());
3811 eb25110696cd mod_rest: Factor out response content type selection Kim Alvefur <zash@zash.se> parents: 3810 diff changeset	321 response.headers.content_type = send_type;
4699 a8af632daf48 mod_rest: Support returning multiple replies in an <xmpp> container Kim Alvefur <zash@zash.se> parents: 4532 diff changeset	322 if responses[2] then
a8af632daf48 mod_rest: Support returning multiple replies in an <xmpp> container Kim Alvefur <zash@zash.se> parents: 4532 diff changeset	323 return encode(send_type, responses);
a8af632daf48 mod_rest: Support returning multiple replies in an <xmpp> container Kim Alvefur <zash@zash.se> parents: 4532 diff changeset	324 end
3812 f027b8b1e794 mod_rest: Factor out serialization of outgoing stanzas Kim Alvefur <zash@zash.se> parents: 3811 diff changeset	325 return encode(send_type, result.stanza);
3794 4b258329e6e4 mod_rest: Initial commit of another RESTful API module Kim Alvefur <zash@zash.se> parents: diff changeset	326 end,
4b258329e6e4 mod_rest: Initial commit of another RESTful API module Kim Alvefur <zash@zash.se> parents: diff changeset	327 function (error)
3909 eb27e51cf2c9 mod_rest: Handle uncaught native errors correctly Matthew Wild <mwild1@gmail.com> parents: 3887 diff changeset	328 if not errors.is_err(error) then
eb27e51cf2c9 mod_rest: Handle uncaught native errors correctly Matthew Wild <mwild1@gmail.com> parents: 3887 diff changeset	329 module:log("error", "Uncaught native error: %s", error);
eb27e51cf2c9 mod_rest: Handle uncaught native errors correctly Matthew Wild <mwild1@gmail.com> parents: 3887 diff changeset	330 return select(2, errors.coerce(nil, error));
eb27e51cf2c9 mod_rest: Handle uncaught native errors correctly Matthew Wild <mwild1@gmail.com> parents: 3887 diff changeset	331 elseif error.context and error.context.stanza then
3811 eb25110696cd mod_rest: Factor out response content type selection Kim Alvefur <zash@zash.se> parents: 3810 diff changeset	332 response.headers.content_type = send_type;
3803 dc2b5a412286 mod_rest: Log sent and received stanzas in style of mod_c2s etc Kim Alvefur <zash@zash.se> parents: 3802 diff changeset	333 module:log("debug", "Sending[rest]: %s", error.context.stanza:top_tag());
3812 f027b8b1e794 mod_rest: Factor out serialization of outgoing stanzas Kim Alvefur <zash@zash.se> parents: 3811 diff changeset	334 return encode(send_type, error.context.stanza);
3794 4b258329e6e4 mod_rest: Initial commit of another RESTful API module Kim Alvefur <zash@zash.se> parents: diff changeset	335 else
4b258329e6e4 mod_rest: Initial commit of another RESTful API module Kim Alvefur <zash@zash.se> parents: diff changeset	336 return error;
4b258329e6e4 mod_rest: Initial commit of another RESTful API module Kim Alvefur <zash@zash.se> parents: diff changeset	337 end
4b258329e6e4 mod_rest: Initial commit of another RESTful API module Kim Alvefur <zash@zash.se> parents: diff changeset	338 end);
3805 683b06c0348f mod_rest: Validate stanza kind earlier Kim Alvefur <zash@zash.se> parents: 3804 diff changeset	339 else
3796 d1ad10b76b00 mod_rest: Catch one (1) reply to a POST-ed stanza from an internal source Kim Alvefur <zash@zash.se> parents: 3795 diff changeset	340 function origin.send(stanza)
3803 dc2b5a412286 mod_rest: Log sent and received stanzas in style of mod_c2s etc Kim Alvefur <zash@zash.se> parents: 3802 diff changeset	341 module:log("debug", "Sending[rest]: %s", stanza:top_tag());
3811 eb25110696cd mod_rest: Factor out response content type selection Kim Alvefur <zash@zash.se> parents: 3810 diff changeset	342 response.headers.content_type = send_type;
3812 f027b8b1e794 mod_rest: Factor out serialization of outgoing stanzas Kim Alvefur <zash@zash.se> parents: 3811 diff changeset	343 response:send(encode(send_type, stanza));
3796 d1ad10b76b00 mod_rest: Catch one (1) reply to a POST-ed stanza from an internal source Kim Alvefur <zash@zash.se> parents: 3795 diff changeset	344 return true;
d1ad10b76b00 mod_rest: Catch one (1) reply to a POST-ed stanza from an internal source Kim Alvefur <zash@zash.se> parents: 3795 diff changeset	345 end
4242 6a91d217acc9 mod_rest: Add whitespace to improve readability, code navigation Kim Alvefur <zash@zash.se> parents: 4066 diff changeset	346
3814 0dede5b0ab27 mod_rest: Fix return status when sending and forgetting Kim Alvefur <zash@zash.se> parents: 3813 diff changeset	347 module:send(payload, origin);
0dede5b0ab27 mod_rest: Fix return status when sending and forgetting Kim Alvefur <zash@zash.se> parents: 3813 diff changeset	348 return 202;
3794 4b258329e6e4 mod_rest: Initial commit of another RESTful API module Kim Alvefur <zash@zash.se> parents: diff changeset	349 end
4b258329e6e4 mod_rest: Initial commit of another RESTful API module Kim Alvefur <zash@zash.se> parents: diff changeset	350 end
4b258329e6e4 mod_rest: Initial commit of another RESTful API module Kim Alvefur <zash@zash.se> parents: diff changeset	351
4488 eea62d30ae08 mod_rest: Add option for serving interactive openapi documentation Kim Alvefur <zash@zash.se> parents: 4481 diff changeset	352 local demo_handlers = {};
eea62d30ae08 mod_rest: Add option for serving interactive openapi documentation Kim Alvefur <zash@zash.se> parents: 4481 diff changeset	353 if module:get_option_path("rest_demo_resources", nil) then
eea62d30ae08 mod_rest: Add option for serving interactive openapi documentation Kim Alvefur <zash@zash.se> parents: 4481 diff changeset	354 demo_handlers = module:require"apidemo";
eea62d30ae08 mod_rest: Add option for serving interactive openapi documentation Kim Alvefur <zash@zash.se> parents: 4481 diff changeset	355 end
eea62d30ae08 mod_rest: Add option for serving interactive openapi documentation Kim Alvefur <zash@zash.se> parents: 4481 diff changeset	356
3794 4b258329e6e4 mod_rest: Initial commit of another RESTful API module Kim Alvefur <zash@zash.se> parents: diff changeset	357 -- Handle stanzas submitted via HTTP
4b258329e6e4 mod_rest: Initial commit of another RESTful API module Kim Alvefur <zash@zash.se> parents: diff changeset	358 module:depends("http");
4b258329e6e4 mod_rest: Initial commit of another RESTful API module Kim Alvefur <zash@zash.se> parents: diff changeset	359 module:provides("http", {
4b258329e6e4 mod_rest: Initial commit of another RESTful API module Kim Alvefur <zash@zash.se> parents: diff changeset	360 route = {
4478 7ab0c423688a mod_rest: Support GET for certain IQ queries Kim Alvefur <zash@zash.se> parents: 4477 diff changeset	361 POST = handle_request;
7ab0c423688a mod_rest: Support GET for certain IQ queries Kim Alvefur <zash@zash.se> parents: 4477 diff changeset	362 ["POST /*"] = handle_request;
7ab0c423688a mod_rest: Support GET for certain IQ queries Kim Alvefur <zash@zash.se> parents: 4477 diff changeset	363 ["GET /*"] = handle_request;
4488 eea62d30ae08 mod_rest: Add option for serving interactive openapi documentation Kim Alvefur <zash@zash.se> parents: 4481 diff changeset	364
eea62d30ae08 mod_rest: Add option for serving interactive openapi documentation Kim Alvefur <zash@zash.se> parents: 4481 diff changeset	365 -- Only if api_demo_resources are set
eea62d30ae08 mod_rest: Add option for serving interactive openapi documentation Kim Alvefur <zash@zash.se> parents: 4481 diff changeset	366 ["GET /"] = demo_handlers.redirect;
eea62d30ae08 mod_rest: Add option for serving interactive openapi documentation Kim Alvefur <zash@zash.se> parents: 4481 diff changeset	367 ["GET /demo/"] = demo_handlers.main_page;
eea62d30ae08 mod_rest: Add option for serving interactive openapi documentation Kim Alvefur <zash@zash.se> parents: 4481 diff changeset	368 ["GET /demo/openapi.yaml"] = demo_handlers.schema;
eea62d30ae08 mod_rest: Add option for serving interactive openapi documentation Kim Alvefur <zash@zash.se> parents: 4481 diff changeset	369 ["GET /demo/*"] = demo_handlers.resources;
3794 4b258329e6e4 mod_rest: Initial commit of another RESTful API module Kim Alvefur <zash@zash.se> parents: diff changeset	370 };
4b258329e6e4 mod_rest: Initial commit of another RESTful API module Kim Alvefur <zash@zash.se> parents: diff changeset	371 });
3795 f51308fcba83 mod_rest: Allow specifying a webhook/callback to handle incoming stanzas Kim Alvefur <zash@zash.se> parents: 3794 diff changeset	372
f51308fcba83 mod_rest: Allow specifying a webhook/callback to handle incoming stanzas Kim Alvefur <zash@zash.se> parents: 3794 diff changeset	373 -- Forward stanzas from XMPP to HTTP and return any reply
f51308fcba83 mod_rest: Allow specifying a webhook/callback to handle incoming stanzas Kim Alvefur <zash@zash.se> parents: 3794 diff changeset	374 local rest_url = module:get_option_string("rest_callback_url", nil);
f51308fcba83 mod_rest: Allow specifying a webhook/callback to handle incoming stanzas Kim Alvefur <zash@zash.se> parents: 3794 diff changeset	375 if rest_url then
3811 eb25110696cd mod_rest: Factor out response content type selection Kim Alvefur <zash@zash.se> parents: 3810 diff changeset	376 local send_type = module:get_option_string("rest_callback_content_type", "application/xmpp+xml");
3813 aa1ad69c7c10 mod_rest: Add JSON support Kim Alvefur <zash@zash.se> parents: 3812 diff changeset	377 if send_type == "json" then
aa1ad69c7c10 mod_rest: Add JSON support Kim Alvefur <zash@zash.se> parents: 3812 diff changeset	378 send_type = "application/json";
aa1ad69c7c10 mod_rest: Add JSON support Kim Alvefur <zash@zash.se> parents: 3812 diff changeset	379 end
3795 f51308fcba83 mod_rest: Allow specifying a webhook/callback to handle incoming stanzas Kim Alvefur <zash@zash.se> parents: 3794 diff changeset	380
3862 3b6b8dcff78e mod_rest: Log connectivity problems via module status API Kim Alvefur <zash@zash.se> parents: 3861 diff changeset	381 module:set_status("info", "Not yet connected");
3861 ede3d1724dd1 mod_rest: Attempt to auto-discover data type wanted by callback Kim Alvefur <zash@zash.se> parents: 3858 diff changeset	382 http.request(rest_url, {
ede3d1724dd1 mod_rest: Attempt to auto-discover data type wanted by callback Kim Alvefur <zash@zash.se> parents: 3858 diff changeset	383 method = "OPTIONS",
ede3d1724dd1 mod_rest: Attempt to auto-discover data type wanted by callback Kim Alvefur <zash@zash.se> parents: 3858 diff changeset	384 }, function (body, code, response)
3862 3b6b8dcff78e mod_rest: Log connectivity problems via module status API Kim Alvefur <zash@zash.se> parents: 3861 diff changeset	385 if code == 0 then
3b6b8dcff78e mod_rest: Log connectivity problems via module status API Kim Alvefur <zash@zash.se> parents: 3861 diff changeset	386 return module:log_status("error", "Could not connect to callback URL %q: %s", rest_url, body);
3b6b8dcff78e mod_rest: Log connectivity problems via module status API Kim Alvefur <zash@zash.se> parents: 3861 diff changeset	387 else
3b6b8dcff78e mod_rest: Log connectivity problems via module status API Kim Alvefur <zash@zash.se> parents: 3861 diff changeset	388 module:set_status("info", "Connected");
3b6b8dcff78e mod_rest: Log connectivity problems via module status API Kim Alvefur <zash@zash.se> parents: 3861 diff changeset	389 end
3861 ede3d1724dd1 mod_rest: Attempt to auto-discover data type wanted by callback Kim Alvefur <zash@zash.se> parents: 3858 diff changeset	390 if code == 200 and response.headers.accept then
3929 bd687d586a8a mod_rest: Separate lists of mediatypes for input, output and errors Kim Alvefur <zash@zash.se> parents: 3926 diff changeset	391 send_type = decide_type(response.headers.accept, supported_outputs);
3861 ede3d1724dd1 mod_rest: Attempt to auto-discover data type wanted by callback Kim Alvefur <zash@zash.se> parents: 3858 diff changeset	392 module:log("debug", "Set 'rest_callback_content_type' = %q based on Accept header", send_type);
ede3d1724dd1 mod_rest: Attempt to auto-discover data type wanted by callback Kim Alvefur <zash@zash.se> parents: 3858 diff changeset	393 end
ede3d1724dd1 mod_rest: Attempt to auto-discover data type wanted by callback Kim Alvefur <zash@zash.se> parents: 3858 diff changeset	394 end);
ede3d1724dd1 mod_rest: Attempt to auto-discover data type wanted by callback Kim Alvefur <zash@zash.se> parents: 3858 diff changeset	395
4245 7bf3bf81c9ef mod_rest: Use HTTP error mapping from net.http.errors Kim Alvefur <zash@zash.se> parents: 4244 diff changeset	396 local code2err = require "net.http.errors".registry;
3797 ed5d7586a61e mod_rest: Map various HTTP status codes to XMPP stanza errors Kim Alvefur <zash@zash.se> parents: 3796 diff changeset	397
3795 f51308fcba83 mod_rest: Allow specifying a webhook/callback to handle incoming stanzas Kim Alvefur <zash@zash.se> parents: 3794 diff changeset	398 local function handle_stanza(event)
f51308fcba83 mod_rest: Allow specifying a webhook/callback to handle incoming stanzas Kim Alvefur <zash@zash.se> parents: 3794 diff changeset	399 local stanza, origin = event.stanza, event.origin;
4250 8b489203e4d3 mod_rest: Ensure no attempt is made to reply to an error stanza Kim Alvefur <zash@zash.se> parents: 4249 diff changeset	400 local reply_allowed = stanza.attr.type ~= "error";
8b489203e4d3 mod_rest: Ensure no attempt is made to reply to an error stanza Kim Alvefur <zash@zash.se> parents: 4249 diff changeset	401 local reply_needed = reply_allowed and stanza.name == "iq";
3798 9b4fd2553365 mod_rest: Handle receipt requests on message stanzas Kim Alvefur <zash@zash.se> parents: 3797 diff changeset	402 local receipt;
9b4fd2553365 mod_rest: Handle receipt requests on message stanzas Kim Alvefur <zash@zash.se> parents: 3797 diff changeset	403
4250 8b489203e4d3 mod_rest: Ensure no attempt is made to reply to an error stanza Kim Alvefur <zash@zash.se> parents: 4249 diff changeset	404 if reply_allowed and stanza.name == "message" and stanza.attr.id and stanza:get_child("urn:xmpp:receipts", "request") then
3798 9b4fd2553365 mod_rest: Handle receipt requests on message stanzas Kim Alvefur <zash@zash.se> parents: 3797 diff changeset	405 reply_needed = true;
9b4fd2553365 mod_rest: Handle receipt requests on message stanzas Kim Alvefur <zash@zash.se> parents: 3797 diff changeset	406 receipt = st.stanza("received", { xmlns = "urn:xmpp:receipts", id = stanza.id });
9b4fd2553365 mod_rest: Handle receipt requests on message stanzas Kim Alvefur <zash@zash.se> parents: 3797 diff changeset	407 end
3795 f51308fcba83 mod_rest: Allow specifying a webhook/callback to handle incoming stanzas Kim Alvefur <zash@zash.se> parents: 3794 diff changeset	408
3812 f027b8b1e794 mod_rest: Factor out serialization of outgoing stanzas Kim Alvefur <zash@zash.se> parents: 3811 diff changeset	409 local request_body = encode(send_type, stanza);
3799 a1f1f703d604 mod_rest: Allow collection of original stanza after sending HTTP request Kim Alvefur <zash@zash.se> parents: 3798 diff changeset	410
a1f1f703d604 mod_rest: Allow collection of original stanza after sending HTTP request Kim Alvefur <zash@zash.se> parents: 3798 diff changeset	411 -- Keep only the top level element and let the rest be GC'd
a1f1f703d604 mod_rest: Allow collection of original stanza after sending HTTP request Kim Alvefur <zash@zash.se> parents: 3798 diff changeset	412 stanza = st.clone(stanza, true);
a1f1f703d604 mod_rest: Allow collection of original stanza after sending HTTP request Kim Alvefur <zash@zash.se> parents: 3798 diff changeset	413
3803 dc2b5a412286 mod_rest: Log sent and received stanzas in style of mod_c2s etc Kim Alvefur <zash@zash.se> parents: 3802 diff changeset	414 module:log("debug", "Sending[rest]: %s", stanza:top_tag());
3795 f51308fcba83 mod_rest: Allow specifying a webhook/callback to handle incoming stanzas Kim Alvefur <zash@zash.se> parents: 3794 diff changeset	415 http.request(rest_url, {
3799 a1f1f703d604 mod_rest: Allow collection of original stanza after sending HTTP request Kim Alvefur <zash@zash.se> parents: 3798 diff changeset	416 body = request_body,
3795 f51308fcba83 mod_rest: Allow specifying a webhook/callback to handle incoming stanzas Kim Alvefur <zash@zash.se> parents: 3794 diff changeset	417 headers = {
3811 eb25110696cd mod_rest: Factor out response content type selection Kim Alvefur <zash@zash.se> parents: 3810 diff changeset	418 ["Content-Type"] = send_type,
3795 f51308fcba83 mod_rest: Allow specifying a webhook/callback to handle incoming stanzas Kim Alvefur <zash@zash.se> parents: 3794 diff changeset	419 ["Content-Language"] = stanza.attr["xml:lang"],
3929 bd687d586a8a mod_rest: Separate lists of mediatypes for input, output and errors Kim Alvefur <zash@zash.se> parents: 3926 diff changeset	420 Accept = table.concat(supported_inputs, ", ");
3795 f51308fcba83 mod_rest: Allow specifying a webhook/callback to handle incoming stanzas Kim Alvefur <zash@zash.se> parents: 3794 diff changeset	421 },
4247 1f93fa24611d mod_rest: Use promise based HTTP client API Kim Alvefur <zash@zash.se> parents: 4245 diff changeset	422 }):next(function (response)
1f93fa24611d mod_rest: Use promise based HTTP client API Kim Alvefur <zash@zash.se> parents: 4245 diff changeset	423 module:set_status("info", "Connected");
3810 91ff86fc3b20 mod_rest: Factor out payload parsing Kim Alvefur <zash@zash.se> parents: 3807 diff changeset	424 local reply;
3795 f51308fcba83 mod_rest: Allow specifying a webhook/callback to handle incoming stanzas Kim Alvefur <zash@zash.se> parents: 3794 diff changeset	425
4247 1f93fa24611d mod_rest: Use promise based HTTP client API Kim Alvefur <zash@zash.se> parents: 4245 diff changeset	426 local code, body = response.code, response.body;
4250 8b489203e4d3 mod_rest: Ensure no attempt is made to reply to an error stanza Kim Alvefur <zash@zash.se> parents: 4249 diff changeset	427 if not reply_allowed then
8b489203e4d3 mod_rest: Ensure no attempt is made to reply to an error stanza Kim Alvefur <zash@zash.se> parents: 4249 diff changeset	428 return;
8b489203e4d3 mod_rest: Ensure no attempt is made to reply to an error stanza Kim Alvefur <zash@zash.se> parents: 4249 diff changeset	429 elseif code == 202 or code == 204 then
3867 839224be5299 mod_rest: Skip attempting parse empty response Kim Alvefur <zash@zash.se> parents: 3866 diff changeset	430 if not reply_needed then
839224be5299 mod_rest: Skip attempting parse empty response Kim Alvefur <zash@zash.se> parents: 3866 diff changeset	431 -- Delivered, no reply
839224be5299 mod_rest: Skip attempting parse empty response Kim Alvefur <zash@zash.se> parents: 3866 diff changeset	432 return;
839224be5299 mod_rest: Skip attempting parse empty response Kim Alvefur <zash@zash.se> parents: 3866 diff changeset	433 end
3810 91ff86fc3b20 mod_rest: Factor out payload parsing Kim Alvefur <zash@zash.se> parents: 3807 diff changeset	434 else
3867 839224be5299 mod_rest: Skip attempting parse empty response Kim Alvefur <zash@zash.se> parents: 3866 diff changeset	435 local parsed, err = parse(response.headers["content-type"], body);
839224be5299 mod_rest: Skip attempting parse empty response Kim Alvefur <zash@zash.se> parents: 3866 diff changeset	436 if not parsed then
839224be5299 mod_rest: Skip attempting parse empty response Kim Alvefur <zash@zash.se> parents: 3866 diff changeset	437 module:log("warn", "Failed parsing data from REST callback: %s, %q", err, body);
839224be5299 mod_rest: Skip attempting parse empty response Kim Alvefur <zash@zash.se> parents: 3866 diff changeset	438 elseif parsed.name ~= stanza.name then
839224be5299 mod_rest: Skip attempting parse empty response Kim Alvefur <zash@zash.se> parents: 3866 diff changeset	439 module:log("warn", "REST callback responded with the wrong stanza type, got %s but expected %s", parsed.name, stanza.name);
839224be5299 mod_rest: Skip attempting parse empty response Kim Alvefur <zash@zash.se> parents: 3866 diff changeset	440 else
839224be5299 mod_rest: Skip attempting parse empty response Kim Alvefur <zash@zash.se> parents: 3866 diff changeset	441 parsed.attr = {
839224be5299 mod_rest: Skip attempting parse empty response Kim Alvefur <zash@zash.se> parents: 3866 diff changeset	442 from = stanza.attr.to,
839224be5299 mod_rest: Skip attempting parse empty response Kim Alvefur <zash@zash.se> parents: 3866 diff changeset	443 to = stanza.attr.from,
839224be5299 mod_rest: Skip attempting parse empty response Kim Alvefur <zash@zash.se> parents: 3866 diff changeset	444 id = parsed.attr.id or id.medium();
839224be5299 mod_rest: Skip attempting parse empty response Kim Alvefur <zash@zash.se> parents: 3866 diff changeset	445 type = parsed.attr.type,
839224be5299 mod_rest: Skip attempting parse empty response Kim Alvefur <zash@zash.se> parents: 3866 diff changeset	446 ["xml:lang"] = parsed.attr["xml:lang"],
839224be5299 mod_rest: Skip attempting parse empty response Kim Alvefur <zash@zash.se> parents: 3866 diff changeset	447 };
839224be5299 mod_rest: Skip attempting parse empty response Kim Alvefur <zash@zash.se> parents: 3866 diff changeset	448 if parsed.name == "message" and parsed.attr.type == "groupchat" then
839224be5299 mod_rest: Skip attempting parse empty response Kim Alvefur <zash@zash.se> parents: 3866 diff changeset	449 parsed.attr.to = jid.bare(stanza.attr.from);
839224be5299 mod_rest: Skip attempting parse empty response Kim Alvefur <zash@zash.se> parents: 3866 diff changeset	450 end
839224be5299 mod_rest: Skip attempting parse empty response Kim Alvefur <zash@zash.se> parents: 3866 diff changeset	451 if not stanza.attr.type and parsed:get_child("error") then
839224be5299 mod_rest: Skip attempting parse empty response Kim Alvefur <zash@zash.se> parents: 3866 diff changeset	452 parsed.attr.type = "error";
839224be5299 mod_rest: Skip attempting parse empty response Kim Alvefur <zash@zash.se> parents: 3866 diff changeset	453 end
839224be5299 mod_rest: Skip attempting parse empty response Kim Alvefur <zash@zash.se> parents: 3866 diff changeset	454 if parsed.attr.type == "error" then
839224be5299 mod_rest: Skip attempting parse empty response Kim Alvefur <zash@zash.se> parents: 3866 diff changeset	455 parsed.attr.id = stanza.attr.id;
839224be5299 mod_rest: Skip attempting parse empty response Kim Alvefur <zash@zash.se> parents: 3866 diff changeset	456 elseif parsed.name == "iq" then
839224be5299 mod_rest: Skip attempting parse empty response Kim Alvefur <zash@zash.se> parents: 3866 diff changeset	457 parsed.attr.id = stanza.attr.id;
839224be5299 mod_rest: Skip attempting parse empty response Kim Alvefur <zash@zash.se> parents: 3866 diff changeset	458 parsed.attr.type = "result";
839224be5299 mod_rest: Skip attempting parse empty response Kim Alvefur <zash@zash.se> parents: 3866 diff changeset	459 end
839224be5299 mod_rest: Skip attempting parse empty response Kim Alvefur <zash@zash.se> parents: 3866 diff changeset	460 reply = parsed;
3821 11272a3233ce mod_rest: Fix replying to groupchat messages Kim Alvefur <zash@zash.se> parents: 3816 diff changeset	461 end
3795 f51308fcba83 mod_rest: Allow specifying a webhook/callback to handle incoming stanzas Kim Alvefur <zash@zash.se> parents: 3794 diff changeset	462 end
f51308fcba83 mod_rest: Allow specifying a webhook/callback to handle incoming stanzas Kim Alvefur <zash@zash.se> parents: 3794 diff changeset	463
f51308fcba83 mod_rest: Allow specifying a webhook/callback to handle incoming stanzas Kim Alvefur <zash@zash.se> parents: 3794 diff changeset	464 if not reply then
f51308fcba83 mod_rest: Allow specifying a webhook/callback to handle incoming stanzas Kim Alvefur <zash@zash.se> parents: 3794 diff changeset	465 local code_hundreds = code - (code % 100);
f51308fcba83 mod_rest: Allow specifying a webhook/callback to handle incoming stanzas Kim Alvefur <zash@zash.se> parents: 3794 diff changeset	466 if code_hundreds == 200 then
f51308fcba83 mod_rest: Allow specifying a webhook/callback to handle incoming stanzas Kim Alvefur <zash@zash.se> parents: 3794 diff changeset	467 reply = st.reply(stanza);
f51308fcba83 mod_rest: Allow specifying a webhook/callback to handle incoming stanzas Kim Alvefur <zash@zash.se> parents: 3794 diff changeset	468 if stanza.name ~= "iq" then
f51308fcba83 mod_rest: Allow specifying a webhook/callback to handle incoming stanzas Kim Alvefur <zash@zash.se> parents: 3794 diff changeset	469 reply.attr.id = id.medium();
f51308fcba83 mod_rest: Allow specifying a webhook/callback to handle incoming stanzas Kim Alvefur <zash@zash.se> parents: 3794 diff changeset	470 end
f51308fcba83 mod_rest: Allow specifying a webhook/callback to handle incoming stanzas Kim Alvefur <zash@zash.se> parents: 3794 diff changeset	471 -- TODO presence/status=body ?
3797 ed5d7586a61e mod_rest: Map various HTTP status codes to XMPP stanza errors Kim Alvefur <zash@zash.se> parents: 3796 diff changeset	472 elseif code2err[code] then
ed5d7586a61e mod_rest: Map various HTTP status codes to XMPP stanza errors Kim Alvefur <zash@zash.se> parents: 3796 diff changeset	473 reply = st.error_reply(stanza, errors.new(code, nil, code2err));
3795 f51308fcba83 mod_rest: Allow specifying a webhook/callback to handle incoming stanzas Kim Alvefur <zash@zash.se> parents: 3794 diff changeset	474 elseif code_hundreds == 400 then
3810 91ff86fc3b20 mod_rest: Factor out payload parsing Kim Alvefur <zash@zash.se> parents: 3807 diff changeset	475 reply = st.error_reply(stanza, "modify", "bad-request", body);
3795 f51308fcba83 mod_rest: Allow specifying a webhook/callback to handle incoming stanzas Kim Alvefur <zash@zash.se> parents: 3794 diff changeset	476 elseif code_hundreds == 500 then
3810 91ff86fc3b20 mod_rest: Factor out payload parsing Kim Alvefur <zash@zash.se> parents: 3807 diff changeset	477 reply = st.error_reply(stanza, "cancel", "internal-server-error", body);
3795 f51308fcba83 mod_rest: Allow specifying a webhook/callback to handle incoming stanzas Kim Alvefur <zash@zash.se> parents: 3794 diff changeset	478 else
3810 91ff86fc3b20 mod_rest: Factor out payload parsing Kim Alvefur <zash@zash.se> parents: 3807 diff changeset	479 reply = st.error_reply(stanza, "cancel", "undefined-condition", body);
3795 f51308fcba83 mod_rest: Allow specifying a webhook/callback to handle incoming stanzas Kim Alvefur <zash@zash.se> parents: 3794 diff changeset	480 end
f51308fcba83 mod_rest: Allow specifying a webhook/callback to handle incoming stanzas Kim Alvefur <zash@zash.se> parents: 3794 diff changeset	481 end
f51308fcba83 mod_rest: Allow specifying a webhook/callback to handle incoming stanzas Kim Alvefur <zash@zash.se> parents: 3794 diff changeset	482
3798 9b4fd2553365 mod_rest: Handle receipt requests on message stanzas Kim Alvefur <zash@zash.se> parents: 3797 diff changeset	483 if receipt then
9b4fd2553365 mod_rest: Handle receipt requests on message stanzas Kim Alvefur <zash@zash.se> parents: 3797 diff changeset	484 reply:add_direct_child(receipt);
9b4fd2553365 mod_rest: Handle receipt requests on message stanzas Kim Alvefur <zash@zash.se> parents: 3797 diff changeset	485 end
9b4fd2553365 mod_rest: Handle receipt requests on message stanzas Kim Alvefur <zash@zash.se> parents: 3797 diff changeset	486
3803 dc2b5a412286 mod_rest: Log sent and received stanzas in style of mod_c2s etc Kim Alvefur <zash@zash.se> parents: 3802 diff changeset	487 module:log("debug", "Received[rest]: %s", reply:top_tag());
dc2b5a412286 mod_rest: Log sent and received stanzas in style of mod_c2s etc Kim Alvefur <zash@zash.se> parents: 3802 diff changeset	488
3795 f51308fcba83 mod_rest: Allow specifying a webhook/callback to handle incoming stanzas Kim Alvefur <zash@zash.se> parents: 3794 diff changeset	489 origin.send(reply);
4247 1f93fa24611d mod_rest: Use promise based HTTP client API Kim Alvefur <zash@zash.se> parents: 4245 diff changeset	490 end,
1f93fa24611d mod_rest: Use promise based HTTP client API Kim Alvefur <zash@zash.se> parents: 4245 diff changeset	491 function (err)
1f93fa24611d mod_rest: Use promise based HTTP client API Kim Alvefur <zash@zash.se> parents: 4245 diff changeset	492 module:log_status("error", "Could not connect to callback URL %q: %s", rest_url, err);
1f93fa24611d mod_rest: Use promise based HTTP client API Kim Alvefur <zash@zash.se> parents: 4245 diff changeset	493 origin.send(st.error_reply(stanza, "wait", "recipient-unavailable", err.text));
4249 64aa1d9d70ac mod_rest: Catch and log errors in callback promise chain Kim Alvefur <zash@zash.se> parents: 4247 diff changeset	494 end):catch(function (err)
64aa1d9d70ac mod_rest: Catch and log errors in callback promise chain Kim Alvefur <zash@zash.se> parents: 4247 diff changeset	495 module:log("error", "Error[rest]: %s", err);
3795 f51308fcba83 mod_rest: Allow specifying a webhook/callback to handle incoming stanzas Kim Alvefur <zash@zash.se> parents: 3794 diff changeset	496 end);
f51308fcba83 mod_rest: Allow specifying a webhook/callback to handle incoming stanzas Kim Alvefur <zash@zash.se> parents: 3794 diff changeset	497
f51308fcba83 mod_rest: Allow specifying a webhook/callback to handle incoming stanzas Kim Alvefur <zash@zash.se> parents: 3794 diff changeset	498 return true;
f51308fcba83 mod_rest: Allow specifying a webhook/callback to handle incoming stanzas Kim Alvefur <zash@zash.se> parents: 3794 diff changeset	499 end
f51308fcba83 mod_rest: Allow specifying a webhook/callback to handle incoming stanzas Kim Alvefur <zash@zash.se> parents: 3794 diff changeset	500
f51308fcba83 mod_rest: Allow specifying a webhook/callback to handle incoming stanzas Kim Alvefur <zash@zash.se> parents: 3794 diff changeset	501 if module:get_host_type() == "component" then
f51308fcba83 mod_rest: Allow specifying a webhook/callback to handle incoming stanzas Kim Alvefur <zash@zash.se> parents: 3794 diff changeset	502 module:hook("iq/bare", handle_stanza, -1);
f51308fcba83 mod_rest: Allow specifying a webhook/callback to handle incoming stanzas Kim Alvefur <zash@zash.se> parents: 3794 diff changeset	503 module:hook("message/bare", handle_stanza, -1);
f51308fcba83 mod_rest: Allow specifying a webhook/callback to handle incoming stanzas Kim Alvefur <zash@zash.se> parents: 3794 diff changeset	504 module:hook("presence/bare", handle_stanza, -1);
f51308fcba83 mod_rest: Allow specifying a webhook/callback to handle incoming stanzas Kim Alvefur <zash@zash.se> parents: 3794 diff changeset	505 module:hook("iq/full", handle_stanza, -1);
f51308fcba83 mod_rest: Allow specifying a webhook/callback to handle incoming stanzas Kim Alvefur <zash@zash.se> parents: 3794 diff changeset	506 module:hook("message/full", handle_stanza, -1);
f51308fcba83 mod_rest: Allow specifying a webhook/callback to handle incoming stanzas Kim Alvefur <zash@zash.se> parents: 3794 diff changeset	507 module:hook("presence/full", handle_stanza, -1);
f51308fcba83 mod_rest: Allow specifying a webhook/callback to handle incoming stanzas Kim Alvefur <zash@zash.se> parents: 3794 diff changeset	508 module:hook("iq/host", handle_stanza, -1);
f51308fcba83 mod_rest: Allow specifying a webhook/callback to handle incoming stanzas Kim Alvefur <zash@zash.se> parents: 3794 diff changeset	509 module:hook("message/host", handle_stanza, -1);
f51308fcba83 mod_rest: Allow specifying a webhook/callback to handle incoming stanzas Kim Alvefur <zash@zash.se> parents: 3794 diff changeset	510 module:hook("presence/host", handle_stanza, -1);
f51308fcba83 mod_rest: Allow specifying a webhook/callback to handle incoming stanzas Kim Alvefur <zash@zash.se> parents: 3794 diff changeset	511 else
f51308fcba83 mod_rest: Allow specifying a webhook/callback to handle incoming stanzas Kim Alvefur <zash@zash.se> parents: 3794 diff changeset	512 -- Don't override everything on normal VirtualHosts
f51308fcba83 mod_rest: Allow specifying a webhook/callback to handle incoming stanzas Kim Alvefur <zash@zash.se> parents: 3794 diff changeset	513 module:hook("iq/host", handle_stanza, -1);
f51308fcba83 mod_rest: Allow specifying a webhook/callback to handle incoming stanzas Kim Alvefur <zash@zash.se> parents: 3794 diff changeset	514 module:hook("message/host", handle_stanza, -1);
f51308fcba83 mod_rest: Allow specifying a webhook/callback to handle incoming stanzas Kim Alvefur <zash@zash.se> parents: 3794 diff changeset	515 module:hook("presence/host", handle_stanza, -1);
f51308fcba83 mod_rest: Allow specifying a webhook/callback to handle incoming stanzas Kim Alvefur <zash@zash.se> parents: 3794 diff changeset	516 end
f51308fcba83 mod_rest: Allow specifying a webhook/callback to handle incoming stanzas Kim Alvefur <zash@zash.se> parents: 3794 diff changeset	517 end
3842 501c7edc8c37 mod_rest: Encode errors as JSON Kim Alvefur <zash@zash.se> parents: 3832 diff changeset	518
3929 bd687d586a8a mod_rest: Separate lists of mediatypes for input, output and errors Kim Alvefur <zash@zash.se> parents: 3926 diff changeset	519 local supported_errors = {
bd687d586a8a mod_rest: Separate lists of mediatypes for input, output and errors Kim Alvefur <zash@zash.se> parents: 3926 diff changeset	520 "text/html",
3931 2e8b284ac8b3 mod_rest: Add an XML error formatter (fixes #1499) Kim Alvefur <zash@zash.se> parents: 3930 diff changeset	521 "application/xmpp+xml",
3929 bd687d586a8a mod_rest: Separate lists of mediatypes for input, output and errors Kim Alvefur <zash@zash.se> parents: 3926 diff changeset	522 "application/json",
bd687d586a8a mod_rest: Separate lists of mediatypes for input, output and errors Kim Alvefur <zash@zash.se> parents: 3926 diff changeset	523 };
bd687d586a8a mod_rest: Separate lists of mediatypes for input, output and errors Kim Alvefur <zash@zash.se> parents: 3926 diff changeset	524
3873 fea0c1bed1a0 mod_rest: Back out 513a8a7fab41 Kim Alvefur <zash@zash.se> parents: 3872 diff changeset	525 local http_server = require "net.http.server";
fea0c1bed1a0 mod_rest: Back out 513a8a7fab41 Kim Alvefur <zash@zash.se> parents: 3872 diff changeset	526 module:hook_object_event(http_server, "http-error", function (event)
fea0c1bed1a0 mod_rest: Back out 513a8a7fab41 Kim Alvefur <zash@zash.se> parents: 3872 diff changeset	527 local request, response = event.request, event.response;
3931 2e8b284ac8b3 mod_rest: Add an XML error formatter (fixes #1499) Kim Alvefur <zash@zash.se> parents: 3930 diff changeset	528 local response_as = decide_type(request and request.headers.accept or "", supported_errors);
2e8b284ac8b3 mod_rest: Add an XML error formatter (fixes #1499) Kim Alvefur <zash@zash.se> parents: 3930 diff changeset	529 if response_as == "application/xmpp+xml" then
2e8b284ac8b3 mod_rest: Add an XML error formatter (fixes #1499) Kim Alvefur <zash@zash.se> parents: 3930 diff changeset	530 if response then
2e8b284ac8b3 mod_rest: Add an XML error formatter (fixes #1499) Kim Alvefur <zash@zash.se> parents: 3930 diff changeset	531 response.headers.content_type = "application/xmpp+xml";
2e8b284ac8b3 mod_rest: Add an XML error formatter (fixes #1499) Kim Alvefur <zash@zash.se> parents: 3930 diff changeset	532 end
2e8b284ac8b3 mod_rest: Add an XML error formatter (fixes #1499) Kim Alvefur <zash@zash.se> parents: 3930 diff changeset	533 local stream_error = st.stanza("error", { xmlns = "http://etherx.jabber.org/streams" });
2e8b284ac8b3 mod_rest: Add an XML error formatter (fixes #1499) Kim Alvefur <zash@zash.se> parents: 3930 diff changeset	534 if event.error then
2e8b284ac8b3 mod_rest: Add an XML error formatter (fixes #1499) Kim Alvefur <zash@zash.se> parents: 3930 diff changeset	535 stream_error:tag(event.error.condition, {xmlns = 'urn:ietf:params:xml:ns:xmpp-streams' }):up();
2e8b284ac8b3 mod_rest: Add an XML error formatter (fixes #1499) Kim Alvefur <zash@zash.se> parents: 3930 diff changeset	536 if event.error.text then
2e8b284ac8b3 mod_rest: Add an XML error formatter (fixes #1499) Kim Alvefur <zash@zash.se> parents: 3930 diff changeset	537 stream_error:text_tag("text", event.error.text, {xmlns = 'urn:ietf:params:xml:ns:xmpp-streams' });
2e8b284ac8b3 mod_rest: Add an XML error formatter (fixes #1499) Kim Alvefur <zash@zash.se> parents: 3930 diff changeset	538 end
2e8b284ac8b3 mod_rest: Add an XML error formatter (fixes #1499) Kim Alvefur <zash@zash.se> parents: 3930 diff changeset	539 end
2e8b284ac8b3 mod_rest: Add an XML error formatter (fixes #1499) Kim Alvefur <zash@zash.se> parents: 3930 diff changeset	540 return tostring(stream_error);
2e8b284ac8b3 mod_rest: Add an XML error formatter (fixes #1499) Kim Alvefur <zash@zash.se> parents: 3930 diff changeset	541 elseif response_as == "application/json" then
3873 fea0c1bed1a0 mod_rest: Back out 513a8a7fab41 Kim Alvefur <zash@zash.se> parents: 3872 diff changeset	542 if response then
fea0c1bed1a0 mod_rest: Back out 513a8a7fab41 Kim Alvefur <zash@zash.se> parents: 3872 diff changeset	543 response.headers.content_type = "application/json";
3842 501c7edc8c37 mod_rest: Encode errors as JSON Kim Alvefur <zash@zash.se> parents: 3832 diff changeset	544 end
3873 fea0c1bed1a0 mod_rest: Back out 513a8a7fab41 Kim Alvefur <zash@zash.se> parents: 3872 diff changeset	545 return json.encode({
fea0c1bed1a0 mod_rest: Back out 513a8a7fab41 Kim Alvefur <zash@zash.se> parents: 3872 diff changeset	546 type = "error",
fea0c1bed1a0 mod_rest: Back out 513a8a7fab41 Kim Alvefur <zash@zash.se> parents: 3872 diff changeset	547 error = event.error,
fea0c1bed1a0 mod_rest: Back out 513a8a7fab41 Kim Alvefur <zash@zash.se> parents: 3872 diff changeset	548 code = event.code,
fea0c1bed1a0 mod_rest: Back out 513a8a7fab41 Kim Alvefur <zash@zash.se> parents: 3872 diff changeset	549 });
fea0c1bed1a0 mod_rest: Back out 513a8a7fab41 Kim Alvefur <zash@zash.se> parents: 3872 diff changeset	550 end
3933 93147b89ea67 mod_rest: Avoid interfering with mod_http_oauth2 errors (fixes #1500) Kim Alvefur <zash@zash.se> parents: 3931 diff changeset	551 end, 1);

prosody-modules

e58ec4b3cf90

mod_rest/mod_rest.lua

Software / code / prosody-modules

Annotate

mod_rest/mod_rest.lua @ 4734:e58ec4b3cf90

Software `/` code `/` prosody-modules