mod_console: Removed redundant code for host:activate() and host:deactivate(), now...
[prosody.git] / plugins / mod_console.lua
index 556f0c5d58b879bb7416422e811d4553875929ab..0b2dd5f8914224b4389f3a8d69ac94330572c73f 100644 (file)
@@ -1,6 +1,6 @@
--- Prosody IM v0.4
--- Copyright (C) 2008-2009 Matthew Wild
--- Copyright (C) 2008-2009 Waqas Hussain
+-- Prosody IM
+-- Copyright (C) 2008-2010 Matthew Wild
+-- Copyright (C) 2008-2010 Waqas Hussain
 -- 
 -- This project is MIT/X11 licensed. Please see the
 -- COPYING file in the source package for more information.
@@ -14,28 +14,43 @@ local prosody = _G.prosody;
 local hosts = prosody.hosts;
 local connlisteners_register = require "net.connlisteners".register;
 
-local console_listener = { default_port = 5582; default_mode = "*l"; };
+local console_listener = { default_port = 5582; default_mode = "*l"; default_interface = "127.0.0.1" };
 
 require "util.iterators";
 local jid_bare = require "util.jid".bare;
 local set, array = require "util.set", require "util.array";
+local cert_verify_identity = require "util.certverification".verify_identity;
 
 local commands = {};
 local def_env = {};
 local default_env_mt = { __index = def_env };
 
+prosody.console = { commands = commands, env = def_env };
+
 local function redirect_output(_G, session)
-       return setmetatable({ print = session.print }, { __index = function (t, k) return rawget(_G, k); end, __newindex = function (t, k, v) rawset(_G, k, v); end });
+       local env = setmetatable({ print = session.print }, { __index = function (t, k) return rawget(_G, k); end });
+       env.dofile = function(name)
+               local f, err = loadfile(name);
+               if not f then return f, err; end
+               return setfenv(f, env)();
+       end;
+       return env;
 end
 
 console = {};
 
 function console:new_session(conn)
-       local w = function(s) conn.write(s:gsub("\n", "\r\n")); end;
+       local w = function(s) conn:write(s:gsub("\n", "\r\n")); end;
        local session = { conn = conn;
                        send = function (t) w(tostring(t)); end;
-                       print = function (t) w("| "..tostring(t).."\n"); end;
-                       disconnect = function () conn.close(); end;
+                       print = function (...)
+                               local t = {};
+                               for i=1,select("#", ...) do
+                                       t[i] = tostring(select(i, ...));
+                               end
+                               w("| "..table.concat(t, "\t").."\n");
+                       end;
+                       disconnect = function () conn:close(); end;
                        };
        session.env = setmetatable({}, default_env_mt);
        
@@ -51,78 +66,87 @@ end
 
 local sessions = {};
 
-function console_listener.listener(conn, data)
+function console_listener.onconnect(conn)
+       -- Handle new connection
+       local session = console:new_session(conn);
+       sessions[conn] = session;
+       printbanner(session);
+       session.send(string.char(0));
+end
+
+function console_listener.onincoming(conn, data)
        local session = sessions[conn];
