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 --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 show_c2s(callback)
 580         for hostname, host in pairs(hosts) do
 581                 for username, user in pairs(host.sessions or {}) do
 582                         for resource, session in pairs(user.sessions or {}) do
 583                                 local jid = username.."@"..hostname.."/"..resource;
 584                                 callback(jid, session);
 585                         end
 586                 end
 587         end
 588 end
 589
 590 function def_env.c2s:count(match_jid)
 591         local count = 0;
 592         show_c2s(function (jid, session)
 593                 if (not match_jid) or jid:match(match_jid) then
 594                         count = count + 1;
 595                 end
 596         end);
 597         return true, "Total: "..count.." clients";
 598 end
 599
 600 function def_env.c2s:show(match_jid, annotate)
 601         local print, count = self.session.print, 0;
 602         annotate = annotate or session_flags;
 603         local curr_host;
 604         show_c2s(function (jid, session)
 605                 if curr_host ~= session.host then
 606                         curr_host = session.host;
 607                         print(curr_host);
 608                 end
 609                 if (not match_jid) or jid:match(match_jid) then
 610                         count = count + 1;
 611                         print(annotate(session, { "  ", jid }));
 612                 end
 613         end);
 614         return true, "Total: "..count.." clients";
 615 end
 616
 617 function def_env.c2s:show_insecure(match_jid)
 618         local print, count = self.session.print, 0;
 619         show_c2s(function (jid, session)
 620                 if ((not match_jid) or jid:match(match_jid)) and not session.secure then
 621                         count = count + 1;
 622                         print(jid);
 623                 end
 624         end);
 625         return true, "Total: "..count.." insecure client connections";
 626 end
 627
 628 function def_env.c2s:show_secure(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 session.secure then
 632                         count = count + 1;
 633                         print(jid);
 634                 end
 635         end);
 636         return true, "Total: "..count.." secure client connections";
 637 end
 638
 639 function def_env.c2s:show_tls(match_jid)
 640         return self:show(match_jid, tls_info);
 641 end
 642
 643 function def_env.c2s:close(match_jid)
 644         local count = 0;
 645         show_c2s(function (jid, session)
 646                 if jid == match_jid or jid_bare(jid) == match_jid then
 647                         count = count + 1;
 648                         session:close();
 649                 end
 650         end);
 651         return true, "Total: "..count.." sessions closed";
 652 end
 653
 654
 655 def_env.s2s = {};
 656 function def_env.s2s:show(match_jid, annotate)
 657         local print = self.session.print;
 658         annotate = annotate or session_flags;
 659
 660         local count_in, count_out = 0,0;
 661         local s2s_list = { };
 662
 663         local s2s_sessions = module:shared"/*/s2s/sessions";
 664         for _, session in pairs(s2s_sessions) do
 665                 local remotehost, localhost, direction;
 666                 if session.direction == "outgoing" then
 667                         direction = "->";
 668                         count_out = count_out + 1;
 669                         remotehost, localhost = session.to_host or "?", session.from_host or "?";
 670                 else
 671                         direction = "<-";
 672                         count_in = count_in + 1;
 673                         remotehost, localhost = session.from_host or "?", session.to_host or "?";
 674                 end
 675                 local sess_lines = { l = localhost, r = remotehost,
 676                         annotate(session, { "", direction, remotehost or "?" })};
 677
 678                 if (not match_jid) or remotehost:match(match_jid) or localhost:match(match_jid) then
 679                         table.insert(s2s_list, sess_lines);
 680                         local print = function (s) table.insert(sess_lines, "        "..s); end
 681                         if session.sendq then
 682                                 print("There are "..#session.sendq.." queued outgoing stanzas for this connection");
 683                         end
 684                         if session.type == "s2sout_unauthed" then
 685                                 if session.connecting then
 686                                         print("Connection not yet established");
 687                                         if not session.srv_hosts then
 688                                                 if not session.conn then
 689                                                         print("We do not yet have a DNS answer for this host's SRV records");
 690                                                 else
 691                                                         print("This host has no SRV records, using A record instead");
 692                                                 end
 693                                         elseif session.srv_choice then
 694                                                 print("We are on SRV record "..session.srv_choice.." of "..#session.srv_hosts);
 695                                                 local srv_choice = session.srv_hosts[session.srv_choice];
 696                                                 print("Using "..(srv_choice.target or ".")..":"..(srv_choice.port or 5269));
 697                                         end
 698                                 elseif session.notopen then
 699                                         print("The <stream> has not yet been opened");
 700                                 elseif not session.dialback_key then
 701                                         print("Dialback has not been initiated yet");
 702                                 elseif session.dialback_key then
 703                                         print("Dialback has been requested, but no result received");
 704                                 end
 705                         end
 706                         if session.type == "s2sin_unauthed" then
 707                                 print("Connection not yet authenticated");
 708                         elseif session.type == "s2sin" then
 709                                 for name in pairs(session.hosts) do
 710                                         if name ~= session.from_host then
 711                                                 print("also hosts "..tostring(name));
 712                                         end
 713                                 end
 714                         end
 715                 end
 716         end
 717
 718         -- Sort by local host, then remote host
 719         table.sort(s2s_list, function(a,b)
 720                 if a.l == b.l then return a.r < b.r; end
 721                 return a.l < b.l;
 722         end);
 723         local lasthost;
 724         for _, sess_lines in ipairs(s2s_list) do
 725                 if sess_lines.l ~= lasthost then print(sess_lines.l); lasthost=sess_lines.l end
 726                 for _, line in ipairs(sess_lines) do print(line); end
 727         end
 728         return true, "Total: "..count_out.." outgoing, "..count_in.." incoming connections";
 729 end
 730
 731 function def_env.s2s:show_tls(match_jid)
 732         return self:show(match_jid, tls_info);
 733 end
 734
 735 local function print_subject(print, subject)
 736         for _, entry in ipairs(subject) do
 737                 print(
 738                         ("    %s: %q"):format(
 739                                 entry.name or entry.oid,
 740                                 entry.value:gsub("[\r\n%z%c]", " ")
 741                         )
 742                 );
 743         end
 744 end
 745
 746 -- As much as it pains me to use the 0-based depths that OpenSSL does,
 747 -- I think there's going to be more confusion among operators if we
 748 -- break from that.
 749 local function print_errors(print, errors)
 750         for depth, t in pairs(errors) do
 751                 print(
 752                         ("    %d: %s"):format(
 753                                 depth-1,
 754                                 table.concat(t, "\n|        ")
 755                         )
 756                 );
 757         end
 758 end
 759
 760 function def_env.s2s:showcert(domain)
 761         local ser = require "util.serialization".serialize;
 762         local print = self.session.print;
 763         local s2s_sessions = module:shared"/*/s2s/sessions";
 764         local domain_sessions = set.new(array.collect(values(s2s_sessions)))
 765                 /function(session) return (session.to_host == domain or session.from_host == domain) and session or nil; end;
 766         local cert_set = {};
 767         for session in domain_sessions do
 768                 local conn = session.conn;
 769                 conn = conn and conn:socket();
 770                 if not conn.getpeerchain then
 771                         if conn.dohandshake then
 772                                 error("This version of LuaSec does not support certificate viewing");
 773                         end
 774                 else
 775                         local cert = conn:getpeercertificate();
 776                         if cert then
 777                                 local certs = conn:getpeerchain();
 778                                 local digest = cert:digest("sha1");
 779                                 if not cert_set[digest] then
 780                                         local chain_valid, chain_errors = conn:getpeerverification();
 781                                         cert_set[digest] = {
 782                                                 {
 783                                                   from = session.from_host,
 784                                                   to = session.to_host,
 785                                                   direction = session.direction
 786                                                 };
 787                                                 chain_valid = chain_valid;
 788                                                 chain_errors = chain_errors;
 789                                                 certs = certs;
 790                                         };
 791                                 else
 792                                         table.insert(cert_set[digest], {
 793                                                 from = session.from_host,
 794                                                 to = session.to_host,
 795                                                 direction = session.direction
 796                                         });
 797                                 end
 798                         end
 799                 end
 800         end
 801         local domain_certs = array.collect(values(cert_set));
 802         -- Phew. We now have a array of unique certificates presented by domain.
 803         local n_certs = #domain_certs;
 804
 805         if n_certs == 0 then
 806                 return "No certificates found for "..domain;
 807         end
 808
 809         local function _capitalize_and_colon(byte)
 810                 return string.upper(byte)..":";
 811         end
 812         local function pretty_fingerprint(hash)
 813                 return hash:gsub("..", _capitalize_and_colon):sub(1, -2);
 814         end
 815
 816         for cert_info in values(domain_certs) do
 817                 local certs = cert_info.certs;
 818                 local cert = certs[1];
 819                 print("---")
 820                 print("Fingerprint (SHA1): "..pretty_fingerprint(cert:digest("sha1")));
 821                 print("");
 822                 local n_streams = #cert_info;
 823                 print("Currently used on "..n_streams.." stream"..(n_streams==1 and "" or "s")..":");
 824                 for _, stream in ipairs(cert_info) do
 825                         if stream.direction == "incoming" then
 826                                 print("    "..stream.to.." <- "..stream.from);
 827                         else
 828                                 print("    "..stream.from.." -> "..stream.to);
 829                         end
 830                 end
 831                 print("");
 832                 local chain_valid, errors = cert_info.chain_valid, cert_info.chain_errors;
 833                 local valid_identity = cert_verify_identity(domain, "xmpp-server", cert);
 834                 if chain_valid then
 835                         print("Trusted certificate: Yes");
 836                 else
 837                         print("Trusted certificate: No");
 838                         print_errors(print, errors);
 839                 end
 840                 print("");
 841                 print("Issuer: ");
 842                 print_subject(print, cert:issuer());
 843                 print("");
 844                 print("Valid for "..domain..": "..(valid_identity and "Yes" or "No"));
 845                 print("Subject:");
 846                 print_subject(print, cert:subject());
 847         end
 848         print("---");
 849         return ("Showing "..n_certs.." certificate"
 850                 ..(n_certs==1 and "" or "s")
 851                 .." presented by "..domain..".");
 852 end
 853
 854 function def_env.s2s:close(from, to)
 855         local print, count = self.session.print, 0;
 856         local s2s_sessions = module:shared"/*/s2s/sessions";
 857
 858         local match_id;
 859         if from and not to then
 860                 match_id, from = from;
 861         elseif not to then
 862                 return false, "Syntax: s2s:close('from', 'to') - Closes all s2s sessions from 'from' to 'to'";
 863         elseif from == to then
 864                 return false, "Both from and to are the same... you can't do that :)";
 865         end
 866
 867         for _, session in pairs(s2s_sessions) do
 868                 local id = session.type..tostring(session):match("[a-f0-9]+$");
 869                 if (match_id and match_id == id)
 870                 or (session.from_host == from and session.to_host == to) then
 871                         print(("Closing connection from %s to %s [%s]"):format(session.from_host, session.to_host, id));
 872                         (session.close or s2smanager.destroy_session)(session);
 873                         count = count + 1 ;
 874                 end
 875         end
 876         return true, "Closed "..count.." s2s session"..((count == 1 and "") or "s");
 877 end
 878
 879 function def_env.s2s:closeall(host)
 880         local count = 0;
 881         local s2s_sessions = module:shared"/*/s2s/sessions";
 882         for _,session in pairs(s2s_sessions) do
 883                 if not host or session.from_host == host or session.to_host == host then
 884                         session:close();
 885                         count = count + 1;
 886                 end
 887         end
 888         if count == 0 then return false, "No sessions to close.";
 889         else return true, "Closed "..count.." s2s session"..((count == 1 and "") or "s"); end
 890 end
 891
 892 def_env.host = {}; def_env.hosts = def_env.host;
 893
 894 function def_env.host:activate(hostname, config)
 895         return hostmanager.activate(hostname, config);
 896 end
 897 function def_env.host:deactivate(hostname, reason)
 898         return hostmanager.deactivate(hostname, reason);
 899 end
 900
 901 function def_env.host:list()
 902         local print = self.session.print;
 903         local i = 0;
 904         local type;
 905         for host in values(array.collect(keys(prosody.hosts)):sort()) do
 906                 i = i + 1;
 907                 type = hosts[host].type;
 908                 if type == "local" then
 909                         print(host);
 910                 else
 911                         type = module:context(host):get_option_string("component_module", type);
 912                         if type ~= "component" then
 913                                 type = type .. " component";
 914                         end
 915                         print(("%s (%s)"):format(host, type));
 916                 end
 917         end
 918         return true, i.." hosts";
 919 end
 920
 921 def_env.port = {};
 922
 923 function def_env.port:list()
 924         local print = self.session.print;
 925         local services = portmanager.get_active_services().data;
 926         local ordered_services, n_ports = {}, 0;
 927         for service, interfaces in pairs(services) do
 928                 table.insert(ordered_services, service);
 929         end
 930         table.sort(ordered_services);
 931         for _, service in ipairs(ordered_services) do
 932                 local ports_list = {};
 933                 for interface, ports in pairs(services[service]) do
 934                         for port in pairs(ports) do
 935                                 table.insert(ports_list, "["..interface.."]:"..port);
 936                         end
 937                 end
 938                 n_ports = n_ports + #ports_list;
 939                 print(service..": "..table.concat(ports_list, ", "));
 940         end
 941         return true, #ordered_services.." services listening on "..n_ports.." ports";
 942 end
 943
 944 function def_env.port:close(close_port, close_interface)
 945         close_port = assert(tonumber(close_port), "Invalid port number");
 946         local n_closed = 0;
 947         local services = portmanager.get_active_services().data;
 948         for service, interfaces in pairs(services) do
 949                 for interface, ports in pairs(interfaces) do
 950                         if not close_interface or close_interface == interface then
 951                                 if ports[close_port] then
 952                                         self.session.print("Closing ["..interface.."]:"..close_port.."...");
 953                                         local ok, err = portmanager.close(interface, close_port)
 954                                         if not ok then
 955                                                 self.session.print("Failed to close "..interface.." "..close_port..": "..err);
 956                                         else
 957                                                 n_closed = n_closed + 1;
 958                                         end
 959                                 end
 960                         end
 961                 end
 962         end
 963         return true, "Closed "..n_closed.." ports";
 964 end
 965
 966 def_env.muc = {};
 967
 968 local console_room_mt = {
 969         __index = function (self, k) return self.room[k]; end;
 970         __tostring = function (self)
 971                 return "MUC room <"..self.room.jid..">";
 972         end;
 973 };
 974
 975 local function check_muc(jid)
 976         local room_name, host = jid_split(jid);
 977         if not hosts[host] then
 978                 return nil, "No such host: "..host;
 979         elseif not hosts[host].modules.muc then
 980                 return nil, "Host '"..host.."' is not a MUC service";
 981         end
 982         return room_name, host;
 983 end
 984
 985 function def_env.muc:create(room_jid)
 986         local room, host = check_muc(room_jid);
 987         if not room_name then
 988                 return room_name, host;
 989         end
 990         if not room then return nil, host end
 991         if hosts[host].modules.muc.rooms[room_jid] then return nil, "Room exists already" end
 992         return hosts[host].modules.muc.create_room(room_jid);
 993 end
 994
 995 function def_env.muc:room(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         local room_obj = hosts[host].modules.muc.get_room_from_jid(room_jid);
1001         if not room_obj then
1002                 return nil, "No such room: "..room_jid;
1003         end
1004         return setmetatable({ room = room_obj }, console_room_mt);
1005 end
1006
1007 function def_env.muc:list(host)
1008         local host_session = hosts[host];
1009         if not host_session or not host_session.modules.muc then
1010                 return nil, "Please supply the address of a local MUC component";
1011         end
1012         local print = self.session.print;
1013         local c = 0;
1014         for room in host_session.modules.muc.each_room() do
1015                 print(room.jid);
1016                 c = c + 1;
1017         end
1018         return true, c.." rooms";
1019 end
1020
1021 local um = require"core.usermanager";
1022
1023 def_env.user = {};
1024 function def_env.user:create(jid, password)
1025         local username, host = jid_split(jid);
1026         if not hosts[host] then
1027                 return nil, "No such host: "..host;
1028         elseif um.user_exists(username, host) then
1029                 return nil, "User exists";
1030         end
1031         local ok, err = um.create_user(username, password, host);
1032         if ok then
1033                 return true, "User created";
1034         else
1035                 return nil, "Could not create user: "..err;
1036         end
1037 end
1038
1039 function def_env.user:delete(jid)
1040         local username, host = jid_split(jid);
1041         if not hosts[host] then
1042                 return nil, "No such host: "..host;
1043         elseif not um.user_exists(username, host) then
1044                 return nil, "No such user";
1045         end
1046         local ok, err = um.delete_user(username, host);
1047         if ok then
1048                 return true, "User deleted";
1049         else
1050                 return nil, "Could not delete user: "..err;
1051         end
1052 end
1053
1054 function def_env.user:password(jid, password)
1055         local username, host = jid_split(jid);
1056         if not hosts[host] then
1057                 return nil, "No such host: "..host;
1058         elseif not um.user_exists(username, host) then
1059                 return nil, "No such user";
1060         end
1061         local ok, err = um.set_password(username, password, host);
1062         if ok then
1063                 return true, "User password changed";
1064         else
1065                 return nil, "Could not change password for user: "..err;
1066         end
1067 end
1068
1069 function def_env.user:list(host, pat)
1070         if not host then
1071                 return nil, "No host given";
1072         elseif not hosts[host] then
1073                 return nil, "No such host";
1074         end
1075         local print = self.session.print;
1076         local total, matches = 0, 0;
1077         for user in um.users(host) do
1078                 if not pat or user:match(pat) then
1079                         print(user.."@"..host);
1080                         matches = matches + 1;
1081                 end
1082                 total = total + 1;
1083         end
1084         return true, "Showing "..(pat and (matches.." of ") or "all " )..total.." users";
1085 end
1086
1087 def_env.xmpp = {};
1088
1089 local st = require "util.stanza";
1090 function def_env.xmpp:ping(localhost, remotehost)
1091         if hosts[localhost] then
1092                 core_post_stanza(hosts[localhost],
1093                         st.iq{ from=localhost, to=remotehost, type="get", id="ping" }
1094                                 :tag("ping", {xmlns="urn:xmpp:ping"}));
1095                 return true, "Sent ping";
1096         else
1097                 return nil, "No such host";
1098         end
1099 end
1100
1101 def_env.dns = {};
1102 local adns = require"net.adns";
1103 local dns = require"net.dns";
1104
1105 function def_env.dns:lookup(name, typ, class)
1106         local ret = "Query sent";
1107         local print = self.session.print;
1108         local function handler(...)
1109                 ret = "Got response";
1110                 print(...);
1111         end
1112         adns.lookup(handler, name, typ, class);
1113         return true, ret;
1114 end
1115
1116 function def_env.dns:addnameserver(...)
1117         dns._resolver:addnameserver(...)
1118         return true
1119 end
1120
1121 function def_env.dns:setnameserver(...)
1122         dns._resolver:setnameserver(...)
1123         return true
1124 end
1125
1126 function def_env.dns:purge()
1127         dns.purge()
1128         return true
1129 end
1130
1131 function def_env.dns:cache()
1132         return true, "Cache:\n"..tostring(dns.cache())
1133 end
1134
1135 def_env.http = {};
1136
1137 function def_env.http:list()
1138         local print = self.session.print;
1139
1140         for host in pairs(prosody.hosts) do
1141                 local http_apps = modulemanager.get_items("http-provider", host);
1142                 if #http_apps > 0 then
1143                         local http_host = module:context(host):get_option("http_host");
1144                         print("HTTP endpoints on "..host..(http_host and (" (using "..http_host.."):") or ":"));
1145                         for _, provider in ipairs(http_apps) do
1146                                 local url = module:context(host):http_url(provider.name);
1147                                 print("", url);
1148                         end
1149                         print("");
1150                 end
1151         end
1152
1153         local default_host = module:get_option("http_default_host");
1154         if not default_host then
1155                 print("HTTP requests to unknown hosts will return 404 Not Found");
1156         else
1157                 print("HTTP requests to unknown hosts will be handled by "..default_host);
1158         end
1159         return true;
1160 end
1161
1162 -------------
1163
1164 function printbanner(session)
1165         local option = module:get_option("console_banner");
1166         if option == nil or option == "full" or option == "graphic" then
1167                 session.print [[
1168                    ____                \   /     _
1169                     |  _ \ _ __ ___  ___  _-_   __| |_   _
1170                     | |_) | '__/ _ \/ __|/ _ \ / _` | | | |
1171                     |  __/| | | (_) \__ \ |_| | (_| | |_| |
1172                     |_|   |_|  \___/|___/\___/ \__,_|\__, |
1173                     A study in simplicity            |___/
1174
1175 ]]
1176         end
1177         if option == nil or option == "short" or option == "full" then
1178         session.print("Welcome to the Prosody administration console. For a list of commands, type: help");
1179         session.print("You may find more help on using this console in our online documentation at ");
1180         session.print("http://prosody.im/doc/console\n");
1181         end
1182         if option and option ~= "short" and option ~= "full" and option ~= "graphic" then
1183                 if type(option) == "string" then
1184                         session.print(option)
1185                 elseif type(option) == "function" then
1186                         module:log("warn", "Using functions as value for the console_banner option is no longer supported");
1187                 end
1188         end
1189 end
1190
1191 module:provides("net", {
1192         name = "console";
1193         listener = console_listener;
1194         default_port = 5582;
1195         private = true;
1196 });