3 -- Copyright (C) 2008-2010 Matthew Wild
4 -- Copyright (C) 2008-2010 Waqas Hussain
6 -- This project is MIT/X11 licensed. Please see the
7 -- COPYING file in the source package for more information.
10 -- prosodyctl - command-line controller for Prosody XMPP server
12 -- Will be modified by configure script if run --
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");
19 -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --
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) ~= ":\\")))
27 -- Tell Lua where to find our libraries
29 local function filter_relative_paths(path)
30 if is_relative(path) then return ""; end
32 local function sanitise_paths(paths)
33 return (paths:gsub("[^;]+;?", filter_relative_paths):gsub(";;+", ";"));
35 package.path = sanitise_paths(CFG_SOURCEDIR.."/?.lua;"..package.path);
36 package.cpath = sanitise_paths(CFG_SOURCEDIR.."/?.so;"..package.cpath);
39 -- Substitute ~ with path to home directory in data path
41 if os.getenv("HOME") then
42 CFG_DATADIR = CFG_DATADIR:gsub("^~", os.getenv("HOME"));
46 -- Global 'prosody' object
49 events = require "util.events".new();
51 lock_globals = function () end;
52 unlock_globals = function () end;
53 installed = CFG_SOURCEDIR ~= nil;
54 core_post_stanza = function () end; -- TODO: mod_router!
58 local dependencies = require "util.dependencies";
59 if not dependencies.check_dependencies() then
63 config = require "core.configmanager"
70 if arg[1] == "--config" and arg[2] then
71 table.insert(filenames, arg[2]);
73 table.insert(filenames, CFG_CONFIGDIR.."/"..arg[2]);
75 table.remove(arg, 1); table.remove(arg, 1);
77 for _, format in ipairs(config.parsers()) do
78 table.insert(filenames, (CFG_CONFIGDIR or ".").."/prosody.cfg."..format);
81 for _,_filename in ipairs(filenames) do
83 local file = io.open(filename);
86 ENV_CONFIG = filename;
87 CFG_CONFIGDIR = filename:match("^(.*)[\\/][^\\/]*$");
91 local ok, level, err = config.load(filename);
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)));
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.");
106 print("More help on configuring Prosody can be found at http://prosody.im/doc/configure");
108 print("**************************");
113 local original_logging_config = config.get("*", "log");
114 config.set("*", "log", { { levels = { min="info" }, to = "console" } });
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");
123 prosody.paths = { source = CFG_SOURCEDIR, config = CFG_CONFIGDIR,
124 plugins = CFG_PLUGINDIR or "plugins", data = data_path };
126 if prosody.installed then
127 -- Change working directory to data path.
128 require "lfs".chdir(data_path);
131 require "core.loggingmanager"
133 dependencies.log_warnings();
135 -- Switch away from root and into the prosody user --
136 local switched_user, current_uid;
138 local want_pposix_version = "0.3.6";
139 local ok, pposix = pcall(require, "util.pposix");
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
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);
150 ok, err = pposix.initgroups(desired_user);
153 ok, err = pposix.setuid(desired_user);
156 switched_user = true;
159 if not switched_user then
161 print("Warning: Couldn't switch to Prosody user/group '"..tostring(desired_user).."'/'"..tostring(desired_group).."': "..tostring(err));
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);
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))
176 local function test_writeable(filename)
177 local f, err = io.open(filename, "a");
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);
189 table.insert(unwriteable_files, err);
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);
196 table.insert(unwriteable_files, err);
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.");
207 for _, err in ipairs(unwriteable_files) do
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 });
228 hosts = prosody.hosts;
230 local function make_host(hostname)
233 events = prosody.events,
235 users = require "core.usermanager".new_null_provider(hostname)
239 for hostname, config in pairs(config.getconfig()) do
240 hosts[hostname] = make_host(hostname);
243 local modulemanager = require "core.modulemanager"
245 local prosodyctl = require "util.prosodyctl"
247 -----------------------
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");
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;
260 prosody.version = "unknown";
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;
271 local prosodyctl_timeout = (config.get("*", "prosodyctl_timeout") or 5) * 2;
272 -----------------------
274 local command = arg[1];
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]]);
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]]
290 show_message [[Please specify a JID, including a host. e.g. alice@example.com]];
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);
300 if prosodyctl.user_exists{ user = user, host = host } then
301 show_message [[That user already exists]];
305 local password = read_password();
306 if not password then return 1; end
308 local ok, msg = prosodyctl.adduser { user = user, host = host, password = password };
310 if ok then return 0; end
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]]);
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]]
330 show_message [[Please specify a JID, including a host. e.g. alice@example.com]];
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);
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]]
345 local password = read_password();
346 if not password then return 1; end
348 local ok, msg = prosodyctl.passwd { user = user, host = host, password = password };
350 if ok then return 0; end
352 show_message(error_messages[msg])
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]]);
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]]
370 show_message [[Please specify a JID, including a host. e.g. alice@example.com]];
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);
380 if not prosodyctl.user_exists { user = user, host = host } then
381 show_message [[That user does not exist on this server]]
385 local ok, msg = prosodyctl.deluser { user = user, host = host };
387 if ok then return 0; end
389 show_message(error_messages[msg])
393 function commands.start(arg)
394 if arg[1] == "--help" then
395 show_usage([[start]], [[Start Prosody]]);
398 local ok, ret = prosodyctl.isrunning();
400 show_message(error_messages[ret]);
405 local ok, ret = prosodyctl.getpid();
407 show_message("Couldn't get running Prosody's PID");
408 show_message(error_messages[ret]);
411 show_message("Prosody is already running with PID %s", ret or "(unknown)");
415 local ok, ret = prosodyctl.start();
417 if config.get("*", "daemonize") ~= false then
420 local ok, running = prosodyctl.isrunning();
421 if ok and running 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.");
432 show_message("Started");
437 show_message("Failed to start Prosody");
438 show_message(error_messages[ret])
442 function commands.status(arg)
443 if arg[1] == "--help" then
444 show_usage([[status]], [[Reports the running status of Prosody]]);
448 local ok, ret = prosodyctl.isrunning();
450 show_message(error_messages[ret]);
455 local ok, ret = prosodyctl.getpid();
457 show_message("Couldn't get running Prosody's PID");
458 show_message(error_messages[ret]);
461 show_message("Prosody is running with PID %s", ret or "(unknown)");
464 show_message("Prosody is not running");
465 if not switched_user and current_uid ~= 0 then
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.");
476 function commands.stop(arg)
477 if arg[1] == "--help" then
478 show_usage([[stop]], [[Stop a running Prosody server]]);
482 if not prosodyctl.isrunning() then
483 show_message("Prosody is not running");
487 local ok, ret = prosodyctl.stop();
491 local ok, running = prosodyctl.isrunning();
492 if ok and not running 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.");
503 show_message("Stopped");
507 show_message(error_messages[ret]);
511 function commands.restart(arg)
512 if arg[1] == "--help" then
513 show_usage([[restart]], [[Restart a running Prosody server]]);
518 return commands.start(arg);
521 function commands.about(arg)
523 if arg[1] == "--help" then
524 show_usage([[about]], [[Show information about this Prosody installation]]);
528 local array = require "util.array";
529 local keys = require "util.iterators".keys;
531 print("Prosody "..(prosody.version or "(unknown version)"));
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 "./");
539 print("# Lua environment");
540 print("Lua version: ", _G._VERSION);
542 print("Lua module search paths:");
543 for path in package.path:gmatch("[^;]+") do
547 print("Lua C module search paths:");
548 for path in package.cpath:gmatch("[^;]+") do
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)")
555 print("LuaRocks: ", luarocks_status);
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;
565 module_versions[name] = module._VERSION;
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]);
575 function commands.reload(arg)
576 if arg[1] == "--help" then
577 show_usage([[reload]], [[Reload Prosody's configuration and re-open log files]]);
581 if not prosodyctl.isrunning() then
582 show_message("Prosody is not running");
586 local ok, ret = prosodyctl.reload();
589 show_message("Prosody log files re-opened and config file reloaded. You may need to reload modules for some changes to take effect.");
593 show_message(error_messages[ret]);
596 -- ejabberdctl compatibility
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
603 show_message [[No username specified]]
605 show_message [[Please specify which host you want to register the user on]];
608 show_usage("register USER HOST [PASSWORD]", "Register a user on the server, with the given password");
612 password = read_password();
614 show_message [[Unable to register user with no password]];
619 local ok, msg = prosodyctl.adduser { user = user, host = host, password = password };
621 if ok then return 0; end
623 show_message(error_messages[msg])
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
632 show_message [[No username specified]]
634 show_message [[Please specify which host you want to unregister the user from]];
637 show_usage("unregister USER HOST [PASSWORD]", "Permanently remove a user account from the server");
641 local ok, msg = prosodyctl.deluser { user = user, host = host };
643 if ok then return 0; end
645 show_message(error_messages[msg])
652 local cert_commands = {};
654 local function ask_overwrite(filename)
655 return lfs.attributes(filename) and not show_yesno("Overwrite "..filename .. "?");
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;
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];
672 if k == "commonName" then
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
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"
687 conf.distinguished_name[k] = nv ~= "." and nv or nil;
690 local conf_file, err = io.open(conf_filename, "w");
691 if not conf_file then
692 show_warning("Could not open OpenSSL config file for writing");
696 conf_file:write(conf:serialize());
699 show_message("Config written to " .. conf_filename);
700 return nil, conf_filename;
702 show_usage("cert config HOSTNAME [HOSTNAME+]", "Builds a certificate config file covering the supplied hostname(s)")
706 function cert_commands.key(arg)
707 if #arg >= 1 and arg[1] ~= "--help" then
708 local key_filename = (CFG_DATADIR or "./certs") .. "/" .. arg[1] .. ".key";
709 if ask_overwrite(key_filename) then
710 return nil, key_filename;
712 os.remove(key_filename); -- This file, if it exists is unlikely to have write permissions
713 local key_size = tonumber(arg[2] or show_prompt("Choose key size (2048):") or 2048);
714 local old_umask = pposix.umask("0377");
715 if openssl.genrsa{out=key_filename, key_size} then
716 os.execute(("chmod 400 '%s'"):format(key_filename));
717 show_message("Key written to ".. key_filename);
718 pposix.umask(old_umask);
719 return nil, key_filename;
721 show_message("There was a problem, see OpenSSL output");
723 show_usage("cert key HOSTNAME <bits>", "Generates a RSA key named HOSTNAME.key\n "
724 .."Prompts for a key size if none given")
728 function cert_commands.request(arg)
729 if #arg >= 1 and arg[1] ~= "--help" then
730 local req_filename = (CFG_DATADIR or "./certs") .. "/" .. arg[1] .. ".req";
731 if ask_overwrite(req_filename) then
732 return nil, req_filename;
734 local _, key_filename = cert_commands.key({arg[1]});
735 local _, conf_filename = cert_commands.config(arg);
736 if openssl.req{new=true, key=key_filename, utf8=true, config=conf_filename, out=req_filename} then
737 show_message("Certificate request written to ".. req_filename);
739 show_message("There was a problem, see OpenSSL output");
742 show_usage("cert request HOSTNAME [HOSTNAME+]", "Generates a certificate request for the supplied hostname(s)")
746 function cert_commands.generate(arg)
747 if #arg >= 1 and arg[1] ~= "--help" then
748 local cert_filename = (CFG_DATADIR or "./certs") .. "/" .. arg[1] .. ".crt";
749 if ask_overwrite(cert_filename) then
750 return nil, cert_filename;
752 local _, key_filename = cert_commands.key({arg[1]});
753 local _, conf_filename = cert_commands.config(arg);
755 if key_filename and conf_filename and cert_filename
756 and openssl.req{new=true, x509=true, nodes=true, key=key_filename,
757 days=365, sha1=true, utf8=true, config=conf_filename, out=cert_filename} then
758 show_message("Certificate written to ".. cert_filename);
760 show_message("There was a problem, see OpenSSL output");
763 show_usage("cert generate HOSTNAME [HOSTNAME+]", "Generates a self-signed certificate for the current hostname(s)")
767 function commands.cert(arg)
768 if #arg >= 1 and arg[1] ~= "--help" then
769 openssl = require "util.openssl";
771 local subcmd = table.remove(arg, 1);
772 if type(cert_commands[subcmd]) == "function" then
774 show_message"You need to supply at least one hostname"
777 if arg[1] ~= "--help" and not hosts[arg[1]] then
778 show_message(error_messages["no-such-host"]);
781 return cert_commands[subcmd](arg);
784 show_usage("cert config|request|generate|key", "Helpers for generating X.509 certificates and keys.")
787 function commands.check(arg)
788 if arg[1] == "--help" then
789 show_usage([[check]], [[Perform basic checks on your Prosody installation]]);
792 local what = table.remove(arg, 1);
793 local array, set = require "util.array", require "util.set";
794 local it = require "util.iterators";
796 if not what or what == "config" then
797 print("Checking config...");
798 local known_global_options = set.new({
799 "pidfile", "log", "plugin_paths", "prosody_user", "prosody_group", "daemonize",
800 "umask", "prosodyctl_timeout", "use_ipv6", "use_libevent", "network_settings"
802 local config = config.getconfig();
803 -- Check that we have any global options (caused by putting a host at the top)
804 if it.count(it.filter("log", pairs(config["*"]))) == 0 then
807 print(" No global options defined. Perhaps you have put a host definition at the top")
808 print(" of the config file? They should be at the bottom, see http://prosody.im/doc/configure#overview");
810 -- Check for global options under hosts
811 local global_options = set.new(it.to_array(it.keys(config["*"])));
812 for host, options in it.filter("*", pairs(config)) do
813 local host_options = set.new(it.to_array(it.keys(options)));
814 local misplaced_options = set.intersection(host_options, known_global_options);
815 for name in pairs(options) do
816 if name:match("^interfaces?")
817 or name:match("_ports?$") or name:match("_interfaces?$")
818 or name:match("_ssl$") then
819 misplaced_options:add(name);
822 if not misplaced_options:empty() then
825 local n = it.count(misplaced_options);
826 print(" You have "..n.." option"..(n>1 and "s " or " ").."set under "..host.." that should be");
827 print(" in the global section of the config file, above any VirtualHost or Component definitions,")
828 print(" see http://prosody.im/doc/configure#overview for more information.")
830 print(" You need to move the following option"..(n>1 and "s" or "")..": "..table.concat(it.to_array(misplaced_options), ", "));
832 local subdomain = host:match("^[^.]+");
833 if not(host_options:contains("component_module")) and (subdomain == "jabber" or subdomain == "xmpp"
834 or subdomain == "chat" or subdomain == "im") then
836 print(" Suggestion: If "..host.. " is a new host with no real users yet, consider renaming it now to");
837 print(" "..host:gsub("^[^.]+%.", "")..". You can use SRV records to redirect XMPP clients and servers to "..host..".");
838 print(" For more information see: http://prosody.im/doc/dns");
844 if not what or what == "dns" then
845 local dns = require "net.dns";
846 local idna = require "util.encodings".idna;
847 local ip = require "util.ip";
848 local c2s_ports = set.new(config.get("*", "c2s_ports") or {5222});
849 local s2s_ports = set.new(config.get("*", "s2s_ports") or {5269});
851 local c2s_srv_required, s2s_srv_required;
852 if not c2s_ports:contains(5222) then
853 c2s_srv_required = true;
855 if not s2s_ports:contains(5269) then
856 s2s_srv_required = true;
859 local problem_hosts = set.new();
861 local external_addresses, internal_addresses = set.new(), set.new();
863 local fqdn = socket.dns.tohostname(socket.dns.gethostname());
865 local res = dns.lookup(idna.to_ascii(fqdn), "A");
867 for _, record in ipairs(res) do
868 external_addresses:add(record.a);
871 local res = dns.lookup(idna.to_ascii(fqdn), "AAAA");
873 for _, record in ipairs(res) do
874 external_addresses:add(record.aaaa);
879 local local_addresses = require"util.net".local_addresses() or {};
881 for addr in it.values(local_addresses) do
882 if not ip.new_ip(addr).private then
883 external_addresses:add(addr);
885 internal_addresses:add(addr);
889 if external_addresses:empty() then
891 print(" Failed to determine the external addresses of this server. Checks may be inaccurate.");
892 c2s_srv_required, s2s_srv_required = true, true;
895 local v6_supported = not not socket.tcp6;
897 for host, host_options in it.filter("*", pairs(config.getconfig())) do
898 local all_targets_ok, some_targets_ok = true, false;
900 local is_component = not not host_options.component_module;
901 print("Checking DNS for "..(is_component and "component" or "host").." "..host.."...");
902 local target_hosts = set.new();
903 if not is_component then
904 local res = dns.lookup("_xmpp-client._tcp."..idna.to_ascii(host)..".", "SRV");
906 for _, record in ipairs(res) do
907 target_hosts:add(record.srv.target);
908 if not c2s_ports:contains(record.srv.port) then
909 print(" SRV target "..record.srv.target.." contains unknown client port: "..record.srv.port);
913 if c2s_srv_required then
914 print(" No _xmpp-client SRV record found for "..host..", but it looks like you need one.");
915 all_targst_ok = false;
917 target_hosts:add(host);
921 local res = dns.lookup("_xmpp-server._tcp."..idna.to_ascii(host)..".", "SRV");
923 for _, record in ipairs(res) do
924 target_hosts:add(record.srv.target);
925 if not s2s_ports:contains(record.srv.port) then
926 print(" SRV target "..record.srv.target.." contains unknown server port: "..record.srv.port);
930 if s2s_srv_required then
931 print(" No _xmpp-server SRV record found for "..host..", but it looks like you need one.");
932 all_targets_ok = false;
934 target_hosts:add(host);
937 if target_hosts:empty() then
938 target_hosts:add(host);
941 if target_hosts:contains("localhost") then
942 print(" Target 'localhost' cannot be accessed from other servers");
943 target_hosts:remove("localhost");
946 local modules = set.new(it.to_array(it.values(host_options.modules_enabled)))
947 + set.new(it.to_array(it.values(config.get("*", "modules_enabled"))))
948 + set.new({ config.get(host, "component_module") });
950 if modules:contains("proxy65") then
951 local proxy65_target = config.get(host, "proxy65_address") or host;
952 local A, AAAA = dns.lookup(idna.to_ascii(proxy65_target), "A"), dns.lookup(idna.to_ascii(proxy65_target), "AAAA");
955 table.insert(prob, "A");
957 if v6_supported and not AAAA then
958 table.insert(prob, "AAAA");
961 print(" File transfer proxy "..proxy65_target.." has no "..table.concat(prob, "/").." record. Create one or set 'proxy65_address' to the correct host/IP.");
965 for host in target_hosts do
966 local host_ok_v4, host_ok_v6;
967 local res = dns.lookup(idna.to_ascii(host), "A");
969 for _, record in ipairs(res) do
970 if external_addresses:contains(record.a) then
971 some_targets_ok = true;
973 elseif internal_addresses:contains(record.a) then
975 some_targets_ok = true;
976 print(" "..host.." A record points to internal address, external connections might fail");
978 print(" "..host.." A record points to unknown address "..record.a);
979 all_targets_ok = false;
983 local res = dns.lookup(idna.to_ascii(host), "AAAA");
985 for _, record in ipairs(res) do
986 if external_addresses:contains(record.aaaa) then
987 some_targets_ok = true;
989 elseif internal_addresses:contains(record.aaaa) then
991 some_targets_ok = true;
992 print(" "..host.." AAAA record points to internal address, external connections might fail");
994 print(" "..host.." AAAA record points to unknown address "..record.aaaa);
995 all_targets_ok = false;
1000 local bad_protos = {}
1001 if not host_ok_v4 then
1002 table.insert(bad_protos, "IPv4");
1004 if not host_ok_v6 then
1005 table.insert(bad_protos, "IPv6");
1007 if #bad_protos > 0 then
1008 print(" Host "..host.." does not seem to resolve to this server ("..table.concat(bad_protos, "/")..")");
1010 if host_ok_v6 and not v6_supported then
1011 print(" Host "..host.." has AAAA records, but your version of LuaSocket does not support IPv6.");
1012 print(" Please see http://prosody.im/doc/ipv6 for more information.");
1015 if not all_targets_ok then
1016 print(" "..(some_targets_ok and "Only some" or "No").." targets for "..host.." appear to resolve to this server.");
1017 if is_component then
1018 print(" DNS records are necessary if you want users on other servers to access this component.");
1020 problem_hosts:add(host);
1024 if not problem_hosts:empty() then
1026 print("For more information about DNS configuration please see http://prosody.im/doc/dns");
1031 if not what or what == "certs" then
1033 print"Checking certificates..."
1034 local x509_verify_identity = require"util.x509".verify_identity;
1035 local ssl = dependencies.softreq"ssl";
1036 -- local datetime_parse = require"util.datetime".parse_x509;
1037 local load_cert = ssl and ssl.x509 and ssl.x509.load;
1038 -- or ssl.cert_from_pem
1040 print("LuaSec not available, can't perform certificate checks")
1041 if what == "certs" then cert_ok = false end
1042 elseif not load_cert then
1043 print("This version of LuaSec (" .. ssl._VERSION .. ") does not support certificate checking");
1046 for host in pairs(hosts) do
1047 if host ~= "*" then -- Should check global certs too.
1048 print("Checking certificate for "..host);
1049 -- First, let's find out what certificate this host uses.
1050 local ssl_config = config.rawget(host, "ssl");
1051 if not ssl_config then
1052 local base_host = host:match("%.(.*)");
1053 ssl_config = config.get(base_host, "ssl");
1055 if not ssl_config then
1056 print(" No 'ssl' option defined for "..host)
1058 elseif not ssl_config.certificate then
1059 print(" No 'certificate' set in ssl option for "..host)
1061 elseif not ssl_config.key then
1062 print(" No 'key' set in ssl option for "..host)
1065 local key, err = io.open(ssl_config.key); -- Permissions check only
1067 print(" Could not open "..ssl_config.key..": "..err);
1072 local cert_fh, err = io.open(ssl_config.certificate); -- Load the file.
1074 print(" Could not open "..ssl_config.certificate..": "..err);
1077 print(" Certificate: "..ssl_config.certificate)
1078 local cert = load_cert(cert_fh:read"*a"); cert_fh = cert_fh:close();
1079 if not cert:validat(os.time()) then
1080 print(" Certificate has expired.")
1083 if config.get(host, "component_module") == nil
1084 and not x509_verify_identity(host, "_xmpp-client", cert) then
1085 print(" Not vaild for client connections to "..host..".")
1088 if (not (config.get(name, "anonymous_login")
1089 or config.get(name, "authentication") == "anonymous"))
1090 and not x509_verify_identity(host, "_xmpp-client", cert) then
1091 print(" Not vaild for server-to-server connections to "..host..".")
1098 if cert_ok == false then
1100 print("For more information about certificates please see http://prosody.im/doc/certificates");
1107 print("Problems found, see above.");
1109 print("All checks passed, congratulations!");
1111 return ok and 0 or 2;
1114 ---------------------
1116 if command and command:match("^mod_") then -- Is a command in a module
1117 local module_name = command:match("^mod_(.+)");
1118 local ret, err = modulemanager.load("*", module_name);
1120 show_message("Failed to load module '"..module_name.."': "..err);
1124 table.remove(arg, 1);
1126 local module = modulemanager.get_module("*", module_name);
1128 show_message("Failed to load module '"..module_name.."': Unknown error");
1132 if not modulemanager.module_has_method(module, "command") then
1133 show_message("Fail: mod_"..module_name.." does not support any commands");
1137 local ok, ret = modulemanager.call_module_method(module, "command", arg);
1139 if type(ret) == "number" then
1141 elseif type(ret) == "string" then
1146 show_message("Failed to execute command: "..error_messages[ret]);
1151 if not commands[command] then -- Show help for all commands
1152 function show_usage(usage, desc)
1157 print("prosodyctl - Manage a Prosody server");
1159 print("Usage: "..arg[0].." COMMAND [OPTIONS]");
1161 print("Where COMMAND may be one of:\n");
1163 local hidden_commands = require "util.set".new{ "register", "unregister", "addplugin" };
1164 local commands_order = { "adduser", "passwd", "deluser", "start", "stop", "restart", "reload", "about" };
1168 for _, command_name in ipairs(commands_order) do
1169 local command = commands[command_name];
1171 command{ "--help" };
1173 done[command_name] = true;
1177 for command_name, command in pairs(commands) do
1178 if not done[command_name] and not hidden_commands:contains(command_name) then
1179 command{ "--help" };
1181 done[command_name] = true;
1189 os.exit(commands[command]({ select(2, unpack(arg)) }));