-       
-       if not session then
-               -- Handle new connection
-               session = console:new_session(conn);
-               sessions[conn] = session;
-               printbanner(session);
-       end
-       if data then
-               -- Handle data
-               (function(session, data)
-                       local useglobalenv;
-                       
-                       if data:match("^>") then
-                               data = data:gsub("^>", "");
-                               useglobalenv = true;
-                       else
-                               local command = data:lower();
-                               command = data:match("^%w+") or data:match("%p");
-                               if commands[command] then
-                                       commands[command](session, data);
-                                       return;
-                               end
-                       end
 
-                       session.env._ = data;
-                       
-                       local chunk, err = loadstring("return "..data);
-                       if not chunk then
-                               chunk, err = loadstring(data);
-                               if not chunk then
-                                       err = err:gsub("^%[string .-%]:%d+: ", "");
-                                       err = err:gsub("^:%d+: ", "");
-                                       err = err:gsub("'<eof>'", "the end of the line");
-                                       session.print("Sorry, I couldn't understand that... "..err);
-                                       return;
-                               end
-                       end
-                       
-                       setfenv(chunk, (useglobalenv and redirect_output(_G, session)) or session.env or nil);
-                       
-                       local ranok, taskok, message = pcall(chunk);
-                       
-                       if not (ranok or message or useglobalenv) and commands[data:lower()] then
-                               commands[data:lower()](session, data);
-                               return;
-                       end
-                       
-                       if not ranok then
-                               session.print("Fatal error while running command, it did not complete");
-                               session.print("Error: "..taskok);
+       -- Handle data
+       (function(session, data)
+               local useglobalenv;
+               
+               if data:match("^>") then
+                       data = data:gsub("^>", "");
+                       useglobalenv = true;
+               elseif data == "\004" then
+                       commands["bye"](session, data);
+                       return;
+               else
+                       local command = data:lower();
+                       command = data:match("^%w+") or data:match("%p");
+                       if commands[command] then
+                               commands[command](session, data);
                                return;
                        end
-                       
-                       if not message then
-                               session.print("Result: "..tostring(taskok));
-                               return;
-                       elseif (not taskok) and message then
-                               session.print("Command completed with a problem");
-                               session.print("Message: "..tostring(message));
+               end
+
+               session.env._ = data;
+               
+               local chunkname = "=console";
+               local chunk, err = loadstring("return "..data, chunkname);
+               if not chunk then
+                       chunk, err = loadstring(data, chunkname);
+                       if not chunk then
+                               err = err:gsub("^%[string .-%]:%d+: ", "");
+                               err = err:gsub("^:%d+: ", "");
+                               err = err:gsub("'<eof>'", "the end of the line");
+                               session.print("Sorry, I couldn't understand that... "..err);
                                return;
                        end
-                       
-                       session.print("OK: "..tostring(message));
-               end)(session, data);
-       end
+               end
+               
+               setfenv(chunk, (useglobalenv and redirect_output(_G, session)) or session.env or nil);
+               
+               local ranok, taskok, message = pcall(chunk);
+               
+               if not (ranok or message or useglobalenv) and commands[data:lower()] then
+                       commands[data:lower()](session, data);
+                       return;
+               end
+               
+               if not ranok then
+                       session.print("Fatal error while running command, it did not complete");
+                       session.print("Error: "..taskok);
+                       return;
+               end
+               
+               if not message then
+                       session.print("Result: "..tostring(taskok));
+                       return;
+               elseif (not taskok) and message then
+                       session.print("Command completed with a problem");
+                       session.print("Message: "..tostring(message));
+                       return;
+               end
+               
+               session.print("OK: "..tostring(message));
+       end)(session, data);
+       
        session.send(string.char(0));
 end
 
-function console_listener.disconnect(conn, err)
-       
+function console_listener.ondisconnect(conn, err)
+       local session = sessions[conn];
+       if session then
+               session.disconnect();
+               sessions[conn] = nil;
+       end
 end
 
 connlisteners_register('console', console_listener);
@@ -134,11 +158,12 @@ function commands.bye(session)
        session.print("See you! :)");
        session.disconnect();
 end
+commands.quit, commands.exit = commands.bye, commands.bye;
 
 commands["!"] = function (session, data)
-       if data:match("^!!") then
+       if data:match("^!!") and session.env._ then
                session.print("!> "..session.env._);
-               return console_listener.listener(session.conn, session.env._);
+               return console_listener.onincoming(session.conn, session.env._);
        end
        local old, new = data:match("^!(.-[^\\])!(.-)!$");
        if old and new then
@@ -148,16 +173,72 @@ commands["!"] = function (session, data)
                        return;
                end
                session.print("!> "..res);
-               return console_listener.listener(session.conn, res);
+               return console_listener.onincoming(session.conn, res);
        end
        session.print("Sorry, not sure what you want");
 end
 
