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                 ["no-posix"] = "The mod_posix module is not enabled in the Prosody config file, see http://prosody.im/doc/prosodyctl for more info";
 224                 ["no-such-method"] = "This module has no commands";
 225                 ["not-running"] = "Prosody is not running";
 226                 }, { __index = function (t,k) return "Error: "..(tostring(k):gsub("%-", " "):gsub("^.", string.upper)); end });
 227
 228 hosts = prosody.hosts;
 229
 230 local function make_host(hostname)
 231         return {
 232                 type = "local",
 233                 events = prosody.events,
 234                 modules = {},
 235                 users = require "core.usermanager".new_null_provider(hostname)
 236         };
 237 end
 238
 239 for hostname, config in pairs(config.getconfig()) do
 240         hosts[hostname] = make_host(hostname);
 241 end
 242
 243 local modulemanager = require "core.modulemanager"
 244
 245 local prosodyctl = require "util.prosodyctl"
 246 require "socket"
 247 -----------------------
 248
 249  -- FIXME: Duplicate code waiting for util.startup
 250 function read_version()
 251         -- Try to determine version
 252         local version_file = io.open((CFG_SOURCEDIR or ".").."/prosody.version");
 253         if version_file then
 254                 prosody.version = version_file:read("*a"):gsub("%s*$", "");
 255                 version_file:close();
 256                 if #prosody.version == 12 and prosody.version:match("^[a-f0-9]+$") then
 257                         prosody.version = "hg:"..prosody.version;
 258                 end
 259         else
 260                 prosody.version = "unknown";
 261         end
 262 end
 263
 264 local show_message, show_warning = prosodyctl.show_message, prosodyctl.show_warning;
 265 local show_usage = prosodyctl.show_usage;
 266 local getchar, getpass = prosodyctl.getchar, prosodyctl.getpass;
 267 local show_yesno = prosodyctl.show_yesno;
 268 local show_prompt = prosodyctl.show_prompt;
 269 local read_password = prosodyctl.read_password;
 270
 271 local prosodyctl_timeout = (config.get("*", "prosodyctl_timeout") or 5) * 2;
 272 -----------------------
 273 local commands = {};
 274 local command = arg[1];
 275
 276 function commands.adduser(arg)
 277         local jid_split = require "util.jid".split;
 278         if not arg[1] or arg[1] == "--help" then
 279                 show_usage([[adduser JID]], [[Create the specified user account in Prosody]]);
 280                 return 1;
 281         end
 282         local user, host = jid_split(arg[1]);
 283         if not user and host then
 284                 show_message [[Failed to understand JID, please supply the JID you want to create]]
 285                 show_usage [[adduser user@host]]
 286                 return 1;
 287         end
 288
 289         if not host then
 290                 show_message [[Please specify a JID, including a host. e.g. alice@example.com]];
 291                 return 1;
 292         end
 293
 294         if not hosts[host] then
 295                 show_warning("The host '%s' is not listed in the configuration file (or is not enabled).", host)
 296                 show_warning("The user will not be able to log in until this is changed.");
 297                 hosts[host] = make_host(host);
 298         end
 299
 300         if prosodyctl.user_exists{ user = user, host = host } then
 301                 show_message [[That user already exists]];
 302                 return 1;
 303         end
 304
 305         local password = read_password();
 306         if not password then return 1; end
 307
 308         local ok, msg = prosodyctl.adduser { user = user, host = host, password = password };
 309
 310         if ok then return 0; end
 311
 312         show_message(msg)
 313         return 1;
 314 end
 315
 316 function commands.passwd(arg)
 317         local jid_split = require "util.jid".split;
 318         if not arg[1] or arg[1] == "--help" then
 319                 show_usage([[passwd JID]], [[Set the password for the specified user account in Prosody]]);
 320                 return 1;
 321         end
 322         local user, host = jid_split(arg[1]);
 323         if not user and host then
 324                 show_message [[Failed to understand JID, please supply the JID you want to set the password for]]
 325                 show_usage [[passwd user@host]]
 326                 return 1;
 327         end
 328
 329         if not host then
 330                 show_message [[Please specify a JID, including a host. e.g. alice@example.com]];
 331                 return 1;
 332         end
 333
 334         if not hosts[host] then
 335                 show_warning("The host '%s' is not listed in the configuration file (or is not enabled).", host)
 336                 show_warning("The user will not be able to log in until this is changed.");
 337                 hosts[host] = make_host(host);
 338         end
 339
 340         if not prosodyctl.user_exists { user = user, host = host } then
 341                 show_message [[That user does not exist, use prosodyctl adduser to create a new user]]
 342                 return 1;
 343         end
 344
 345         local password = read_password();
 346         if not password then return 1; end
 347
 348         local ok, msg = prosodyctl.passwd { user = user, host = host, password = password };
 349
 350         if ok then return 0; end
 351
 352         show_message(error_messages[msg])
 353         return 1;
 354 end
 355
 356 function commands.deluser(arg)
 357         local jid_split = require "util.jid".split;
 358         if not arg[1] or arg[1] == "--help" then
 359                 show_usage([[deluser JID]], [[Permanently remove the specified user account from Prosody]]);
 360                 return 1;
 361         end
 362         local user, host = jid_split(arg[1]);
 363         if not user and host then
 364                 show_message [[Failed to understand JID, please supply the JID you want to set the password for]]
 365                 show_usage [[passwd user@host]]
 366                 return 1;
 367         end
 368
 369         if not host then
 370                 show_message [[Please specify a JID, including a host. e.g. alice@example.com]];
 371                 return 1;
 372         end
 373
 374         if not hosts[host] then
 375                 show_warning("The host '%s' is not listed in the configuration file (or is not enabled).", host)
 376                 show_warning("The user will not be able to log in until this is changed.");
 377                 hosts[host] = make_host(host);
 378         end
 379
 380         if not prosodyctl.user_exists { user = user, host = host } then
 381                 show_message [[That user does not exist on this server]]
 382                 return 1;
 383         end
 384
 385         local ok, msg = prosodyctl.deluser { user = user, host = host };
 386
 387         if ok then return 0; end
 388
 389         show_message(error_messages[msg])
 390         return 1;
 391 end
 392
 393 function commands.start(arg)
 394         if arg[1] == "--help" then
 395                 show_usage([[start]], [[Start Prosody]]);
 396                 return 1;
 397         end
 398         local ok, ret = prosodyctl.isrunning();
 399         if not ok then
 400                 show_message(error_messages[ret]);
 401                 return 1;
 402         end
 403
 404         if ret then
 405                 local ok, ret = prosodyctl.getpid();
 406                 if not ok then
 407                         show_message("Couldn't get running Prosody's PID");
 408                         show_message(error_messages[ret]);
 409                         return 1;
 410                 end
 411                 show_message("Prosody is already running with PID %s", ret or "(unknown)");
 412                 return 1;
 413         end
 414
 415         local ok, ret = prosodyctl.start();
 416         if ok then
 417                 if config.get("*", "daemonize") ~= false then
 418                         local i=1;
 419                         while true do
 420                                 local ok, running = prosodyctl.isrunning();
 421                                 if ok and running then
 422                                         break;
 423                                 elseif i == 5 then
 424                                         show_message("Still waiting...");
 425                                 elseif i >= prosodyctl_timeout then
 426                                         show_message("Prosody is still not running. Please give it some time or check your log files for errors.");
 427                                         return 2;
 428                                 end
 429                                 socket.sleep(0.5);
 430                                 i = i + 1;
 431                         end
 432                         show_message("Started");
 433                 end
 434                 return 0;
 435         end
 436
 437         show_message("Failed to start Prosody");
 438         show_message(error_messages[ret])
 439         return 1;
 440 end
 441
 442 function commands.status(arg)
 443         if arg[1] == "--help" then
 444                 show_usage([[status]], [[Reports the running status of Prosody]]);
 445                 return 1;
 446         end
 447
 448         local ok, ret = prosodyctl.isrunning();
 449         if not ok then
 450                 show_message(error_messages[ret]);
 451                 return 1;
 452         end
 453
 454         if ret then
 455                 local ok, ret = prosodyctl.getpid();
 456                 if not ok then
 457                         show_message("Couldn't get running Prosody's PID");
 458                         show_message(error_messages[ret]);
 459                         return 1;
 460                 end
 461                 show_message("Prosody is running with PID %s", ret or "(unknown)");
 462                 return 0;
 463         else
 464                 show_message("Prosody is not running");
 465                 if not switched_user and current_uid ~= 0 then
 466                         print("\nNote:")
 467                         print(" You will also see this if prosodyctl is not running under");
 468                         print(" the same user account as Prosody. Try running as root (e.g. ");
 469                         print(" with 'sudo' in front) to gain access to Prosody's real status.");
 470                 end
 471                 return 2
 472         end
 473         return 1;
 474 end
 475
 476 function commands.stop(arg)
 477         if arg[1] == "--help" then
 478                 show_usage([[stop]], [[Stop a running Prosody server]]);
 479                 return 1;
 480         end
 481
 482         if not prosodyctl.isrunning() then
 483                 show_message("Prosody is not running");
 484                 return 1;
 485         end
 486
 487         local ok, ret = prosodyctl.stop();
 488         if ok then
 489                 local i=1;
 490                 while true do
 491                         local ok, running = prosodyctl.isrunning();
 492                         if ok and not running then
 493                                 break;
 494                         elseif i == 5 then
 495                                 show_message("Still waiting...");
 496                         elseif i >= prosodyctl_timeout then
 497                                 show_message("Prosody is still running. Please give it some time or check your log files for errors.");
 498                                 return 2;
 499                         end
 500                         socket.sleep(0.5);
 501                         i = i + 1;
 502                 end
 503                 show_message("Stopped");
 504                 return 0;
 505         end
 506
 507         show_message(error_messages[ret]);
 508         return 1;
 509 end
 510
 511 function commands.restart(arg)
 512         if arg[1] == "--help" then
 513                 show_usage([[restart]], [[Restart a running Prosody server]]);
 514                 return 1;
 515         end
 516
 517         commands.stop(arg);
 518         return commands.start(arg);
 519 end
 520
 521 function commands.about(arg)
 522         read_version();
 523         if arg[1] == "--help" then
 524                 show_usage([[about]], [[Show information about this Prosody installation]]);
 525                 return 1;
 526         end
 527
 528         local array = require "util.array";
 529         local keys = require "util.iterators".keys;
 530
 531         print("Prosody "..(prosody.version or "(unknown version)"));
 532         print("");
 533         print("# Prosody directories");
 534         print("Data directory:  ", CFG_DATADIR or "./");
 535         print("Plugin directory:", CFG_PLUGINDIR or "./");
 536         print("Config directory:", CFG_CONFIGDIR or "./");
 537         print("Source directory:", CFG_SOURCEDIR or "./");
 538         print("");
 539         print("# Lua environment");
 540         print("Lua version:             ", _G._VERSION);
 541         print("");
 542         print("Lua module search paths:");
 543         for path in package.path:gmatch("[^;]+") do
 544                 print("  "..path);
 545         end
 546         print("");
 547         print("Lua C module search paths:");
 548         for path in package.cpath:gmatch("[^;]+") do
 549                 print("  "..path);
 550         end
 551         print("");
 552         local luarocks_status = (pcall(require, "luarocks.loader") and "Installed ("..(luarocks.cfg.program_version or "2.x+")..")")
 553                 or (pcall(require, "luarocks.require") and "Installed (1.x)")
 554                 or "Not installed";
 555         print("LuaRocks:        ", luarocks_status);
 556         print("");
 557         print("# Lua module versions");
 558         local module_versions, longest_name = {}, 8;
 559         for name, module in pairs(package.loaded) do
 560                 if type(module) == "table" and rawget(module, "_VERSION")
 561                 and name ~= "_G" and not name:match("%.") then
 562                         if #name > longest_name then
 563                                 longest_name = #name;
 564                         end
 565                         module_versions[name] = module._VERSION;
 566                 end
 567         end
 568         local sorted_keys = array.collect(keys(module_versions)):sort();
 569         for _, name in ipairs(array.collect(keys(module_versions)):sort()) do
 570                 print(name..":"..string.rep(" ", longest_name-#name), module_versions[name]);
 571         end
 572         print("");
 573 end
 574
 575 function commands.reload(arg)
 576         if arg[1] == "--help" then
 577                 show_usage([[reload]], [[Reload Prosody's configuration and re-open log files]]);
 578                 return 1;
 579         end
 580
 581         if not prosodyctl.isrunning() then
 582                 show_message("Prosody is not running");
 583                 return 1;
 584         end
 585
 586         local ok, ret = prosodyctl.reload();
 587         if ok then
 588
 589                 show_message("Prosody log files re-opened and config file reloaded. You may need to reload modules for some changes to take effect.");
 590                 return 0;
 591         end
 592
 593         show_message(error_messages[ret]);
 594         return 1;
 595 end
 596 -- ejabberdctl compatibility
 597
 598 function commands.register(arg)
 599         local user, host, password = unpack(arg);
 600         if (not (user and host)) or arg[1] == "--help" then
 601                 if user ~= "--help" then
 602                         if not user then
 603                                 show_message [[No username specified]]
 604                         elseif not host then
 605                                 show_message [[Please specify which host you want to register the user on]];
 606                         end
 607                 end
 608                 show_usage("register USER HOST [PASSWORD]", "Register a user on the server, with the given password");
 609                 return 1;
 610         end
 611         if not password then
 612                 password = read_password();
 613                 if not password then
 614                         show_message [[Unable to register user with no password]];
 615                         return 1;
 616                 end
 617         end
 618
 619         local ok, msg = prosodyctl.adduser { user = user, host = host, password = password };
 620
 621         if ok then return 0; end
 622
 623         show_message(error_messages[msg])
 624         return 1;
 625 end
 626
 627 function commands.unregister(arg)
 628         local user, host = unpack(arg);
 629         if (not (user and host)) or arg[1] == "--help" then
 630                 if user ~= "--help" then
 631                         if not user then
 632                                 show_message [[No username specified]]
 633                         elseif not host then
 634                                 show_message [[Please specify which host you want to unregister the user from]];
 635                         end
 636                 end
 637                 show_usage("unregister USER HOST [PASSWORD]", "Permanently remove a user account from the server");
 638                 return 1;
 639         end
 640
 641         local ok, msg = prosodyctl.deluser { user = user, host = host };
 642
 643         if ok then return 0; end
 644
 645         show_message(error_messages[msg])
 646         return 1;
 647 end
 648
 649 local openssl;
 650 local lfs;
 651
 652 local cert_commands = {};
 653
 654 local function ask_overwrite(filename)
 655         return lfs.attributes(filename) and not show_yesno("Overwrite "..filename .. "?");
 656 end
 657
 658 function cert_commands.config(arg)
 659         if #arg >= 1 and arg[1] ~= "--help" then
 660                 local conf_filename = (CFG_DATADIR or "./certs") .. "/" .. arg[1] .. ".cnf";
 661                 if ask_overwrite(conf_filename) then
 662                         return nil, conf_filename;
 663                 end
 664                 local conf = openssl.config.new();
 665                 conf:from_prosody(hosts, config, arg);
 666                 show_message("Please provide details to include in the certificate config file.");
 667                 show_message("Leave the field empty to use the default value or '.' to exclude the field.")
 668                 for i, k in ipairs(openssl._DN_order) do
 669                         local v = conf.distinguished_name[k];
 670                         if v then
 671                                 local nv;
 672                                 if k == "commonName" then
 673                                         v = arg[1]
 674                                 elseif k == "emailAddress" then
 675                                         v = "xmpp@" .. arg[1];
 676                                 elseif k == "countryName" then
 677                                         local tld = arg[1]:match"%.([a-z]+)$";
 678                                         if tld and #tld == 2 and tld ~= "uk" then
 679                                                 v = tld:upper();
 680                                         end
 681                                 end
 682                                 nv = show_prompt(("%s (%s):"):format(k, nv or v));
 683                                 nv = (not nv or nv == "") and v or nv;
 684                                 if nv:find"[\192-\252][\128-\191]+" then
 685                                         conf.req.string_mask = "utf8only"
 686                                 end
 687                                 conf.distinguished_name[k] = nv ~= "." and nv or nil;
 688                         end
 689                 end
 690                 local conf_file = io.open(conf_filename, "w");
 691                 conf_file:write(conf:serialize());
 692                 conf_file:close();
 693                 print("");
 694                 show_message("Config written to " .. conf_filename);
 695                 return nil, conf_filename;
 696         else
 697                 show_usage("cert config HOSTNAME [HOSTNAME+]", "Builds a certificate config file covering the supplied hostname(s)")
 698         end
 699 end
 700
 701 function cert_commands.key(arg)
 702         if #arg >= 1 and arg[1] ~= "--help" then
 703                 local key_filename = (CFG_DATADIR or "./certs") .. "/" .. arg[1] .. ".key";
 704                 if ask_overwrite(key_filename) then
 705                         return nil, key_filename;
 706                 end
 707                 os.remove(key_filename); -- This file, if it exists is unlikely to have write permissions
 708                 local key_size = tonumber(arg[2] or show_prompt("Choose key size (2048):") or 2048);
 709                 local old_umask = pposix.umask("0377");
 710                 if openssl.genrsa{out=key_filename, key_size} then
 711                         os.execute(("chmod 400 '%s'"):format(key_filename));
 712                         show_message("Key written to ".. key_filename);
 713                         pposix.umask(old_umask);
 714                         return nil, key_filename;
 715                 end
 716                 show_message("There was a problem, see OpenSSL output");
 717         else
 718                 show_usage("cert key HOSTNAME <bits>", "Generates a RSA key named HOSTNAME.key\n "
 719                 .."Prompts for a key size if none given")
 720         end
 721 end
 722
 723 function cert_commands.request(arg)
 724         if #arg >= 1 and arg[1] ~= "--help" then
 725                 local req_filename = (CFG_DATADIR or "./certs") .. "/" .. arg[1] .. ".req";
 726                 if ask_overwrite(req_filename) then
 727                         return nil, req_filename;
 728                 end
 729                 local _, key_filename = cert_commands.key({arg[1]});
 730                 local _, conf_filename = cert_commands.config(arg);
 731                 if openssl.req{new=true, key=key_filename, utf8=true, config=conf_filename, out=req_filename} then
 732                         show_message("Certificate request written to ".. req_filename);
 733                 else
 734                         show_message("There was a problem, see OpenSSL output");
 735                 end
 736         else
 737                 show_usage("cert request HOSTNAME [HOSTNAME+]", "Generates a certificate request for the supplied hostname(s)")
 738         end
 739 end
 740
 741 function cert_commands.generate(arg)
 742         if #arg >= 1 and arg[1] ~= "--help" then
 743                 local cert_filename = (CFG_DATADIR or "./certs") .. "/" .. arg[1] .. ".crt";
 744                 if ask_overwrite(cert_filename) then
 745                         return nil, cert_filename;
 746                 end
 747                 local _, key_filename = cert_commands.key({arg[1]});
 748                 local _, conf_filename = cert_commands.config(arg);
 749                 local ret;
 750                 if key_filename and conf_filename and cert_filename
 751                         and openssl.req{new=true, x509=true, nodes=true, key=key_filename,
 752                                 days=365, sha1=true, utf8=true, config=conf_filename, out=cert_filename} then
 753                         show_message("Certificate written to ".. cert_filename);
 754                 else
 755                         show_message("There was a problem, see OpenSSL output");
 756                 end
 757         else
 758                 show_usage("cert generate HOSTNAME [HOSTNAME+]", "Generates a self-signed certificate for the current hostname(s)")
 759         end
 760 end
 761
 762 function commands.cert(arg)
 763         if #arg >= 1 and arg[1] ~= "--help" then
 764                 openssl = require "util.openssl";
 765                 lfs = require "lfs";
 766                 local subcmd = table.remove(arg, 1);
 767                 if type(cert_commands[subcmd]) == "function" then
 768                         if not arg[1] then
 769                                 show_message"You need to supply at least one hostname"
 770                                 arg = { "--help" };
 771                         end
 772                         if arg[1] ~= "--help" and not hosts[arg[1]] then
 773                                 show_message(error_messages["no-such-host"]);
 774                                 return
 775                         end
 776                         return cert_commands[subcmd](arg);
 777                 end
 778         end
 779         show_usage("cert config|request|generate|key", "Helpers for generating X.509 certificates and keys.")
 780 end
 781
 782 function commands.check(arg)
 783         if arg[1] == "--help" then
 784                 show_usage([[check]], [[Perform basic checks on your Prosody installation]]);
 785                 return 1;
 786         end
 787         local what = table.remove(arg, 1);
 788         local array, set = require "util.array", require "util.set";
 789         local it = require "util.iterators";
 790         local ok = true;
 791         if not what or what == "config" then
 792                 print("Checking config...");
 793                 local known_global_options = set.new({
 794                         "pidfile", "log", "plugin_paths", "prosody_user", "prosody_group", "daemonize",
 795                         "umask", "prosodyctl_timeout", "use_ipv6", "use_libevent", "network_settings"
 796                 });
 797                 local config = config.getconfig();
 798                 -- Check that we have any global options (caused by putting a host at the top)
 799                 if it.count(it.filter("log", pairs(config["*"]))) == 0 then
 800                         ok = false;
 801                         print("");
 802                         print("    No global options defined. Perhaps you have put a host definition at the top")
 803                         print("    of the config file? They should be at the bottom, see http://prosody.im/doc/configure#overview");
 804                 end
 805                 -- Check for global options under hosts
 806                 local global_options = set.new(it.to_array(it.keys(config["*"])));
 807                 for host, options in it.filter("*", pairs(config)) do
 808                         local host_options = set.new(it.to_array(it.keys(options)));
 809                         local misplaced_options = set.intersection(host_options, known_global_options);
 810                         for name in pairs(options) do
 811                                 if name:match("^interfaces?")
 812                                 or name:match("_ports?$") or name:match("_interfaces?$")
 813                                 or name:match("_ssl$") then
 814                                         misplaced_options:add(name);
 815                                 end
 816                         end
 817                         if not misplaced_options:empty() then
 818                                 ok = false;
 819                                 print("");
 820                                 local n = it.count(misplaced_options);
 821                                 print("    You have "..n.." option"..(n>1 and "s " or " ").."set under "..host.." that should be");
 822                                 print("    in the global section of the config file, above any VirtualHost or Component definitions,")
 823                                 print("    see http://prosody.im/doc/configure#overview for more information.")
 824                                 print("");
 825                                 print("    You need to move the following option"..(n>1 and "s" or "")..": "..table.concat(it.to_array(misplaced_options), ", "));
 826                         end
 827                         local subdomain = host:match("^[^.]+");
 828                         if not(host_options:contains("component_module")) and (subdomain == "jabber" or subdomain == "xmpp"
 829                            or subdomain == "chat" or subdomain == "im") then
 830                                 print("");
 831                                 print("    Suggestion: If "..host.. " is a new host with no real users yet, consider renaming it now to");
 832                                 print("     "..host:gsub("^[^.]+%.", "")..". You can use SRV records to redirect XMPP clients and servers to "..host..".");
 833                                 print("     For more information see: http://prosody.im/doc/dns");
 834                         end
 835                 end
 836
 837                 print("Done.\n");
 838         end
 839         if not what or what == "dns" then
 840                 local dns = require "net.dns";
 841                 local ip = require "util.ip";
 842                 local c2s_ports = set.new(config.get("*", "c2s_ports") or {5222});
 843                 local s2s_ports = set.new(config.get("*", "s2s_ports") or {5269});
 844
 845                 local c2s_srv_required, s2s_srv_required;
 846                 if not c2s_ports:contains(5222) then
 847                         c2s_srv_required = true;
 848                 end
 849                 if not s2s_ports:contains(5269) then
 850                         s2s_srv_required = true;
 851                 end
 852
 853                 local problem_hosts = set.new();
 854
 855                 local external_addresses, internal_addresses = set.new(), set.new();
 856
 857                 local fqdn = socket.dns.tohostname(socket.dns.gethostname());
 858                 if fqdn then
 859                         local res = dns.lookup(fqdn, "A");
 860                         if res then
 861                                 for _, record in ipairs(res) do
 862                                         external_addresses:add(record.a);
 863                                 end
 864                         end
 865                         local res = dns.lookup(fqdn, "AAAA");
 866                         if res then
 867                                 for _, record in ipairs(res) do
 868                                         external_addresses:add(record.aaaa);
 869                                 end
 870                         end
 871                 end
 872
 873                 local local_addresses = require"util.net".local_addresses() or {};
 874
 875                 for addr in it.values(local_addresses) do
 876                         if not ip.new_ip(addr).private then
 877                                 external_addresses:add(addr);
 878                         else
 879                                 internal_addresses:add(addr);
 880                         end
 881                 end
 882
 883                 if external_addresses:empty() then
 884                         print("");
 885                         print("   Failed to determine the external addresses of this server. Checks may be inaccurate.");
 886                         c2s_srv_required, s2s_srv_required = true, true;
 887                 end
 888
 889                 local v6_supported = not not socket.tcp6;
 890
 891                 for host, host_options in it.filter("*", pairs(config.getconfig())) do
 892                         local all_targets_ok, some_targets_ok = true, false;
 893
 894                         local is_component = not not host_options.component_module;
 895                         print("Checking DNS for "..(is_component and "component" or "host").." "..host.."...");
 896                         local target_hosts = set.new();
 897                         if not is_component then
 898                                 local res = dns.lookup("_xmpp-client._tcp."..host..".", "SRV");
 899                                 if res then
 900                                         for _, record in ipairs(res) do
 901                                                 target_hosts:add(record.srv.target);
 902                                                 if not c2s_ports:contains(record.srv.port) then
 903                                                         print("    SRV target "..record.srv.target.." contains unknown client port: "..record.srv.port);
 904                                                 end
 905                                         end
 906                                 else
 907                                         if c2s_srv_required then
 908                                                 print("    No _xmpp-client SRV record found for "..host..", but it looks like you need one.");
 909                                                 all_targst_ok = false;
 910                                         else
 911                                                 target_hosts:add(host);
 912                                         end
 913                                 end
 914                         end
 915                         local res = dns.lookup("_xmpp-server._tcp."..host..".", "SRV");
 916                         if res then
 917                                 for _, record in ipairs(res) do
 918                                         target_hosts:add(record.srv.target);
 919                                         if not s2s_ports:contains(record.srv.port) then
 920                                                 print("    SRV target "..record.srv.target.." contains unknown server port: "..record.srv.port);
 921                                         end
 922                                 end
 923                         else
 924                                 if s2s_srv_required then
 925                                         print("    No _xmpp-server SRV record found for "..host..", but it looks like you need one.");
 926                                         all_targets_ok = false;
 927                                 else
 928                                         target_hosts:add(host);
 929                                 end
 930                         end
 931                         if target_hosts:empty() then
 932                                 target_hosts:add(host);
 933                         end
 934
 935                         if target_hosts:contains("localhost") then
 936                                 print("    Target 'localhost' cannot be accessed from other servers");
 937                                 target_hosts:remove("localhost");
 938                         end
 939
 940                         local modules = set.new(it.to_array(it.values(host_options.modules_enabled)))
 941                                         + set.new(it.to_array(it.values(config.get("*", "modules_enabled"))))
 942                                         + set.new({ config.get(host, "component_module") });
 943
 944                         if modules:contains("proxy65") then
 945                                 local proxy65_target = config.get(host, "proxy65_address") or host;
 946                                 local A, AAAA = dns.lookup(proxy65_target, "A"), dns.lookup(proxy65_target, "AAAA");
 947                                 local prob = {};
 948                                 if not A then
 949                                         table.insert(prob, "A");
 950                                 end
 951                                 if v6_supported and not AAAA then
 952                                         table.insert(prob, "AAAA");
 953                                 end
 954                                 if #prob > 0 then
 955                                         print("    File transfer proxy "..proxy65_target.." has no "..table.concat(prob, "/").." record. Create one or set 'proxy65_address' to the correct host/IP.");
 956                                 end
 957                         end
 958
 959                         for host in target_hosts do
 960                                 local host_ok_v4, host_ok_v6;
 961                                 local res = dns.lookup(host, "A");
 962                                 if res then
 963                                         for _, record in ipairs(res) do
 964                                                 if external_addresses:contains(record.a) then
 965                                                         some_targets_ok = true;
 966                                                         host_ok_v4 = true;
 967                                                 elseif internal_addresses:contains(record.a) then
 968                                                         host_ok_v4 = true;
 969                                                         some_targets_ok = true;
 970                                                         print("    "..host.." A record points to internal address, external connections might fail");
 971                                                 else
 972                                                         print("    "..host.." A record points to unknown address "..record.a);
 973                                                         all_targets_ok = false;
 974                                                 end
 975                                         end
 976                                 end
 977                                 local res = dns.lookup(host, "AAAA");
 978                                 if res then
 979                                         for _, record in ipairs(res) do
 980                                                 if external_addresses:contains(record.aaaa) then
 981                                                         some_targets_ok = true;
 982                                                         host_ok_v6 = true;
 983                                                 elseif internal_addresses:contains(record.aaaa) then
 984                                                         host_ok_v6 = true;
 985                                                         some_targets_ok = true;
 986                                                         print("    "..host.." AAAA record points to internal address, external connections might fail");
 987                                                 else
 988                                                         print("    "..host.." AAAA record points to unknown address "..record.aaaa);
 989                                                         all_targets_ok = false;
 990                                                 end
 991                                         end
 992                                 end
 993
 994                                 local bad_protos = {}
 995                                 if not host_ok_v4 then
 996                                         table.insert(bad_protos, "IPv4");
 997                                 end
 998                                 if not host_ok_v6 then
 999                                         table.insert(bad_protos, "IPv6");
1000                                 end
1001                                 if #bad_protos > 0 then
1002                                         print("    Host "..host.." does not seem to resolve to this server ("..table.concat(bad_protos, "/")..")");
1003                                 end
1004                                 if host_ok_v6 and not v6_supported then
1005                                         print("    Host "..host.." has AAAA records, but your version of LuaSocket does not support IPv6.");
1006                                         print("      Please see http://prosody.im/doc/ipv6 for more information.");
1007                                 end
1008                         end
1009                         if not all_targets_ok then
1010                                 print("    "..(some_targets_ok and "Only some" or "No").." targets for "..host.." appear to resolve to this server.");
1011                                 if is_component then
1012                                         print("    DNS records are necessary if you want users on other servers to access this component.");
1013                                 end
1014                                 problem_hosts:add(host);
1015                         end
1016                         print("");
1017                 end
1018                 if not problem_hosts:empty() then
1019                         print("");
1020                         print("For more information about DNS configuration please see http://prosody.im/doc/dns");
1021                         print("");
1022                         ok = false;
1023                 end
1024         end
1025         if not what or what == "certs" then
1026                 local cert_ok;
1027                 print"Checking certificates..."
1028                 local x509_verify_identity = require"util.x509".verify_identity;
1029                 local ssl = dependencies.softreq"ssl";
1030                 -- local datetime_parse = require"util.datetime".parse_x509;
1031                 local load_cert = ssl and ssl.x509 and ssl.x509.load;
1032                 -- or ssl.cert_from_pem
1033                 if not ssl then
1034                         print("LuaSec not available, can't perform certificate checks")
1035                         if what == "certs" then cert_ok = false end
1036                 elseif not load_cert then
1037                         print("This version of LuaSec (" .. ssl._VERSION .. ") does not support certificate checking");
1038                         cert_ok = false
1039                 else
1040                         for host in pairs(hosts) do
1041                                 if host ~= "*" then -- Should check global certs too.
1042                                         print("Checking certificate for "..host);
1043                                         -- First, let's find out what certificate this host uses.
1044                                         local ssl_config = config.rawget(host, "ssl");
1045                                         if not ssl_config then
1046                                                 local base_host = host:match("%.(.*)");
1047                                                 ssl_config = config.get(base_host, "ssl");
1048                                         end
1049                                         if not ssl_config then
1050                                                 print("  No 'ssl' option defined for "..host)
1051                                                 cert_ok = false
1052                                         elseif not ssl_config.certificate then
1053                                                 print("  No 'certificate' set in ssl option for "..host)
1054                                                 cert_ok = false
1055                                         elseif not ssl_config.key then
1056                                                 print("  No 'key' set in ssl option for "..host)
1057                                                 cert_ok = false
1058                                         else
1059                                                 local key, err = io.open(ssl_config.key); -- Permissions check only
1060                                                 if not key then
1061                                                         print("    Could not open "..ssl_config.key..": "..err);
1062                                                         cert_ok = false
1063                                                 else
1064                                                         key:close();
1065                                                 end
1066                                                 local cert_fh, err = io.open(ssl_config.certificate); -- Load the file.
1067                                                 if not cert_fh then
1068                                                         print("    Could not open "..ssl_config.certificate..": "..err);
1069                                                         cert_ok = false
1070                                                 else
1071                                                         print("  Certificate: "..ssl_config.certificate)
1072                                                         local cert = load_cert(cert_fh:read"*a"); cert_fh = cert_fh:close();
1073                                                         if not cert:validat(os.time()) then
1074                                                                 print("    Certificate has expired.")
1075                                                                 cert_ok = false
1076                                                         end
1077                                                         if config.get(host, "component_module") == nil
1078                                                         and not x509_verify_identity(host, "_xmpp-client", cert) then
1079                                                                 print("    Not vaild for client connections to "..host..".")
1080                                                                 cert_ok = false
1081                                                         end
1082                                                         if (not (config.get(name, "anonymous_login")
1083                                                                 or config.get(name, "authentication") == "anonymous"))
1084                                                         and not x509_verify_identity(host, "_xmpp-client", cert) then
1085                                                                 print("    Not vaild for server-to-server connections to "..host..".")
1086                                                                 cert_ok = false
1087                                                         end
1088                                                 end
1089                                         end
1090                                 end
1091                         end
1092                         if cert_ok == false then
1093                                 print("")
1094                                 print("For more information about certificates please see http://prosody.im/doc/certificates");
1095                                 ok = false
1096                         end
1097                 end
1098                 print("")
1099         end
1100         if not ok then
1101                 print("Problems found, see above.");
1102         else
1103                 print("All checks passed, congratulations!");
1104         end
1105         return ok and 0 or 2;
1106 end
1107
1108 ---------------------
1109
1110 if command and command:match("^mod_") then -- Is a command in a module
1111         local module_name = command:match("^mod_(.+)");
1112         local ret, err = modulemanager.load("*", module_name);
1113         if not ret then
1114                 show_message("Failed to load module '"..module_name.."': "..err);
1115                 os.exit(1);
1116         end
1117
1118         table.remove(arg, 1);
1119
1120         local module = modulemanager.get_module("*", module_name);
1121         if not module then
1122                 show_message("Failed to load module '"..module_name.."': Unknown error");
1123                 os.exit(1);
1124         end
1125
1126         if not modulemanager.module_has_method(module, "command") then
1127                 show_message("Fail: mod_"..module_name.." does not support any commands");
1128                 os.exit(1);
1129         end
1130
1131         local ok, ret = modulemanager.call_module_method(module, "command", arg);
1132         if ok then
1133                 if type(ret) == "number" then
1134                         os.exit(ret);
1135                 elseif type(ret) == "string" then
1136                         show_message(ret);
1137                 end
1138                 os.exit(0); -- :)
1139         else
1140                 show_message("Failed to execute command: "..error_messages[ret]);
1141                 os.exit(1); -- :(
1142         end
1143 end
1144
1145 if not commands[command] then -- Show help for all commands
1146         function show_usage(usage, desc)
1147                 print(" "..usage);
1148                 print("    "..desc);
1149         end
1150
1151         print("prosodyctl - Manage a Prosody server");
1152         print("");
1153         print("Usage: "..arg[0].." COMMAND [OPTIONS]");
1154         print("");
1155         print("Where COMMAND may be one of:\n");
1156
1157         local hidden_commands = require "util.set".new{ "register", "unregister", "addplugin" };
1158         local commands_order = { "adduser", "passwd", "deluser", "start", "stop", "restart", "reload", "about" };
1159
1160         local done = {};
1161
1162         for _, command_name in ipairs(commands_order) do
1163                 local command = commands[command_name];
1164                 if command then
1165                         command{ "--help" };
1166                         print""
1167                         done[command_name] = true;
1168                 end
1169         end
1170
1171         for command_name, command in pairs(commands) do
1172                 if not done[command_name] and not hidden_commands:contains(command_name) then
1173                         command{ "--help" };
1174                         print""
1175                         done[command_name] = true;
1176                 end
1177         end
1178
1179
1180         os.exit(0);
1181 end
1182
1183 os.exit(commands[command]({ select(2, unpack(arg)) }));