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