plugins/mod_xmlrpc.lua
author Waqas Hussain <waqas20@gmail.com>
Sun, 08 Mar 2009 05:03:22 +0500
changeset 892 2128891180b7
parent 889 bb959588bbc4
child 896 2c0b9e3c11c3
permissions -rw-r--r--
mod_xmlrpc: Limit usage to admins
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
875
e73b6ef579c7 Added mod_xmlrpc
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
     1
-- Prosody IM v0.3
e73b6ef579c7 Added mod_xmlrpc
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
     2
-- Copyright (C) 2008-2009 Matthew Wild
e73b6ef579c7 Added mod_xmlrpc
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
     3
-- Copyright (C) 2008-2009 Waqas Hussain
e73b6ef579c7 Added mod_xmlrpc
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
     4
-- 
e73b6ef579c7 Added mod_xmlrpc
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
     5
-- This project is MIT/X11 licensed. Please see the
e73b6ef579c7 Added mod_xmlrpc
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
     6
-- COPYING file in the source package for more information.
e73b6ef579c7 Added mod_xmlrpc
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
     7
--
e73b6ef579c7 Added mod_xmlrpc
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
     8
e73b6ef579c7 Added mod_xmlrpc
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
     9
e73b6ef579c7 Added mod_xmlrpc
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
    10
module.host = "*" -- Global module
e73b6ef579c7 Added mod_xmlrpc
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
    11
e73b6ef579c7 Added mod_xmlrpc
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
    12
local httpserver = require "net.httpserver";
e73b6ef579c7 Added mod_xmlrpc
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
    13
local st = require "util.stanza";
e73b6ef579c7 Added mod_xmlrpc
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
    14
local pcall = pcall;
e73b6ef579c7 Added mod_xmlrpc
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
    15
local unpack = unpack;
e73b6ef579c7 Added mod_xmlrpc
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
    16
local tostring = tostring;
892
2128891180b7 mod_xmlrpc: Limit usage to admins
Waqas Hussain <waqas20@gmail.com>
parents: 889
diff changeset
    17
local is_admin = require "core.usermanager".is_admin;
2128891180b7 mod_xmlrpc: Limit usage to admins
Waqas Hussain <waqas20@gmail.com>
parents: 889
diff changeset
    18
local jid_split = require "util.jid".split;
2128891180b7 mod_xmlrpc: Limit usage to admins
Waqas Hussain <waqas20@gmail.com>
parents: 889
diff changeset
    19
local b64_decode = require "util.encodings".base64.decode;
2128891180b7 mod_xmlrpc: Limit usage to admins
Waqas Hussain <waqas20@gmail.com>
parents: 889
diff changeset
    20
local get_method = require "core.objectmanager".get_object;
2128891180b7 mod_xmlrpc: Limit usage to admins
Waqas Hussain <waqas20@gmail.com>
parents: 889
diff changeset
    21
local validate_credentials = require "core.usermanager".validate_credentials;
875
e73b6ef579c7 Added mod_xmlrpc
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
    22
e73b6ef579c7 Added mod_xmlrpc
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
    23
local translate_request = require "util.xmlrpc".translate_request;
e73b6ef579c7 Added mod_xmlrpc
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
    24
local create_response = require "util.xmlrpc".create_response;
e73b6ef579c7 Added mod_xmlrpc
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
    25
local create_error_response = require "util.xmlrpc".create_error_response;
e73b6ef579c7 Added mod_xmlrpc
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
    26
e73b6ef579c7 Added mod_xmlrpc
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
    27
