plugins/mod_admin_telnet.lua

   1 -- Prosody IM
   2 -- Copyright (C) 2008-2010 Matthew Wild
   3 -- Copyright (C) 2008-2010 Waqas Hussain
   4 --
   5 -- This project is MIT/X11 licensed. Please see the
   6 -- COPYING file in the source package for more information.
   7 --
   8
   9 module:set_global();
  10
  11 local hostmanager = require "core.hostmanager";
  12 local modulemanager = require "core.modulemanager";
  13 local s2smanager = require "core.s2smanager";
  14 local portmanager = require "core.portmanager";
  15
  16 local _G = _G;
  17
  18 local prosody = _G.prosody;
  19 local hosts = prosody.hosts;
  20
  21 local console_listener = { default_port = 5582; default_mode = "*a"; interface = "127.0.0.1" };
  22
  23 local iterators = require "util.iterators";
  24 local keys, values = iterators.keys, iterators.values;
  25 local jid_bare, jid_split = import("util.jid", "bare", "prepped_split");
  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
  31 local commands = module:shared("commands")
  32 local def_env = module:shared("env");
  33 local default_env_mt = { __index = def_env };
  34 local core_post_stanza = prosody.core_post_stanza;
  35
  36 local function redirect_output(_G, session)
  37         local env = setmetatable({ print = session.print }, { __index = function (t, k) return rawget(_G, k); end });
  38         env.dofile = function(name)
  39                 local f, err = envloadfile(name, env);
  40                 if not f then return f, err; end
  41                 return f();
  42         end;
  43         return env;
  44 end
  45
  46 console = {};
  47
  48 function console:new_session(conn)
  49         local w = function(s) conn:write(s:gsub("\n", "\r\n")); end;
  50         local session = { conn = conn;
  51                         send = function (t) w(tostring(t)); end;
  52                         print = function (...)
  53                                 local t = {};
  54                                 for i=1,select("#", ...) do
  55                                         t[i] = tostring(select(i, ...));
  56                                 end
  57                                 w("| "..table.concat(t, "\t").."\n");
  58                         end;
  59                         disconnect = function () conn:close(); end;
  60                         };
  61         session.env = setmetatable({}, default_env_mt);
  62
  63         -- Load up environment with helper objects
  64         for name, t in pairs(def_env) do
  65                 if type(t) == "table" then
  66                         session.env[name] = setmetatable({ session = session }, { __index = t });
  67                 end
  68         end
  69
  70         return session;
  71 end
  72
  73 function console:process_line(session, line)
  74         local useglobalenv;
  75
  76         if line:match("^>") then
  77                 line = line:gsub("^>", "");
  78                 useglobalenv = true;
  79         elseif line == "\004" then
  80                 commands["bye"](session, line);
  81                 return;
  82         else
  83                 local command = line:match("^%w+") or line:match("%p");
  84                 if commands[command] then
  85                         commands[command](session, line);
  86                         return;
  87                 end
  88         end
  89
  90         session.env._ = line;
  91
  92         local chunkname = "=console";
  93         local env = (useglobalenv and redirect_output(_G, session)) or session.env or nil
  94         local chunk, err = envload("return "..line, chunkname, env);
  95         if not chunk then
  96                 chunk, err = envload(line, chunkname, env);
  97                 if not chunk then
  98                         err = err:gsub("^%[string .-%]:%d+: ", "");
  99                         err = err:gsub("^:%d+: ", "");
 100                         err = err:gsub("'<eof>'", "the end of the line");
 101                         session.print("Sorry, I couldn't understand that... "..err);
 102                         return;
 103                 end
 104         end
 105
 106         local ranok, taskok, message = pcall(chunk);
 107
 108         if not (ranok or message or useglobalenv) and commands[line:lower()] then
 109                 commands[line:lower()](session, line);
 110                 return;
 111         end
 112
 113         if not ranok then
 114                 session.print("Fatal error while running command, it did not complete");
 115                 session.print("Error: "..taskok);
 116                 return;
 117         end
 118
 119         if not message then
 120                 session.print("Result: "..tostring(taskok));
 121                 return;
 122         elseif (not taskok) and message then
 123                 session.print("Command completed with a problem");
 124                 session.print("Message: "..tostring(message));
 125                 return;
 126         end
 127
 128         session.print("OK: "..tostring(message));
 129 end
 130
 131 local sessions = {};
 132
 133 function console_listener.onconnect(conn)
 134         -- Handle new connection
 135         local session = console:new_session(conn);
 136         sessions[conn] = session;
 137         printbanner(session);
 138         session.send(string.char(0));
 139 end
 140
 141 function console_listener.onincoming(conn, data)
 142         local session = sessions[conn];
 143
 144         local partial = session.partial_data;
 145         if partial then
 146                 data = partial..data;
 147         end
 148
 149         for line in data:gmatch("[^\n]*[\n\004]") do
 150                 if session.closed then return end
 151                 console:process_line(session, line);
 152                 session.send(string.char(0));
 153         end
 154         session.partial_data = data:match("[^\n]+$");
 155 end
 156
 157 function console_listener.onreadtimeout(conn)
 158         local session = sessions[conn];
 159         if session then
 160                 session.send("\0");
 161                 return true;
 162         end
 163 end
 164
 165 function console_listener.ondisconnect(conn, err)
 166         local session = sessions[conn];
 167         if session then
 168                 session.disconnect();
 169                 sessions[conn] = nil;
 170         end
 171 end
 172
 173 -- Console commands --
 174 -- These are simple commands, not valid standalone in Lua
 175
 176 function commands.bye(session)
 177         session.print("See you! :)");
 178         session.closed = true;
 179         session.disconnect();
 180 end
 181 commands.quit, commands.exit = commands.bye, commands.bye;
 182
 183 commands["!"] = function (session, data)
 184         if data:match("^!!") and session.env._ then
 185                 session.print("!> "..session.env._);
 186                 return console_listener.onincoming(session.conn, session.env._);
 187         end
 188         local old, new = data:match("^!(.-[^\\])!(.-)!$");
 189         if old and new then
 190                 local ok, res = pcall(string.gsub, session.env._, old, new);
 191                 if not ok then
 192                         session.print(res)
 193                         return;
 194                 end
 195                 session.print("!> "..res);
 196                 return console_listener.onincoming(session.conn, res);
 197         end
 198         session.print("Sorry, not sure what you want");
 199 end
 200
 201
 202 function commands.help(session, data)
 203         local print = session.print;
 204         local section = data:match("^help (%w+)");
 205         if not section then
 206                 print [[Commands are divided into multiple sections. For help on a particular section, ]]
 207                 print [[type: help SECTION (for example, 'help c2s'). Sections are: ]]
 208                 print [[]]
 209                 print [[c2s - Commands to manage local client-to-server sessions]]
 210                 print [[s2s - Commands to manage sessions between this server and others]]
 211                 print [[module - Commands to load/reload/unload modules/plugins]]
 212                 print [[host - Commands to activate, deactivate and list virtual hosts]]
 213                 print [[user - Commands to create and delete users, and change their passwords]]
 214                 print [[server - Uptime, version, shutting down, etc.]]
 215                 print [[port - Commands to manage ports the server is listening on]]
 216                 print [[dns - Commands to manage and inspect the internal DNS resolver]]
 217                 print [[config - Reloading the configuration, etc.]]
 218                 print [[console - Help regarding the console itself]]
 219         elseif section == "c2s" then
 220                 print [[c2s:show(jid) - Show all client sessions with the specified JID (or all if no JID given)]]
 221                 print [[c2s:show_insecure() - Show all unencrypted client connections]]
 222                 print [[c2s:show_secure() - Show all encrypted client connections]]
 223                 print [[c2s:close(jid) - Close all sessions for the specified JID]]
 224         elseif section == "s2s" then
 225                 print [[s2s:show(domain) - Show all s2s connections for the given domain (or all if no domain given)]]
 226                 print [[s2s:show_tls(domain) - Show TLS cipher info for encrypted sessions]]
 227                 print [[s2s:close(from, to) - Close a connection from one domain to another]]
 228                 print [[s2s:closeall(host) - Close all the incoming/outgoing s2s sessions to specified host]]
 229         elseif section == "module" then
 230                 print [[module:load(module, host) - Load the specified module on the specified host (or all hosts if none given)]]
 231                 print [[module:reload(module, host) - The same, but unloads and loads the module (saving state if the module supports it)]]
 232                 print [[module:unload(module, host) - The same, but just unloads the module from memory]]
 233                 print [[module:list(host) - List the modules loaded on the specified host]]
 234         elseif section == "host" then
 235                 print [[host:activate(hostname) - Activates the specified host]]
 236                 print [[host:deactivate(hostname) - Disconnects all clients on this host and deactivates]]
 237                 print [[host:list() - List the currently-activated hosts]]
 238         elseif section == "user" then
 239                 print [[user:create(jid, password) - Create the specified user account]]
 240                 print [[user:password(jid, password) - Set the password for the specified user account]]
 241                 print [[user:delete(jid) - Permanently remove the specified user account]]
 242                 print [[user:list(hostname, pattern) - List users on the specified host, optionally filtering with a pattern]]
 243         elseif section == "server" then
 244                 print [[server:version() - Show the server's version number]]
 245                 print [[server:uptime() - Show how long the server has been running]]
 246                 print [[server:memory() - Show details about the server's memory usage]]
 247                 print [[server:shutdown(reason) - Shut down the server, with an optional reason to be broadcast to all connections]]
 248         elseif section == "port" then
 249                 print [[port:list() - Lists all network ports prosody currently listens on]]
 250                 print [[port:close(port, interface) - Close a port]]
 251         elseif section == "dns" then
 252                 print [[dns:lookup(name, type, class) - Do a DNS lookup]]
 253                 print [[dns:addnameserver(nameserver) - Add a nameserver to the list]]
 254                 print [[dns:setnameserver(nameserver) - Replace the list of name servers with the supplied one]]
 255                 print [[dns:purge() - Clear the DNS cache]]
 256                 print [[dns:cache() - Show cached records]]
 257         elseif section == "config" then
 258                 print [[config:reload() - Reload the server configuration. Modules may need to be reloaded for changes to take effect.]]
 259         elseif section == "console" then
 260                 print [[Hey! Welcome to Prosody's admin console.]]
 261                 print [[First thing, if you're ever wondering how to get out, simply type 'quit'.]]
 262                 print [[Secondly, note that we don't support the full telnet protocol yet (it's coming)]]
 263                 print [[so you may have trouble using the arrow keys, etc. depending on your system.]]
 264                 print [[]]
 265                 print [[For now we offer a couple of handy shortcuts:]]
 266                 print [[!! - Repeat the last command]]
 267                 print [[!old!new! - repeat the last command, but with 'old' replaced by 'new']]
 268                 print [[]]
 269                 print [[For those well-versed in Prosody's internals, or taking instruction from those who are,]]
 270                 print [[you can prefix a command with > to escape the console sandbox, and access everything in]]
 271                 print [[the running server. Great fun, but be careful not to break anything :)]]
 272         end
 273         print [[]]
 274 end
 275
 276 -- Session environment --
 277 -- Anything in def_env will be accessible within the session as a global variable
 278
 279 def_env.server = {};
 280
 281 function def_env.server:insane_reload()
 282         prosody.unlock_globals();
 283         dofile "prosody"
 284         prosody = _G.prosody;
 285         return true, "Server reloaded";
 286 end
 287
 288 function def_env.server:version()
 289         return true, tostring(prosody.version or "unknown");
 290 end
 291
 292 function def_env.server:uptime()
 293         local t = os.time()-prosody.start_time;
 294         local seconds = t%60;
 295         t = (t - seconds)/60;
 296         local minutes = t%60;
 297         t = (t - minutes)/60;
 298         local hours = t%24;
 299         t = (t - hours)/24;
 300         local days = t;
 301         return true, string.format("This server has been running for %d day%s, %d hour%s and %d minute%s (since %s)",
 302                 days, (days ~= 1 and "s") or "", hours, (hours ~= 1 and "s") or "",
 303                 minutes, (minutes ~= 1 and "s") or "", os.date("%c", prosody.start_time));
 304 end
 305
 306 function def_env.server:shutdown(reason)
 307         prosody.shutdown(reason);
 308         return true, "Shutdown initiated";
 309 end
 310
 311 local function human(kb)
 312         local unit = "K";
 313         if kb > 1024 then
 314                 kb, unit = kb/1024, "M";
 315         end
 316         return ("%0.2f%sB"):format(kb, unit);
 317 end
 318
 319 function def_env.server:memory()
 320         if not pposix.meminfo then
 321                 return true, "Lua is using "..collectgarbage("count");
 322         end
 323         local mem, lua_mem = pposix.meminfo(), collectgarbage("count");
 324         local print = self.session.print;
 325         print("Process: "..human((mem.allocated+mem.allocated_mmap)/1024));
 326         print("   Used: "..human(mem.used/1024).." ("..human(lua_mem).." by Lua)");
 327         print("   Free: "..human(mem.unused/1024).." ("..human(mem.returnable/1024).." returnable)");
 328         return true, "OK";
 329 end
 330
 331 def_env.module = {};
 332
 333 local function get_hosts_set(hosts, module)
 334         if type(hosts) == "table" then
 335                 if hosts[1] then
 336                         return set.new(hosts);
 337                 elseif hosts._items then
 338                         return hosts;
 339                 end
 340         elseif type(hosts) == "string" then
 341                 return set.new { hosts };
 342         elseif hosts == nil then
 343                 local mm = require "modulemanager";
 344                 local hosts_set = set.new(array.collect(keys(prosody.hosts)))
 345                         / function (host) return (prosody.hosts[host].type == "local" or module and mm.is_loaded(host, module)) and host or nil; end;
 346                 if module and mm.get_module("*", module) then
 347                         hosts_set:add("*");
 348                 end
 349                 return hosts_set;
 350         end
 351 end
 352
 353 function def_env.module:load(name, hosts, config)
 354         local mm = require "modulemanager";
 355
 356         hosts = get_hosts_set(hosts);
 357
 358         -- Load the module for each host
 359         local ok, err, count, mod = true, nil, 0, nil;
 360         for host in hosts do
 361                 if (not mm.is_loaded(host, name)) then
 362                         mod, err = mm.load(host, name, config);
 363                         if not mod then
 364                                 ok = false;
 365                                 if err == "global-module-already-loaded" then
 366                                         if count > 0 then
 367                                                 ok, err, count = true, nil, 1;
 368                                         end
 369                                         break;
 370                                 end
 371                                 self.session.print(err or "Unknown error loading module");
 372                         else
 373                                 count = count + 1;
 374                                 self.session.print("Loaded for "..mod.module.host);
 375                         end
 376                 end
 377         end
 378
 379         return ok, (ok and "Module loaded onto "..count.." host"..(count ~= 1 and "s" or "")) or ("Last error: "..tostring(err));
 380 end
 381
 382 function def_env.module:unload(name, hosts)
 383         local mm = require "modulemanager";
 384
 385         hosts = get_hosts_set(hosts, name);
 386
 387         -- Unload the module for each host
 388         local ok, err, count = true, nil, 0;
 389         for host in hosts do
 390                 if mm.is_loaded(host, name) then
 391                         ok, err = mm.unload(host, name);
 392                         if not ok then
 393                                 ok = false;
 394                                 self.session.print(err or "Unknown error unloading module");
 395                         else
 396                                 count = count + 1;
 397                                 self.session.print("Unloaded from "..host);
 398                         end
 399                 end
 400         end
 401         return ok, (ok and "Module unloaded from "..count.." host"..(count ~= 1 and "s" or "")) or ("Last error: "..tostring(err));
 402 end
 403
 404 function def_env.module:reload(name, hosts)
 405         local mm = require "modulemanager";
 406
 407         hosts = array.collect(get_hosts_set(hosts, name)):sort(function (a, b)
 408                 if a == "*" then return true
 409                 elseif b == "*" then return false
 410                 else return a < b; end
 411         end);
 412
 413         -- Reload the module for each host
 414         local ok, err, count = true, nil, 0;
 415         for _, host in ipairs(hosts) do
 416                 if mm.is_loaded(host, name) then
 417                         ok, err = mm.reload(host, name);
 418                         if not ok then
 419                                 ok = false;
 420                                 self.session.print(err or "Unknown error reloading module");
 421                         else
 422                                 count = count + 1;
 423                                 if ok == nil then
 424                                         ok = true;
 425                                 end
 426                                 self.session.print("Reloaded on "..host);
 427                         end
 428                 end
 429         end
 430         return ok, (ok and "Module reloaded on "..count.." host"..(count ~= 1 and "s" or "")) or ("Last error: "..tostring(err));
 431 end
 432
 433 function def_env.module:list(hosts)
 434         if hosts == nil then
 435                 hosts = array.collect(keys(prosody.hosts));
 436                 table.insert(hosts, 1, "*");
 437         end
 438         if type(hosts) == "string" then
 439                 hosts = { hosts };
 440         end
 441         if type(hosts) ~= "table" then
 442                 return false, "Please supply a host or a list of hosts you would like to see";
 443         end
 444
 445         local print = self.session.print;
 446         for _, host in ipairs(hosts) do
 447                 print((host == "*" and "Global" or host)..":");
 448                 local modules = array.collect(keys(modulemanager.get_modules(host) or {})):sort();
 449                 if #modules == 0 then
 450                         if prosody.hosts[host] then
 451                                 print("    No modules loaded");
 452                         else
 453                                 print("    Host not found");
 454                         end
 455                 else
 456                         for _, name in ipairs(modules) do
 457                                 print("    "..name);
 458                         end
 459                 end
 460         end
 461 end
 462
 463 def_env.config = {};
 464 function def_env.config:load(filename, format)
 465         local config_load = require "core.configmanager".load;
 466         local ok, err = config_load(filename, format);
 467         if not ok then
 468                 return false, err or "Unknown error loading config";
 469         end
 470         return true, "Config loaded";
 471 end
 472
 473 function def_env.config:get(host, section, key)
 474         local config_get = require "core.configmanager".get
 475         return true, tostring(config_get(host, section, key));
 476 end
 477
 478 function def_env.config:reload()
 479         local ok, err = prosody.reload_config();
 480         return ok, (ok and "Config reloaded (you may need to reload modules to take effect)") or tostring(err);
 481 end
 482
 483 def_env.hosts = {};
 484 function def_env.hosts:list()
 485         for host, host_session in pairs(hosts) do
 486                 self.session.print(host);
 487         end
 488         return true, "Done";
 489 end
 490
 491 function def_env.hosts:add(name)
 492 end
 493
 494 local function session_flags(session, line)
 495         line = line or {};
 496         if session.type == "c2s" then
 497                 local status, priority = "unavailable", tostring(session.priority or "-");
 498                 if session.presence then
 499                         status = session.presence:get_child_text("show") or "available";
 500                 end
 501                 line[#line+1] = status.."("..priority..")";
 502         end
 503         if session.cert_identity_status == "valid" then
 504                 line[#line+1] = "(authenticated)";
 505         end
 506         if session.secure then
 507                 line[#line+1] = "(encrypted)";
 508         end
 509         if session.compressed then
 510                 line[#line+1] = "(compressed)";
 511         end
 512         if session.smacks then
 513                 line[#line+1] = "(sm)";
 514         end
 515         if session.ip and session.ip:match(":") then
 516                 line[#line+1] = "(IPv6)";
 517         end
 518         return table.concat(line, " ");
 519 end
 520
 521 local function tls_info(session, line)
 522         line = line or {};
 523         if session.secure then
 524                 local sock = session.conn and session.conn.socket and session.conn:socket();
 525                 if sock and sock.info then
 526                         local info = sock:info();
 527                         line[#line+1] = ("(%s with %s)"):format(info.protocol, info.cipher);
 528                 else
 529                         line[#line+1] = "(cipher info unavailable)";
 530                 end
 531         else
 532                 line[#line+1] = "(insecure)";
 533         end
 534         return table.concat(line, " ");
 535 end
 536
 537 def_env.c2s = {};
 538
 539 local function show_c2s(callback)
 540         for hostname, host in pairs(hosts) do
 541                 for username, user in pairs(host.sessions or {}) do
 542                         for resource, session in pairs(user.sessions or {}) do
 543                                 local jid = username.."@"..hostname.."/"..resource;
 544                                 callback(jid, session);
 545                         end
 546                 end
 547         end
 548 end
 549
 550 function def_env.c2s:count(match_jid)
 551         local count = 0;
 552         show_c2s(function (jid, session)
 553                 if (not match_jid) or jid:match(match_jid) then
 554                         count = count + 1;
 555                 end
 556         end);
 557         return true, "Total: "..count.." clients";
 558 end
 559
 560 function def_env.c2s:show(match_jid)
 561         local print, count = self.session.print, 0;
 562         local curr_host;
 563         show_c2s(function (jid, session)
 564                 if curr_host ~= session.host then
 565                         curr_host = session.host;
 566                         print(curr_host);
 567                 end
 568                 if (not match_jid) or jid:match(match_jid) then
 569                         count = count + 1;
 570                         print(session_flags(session, { "  ", jid }));
 571                 end
 572         end);
 573         return true, "Total: "..count.." clients";
 574 end
 575
 576 function def_env.c2s:show_insecure(match_jid)
 577         local print, count = self.session.print, 0;
 578         show_c2s(function (jid, session)
 579                 if ((not match_jid) or jid:match(match_jid)) and not session.secure then
 580                         count = count + 1;
 581                         print(jid);
 582                 end
 583         end);
 584         return true, "Total: "..count.." insecure client connections";
 585 end
 586
 587 function def_env.c2s:show_secure(match_jid)
 588         local print, count = self.session.print, 0;
 589         show_c2s(function (jid, session)
 590                 if ((not match_jid) or jid:match(match_jid)) and session.secure then
 591                         count = count + 1;
 592                         print(jid);
 593                 end
 594         end);
 595         return true, "Total: "..count.." secure client connections";
 596 end
 597
 598 function def_env.c2s:close(match_jid)
 599         local count = 0;
 600         show_c2s(function (jid, session)
 601                 if jid == match_jid or jid_bare(jid) == match_jid then
 602                         count = count + 1;
 603                         session:close();
 604                 end
 605         end);
 606         return true, "Total: "..count.." sessions closed";
 607 end
 608
 609
 610 def_env.s2s = {};
 611 function def_env.s2s:show(match_jid, annotate)
 612         local print = self.session.print;
 613         annotate = annotate or session_flags;
 614
 615         local count_in, count_out = 0,0;
 616         local s2s_list = { };
 617
 618         local s2s_sessions = module:shared"/*/s2s/sessions";
 619         for _, session in pairs(s2s_sessions) do
 620                 local remotehost, localhost, direction;
 621                 if session.direction == "outgoing" then
 622                         direction = "->";
 623                         count_out = count_out + 1;
 624                         remotehost, localhost = session.to_host or "?", session.from_host or "?";
 625                 else
 626                         direction = "<-";
 627                         count_in = count_in + 1;
 628                         remotehost, localhost = session.from_host or "?", session.to_host or "?";
 629                 end
 630                 local sess_lines = { l = localhost, r = remotehost,
 631                         annotate(session, { "", direction, remotehost or "?",
 632                                 "["..session.type..tostring(session):match("[a-f0-9]*$").."]" })};
 633
 634                 if (not match_jid) or remotehost:match(match_jid) or localhost:match(match_jid) then
 635                         table.insert(s2s_list, sess_lines);
 636                         local print = function (s) table.insert(sess_lines, "        "..s); end
 637                         if session.sendq then
 638                                 print("There are "..#session.sendq.." queued outgoing stanzas for this connection");
 639                         end
 640                         if session.type == "s2sout_unauthed" then
 641                                 if session.connecting then
 642                                         print("Connection not yet established");
 643                                         if not session.srv_hosts then
 644                                                 if not session.conn then
 645                                                         print("We do not yet have a DNS answer for this host's SRV records");
 646                                                 else
 647                                                         print("This host has no SRV records, using A record instead");
 648                                                 end
 649                                         elseif session.srv_choice then
 650                                                 print("We are on SRV record "..session.srv_choice.." of "..#session.srv_hosts);
 651                                                 local srv_choice = session.srv_hosts[session.srv_choice];
 652                                                 print("Using "..(srv_choice.target or ".")..":"..(srv_choice.port or 5269));
 653                                         end
 654                                 elseif session.notopen then
 655                                         print("The <stream> has not yet been opened");
 656                                 elseif not session.dialback_key then
 657                                         print("Dialback has not been initiated yet");
 658                                 elseif session.dialback_key then
 659                                         print("Dialback has been requested, but no result received");
 660                                 end
 661                         end
 662                         if session.type == "s2sin_unauthed" then
 663                                 print("Connection not yet authenticated");
 664                         elseif session.type == "s2sin" then
 665                                 for name in pairs(session.hosts) do
 666                                         if name ~= session.from_host then
 667                                                 print("also hosts "..tostring(name));
 668                                         end
 669                                 end
 670                         end
 671                 end
 672         end
 673
 674         -- Sort by local host, then remote host
 675         table.sort(s2s_list, function(a,b)
 676                 if a.l == b.l then return a.r < b.r; end
 677                 return a.l < b.l;
 678         end);
 679         local lasthost;
 680         for _, sess_lines in ipairs(s2s_list) do
 681                 if sess_lines.l ~= lasthost then print(sess_lines.l); lasthost=sess_lines.l end
 682                 for _, line in ipairs(sess_lines) do print(line); end
 683         end
 684         return true, "Total: "..count_out.." outgoing, "..count_in.." incoming connections";
 685 end
 686
 687 function def_env.s2s:show_tls(match_jid)
 688         return self:show(match_jid, tls_info);
 689 end
 690
 691 local function print_subject(print, subject)
 692         for _, entry in ipairs(subject) do
 693                 print(
 694                         ("    %s: %q"):format(
 695                                 entry.name or entry.oid,
 696                                 entry.value:gsub("[\r\n%z%c]", " ")
 697                         )
 698                 );
 699         end
 700 end
 701
 702 -- As much as it pains me to use the 0-based depths that OpenSSL does,
 703 -- I think there's going to be more confusion among operators if we
 704 -- break from that.
 705 local function print_errors(print, errors)
 706         for depth, t in pairs(errors) do
 707                 print(
 708                         ("    %d: %s"):format(
 709                                 depth-1,
 710                                 table.concat(t, "\n|        ")
 711                         )
 712                 );
 713         end
 714 end
 715
 716 function def_env.s2s:showcert(domain)
 717         local ser = require "util.serialization".serialize;
 718         local print = self.session.print;
 719         local s2s_sessions = module:shared"/*/s2s/sessions";
 720         local domain_sessions = set.new(array.collect(values(s2s_sessions)))
 721                 /function(session) return (session.to_host == domain or session.from_host == domain) and session or nil; end;
 722         local cert_set = {};
 723         for session in domain_sessions do
 724                 local conn = session.conn;
 725                 conn = conn and conn:socket();
 726                 if not conn.getpeerchain then
 727                         if conn.dohandshake then
 728                                 error("This version of LuaSec does not support certificate viewing");
 729                         end
 730                 else
 731                         local cert = conn:getpeercertificate();
 732                         if cert then
 733                                 local certs = conn:getpeerchain();
 734                                 local digest = cert:digest("sha1");
 735                                 if not cert_set[digest] then
 736                                         local chain_valid, chain_errors = conn:getpeerverification();
 737                                         cert_set[digest] = {
 738                                                 {
 739                                                   from = session.from_host,
 740                                                   to = session.to_host,
 741                                                   direction = session.direction
 742                                                 };
 743                                                 chain_valid = chain_valid;
 744                                                 chain_errors = chain_errors;
 745                                                 certs = certs;
 746                                         };
 747                                 else
 748                                         table.insert(cert_set[digest], {
 749                                                 from = session.from_host,
 750                                                 to = session.to_host,
 751                                                 direction = session.direction
 752                                         });
 753                                 end
 754                         end
 755                 end
 756         end
 757         local domain_certs = array.collect(values(cert_set));
 758         -- Phew. We now have a array of unique certificates presented by domain.
 759         local n_certs = #domain_certs;
 760
 761         if n_certs == 0 then
 762                 return "No certificates found for "..domain;
 763         end
 764
 765         local function _capitalize_and_colon(byte)
 766                 return string.upper(byte)..":";
 767         end
 768         local function pretty_fingerprint(hash)
 769                 return hash:gsub("..", _capitalize_and_colon):sub(1, -2);
 770         end
 771
 772         for cert_info in values(domain_certs) do
 773                 local certs = cert_info.certs;
 774                 local cert = certs[1];
 775                 print("---")
 776                 print("Fingerprint (SHA1): "..pretty_fingerprint(cert:digest("sha1")));
 777                 print("");
 778                 local n_streams = #cert_info;
 779                 print("Currently used on "..n_streams.." stream"..(n_streams==1 and "" or "s")..":");
 780                 for _, stream in ipairs(cert_info) do
 781                         if stream.direction == "incoming" then
 782                                 print("    "..stream.to.." <- "..stream.from);
 783                         else
 784                                 print("    "..stream.from.." -> "..stream.to);
 785                         end
 786                 end
 787                 print("");
 788                 local chain_valid, errors = cert_info.chain_valid, cert_info.chain_errors;
 789                 local valid_identity = cert_verify_identity(domain, "xmpp-server", cert);
 790                 if chain_valid then
 791                         print("Trusted certificate: Yes");
 792                 else
 793                         print("Trusted certificate: No");
 794                         print_errors(print, errors);
 795                 end
 796                 print("");
 797                 print("Issuer: ");
 798                 print_subject(print, cert:issuer());
 799                 print("");
 800                 print("Valid for "..domain..": "..(valid_identity and "Yes" or "No"));
 801                 print("Subject:");
 802                 print_subject(print, cert:subject());
 803         end
 804         print("---");
 805         return ("Showing "..n_certs.." certificate"
 806                 ..(n_certs==1 and "" or "s")
 807                 .." presented by "..domain..".");
 808 end
 809
 810 function def_env.s2s:close(from, to)
 811         local print, count = self.session.print, 0;
 812         local s2s_sessions = module:shared"/*/s2s/sessions";
 813
 814         local match_id;
 815         if from and not to then
 816                 match_id, from = from;
 817         elseif not to then
 818                 return false, "Syntax: s2s:close('from', 'to') - Closes all s2s sessions from 'from' to 'to'";
 819         elseif from == to then
 820                 return false, "Both from and to are the same... you can't do that :)";
 821         end
 822
 823         for _, session in pairs(s2s_sessions) do
 824                 local id = session.type..tostring(session):match("[a-f0-9]+$");
 825                 if (match_id and match_id == id)
 826                 or (session.from_host == from and session.to_host == to) then
 827                         print(("Closing connection from %s to %s [%s]"):format(session.from_host, session.to_host, id));
 828                         (session.close or s2smanager.destroy_session)(session);
 829                         count = count + 1 ;
 830                 end
 831                         end
 832         return true, "Closed "..count.." s2s session"..((count == 1 and "") or "s");
 833 end
 834
 835 function def_env.s2s:closeall(host)
 836         local count = 0;
 837         local s2s_sessions = module:shared"/*/s2s/sessions";
 838         for _,session in pairs(s2s_sessions) do
 839                 if not host or session.from_host == host or session.to_host == host then
 840                         session:close();
 841                                 count = count + 1;
 842                         end
 843                 end
 844         if count == 0 then return false, "No sessions to close.";
 845         else return true, "Closed "..count.." s2s session"..((count == 1 and "") or "s"); end
 846 end
 847
 848 def_env.host = {}; def_env.hosts = def_env.host;
 849
 850 function def_env.host:activate(hostname, config)
 851         return hostmanager.activate(hostname, config);
 852 end
 853 function def_env.host:deactivate(hostname, reason)
 854         return hostmanager.deactivate(hostname, reason);
 855 end
 856
 857 function def_env.host:list()
 858         local print = self.session.print;
 859         local i = 0;
 860         for host in values(array.collect(keys(prosody.hosts)):sort()) do
 861                 i = i + 1;
 862                 print(host);
 863         end
 864         return true, i.." hosts";
 865 end
 866
 867 def_env.port = {};
 868
 869 function def_env.port:list()
 870         local print = self.session.print;
 871         local services = portmanager.get_active_services().data;
 872         local ordered_services, n_ports = {}, 0;
 873         for service, interfaces in pairs(services) do
 874                 table.insert(ordered_services, service);
 875         end
 876         table.sort(ordered_services);
 877         for _, service in ipairs(ordered_services) do
 878                 local ports_list = {};
 879                 for interface, ports in pairs(services[service]) do
 880                         for port in pairs(ports) do
 881                                 table.insert(ports_list, "["..interface.."]:"..port);
 882                         end
 883                 end
 884                 n_ports = n_ports + #ports_list;
 885                 print(service..": "..table.concat(ports_list, ", "));
 886         end
 887         return true, #ordered_services.." services listening on "..n_ports.." ports";
 888 end
 889
 890 function def_env.port:close(close_port, close_interface)
 891         close_port = assert(tonumber(close_port), "Invalid port number");
 892         local n_closed = 0;
 893         local services = portmanager.get_active_services().data;
 894         for service, interfaces in pairs(services) do
 895                 for interface, ports in pairs(interfaces) do
 896                         if not close_interface or close_interface == interface then
 897                                 if ports[close_port] then
 898                                         self.session.print("Closing ["..interface.."]:"..close_port.."...");
 899                                         local ok, err = portmanager.close(interface, close_port)
 900                                         if not ok then
 901                                                 self.session.print("Failed to close "..interface.." "..close_port..": "..err);
 902                                         else
 903                                                 n_closed = n_closed + 1;
 904                                         end
 905                                 end
 906                         end
 907                 end
 908         end
 909         return true, "Closed "..n_closed.." ports";
 910 end
 911
 912 def_env.muc = {};
 913
 914 local console_room_mt = {
 915         __index = function (self, k) return self.room[k]; end;
 916         __tostring = function (self)
 917                 return "MUC room <"..self.room.jid..">";
 918         end;
 919 };
 920
 921 local function check_muc(jid)
 922         local room_name, host = jid_split(jid);
 923         if not hosts[host] then
 924                 return nil, "No such host: "..host;
 925         elseif not hosts[host].modules.muc then
 926                 return nil, "Host '"..host.."' is not a MUC service";
 927         end
 928         return room_name, host;
 929 end
 930
 931 function def_env.muc:create(room_jid)
 932         local room, host = check_muc(room_jid);
 933         if not room_name then
 934                 return room_name, host;
 935         end
 936         if not room then return nil, host end
 937         if hosts[host].modules.muc.rooms[room_jid] then return nil, "Room exists already" end
 938         return hosts[host].modules.muc.create_room(room_jid);
 939 end
 940
 941 function def_env.muc:room(room_jid)
 942         local room_name, host = check_muc(room_jid);
 943         if not room_name then
 944                 return room_name, host;
 945         end
 946         local room_obj = hosts[host].modules.muc.rooms[room_jid];
 947         if not room_obj then
 948                 return nil, "No such room: "..room_jid;
 949         end
 950         return setmetatable({ room = room_obj }, console_room_mt);
 951 end
 952
 953 local um = require"core.usermanager";
 954
 955 def_env.user = {};
 956 function def_env.user:create(jid, password)
 957         local username, host = jid_split(jid);
 958         if not hosts[host] then
 959                 return nil, "No such host: "..host;
 960         elseif um.user_exists(username, host) then
 961                 return nil, "User exists";
 962         end
 963         local ok, err = um.create_user(username, password, host);
 964         if ok then
 965                 return true, "User created";
 966         else
 967                 return nil, "Could not create user: "..err;
 968         end
 969 end
 970
 971 function def_env.user:delete(jid)
 972         local username, host = jid_split(jid);
 973         if not hosts[host] then
 974                 return nil, "No such host: "..host;
 975         elseif not um.user_exists(username, host) then
 976                 return nil, "No such user";
 977         end
 978         local ok, err = um.delete_user(username, host);
 979         if ok then
 980                 return true, "User deleted";
 981         else
 982                 return nil, "Could not delete user: "..err;
 983         end
 984 end
 985
 986 function def_env.user:password(jid, password)
 987         local username, host = jid_split(jid);
 988         if not hosts[host] then
 989                 return nil, "No such host: "..host;
 990         elseif not um.user_exists(username, host) then
 991                 return nil, "No such user";
 992         end
 993         local ok, err = um.set_password(username, password, host);
 994         if ok then
 995                 return true, "User password changed";
 996         else
 997                 return nil, "Could not change password for user: "..err;
 998         end
 999 end
1000
1001 function def_env.user:list(host, pat)
1002         if not host then
1003                 return nil, "No host given";
1004         elseif not hosts[host] then
1005                 return nil, "No such host";
1006         end
1007         local print = self.session.print;
1008         local total, matches = 0, 0;
1009         for user in um.users(host) do
1010                 if not pat or user:match(pat) then
1011                         print(user.."@"..host);
1012                         matches = matches + 1;
1013                 end
1014                 total = total + 1;
1015         end
1016         return true, "Showing "..(pat and (matches.." of ") or "all " )..total.." users";
1017 end
1018
1019 def_env.xmpp = {};
1020
1021 local st = require "util.stanza";
1022 function def_env.xmpp:ping(localhost, remotehost)
1023         if hosts[localhost] then
1024                 core_post_stanza(hosts[localhost],
1025                         st.iq{ from=localhost, to=remotehost, type="get", id="ping" }
1026                                 :tag("ping", {xmlns="urn:xmpp:ping"}));
1027                 return true, "Sent ping";
1028         else
1029                 return nil, "No such host";
1030         end
1031 end
1032
1033 def_env.dns = {};
1034 local adns = require"net.adns";
1035 local dns = require"net.dns";
1036
1037 function def_env.dns:lookup(name, typ, class)
1038         local ret = "Query sent";
1039         local print = self.session.print;
1040         local function handler(...)
1041                 ret = "Got response";
1042                 print(...);
1043         end
1044         adns.lookup(handler, name, typ, class);
1045         return true, ret;
1046 end
1047
1048 function def_env.dns:addnameserver(...)
1049         dns.addnameserver(...)
1050         return true
1051 end
1052
1053 function def_env.dns:setnameserver(...)
1054         dns.setnameserver(...)
1055         return true
1056 end
1057
1058 function def_env.dns:purge()
1059         dns.purge()
1060         return true
1061 end
1062
1063 function def_env.dns:cache()
1064         return true, "Cache:\n"..tostring(dns.cache())
1065 end
1066
1067 -------------
1068
1069 function printbanner(session)
1070         local option = module:get_option("console_banner");
1071         if option == nil or option == "full" or option == "graphic" then
1072                 session.print [[
1073                    ____                \   /     _
1074                     |  _ \ _ __ ___  ___  _-_   __| |_   _
1075                     | |_) | '__/ _ \/ __|/ _ \ / _` | | | |
1076                     |  __/| | | (_) \__ \ |_| | (_| | |_| |
1077                     |_|   |_|  \___/|___/\___/ \__,_|\__, |
1078                     A study in simplicity            |___/
1079
1080 ]]
1081         end
1082         if option == nil or option == "short" or option == "full" then
1083         session.print("Welcome to the Prosody administration console. For a list of commands, type: help");
1084         session.print("You may find more help on using this console in our online documentation at ");
1085         session.print("http://prosody.im/doc/console\n");
1086         end
1087         if option and option ~= "short" and option ~= "full" and option ~= "graphic" then
1088                 if type(option) == "string" then
1089                         session.print(option)
1090                 elseif type(option) == "function" then
1091                         module:log("warn", "Using functions as value for the console_banner option is no longer supported");
1092                 end
1093         end
1094 end
1095
1096 module:provides("net", {
1097         name = "console";
1098         listener = console_listener;
1099         default_port = 5582;
1100         private = true;
1101 });