+
+function commands.help(session, data)
+       local print = session.print;
+       local section = data:match("^help (%w+)");
+       if not section then
+               print [[Commands are divided into multiple sections. For help on a particular section, ]]
+               print [[type: help SECTION (for example, 'help c2s'). Sections are: ]]
+               print [[]]
+               print [[c2s - Commands to manage local client-to-server sessions]]
+               print [[s2s - Commands to manage sessions between this server and others]]
+               print [[module - Commands to load/reload/unload modules/plugins]]
+               print [[host - Commands to activate, deactivate and list virtual hosts]]
+               print [[server - Uptime, version, shutting down, etc.]]
+               print [[config - Reloading the configuration, etc.]]
+               print [[console - Help regarding the console itself]]
+       elseif section == "c2s" then
+               print [[c2s:show(jid) - Show all client sessions with the specified JID (or all if no JID given)]]
+               print [[c2s:show_insecure() - Show all unencrypted client connections]]
+               print [[c2s:show_secure() - Show all encrypted client connections]]
+               print [[c2s:close(jid) - Close all sessions for the specified JID]]
+       elseif section == "s2s" then
+               print [[s2s:show(domain) - Show all s2s connections for the given domain (or all if no domain given)]]
+               print [[s2s:close(from, to) - Close a connection from one domain to another]]
+       elseif section == "module" then
+               print [[module:load(module, host) - Load the specified module on the specified host (or all hosts if none given)]]
+               print [[module:reload(module, host) - The same, but unloads and loads the module (saving state if the module supports it)]]
+               print [[module:unload(module, host) - The same, but just unloads the module from memory]]
+               print [[module:list(host) - List the modules loaded on the specified host]]
+       elseif section == "host" then
+               print [[host:activate(hostname) - Activates the specified host]]
+               print [[host:deactivate(hostname) - Disconnects all clients on this host and deactivates]]
+               print [[host:list() - List the currently-activated hosts]]
+       elseif section == "server" then
+               print [[server:version() - Show the server's version number]]
+               print [[server:uptime() - Show how long the server has been running]]
+               print [[server:shutdown(reason) - Shut down the server, with an optional reason to be broadcast to all connections]]
+       elseif section == "config" then
+               print [[config:reload() - Reload the server configuration. Modules may need to be reloaded for changes to take effect.]]
+       elseif section == "console" then
+               print [[Hey! Welcome to Prosody's admin console.]]
+               print [[First thing, if you're ever wondering how to get out, simply type 'quit'.]]
+               print [[Secondly, note that we don't support the full telnet protocol yet (it's coming)]]
+               print [[so you may have trouble using the arrow keys, etc. depending on your system.]]
+               print [[]]
+               print [[For now we offer a couple of handy shortcuts:]]
+               print [[!! - Repeat the last command]]
+               print [[!old!new! - repeat the last command, but with 'old' replaced by 'new']]
+               print [[]]
+               print [[For those well-versed in Prosody's internals, or taking instruction from those who are,]]
+               print [[you can prefix a command with > to escape the console sandbox, and access everything in]]
+               print [[the running server. Great fun, but be careful not to break anything :)]]
+       end
+       print [[]]
+end
+
 -- Session environment --
 -- Anything in def_env will be accessible within the session as a global variable
 
 def_env.server = {};
-function def_env.server:reload()
+
+function def_env.server:insane_reload()
        prosody.unlock_globals();
        dofile "prosody"
        prosody = _G.prosody;
@@ -177,11 +258,16 @@ function def_env.server:uptime()
        local hours = t%24;
        t = (t - hours)/24;
        local days = t;
-       return true, string.format("This server has been running for %d day%s, %d hour%s and %d minute%s (since %s)", 
-               days, (days ~= 1 and "s") or "", hours, (hours ~= 1 and "s") or "", 
+       return true, string.format("This server has been running for %d day%s, %d hour%s and %d minute%s (since %s)",
+               days, (days ~= 1 and "s") or "", hours, (hours ~= 1 and "s") or "",
                minutes, (minutes ~= 1 and "s") or "", os.date("%c", prosody.start_time));
 end
 
+function def_env.server:shutdown(reason)
+       prosody.shutdown(reason);
+       return true, "Shutdown initiated";
+end
+
 def_env.module = {};
 
 local function get_hosts_set(hosts, module)
@@ -270,6 +356,35 @@ function def_env.module:reload(name, hosts)
        return ok, (ok and "Module reloaded on "..count.." host"..(count ~= 1 and "s" or "")) or ("Last error: "..tostring(err));
 end
 
+function def_env.module:list(hosts)
+       if hosts == nil then
+               hosts = array.collect(keys(prosody.hosts));
+       end
+       if type(hosts) == "string" then
+               hosts = { hosts };
+       end
+       if type(hosts) ~= "table" then
+               return false, "Please supply a host or a list of hosts you would like to see";
+       end
+       
+       local print = self.session.print;
+       for _, host in ipairs(hosts) do
+               print(host..":");
+               local modules = array.collect(keys(prosody.hosts[host] and prosody.hosts[host].modules or {})):sort();
+               if #modules == 0 then
+                       if prosody.hosts[host] then
+                               print("    No modules loaded");
+                       else
+                               print("    Host not found");
+                       end
+               else
+                       for _, name in ipairs(modules) do
+                               print("    "..name);
+                       end
+               end
+       end
+end
+
 def_env.config = {};
 function def_env.config:load(filename, format)
        local config_load = require "core.configmanager".load;
@@ -285,6 +400,11 @@ function def_env.config:get(host, section, key)
        return true, tostring(config_get(host, section, key));
 end
 
+function def_env.config:reload()
+       local ok, err = prosody.reload_config();
+       return ok, (ok and "Config reloaded (you may need to reload modules to take effect)") or tostring(err);
+end
+
 def_env.hosts = {};
 function def_env.hosts:list()
        for host, host_session in pairs(hosts) do
@@ -311,10 +431,24 @@ end
 
 function def_env.c2s:show(match_jid)
        local print, count = self.session.print, 0;
-       show_c2s(function (jid)
+       local curr_host;
+       show_c2s(function (jid, session)
+               if curr_host ~= session.host then
+                       curr_host = session.host;
+                       print(curr_host);
+               end
                if (not match_jid) or jid:match(match_jid) then
                        count = count + 1;
-                       print(jid);
+                       local status, priority = "unavailable", tostring(session.priority or "-");
+                       if session.presence then
+                               status = session.presence:child_with_name("show");
+                               if status then
+                                       status = status:get_text() or "[invalid!]";
+                               else
+                                       status = "available";
+                               end
+                       end
+                       print("   "..jid.." - "..status.."("..priority..")");
                end             
        end);
        return true, "Total: "..count.." clients";
@@ -365,7 +499,7 @@ function def_env.s2s:show(match_jid)
                for remotehost, session in pairs(host_session.s2sout) do
                        if (not match_jid) or remotehost:match(match_jid) or host:match(match_jid) then
                                count_out = count_out + 1;
-                               print("    "..host.." -> "..remotehost);
+                               print("    "..host.." -> "..remotehost..(session.cert_identity_status == "valid" and " (secure)" or "")..(session.secure and " (encrypted)" or "")..(session.compressed and " (compressed)" or ""));
                                if session.sendq then
                                        print("        There are "..#session.sendq.." queued outgoing stanzas for this connection");
                                end
@@ -393,12 +527,16 @@ function def_env.s2s:show(match_jid)
                                end
                        end
                end     
-               
+               local subhost_filter = function (h)
+                               return (match_jid and h:match(match_jid));
+                       end
                for session in pairs(incoming_s2s) do
-                       if session.to_host == host and ((not match_jid) or host:match(match_jid) 
-                               or (session.from_host and session.from_host:match(match_jid))) then
+                       if session.to_host == host and ((not match_jid) or host:match(match_jid)
+                               or (session.from_host and session.from_host:match(match_jid))
+                               -- Pft! is what I say to list comprehensions
+                               or (session.hosts and #array.collect(keys(session.hosts)):filter(subhost_filter)>0)) then
                                count_in = count_in + 1;
-                               print("    "..host.." <- "..(session.from_host or "(unknown)"));
+                               print("    "..host.." <- "..(session.from_host or "(unknown)")..(session.cert_identity_status == "valid" and " (secure)" or "")..(session.secure and " (encrypted)" or "")..(session.compressed and " (compressed)" or ""));
                                if session.type == "s2sin_unauthed" then
                                                print("        Connection not yet authenticated");
                                end
@@ -424,6 +562,109 @@ function def_env.s2s:show(match_jid)
        return true, "Total: "..count_out.." outgoing, "..count_in.." incoming connections";
 end
 
+local function print_subject(print, subject)
+       for _, entry in ipairs(subject) do
+               print(
+                       ("    %s: %q"):format(
+                               entry.name or entry.oid,
+                               entry.value:gsub("[\r\n%z%c]", " ")
+                       )
+               );
+       end
+end
+
+function def_env.s2s:showcert(domain)
+       local ser = require "util.serialization".serialize;
+       local print = self.session.print;
+       local domain_sessions = set.new(array.collect(keys(incoming_s2s)))
+               /function(session) return session.from_host == domain; end;
+       for local_host in values(prosody.hosts) do
+               local s2sout = local_host.s2sout;
+               if s2sout and s2sout[domain] then
+                       domain_sessions:add(s2sout[domain]);
+               end
+       end
+       local cert_set = {};
+       for session in domain_sessions do
+               local conn = session.conn;
+               conn = conn and conn:socket();
+               if not conn.getpeercertificate then
+                       if conn.dohandshake then
+                               error("This version of LuaSec does not support certificate viewing");
+                       end
+               else
+                       local cert = conn:getpeercertificate();
+                       if cert then
+                               local digest = cert:digest("sha1");
+                               if not cert_set[digest] then
+                                       local chain_valid, chain_err = conn:getpeerchainvalid();
+                                       cert_set[digest] = {
+                                               {
+                                                 from = session.from_host,
+                                                 to = session.to_host,
+                                                 direction = session.direction
+                                               };
+                                               chain_valid = chain_valid;
+                                               chain_err = chain_err;
+                                               cert = cert;
+                                       };
+                               else
+                                       table.insert(cert_set[digest], {
+                                               from = session.from_host,
+                                               to = session.to_host,
+                                               direction = session.direction
+                                       });
+                               end
+                       end
+               end
+       end
+       local domain_certs = array.collect(values(cert_set));
+       -- Phew. We now have a array of unique certificates presented by domain.
+       local print = self.session.print;
+       local n_certs = #domain_certs;
+       
+       if n_certs == 0 then
+               return "No certificates found for "..domain;
+       end
+       
+       local function _capitalize_and_colon(byte)
+               return string.upper(byte)..":";
+       end
+       local function pretty_fingerprint(hash)
+               return hash:gsub("..", _capitalize_and_colon):sub(1, -2);
+       end
+       
+       for cert_info in values(domain_certs) do
+               local cert = cert_info.cert;
+               print("---")
+               print("Fingerprint (SHA1): "..pretty_fingerprint(cert:digest("sha1")));
+               print("");
+               local n_streams = #cert_info;
+               print("Currently used on "..n_streams.." stream"..(n_streams==1 and "" or "s")..":");
+               for _, stream in ipairs(cert_info) do
+                       if stream.direction == "incoming" then
+                               print("    "..stream.to.." <- "..stream.from);
+                       else
+                               print("    "..stream.from.." -> "..stream.to);
+                       end
+               end
+               print("");
+               local chain_valid, err = cert_info.chain_valid, cert_info.chain_err;
+               local valid_identity = cert_verify_identity(domain, "xmpp-server", cert);
+               print("Trusted certificate: "..(chain_valid and "Yes" or ("No ("..err..")")));
+               print("Issuer: ");
+               print_subject(print, cert:issuer());
+               print("");
+               print("Valid for "..domain..": "..(valid_identity and "Yes" or "No"));
+               print("Subject:");
+               print_subject(print, cert:subject());
+       end
+       print("---");
+       return ("Showing "..n_certs.." certificate"
+               ..(n_certs==1 and "" or "s")
+               .." presented by "..domain..".");
+end
+
 function def_env.s2s:close(from, to)
        local print, count = self.session.print, 0;
        
@@ -436,10 +677,10 @@ function def_env.s2s:close(from, to)
        if hosts[from] and not hosts[to] then
                -- Is an outgoing connection
                local session = hosts[from].s2sout[to];
-               if not session then 
+               if not session then
                        print("No outgoing connection from "..from.." to "..to)
                else
-                       s2smanager.destroy_session(session);
+                       (session.close or s2smanager.destroy_session)(session);
                        count = count + 1;
                        print("Closed outgoing session from "..from.." to "..to);
                end
@@ -447,7 +688,7 @@ function def_env.s2s:close(from, to)
                -- Is an incoming connection
                for session in pairs(incoming_s2s) do
                        if session.to_host == to and session.from_host == from then
-                               s2smanager.destroy_session(session);
+                               (session.close or s2smanager.destroy_session)(session);
                                count = count + 1;
                        end
                end
@@ -466,6 +707,25 @@ function def_env.s2s:close(from, to)
        return true, "Closed "..count.." s2s session"..((count == 1 and "") or "s");
 end
 
+def_env.host = {}; def_env.hosts = def_env.host;
+
+function def_env.host:activate(hostname, config)
+       return hostmanager.activate(hostname, config);
+end
+function def_env.host:deactivate(hostname, reason)
+       return hostmanager.deactivate(hostname, reason);
+end
+
+function def_env.host:list()
+       local print = self.session.print;
+       local i = 0;
+       for host in values(array.collect(keys(prosody.hosts)):sort()) do
+               i = i + 1;
+               print(host);
+       end
+       return true, i.." hosts";
+end
+
 -------------
 
 function printbanner(session)
@@ -495,3 +755,5 @@ if option and option ~= "short" and option ~= "full" and option ~= "graphic" the
        end
 end
 end
+
+prosody.net_activate_ports("console", "console", {5582}, "tcp");