local entity_map = setmetatable({
e73b6ef579c7 Added mod_xmlrpc
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
    28
	["amp"] = "&";
e73b6ef579c7 Added mod_xmlrpc
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
    29
	["gt"] = ">";
e73b6ef579c7 Added mod_xmlrpc
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
    30
	["lt"] = "<";
e73b6ef579c7 Added mod_xmlrpc
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
    31
	["apos"] = "'";
e73b6ef579c7 Added mod_xmlrpc
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
    32
	["quot"] = "\"";
e73b6ef579c7 Added mod_xmlrpc
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
    33
}, {__index = function(_, s)
e73b6ef579c7 Added mod_xmlrpc
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
    34
		if s:sub(1,1) == "#" then
e73b6ef579c7 Added mod_xmlrpc
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
    35
			if s:sub(2,2) == "x" then
e73b6ef579c7 Added mod_xmlrpc
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
    36
				return string.char(tonumber(s:sub(3), 16));
e73b6ef579c7 Added mod_xmlrpc
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
    37
			else
e73b6ef579c7 Added mod_xmlrpc
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
    38
				return string.char(tonumber(s:sub(2)));
e73b6ef579c7 Added mod_xmlrpc
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
    39
			end
e73b6ef579c7 Added mod_xmlrpc
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
    40
		end
e73b6ef579c7 Added mod_xmlrpc
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
    41
	end
e73b6ef579c7 Added mod_xmlrpc
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
    42
});
e73b6ef579c7 Added mod_xmlrpc
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
    43
local function xml_unescape(str)
e73b6ef579c7 Added mod_xmlrpc
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
    44
	return (str:gsub("&(.-);", entity_map));
e73b6ef579c7 Added mod_xmlrpc
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
    45
end
e73b6ef579c7 Added mod_xmlrpc
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
    46
local function parse_xml(xml)
e73b6ef579c7 Added mod_xmlrpc
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
    47
	local stanza = st.stanza("root");
e73b6ef579c7 Added mod_xmlrpc
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
    48
	local regexp = "<([^>]*)>([^<]*)";
e73b6ef579c7 Added mod_xmlrpc
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
    49
	for elem, text in xml:gmatch(regexp) do
e73b6ef579c7 Added mod_xmlrpc
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
    50
		--print("[<"..elem..">|"..text.."]");
e73b6ef579c7 Added mod_xmlrpc
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
    51
		if elem:sub(1,1) == "!" or elem:sub(1,1) == "?" then -- neglect comments and processing-instructions
e73b6ef579c7 Added mod_xmlrpc
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
    52
		elseif elem:sub(1,1) == "/" then -- end tag
e73b6ef579c7 Added mod_xmlrpc
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
    53
			elem = elem:sub(2);
e73b6ef579c7 Added mod_xmlrpc
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
    54
			stanza:up(); -- TODO check for start-end tag name match
e73b6ef579c7 Added mod_xmlrpc
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
    55
		elseif elem:sub(-1,-1) == "/" then -- empty tag
e73b6ef579c7 Added mod_xmlrpc
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
    56
			elem = elem:sub(1,-2);
e73b6ef579c7 Added mod_xmlrpc
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
    57
			stanza:tag(elem):up();
e73b6ef579c7 Added mod_xmlrpc
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
    58
		else -- start tag
e73b6ef579c7 Added mod_xmlrpc
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
    59
			stanza:tag(elem);
e73b6ef579c7 Added mod_xmlrpc
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
    60
		end
e73b6ef579c7 Added mod_xmlrpc
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
    61
		if #text ~= 0 then -- text
e73b6ef579c7 Added mod_xmlrpc
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
    62
			stanza:text(xml_unescape(text));
e73b6ef579c7 Added mod_xmlrpc
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
    63
		end
e73b6ef579c7 Added mod_xmlrpc
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
    64
	end
e73b6ef579c7 Added mod_xmlrpc
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
    65
	return stanza.tags[1];
e73b6ef579c7 Added mod_xmlrpc
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
    66
end
e73b6ef579c7 Added mod_xmlrpc
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
    67
e73b6ef579c7 Added mod_xmlrpc
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
    68
local function handle_xmlrpc_request(method, args)
e73b6ef579c7 Added mod_xmlrpc
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
    69
	method = get_method(method);
e73b6ef579c7 Added mod_xmlrpc
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
    70
	if not method then return create_error_response(404, "method not found"); end
e73b6ef579c7 Added mod_xmlrpc
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
    71
	args = args or {};
e73b6ef579c7 Added mod_xmlrpc
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
    72
	local success, result = pcall(method, unpack(args));
e73b6ef579c7 Added mod_xmlrpc
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
    73
	if success then
e73b6ef579c7 Added mod_xmlrpc
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
    74
		success, result = pcall(create_response, result or "nil");
e73b6ef579c7 Added mod_xmlrpc
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
    75
		if success then
