plugins/mod_admin_telnet.lua

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