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, jid_join = import("util.jid", "bare", "prepped_split", "join");
  26 local set, array = require "util.set", require "util.array";
  27 local cert_verify_identity = require "util.x509".verify_identity;
  28 local envload = require "util.envload".envload;
  29 local envloadfile = require "util.envload".envloadfile;
  30 local has_pposix, pposix = pcall(require, "util.pposix");
  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 --luacheck: ignore 212/self
 286
 287 def_env.server = {};
 288
 289 function def_env.server:insane_reload()
 290         prosody.unlock_globals();
 291         dofile "prosody"
 292         prosody = _G.prosody;
 293         return true, "Server reloaded";
 294 end
 295
 296 function def_env.server:version()
 297         return true, tostring(prosody.version or "unknown");
 298 end
 299
 300 function def_env.server:uptime()
 301         local t = os.time()-prosody.start_time;
 302         local seconds = t%60;
 303         t = (t - seconds)/60;
 304         local minutes = t%60;
 305         t = (t - minutes)/60;
 306         local hours = t%24;
 307         t = (t - hours)/24;
 308         local days = t;
 309         return true, string.format("This server has been running for %d day%s, %d hour%s and %d minute%s (since %s)",
 310                 days, (days ~= 1 and "s") or "", hours, (hours ~= 1 and "s") or "",
 311                 minutes, (minutes ~= 1 and "s") or "", os.date("%c", prosody.start_time));
 312 end
 313
 314 function def_env.server:shutdown(reason)
 315         prosody.shutdown(reason);
 316         return true, "Shutdown initiated";
 317 end
 318
 319 local function human(kb)
 320         local unit = "K";
 321         if kb > 1024 then
 322                 kb, unit = kb/1024, "M";
 323         end
 324         return ("%0.2f%sB"):format(kb, unit);
 325 end
 326
 327 function def_env.server:memory()
 328         if not has_pposix or not pposix.meminfo then
 329                 return true, "Lua is using "..collectgarbage("count");
 330         end
 331         local mem, lua_mem = pposix.meminfo(), collectgarbage("count");
 332         local print = self.session.print;
 333         print("Process: "..human((mem.allocated+mem.allocated_mmap)/1024));
 334         print("   Used: "..human(mem.used/1024).." ("..human(lua_mem).." by Lua)");
 335         print("   Free: "..human(mem.unused/1024).." ("..human(mem.returnable/1024).." returnable)");
 336         return true, "OK";
 337 end
 338
 339 def_env.timer = {};
 340
 341 function def_env.timer:info()
 342         local socket = require "socket";
 343         local print = self.session.print;
 344         local add_task = require"util.timer".add_task;
 345         local h, params = add_task.h, add_task.params;
 346         if h then
 347                 print("-- util.timer");
 348                 for i, id in ipairs(h.ids) do
 349                         if not params[id] then
 350                                 print(os.date("%F %T", h.priorities[i]), h.items[id]);
 351                         elseif not params[id].callback then
 352                                 print(os.date("%F %T", h.priorities[i]), h.items[id], unpack(params[id]));
 353                         else
 354                                 print(os.date("%F %T", h.priorities[i]), params[id].callback, unpack(params[id]));
 355                         end
 356                 end
 357         end
 358         if server.event_base then
 359                 local count = 0;
 360                 for k, v in pairs(debug.getregistry()) do
 361                         if type(v) == "function" and v.callback and v.callback == add_task._on_timer then
 362                                 count = count + 1;
 363                         end
 364                 end
 365                 print(count .. " libevent callbacks");
 366         end
 367         if h then
 368                 local next_time = h:peek();
 369                 if next_time then
 370                         return true, os.date("Next event at %F %T (in %%.6fs)", next_time):format(next_time - socket.gettime());
 371                 end
 372         end
 373         return true;
 374 end
 375
 376 def_env.module = {};
 377
 378 local function get_hosts_set(hosts, module)
 379         if type(hosts) == "table" then
 380                 if hosts[1] then
 381                         return set.new(hosts);
 382                 elseif hosts._items then
 383                         return hosts;
 384                 end
 385         elseif type(hosts) == "string" then
 386                 return set.new { hosts };
 387         elseif hosts == nil then
 388                 local hosts_set = set.new(array.collect(keys(prosody.hosts)))
 389                         / function (host) return (prosody.hosts[host].type == "local" or module and modulemanager.is_loaded(host, module)) and host or nil; end;
 390                 if module and modulemanager.get_module("*", module) then
 391                         hosts_set:add("*");
 392                 end
 393                 return hosts_set;
 394         end
 395 end
 396
 397 function def_env.module:load(name, hosts, config)
 398         hosts = get_hosts_set(hosts);
 399
 400         -- Load the module for each host
 401         local ok, err, count, mod = true, nil, 0, nil;
 402         for host in hosts do
 403                 if (not modulemanager.is_loaded(host, name)) then
 404                         mod, err = modulemanager.load(host, name, config);
 405                         if not mod then
 406                                 ok = false;
 407                                 if err == "global-module-already-loaded" then
 408                                         if count > 0 then
 409                                                 ok, err, count = true, nil, 1;
 410                                         end
 411                                         break;
 412                                 end
 413                                 self.session.print(err or "Unknown error loading module");
 414                         else
 415                                 count = count + 1;
 416                                 self.session.print("Loaded for "..mod.module.host);
 417                         end
 418                 end
 419         end
 420
 421         return ok, (ok and "Module loaded onto "..count.." host"..(count ~= 1 and "s" or "")) or ("Last error: "..tostring(err));
 422 end
 423
 424 function def_env.module:unload(name, hosts)
 425         hosts = get_hosts_set(hosts, name);
 426
 427         -- Unload the module for each host
 428         local ok, err, count = true, nil, 0;
 429         for host in hosts do
 430                 if modulemanager.is_loaded(host, name) then
 431                         ok, err = modulemanager.unload(host, name);
 432                         if not ok then
 433                                 ok = false;
 434                                 self.session.print(err or "Unknown error unloading module");
 435                         else
 436                                 count = count + 1;
 437                                 self.session.print("Unloaded from "..host);
 438                         end
 439                 end
 440         end
 441         return ok, (ok and "Module unloaded from "..count.." host"..(count ~= 1 and "s" or "")) or ("Last error: "..tostring(err));
 442 end
 443
 444 function def_env.module:reload(name, hosts)
 445         hosts = array.collect(get_hosts_set(hosts, name)):sort(function (a, b)
 446                 if a == "*" then return true
 447                 elseif b == "*" then return false
 448                 else return a < b; end
 449         end);
 450
 451         -- Reload the module for each host
 452         local ok, err, count = true, nil, 0;
 453         for _, host in ipairs(hosts) do
 454                 if modulemanager.is_loaded(host, name) then
 455                         ok, err = modulemanager.reload(host, name);
 456                         if not ok then
 457                                 ok = false;
 458                                 self.session.print(err or "Unknown error reloading module");
 459                         else
 460                                 count = count + 1;
 461                                 if ok == nil then
 462                                         ok = true;
 463                                 end
 464                                 self.session.print("Reloaded on "..host);
 465                         end
 466                 end
 467         end
 468         return ok, (ok and "Module reloaded on "..count.." host"..(count ~= 1 and "s" or "")) or ("Last error: "..tostring(err));
 469 end
 470
 471 function def_env.module:list(hosts)
 472         if hosts == nil then
 473                 hosts = array.collect(keys(prosody.hosts));
 474                 table.insert(hosts, 1, "*");
 475         end
 476         if type(hosts) == "string" then
 477                 hosts = { hosts };
 478         end
 479         if type(hosts) ~= "table" then
 480                 return false, "Please supply a host or a list of hosts you would like to see";
 481         end
 482
 483         local print = self.session.print;
 484         for _, host in ipairs(hosts) do
 485                 print((host == "*" and "Global" or host)..":");
 486                 local modules = array.collect(keys(modulemanager.get_modules(host) or {})):sort();
 487                 if #modules == 0 then
 488                         if prosody.hosts[host] then
 489                                 print("    No modules loaded");
 490                         else
 491                                 print("    Host not found");
 492                         end
 493                 else
 494                         for _, name in ipairs(modules) do
 495                                 print("    "..name);
 496                         end
 497                 end
 498         end
 499 end
 500
 501 def_env.config = {};
 502 function def_env.config:load(filename, format)
 503         local config_load = require "core.configmanager".load;
 504         local ok, err = config_load(filename, format);
 505         if not ok then
 506                 return false, err or "Unknown error loading config";
 507         end
 508         return true, "Config loaded";
 509 end
 510
 511 function def_env.config:get(host, section, key)
 512         local config_get = require "core.configmanager".get
 513         return true, tostring(config_get(host, section, key));
 514 end
 515
 516 function def_env.config:reload()
 517         local ok, err = prosody.reload_config();
 518         return ok, (ok and "Config reloaded (you may need to reload modules to take effect)") or tostring(err);
 519 end
 520
 521 local function common_info(session, line)
 522         if session.id then
 523                 line[#line+1] = "["..session.id.."]"
 524         else
 525                 line[#line+1] = "["..session.type..(tostring(session):match("%x*$")).."]"
 526         end
 527 end
 528
 529 local function session_flags(session, line)
 530         line = line or {};
 531         common_info(session, line);
 532         if session.type == "c2s" then
 533                 local status, priority = "unavailable", tostring(session.priority or "-");
 534                 if session.presence then
 535                         status = session.presence:get_child_text("show") or "available";
 536                 end
 537                 line[#line+1] = status.."("..priority..")";
 538         end
 539         if session.cert_identity_status == "valid" then
 540                 line[#line+1] = "(authenticated)";
 541         end
 542         if session.secure then
 543                 line[#line+1] = "(encrypted)";
 544         end
 545         if session.compressed then
 546                 line[#line+1] = "(compressed)";
 547         end
 548         if session.smacks then
 549                 line[#line+1] = "(sm)";
 550         end
 551         if session.ip and session.ip:match(":") then
 552                 line[#line+1] = "(IPv6)";
 553         end
 554         if session.remote then
 555                 line[#line+1] = "(remote)";
 556         end
 557         return table.concat(line, " ");
 558 end
 559
 560 local function tls_info(session, line)
 561         line = line or {};
 562         common_info(session, line);
 563         if session.secure then
 564                 local sock = session.conn and session.conn.socket and session.conn:socket();
 565                 if sock and sock.info then
 566                         local info = sock:info();
 567                         line[#line+1] = ("(%s with %s)"):format(info.protocol, info.cipher);
 568                 else
 569                         line[#line+1] = "(cipher info unavailable)";
 570                 end
 571         else
 572                 line[#line+1] = "(insecure)";
 573         end
 574         return table.concat(line, " ");
 575 end
 576
 577 def_env.c2s = {};
 578
 579 local function get_jid(session)
 580         if session.username then
 581                 return session.full_jid or jid_join(session.username, session.host, session.resource);
 582         end
 583
 584         local conn = session.conn;
 585         local ip = session.ip or "?";
 586         local clientport = conn and conn:clientport() or "?";
 587         local serverip = conn and conn.server and conn:server():ip() or "?";
 588         local serverport = conn and conn:serverport() or "?"
 589         return jid_join("["..ip.."]:"..clientport, session.host or "["..serverip.."]:"..serverport);
 590 end
 591
 592 local function show_c2s(callback)
 593         local c2s = array.collect(values(module:shared"/*/c2s/sessions"));
 594         c2s:sort(function(a, b)
 595                 if a.host == b.host then
 596                         if a.username == b.username then
 597                                 return (a.resource or "") > (b.resource or "");
 598                         end
 599                         return (a.username or "") > (b.username or "");
 600                 end
 601                 return (a.host or "") > (b.host or "");
 602         end):map(function (session)
 603                 callback(get_jid(session), session)
 604         end);
 605 end
 606
 607 function def_env.c2s:count(match_jid)
 608         return true, "Total: "..  iterators.count(values(module:shared"/*/c2s/sessions")) .." clients";
 609 end
 610
 611 function def_env.c2s:show(match_jid, annotate)
 612         local print, count = self.session.print, 0;
 613         annotate = annotate or session_flags;
 614         local curr_host = false;
 615         show_c2s(function (jid, session)
 616                 if curr_host ~= session.host then
 617                         curr_host = session.host;
 618                         print(curr_host or "(not connected to any host yet)");
 619                 end
 620                 if (not match_jid) or jid:match(match_jid) then
 621                         count = count + 1;
 622                         print(annotate(session, { "  ", jid }));
 623                 end
 624         end);
 625         return true, "Total: "..count.." clients";
 626 end
 627
 628 function def_env.c2s:show_insecure(match_jid)
 629         local print, count = self.session.print, 0;
 630         show_c2s(function (jid, session)
 631                 if ((not match_jid) or jid:match(match_jid)) and not session.secure then
 632                         count = count + 1;
 633                         print(jid);
 634                 end
 635         end);
 636         return true, "Total: "..count.." insecure client connections";
 637 end
 638
 639 function def_env.c2s:show_secure(match_jid)
 640         local print, count = self.session.print, 0;
 641         show_c2s(function (jid, session)
 642                 if ((not match_jid) or jid:match(match_jid)) and session.secure then
 643                         count = count + 1;
 644                         print(jid);
 645                 end
 646         end);
 647         return true, "Total: "..count.." secure client connections";
 648 end
 649
 650 function def_env.c2s:show_tls(match_jid)
 651         return self:show(match_jid, tls_info);
 652 end
 653
 654 function def_env.c2s:close(match_jid)
 655         local count = 0;
 656         show_c2s(function (jid, session)
 657                 if jid == match_jid or jid_bare(jid) == match_jid then
 658                         count = count + 1;
 659                         session:close();
 660                 end
 661         end);
 662         return true, "Total: "..count.." sessions closed";
 663 end
 664
 665
 666 def_env.s2s = {};
 667 function def_env.s2s:show(match_jid, annotate)
 668         local print = self.session.print;
 669         annotate = annotate or session_flags;
 670
 671         local count_in, count_out = 0,0;
 672         local s2s_list = { };
 673
 674         local s2s_sessions = module:shared"/*/s2s/sessions";
 675         for _, session in pairs(s2s_sessions) do
 676                 local remotehost, localhost, direction;
 677                 if session.direction == "outgoing" then
 678                         direction = "->";
 679                         count_out = count_out + 1;
 680                         remotehost, localhost = session.to_host or "?", session.from_host or "?";
 681                 else
 682                         direction = "<-";
 683                         count_in = count_in + 1;
 684                         remotehost, localhost = session.from_host or "?", session.to_host or "?";
 685                 end
 686                 local sess_lines = { l = localhost, r = remotehost,
 687                         annotate(session, { "", direction, remotehost or "?" })};
 688
 689                 if (not match_jid) or remotehost:match(match_jid) or localhost:match(match_jid) then
 690                         table.insert(s2s_list, sess_lines);
 691                         local print = function (s) table.insert(sess_lines, "        "..s); end
 692                         if session.sendq then
 693                                 print("There are "..#session.sendq.." queued outgoing stanzas for this connection");
 694                         end
 695                         if session.type == "s2sout_unauthed" then
 696                                 if session.connecting then
 697                                         print("Connection not yet established");
 698                                         if not session.srv_hosts then
 699                                                 if not session.conn then
 700                                                         print("We do not yet have a DNS answer for this host's SRV records");
 701                                                 else
 702                                                         print("This host has no SRV records, using A record instead");
 703                                                 end
 704                                         elseif session.srv_choice then
 705                                                 print("We are on SRV record "..session.srv_choice.." of "..#session.srv_hosts);
 706                                                 local srv_choice = session.srv_hosts[session.srv_choice];
 707                                                 print("Using "..(srv_choice.target or ".")..":"..(srv_choice.port or 5269));
 708                                         end
 709                                 elseif session.notopen then
 710                                         print("The <stream> has not yet been opened");
 711                                 elseif not session.dialback_key then
 712                                         print("Dialback has not been initiated yet");
 713                                 elseif session.dialback_key then
 714                                         print("Dialback has been requested, but no result received");
 715                                 end
 716                         end
 717                         if session.type == "s2sin_unauthed" then
 718                                 print("Connection not yet authenticated");
 719                         elseif session.type == "s2sin" then
 720                                 for name in pairs(session.hosts) do
 721                                         if name ~= session.from_host then
 722                                                 print("also hosts "..tostring(name));
 723                                         end
 724                                 end
 725                         end
 726                 end
 727         end
 728
 729         -- Sort by local host, then remote host
 730         table.sort(s2s_list, function(a,b)
 731                 if a.l == b.l then return a.r < b.r; end
 732                 return a.l < b.l;
 733         end);
 734         local lasthost;
 735         for _, sess_lines in ipairs(s2s_list) do
 736                 if sess_lines.l ~= lasthost then print(sess_lines.l); lasthost=sess_lines.l end
 737                 for _, line in ipairs(sess_lines) do print(line); end
 738         end
 739         return true, "Total: "..count_out.." outgoing, "..count_in.." incoming connections";
 740 end
 741
 742 function def_env.s2s:show_tls(match_jid)
 743         return self:show(match_jid, tls_info);
 744 end
 745
 746 local function print_subject(print, subject)
 747         for _, entry in ipairs(subject) do
 748                 print(
 749                         ("    %s: %q"):format(
 750                                 entry.name or entry.oid,
 751                                 entry.value:gsub("[\r\n%z%c]", " ")
 752                         )
 753                 );
 754         end
 755 end
 756
 757 -- As much as it pains me to use the 0-based depths that OpenSSL does,
 758 -- I think there's going to be more confusion among operators if we
 759 -- break from that.
 760 local function print_errors(print, errors)
 761         for depth, t in pairs(errors) do
 762                 print(
 763                         ("    %d: %s"):format(
 764                                 depth-1,
 765                                 table.concat(t, "\n|        ")
 766                         )
 767                 );
 768         end
 769 end
 770
 771 function def_env.s2s:showcert(domain)
 772         local print = self.session.print;
 773         local s2s_sessions = module:shared"/*/s2s/sessions";
 774         local domain_sessions = set.new(array.collect(values(s2s_sessions)))
 775                 /function(session) return (session.to_host == domain or session.from_host == domain) and session or nil; end;
 776         local cert_set = {};
 777         for session in domain_sessions do
 778                 local conn = session.conn;
 779                 conn = conn and conn:socket();
 780                 if not conn.getpeerchain then
 781                         if conn.dohandshake then
 782                                 error("This version of LuaSec does not support certificate viewing");
 783                         end
 784                 else
 785                         local cert = conn:getpeercertificate();
 786                         if cert then
 787                                 local certs = conn:getpeerchain();
 788                                 local digest = cert:digest("sha1");
 789                                 if not cert_set[digest] then
 790                                         local chain_valid, chain_errors = conn:getpeerverification();
 791                                         cert_set[digest] = {
 792                                                 {
 793                                                   from = session.from_host,
 794                                                   to = session.to_host,
 795                                                   direction = session.direction
 796                                                 };
 797                                                 chain_valid = chain_valid;
 798                                                 chain_errors = chain_errors;
 799                                                 certs = certs;
 800                                         };
 801                                 else
 802                                         table.insert(cert_set[digest], {
 803                                                 from = session.from_host,
 804                                                 to = session.to_host,
 805                                                 direction = session.direction
 806                                         });
 807                                 end
 808                         end
 809                 end
 810         end
 811         local domain_certs = array.collect(values(cert_set));
 812         -- Phew. We now have a array of unique certificates presented by domain.
 813         local n_certs = #domain_certs;
 814
 815         if n_certs == 0 then
 816                 return "No certificates found for "..domain;
 817         end
 818
 819         local function _capitalize_and_colon(byte)
 820                 return string.upper(byte)..":";
 821         end
 822         local function pretty_fingerprint(hash)
 823                 return hash:gsub("..", _capitalize_and_colon):sub(1, -2);
 824         end
 825
 826         for cert_info in values(domain_certs) do
 827                 local certs = cert_info.certs;
 828                 local cert = certs[1];
 829                 print("---")
 830                 print("Fingerprint (SHA1): "..pretty_fingerprint(cert:digest("sha1")));
 831                 print("");
 832                 local n_streams = #cert_info;
 833                 print("Currently used on "..n_streams.." stream"..(n_streams==1 and "" or "s")..":");
 834                 for _, stream in ipairs(cert_info) do
 835                         if stream.direction == "incoming" then
 836                                 print("    "..stream.to.." <- "..stream.from);
 837                         else
 838                                 print("    "..stream.from.." -> "..stream.to);
 839                         end
 840                 end
 841                 print("");
 842                 local chain_valid, errors = cert_info.chain_valid, cert_info.chain_errors;
 843                 local valid_identity = cert_verify_identity(domain, "xmpp-server", cert);
 844                 if chain_valid then
 845                         print("Trusted certificate: Yes");
 846                 else
 847                         print("Trusted certificate: No");
 848                         print_errors(print, errors);
 849                 end
 850                 print("");
 851                 print("Issuer: ");
 852                 print_subject(print, cert:issuer());
 853                 print("");
 854                 print("Valid for "..domain..": "..(valid_identity and "Yes" or "No"));
 855                 print("Subject:");
 856                 print_subject(print, cert:subject());
 857         end
 858         print("---");
 859         return ("Showing "..n_certs.." certificate"
 860                 ..(n_certs==1 and "" or "s")
 861                 .." presented by "..domain..".");
 862 end
 863
 864 function def_env.s2s:close(from, to)
 865         local print, count = self.session.print, 0;
 866         local s2s_sessions = module:shared"/*/s2s/sessions";
 867
 868         local match_id;
 869         if from and not to then
 870                 match_id, from = from;
 871         elseif not to then
 872                 return false, "Syntax: s2s:close('from', 'to') - Closes all s2s sessions from 'from' to 'to'";
 873         elseif from == to then
 874                 return false, "Both from and to are the same... you can't do that :)";
 875         end
 876
 877         for _, session in pairs(s2s_sessions) do
 878                 local id = session.type..tostring(session):match("[a-f0-9]+$");
 879                 if (match_id and match_id == id)
 880                 or (session.from_host == from and session.to_host == to) then
 881                         print(("Closing connection from %s to %s [%s]"):format(session.from_host, session.to_host, id));
 882                         (session.close or s2smanager.destroy_session)(session);
 883                         count = count + 1 ;
 884                 end
 885         end
 886         return true, "Closed "..count.." s2s session"..((count == 1 and "") or "s");
 887 end
 888
 889 function def_env.s2s:closeall(host)
 890         local count = 0;
 891         local s2s_sessions = module:shared"/*/s2s/sessions";
 892         for _,session in pairs(s2s_sessions) do
 893                 if not host or session.from_host == host or session.to_host == host then
 894                         session:close();
 895                         count = count + 1;
 896                 end
 897         end
 898         if count == 0 then return false, "No sessions to close.";
 899         else return true, "Closed "..count.." s2s session"..((count == 1 and "") or "s"); end
 900 end
 901
 902 def_env.host = {}; def_env.hosts = def_env.host;
 903
 904 function def_env.host:activate(hostname, config)
 905         return hostmanager.activate(hostname, config);
 906 end
 907 function def_env.host:deactivate(hostname, reason)
 908         return hostmanager.deactivate(hostname, reason);
 909 end
 910
 911 function def_env.host:list()
 912         local print = self.session.print;
 913         local i = 0;
 914         local type;
 915         for host in values(array.collect(keys(prosody.hosts)):sort()) do
 916                 i = i + 1;
 917                 type = hosts[host].type;
 918                 if type == "local" then
 919                         print(host);
 920                 else
 921                         type = module:context(host):get_option_string("component_module", type);
 922                         if type ~= "component" then
 923                                 type = type .. " component";
 924                         end
 925                         print(("%s (%s)"):format(host, type));
 926                 end
 927         end
 928         return true, i.." hosts";
 929 end
 930
 931 def_env.port = {};
 932
 933 function def_env.port:list()
 934         local print = self.session.print;
 935         local services = portmanager.get_active_services().data;
 936         local ordered_services, n_ports = {}, 0;
 937         for service, interfaces in pairs(services) do
 938                 table.insert(ordered_services, service);
 939         end
 940         table.sort(ordered_services);
 941         for _, service in ipairs(ordered_services) do
 942                 local ports_list = {};
 943                 for interface, ports in pairs(services[service]) do
 944                         for port in pairs(ports) do
 945                                 table.insert(ports_list, "["..interface.."]:"..port);
 946                         end
 947                 end
 948                 n_ports = n_ports + #ports_list;
 949                 print(service..": "..table.concat(ports_list, ", "));
 950         end
 951         return true, #ordered_services.." services listening on "..n_ports.." ports";
 952 end
 953
 954 function def_env.port:close(close_port, close_interface)
 955         close_port = assert(tonumber(close_port), "Invalid port number");
 956         local n_closed = 0;
 957         local services = portmanager.get_active_services().data;
 958         for service, interfaces in pairs(services) do
 959                 for interface, ports in pairs(interfaces) do
 960                         if not close_interface or close_interface == interface then
 961                                 if ports[close_port] then
 962                                         self.session.print("Closing ["..interface.."]:"..close_port.."...");
 963                                         local ok, err = portmanager.close(interface, close_port)
 964                                         if not ok then
 965                                                 self.session.print("Failed to close "..interface.." "..close_port..": "..err);
 966                                         else
 967                                                 n_closed = n_closed + 1;
 968                                         end
 969                                 end
 970                         end
 971                 end
 972         end
 973         return true, "Closed "..n_closed.." ports";
 974 end
 975
 976 def_env.muc = {};
 977
 978 local console_room_mt = {
 979         __index = function (self, k) return self.room[k]; end;
 980         __tostring = function (self)
 981                 return "MUC room <"..self.room.jid..">";
 982         end;
 983 };
 984
 985 local function check_muc(jid)
 986         local room_name, host = jid_split(jid);
 987         if not hosts[host] then
 988                 return nil, "No such host: "..host;
 989         elseif not hosts[host].modules.muc then
 990                 return nil, "Host '"..host.."' is not a MUC service";
 991         end
 992         return room_name, host;
 993 end
 994
 995 function def_env.muc:create(room_jid)
 996         local room_name, host = check_muc(room_jid);
 997         if not room_name then
 998                 return room_name, host;
 999         end
1000         if not room_name then return nil, host end
1001         if hosts[host].modules.muc.rooms[room_jid] then return nil, "Room exists already" end
1002         return hosts[host].modules.muc.create_room(room_jid);
1003 end
1004
1005 function def_env.muc:room(room_jid)
1006         local room_name, host = check_muc(room_jid);
1007         if not room_name then
1008                 return room_name, host;
1009         end
1010         local room_obj = hosts[host].modules.muc.get_room_from_jid(room_jid);
1011         if not room_obj then
1012                 return nil, "No such room: "..room_jid;
1013         end
1014         return setmetatable({ room = room_obj }, console_room_mt);
1015 end
1016
1017 function def_env.muc:list(host)
1018         local host_session = hosts[host];
1019         if not host_session or not host_session.modules.muc then
1020                 return nil, "Please supply the address of a local MUC component";
1021         end
1022         local print = self.session.print;
1023         local c = 0;
1024         for room in host_session.modules.muc.each_room() do
1025                 print(room.jid);
1026                 c = c + 1;
1027         end
1028         return true, c.." rooms";
1029 end
1030
1031 local um = require"core.usermanager";
1032
1033 def_env.user = {};
1034 function def_env.user:create(jid, password)
1035         local username, host = jid_split(jid);
1036         if not hosts[host] then
1037                 return nil, "No such host: "..host;
1038         elseif um.user_exists(username, host) then
1039                 return nil, "User exists";
1040         end
1041         local ok, err = um.create_user(username, password, host);
1042         if ok then
1043                 return true, "User created";
1044         else
1045                 return nil, "Could not create user: "..err;
1046         end
1047 end
1048
1049 function def_env.user:delete(jid)
1050         local username, host = jid_split(jid);
1051         if not hosts[host] then
1052                 return nil, "No such host: "..host;
1053         elseif not um.user_exists(username, host) then
1054                 return nil, "No such user";
1055         end
1056         local ok, err = um.delete_user(username, host);
1057         if ok then
1058                 return true, "User deleted";
1059         else
1060                 return nil, "Could not delete user: "..err;
1061         end
1062 end
1063
1064 function def_env.user:password(jid, password)
1065         local username, host = jid_split(jid);
1066         if not hosts[host] then
1067                 return nil, "No such host: "..host;
1068         elseif not um.user_exists(username, host) then
1069                 return nil, "No such user";
1070         end
1071         local ok, err = um.set_password(username, password, host);
1072         if ok then
1073                 return true, "User password changed";
1074         else
1075                 return nil, "Could not change password for user: "..err;
1076         end
1077 end
1078
1079 function def_env.user:list(host, pat)
1080         if not host then
1081                 return nil, "No host given";
1082         elseif not hosts[host] then
1083                 return nil, "No such host";
1084         end
1085         local print = self.session.print;
1086         local total, matches = 0, 0;
1087         for user in um.users(host) do
1088                 if not pat or user:match(pat) then
1089                         print(user.."@"..host);
1090                         matches = matches + 1;
1091                 end
1092                 total = total + 1;
1093         end
1094         return true, "Showing "..(pat and (matches.." of ") or "all " )..total.." users";
1095 end
1096
1097 def_env.xmpp = {};
1098
1099 local st = require "util.stanza";
1100 function def_env.xmpp:ping(localhost, remotehost)
1101         if hosts[localhost] then
1102                 core_post_stanza(hosts[localhost],
1103                         st.iq{ from=localhost, to=remotehost, type="get", id="ping" }
1104                                 :tag("ping", {xmlns="urn:xmpp:ping"}));
1105                 return true, "Sent ping";
1106         else
1107                 return nil, "No such host";
1108         end
1109 end
1110
1111 def_env.dns = {};
1112 local adns = require"net.adns";
1113 local dns = require"net.dns";
1114
1115 function def_env.dns:lookup(name, typ, class)
1116         local ret = "Query sent";
1117         local print = self.session.print;
1118         local function handler(...)
1119                 ret = "Got response";
1120                 print(...);
1121         end
1122         adns.lookup(handler, name, typ, class);
1123         return true, ret;
1124 end
1125
1126 function def_env.dns:addnameserver(...)
1127         dns._resolver:addnameserver(...)
1128         return true
1129 end
1130
1131 function def_env.dns:setnameserver(...)
1132         dns._resolver:setnameserver(...)
1133         return true
1134 end
1135
1136 function def_env.dns:purge()
1137         dns.purge()
1138         return true
1139 end
1140
1141 function def_env.dns:cache()
1142         return true, "Cache:\n"..tostring(dns.cache())
1143 end
1144
1145 def_env.http = {};
1146
1147 function def_env.http:list()
1148         local print = self.session.print;
1149
1150         for host in pairs(prosody.hosts) do
1151                 local http_apps = modulemanager.get_items("http-provider", host);
1152                 if #http_apps > 0 then
1153                         local http_host = module:context(host):get_option("http_host");
1154                         print("HTTP endpoints on "..host..(http_host and (" (using "..http_host.."):") or ":"));
1155                         for _, provider in ipairs(http_apps) do
1156                                 local url = module:context(host):http_url(provider.name);
1157                                 print("", url);
1158                         end
1159                         print("");
1160                 end
1161         end
1162
1163         local default_host = module:get_option("http_default_host");
1164         if not default_host then
1165                 print("HTTP requests to unknown hosts will return 404 Not Found");
1166         else
1167                 print("HTTP requests to unknown hosts will be handled by "..default_host);
1168         end
1169         return true;
1170 end
1171
1172 -------------
1173
1174 function printbanner(session)
1175         local option = module:get_option_string("console_banner", "full");
1176         if option == "full" or option == "graphic" then
1177                 session.print [[
1178                    ____                \   /     _
1179                     |  _ \ _ __ ___  ___  _-_   __| |_   _
1180                     | |_) | '__/ _ \/ __|/ _ \ / _` | | | |
1181                     |  __/| | | (_) \__ \ |_| | (_| | |_| |
1182                     |_|   |_|  \___/|___/\___/ \__,_|\__, |
1183                     A study in simplicity            |___/
1184
1185 ]]
1186         end
1187         if option == "short" or option == "full" then
1188         session.print("Welcome to the Prosody administration console. For a list of commands, type: help");
1189         session.print("You may find more help on using this console in our online documentation at ");
1190         session.print("https://prosody.im/doc/console\n");
1191         end
1192         if option ~= "short" and option ~= "full" and option ~= "graphic" then
1193                 session.print(option);
1194         end
1195 end
1196
1197 module:provides("net", {
1198         name = "console";
1199         listener = console_listener;
1200         default_port = 5582;
1201         private = true;
1202 });