Software / code / prosody-modules
File
mod_unified_push/mod_unified_push.lua @ 6302:06fbbd45ba75
mod_cloud_notify: Readme: fix links and labels that were removed in the last commit
diff --git a/mod_cloud_notify/README.md b/mod_cloud_notify/README.md
--- a/mod_cloud_notify/README.md
+++ b/mod_cloud_notify/README.md
@@ -1,3 +1,9 @@
+----
+-labels:
+-- 'Stage-Beta'
+-summary: 'XEP-0357: Cloud push notifications'
+----
+
# Introduction
This module enables support for sending "push notifications" to clients
@@ -32,15 +38,15 @@ notification to your device. When your d
it will display it or wake up the app so it can connect to XMPP and
receive any pending messages.
-This protocol is described for developers in \[XEP-0357: Push
-Notifications\].
+This protocol is described for developers in [XEP-0357: Push
+Notifications].
-For this module to work reliably, you must have \[mod_smacks\],
-\[mod_mam\] and \[mod_carbons\] also enabled on your server.
+For this module to work reliably, you must have [mod_smacks],
+[mod_mam] and [mod_carbons] also enabled on your server.
Some clients, notably Siskin and Snikket iOS need some additional
extensions that are not currently defined in a standard XEP. To support
-these clients, see \[mod_cloud_notify_extensions\].
+these clients, see [mod_cloud_notify_extensions].
# Configuration
@@ -58,18 +64,18 @@ these clients, see \[mod_cloud_notify_ex
# Internal design notes
App servers are notified about offline messages, messages stored by
-\[mod_mam\] or messages waiting in the smacks queue. The business rules
+[mod_mam] or messages waiting in the smacks queue. The business rules
outlined
[here](//mail.jabber.org/pipermail/standards/2016-February/030925.html)
are all honored[^2].
-To cooperate with \[mod_smacks\] this module consumes some events:
+To cooperate with [mod_smacks] this module consumes some events:
`smacks-ack-delayed`, `smacks-hibernation-start` and
`smacks-hibernation-end`. These events allow this module to send out
notifications for messages received while the session is hibernated by
-\[mod_smacks\] or even when smacks acknowledgements for messages are
+[mod_smacks] or even when smacks acknowledgements for messages are
delayed by a certain amount of seconds configurable with the
-\[mod_smacks\] setting `smacks_max_ack_delay`.
+[mod_smacks] setting `smacks_max_ack_delay`.
The `smacks_max_ack_delay` setting allows to send out notifications to
clients which aren't already in smacks hibernation state (because the
| author | Menel <menel@snikket.de> |
|---|---|
| date | Fri, 13 Jun 2025 10:44:37 +0200 |
| parent | 5155:18ed655c755d |
line wrap: on
line source
local unified_push_secret = module:get_option_string("unified_push_secret"); local push_registration_ttl = module:get_option_number("unified_push_registration_ttl", 86400); local base64 = require "util.encodings".base64; local datetime = require "util.datetime"; local id = require "util.id"; local jid = require "util.jid"; local jwt = require "util.jwt"; local st = require "util.stanza"; local urlencode = require "util.http".urlencode; local xmlns_up = "http://gultsch.de/xmpp/drafts/unified-push"; module:depends("http"); module:depends("disco"); module:add_feature(xmlns_up); local acl = module:get_option_set("unified_push_acl", { module:get_host_type() == "local" and module.host or module.host:match("^[^%.]+%.(.+)$") }); local function is_jid_permitted(user_jid) for acl_entry in acl do if jid.compare(user_jid, acl_entry) then return true; end end return false; end local function check_sha256(s) if not s then return nil, "no value provided"; end local d = base64.decode(s); if not d then return nil, "invalid base64"; end if #d ~= 32 then return nil, "incorrect decoded length, expected 32"; end return s; end local push_store = module:open_store(); local backends = { jwt = { sign = function (data) return jwt.sign(unified_push_secret, data); end; verify = function (token) local ok, result = jwt.verify(unified_push_secret, token); if not ok then return ok, result; end if result.exp and result.exp < os.time() then return nil, "token-expired"; end return ok, result; end; }; storage = { sign = function (data) local reg_id = id.long(); local ok, err = push_store:set(reg_id, data); if not ok then return nil, err; end return reg_id; end; verify = function (token) if token == "_private" then return nil, "invalid-token"; end local data = push_store:get(token); if not data then return nil, "item-not-found"; elseif data.exp and data.exp < os.time() then push_store:set(token, nil); return nil, "token-expired"; end return true, data; end; }; }; if pcall(require, "util.paseto") and require "util.paseto".v3_local then local paseto = require "util.paseto".v3_local; local state = push_store:get("_private"); local key = state and state.paseto_v3_local_key; if not key then key = paseto.new_key(); push_store:set("_private", { paseto_v3_local_key = key }); end local sign, verify = paseto.init(key); backends.paseto = { sign = sign; verify = function (token) local payload, err = verify(token); if not payload then return nil, err; end return true, payload; end; }; end local backend = module:get_option_string("unified_push_backend", backends.paseto and "paseto" or "storage"); assert(backend ~= "jwt" or unified_push_secret, "required option missing: unified_push_secret"); local function register_route(params) local expiry = os.time() + push_registration_ttl; local token, err = backends[backend].sign({ instance = params.instance; application = params.application; sub = params.jid; exp = expiry; }); if not token then return nil, err; end return { url = module:http_url("push").."/"..urlencode(token); expiry = expiry; }; end -- Handle incoming registration from XMPP client function handle_register(event) module:log("debug", "Push registration request received"); local origin, stanza = event.origin, event.stanza; if not is_jid_permitted(stanza.attr.from) then module:log("debug", "Sender <%s> not permitted to register on this UnifiedPush service", stanza.attr.from); return origin.send(st.error_reply(stanza, "auth", "forbidden")); end local instance, instance_err = check_sha256(stanza.tags[1].attr.instance); if not instance then return origin.send(st.error_reply(stanza, "modify", "bad-request", "instance: "..instance_err)); end local application, application_err = check_sha256(stanza.tags[1].attr.application); if not application then return origin.send(st.error_reply(stanza, "modify", "bad-request", "application: "..application_err)); end local route, register_err = register_route({ instance = instance; application = application; jid = stanza.attr.from; }); if not route then module:log("warn", "Failed to create registration using %s backend: %s", backend, register_err); return origin.send(st.error_reply(stanza, "wait", "internal-server-error")); end module:log("debug", "New push registration successful"); return origin.send(st.reply(stanza):tag("registered", { expiration = datetime.datetime(route.expiry); endpoint = route.url; xmlns = xmlns_up; })); end module:hook("iq-set/host/"..xmlns_up..":register", handle_register); -- Handle incoming POST function handle_push(event, subpath) module:log("debug", "Incoming push received!"); local ok, data = backends[backend].verify(subpath); if not ok then module:log("debug", "Received push to unacceptable token (%s)", data); return 404; end local payload = event.request.body; if not payload or payload == "" then module:log("warn", "Missing or empty push payload"); return 400; elseif #payload > 4096 then module:log("warn", "Push payload too large"); return 413; end local push_id = event.request.id or id.short(); module:log("debug", "Push notification received [%s], relaying to device...", push_id); local push_iq = st.iq({ type = "set", to = data.sub, from = module.host, id = push_id }) :text_tag("push", base64.encode(payload), { instance = data.instance, application = data.application, xmlns = xmlns_up }); return module:send_iq(push_iq):next(function () module:log("debug", "Push notification delivered [%s]", push_id); return 201; end, function (error_event) local e_type, e_cond, e_text = error_event.stanza:get_error(); if e_cond == "item-not-found" or e_cond == "feature-not-implemented" then module:log("debug", "Push rejected [%s]", push_id); return 404; elseif e_cond == "service-unavailable" or e_cond == "recipient-unavailable" then module:log("debug", "Recipient temporarily unavailable [%s]", push_id); return 503; end module:log("warn", "Unexpected push error response: %s/%s/%s", e_type, e_cond, e_text); return 500; end); end module:provides("http", { name = "push"; route = { ["GET /*"] = function (event) event.response.headers.content_type = "application/json"; return [[{"unifiedpush":{"version":1}}]]; end; ["POST /*"] = handle_push; }; });