2 -- Copyright (C) 2008-2010 Matthew Wild
3 -- Copyright (C) 2008-2010 Waqas Hussain
5 -- This project is MIT/X11 licensed. Please see the
6 -- COPYING file in the source package for more information.
11 local hostmanager = require "core.hostmanager";
12 local modulemanager = require "core.modulemanager";
13 local s2smanager = require "core.s2smanager";
14 local portmanager = require "core.portmanager";
18 local prosody = _G.prosody;
19 local hosts = prosody.hosts;
21 local console_listener = { default_port = 5582; default_mode = "*a"; interface = "127.0.0.1" };
23 local iterators = require "util.iterators";
24 local keys, values = iterators.keys, iterators.values;
25 local jid_bare, jid_split, jid_join = import("util.jid", "bare", "prepped_split", "join");
26 local set, array = require "util.set", require "util.array";
27 local cert_verify_identity = require "util.x509".verify_identity;
28 local envload = require "util.envload".envload;
29 local envloadfile = require "util.envload".envloadfile;
30 local has_pposix, pposix = pcall(require, "util.pposix");
32 local commands = module:shared("commands")
33 local def_env = module:shared("env");
34 local default_env_mt = { __index = def_env };
35 local core_post_stanza = prosody.core_post_stanza;
37 local function redirect_output(_G, session)
38 local env = setmetatable({ print = session.print }, { __index = function (t, k) return rawget(_G, k); end });
39 env.dofile = function(name)
40 local f, err = envloadfile(name, env);
41 if not f then return f, err; end
49 function console:new_session(conn)
50 local w = function(s) conn:write(s:gsub("\n", "\r\n")); end;
51 local session = { conn = conn;
52 send = function (t) w(tostring(t)); end;
53 print = function (...)
55 for i=1,select("#", ...) do
56 t[i] = tostring(select(i, ...));
58 w("| "..table.concat(t, "\t").."\n");
60 disconnect = function () conn:close(); end;
62 session.env = setmetatable({}, default_env_mt);
64 -- Load up environment with helper objects
65 for name, t in pairs(def_env) do
66 if type(t) == "table" then
67 session.env[name] = setmetatable({ session = session }, { __index = t });
74 function console:process_line(session, line)
77 if line:match("^>") then
78 line = line:gsub("^>", "");
80 elseif line == "\004" then
81 commands["bye"](session, line);
84 local command = line:match("^%w+") or line:match("%p");
85 if commands[command] then
86 commands[command](session, line);
93 local chunkname = "=console";
94 local env = (useglobalenv and redirect_output(_G, session)) or session.env or nil
95 local chunk, err = envload("return "..line, chunkname, env);
97 chunk, err = envload(line, chunkname, env);
99 err = err:gsub("^%[string .-%]:%d+: ", "");
100 err = err:gsub("^:%d+: ", "");
101 err = err:gsub("'<eof>'", "the end of the line");
102 session.print("Sorry, I couldn't understand that... "..err);
107 local ranok, taskok, message = pcall(chunk);
109 if not (ranok or message or useglobalenv) and commands[line:lower()] then
110 commands[line:lower()](session, line);
115 session.print("Fatal error while running command, it did not complete");
116 session.print("Error: "..taskok);
121 session.print("Result: "..tostring(taskok));
123 elseif (not taskok) and message then
124 session.print("Command completed with a problem");
125 session.print("Message: "..tostring(message));
129 session.print("OK: "..tostring(message));
134 function console_listener.onconnect(conn)
135 -- Handle new connection
136 local session = console:new_session(conn);
137 sessions[conn] = session;
138 printbanner(session);
139 session.send(string.char(0));
142 function console_listener.onincoming(conn, data)
143 local session = sessions[conn];
145 local partial = session.partial_data;
147 data = partial..data;
150 for line in data:gmatch("[^\n]*[\n\004]") do
151 if session.closed then return end
152 console:process_line(session, line);
153 session.send(string.char(0));
155 session.partial_data = data:match("[^\n]+$");
158 function console_listener.onreadtimeout(conn)
159 local session = sessions[conn];
166 function console_listener.ondisconnect(conn, err)
167 local session = sessions[conn];
169 session.disconnect();
170 sessions[conn] = nil;
174 function console_listener.ondetach(conn)
175 sessions[conn] = nil;
178 -- Console commands --
179 -- These are simple commands, not valid standalone in Lua
181 function commands.bye(session)
182 session.print("See you! :)");
183 session.closed = true;
184 session.disconnect();
186 commands.quit, commands.exit = commands.bye, commands.bye;
188 commands["!"] = function (session, data)
189 if data:match("^!!") and session.env._ then
190 session.print("!> "..session.env._);
191 return console_listener.onincoming(session.conn, session.env._);
193 local old, new = data:match("^!(.-[^\\])!(.-)!$");
195 local ok, res = pcall(string.gsub, session.env._, old, new);
200 session.print("!> "..res);
201 return console_listener.onincoming(session.conn, res);
203 session.print("Sorry, not sure what you want");
207 function commands.help(session, data)
208 local print = session.print;
209 local section = data:match("^help (%w+)");
211 print [[Commands are divided into multiple sections. For help on a particular section, ]]
212 print [[type: help SECTION (for example, 'help c2s'). Sections are: ]]
214 print [[c2s - Commands to manage local client-to-server sessions]]
215 print [[s2s - Commands to manage sessions between this server and others]]
216 print [[module - Commands to load/reload/unload modules/plugins]]
217 print [[host - Commands to activate, deactivate and list virtual hosts]]
218 print [[user - Commands to create and delete users, and change their passwords]]
219 print [[server - Uptime, version, shutting down, etc.]]
220 print [[port - Commands to manage ports the server is listening on]]
221 print [[dns - Commands to manage and inspect the internal DNS resolver]]
222 print [[config - Reloading the configuration, etc.]]
223 print [[console - Help regarding the console itself]]
224 elseif section == "c2s" then
225 print [[c2s:show(jid) - Show all client sessions with the specified JID (or all if no JID given)]]
226 print [[c2s:show_insecure() - Show all unencrypted client connections]]
227 print [[c2s:show_secure() - Show all encrypted client connections]]
228 print [[c2s:show_tls() - Show TLS cipher info for encrypted sessions]]
229 print [[c2s:close(jid) - Close all sessions for the specified JID]]
230 elseif section == "s2s" then
231 print [[s2s:show(domain) - Show all s2s connections for the given domain (or all if no domain given)]]
232 print [[s2s:show_tls(domain) - Show TLS cipher info for encrypted sessions]]
233 print [[s2s:close(from, to) - Close a connection from one domain to another]]
234 print [[s2s:closeall(host) - Close all the incoming/outgoing s2s sessions to specified host]]
235 elseif section == "module" then
236 print [[module:load(module, host) - Load the specified module on the specified host (or all hosts if none given)]]
237 print [[module:reload(module, host) - The same, but unloads and loads the module (saving state if the module supports it)]]
238 print [[module:unload(module, host) - The same, but just unloads the module from memory]]
239 print [[module:list(host) - List the modules loaded on the specified host]]
240 elseif section == "host" then
241 print [[host:activate(hostname) - Activates the specified host]]
242 print [[host:deactivate(hostname) - Disconnects all clients on this host and deactivates]]
243 print [[host:list() - List the currently-activated hosts]]
244 elseif section == "user" then
245 print [[user:create(jid, password) - Create the specified user account]]
246 print [[user:password(jid, password) - Set the password for the specified user account]]
247 print [[user:delete(jid) - Permanently remove the specified user account]]
248 print [[user:list(hostname, pattern) - List users on the specified host, optionally filtering with a pattern]]
249 elseif section == "server" then
250 print [[server:version() - Show the server's version number]]
251 print [[server:uptime() - Show how long the server has been running]]
252 print [[server:memory() - Show details about the server's memory usage]]
253 print [[server:shutdown(reason) - Shut down the server, with an optional reason to be broadcast to all connections]]
254 elseif section == "port" then
255 print [[port:list() - Lists all network ports prosody currently listens on]]
256 print [[port:close(port, interface) - Close a port]]
257 elseif section == "dns" then
258 print [[dns:lookup(name, type, class) - Do a DNS lookup]]
259 print [[dns:addnameserver(nameserver) - Add a nameserver to the list]]
260 print [[dns:setnameserver(nameserver) - Replace the list of name servers with the supplied one]]
261 print [[dns:purge() - Clear the DNS cache]]
262 print [[dns:cache() - Show cached records]]
263 elseif section == "config" then
264 print [[config:reload() - Reload the server configuration. Modules may need to be reloaded for changes to take effect.]]
265 elseif section == "console" then
266 print [[Hey! Welcome to Prosody's admin console.]]
267 print [[First thing, if you're ever wondering how to get out, simply type 'quit'.]]
268 print [[Secondly, note that we don't support the full telnet protocol yet (it's coming)]]
269 print [[so you may have trouble using the arrow keys, etc. depending on your system.]]
271 print [[For now we offer a couple of handy shortcuts:]]
272 print [[!! - Repeat the last command]]
273 print [[!old!new! - repeat the last command, but with 'old' replaced by 'new']]
275 print [[For those well-versed in Prosody's internals, or taking instruction from those who are,]]
276 print [[you can prefix a command with > to escape the console sandbox, and access everything in]]
277 print [[the running server. Great fun, but be careful not to break anything :)]]
282 -- Session environment --
283 -- Anything in def_env will be accessible within the session as a global variable
285 --luacheck: ignore 212/self
289 function def_env.server:insane_reload()
290 prosody.unlock_globals();
292 prosody = _G.prosody;
293 return true, "Server reloaded";
296 function def_env.server:version()
297 return true, tostring(prosody.version or "unknown");
300 function def_env.server:uptime()
301 local t = os.time()-prosody.start_time;
302 local seconds = t%60;
303 t = (t - seconds)/60;
304 local minutes = t%60;
305 t = (t - minutes)/60;
309 return true, string.format("This server has been running for %d day%s, %d hour%s and %d minute%s (since %s)",
310 days, (days ~= 1 and "s") or "", hours, (hours ~= 1 and "s") or "",
311 minutes, (minutes ~= 1 and "s") or "", os.date("%c", prosody.start_time));
314 function def_env.server:shutdown(reason)
315 prosody.shutdown(reason);
316 return true, "Shutdown initiated";
319 local function human(kb)
322 kb, unit = kb/1024, "M";
324 return ("%0.2f%sB"):format(kb, unit);
327 function def_env.server:memory()
328 if not has_pposix or not pposix.meminfo then
329 return true, "Lua is using "..collectgarbage("count");
331 local mem, lua_mem = pposix.meminfo(), collectgarbage("count");
332 local print = self.session.print;
333 print("Process: "..human((mem.allocated+mem.allocated_mmap)/1024));
334 print(" Used: "..human(mem.used/1024).." ("..human(lua_mem).." by Lua)");
335 print(" Free: "..human(mem.unused/1024).." ("..human(mem.returnable/1024).." returnable)");
341 local function get_hosts_set(hosts, module)
342 if type(hosts) == "table" then
344 return set.new(hosts);
345 elseif hosts._items then
348 elseif type(hosts) == "string" then
349 return set.new { hosts };
350 elseif hosts == nil then
351 local hosts_set = set.new(array.collect(keys(prosody.hosts)))
352 / function (host) return (prosody.hosts[host].type == "local" or module and modulemanager.is_loaded(host, module)) and host or nil; end;
353 if module and modulemanager.get_module("*", module) then
360 function def_env.module:load(name, hosts, config)
361 hosts = get_hosts_set(hosts);
363 -- Load the module for each host
364 local ok, err, count, mod = true, nil, 0, nil;
366 if (not modulemanager.is_loaded(host, name)) then
367 mod, err = modulemanager.load(host, name, config);
370 if err == "global-module-already-loaded" then
372 ok, err, count = true, nil, 1;
376 self.session.print(err or "Unknown error loading module");
379 self.session.print("Loaded for "..mod.module.host);
384 return ok, (ok and "Module loaded onto "..count.." host"..(count ~= 1 and "s" or "")) or ("Last error: "..tostring(err));
387 function def_env.module:unload(name, hosts)
388 hosts = get_hosts_set(hosts, name);
390 -- Unload the module for each host
391 local ok, err, count = true, nil, 0;
393 if modulemanager.is_loaded(host, name) then
394 ok, err = modulemanager.unload(host, name);
397 self.session.print(err or "Unknown error unloading module");
400 self.session.print("Unloaded from "..host);
404 return ok, (ok and "Module unloaded from "..count.." host"..(count ~= 1 and "s" or "")) or ("Last error: "..tostring(err));
407 function def_env.module:reload(name, hosts)
408 hosts = array.collect(get_hosts_set(hosts, name)):sort(function (a, b)
409 if a == "*" then return true
410 elseif b == "*" then return false
411 else return a < b; end
414 -- Reload the module for each host
415 local ok, err, count = true, nil, 0;
416 for _, host in ipairs(hosts) do
417 if modulemanager.is_loaded(host, name) then
418 ok, err = modulemanager.reload(host, name);
421 self.session.print(err or "Unknown error reloading module");
427 self.session.print("Reloaded on "..host);
431 return ok, (ok and "Module reloaded on "..count.." host"..(count ~= 1 and "s" or "")) or ("Last error: "..tostring(err));
434 function def_env.module:list(hosts)
436 hosts = array.collect(keys(prosody.hosts));
437 table.insert(hosts, 1, "*");
439 if type(hosts) == "string" then
442 if type(hosts) ~= "table" then
443 return false, "Please supply a host or a list of hosts you would like to see";
446 local print = self.session.print;
447 for _, host in ipairs(hosts) do
448 print((host == "*" and "Global" or host)..":");
449 local modules = array.collect(keys(modulemanager.get_modules(host) or {})):sort();
450 if #modules == 0 then
451 if prosody.hosts[host] then
452 print(" No modules loaded");
454 print(" Host not found");
457 for _, name in ipairs(modules) do
465 function def_env.config:load(filename, format)
466 local config_load = require "core.configmanager".load;
467 local ok, err = config_load(filename, format);
469 return false, err or "Unknown error loading config";
471 return true, "Config loaded";
474 function def_env.config:get(host, section, key)
475 local config_get = require "core.configmanager".get
476 return true, tostring(config_get(host, section, key));
479 function def_env.config:reload()
480 local ok, err = prosody.reload_config();
481 return ok, (ok and "Config reloaded (you may need to reload modules to take effect)") or tostring(err);
484 local function common_info(session, line)
486 line[#line+1] = "["..session.id.."]"
488 line[#line+1] = "["..session.type..(tostring(session):match("%x*$")).."]"
492 local function session_flags(session, line)
494 common_info(session, line);
495 if session.type == "c2s" then
496 local status, priority = "unavailable", tostring(session.priority or "-");
497 if session.presence then
498 status = session.presence:get_child_text("show") or "available";
500 line[#line+1] = status.."("..priority..")";
502 if session.cert_identity_status == "valid" then
503 line[#line+1] = "(authenticated)";
505 if session.secure then
506 line[#line+1] = "(encrypted)";
508 if session.compressed then
509 line[#line+1] = "(compressed)";
511 if session.smacks then
512 line[#line+1] = "(sm)";
514 if session.ip and session.ip:match(":") then
515 line[#line+1] = "(IPv6)";
517 if session.remote then
518 line[#line+1] = "(remote)";
520 return table.concat(line, " ");
523 local function tls_info(session, line)
525 common_info(session, line);
526 if session.secure then
527 local sock = session.conn and session.conn.socket and session.conn:socket();
528 if sock and sock.info then
529 local info = sock:info();
530 line[#line+1] = ("(%s with %s)"):format(info.protocol, info.cipher);
532 line[#line+1] = "(cipher info unavailable)";
535 line[#line+1] = "(insecure)";
537 return table.concat(line, " ");
542 local function get_jid(session)
543 if session.username then
544 return session.full_jid or jid_join(session.username, session.host, session.resource);
547 local conn = session.conn;
548 local ip = session.ip or "?";
549 local clientport = conn and conn:clientport() or "?";
550 local serverip = conn and conn.server and conn:server():ip() or "?";
551 local serverport = conn and conn:serverport() or "?"
552 return jid_join("["..ip.."]:"..clientport, session.host or "["..serverip.."]:"..serverport);
555 local function show_c2s(callback)
556 local c2s = array.collect(values(module:shared"/*/c2s/sessions"));
557 c2s:sort(function(a, b)
558 if a.host == b.host then
559 if a.username == b.username then
560 return (a.resource or "") > (b.resource or "");
562 return (a.username or "") > (b.username or "");
564 return (a.host or "") > (b.host or "");
565 end):map(function (session)
566 callback(get_jid(session), session)
570 function def_env.c2s:count(match_jid)
571 return true, "Total: ".. iterators.count(values(module:shared"/*/c2s/sessions")) .." clients";
574 function def_env.c2s:show(match_jid, annotate)
575 local print, count = self.session.print, 0;
576 annotate = annotate or session_flags;
577 local curr_host = false;
578 show_c2s(function (jid, session)
579 if curr_host ~= session.host then
580 curr_host = session.host;
581 print(curr_host or "(not connected to any host yet)");
583 if (not match_jid) or jid:match(match_jid) then
585 print(annotate(session, { " ", jid }));
588 return true, "Total: "..count.." clients";
591 function def_env.c2s:show_insecure(match_jid)
592 local print, count = self.session.print, 0;
593 show_c2s(function (jid, session)
594 if ((not match_jid) or jid:match(match_jid)) and not session.secure then
599 return true, "Total: "..count.." insecure client connections";
602 function def_env.c2s:show_secure(match_jid)
603 local print, count = self.session.print, 0;
604 show_c2s(function (jid, session)
605 if ((not match_jid) or jid:match(match_jid)) and session.secure then
610 return true, "Total: "..count.." secure client connections";
613 function def_env.c2s:show_tls(match_jid)
614 return self:show(match_jid, tls_info);
617 function def_env.c2s:close(match_jid)
619 show_c2s(function (jid, session)
620 if jid == match_jid or jid_bare(jid) == match_jid then
625 return true, "Total: "..count.." sessions closed";
630 function def_env.s2s:show(match_jid, annotate)
631 local print = self.session.print;
632 annotate = annotate or session_flags;
634 local count_in, count_out = 0,0;
635 local s2s_list = { };
637 local s2s_sessions = module:shared"/*/s2s/sessions";
638 for _, session in pairs(s2s_sessions) do
639 local remotehost, localhost, direction;
640 if session.direction == "outgoing" then
642 count_out = count_out + 1;
643 remotehost, localhost = session.to_host or "?", session.from_host or "?";
646 count_in = count_in + 1;
647 remotehost, localhost = session.from_host or "?", session.to_host or "?";
649 local sess_lines = { l = localhost, r = remotehost,
650 annotate(session, { "", direction, remotehost or "?" })};
652 if (not match_jid) or remotehost:match(match_jid) or localhost:match(match_jid) then
653 table.insert(s2s_list, sess_lines);
654 local print = function (s) table.insert(sess_lines, " "..s); end
655 if session.sendq then
656 print("There are "..#session.sendq.." queued outgoing stanzas for this connection");
658 if session.type == "s2sout_unauthed" then
659 if session.connecting then
660 print("Connection not yet established");
661 if not session.srv_hosts then
662 if not session.conn then
663 print("We do not yet have a DNS answer for this host's SRV records");
665 print("This host has no SRV records, using A record instead");
667 elseif session.srv_choice then
668 print("We are on SRV record "..session.srv_choice.." of "..#session.srv_hosts);
669 local srv_choice = session.srv_hosts[session.srv_choice];
670 print("Using "..(srv_choice.target or ".")..":"..(srv_choice.port or 5269));
672 elseif session.notopen then
673 print("The <stream> has not yet been opened");
674 elseif not session.dialback_key then
675 print("Dialback has not been initiated yet");
676 elseif session.dialback_key then
677 print("Dialback has been requested, but no result received");
680 if session.type == "s2sin_unauthed" then
681 print("Connection not yet authenticated");
682 elseif session.type == "s2sin" then
683 for name in pairs(session.hosts) do
684 if name ~= session.from_host then
685 print("also hosts "..tostring(name));
692 -- Sort by local host, then remote host
693 table.sort(s2s_list, function(a,b)
694 if a.l == b.l then return a.r < b.r; end
698 for _, sess_lines in ipairs(s2s_list) do
699 if sess_lines.l ~= lasthost then print(sess_lines.l); lasthost=sess_lines.l end
700 for _, line in ipairs(sess_lines) do print(line); end
702 return true, "Total: "..count_out.." outgoing, "..count_in.." incoming connections";
705 function def_env.s2s:show_tls(match_jid)
706 return self:show(match_jid, tls_info);
709 local function print_subject(print, subject)
710 for _, entry in ipairs(subject) do
713 entry.name or entry.oid,
714 entry.value:gsub("[\r\n%z%c]", " ")
720 -- As much as it pains me to use the 0-based depths that OpenSSL does,
721 -- I think there's going to be more confusion among operators if we
723 local function print_errors(print, errors)
724 for depth, t in pairs(errors) do
728 table.concat(t, "\n| ")
734 function def_env.s2s:showcert(domain)
735 local ser = require "util.serialization".serialize;
736 local print = self.session.print;
737 local s2s_sessions = module:shared"/*/s2s/sessions";
738 local domain_sessions = set.new(array.collect(values(s2s_sessions)))
739 /function(session) return (session.to_host == domain or session.from_host == domain) and session or nil; end;
741 for session in domain_sessions do
742 local conn = session.conn;
743 conn = conn and conn:socket();
744 if not conn.getpeerchain then
745 if conn.dohandshake then
746 error("This version of LuaSec does not support certificate viewing");
749 local cert = conn:getpeercertificate();
751 local certs = conn:getpeerchain();
752 local digest = cert:digest("sha1");
753 if not cert_set[digest] then
754 local chain_valid, chain_errors = conn:getpeerverification();
757 from = session.from_host,
758 to = session.to_host,
759 direction = session.direction
761 chain_valid = chain_valid;
762 chain_errors = chain_errors;
766 table.insert(cert_set[digest], {
767 from = session.from_host,
768 to = session.to_host,
769 direction = session.direction
775 local domain_certs = array.collect(values(cert_set));
776 -- Phew. We now have a array of unique certificates presented by domain.
777 local n_certs = #domain_certs;
780 return "No certificates found for "..domain;
783 local function _capitalize_and_colon(byte)
784 return string.upper(byte)..":";
786 local function pretty_fingerprint(hash)
787 return hash:gsub("..", _capitalize_and_colon):sub(1, -2);
790 for cert_info in values(domain_certs) do
791 local certs = cert_info.certs;
792 local cert = certs[1];
794 print("Fingerprint (SHA1): "..pretty_fingerprint(cert:digest("sha1")));
796 local n_streams = #cert_info;
797 print("Currently used on "..n_streams.." stream"..(n_streams==1 and "" or "s")..":");
798 for _, stream in ipairs(cert_info) do
799 if stream.direction == "incoming" then
800 print(" "..stream.to.." <- "..stream.from);
802 print(" "..stream.from.." -> "..stream.to);
806 local chain_valid, errors = cert_info.chain_valid, cert_info.chain_errors;
807 local valid_identity = cert_verify_identity(domain, "xmpp-server", cert);
809 print("Trusted certificate: Yes");
811 print("Trusted certificate: No");
812 print_errors(print, errors);
816 print_subject(print, cert:issuer());
818 print("Valid for "..domain..": "..(valid_identity and "Yes" or "No"));
820 print_subject(print, cert:subject());
823 return ("Showing "..n_certs.." certificate"
824 ..(n_certs==1 and "" or "s")
825 .." presented by "..domain..".");
828 function def_env.s2s:close(from, to)
829 local print, count = self.session.print, 0;
830 local s2s_sessions = module:shared"/*/s2s/sessions";
833 if from and not to then
834 match_id, from = from;
836 return false, "Syntax: s2s:close('from', 'to') - Closes all s2s sessions from 'from' to 'to'";
837 elseif from == to then
838 return false, "Both from and to are the same... you can't do that :)";
841 for _, session in pairs(s2s_sessions) do
842 local id = session.type..tostring(session):match("[a-f0-9]+$");
843 if (match_id and match_id == id)
844 or (session.from_host == from and session.to_host == to) then
845 print(("Closing connection from %s to %s [%s]"):format(session.from_host, session.to_host, id));
846 (session.close or s2smanager.destroy_session)(session);
850 return true, "Closed "..count.." s2s session"..((count == 1 and "") or "s");
853 function def_env.s2s:closeall(host)
855 local s2s_sessions = module:shared"/*/s2s/sessions";
856 for _,session in pairs(s2s_sessions) do
857 if not host or session.from_host == host or session.to_host == host then
862 if count == 0 then return false, "No sessions to close.";
863 else return true, "Closed "..count.." s2s session"..((count == 1 and "") or "s"); end
866 def_env.host = {}; def_env.hosts = def_env.host;
868 function def_env.host:activate(hostname, config)
869 return hostmanager.activate(hostname, config);
871 function def_env.host:deactivate(hostname, reason)
872 return hostmanager.deactivate(hostname, reason);
875 function def_env.host:list()
876 local print = self.session.print;
879 for host in values(array.collect(keys(prosody.hosts)):sort()) do
881 type = hosts[host].type;
882 if type == "local" then
885 type = module:context(host):get_option_string("component_module", type);
886 if type ~= "component" then
887 type = type .. " component";
889 print(("%s (%s)"):format(host, type));
892 return true, i.." hosts";
897 function def_env.port:list()
898 local print = self.session.print;
899 local services = portmanager.get_active_services().data;
900 local ordered_services, n_ports = {}, 0;
901 for service, interfaces in pairs(services) do
902 table.insert(ordered_services, service);
904 table.sort(ordered_services);
905 for _, service in ipairs(ordered_services) do
906 local ports_list = {};
907 for interface, ports in pairs(services[service]) do
908 for port in pairs(ports) do
909 table.insert(ports_list, "["..interface.."]:"..port);
912 n_ports = n_ports + #ports_list;
913 print(service..": "..table.concat(ports_list, ", "));
915 return true, #ordered_services.." services listening on "..n_ports.." ports";
918 function def_env.port:close(close_port, close_interface)
919 close_port = assert(tonumber(close_port), "Invalid port number");
921 local services = portmanager.get_active_services().data;
922 for service, interfaces in pairs(services) do
923 for interface, ports in pairs(interfaces) do
924 if not close_interface or close_interface == interface then
925 if ports[close_port] then
926 self.session.print("Closing ["..interface.."]:"..close_port.."...");
927 local ok, err = portmanager.close(interface, close_port)
929 self.session.print("Failed to close "..interface.." "..close_port..": "..err);
931 n_closed = n_closed + 1;
937 return true, "Closed "..n_closed.." ports";
942 local console_room_mt = {
943 __index = function (self, k) return self.room[k]; end;
944 __tostring = function (self)
945 return "MUC room <"..self.room.jid..">";
949 local function check_muc(jid)
950 local room_name, host = jid_split(jid);
951 if not hosts[host] then
952 return nil, "No such host: "..host;
953 elseif not hosts[host].modules.muc then
954 return nil, "Host '"..host.."' is not a MUC service";
956 return room_name, host;
959 function def_env.muc:create(room_jid)
960 local room_name, host = check_muc(room_jid);
961 if not room_name then
962 return room_name, host;
964 if not room_name then return nil, host end
965 if hosts[host].modules.muc.rooms[room_jid] then return nil, "Room exists already" end
966 return hosts[host].modules.muc.create_room(room_jid);
969 function def_env.muc:room(room_jid)
970 local room_name, host = check_muc(room_jid);
971 if not room_name then
972 return room_name, host;
974 local room_obj = hosts[host].modules.muc.rooms[room_jid];
976 return nil, "No such room: "..room_jid;
978 return setmetatable({ room = room_obj }, console_room_mt);
981 function def_env.muc:list(host)
982 local host_session = hosts[host];
983 if not host_session or not host_session.modules.muc then
984 return nil, "Please supply the address of a local MUC component";
986 local print = self.session.print;
988 for name in keys(host_session.modules.muc.rooms) do
992 return true, c.." rooms";
995 local um = require"core.usermanager";
998 function def_env.user:create(jid, password)
999 local username, host = jid_split(jid);
1000 if not hosts[host] then
1001 return nil, "No such host: "..host;
1002 elseif um.user_exists(username, host) then
1003 return nil, "User exists";
1005 local ok, err = um.create_user(username, password, host);
1007 return true, "User created";
1009 return nil, "Could not create user: "..err;
1013 function def_env.user:delete(jid)
1014 local username, host = jid_split(jid);
1015 if not hosts[host] then
1016 return nil, "No such host: "..host;
1017 elseif not um.user_exists(username, host) then
1018 return nil, "No such user";
1020 local ok, err = um.delete_user(username, host);
1022 return true, "User deleted";
1024 return nil, "Could not delete user: "..err;
1028 function def_env.user:password(jid, password)
1029 local username, host = jid_split(jid);
1030 if not hosts[host] then
1031 return nil, "No such host: "..host;
1032 elseif not um.user_exists(username, host) then
1033 return nil, "No such user";
1035 local ok, err = um.set_password(username, password, host);
1037 return true, "User password changed";
1039 return nil, "Could not change password for user: "..err;
1043 function def_env.user:list(host, pat)
1045 return nil, "No host given";
1046 elseif not hosts[host] then
1047 return nil, "No such host";
1049 local print = self.session.print;
1050 local total, matches = 0, 0;
1051 for user in um.users(host) do
1052 if not pat or user:match(pat) then
1053 print(user.."@"..host);
1054 matches = matches + 1;
1058 return true, "Showing "..(pat and (matches.." of ") or "all " )..total.." users";
1063 local st = require "util.stanza";
1064 function def_env.xmpp:ping(localhost, remotehost)
1065 if hosts[localhost] then
1066 core_post_stanza(hosts[localhost],
1067 st.iq{ from=localhost, to=remotehost, type="get", id="ping" }
1068 :tag("ping", {xmlns="urn:xmpp:ping"}));
1069 return true, "Sent ping";
1071 return nil, "No such host";
1076 local adns = require"net.adns";
1077 local dns = require"net.dns";
1079 function def_env.dns:lookup(name, typ, class)
1080 local ret = "Query sent";
1081 local print = self.session.print;
1082 local function handler(...)
1083 ret = "Got response";
1086 adns.lookup(handler, name, typ, class);
1090 function def_env.dns:addnameserver(...)
1091 dns._resolver:addnameserver(...)
1095 function def_env.dns:setnameserver(...)
1096 dns._resolver:setnameserver(...)
1100 function def_env.dns:purge()
1105 function def_env.dns:cache()
1106 return true, "Cache:\n"..tostring(dns.cache())
1111 function def_env.http:list()
1112 local print = self.session.print;
1114 for host in pairs(prosody.hosts) do
1115 local http_apps = modulemanager.get_items("http-provider", host);
1116 if #http_apps > 0 then
1117 local http_host = module:context(host):get_option("http_host");
1118 print("HTTP endpoints on "..host..(http_host and (" (using "..http_host.."):") or ":"));
1119 for _, provider in ipairs(http_apps) do
1120 local url = module:context(host):http_url(provider.name);
1127 local default_host = module:get_option("http_default_host");
1128 if not default_host then
1129 print("HTTP requests to unknown hosts will return 404 Not Found");
1131 print("HTTP requests to unknown hosts will be handled by "..default_host);
1138 function printbanner(session)
1139 local option = module:get_option_string("console_banner", "full");
1140 if option == "full" or option == "graphic" then
1143 | _ \ _ __ ___ ___ _-_ __| |_ _
1144 | |_) | '__/ _ \/ __|/ _ \ / _` | | | |
1145 | __/| | | (_) \__ \ |_| | (_| | |_| |
1146 |_| |_| \___/|___/\___/ \__,_|\__, |
1147 A study in simplicity |___/
1151 if option == "short" or option == "full" then
1152 session.print("Welcome to the Prosody administration console. For a list of commands, type: help");
1153 session.print("You may find more help on using this console in our online documentation at ");
1154 session.print("http://prosody.im/doc/console\n");
1156 if option ~= "short" and option ~= "full" and option ~= "graphic" then
1157 session.print(option);
1161 module:provides("net", {
1163 listener = console_listener;
1164 default_port = 5582;