Mercurial > prosody-modules
view mod_register_json/register_json/mod_register_json.lua @ 6299:5cf5ee23b361
mod_voipms: New Module to send and receive SMS/MMS via VoIP.ms APIs.
diff --git a/mod_voipms/README.md b/mod_voipms/README.md
new file mode 100644
--- /dev/null
+++ b/mod_voipms/README.md
@@ -0,0 +1,51 @@
+---
+labels:
+- 'Stage-Alpha'
+- 'Type-Web'
+summary: Send and receive SMS/MMS via VoIP.ms APIs.
+rockspec:
+ build:
+ modules:
+ mod_voipms: mod_voipms.lua
+...
+
+Introduction
+============
+
+This is a Prosody module to map JIDs to DIDs on VoIP.ms and support sending/receiving SMS/MMS.
+
+Configuration
+=============
+
+| option | type | default |
+|-----------------------|--------|---------|
+| voipms\_api\_username | string | nil |
+| voipms\_api\_password | string | nil |
+| voipms\_query\_key | string | nil |
+| voipms\_jid\_map | table | nil |
+```
+VirtualHost "sms.example.com"
+modules_enabled = {
+ "voipms";
+}
+voipms_api_username = john@example.com -- E-mail registered with VoIP.ms
+voipms_api_password = abcd1234 -- API password configured in VoIP.ms
+voipms_query_key = some_query_key -- query param 'key' part of your URL callback
+voipms_jid_map = {
+ ["your_jid@your_domain.com"] = "+1234567890"
+}
+```
+
+HTTP
+====
+
+The module is served on Prosody's default HTTP ports at the path /voipms. More details on configuring HTTP modules in Prosody can be found in the HTTP documentation.
+
+VoIP.ms Webhook URL
+===================
+
+This module receives the VoIP.ms Webhook URL (POST) at the /voipms endpoint. It uses the sendSMS/sendMMS GET methods against the VoIP.ms APIs. This is an example webhook to use in VoIP.ms:
+
+```
+https://sms.example.com/voipms?key=some_query_key
+```
diff --git a/mod_voipms/mod_voipms.lua b/mod_voipms/mod_voipms.lua
new file mode 100644
--- /dev/null
+++ b/mod_voipms/mod_voipms.lua
@@ -0,0 +1,166 @@
+local http = require "net.http"
+local json = require "util.json"
+local st = require "util.stanza"
+
+local api_username = module:get_option_string("voipms_api_username")
+local api_password = module:get_option_string("voipms_api_password")
+local query_key = module:get_option("voipms_query_key")
+local jid_map = module:get_option("voipms_jid_map") or {}
+local rest_endpoint = "https://voip.ms/api/v1/rest.php"
+
+if not api_username or not api_password or not query_key then
+ module:log("error", "Missing required config values (voipms_api_username, voipms_api_password, voipms_query_key)")
+ return
+end
+
+module:depends("http")
+
+local function normalize_number(num)
+ if not num then return nil end
+ if num:sub(1, 1) ~= "+" then
+ return "+1" .. num
+ end
+ return num
+end
+
+local function extract_query_key(event)
+ return (event.request.url.query or ""):match("key=([^&]+)")
+end
+
+module:provides("http", {
+ route = {
+ ["POST"] = function(event)
+ local req = event.request
+ local body = req.body or ""
+
+ if extract_query_key(event) ~= query_key then
+ module:log("warn", "Unauthorized webhook: missing or invalid key")
+ return { status_code = 403 }
+ end
+
+ local json_payload, err = json.decode(body)
+ if not json_payload then
+ module:log("warn", "Invalid JSON: %s", err or "unknown error")
+ return { status_code = 400 }
+ end
+
+ local payload = json_payload.data and json_payload.data.payload
+ if not payload then
+ module:log("warn", "Missing payload in JSON")
+ return { status_code = 400 }
+ end
+
+ local from = payload.from and payload.from.phone_number
+ local to_list = payload.to or {}
+ local to = #to_list > 0 and to_list[1].phone_number or nil
+
+ if not from or not to then
+ module:log("warn", "Missing phone numbers (from: %s, to: %s)", tostring(from), tostring(to))
+ return { status_code = 400 }
+ end
+
+ local normalized_to = normalize_number(to)
+ local target_jid = nil
+
+ for jid, did in pairs(jid_map) do
+ if normalize_number(did) == normalized_to then
+ target_jid = jid
+ break
+ end
+ end
+
+ if not target_jid then
+ module:log("warn", "No JID mapping for DID %s", normalized_to)
+ return { status_code = 404 }
+ end
+
+ local normalized_from = normalize_number(from)
+ local message_text = payload.text or ""
+
+ local message = st.message({
+ from = normalized_from .. "@" .. module.host,
+ to = target_jid,
+ type = "chat"
+ }):tag("body"):text(message_text):up()
+
+ if payload.media and #payload.media > 0 then
+ for _, media_item in ipairs(payload.media) do
+ if media_item.url then
+ message_text = message_text .. "\n" .. media_item.url
+ message:tag("x", { xmlns = "jabber:x:oob" })
+ :tag("url"):text(media_item.url):up():up()
+ end
+ end
+ end
+
+ module:send(message)
+ module:log("info", "Delivered SMS from %s to %s", normalized_from, target_jid)
+
+ return { status_code = 204 }
+ end
+ }
+})
+
+module:hook("message/bare", function(event)
+ local stanza = event.stanza
+ if stanza.attr.type ~= "chat" then return end
+
+ local from_jid = stanza.attr.from
+ local to_jid = stanza.attr.to
+ local body = stanza:get_child_text("body")
+ if not body or body == "" then return end
+
+ local from_number = jid_map[from_jid]
+ if not from_number then
+ module:log("warn", "No DID mapping for JID %s", from_jid)
+ return
+ end
+
+ local to_number = to_jid:match("^([^@]+)")
+ if not to_number then
+ module:log("warn", "Malformed JID in message.to: %s", to_jid)
+ return
+ end
+
+ to_number = normalize_number(to_number)
+
+ local media_urls = {}
+ for line in body:gmatch("[^\r\n]+") do
+ if line:match("^https?://") then
+ table.insert(media_urls, line)
+ end
+ end
+
+ local method = (#media_urls > 0) and "sendMMS" or "sendSMS"
+ local query = {
+ api_username = api_username,
+ api_password = api_password,
+ method = method,
+ did = from_number,
+ dst = to_number,
+ message = body
+ }
+
+ if method == "sendMMS" then
+ for i, url in ipairs(media_urls) do
+ query["media_url[" .. (i - 1) .. "]"] = url
+ end
+ end
+
+ local query_str = http.formencode(query)
+
+ http.request(rest_endpoint .. "?" .. query_str, {
+ method = "GET";
+ }, function(response_body, code)
+ if code == 200 then
+ local resp, err = json.decode(response_body)
+ if not resp or resp.status ~= "success" then
+ module:log("error", "Failed to send %s: %s", method, err or (resp and resp.status) or "unknown")
+ else
+ module:log("info", "Sent %s from %s to %s", method, from_number, to_number)
+ end
+ else
+ module:log("error", "HTTP error sending %s: code %s", method, tostring(code))
+ end
+ end)
+end)
| author | Chaz <menel@snikket.de> |
|---|---|
| date | Mon, 21 Jul 2025 23:57:37 +0200 |
| parents | 7dbde05b48a9 |
| children |
line wrap: on
line source
-- Expose a simple token based servlet to handle user registrations from web pages -- through Base64 encoded JSON. -- Copyright (C) 2010 - 2013, Marco Cirillo (LW.Org) local datamanager = datamanager local b64_decode = require "util.encodings".base64.decode local b64_encode = require "util.encodings".base64.encode local http_event = require "net.http.server".fire_event local jid_prep = require "util.jid".prep local jid_split = require "util.jid".split local json_decode = require "util.json".decode local nodeprep = require "util.encodings".stringprep.nodeprep local open, os_time, setmt, type = io.open, os.time, setmetatable, type local sha1 = require "util.hashes".sha1 local urldecode = http.urldecode local usermanager = usermanager local uuid_gen = require "util.uuid".generate local timer = require "util.timer" module:depends("http") -- Pick up configuration and setup stores/variables. local auth_token = module:get_option_string("reg_servlet_auth_token") local secure = module:get_option_boolean("reg_servlet_secure", true) local base_path = module:get_option_string("reg_servlet_base", "/register_account/") local throttle_time = module:get_option_number("reg_servlet_ttime", nil) local whitelist = module:get_option_set("reg_servlet_wl", {}) local blacklist = module:get_option_set("reg_servlet_bl", {}) local fm_patterns = module:get_option("reg_servlet_filtered_mails", {}) if type(fm_patterns) ~= "table" then fm_patterns = {} end local files_base = module.path:gsub("/[^/]+$","") .. "/template/" local recent_ips = {} local pending = {} local pending_node = {} -- Setup hashes data structure hashes = { _index = {} } local hashes_mt = {} ; hashes_mt.__index = hashes_mt function hashes_mt:add(node, mail) local _hash = b64_encode(sha1(mail)) if not self:exists(_hash) then self[_hash] = node ; self._index[node] = _hash ; self:save() return true else return false end end function hashes_mt:exists(hash) if hashes[hash] then return true else return false end end function hashes_mt:remove(node) local _hash = self._index[node] if _hash then self[_hash] = nil ; self._index[node] = nil ; self:save() end end function hashes_mt:save() if not datamanager.store("register_json", module.host, "hashes", hashes) then module:log("error", "Failed to save the mail addresses' hashes store.") end end local function check_mail(address) for _, pattern in ipairs(fm_patterns) do if address:match(pattern) then return false end end return true end -- Begin local function handle(code, message) return http_event("http-error", { code = code, message = message }) end local function http_response(event, code, message, headers) local response = event.response if headers then for header, data in pairs(headers) do response.headers[header] = data end end response.status_code = code response:send(handle(code, message)) end local function handle_req(event) local request = event.request if secure and not request.secure then return nil end if request.method ~= "POST" then return http_response(event, 405, "Bad method.", {["Allow"] = "POST"}) end local req_body -- We check that what we have is valid JSON wise else we throw an error... if not pcall(function() req_body = json_decode(b64_decode(request.body)) end) then module:log("debug", "Data submitted for user registration by %s failed to Decode.", user) return http_response(event, 400, "Decoding failed.") else -- Decode JSON data and check that all bits are there else throw an error if req_body["username"] == nil or req_body["password"] == nil or req_body["ip"] == nil or req_body["mail"] == nil or req_body["auth_token"] == nil then module:log("debug", "%s supplied an insufficent number of elements or wrong elements for the JSON registration", user) return http_response(event, 400, "Invalid syntax.") end -- Set up variables local username, password, ip, mail, token = req_body.username, req_body.password, req_body.ip, req_body.mail, req_body.auth_token -- Check if user is an admin of said host if token ~= auth_token then module:log("warn", "%s tried to retrieve a registration token for %s@%s", request.ip, username, module.host) return http_response(event, 401, "Auth token is invalid! The attempt has been logged.") else -- Blacklist can be checked here. if blacklist:contains(ip) then module:log("warn", "Attempt of reg. submission to the JSON servlet from blacklisted address: %s", ip) return http_response(event, 403, "The specified address is blacklisted, sorry.") end if not check_mail(mail) then module:log("warn", "%s attempted to use a mail address (%s) matching one of the forbidden patterns.", ip, mail) return http_response(event, 403, "Requesting to register using this E-Mail address is forbidden, sorry.") end -- We first check if the supplied username for registration is already there. -- And nodeprep the username username = nodeprep(username) if not username then module:log("debug", "An username containing invalid characters was supplied: %s", req_body["username"]) return http_response(event, 406, "Supplied username contains invalid characters, see RFC 6122.") else if pending_node[username] then module:log("warn", "%s attempted to submit a registration request but another request for that user (%s) is pending", ip, username) return http_response(event, 401, "Another user registration by that username is pending.") end if not usermanager.user_exists(username, module.host) then -- if username fails to register successive requests shouldn't be throttled until one is successful. if throttle_time and not whitelist:contains(ip) then if not recent_ips[ip] then recent_ips[ip] = os_time() else if os_time() - recent_ips[ip] < throttle_time then recent_ips[ip] = os_time() module:log("warn", "JSON Registration request from %s has been throttled.", req_body["ip"]) return http_response(event, 503, "Request throttled, wait a bit and try again.") end recent_ips[ip] = os_time() end end local uuid = uuid_gen() if not hashes:add(username, mail) then module:log("warn", "%s (%s) attempted to register to the server with an E-Mail address we already possess the hash of.", username, ip) return http_response(event, 409, "The E-Mail Address provided matches the hash associated to an existing account.") end pending[uuid] = { node = username, password = password, ip = ip } pending_node[username] = uuid timer.add_task(300, function() if pending[uuid] then pending[uuid] = nil pending_node[username] = nil hashes:remove(username) end end) module:log("info", "%s (%s) submitted a registration request and is awaiting final verification", username, uuid) return uuid else module:log("debug", "%s registration data submission failed (user already exists)", username) return http_response(event, 409, "User already exists.") end end end end end local function open_file(file) local f, err = open(file, "rb"); if not f then return nil end local data = f:read("*a") ; f:close() return data end local function r_template(event, type) local data = open_file(files_base..type.."_t.html") if data then data = data:gsub("%%REG%-URL", base_path.."verify/") return data else return http_response(event, 500, "Failed to obtain template.") end end local function handle_verify(event, path) local request = event.request local body = request.body if secure and not request.secure then return nil end local valid_files = { ["css/style.css"] = files_base.."css/style.css", ["images/tile.png"] = files_base.."images/tile.png", ["images/header.png"] = files_base.."images/header.png" } if request.method == "GET" then if path == "" then return r_template(event, "form") end if valid_files[path] then local data = open_file(valid_files[path]) if data then return data else return http_response(event, 404, "Not found.") end end elseif request.method == "POST" then if path == "" then if not body then return http_response(event, 400, "Bad Request.") end local uuid = urldecode(body):match("^uuid=(.*)$") if not pending[uuid] then return r_template(event, "fail") else local username, password, ip = pending[uuid].node, pending[uuid].password, pending[uuid].ip local ok, error = usermanager.create_user(username, password, module.host) if ok then module:fire_event( "user-registered", { username = username, host = module.host, source = "mod_register_json", session = { ip = ip } } ) module:log("info", "Account %s@%s is successfully verified and activated", username, module.host) -- we shall not clean the user from the pending lists as long as registration doesn't succeed. pending[uuid] = nil ; pending_node[username] = nil return r_template(event, "success") else module:log("error", "User creation failed: "..error) return http_response(event, 500, "Encountered server error while creating the user: "..error) end end end else return http_response(event, 405, "Invalid method.") end end local function handle_user_deletion(event) local user, hostname = event.username, event.host if hostname == module.host then hashes:remove(user) end end -- Set it up! hashes = datamanager.load("register_json", module.host, "hashes") or hashes ; setmt(hashes, hashes_mt) module:provides("http", { default_path = base_path, route = { ["GET /"] = handle_req, ["POST /"] = handle_req, ["GET /verify/*"] = handle_verify, ["POST /verify/*"] = handle_verify } }) module:hook_global("user-deleted", handle_user_deletion, 10); -- Reloadability module.save = function() return { hashes = hashes } end module.restore = function(data) hashes = data.hashes or { _index = {} } ; setmt(hashes, hashes_mt) end