e73b6ef579c7 Added mod_xmlrpc
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
    76
			return result;
e73b6ef579c7 Added mod_xmlrpc
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
    77
		end
e73b6ef579c7 Added mod_xmlrpc
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
    78
		return create_error_response(500, "Error in creating response: "..result);
e73b6ef579c7 Added mod_xmlrpc
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
    79
	end
e73b6ef579c7 Added mod_xmlrpc
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
    80
	return create_error_response(0, result or "nil");
e73b6ef579c7 Added mod_xmlrpc
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
    81
end
e73b6ef579c7 Added mod_xmlrpc
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
    82
877
0bababc930dd mod_xmlrpc: Handle RPC stanzas sent over XMPP (XEP-0009: Jabber-RPC)
Waqas Hussain <waqas20@gmail.com>
parents: 875
diff changeset
    83
local function handle_xmpp_request(origin, stanza)
875
e73b6ef579c7 Added mod_xmlrpc
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
    84
	local query = stanza.tags[1];
e73b6ef579c7 Added mod_xmlrpc
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
    85
	if query.name == "query" then
e73b6ef579c7 Added mod_xmlrpc
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
    86
		if #query.tags == 1 then
892
2128891180b7 mod_xmlrpc: Limit usage to admins
Waqas Hussain <waqas20@gmail.com>
parents: 889
diff changeset
    87
			if is_admin(stanza.attr.from) then
2128891180b7 mod_xmlrpc: Limit usage to admins
Waqas Hussain <waqas20@gmail.com>
parents: 889
diff changeset
    88
				local success, method, args = pcall(translate_request, query.tags[1]);
2128891180b7 mod_xmlrpc: Limit usage to admins
Waqas Hussain <waqas20@gmail.com>
parents: 889
diff changeset
    89
				if success then
2128891180b7 mod_xmlrpc: Limit usage to admins
Waqas Hussain <waqas20@gmail.com>
parents: 889
diff changeset
    90
					local result = handle_xmlrpc_request(method, args);
2128891180b7 mod_xmlrpc: Limit usage to admins
Waqas Hussain <waqas20@gmail.com>
parents: 889
diff changeset
    91
					origin.send(st.reply(stanza):tag('query', {xmlns='jabber:iq:rpc'}):add_child(result));
2128891180b7 mod_xmlrpc: Limit usage to admins
Waqas Hussain <waqas20@gmail.com>
parents: 889
diff changeset
    92
				else
2128891180b7 mod_xmlrpc: Limit usage to admins
Waqas Hussain <waqas20@gmail.com>
parents: 889
diff changeset
    93
					origin.send(st.error_reply(stanza, "modify", "bad-request", method));
2128891180b7 mod_xmlrpc: Limit usage to admins
Waqas Hussain <waqas20@gmail.com>
parents: 889
diff changeset
    94
				end
2128891180b7 mod_xmlrpc: Limit usage to admins
Waqas Hussain <waqas20@gmail.com>
parents: 889
diff changeset
    95
			else origin.send(st.error_reply(stanza, "auth", "forbidden", "No content in XML-RPC request")); end
2128891180b7 mod_xmlrpc: Limit usage to admins
Waqas Hussain <waqas20@gmail.com>
parents: 889
diff changeset
    96
		else origin.send(st.error_reply(stanza, "modify", "bad-request", "No content in XML-RPC request")); end
2128891180b7 mod_xmlrpc: Limit usage to admins
Waqas Hussain <waqas20@gmail.com>
parents: 889
diff changeset
    97
	else origin.send(st.error_reply(stanza, "cancel", "service-unavailable")); end
875
e73b6ef579c7 Added mod_xmlrpc
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
    98
end
877
0bababc930dd mod_xmlrpc: Handle RPC stanzas sent over XMPP (XEP-0009: Jabber-RPC)
Waqas Hussain <waqas20@gmail.com>
parents: 875
diff changeset
    99
module:add_iq_handler({"c2s", "s2sin"}, "jabber:iq:rpc", handle_xmpp_request);
0bababc930dd mod_xmlrpc: Handle RPC stanzas sent over XMPP (XEP-0009: Jabber-RPC)
Waqas Hussain <waqas20@gmail.com>
parents: 875
diff changeset
   100
