Merge 0.9->0.10 (third time lucky)
[prosody.git] / 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 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                         hgrepo = hgrepo == "010452cfaf53" and "prosody-modules";
556                         return path..(hgid and " - "..(hgrepo or "HG").." rev: "..hgid or "")
557                                 .."\n  ";
558                 end)));
559         print("");
560         print("# Lua environment");
561         print("Lua version:             ", _G._VERSION);
562         print("");
563         print("Lua module search paths:");
564         for path in package.path:gmatch("[^;]+") do
565                 print("  "..path);
566         end
567         print("");
568         print("Lua C module search paths:");
569         for path in package.cpath:gmatch("[^;]+") do
570                 print("  "..path);
571         end
572         print("");
573         local luarocks_status = (pcall(require, "luarocks.loader") and "Installed ("..(package.loaded["luarocks.cfg"].program_version or "2.x+")..")")
574                 or (pcall(require, "luarocks.require") and "Installed (1.x)")
575                 or "Not installed";
576         print("LuaRocks:        ", luarocks_status);
577         print("");
578         print("# Lua module versions");
579         local module_versions, longest_name = {}, 8;
580         for name, module in pairs(package.loaded) do
581                 if type(module) == "table" and rawget(module, "_VERSION")
582                 and name ~= "_G" and not name:match("%.") then
583                         if #name > longest_name then
584                                 longest_name = #name;
585                         end
586                         module_versions[name] = module._VERSION;
587                 end
588         end
589         local sorted_keys = array.collect(keys(module_versions)):sort();
590         for _, name in ipairs(array.collect(keys(module_versions)):sort()) do
591                 print(name..":"..string.rep(" ", longest_name-#name), module_versions[name]);
592         end
593         print("");
594 end
595
596 function commands.reload(arg)
597         if arg[1] == "--help" then
598                 show_usage([[reload]], [[Reload Prosody's configuration and re-open log files]]);
599                 return 1;
600         end
601
602         if not prosodyctl.isrunning() then
603                 show_message("Prosody is not running");
604                 return 1;
605         end
606         
607         local ok, ret = prosodyctl.reload();
608         if ok then
609                 
610                 show_message("Prosody log files re-opened and config file reloaded. You may need to reload modules for some changes to take effect.");
611                 return 0;
612         end
613
614         show_message(error_messages[ret]);
615         return 1;
616 end
617 -- ejabberdctl compatibility
618
619 function commands.register(arg)
620         local user, host, password = unpack(arg);
621         if (not (user and host)) or arg[1] == "--help" then
622                 if user ~= "--help" then
623                         if not user then
624                                 show_message [[No username specified]]
625                         elseif not host then
626                                 show_message [[Please specify which host you want to register the user on]];
627                         end
628                 end
629                 show_usage("register USER HOST [PASSWORD]", "Register a user on the server, with the given password");
630                 return 1;
631         end
632         if not password then
633                 password = read_password();
634                 if not password then
635                         show_message [[Unable to register user with no password]];
636                         return 1;
637                 end
638         end
639         
640         local ok, msg = prosodyctl.adduser { user = user, host = host, password = password };
641         
642         if ok then return 0; end
643         
644         show_message(error_messages[msg])
645         return 1;
646 end
647
648 function commands.unregister(arg)
649         local user, host = unpack(arg);
650         if (not (user and host)) or arg[1] == "--help" then
651                 if user ~= "--help" then
652                         if not user then
653                                 show_message [[No username specified]]
654                         elseif not host then
655                                 show_message [[Please specify which host you want to unregister the user from]];
656                         end
657                 end
658                 show_usage("unregister USER HOST [PASSWORD]", "Permanently remove a user account from the server");
659                 return 1;
660         end
661
662         local ok, msg = prosodyctl.deluser { user = user, host = host };
663         
664         if ok then return 0; end
665         
666         show_message(error_messages[msg])
667         return 1;
668 end
669
670 local openssl;
671 local lfs;
672
673 local cert_commands = {};
674
675 local function ask_overwrite(filename)
676         return lfs.attributes(filename) and not show_yesno("Overwrite "..filename .. "?");
677 end
678
679 function cert_commands.config(arg)
680         if #arg >= 1 and arg[1] ~= "--help" then
681                 local conf_filename = (CFG_DATADIR or "./certs") .. "/" .. arg[1] .. ".cnf";
682                 if ask_overwrite(conf_filename) then
683                         return nil, conf_filename;
684                 end
685                 local conf = openssl.config.new();
686                 conf:from_prosody(hosts, config, arg);
687                 show_message("Please provide details to include in the certificate config file.");
688                 show_message("Leave the field empty to use the default value or '.' to exclude the field.")
689                 for i, k in ipairs(openssl._DN_order) do
690                         local v = conf.distinguished_name[k];
691                         if v then
692                                 local nv;
693                                 if k == "commonName" then
694                                         v = arg[1]
695                                 elseif k == "emailAddress" then
696                                         v = "xmpp@" .. arg[1];
697                                 elseif k == "countryName" then
698                                         local tld = arg[1]:match"%.([a-z]+)$";
699                                         if tld and #tld == 2 and tld ~= "uk" then
700                                                 v = tld:upper();
701                                         end
702                                 end
703                                 nv = show_prompt(("%s (%s):"):format(k, nv or v));
704                                 nv = (not nv or nv == "") and v or nv;
705                                 if nv:find"[\192-\252][\128-\191]+" then
706                                         conf.req.string_mask = "utf8only"
707                                 end
708                                 conf.distinguished_name[k] = nv ~= "." and nv or nil;
709                         end
710                 end
711                 local conf_file, err = io.open(conf_filename, "w");
712                 if not conf_file then
713                         show_warning("Could not open OpenSSL config file for writing");
714                         show_warning(err);
715                         os.exit(1);
716                 end
717                 conf_file:write(conf:serialize());
718                 conf_file:close();
719                 print("");
720                 show_message("Config written to " .. conf_filename);
721                 return nil, conf_filename;
722         else
723                 show_usage("cert config HOSTNAME [HOSTNAME+]", "Builds a certificate config file covering the supplied hostname(s)")
724         end
725 end
726
727 function cert_commands.key(arg)
728         if #arg >= 1 and arg[1] ~= "--help" then
729                 local key_filename = (CFG_DATADIR or "./certs") .. "/" .. arg[1] .. ".key";
730                 if ask_overwrite(key_filename) then
731                         return nil, key_filename;
732                 end
733                 os.remove(key_filename); -- This file, if it exists is unlikely to have write permissions
734                 local key_size = tonumber(arg[2] or show_prompt("Choose key size (2048):") or 2048);
735                 local old_umask = pposix.umask("0377");
736                 if openssl.genrsa{out=key_filename, key_size} then
737                         os.execute(("chmod 400 '%s'"):format(key_filename));
738                         show_message("Key written to ".. key_filename);
739                         pposix.umask(old_umask);
740                         return nil, key_filename;
741                 end
742                 show_message("There was a problem, see OpenSSL output");
743         else
744                 show_usage("cert key HOSTNAME <bits>", "Generates a RSA key named HOSTNAME.key\n "
745                 .."Prompts for a key size if none given")
746         end
747 end
748
749 function cert_commands.request(arg)
750         if #arg >= 1 and arg[1] ~= "--help" then
751                 local req_filename = (CFG_DATADIR or "./certs") .. "/" .. arg[1] .. ".req";
752                 if ask_overwrite(req_filename) then
753                         return nil, req_filename;
754                 end
755                 local _, key_filename = cert_commands.key({arg[1]});
756                 local _, conf_filename = cert_commands.config(arg);
757                 if openssl.req{new=true, key=key_filename, utf8=true, sha256=true, config=conf_filename, out=req_filename} then
758                         show_message("Certificate request written to ".. req_filename);
759                 else
760                         show_message("There was a problem, see OpenSSL output");
761                 end
762         else
763                 show_usage("cert request HOSTNAME [HOSTNAME+]", "Generates a certificate request for the supplied hostname(s)")
764         end
765 end
766
767 function cert_commands.generate(arg)
768         if #arg >= 1 and arg[1] ~= "--help" then
769                 local cert_filename = (CFG_DATADIR or "./certs") .. "/" .. arg[1] .. ".crt";
770                 if ask_overwrite(cert_filename) then
771                         return nil, cert_filename;
772                 end
773                 local _, key_filename = cert_commands.key({arg[1]});
774                 local _, conf_filename = cert_commands.config(arg);
775                 local ret;
776                 if key_filename and conf_filename and cert_filename
777                         and openssl.req{new=true, x509=true, nodes=true, key=key_filename,
778                                 days=365, sha256=true, utf8=true, config=conf_filename, out=cert_filename} then
779                         show_message("Certificate written to ".. cert_filename);
780                 else
781                         show_message("There was a problem, see OpenSSL output");
782                 end
783         else
784                 show_usage("cert generate HOSTNAME [HOSTNAME+]", "Generates a self-signed certificate for the current hostname(s)")
785         end
786 end
787
788 function commands.cert(arg)
789         if #arg >= 1 and arg[1] ~= "--help" then
790                 openssl = require "util.openssl";
791                 lfs = require "lfs";
792                 local subcmd = table.remove(arg, 1);
793                 if type(cert_commands[subcmd]) == "function" then
794                         if not arg[1] then
795                                 show_message"You need to supply at least one hostname"
796                                 arg = { "--help" };
797                         end
798                         if arg[1] ~= "--help" and not hosts[arg[1]] then
799                                 show_message(error_messages["no-such-host"]);
800                                 return
801                         end
802                         return cert_commands[subcmd](arg);
803                 end
804         end
805         show_usage("cert config|request|generate|key", "Helpers for generating X.509 certificates and keys.")
806 end
807
808 function commands.check(arg)
809         if arg[1] == "--help" then
810                 show_usage([[check]], [[Perform basic checks on your Prosody installation]]);
811                 return 1;
812         end
813         local what = table.remove(arg, 1);
814         local array, set = require "util.array", require "util.set";
815         local it = require "util.iterators";
816         local ok = true;
817         local function disabled_hosts(host, conf) return host ~= "*" and conf.enabled ~= false; end
818         local function enabled_hosts() return it.filter(disabled_hosts, pairs(config.getconfig())); end
819         if not what or what == "disabled" then
820                 local disabled_hosts = set.new();
821                 for host, host_options in it.filter("*", pairs(config.getconfig())) do
822                         if host_options.enabled == false then
823                                 disabled_hosts:add(host);
824                         end
825                 end
826                 if not disabled_hosts:empty() then
827                         local msg = "Checks will be skipped for these disabled hosts: %s";
828                         if what then msg = "These hosts are disabled: %s"; end
829                         show_warning(msg, tostring(disabled_hosts));
830                         if what then return 0; end
831                         print""
832                 end
833         end
834         if not what or what == "config" then
835                 print("Checking config...");
836                 local deprecated = set.new({
837                         "bosh_ports", "disallow_s2s", "no_daemonize", "anonymous_login", "require_encryption",
838                 });
839                 local known_global_options = set.new({
840                         "pidfile", "log", "plugin_paths", "prosody_user", "prosody_group", "daemonize",
841                         "umask", "prosodyctl_timeout", "use_ipv6", "use_libevent", "network_settings"
842                 });
843                 local config = config.getconfig();
844                 -- Check that we have any global options (caused by putting a host at the top)
845                 if it.count(it.filter("log", pairs(config["*"]))) == 0 then
846                         ok = false;
847                         print("");
848                         print("    No global options defined. Perhaps you have put a host definition at the top")
849                         print("    of the config file? They should be at the bottom, see http://prosody.im/doc/configure#overview");
850                 end
851                 if it.count(enabled_hosts()) == 0 then
852                         ok = false;
853                         print("");
854                         if it.count(it.filter("*", pairs(config))) == 0 then
855                                 print("    No hosts are defined, please add at least one VirtualHost section")
856                         elseif config["*"]["enabled"] == false then
857                                 print("    No hosts are enabled. Remove enabled = false from the global section or put enabled = true under at least one VirtualHost section")
858                         else
859                                 print("    All hosts are disabled. Remove enabled = false from at least one VirtualHost section")
860                         end
861                 end
862                 -- Check for global options under hosts
863                 local global_options = set.new(it.to_array(it.keys(config["*"])));
864                 local deprecated_global_options = set.intersection(global_options, deprecated);
865                 if not deprecated_global_options:empty() then
866                         print("");
867                         print("    You have some deprecated options in the global section:");
868                         print("    "..tostring(deprecated_global_options))
869                         ok = false;
870                 end
871                 for host, options in enabled_hosts() do
872                         local host_options = set.new(it.to_array(it.keys(options)));
873                         local misplaced_options = set.intersection(host_options, known_global_options);
874                         for name in pairs(options) do
875                                 if name:match("^interfaces?")
876                                 or name:match("_ports?$") or name:match("_interfaces?$")
877                                 or name:match("_ssl$") then
878                                         misplaced_options:add(name);
879                                 end
880                         end
881                         if not misplaced_options:empty() then
882                                 ok = false;
883                                 print("");
884                                 local n = it.count(misplaced_options);
885                                 print("    You have "..n.." option"..(n>1 and "s " or " ").."set under "..host.." that should be");
886                                 print("    in the global section of the config file, above any VirtualHost or Component definitions,")
887                                 print("    see http://prosody.im/doc/configure#overview for more information.")
888                                 print("");
889                                 print("    You need to move the following option"..(n>1 and "s" or "")..": "..table.concat(it.to_array(misplaced_options), ", "));
890                         end
891                         local subdomain = host:match("^[^.]+");
892                         if not(host_options:contains("component_module")) and (subdomain == "jabber" or subdomain == "xmpp"
893                            or subdomain == "chat" or subdomain == "im") then
894                                 print("");
895                                 print("    Suggestion: If "..host.. " is a new host with no real users yet, consider renaming it now to");
896                                 print("     "..host:gsub("^[^.]+%.", "")..". You can use SRV records to redirect XMPP clients and servers to "..host..".");
897                                 print("     For more information see: http://prosody.im/doc/dns");
898                         end
899                 end
900                 
901                 print("Done.\n");
902         end
903         if not what or what == "dns" then
904                 local dns = require "net.dns";
905                 local idna = require "util.encodings".idna;
906                 local ip = require "util.ip";
907                 local c2s_ports = set.new(config.get("*", "c2s_ports") or {5222});
908                 local s2s_ports = set.new(config.get("*", "s2s_ports") or {5269});
909                 
910                 local c2s_srv_required, s2s_srv_required;
911                 if not c2s_ports:contains(5222) then
912                         c2s_srv_required = true;
913                 end
914                 if not s2s_ports:contains(5269) then
915                         s2s_srv_required = true;
916                 end
917                 
918                 local problem_hosts = set.new();
919                 
920                 local external_addresses, internal_addresses = set.new(), set.new();
921                 
922                 local fqdn = socket.dns.tohostname(socket.dns.gethostname());
923                 if fqdn then
924                         local res = dns.lookup(idna.to_ascii(fqdn), "A");
925                         if res then
926                                 for _, record in ipairs(res) do
927                                         external_addresses:add(record.a);
928                                 end
929                         end
930                         local res = dns.lookup(idna.to_ascii(fqdn), "AAAA");
931                         if res then
932                                 for _, record in ipairs(res) do
933                                         external_addresses:add(record.aaaa);
934                                 end
935                         end
936                 end
937                 
938                 local local_addresses = require"util.net".local_addresses() or {};
939                 
940                 for addr in it.values(local_addresses) do
941                         if not ip.new_ip(addr).private then
942                                 external_addresses:add(addr);
943                         else
944                                 internal_addresses:add(addr);
945                         end
946                 end
947                 
948                 if external_addresses:empty() then
949                         print("");
950                         print("   Failed to determine the external addresses of this server. Checks may be inaccurate.");
951                         c2s_srv_required, s2s_srv_required = true, true;
952                 end
953                 
954                 local v6_supported = not not socket.tcp6;
955                 
956                 for host, host_options in enabled_hosts() do
957                         local all_targets_ok, some_targets_ok = true, false;
958                         
959                         local is_component = not not host_options.component_module;
960                         print("Checking DNS for "..(is_component and "component" or "host").." "..host.."...");
961                         local target_hosts = set.new();
962                         if not is_component then
963                                 local res = dns.lookup("_xmpp-client._tcp."..idna.to_ascii(host)..".", "SRV");
964                                 if res then
965                                         for _, record in ipairs(res) do
966                                                 target_hosts:add(record.srv.target);
967                                                 if not c2s_ports:contains(record.srv.port) then
968                                                         print("    SRV target "..record.srv.target.." contains unknown client port: "..record.srv.port);
969                                                 end
970                                         end
971                                 else
972                                         if c2s_srv_required then
973                                                 print("    No _xmpp-client SRV record found for "..host..", but it looks like you need one.");
974                                                 all_targst_ok = false;
975                                         else
976                                                 target_hosts:add(host);
977                                         end
978                                 end
979                         end
980                         local res = dns.lookup("_xmpp-server._tcp."..idna.to_ascii(host)..".", "SRV");
981                         if res then
982                                 for _, record in ipairs(res) do
983                                         target_hosts:add(record.srv.target);
984                                         if not s2s_ports:contains(record.srv.port) then
985                                                 print("    SRV target "..record.srv.target.." contains unknown server port: "..record.srv.port);
986                                         end
987                                 end
988                         else
989                                 if s2s_srv_required then
990                                         print("    No _xmpp-server SRV record found for "..host..", but it looks like you need one.");
991                                         all_targets_ok = false;
992                                 else
993                                         target_hosts:add(host);
994                                 end
995                         end
996                         if target_hosts:empty() then
997                                 target_hosts:add(host);
998                         end
999                         
1000                         if target_hosts:contains("localhost") then
1001                                 print("    Target 'localhost' cannot be accessed from other servers");
1002                                 target_hosts:remove("localhost");
1003                         end
1004                         
1005                         local modules = set.new(it.to_array(it.values(host_options.modules_enabled)))
1006                                         + set.new(it.to_array(it.values(config.get("*", "modules_enabled"))))
1007                                         + set.new({ config.get(host, "component_module") });
1008
1009                         if modules:contains("proxy65") then
1010                                 local proxy65_target = config.get(host, "proxy65_address") or host;
1011                                 local A, AAAA = dns.lookup(idna.to_ascii(proxy65_target), "A"), dns.lookup(idna.to_ascii(proxy65_target), "AAAA");
1012                                 local prob = {};
1013                                 if not A then
1014                                         table.insert(prob, "A");
1015                                 end
1016                                 if v6_supported and not AAAA then
1017                                         table.insert(prob, "AAAA");
1018                                 end
1019                                 if #prob > 0 then
1020                                         print("    File transfer proxy "..proxy65_target.." has no "..table.concat(prob, "/").." record. Create one or set 'proxy65_address' to the correct host/IP.");
1021                                 end
1022                         end
1023                         
1024                         for host in target_hosts do
1025                                 local host_ok_v4, host_ok_v6;
1026                                 local res = dns.lookup(idna.to_ascii(host), "A");
1027                                 if res then
1028                                         for _, record in ipairs(res) do
1029                                                 if external_addresses:contains(record.a) then
1030                                                         some_targets_ok = true;
1031                                                         host_ok_v4 = true;
1032                                                 elseif internal_addresses:contains(record.a) then
1033                                                         host_ok_v4 = true;
1034                                                         some_targets_ok = true;
1035                                                         print("    "..host.." A record points to internal address, external connections might fail");
1036                                                 else
1037                                                         print("    "..host.." A record points to unknown address "..record.a);
1038                                                         all_targets_ok = false;
1039                                                 end
1040                                         end
1041                                 end
1042                                 local res = dns.lookup(idna.to_ascii(host), "AAAA");
1043                                 if res then
1044                                         for _, record in ipairs(res) do
1045                                                 if external_addresses:contains(record.aaaa) then
1046                                                         some_targets_ok = true;
1047                                                         host_ok_v6 = true;
1048                                                 elseif internal_addresses:contains(record.aaaa) then
1049                                                         host_ok_v6 = true;
1050                                                         some_targets_ok = true;
1051                                                         print("    "..host.." AAAA record points to internal address, external connections might fail");
1052                                                 else
1053                                                         print("    "..host.." AAAA record points to unknown address "..record.aaaa);
1054                                                         all_targets_ok = false;
1055                                                 end
1056                                         end
1057                                 end
1058                                 
1059                                 local bad_protos = {}
1060                                 if not host_ok_v4 then
1061                                         table.insert(bad_protos, "IPv4");
1062                                 end
1063                                 if not host_ok_v6 then
1064                                         table.insert(bad_protos, "IPv6");
1065                                 end
1066                                 if #bad_protos > 0 then
1067                                         print("    Host "..host.." does not seem to resolve to this server ("..table.concat(bad_protos, "/")..")");
1068                                 end
1069                                 if host_ok_v6 and not v6_supported then
1070                                         print("    Host "..host.." has AAAA records, but your version of LuaSocket does not support IPv6.");
1071                                         print("      Please see http://prosody.im/doc/ipv6 for more information.");
1072                                 end
1073                         end
1074                         if not all_targets_ok then
1075                                 print("    "..(some_targets_ok and "Only some" or "No").." targets for "..host.." appear to resolve to this server.");
1076                                 if is_component then
1077                                         print("    DNS records are necessary if you want users on other servers to access this component.");
1078                                 end
1079                                 problem_hosts:add(host);
1080                         end
1081                         print("");
1082                 end
1083                 if not problem_hosts:empty() then
1084                         print("");
1085                         print("For more information about DNS configuration please see http://prosody.im/doc/dns");
1086                         print("");
1087                         ok = false;
1088                 end
1089         end
1090         if not what or what == "certs" then
1091                 local cert_ok;
1092                 print"Checking certificates..."
1093                 local x509_verify_identity = require"util.x509".verify_identity;
1094                 local ssl = dependencies.softreq"ssl";
1095                 -- local datetime_parse = require"util.datetime".parse_x509;
1096                 local load_cert = ssl and ssl.x509 and ssl.x509.load;
1097                 -- or ssl.cert_from_pem
1098                 if not ssl then
1099                         print("LuaSec not available, can't perform certificate checks")
1100                         if what == "certs" then cert_ok = false end
1101                 elseif not load_cert then
1102                         print("This version of LuaSec (" .. ssl._VERSION .. ") does not support certificate checking");
1103                         cert_ok = false
1104                 else
1105                         for host in enabled_hosts() do
1106                                 print("Checking certificate for "..host);
1107                                 -- First, let's find out what certificate this host uses.
1108                                 local ssl_config = config.rawget(host, "ssl");
1109                                 if not ssl_config then
1110                                         local base_host = host:match("%.(.*)");
1111                                         ssl_config = config.get(base_host, "ssl");
1112                                 end
1113                                 if not ssl_config then
1114                                         print("  No 'ssl' option defined for "..host)
1115                                         cert_ok = false
1116                                 elseif not ssl_config.certificate then
1117                                         print("  No 'certificate' set in ssl option for "..host)
1118                                         cert_ok = false
1119                                 elseif not ssl_config.key then
1120                                         print("  No 'key' set in ssl option for "..host)
1121                                         cert_ok = false
1122                                 else
1123                                         local key, err = io.open(ssl_config.key); -- Permissions check only
1124                                         if not key then
1125                                                 print("    Could not open "..ssl_config.key..": "..err);
1126                                                 cert_ok = false
1127                                         else
1128                                                 key:close();
1129                                         end
1130                                         local cert_fh, err = io.open(ssl_config.certificate); -- Load the file.
1131                                         if not cert_fh then
1132                                                 print("    Could not open "..ssl_config.certificate..": "..err);
1133                                                 cert_ok = false
1134                                         else
1135                                                 print("  Certificate: "..ssl_config.certificate)
1136                                                 local cert = load_cert(cert_fh:read"*a"); cert_fh = cert_fh:close();
1137                                                 if not cert:validat(os.time()) then
1138                                                         print("    Certificate has expired.")
1139                                                         cert_ok = false
1140                                                 end
1141                                                 if config.get(host, "component_module") == nil
1142                                                         and not x509_verify_identity(host, "_xmpp-client", cert) then
1143                                                         print("    Not vaild for client connections to "..host..".")
1144                                                         cert_ok = false
1145                                                 end
1146                                                 if (not (config.get(host, "anonymous_login")
1147                                                         or config.get(host, "authentication") == "anonymous"))
1148                                                         and not x509_verify_identity(host, "_xmpp-client", cert) then
1149                                                         print("    Not vaild for server-to-server connections to "..host..".")
1150                                                         cert_ok = false
1151                                                 end
1152                                         end
1153                                 end
1154                         end
1155                         if cert_ok == false then
1156                                 print("")
1157                                 print("For more information about certificates please see http://prosody.im/doc/certificates");
1158                                 ok = false
1159                         end
1160                 end
1161                 print("")
1162         end
1163         if not ok then
1164                 print("Problems found, see above.");
1165         else
1166                 print("All checks passed, congratulations!");
1167         end
1168         return ok and 0 or 2;
1169 end
1170
1171 ---------------------
1172
1173 if command and command:match("^mod_") then -- Is a command in a module
1174         local module_name = command:match("^mod_(.+)");
1175         local ret, err = modulemanager.load("*", module_name);
1176         if not ret then
1177                 show_message("Failed to load module '"..module_name.."': "..err);
1178                 os.exit(1);
1179         end
1180         
1181         table.remove(arg, 1);
1182         
1183         local module = modulemanager.get_module("*", module_name);
1184         if not module then
1185                 show_message("Failed to load module '"..module_name.."': Unknown error");
1186                 os.exit(1);
1187         end
1188         
1189         if not modulemanager.module_has_method(module, "command") then
1190                 show_message("Fail: mod_"..module_name.." does not support any commands");
1191                 os.exit(1);
1192         end
1193         
1194         local ok, ret = modulemanager.call_module_method(module, "command", arg);
1195         if ok then
1196                 if type(ret) == "number" then
1197                         os.exit(ret);
1198                 elseif type(ret) == "string" then
1199                         show_message(ret);
1200                 end
1201                 os.exit(0); -- :)
1202         else
1203                 show_message("Failed to execute command: "..error_messages[ret]);
1204                 os.exit(1); -- :(
1205         end
1206 end
1207
1208 if not commands[command] then -- Show help for all commands
1209         function show_usage(usage, desc)
1210                 print(" "..usage);
1211                 print("    "..desc);
1212         end
1213
1214         print("prosodyctl - Manage a Prosody server");
1215         print("");
1216         print("Usage: "..arg[0].." COMMAND [OPTIONS]");
1217         print("");
1218         print("Where COMMAND may be one of:\n");
1219
1220         local hidden_commands = require "util.set".new{ "register", "unregister", "addplugin" };
1221         local commands_order = { "adduser", "passwd", "deluser", "start", "stop", "restart", "reload", "about" };
1222
1223         local done = {};
1224
1225         for _, command_name in ipairs(commands_order) do
1226                 local command = commands[command_name];
1227                 if command then
1228                         command{ "--help" };
1229                         print""
1230                         done[command_name] = true;
1231                 end
1232         end
1233
1234         for command_name, command in pairs(commands) do
1235                 if not done[command_name] and not hidden_commands:contains(command_name) then
1236                         command{ "--help" };
1237                         print""
1238                         done[command_name] = true;
1239                 end
1240         end
1241         
1242         
1243         os.exit(0);
1244 end
1245
1246 os.exit(commands[command]({ select(2, unpack(arg)) }));