prosodyctl

   1 #!/usr/bin/env lua
   2 -- Prosody IM
   3 -- Copyright (C) 2008-2010 Matthew Wild
   4 -- Copyright (C) 2008-2010 Waqas Hussain
   5 --
   6 -- This project is MIT/X11 licensed. Please see the
   7 -- COPYING file in the source package for more information.
   8 --
   9
  10 -- prosodyctl - command-line controller for Prosody XMPP server
  11
  12 -- Will be modified by configure script if run --
  13
  14 CFG_SOURCEDIR=os.getenv("PROSODY_SRCDIR");
  15 CFG_CONFIGDIR=os.getenv("PROSODY_CFGDIR");
  16 CFG_PLUGINDIR=os.getenv("PROSODY_PLUGINDIR");
  17 CFG_DATADIR=os.getenv("PROSODY_DATADIR");
  18
  19 -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --
  20
  21 local function is_relative(path)
  22         local path_sep = package.config:sub(1,1);
  23         return ((path_sep == "/" and path:sub(1,1) ~= "/")
  24         or (path_sep == "\\" and (path:sub(1,1) ~= "/" and path:sub(2,3) ~= ":\\")))
  25 end
  26
  27 -- Tell Lua where to find our libraries
  28 if CFG_SOURCEDIR then
  29         local function filter_relative_paths(path)
  30                 if is_relative(path) then return ""; end
  31         end
  32         local function sanitise_paths(paths)
  33                 return (paths:gsub("[^;]+;?", filter_relative_paths):gsub(";;+", ";"));
  34         end
  35         package.path = sanitise_paths(CFG_SOURCEDIR.."/?.lua;"..package.path);
  36         package.cpath = sanitise_paths(CFG_SOURCEDIR.."/?.so;"..package.cpath);
  37 end
  38
  39 -- Substitute ~ with path to home directory in data path
  40 if CFG_DATADIR then
  41         if os.getenv("HOME") then
  42                 CFG_DATADIR = CFG_DATADIR:gsub("^~", os.getenv("HOME"));
  43         end
  44 end
  45
  46 -- Global 'prosody' object
  47 local prosody = {
  48         hosts = {};
  49         events = require "util.events".new();
  50         platform = "posix";
  51         lock_globals = function () end;
  52         unlock_globals = function () end;
  53         installed = CFG_SOURCEDIR ~= nil;
  54         core_post_stanza = function () end; -- TODO: mod_router!
  55 };
  56 _G.prosody = prosody;
  57
  58 local dependencies = require "util.dependencies";
  59 if not dependencies.check_dependencies() then
  60         os.exit(1);
  61 end
  62
  63 config = require "core.configmanager"
  64
  65 local ENV_CONFIG;
  66 do
  67         local filenames = {};
  68
  69         local filename;
  70         if arg[1] == "--config" and arg[2] then
  71                 table.insert(filenames, arg[2]);
  72                 if CFG_CONFIGDIR then
  73                         table.insert(filenames, CFG_CONFIGDIR.."/"..arg[2]);
  74                 end
  75                 table.remove(arg, 1); table.remove(arg, 1);
  76         else
  77                 for _, format in ipairs(config.parsers()) do
  78                         table.insert(filenames, (CFG_CONFIGDIR or ".").."/prosody.cfg."..format);
  79                 end
  80         end
  81         for _,_filename in ipairs(filenames) do
  82                 filename = _filename;
  83                 local file = io.open(filename);
  84                 if file then
  85                         file:close();
  86                         ENV_CONFIG = filename;
  87                         CFG_CONFIGDIR = filename:match("^(.*)[\\/][^\\/]*$");
  88                         break;
  89                 end
  90         end
  91         local ok, level, err = config.load(filename);
  92         if not ok then
  93                 print("\n");
  94                 print("**************************");
  95                 if level == "parser" then
  96                         print("A problem occured while reading the config file "..(CFG_CONFIGDIR or ".").."/prosody.cfg.lua");
  97                         local err_line, err_message = tostring(err):match("%[string .-%]:(%d*): (.*)");
  98                         print("Error"..(err_line and (" on line "..err_line) or "")..": "..(err_message or tostring(err)));
  99                         print("");
 100                 elseif level == "file" then
 101                         print("Prosody was unable to find the configuration file.");
 102                         print("We looked for: "..(CFG_CONFIGDIR or ".").."/prosody.cfg.lua");
 103                         print("A sample config file is included in the Prosody download called prosody.cfg.lua.dist");
 104                         print("Copy or rename it to prosody.cfg.lua and edit as necessary.");
 105                 end
 106                 print("More help on configuring Prosody can be found at http://prosody.im/doc/configure");
 107                 print("Good luck!");
 108                 print("**************************");
 109                 print("");
 110                 os.exit(1);
 111         end
 112 end
 113 local original_logging_config = config.get("*", "log");
 114 config.set("*", "log", { { levels = { min="info" }, to = "console" } });
 115
 116 local data_path = config.get("*", "data_path") or CFG_DATADIR or "data";
 117 local custom_plugin_paths = config.get("*", "plugin_paths");
 118 if custom_plugin_paths then
 119         local path_sep = package.config:sub(3,3);
 120         -- path1;path2;path3;defaultpath...
 121         CFG_PLUGINDIR = table.concat(custom_plugin_paths, path_sep)..path_sep..(CFG_PLUGINDIR or "plugins");
 122 end
 123 prosody.paths = { source = CFG_SOURCEDIR, config = CFG_CONFIGDIR,
 124                   plugins = CFG_PLUGINDIR or "plugins", data = data_path };
 125
 126 if prosody.installed then
 127         -- Change working directory to data path.
 128         require "lfs".chdir(data_path);
 129 end
 130
 131 require "core.loggingmanager"
 132
 133 dependencies.log_warnings();
 134
 135 -- Switch away from root and into the prosody user --
 136 local switched_user, current_uid;
 137
 138 local want_pposix_version = "0.3.6";
 139 local ok, pposix = pcall(require, "util.pposix");
 140
 141 if ok and pposix then
 142         if pposix._VERSION ~= want_pposix_version then print(string.format("Unknown version (%s) of binary pposix module, expected %s", tostring(pposix._VERSION), want_pposix_version)); return; end
 143         current_uid = pposix.getuid();
 144         if current_uid == 0 then
 145                 -- We haz root!
 146                 local desired_user = config.get("*", "prosody_user") or "prosody";
 147                 local desired_group = config.get("*", "prosody_group") or desired_user;
 148                 local ok, err = pposix.setgid(desired_group);
 149                 if ok then
 150                         ok, err = pposix.initgroups(desired_user);
 151                 end
 152                 if ok then
 153                         ok, err = pposix.setuid(desired_user);
 154                         if ok then
 155                                 -- Yay!
 156                                 switched_user = true;
 157                         end
 158                 end
 159                 if not switched_user then
 160                         -- Boo!
 161                         print("Warning: Couldn't switch to Prosody user/group '"..tostring(desired_user).."'/'"..tostring(desired_group).."': "..tostring(err));
 162                 end
 163         end
 164
 165         -- Set our umask to protect data files
 166         pposix.umask(config.get("*", "umask") or "027");
 167         pposix.setenv("HOME", data_path);
 168         pposix.setenv("PROSODY_CONFIG", ENV_CONFIG);
 169 else
 170         print("Error: Unable to load pposix module. Check that Prosody is installed correctly.")
 171         print("For more help send the below error to us through http://prosody.im/discuss");
 172         print(tostring(pposix))
 173         os.exit(1);
 174 end
 175
 176 local function test_writeable(filename)
 177         local f, err = io.open(filename, "a");
 178         if not f then
 179                 return false, err;
 180         end
 181         f:close();
 182         return true;
 183 end
 184
 185 local unwriteable_files = {};
 186 if type(original_logging_config) == "string" and original_logging_config:sub(1,1) ~= "*" then
 187         local ok, err = test_writeable(original_logging_config);
 188         if not ok then
 189                 table.insert(unwriteable_files, err);
 190         end
 191 elseif type(original_logging_config) == "table" then
 192         for _, rule in ipairs(original_logging_config) do
 193                 if rule.filename then
 194                         local ok, err = test_writeable(rule.filename);
 195                         if not ok then
 196                                 table.insert(unwriteable_files, err);
 197                         end
 198                 end
 199         end
 200 end
 201
 202 if #unwriteable_files > 0 then
 203         print("One of more of the Prosody log files are not");
 204         print("writeable, please correct the errors and try");
 205         print("starting prosodyctl again.");
 206         print("");
 207         for _, err in ipairs(unwriteable_files) do
 208                 print(err);
 209         end
 210         print("");
 211         os.exit(1);
 212 end
 213
 214
 215 local error_messages = setmetatable({
 216                 ["invalid-username"] = "The given username is invalid in a Jabber ID";
 217                 ["invalid-hostname"] = "The given hostname is invalid";
 218                 ["no-password"] = "No password was supplied";
 219                 ["no-such-user"] = "The given user does not exist on the server";
 220                 ["no-such-host"] = "The given hostname does not exist in the config";
 221                 ["unable-to-save-data"] = "Unable to store, perhaps you don't have permission?";
 222                 ["no-pidfile"] = "There is no 'pidfile' option in the configuration file, see http://prosody.im/doc/prosodyctl#pidfile for help";
 223                 ["invalid-pidfile"] = "The 'pidfile' option in the configuration file is not a string, see http://prosody.im/doc/prosodyctl#pidfile for help";
 224                 ["no-posix"] = "The mod_posix module is not enabled in the Prosody config file, see http://prosody.im/doc/prosodyctl for more info";
 225                 ["no-such-method"] = "This module has no commands";
 226                 ["not-running"] = "Prosody is not running";
 227                 }, { __index = function (t,k) return "Error: "..(tostring(k):gsub("%-", " "):gsub("^.", string.upper)); end });
 228
 229 hosts = prosody.hosts;
 230
 231 local function make_host(hostname)
 232         return {
 233                 type = "local",
 234                 events = prosody.events,
 235                 modules = {},
 236                 users = require "core.usermanager".new_null_provider(hostname)
 237         };
 238 end
 239
 240 for hostname, config in pairs(config.getconfig()) do
 241         hosts[hostname] = make_host(hostname);
 242 end
 243
 244 local modulemanager = require "core.modulemanager"
 245
 246 local prosodyctl = require "util.prosodyctl"
 247 local socket = require "socket"
 248 -----------------------
 249
 250  -- FIXME: Duplicate code waiting for util.startup
 251 function read_version()
 252         -- Try to determine version
 253         local version_file = io.open((CFG_SOURCEDIR or ".").."/prosody.version");
 254         prosody.version = "unknown";
 255         if version_file then
 256                 prosody.version = version_file:read("*a"):gsub("%s*$", "");
 257                 version_file:close();
 258                 if #prosody.version == 12 and prosody.version:match("^[a-f0-9]+$") then
 259                         prosody.version = "hg:"..prosody.version;
 260                 end
 261         else
 262                 local hg = require"util.mercurial";
 263                 local hgid = hg.check_id(CFG_SOURCEDIR or ".");
 264                 if hgid then prosody.version = "hg:" .. hgid; end
 265         end
 266 end
 267
 268 local show_message, show_warning = prosodyctl.show_message, prosodyctl.show_warning;
 269 local show_usage = prosodyctl.show_usage;
 270 local getchar, getpass = prosodyctl.getchar, prosodyctl.getpass;
 271 local show_yesno = prosodyctl.show_yesno;
 272 local show_prompt = prosodyctl.show_prompt;
 273 local read_password = prosodyctl.read_password;
 274
 275 local jid_split = require "util.jid".prepped_split;
 276
 277 local prosodyctl_timeout = (config.get("*", "prosodyctl_timeout") or 5) * 2;
 278 -----------------------
 279 local commands = {};
 280 local command = arg[1];
 281
 282 function commands.adduser(arg)
 283         if not arg[1] or arg[1] == "--help" then
 284                 show_usage([[adduser JID]], [[Create the specified user account in Prosody]]);
 285                 return 1;
 286         end
 287         local user, host = jid_split(arg[1]);
 288         if not user and host then
 289                 show_message [[Failed to understand JID, please supply the JID you want to create]]
 290                 show_usage [[adduser user@host]]
 291                 return 1;
 292         end
 293
 294         if not host then
 295                 show_message [[Please specify a JID, including a host. e.g. alice@example.com]];
 296                 return 1;
 297         end
 298
 299         if not hosts[host] then
 300                 show_warning("The host '%s' is not listed in the configuration file (or is not enabled).", host)
 301                 show_warning("The user will not be able to log in until this is changed.");
 302                 hosts[host] = make_host(host);
 303         end
 304
 305         if prosodyctl.user_exists{ user = user, host = host } then
 306                 show_message [[That user already exists]];
 307                 return 1;
 308         end
 309
 310         local password = read_password();
 311         if not password then return 1; end
 312
 313         local ok, msg = prosodyctl.adduser { user = user, host = host, password = password };
 314
 315         if ok then return 0; end
 316
 317         show_message(msg)
 318         return 1;
 319 end
 320
 321 function commands.passwd(arg)
 322         if not arg[1] or arg[1] == "--help" then
 323                 show_usage([[passwd JID]], [[Set the password for the specified user account in Prosody]]);
 324                 return 1;
 325         end
 326         local user, host = jid_split(arg[1]);
 327         if not user and host then
 328                 show_message [[Failed to understand JID, please supply the JID you want to set the password for]]
 329                 show_usage [[passwd user@host]]
 330                 return 1;
 331         end
 332
 333         if not host then
 334                 show_message [[Please specify a JID, including a host. e.g. alice@example.com]];
 335                 return 1;
 336         end
 337
 338         if not hosts[host] then
 339                 show_warning("The host '%s' is not listed in the configuration file (or is not enabled).", host)
 340                 show_warning("The user will not be able to log in until this is changed.");
 341                 hosts[host] = make_host(host);
 342         end
 343
 344         if not prosodyctl.user_exists { user = user, host = host } then
 345                 show_message [[That user does not exist, use prosodyctl adduser to create a new user]]
 346                 return 1;
 347         end
 348
 349         local password = read_password();
 350         if not password then return 1; end
 351
 352         local ok, msg = prosodyctl.passwd { user = user, host = host, password = password };
 353
 354         if ok then return 0; end
 355
 356         show_message(error_messages[msg])
 357         return 1;
 358 end
 359
 360 function commands.deluser(arg)
 361         if not arg[1] or arg[1] == "--help" then
 362                 show_usage([[deluser JID]], [[Permanently remove the specified user account from Prosody]]);
 363                 return 1;
 364         end
 365         local user, host = jid_split(arg[1]);
 366         if not user and host then
 367                 show_message [[Failed to understand JID, please supply the JID you want to set the password for]]
 368                 show_usage [[passwd user@host]]
 369                 return 1;
 370         end
 371
 372         if not host then
 373                 show_message [[Please specify a JID, including a host. e.g. alice@example.com]];
 374                 return 1;
 375         end
 376
 377         if not hosts[host] then
 378                 show_warning("The host '%s' is not listed in the configuration file (or is not enabled).", host)
 379                 hosts[host] = make_host(host);
 380         end
 381
 382         if not prosodyctl.user_exists { user = user, host = host } then
 383                 show_message [[That user does not exist on this server]]
 384                 return 1;
 385         end
 386
 387         local ok, msg = prosodyctl.deluser { user = user, host = host };
 388
 389         if ok then return 0; end
 390
 391         show_message(error_messages[msg])
 392         return 1;
 393 end
 394
 395 function commands.start(arg)
 396         if arg[1] == "--help" then
 397                 show_usage([[start]], [[Start Prosody]]);
 398                 return 1;
 399         end
 400         local ok, ret = prosodyctl.isrunning();
 401         if not ok then
 402                 show_message(error_messages[ret]);
 403                 return 1;
 404         end
 405
 406         if ret then
 407                 local ok, ret = prosodyctl.getpid();
 408                 if not ok then
 409                         show_message("Couldn't get running Prosody's PID");
 410                         show_message(error_messages[ret]);
 411                         return 1;
 412                 end
 413                 show_message("Prosody is already running with PID %s", ret or "(unknown)");
 414                 return 1;
 415         end
 416
 417         local ok, ret = prosodyctl.start();
 418         if ok then
 419                 local daemonize = config.get("*", "daemonize");
 420                 if daemonize == nil then
 421                         daemonize = prosody.installed;
 422                 end
 423                 if daemonize then
 424                         local i=1;
 425                         while true do
 426                                 local ok, running = prosodyctl.isrunning();
 427                                 if ok and running then
 428                                         break;
 429                                 elseif i == 5 then
 430                                         show_message("Still waiting...");
 431                                 elseif i >= prosodyctl_timeout then
 432                                         show_message("Prosody is still not running. Please give it some time or check your log files for errors.");
 433                                         return 2;
 434                                 end
 435                                 socket.sleep(0.5);
 436                                 i = i + 1;
 437                         end
 438                         show_message("Started");
 439                 end
 440                 return 0;
 441         end
 442
 443         show_message("Failed to start Prosody");
 444         show_message(error_messages[ret])
 445         return 1;
 446 end
 447
 448 function commands.status(arg)
 449         if arg[1] == "--help" then
 450                 show_usage([[status]], [[Reports the running status of Prosody]]);
 451                 return 1;
 452         end
 453
 454         local ok, ret = prosodyctl.isrunning();
 455         if not ok then
 456                 show_message(error_messages[ret]);
 457                 return 1;
 458         end
 459
 460         if ret then
 461                 local ok, ret = prosodyctl.getpid();
 462                 if not ok then
 463                         show_message("Couldn't get running Prosody's PID");
 464                         show_message(error_messages[ret]);
 465                         return 1;
 466                 end
 467                 show_message("Prosody is running with PID %s", ret or "(unknown)");
 468                 return 0;
 469         else
 470                 show_message("Prosody is not running");
 471                 if not switched_user and current_uid ~= 0 then
 472                         print("\nNote:")
 473                         print(" You will also see this if prosodyctl is not running under");
 474                         print(" the same user account as Prosody. Try running as root (e.g. ");
 475                         print(" with 'sudo' in front) to gain access to Prosody's real status.");
 476                 end
 477                 return 2
 478         end
 479         return 1;
 480 end
 481
 482 function commands.stop(arg)
 483         if arg[1] == "--help" then
 484                 show_usage([[stop]], [[Stop a running Prosody server]]);
 485                 return 1;
 486         end
 487
 488         if not prosodyctl.isrunning() then
 489                 show_message("Prosody is not running");
 490                 return 1;
 491         end
 492
 493         local ok, ret = prosodyctl.stop();
 494         if ok then
 495                 local i=1;
 496                 while true do
 497                         local ok, running = prosodyctl.isrunning();
 498                         if ok and not running then
 499                                 break;
 500                         elseif i == 5 then
 501                                 show_message("Still waiting...");
 502                         elseif i >= prosodyctl_timeout then
 503                                 show_message("Prosody is still running. Please give it some time or check your log files for errors.");
 504                                 return 2;
 505                         end
 506                         socket.sleep(0.5);
 507                         i = i + 1;
 508                 end
 509                 show_message("Stopped");
 510                 return 0;
 511         end
 512
 513         show_message(error_messages[ret]);
 514         return 1;
 515 end
 516
 517 function commands.restart(arg)
 518         if arg[1] == "--help" then
 519                 show_usage([[restart]], [[Restart a running Prosody server]]);
 520                 return 1;
 521         end
 522
 523         commands.stop(arg);
 524         return commands.start(arg);
 525 end
 526
 527 function commands.about(arg)
 528         read_version();
 529         if arg[1] == "--help" then
 530                 show_usage([[about]], [[Show information about this Prosody installation]]);
 531                 return 1;
 532         end
 533
 534         local pwd = ".";
 535         local lfs = require "lfs";
 536         local array = require "util.array";
 537         local keys = require "util.iterators".keys;
 538         local hg = require"util.mercurial";
 539         local relpath = config.resolve_relative_path;
 540
 541         print("Prosody "..(prosody.version or "(unknown version)"));
 542         print("");
 543         print("# Prosody directories");
 544         print("Data directory:     "..relpath(pwd, data_path));
 545         print("Config directory:   "..relpath(pwd, CFG_CONFIGDIR or "."));
 546         print("Source directory:   "..relpath(pwd, CFG_SOURCEDIR or "."));
 547         print("Plugin directories:")
 548         print("  "..(prosody.paths.plugins:gsub("([^;]+);?", function(path)
 549                         local opath = path;
 550                         path = config.resolve_relative_path(pwd, path);
 551                         local hgid, hgrepo = hg.check_id(path);
 552                         if not hgid and hgrepo then
 553                                 return path.." - "..hgrepo .."!\n  ";
 554                         end
 555                         -- 010452cfaf53 is the first commit in the prosody-modules repository
 556                         hgrepo = hgrepo == "010452cfaf53" and "prosody-modules";
 557                         return path..(hgid and " - "..(hgrepo or "HG").." rev: "..hgid or "")
 558                                 .."\n  ";
 559                 end)));
 560         print("");
 561         print("# Lua environment");
 562         print("Lua version:             ", _G._VERSION);
 563         print("");
 564         print("Lua module search paths:");
 565         for path in package.path:gmatch("[^;]+") do
 566                 print("  "..path);
 567         end
 568         print("");
 569         print("Lua C module search paths:");
 570         for path in package.cpath:gmatch("[^;]+") do
 571                 print("  "..path);
 572         end
 573         print("");
 574         local luarocks_status = (pcall(require, "luarocks.loader") and "Installed ("..(package.loaded["luarocks.cfg"].program_version or "2.x+")..")")
 575                 or (pcall(require, "luarocks.require") and "Installed (1.x)")
 576                 or "Not installed";
 577         print("LuaRocks:        ", luarocks_status);
 578         print("");
 579         print("# Lua module versions");
 580         local module_versions, longest_name = {}, 8;
 581         local luaevent =dependencies.softreq"luaevent";
 582         local ssl = dependencies.softreq"ssl";
 583         for name, module in pairs(package.loaded) do
 584                 if type(module) == "table" and rawget(module, "_VERSION")
 585                 and name ~= "_G" and not name:match("%.") then
 586                         if #name > longest_name then
 587                                 longest_name = #name;
 588                         end
 589                         module_versions[name] = module._VERSION;
 590                 end
 591         end
 592         local sorted_keys = array.collect(keys(module_versions)):sort();
 593         for _, name in ipairs(array.collect(keys(module_versions)):sort()) do
 594                 print(name..":"..string.rep(" ", longest_name-#name), module_versions[name]);
 595         end
 596         print("");
 597 end
 598
 599 function commands.reload(arg)
 600         if arg[1] == "--help" then
 601                 show_usage([[reload]], [[Reload Prosody's configuration and re-open log files]]);
 602                 return 1;
 603         end
 604
 605         if not prosodyctl.isrunning() then
 606                 show_message("Prosody is not running");
 607                 return 1;
 608         end
 609
 610         local ok, ret = prosodyctl.reload();
 611         if ok then
 612
 613                 show_message("Prosody log files re-opened and config file reloaded. You may need to reload modules for some changes to take effect.");
 614                 return 0;
 615         end
 616
 617         show_message(error_messages[ret]);
 618         return 1;
 619 end
 620 -- ejabberdctl compatibility
 621
 622 function commands.register(arg)
 623         local user, host, password = unpack(arg);
 624         if (not (user and host)) or arg[1] == "--help" then
 625                 if user ~= "--help" then
 626                         if not user then
 627                                 show_message [[No username specified]]
 628                         elseif not host then
 629                                 show_message [[Please specify which host you want to register the user on]];
 630                         end
 631                 end
 632                 show_usage("register USER HOST [PASSWORD]", "Register a user on the server, with the given password");
 633                 return 1;
 634         end
 635         if not password then
 636                 password = read_password();
 637                 if not password then
 638                         show_message [[Unable to register user with no password]];
 639                         return 1;
 640                 end
 641         end
 642
 643         local ok, msg = prosodyctl.adduser { user = user, host = host, password = password };
 644
 645         if ok then return 0; end
 646
 647         show_message(error_messages[msg])
 648         return 1;
 649 end
 650
 651 function commands.unregister(arg)
 652         local user, host = unpack(arg);
 653         if (not (user and host)) or arg[1] == "--help" then
 654                 if user ~= "--help" then
 655                         if not user then
 656                                 show_message [[No username specified]]
 657                         elseif not host then
 658                                 show_message [[Please specify which host you want to unregister the user from]];
 659                         end
 660                 end
 661                 show_usage("unregister USER HOST [PASSWORD]", "Permanently remove a user account from the server");
 662                 return 1;
 663         end
 664
 665         local ok, msg = prosodyctl.deluser { user = user, host = host };
 666
 667         if ok then return 0; end
 668
 669         show_message(error_messages[msg])
 670         return 1;
 671 end
 672
 673 local openssl;
 674 local lfs;
 675
 676 local cert_commands = {};
 677
 678 -- If a file already exists, ask if the user wants to use it or replace it
 679 -- Backups the old file if replaced
 680 local function use_existing(filename)
 681         local attrs = lfs.attributes(filename);
 682         if attrs then
 683                 if show_yesno(filename .. " exists, do you want to replace it? [y/n]") then
 684                         local backup = filename..".bkp~"..os.date("%FT%T", attrs.change);
 685                         os.rename(filename, backup);
 686                         show_message(filename.." backed up to "..backup);
 687                 else
 688                         -- Use the existing file
 689                         return true;
 690                 end
 691         end
 692 end
 693
 694 function cert_commands.config(arg)
 695         if #arg >= 1 and arg[1] ~= "--help" then
 696                 local conf_filename = (CFG_DATADIR or "./certs") .. "/" .. arg[1] .. ".cnf";
 697                 if use_existing(conf_filename) then
 698                         return nil, conf_filename;
 699                 end
 700                 local conf = openssl.config.new();
 701                 conf:from_prosody(hosts, config, arg);
 702                 show_message("Please provide details to include in the certificate config file.");
 703                 show_message("Leave the field empty to use the default value or '.' to exclude the field.")
 704                 for i, k in ipairs(openssl._DN_order) do
 705                         local v = conf.distinguished_name[k];
 706                         if v then
 707                                 local nv;
 708                                 if k == "commonName" then
 709                                         v = arg[1]
 710                                 elseif k == "emailAddress" then
 711                                         v = "xmpp@" .. arg[1];
 712                                 elseif k == "countryName" then
 713                                         local tld = arg[1]:match"%.([a-z]+)$";
 714                                         if tld and #tld == 2 and tld ~= "uk" then
 715                                                 v = tld:upper();
 716                                         end
 717                                 end
 718                                 nv = show_prompt(("%s (%s):"):format(k, nv or v));
 719                                 nv = (not nv or nv == "") and v or nv;
 720                                 if nv:find"[\192-\252][\128-\191]+" then
 721                                         conf.req.string_mask = "utf8only"
 722                                 end
 723                                 conf.distinguished_name[k] = nv ~= "." and nv or nil;
 724                         end
 725                 end
 726                 local conf_file, err = io.open(conf_filename, "w");
 727                 if not conf_file then
 728                         show_warning("Could not open OpenSSL config file for writing");
 729                         show_warning(err);
 730                         os.exit(1);
 731                 end
 732                 conf_file:write(conf:serialize());
 733                 conf_file:close();
 734                 print("");
 735                 show_message("Config written to " .. conf_filename);
 736                 return nil, conf_filename;
 737         else
 738                 show_usage("cert config HOSTNAME [HOSTNAME+]", "Builds a certificate config file covering the supplied hostname(s)")
 739         end
 740 end
 741
 742 function cert_commands.key(arg)
 743         if #arg >= 1 and arg[1] ~= "--help" then
 744                 local key_filename = (CFG_DATADIR or "./certs") .. "/" .. arg[1] .. ".key";
 745                 if use_existing(key_filename) then
 746                         return nil, key_filename;
 747                 end
 748                 os.remove(key_filename); -- This file, if it exists is unlikely to have write permissions
 749                 local key_size = tonumber(arg[2] or show_prompt("Choose key size (2048):") or 2048);
 750                 local old_umask = pposix.umask("0377");
 751                 if openssl.genrsa{out=key_filename, key_size} then
 752                         os.execute(("chmod 400 '%s'"):format(key_filename));
 753                         show_message("Key written to ".. key_filename);
 754                         pposix.umask(old_umask);
 755                         return nil, key_filename;
 756                 end
 757                 show_message("There was a problem, see OpenSSL output");
 758         else
 759                 show_usage("cert key HOSTNAME <bits>", "Generates a RSA key named HOSTNAME.key\n "
 760                 .."Prompts for a key size if none given")
 761         end
 762 end
 763
 764 function cert_commands.request(arg)
 765         if #arg >= 1 and arg[1] ~= "--help" then
 766                 local req_filename = (CFG_DATADIR or "./certs") .. "/" .. arg[1] .. ".req";
 767                 if use_existing(req_filename) then
 768                         return nil, req_filename;
 769                 end
 770                 local _, key_filename = cert_commands.key({arg[1]});
 771                 local _, conf_filename = cert_commands.config(arg);
 772                 if openssl.req{new=true, key=key_filename, utf8=true, sha256=true, config=conf_filename, out=req_filename} then
 773                         show_message("Certificate request written to ".. req_filename);
 774                 else
 775                         show_message("There was a problem, see OpenSSL output");
 776                 end
 777         else
 778                 show_usage("cert request HOSTNAME [HOSTNAME+]", "Generates a certificate request for the supplied hostname(s)")
 779         end
 780 end
 781
 782 function cert_commands.generate(arg)
 783         if #arg >= 1 and arg[1] ~= "--help" then
 784                 local cert_filename = (CFG_DATADIR or "./certs") .. "/" .. arg[1] .. ".crt";
 785                 if use_existing(cert_filename) then
 786                         return nil, cert_filename;
 787                 end
 788                 local _, key_filename = cert_commands.key({arg[1]});
 789                 local _, conf_filename = cert_commands.config(arg);
 790                 local ret;
 791                 if key_filename and conf_filename and cert_filename
 792                         and openssl.req{new=true, x509=true, nodes=true, key=key_filename,
 793                                 days=365, sha256=true, utf8=true, config=conf_filename, out=cert_filename} then
 794                         show_message("Certificate written to ".. cert_filename);
 795                 else
 796                         show_message("There was a problem, see OpenSSL output");
 797                 end
 798         else
 799                 show_usage("cert generate HOSTNAME [HOSTNAME+]", "Generates a self-signed certificate for the current hostname(s)")
 800         end
 801 end
 802
 803 function commands.cert(arg)
 804         if #arg >= 1 and arg[1] ~= "--help" then
 805                 openssl = require "util.openssl";
 806                 lfs = require "lfs";
 807                 local subcmd = table.remove(arg, 1);
 808                 if type(cert_commands[subcmd]) == "function" then
 809                         if not arg[1] then
 810                                 show_message"You need to supply at least one hostname"
 811                                 arg = { "--help" };
 812                         end
 813                         if arg[1] ~= "--help" and not hosts[arg[1]] then
 814                                 show_message(error_messages["no-such-host"]);
 815                                 return
 816                         end
 817                         return cert_commands[subcmd](arg);
 818                 end
 819         end
 820         show_usage("cert config|request|generate|key", "Helpers for generating X.509 certificates and keys.")
 821 end
 822
 823 function commands.check(arg)
 824         if arg[1] == "--help" then
 825                 show_usage([[check]], [[Perform basic checks on your Prosody installation]]);
 826                 return 1;
 827         end
 828         local what = table.remove(arg, 1);
 829         local array, set = require "util.array", require "util.set";
 830         local it = require "util.iterators";
 831         local ok = true;
 832         local function disabled_hosts(host, conf) return host ~= "*" and conf.enabled ~= false; end
 833         local function enabled_hosts() return it.filter(disabled_hosts, pairs(config.getconfig())); end
 834         if not what or what == "disabled" then
 835                 local disabled_hosts = set.new();
 836                 for host, host_options in it.filter("*", pairs(config.getconfig())) do
 837                         if host_options.enabled == false then
 838                                 disabled_hosts:add(host);
 839                         end
 840                 end
 841                 if not disabled_hosts:empty() then
 842                         local msg = "Checks will be skipped for these disabled hosts: %s";
 843                         if what then msg = "These hosts are disabled: %s"; end
 844                         show_warning(msg, tostring(disabled_hosts));
 845                         if what then return 0; end
 846                         print""
 847                 end
 848         end
 849         if not what or what == "config" then
 850                 print("Checking config...");
 851                 local deprecated = set.new({
 852                         "bosh_ports", "disallow_s2s", "no_daemonize", "anonymous_login", "require_encryption",
 853                 });
 854                 local known_global_options = set.new({
 855                         "pidfile", "log", "plugin_paths", "prosody_user", "prosody_group", "daemonize",
 856                         "umask", "prosodyctl_timeout", "use_ipv6", "use_libevent", "network_settings",
 857                         "network_backend", "http_default_host",
 858                 });
 859                 local config = config.getconfig();
 860                 -- Check that we have any global options (caused by putting a host at the top)
 861                 if it.count(it.filter("log", pairs(config["*"]))) == 0 then
 862                         ok = false;
 863                         print("");
 864                         print("    No global options defined. Perhaps you have put a host definition at the top")
 865                         print("    of the config file? They should be at the bottom, see http://prosody.im/doc/configure#overview");
 866                 end
 867                 if it.count(enabled_hosts()) == 0 then
 868                         ok = false;
 869                         print("");
 870                         if it.count(it.filter("*", pairs(config))) == 0 then
 871                                 print("    No hosts are defined, please add at least one VirtualHost section")
 872                         elseif config["*"]["enabled"] == false then
 873                                 print("    No hosts are enabled. Remove enabled = false from the global section or put enabled = true under at least one VirtualHost section")
 874                         else
 875                                 print("    All hosts are disabled. Remove enabled = false from at least one VirtualHost section")
 876                         end
 877                 end
 878                 -- Check for global options under hosts
 879                 local global_options = set.new(it.to_array(it.keys(config["*"])));
 880                 local deprecated_global_options = set.intersection(global_options, deprecated);
 881                 if not deprecated_global_options:empty() then
 882                         print("");
 883                         print("    You have some deprecated options in the global section:");
 884                         print("    "..tostring(deprecated_global_options))
 885                         ok = false;
 886                 end
 887                 for host, options in enabled_hosts() do
 888                         local host_options = set.new(it.to_array(it.keys(options)));
 889                         local misplaced_options = set.intersection(host_options, known_global_options);
 890                         for name in pairs(options) do
 891                                 if name:match("^interfaces?")
 892                                 or name:match("_ports?$") or name:match("_interfaces?$")
 893                                 or (name:match("_ssl$") and not name:match("^[cs]2s_ssl$")) then
 894                                         misplaced_options:add(name);
 895                                 end
 896                         end
 897                         if not misplaced_options:empty() then
 898                                 ok = false;
 899                                 print("");
 900                                 local n = it.count(misplaced_options);
 901                                 print("    You have "..n.." option"..(n>1 and "s " or " ").."set under "..host.." that should be");
 902                                 print("    in the global section of the config file, above any VirtualHost or Component definitions,")
 903                                 print("    see http://prosody.im/doc/configure#overview for more information.")
 904                                 print("");
 905                                 print("    You need to move the following option"..(n>1 and "s" or "")..": "..table.concat(it.to_array(misplaced_options), ", "));
 906                         end
 907                         local subdomain = host:match("^[^.]+");
 908                         if not(host_options:contains("component_module")) and (subdomain == "jabber" or subdomain == "xmpp"
 909                            or subdomain == "chat" or subdomain == "im") then
 910                                 print("");
 911                                 print("    Suggestion: If "..host.. " is a new host with no real users yet, consider renaming it now to");
 912                                 print("     "..host:gsub("^[^.]+%.", "")..". You can use SRV records to redirect XMPP clients and servers to "..host..".");
 913                                 print("     For more information see: http://prosody.im/doc/dns");
 914                         end
 915                 end
 916                 local all_modules = set.new(config["*"].modules_enabled);
 917                 local all_options = set.new(it.to_array(it.keys(config["*"])));
 918                 for host in enabled_hosts() do
 919                         all_options:include(set.new(it.to_array(it.keys(config[host]))));
 920                         all_modules:include(set.new(config[host].modules_enabled));
 921                 end
 922                 for mod in all_modules do
 923                         if mod:match("^mod_") then
 924                                 print("");
 925                                 print("    Modules in modules_enabled should not have the 'mod_' prefix included.");
 926                                 print("    Change '"..mod.."' to '"..mod:match("^mod_(.*)").."'.");
 927                         end
 928                 end
 929                 local ssl = dependencies.softreq"ssl";
 930                 if not ssl then
 931                         if not set.intersection(all_options, set.new({"require_encryption", "c2s_require_encryption", "s2s_require_encryption"})):empty() then
 932                                 print("");
 933                                 print("    You require encryption but LuaSec is not available.");
 934                                 print("    Connections will fail.");
 935                                 ok = false;
 936                         end
 937                 elseif not ssl.loadcertificate then
 938                         if all_options:contains("s2s_secure_auth") then
 939                                 print("");
 940                                 print("    You have set s2s_secure_auth but your version of LuaSec does ");
 941                                 print("    not support certificate validation, so all s2s connections will");
 942                                 print("    fail.");
 943                                 ok = false;
 944                         elseif all_options:contains("s2s_secure_domains") then
 945                                 local secure_domains = set.new();
 946                                 for host in enabled_hosts() do
 947                                         if config[host].s2s_secure_auth == true then
 948                                                 secure_domains:add("*");
 949                                         else
 950                                                 secure_domains:include(set.new(config[host].s2s_secure_domains));
 951                                         end
 952                                 end
 953                                 if not secure_domains:empty() then
 954                                         print("");
 955                                         print("    You have set s2s_secure_domains but your version of LuaSec does ");
 956                                         print("    not support certificate validation, so s2s connections to/from ");
 957                                         print("    these domains will fail.");
 958                                         ok = false;
 959                                 end
 960                         end
 961                 end
 962
 963                 print("Done.\n");
 964         end
 965         if not what or what == "dns" then
 966                 local dns = require "net.dns";
 967                 local idna = require "util.encodings".idna;
 968                 local ip = require "util.ip";
 969                 local c2s_ports = set.new(config.get("*", "c2s_ports") or {5222});
 970                 local s2s_ports = set.new(config.get("*", "s2s_ports") or {5269});
 971
 972                 local c2s_srv_required, s2s_srv_required;
 973                 if not c2s_ports:contains(5222) then
 974                         c2s_srv_required = true;
 975                 end
 976                 if not s2s_ports:contains(5269) then
 977                         s2s_srv_required = true;
 978                 end
 979
 980                 local problem_hosts = set.new();
 981
 982                 local external_addresses, internal_addresses = set.new(), set.new();
 983
 984                 local fqdn = socket.dns.tohostname(socket.dns.gethostname());
 985                 if fqdn then
 986                         local res = dns.lookup(idna.to_ascii(fqdn), "A");
 987                         if res then
 988                                 for _, record in ipairs(res) do
 989                                         external_addresses:add(record.a);
 990                                 end
 991                         end
 992                         local res = dns.lookup(idna.to_ascii(fqdn), "AAAA");
 993                         if res then
 994                                 for _, record in ipairs(res) do
 995                                         external_addresses:add(record.aaaa);
 996                                 end
 997                         end
 998                 end
 999
1000                 local local_addresses = require"util.net".local_addresses() or {};
1001
1002                 for addr in it.values(local_addresses) do
1003                         if not ip.new_ip(addr).private then
1004                                 external_addresses:add(addr);
1005                         else
1006                                 internal_addresses:add(addr);
1007                         end
1008                 end
1009
1010                 if external_addresses:empty() then
1011                         print("");
1012                         print("   Failed to determine the external addresses of this server. Checks may be inaccurate.");
1013                         c2s_srv_required, s2s_srv_required = true, true;
1014                 end
1015
1016                 local v6_supported = not not socket.tcp6;
1017
1018                 for host, host_options in enabled_hosts() do
1019                         local all_targets_ok, some_targets_ok = true, false;
1020
1021                         local is_component = not not host_options.component_module;
1022                         print("Checking DNS for "..(is_component and "component" or "host").." "..host.."...");
1023                         local target_hosts = set.new();
1024                         if not is_component then
1025                                 local res = dns.lookup("_xmpp-client._tcp."..idna.to_ascii(host)..".", "SRV");
1026                                 if res then
1027                                         for _, record in ipairs(res) do
1028                                                 target_hosts:add(record.srv.target);
1029                                                 if not c2s_ports:contains(record.srv.port) then
1030                                                         print("    SRV target "..record.srv.target.." contains unknown client port: "..record.srv.port);
1031                                                 end
1032                                         end
1033                                 else
1034                                         if c2s_srv_required then
1035                                                 print("    No _xmpp-client SRV record found for "..host..", but it looks like you need one.");
1036                                                 all_targst_ok = false;
1037                                         else
1038                                                 target_hosts:add(host);
1039                                         end
1040                                 end
1041                         end
1042                         local res = dns.lookup("_xmpp-server._tcp."..idna.to_ascii(host)..".", "SRV");
1043                         if res then
1044                                 for _, record in ipairs(res) do
1045                                         target_hosts:add(record.srv.target);
1046                                         if not s2s_ports:contains(record.srv.port) then
1047                                                 print("    SRV target "..record.srv.target.." contains unknown server port: "..record.srv.port);
1048                                         end
1049                                 end
1050                         else
1051                                 if s2s_srv_required then
1052                                         print("    No _xmpp-server SRV record found for "..host..", but it looks like you need one.");
1053                                         all_targets_ok = false;
1054                                 else
1055                                         target_hosts:add(host);
1056                                 end
1057                         end
1058                         if target_hosts:empty() then
1059                                 target_hosts:add(host);
1060                         end
1061
1062                         if target_hosts:contains("localhost") then
1063                                 print("    Target 'localhost' cannot be accessed from other servers");
1064                                 target_hosts:remove("localhost");
1065                         end
1066
1067                         local modules = set.new(it.to_array(it.values(host_options.modules_enabled)))
1068                                         + set.new(it.to_array(it.values(config.get("*", "modules_enabled"))))
1069                                         + set.new({ config.get(host, "component_module") });
1070
1071                         if modules:contains("proxy65") then
1072                                 local proxy65_target = config.get(host, "proxy65_address") or host;
1073                                 local A, AAAA = dns.lookup(idna.to_ascii(proxy65_target), "A"), dns.lookup(idna.to_ascii(proxy65_target), "AAAA");
1074                                 local prob = {};
1075                                 if not A then
1076                                         table.insert(prob, "A");
1077                                 end
1078                                 if v6_supported and not AAAA then
1079                                         table.insert(prob, "AAAA");
1080                                 end
1081                                 if #prob > 0 then
1082                                         print("    File transfer proxy "..proxy65_target.." has no "..table.concat(prob, "/").." record. Create one or set 'proxy65_address' to the correct host/IP.");
1083                                 end
1084                         end
1085
1086                         for host in target_hosts do
1087                                 local host_ok_v4, host_ok_v6;
1088                                 local res = dns.lookup(idna.to_ascii(host), "A");
1089                                 if res then
1090                                         for _, record in ipairs(res) do
1091                                                 if external_addresses:contains(record.a) then
1092                                                         some_targets_ok = true;
1093                                                         host_ok_v4 = true;
1094                                                 elseif internal_addresses:contains(record.a) then
1095                                                         host_ok_v4 = true;
1096                                                         some_targets_ok = true;
1097                                                         print("    "..host.." A record points to internal address, external connections might fail");
1098                                                 else
1099                                                         print("    "..host.." A record points to unknown address "..record.a);
1100                                                         all_targets_ok = false;
1101                                                 end
1102                                         end
1103                                 end
1104                                 local res = dns.lookup(idna.to_ascii(host), "AAAA");
1105                                 if res then
1106                                         for _, record in ipairs(res) do
1107                                                 if external_addresses:contains(record.aaaa) then
1108                                                         some_targets_ok = true;
1109                                                         host_ok_v6 = true;
1110                                                 elseif internal_addresses:contains(record.aaaa) then
1111                                                         host_ok_v6 = true;
1112                                                         some_targets_ok = true;
1113                                                         print("    "..host.." AAAA record points to internal address, external connections might fail");
1114                                                 else
1115                                                         print("    "..host.." AAAA record points to unknown address "..record.aaaa);
1116                                                         all_targets_ok = false;
1117                                                 end
1118                                         end
1119                                 end
1120
1121                                 local bad_protos = {}
1122                                 if not host_ok_v4 then
1123                                         table.insert(bad_protos, "IPv4");
1124                                 end
1125                                 if not host_ok_v6 then
1126                                         table.insert(bad_protos, "IPv6");
1127                                 end
1128                                 if #bad_protos > 0 then
1129                                         print("    Host "..host.." does not seem to resolve to this server ("..table.concat(bad_protos, "/")..")");
1130                                 end
1131                                 if host_ok_v6 and not v6_supported then
1132                                         print("    Host "..host.." has AAAA records, but your version of LuaSocket does not support IPv6.");
1133                                         print("      Please see http://prosody.im/doc/ipv6 for more information.");
1134                                 end
1135                         end
1136                         if not all_targets_ok then
1137                                 print("    "..(some_targets_ok and "Only some" or "No").." targets for "..host.." appear to resolve to this server.");
1138                                 if is_component then
1139                                         print("    DNS records are necessary if you want users on other servers to access this component.");
1140                                 end
1141                                 problem_hosts:add(host);
1142                         end
1143                         print("");
1144                 end
1145                 if not problem_hosts:empty() then
1146                         print("");
1147                         print("For more information about DNS configuration please see http://prosody.im/doc/dns");
1148                         print("");
1149                         ok = false;
1150                 end
1151         end
1152         if not what or what == "certs" then
1153                 local cert_ok;
1154                 print"Checking certificates..."
1155                 local x509_verify_identity = require"util.x509".verify_identity;
1156                 local ssl = dependencies.softreq"ssl";
1157                 -- local datetime_parse = require"util.datetime".parse_x509;
1158                 local load_cert = ssl and ssl.loadcertificate;
1159                 -- or ssl.cert_from_pem
1160                 if not ssl then
1161                         print("LuaSec not available, can't perform certificate checks")
1162                         if what == "certs" then cert_ok = false end
1163                 elseif not load_cert then
1164                         print("This version of LuaSec (" .. ssl._VERSION .. ") does not support certificate checking");
1165                         cert_ok = false
1166                 else
1167                         for host in enabled_hosts() do
1168                                 print("Checking certificate for "..host);
1169                                 -- First, let's find out what certificate this host uses.
1170                                 local ssl_config = config.rawget(host, "ssl");
1171                                 if not ssl_config then
1172                                         local base_host = host:match("%.(.*)");
1173                                         ssl_config = config.get(base_host, "ssl");
1174                                 end
1175                                 if not ssl_config then
1176                                         print("  No 'ssl' option defined for "..host)
1177                                         cert_ok = false
1178                                 elseif not ssl_config.certificate then
1179                                         print("  No 'certificate' set in ssl option for "..host)
1180                                         cert_ok = false
1181                                 elseif not ssl_config.key then
1182                                         print("  No 'key' set in ssl option for "..host)
1183                                         cert_ok = false
1184                                 else
1185                                         local key, err = io.open(ssl_config.key); -- Permissions check only
1186                                         if not key then
1187                                                 print("    Could not open "..ssl_config.key..": "..err);
1188                                                 cert_ok = false
1189                                         else
1190                                                 key:close();
1191                                         end
1192                                         local cert_fh, err = io.open(ssl_config.certificate); -- Load the file.
1193                                         if not cert_fh then
1194                                                 print("    Could not open "..ssl_config.certificate..": "..err);
1195                                                 cert_ok = false
1196                                         else
1197                                                 print("  Certificate: "..ssl_config.certificate)
1198                                                 local cert = load_cert(cert_fh:read"*a"); cert_fh = cert_fh:close();
1199                                                 if not cert:validat(os.time()) then
1200                                                         print("    Certificate has expired.")
1201                                                         cert_ok = false
1202                                                 end
1203                                                 if config.get(host, "component_module") == nil
1204                                                         and not x509_verify_identity(host, "_xmpp-client", cert) then
1205                                                         print("    Not vaild for client connections to "..host..".")
1206                                                         cert_ok = false
1207                                                 end
1208                                                 if (not (config.get(host, "anonymous_login")
1209                                                         or config.get(host, "authentication") == "anonymous"))
1210                                                         and not x509_verify_identity(host, "_xmpp-server", cert) then
1211                                                         print("    Not vaild for server-to-server connections to "..host..".")
1212                                                         cert_ok = false
1213                                                 end
1214                                         end
1215                                 end
1216                         end
1217                         if cert_ok == false then
1218                                 print("")
1219                                 print("For more information about certificates please see http://prosody.im/doc/certificates");
1220                                 ok = false
1221                         end
1222                 end
1223                 print("")
1224         end
1225         if not ok then
1226                 print("Problems found, see above.");
1227         else
1228                 print("All checks passed, congratulations!");
1229         end
1230         return ok and 0 or 2;
1231 end
1232
1233 ---------------------
1234
1235 if command and command:match("^mod_") then -- Is a command in a module
1236         local module_name = command:match("^mod_(.+)");
1237         local ret, err = modulemanager.load("*", module_name);
1238         if not ret then
1239                 show_message("Failed to load module '"..module_name.."': "..err);
1240                 os.exit(1);
1241         end
1242
1243         table.remove(arg, 1);
1244
1245         local module = modulemanager.get_module("*", module_name);
1246         if not module then
1247                 show_message("Failed to load module '"..module_name.."': Unknown error");
1248                 os.exit(1);
1249         end
1250
1251         if not modulemanager.module_has_method(module, "command") then
1252                 show_message("Fail: mod_"..module_name.." does not support any commands");
1253                 os.exit(1);
1254         end
1255
1256         local ok, ret = modulemanager.call_module_method(module, "command", arg);
1257         if ok then
1258                 if type(ret) == "number" then
1259                         os.exit(ret);
1260                 elseif type(ret) == "string" then
1261                         show_message(ret);
1262                 end
1263                 os.exit(0); -- :)
1264         else
1265                 show_message("Failed to execute command: "..error_messages[ret]);
1266                 os.exit(1); -- :(
1267         end
1268 end
1269
1270 if not commands[command] then -- Show help for all commands
1271         function show_usage(usage, desc)
1272                 print(" "..usage);
1273                 print("    "..desc);
1274         end
1275
1276         print("prosodyctl - Manage a Prosody server");
1277         print("");
1278         print("Usage: "..arg[0].." COMMAND [OPTIONS]");
1279         print("");
1280         print("Where COMMAND may be one of:\n");
1281
1282         local hidden_commands = require "util.set".new{ "register", "unregister", "addplugin" };
1283         local commands_order = { "adduser", "passwd", "deluser", "start", "stop", "restart", "reload", "about" };
1284
1285         local done = {};
1286
1287         for _, command_name in ipairs(commands_order) do
1288                 local command = commands[command_name];
1289                 if command then
1290                         command{ "--help" };
1291                         print""
1292                         done[command_name] = true;
1293                 end
1294         end
1295
1296         for command_name, command in pairs(commands) do
1297                 if not done[command_name] and not hidden_commands:contains(command_name) then
1298                         command{ "--help" };
1299                         print""
1300                         done[command_name] = true;
1301                 end
1302         end
1303
1304
1305         os.exit(0);
1306 end
1307
1308 os.exit(commands[command]({ select(2, unpack(arg)) }));