module:add_feature("jabber:iq:rpc");
892
2128891180b7 mod_xmlrpc: Limit usage to admins
Waqas Hussain <waqas20@gmail.com>
parents: 889
diff changeset
   101
-- TODO add <identity category='automation' type='rpc'/> to disco replies
875
e73b6ef579c7 Added mod_xmlrpc
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
   102
892
2128891180b7 mod_xmlrpc: Limit usage to admins
Waqas Hussain <waqas20@gmail.com>
parents: 889
diff changeset
   103
local default_headers = { ['Content-Type'] = 'text/xml' };
2128891180b7 mod_xmlrpc: Limit usage to admins
Waqas Hussain <waqas20@gmail.com>
parents: 889
diff changeset
   104
local unauthorized_response = { status = '401 UNAUTHORIZED', headers = {['Content-Type']='text/html', ['WWW-Authenticate']='Basic realm="WallyWorld"'}; body = "<html><body>Authentication required</body></html>"; };
875
e73b6ef579c7 Added mod_xmlrpc
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
   105
local function handle_http_request(method, body, request)
892
2128891180b7 mod_xmlrpc: Limit usage to admins
Waqas Hussain <waqas20@gmail.com>
parents: 889
diff changeset
   106
	-- authenticate user
2128891180b7 mod_xmlrpc: Limit usage to admins
Waqas Hussain <waqas20@gmail.com>
parents: 889
diff changeset
   107
	local username, password = b64_decode(request['authorization'] or ''):gmatch('([^:]*):(.*)')(); -- TODO digest auth
2128891180b7 mod_xmlrpc: Limit usage to admins
Waqas Hussain <waqas20@gmail.com>
parents: 889
diff changeset
   108
	local node, host = jid_split(username);
2128891180b7 mod_xmlrpc: Limit usage to admins
Waqas Hussain <waqas20@gmail.com>
parents: 889
diff changeset
   109
	if not validate_credentials(host, node, password) and is_admin(username) then
2128891180b7 mod_xmlrpc: Limit usage to admins
Waqas Hussain <waqas20@gmail.com>
parents: 889
diff changeset
   110
		return unauthorized_response;
2128891180b7 mod_xmlrpc: Limit usage to admins
Waqas Hussain <waqas20@gmail.com>
parents: 889
diff changeset
   111
	end
2128891180b7 mod_xmlrpc: Limit usage to admins
Waqas Hussain <waqas20@gmail.com>
parents: 889
diff changeset
   112
	-- parse request
875
e73b6ef579c7 Added mod_xmlrpc
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
   113
	local stanza = body and parse_xml(body);
e73b6ef579c7 Added mod_xmlrpc
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
   114
	if (not stanza) or request.method ~= "POST" then
e73b6ef579c7 Added mod_xmlrpc
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
   115
		return "<html><body>You really don't look like an XML-RPC client to me... what do you want?</body></html>";
e73b6ef579c7 Added mod_xmlrpc
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
   116
	end
892
2128891180b7 mod_xmlrpc: Limit usage to admins
Waqas Hussain <waqas20@gmail.com>
parents: 889
diff changeset
   117
	-- execute request
875
e73b6ef579c7 Added mod_xmlrpc
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
   118
	local success, method, args = pcall(translate_request, stanza);
e73b6ef579c7 Added mod_xmlrpc
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
   119
	if success then
880
ff4a08d73772 XML-RPC: Set appropriate Content-Type header in HTTP response
Waqas Hussain <waqas20@gmail.com>
parents: 877
diff changeset
   120
		return { headers = default_headers; body = tostring(handle_xmlrpc_request(method, args)) };
875
e73b6ef579c7 Added mod_xmlrpc
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
   121
	end
880
ff4a08d73772 XML-RPC: Set appropriate Content-Type header in HTTP response
Waqas Hussain <waqas20@gmail.com>
parents: 877
diff changeset
   122
	return "<html><body>Error parsing XML-RPC request: "..tostring(method).."</body></html>";
875
e73b6ef579c7 Added mod_xmlrpc
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
   123
end
e73b6ef579c7 Added mod_xmlrpc
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
   124
httpserver.new{ port = 9000, base = "xmlrpc", handler = handle_http_request }