Software / code / prosody-modules
File
mod_dnsbl/mod_dnsbl.lua @ 6301:fa45ae704b79
mod_cloud_notify: Update Readme
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,109 +1,106 @@
----
-labels:
-- 'Stage-Beta'
-summary: 'XEP-0357: Cloud push notifications'
----
+# Introduction
-Introduction
-============
+This module enables support for sending "push notifications" to clients
+that need it, typically those running on certain mobile devices.
-This module enables support for sending "push notifications" to clients that
-need it, typically those running on certain mobile devices.
+As well as this module, your client must support push notifications (the
+apps that need it generally do, of course) and the app developer's push
+gateway must be reachable from your Prosody server (this happens over a
+normal XMPP server-to-server 's2s' connection).
-As well as this module, your client must support push notifications (the apps
-that need it generally do, of course) and the app developer's push gateway
-must be reachable from your Prosody server (this happens over a normal XMPP
-server-to-server 's2s' connection).
-
-Details
-=======
+# Details
Some platforms, notably Apple's iOS and many versions of Android, impose
-limits that prevent applications from running or accessing the network in the
-background. This makes it difficult or impossible for an XMPP application to
-remain reliably connected to a server to receive messages.
-
-In order for messaging and other apps to receive notifications, the OS vendors
-run proprietary servers that their OS maintains a permanent connection to in
-the background. Then they provide APIs to application developers that allow
-sending notifications to specific devices via those servers.
+limits that prevent applications from running or accessing the network
+in the background. This makes it difficult or impossible for an XMPP
+application to remain reliably connected to a server to receive
+messages.
-When you connect to your server with an app that requires push notifications,
-it will use this module to set up a "push registration". When you receive
-a message but your device is not connected to the server, this module will
-generate a notification and send it to the push gateway operated by your
-application's developers). Their gateway will then connect to your device's
-OS vendor and ask them to forward the notification to your device. When your
-device receives the notification, it will display it or wake up the app so it
-can connect to XMPP and receive any pending messages.
+In order for messaging and other apps to receive notifications, the OS
+vendors run proprietary servers that their OS maintains a permanent
+connection to in the background. Then they provide APIs to application
+developers that allow sending notifications to specific devices via
+those servers.
-This protocol is described for developers in [XEP-0357: Push Notifications].
+When you connect to your server with an app that requires push
+notifications, it will use this module to set up a "push registration".
+When you receive a message but your device is not connected to the
+server, this module will generate a notification and send it to the push
+gateway operated by your application's developers). Their gateway will
+then connect to your device's OS vendor and ask them to forward the
+notification to your device. When your device receives the notification,
+it will display it or wake up the app so it can connect to XMPP and
+receive any pending messages.
-For this module to work reliably, you must have [mod_smacks], [mod_mam] and
-[mod_carbons] also enabled on your server.
+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.
-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].
+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\].
-Configuration
-=============
+# Configuration
- Option Default Description
- ------------------------------------ ----------------- -------------------------------------------------------------------------------------------------------------------
- `push_notification_important_body` `New Message!` The body text to use when the stanza is important (see above), no message body is sent if this is empty
- `push_max_errors` `16` How much persistent push errors are tolerated before notifications for the identifier in question are disabled
- `push_max_devices` `5` The number of allowed devices per user (the oldest devices are automatically removed if this threshold is reached)
- `push_max_hibernation_timeout` `259200` (72h) Number of seconds to extend the smacks timeout if no push was triggered yet (default: 72 hours)
- `push_notification_with_body` (\*) `false` Whether or not to send the real message body to remote pubsub node. Without end-to-end encryption, enabling this may expose your message contents to your client developers and OS vendor. Not recommended.
- `push_notification_with_sender` (\*) `false` Whether or not to send the real message sender to remote pubsub node. Enabling this may expose your contacts to your client developers and OS vendor. Not recommended.
+ Option Default Description
+ -------------------------------------- ---------------- -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
+ `push_notification_important_body` `New Message!` The body text to use when the stanza is important (see above), no message body is sent if this is empty
+ `push_max_errors` `16` How much persistent push errors are tolerated before notifications for the identifier in question are disabled
+ `push_max_devices` `5` The number of allowed devices per user (the oldest devices are automatically removed if this threshold is reached)
+ `push_max_hibernation_timeout` `259200` (72h) Number of seconds to extend the smacks timeout if no push was triggered yet (default: 72 hours)
+ `push_notification_with_body` (\*) `false` Whether or not to send the real message body to remote pubsub node. Without end-to-end encryption, enabling this may expose your message contents to your client developers and OS vendor. Not recommended.
+ `push_notification_with_sender` (\*) `false` Whether or not to send the real message sender to remote pubsub node. Enabling this may expose your contacts to your client developers and OS vendor. Not recommended.
-(\*) There are privacy implications for enabling these options.
+(\*) There are privacy implications for enabling these options.[^1]
-Internal design notes
-=====================
+# 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 outlined [here](//mail.jabber.org/pipermail/standards/2016-February/030925.html) are all honored[^2].
+App servers are notified about offline messages, messages stored by
+\[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:
-`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 delayed by a certain amount of seconds
-configurable with the [mod_smacks] setting `smacks_max_ack_delay`.
+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
+delayed by a certain amount of seconds configurable with the
+\[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 read timeout or
-connection close didn't already happen) but also aren't responding to acknowledgement
-request in a timely manner. This setting thus allows conversations to be smoother
-under such circumstances.
+The `smacks_max_ack_delay` setting allows to send out notifications to
+clients which aren't already in smacks hibernation state (because the
+read timeout or connection close didn't already happen) but also aren't
+responding to acknowledgement request in a timely manner. This setting
+thus allows conversations to be smoother under such circumstances.
-The new event `cloud-notify-ping` can be used by any module to send out a cloud
-notification to either all registered endpoints for the given user or only the endpoints
-given in the event data.
+The new event `cloud-notify-ping` can be used by any module to send out
+a cloud notification to either all registered endpoints for the given
+user or only the endpoints given in the event data.
-The config setting `push_notification_important_body` can be used to specify an alternative
-body text to send to the remote pubsub node if the stanza is encrypted or has a body.
-This way the real contents of the message aren't revealed to the push appserver but it
-can still see that the push is important.
-This is used by Chatsecure on iOS to send out high priority pushes in those cases for example.
+The config setting `push_notification_important_body` can be used to
+specify an alternative body text to send to the remote pubsub node if
+the stanza is encrypted or has a body. This way the real contents of the
+message aren't revealed to the push appserver but it can still see that
+the push is important. This is used by Chatsecure on iOS to send out
+high priority pushes in those cases for example.
-Compatibility
-=============
-
-**Note:** This module should be used with Lua 5.2 and higher. Using it with
-Lua 5.1 may cause push notifications to not be sent to some clients.
+# Compatibility
------- -----------------------------------------------------------------------------
- trunk Works
- 0.12 Works
- 0.11 Works
- 0.10 Works
- 0.9 Support dropped, use last supported version [675726ab06d3](//hg.prosody.im/prosody-modules/raw-file/675726ab06d3/mod_cloud_notify/mod_cloud_notify.lua)
------- -----------------------------------------------------------------------------
+**Note:** This module should be used with Lua 5.2 and higher. Using it
+with Lua 5.1 may cause push notifications to not be sent to some
+clients.
+ ------- -----------------------------------------------------------------
+ trunk Works as of 25-06-13
+ 13 Works
+ 0.12 Works
+ ------- -----------------------------------------------------------------
-[^1]: The service which is expected to forward notifications to something like Google Cloud Messaging or Apple Notification Service
-[^2]: [business_rules.markdown](//hg.prosody.im/prosody-modules/file/tip/mod_cloud_notify/business_rules.markdown)
+[^1]: The service which is expected to forward notifications to
+ something like Google Cloud Messaging or Apple Notification Service
+
+[^2]: [business_rules.md](//hg.prosody.im/prosody-modules/file/tip/mod_cloud_notify/business_rules.md)
| author | Menel <menel@snikket.de> |
|---|---|
| date | Fri, 13 Jun 2025 10:36:52 +0200 |
| parent | 6161:99860e1b817d |
line wrap: on
line source
local lfs = require "lfs"; local adns = require "net.adns"; local it = require "util.iterators"; local parse_cidr = require "util.ip".parse_cidr; local parse_ip = require "util.ip".new_ip; local promise = require "util.promise"; local set = require "util.set"; local st = require "util.stanza"; local render_message = require "util.interpolation".new("%b{}", function (s) return s; end); local trie = module:require("mod_anti_spam/trie"); local dnsbls_config_raw = module:get_option("dnsbls"); local default_dnsbl_flag = module:get_option_string("dnsbl_flag", "dnsbl_hit"); local default_dnsbl_message = module:get_option("dnsbl_message"); if not dnsbls_config_raw then module:log_status("error", "No 'dnsbls' in config file"); return; end local dnsbls = set.new(); local dnsbls_config = {}; for k, v in ipairs(dnsbls_config_raw) do local dnsbl_name, dnsbl_config; if type(k) == "string" then dnsbl_name = k; dnsbl_config = v; else dnsbl_name = v; dnsbl_config = {}; end dnsbls:add(dnsbl_name); dnsbls_config[dnsbl_name] = dnsbl_config; end local function read_dnsbl_file(filename) local t = trie.new(); local f, err = io.open(filename); if not f then module:log("error", "Failed to read file: %s", err); return t; end local n_line, n_added = 0, 0; for line in f:lines() do n_line = n_line + 1; line = line:gsub("#.+$", ""):match("^%s*(.-)%s*$"); if line == "" then -- luacheck: ignore 542 -- Skip else local parsed_ip, parsed_bits = parse_cidr(line); if not parsed_ip then -- Skip module:log("warn", "Failed to parse IP/CIDR on %s:%d", filename, n_line); else if not parsed_bits then -- Default to full length of IP address parsed_bits = #parsed_ip.packed * 8; end t:add_subnet(parsed_ip, parsed_bits); n_added = n_added + 1; end end end module:log("info", "Loaded %d entries from %s", n_added, filename); return t; end local ipsets = {}; local ipsets_last_updated = {}; function reload_file_dnsbls() for dnsbl in dnsbls do if dnsbl:byte(1) == 64 then -- '@' local filename = dnsbl:sub(2); local file_last_updated = lfs.attributes(filename, "change"); if (ipsets_last_updated[dnsbl] or 0) < file_last_updated then ipsets[dnsbl] = read_dnsbl_file(filename); ipsets_last_updated[dnsbl] = file_last_updated; end end end end module:hook_global("config-reloaded", reload_file_dnsbls); reload_file_dnsbls(); local mod_flags = module:depends("flags"); local function reverse(ip, suffix) local a,b,c,d = ip:match("^(%d+).(%d+).(%d+).(%d+)$"); if not a then return end return ("%d.%d.%d.%d.%s"):format(d,c,b,a, suffix); end function check_dnsbl(ip_address, dnsbl, callback, ud) if dnsbl:byte(1) == 64 then -- '@' local parsed_ip = parse_ip(ip_address); if not parsed_ip then module:log("warn", "Failed to parse IP address: %s", ip_address); callback(ud, false, dnsbl); return; end callback(ud, not not ipsets[dnsbl]:contains_ip(parsed_ip), dnsbl); return; else if ip_address:sub(1,7):lower() == "::ffff:" then ip_address = ip_address:sub(8); end local rbl_ip = reverse(ip_address, dnsbl); if not rbl_ip then return; end module:log("debug", "Sending DNSBL lookup for %s", ip_address); adns.lookup(function (reply) local hit = not not (reply and reply[1]); module:log("debug", "Received DNSBL result for %s: %s", ip_address, hit and "present" or "absent"); callback(ud, hit, dnsbl); end, rbl_ip); end end local function handle_dnsbl_register_result(registration_event, hit, dnsbl) if not hit then return; end if registration_event.dnsbl_match then return; end registration_event.dnsbl_match = true; local username = registration_event.username; local flag = dnsbls_config[dnsbl].flag or default_dnsbl_flag; module:log("info", "Flagging %s for user %s registered from %s matching %s", flag, username, registration_event.ip, dnsbl); mod_flags:add_flag(username, flag, "Matched "..dnsbl); local msg = dnsbls_config[dnsbl].message or default_dnsbl_message; if msg then module:log("debug", "Sending warning message to %s", username); local msg_stanza = st.message( { to = username.."@"..module.host; from = module.host; }, render_message(msg, { registration = registration_event }) ); module:send(msg_stanza); end end module:hook("user-registered", function (event) local session = event.session; local ip = event.ip or (session and session.ip); if not ip then return; end if not event.ip then event.ip = ip; end for dnsbl in dnsbls do check_dnsbl(ip, dnsbl, handle_dnsbl_register_result, event); end end); module:add_item("account-trait", { name = "register-dnsbl-hit"; prob_bad_true = 0.6; prob_bad_false = 0.4; }); module:hook("get-account-traits", function (event) event.traits["register-dnsbl-hit"] = mod_flags.has_flag(event.username, default_dnsbl_flag); end); module:add_item("shell-command", { section = "dnsbl"; section_desc = "Manage DNS blocklists"; name = "lists"; desc = "Show all lists currently in use on the specified host"; args = { { name = "host", type = "string" }; }; host_selector = "host"; handler = function(self, host) --luacheck: ignore 212/self 212/host local count = 0; for list in dnsbls do count = count + 1; self.session.print(list); end return true, ("%d lists"):format(count); end; }); module:add_item("shell-command", { section = "dnsbl"; section_desc = "Manage DNS blocklists"; name = "check"; desc = "Check an IP against the configured block lists"; args = { { name = "host", type = "string" }; { name = "ip_address", type = "string" }; }; host_selector = "host"; handler = function(self, host, ip_address) --luacheck: ignore 212/self 212/host local parsed_ip = parse_ip(ip_address); if not parsed_ip then return false, "Failed to parse IP address"; end local matches, total = 0, 0; local promises = {}; for dnsbl in dnsbls do total = total + 1; promises[dnsbl] = promise.new(function (resolve) check_dnsbl(parsed_ip, dnsbl, resolve, true); end); end return promise.all_settled(promises):next(function (results) for dnsbl, result in it.sorted_pairs(results) do local msg; if result.status == "fulfilled" then if result.value then msg = "[X]"; matches = matches + 1; else msg = "[ ]"; end else msg = "[?]"; end print(msg, dnsbl); end return ("Found in %d of %d lists"):format(matches, total); end); end; });