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;
57 local dependencies = require "util.dependencies";
58 if not dependencies.check_dependencies() then
62 config = require "core.configmanager"
69 if arg[1] == "--config" and arg[2] then
70 table.insert(filenames, arg[2]);
72 table.insert(filenames, CFG_CONFIGDIR.."/"..arg[2]);
74 table.remove(arg, 1); table.remove(arg, 1);
76 for _, format in ipairs(config.parsers()) do
77 table.insert(filenames, (CFG_CONFIGDIR or ".").."/prosody.cfg."..format);
80 for _,_filename in ipairs(filenames) do
82 local file = io.open(filename);
85 ENV_CONFIG = filename;
86 CFG_CONFIGDIR = filename:match("^(.*)[\\/][^\\/]*$");
90 local ok, level, err = config.load(filename);
93 print("**************************");
94 if level == "parser" then
95 print("A problem occured while reading the config file "..(CFG_CONFIGDIR or ".").."/prosody.cfg.lua");
96 local err_line, err_message = tostring(err):match("%[string .-%]:(%d*): (.*)");
97 print("Error"..(err_line and (" on line "..err_line) or "")..": "..(err_message or tostring(err)));
99 elseif level == "file" then
100 print("Prosody was unable to find the configuration file.");
101 print("We looked for: "..(CFG_CONFIGDIR or ".").."/prosody.cfg.lua");
102 print("A sample config file is included in the Prosody download called prosody.cfg.lua.dist");
103 print("Copy or rename it to prosody.cfg.lua and edit as necessary.");
105 print("More help on configuring Prosody can be found at http://prosody.im/doc/configure");
107 print("**************************");
112 local original_logging_config = config.get("*", "log");
113 config.set("*", "log", { { levels = { min="info" }, to = "console" } });
115 local data_path = config.get("*", "data_path") or CFG_DATADIR or "data";
116 local custom_plugin_paths = config.get("*", "plugin_paths");
117 if custom_plugin_paths then
118 local path_sep = package.config:sub(3,3);
119 -- path1;path2;path3;defaultpath...
120 CFG_PLUGINDIR = table.concat(custom_plugin_paths, path_sep)..path_sep..(CFG_PLUGINDIR or "plugins");
122 prosody.paths = { source = CFG_SOURCEDIR, config = CFG_CONFIGDIR,
123 plugins = CFG_PLUGINDIR or "plugins", data = data_path };
125 if prosody.installed then
126 -- Change working directory to data path.
127 require "lfs".chdir(data_path);
130 require "core.loggingmanager"
132 dependencies.log_warnings();
134 -- Switch away from root and into the prosody user --
135 local switched_user, current_uid;
137 local want_pposix_version = "0.3.5";
138 local ok, pposix = pcall(require, "util.pposix");
140 if ok and pposix then
141 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
142 current_uid = pposix.getuid();
143 if current_uid == 0 then
145 local desired_user = config.get("*", "prosody_user") or "prosody";
146 local desired_group = config.get("*", "prosody_group") or desired_user;
147 local ok, err = pposix.setgid(desired_group);
149 ok, err = pposix.initgroups(desired_user);
152 ok, err = pposix.setuid(desired_user);
155 switched_user = true;
158 if not switched_user then
160 print("Warning: Couldn't switch to Prosody user/group '"..tostring(desired_user).."'/'"..tostring(desired_group).."': "..tostring(err));
164 -- Set our umask to protect data files
165 pposix.umask(config.get("*", "umask") or "027");
166 pposix.setenv("HOME", data_path);
167 pposix.setenv("PROSODY_CONFIG", ENV_CONFIG);
169 print("Error: Unable to load pposix module. Check that Prosody is installed correctly.")
170 print("For more help send the below error to us through http://prosody.im/discuss");
171 print(tostring(pposix))
175 local function test_writeable(filename)
176 local f, err = io.open(filename, "a");
184 local unwriteable_files = {};
185 if type(original_logging_config) == "string" and original_logging_config:sub(1,1) ~= "*" then
186 local ok, err = test_writeable(original_logging_config);
188 table.insert(unwriteable_files, err);
190 elseif type(original_logging_config) == "table" then
191 for _, rule in ipairs(original_logging_config) do
192 if rule.filename then
193 local ok, err = test_writeable(rule.filename);
195 table.insert(unwriteable_files, err);
201 if #unwriteable_files > 0 then
202 print("One of more of the Prosody log files are not");
203 print("writeable, please correct the errors and try");
204 print("starting prosodyctl again.");
206 for _, err in ipairs(unwriteable_files) do
214 local error_messages = setmetatable({
215 ["invalid-username"] = "The given username is invalid in a Jabber ID";
216 ["invalid-hostname"] = "The given hostname is invalid";
217 ["no-password"] = "No password was supplied";
218 ["no-such-user"] = "The given user does not exist on the server";
219 ["no-such-host"] = "The given hostname does not exist in the config";
220 ["unable-to-save-data"] = "Unable to store, perhaps you don't have permission?";
221 ["no-pidfile"] = "There is no 'pidfile' option in the configuration file, see http://prosody.im/doc/prosodyctl#pidfile for help";
222 ["no-posix"] = "The mod_posix module is not enabled in the Prosody config file, see http://prosody.im/doc/prosodyctl for more info";
223 ["no-such-method"] = "This module has no commands";
224 ["not-running"] = "Prosody is not running";
225 }, { __index = function (t,k) return "Error: "..(tostring(k):gsub("%-", " "):gsub("^.", string.upper)); end });
227 hosts = prosody.hosts;
229 local function make_host(hostname)
232 events = prosody.events,
234 users = require "core.usermanager".new_null_provider(hostname)
238 for hostname, config in pairs(config.getconfig()) do
239 hosts[hostname] = make_host(hostname);
242 local modulemanager = require "core.modulemanager"
244 local prosodyctl = require "util.prosodyctl"
246 -----------------------
248 -- FIXME: Duplicate code waiting for util.startup
249 function read_version()
250 -- Try to determine version
251 local version_file = io.open((CFG_SOURCEDIR or ".").."/prosody.version");
253 prosody.version = version_file:read("*a"):gsub("%s*$", "");
254 version_file:close();
255 if #prosody.version == 12 and prosody.version:match("^[a-f0-9]+$") then
256 prosody.version = "hg:"..prosody.version;
259 prosody.version = "unknown";
263 local show_message, show_warning = prosodyctl.show_message, prosodyctl.show_warning;
264 local show_usage = prosodyctl.show_usage;
265 local getchar, getpass = prosodyctl.getchar, prosodyctl.getpass;
266 local show_yesno = prosodyctl.show_yesno;
267 local show_prompt = prosodyctl.show_prompt;
268 local read_password = prosodyctl.read_password;
270 local prosodyctl_timeout = (config.get("*", "prosodyctl_timeout") or 5) * 2;
271 -----------------------
273 local command = arg[1];
275 function commands.adduser(arg)
276 if not arg[1] or arg[1] == "--help" then
277 show_usage([[adduser JID]], [[Create the specified user account in Prosody]]);
280 local user, host = arg[1]:match("([^@]+)@(.+)");
281 if not user and host then
282 show_message [[Failed to understand JID, please supply the JID you want to create]]
283 show_usage [[adduser user@host]]
288 show_message [[Please specify a JID, including a host. e.g. alice@example.com]];
292 if not hosts[host] then
293 show_warning("The host '%s' is not listed in the configuration file (or is not enabled).", host)
294 show_warning("The user will not be able to log in until this is changed.");
295 hosts[host] = make_host(host);
298 if prosodyctl.user_exists{ user = user, host = host } then
299 show_message [[That user already exists]];
303 local password = read_password();
304 if not password then return 1; end
306 local ok, msg = prosodyctl.adduser { user = user, host = host, password = password };
308 if ok then return 0; end
314 function commands.passwd(arg)
315 if not arg[1] or arg[1] == "--help" then
316 show_usage([[passwd JID]], [[Set the password for the specified user account in Prosody]]);
319 local user, host = arg[1]:match("([^@]+)@(.+)");
320 if not user and host then
321 show_message [[Failed to understand JID, please supply the JID you want to set the password for]]
322 show_usage [[passwd user@host]]
327 show_message [[Please specify a JID, including a host. e.g. alice@example.com]];
331 if not hosts[host] then
332 show_warning("The host '%s' is not listed in the configuration file (or is not enabled).", host)
333 show_warning("The user will not be able to log in until this is changed.");
334 hosts[host] = make_host(host);
337 if not prosodyctl.user_exists { user = user, host = host } then
338 show_message [[That user does not exist, use prosodyctl adduser to create a new user]]
342 local password = read_password();
343 if not password then return 1; end
345 local ok, msg = prosodyctl.passwd { user = user, host = host, password = password };
347 if ok then return 0; end
349 show_message(error_messages[msg])
353 function commands.deluser(arg)
354 if not arg[1] or arg[1] == "--help" then
355 show_usage([[deluser JID]], [[Permanently remove the specified user account from Prosody]]);
358 local user, host = arg[1]:match("([^@]+)@(.+)");
359 if not user and host then
360 show_message [[Failed to understand JID, please supply the JID you want to set the password for]]
361 show_usage [[passwd user@host]]
366 show_message [[Please specify a JID, including a host. e.g. alice@example.com]];
370 if not hosts[host] then
371 show_warning("The host '%s' is not listed in the configuration file (or is not enabled).", host)
372 show_warning("The user will not be able to log in until this is changed.");
373 hosts[host] = make_host(host);
376 if not prosodyctl.user_exists { user = user, host = host } then
377 show_message [[That user does not exist on this server]]
381 local ok, msg = prosodyctl.deluser { user = user, host = host };
383 if ok then return 0; end
385 show_message(error_messages[msg])
389 function commands.start(arg)
390 if arg[1] == "--help" then
391 show_usage([[start]], [[Start Prosody]]);
394 local ok, ret = prosodyctl.isrunning();
396 show_message(error_messages[ret]);
401 local ok, ret = prosodyctl.getpid();
403 show_message("Couldn't get running Prosody's PID");
404 show_message(error_messages[ret]);
407 show_message("Prosody is already running with PID %s", ret or "(unknown)");
411 local ok, ret = prosodyctl.start();
413 if config.get("*", "daemonize") ~= false then
416 local ok, running = prosodyctl.isrunning();
417 if ok and running then
420 show_message("Still waiting...");
421 elseif i >= prosodyctl_timeout then
422 show_message("Prosody is still not running. Please give it some time or check your log files for errors.");
428 show_message("Started");
433 show_message("Failed to start Prosody");
434 show_message(error_messages[ret])
438 function commands.status(arg)
439 if arg[1] == "--help" then
440 show_usage([[status]], [[Reports the running status of Prosody]]);
444 local ok, ret = prosodyctl.isrunning();
446 show_message(error_messages[ret]);
451 local ok, ret = prosodyctl.getpid();
453 show_message("Couldn't get running Prosody's PID");
454 show_message(error_messages[ret]);
457 show_message("Prosody is running with PID %s", ret or "(unknown)");
460 show_message("Prosody is not running");
461 if not switched_user and current_uid ~= 0 then
463 print(" You will also see this if prosodyctl is not running under");
464 print(" the same user account as Prosody. Try running as root (e.g. ");
465 print(" with 'sudo' in front) to gain access to Prosody's real status.");
472 function commands.stop(arg)
473 if arg[1] == "--help" then
474 show_usage([[stop]], [[Stop a running Prosody server]]);
478 if not prosodyctl.isrunning() then
479 show_message("Prosody is not running");
483 local ok, ret = prosodyctl.stop();
487 local ok, running = prosodyctl.isrunning();
488 if ok and not running then
491 show_message("Still waiting...");
492 elseif i >= prosodyctl_timeout then
493 show_message("Prosody is still running. Please give it some time or check your log files for errors.");
499 show_message("Stopped");
503 show_message(error_messages[ret]);
507 function commands.restart(arg)
508 if arg[1] == "--help" then
509 show_usage([[restart]], [[Restart a running Prosody server]]);
514 return commands.start(arg);
517 function commands.about(arg)
519 if arg[1] == "--help" then
520 show_usage([[about]], [[Show information about this Prosody installation]]);
524 local array = require "util.array";
525 local keys = require "util.iterators".keys;
527 print("Prosody "..(prosody.version or "(unknown version)"));
529 print("# Prosody directories");
530 print("Data directory: ", CFG_DATADIR or "./");
531 print("Plugin directory:", CFG_PLUGINDIR or "./");
532 print("Config directory:", CFG_CONFIGDIR or "./");
533 print("Source directory:", CFG_SOURCEDIR or "./");
535 print("# Lua environment");
536 print("Lua version: ", _G._VERSION);
538 print("Lua module search paths:");
539 for path in package.path:gmatch("[^;]+") do
543 print("Lua C module search paths:");
544 for path in package.cpath:gmatch("[^;]+") do
548 local luarocks_status = (pcall(require, "luarocks.loader") and "Installed ("..(luarocks.cfg.program_version or "2.x+")..")")
549 or (pcall(require, "luarocks.require") and "Installed (1.x)")
551 print("LuaRocks: ", luarocks_status);
553 print("# Lua module versions");
554 local module_versions, longest_name = {}, 8;
555 for name, module in pairs(package.loaded) do
556 if type(module) == "table" and rawget(module, "_VERSION")
557 and name ~= "_G" and not name:match("%.") then
558 if #name > longest_name then
559 longest_name = #name;
561 module_versions[name] = module._VERSION;
564 local sorted_keys = array.collect(keys(module_versions)):sort();
565 for _, name in ipairs(array.collect(keys(module_versions)):sort()) do
566 print(name..":"..string.rep(" ", longest_name-#name), module_versions[name]);
571 function commands.reload(arg)
572 if arg[1] == "--help" then
573 show_usage([[reload]], [[Reload Prosody's configuration and re-open log files]]);
577 if not prosodyctl.isrunning() then
578 show_message("Prosody is not running");
582 local ok, ret = prosodyctl.reload();
585 show_message("Prosody log files re-opened and config file reloaded. You may need to reload modules for some changes to take effect.");
589 show_message(error_messages[ret]);
592 -- ejabberdctl compatibility
594 function commands.register(arg)
595 local user, host, password = unpack(arg);
596 if (not (user and host)) or arg[1] == "--help" then
597 if user ~= "--help" then
599 show_message [[No username specified]]
601 show_message [[Please specify which host you want to register the user on]];
604 show_usage("register USER HOST [PASSWORD]", "Register a user on the server, with the given password");
608 password = read_password();
610 show_message [[Unable to register user with no password]];
615 local ok, msg = prosodyctl.adduser { user = user, host = host, password = password };
617 if ok then return 0; end
619 show_message(error_messages[msg])
623 function commands.unregister(arg)
624 local user, host = unpack(arg);
625 if (not (user and host)) or arg[1] == "--help" then
626 if user ~= "--help" then
628 show_message [[No username specified]]
630 show_message [[Please specify which host you want to unregister the user from]];
633 show_usage("unregister USER HOST [PASSWORD]", "Permanently remove a user account from the server");
637 local ok, msg = prosodyctl.deluser { user = user, host = host };
639 if ok then return 0; end
641 show_message(error_messages[msg])
648 local cert_commands = {};
650 local function ask_overwrite(filename)
651 return lfs.attributes(filename) and not show_yesno("Overwrite "..filename .. "?");
654 function cert_commands.config(arg)
655 if #arg >= 1 and arg[1] ~= "--help" then
656 local conf_filename = (CFG_DATADIR or ".") .. "/" .. arg[1] .. ".cnf";
657 if ask_overwrite(conf_filename) then
658 return nil, conf_filename;
660 local conf = openssl.config.new();
661 conf:from_prosody(hosts, config, arg);
662 for k, v in pairs(conf.distinguished_name) do
664 if k == "commonName" then
666 elseif k == "emailAddress" then
667 v = "xmpp@" .. arg[1];
669 nv = show_prompt(("%s (%s):"):format(k, nv or v));
670 nv = (not nv or nv == "") and v or nv;
671 if nv:find"[\192-\252][\128-\191]+" then
672 conf.req.string_mask = "utf8only"
674 conf.distinguished_name[k] = nv ~= "." and nv or nil;
676 local conf_file = io.open(conf_filename, "w");
677 conf_file:write(conf:serialize());
680 show_message("Config written to " .. conf_filename);
681 return nil, conf_filename;
683 show_usage("cert config HOSTNAME [HOSTNAME+]", "Builds a certificate config file covering the supplied hostname(s)")
687 function cert_commands.key(arg)
688 if #arg >= 1 and arg[1] ~= "--help" then
689 local key_filename = (CFG_DATADIR or ".") .. "/" .. arg[1] .. ".key";
690 if ask_overwrite(key_filename) then
691 return nil, key_filename;
693 os.remove(key_filename); -- This file, if it exists is unlikely to have write permissions
694 local key_size = tonumber(arg[2] or show_prompt("Choose key size (2048):") or 2048);
695 local old_umask = pposix.umask("0377");
696 if openssl.genrsa{out=key_filename, key_size} then
697 os.execute(("chmod 400 '%s'"):format(key_filename));
698 show_message("Key written to ".. key_filename);
699 pposix.umask(old_umask);
700 return nil, key_filename;
702 show_message("There was a problem, see OpenSSL output");
704 show_usage("cert key HOSTNAME <bits>", "Generates a RSA key named HOSTNAME.key\n "
705 .."Prompts for a key size if none given")
709 function cert_commands.request(arg)
710 if #arg >= 1 and arg[1] ~= "--help" then
711 local req_filename = (CFG_DATADIR or ".") .. "/" .. arg[1] .. ".req";
712 if ask_overwrite(req_filename) then
713 return nil, req_filename;
715 local _, key_filename = cert_commands.key({arg[1]});
716 local _, conf_filename = cert_commands.config(arg);
717 if openssl.req{new=true, key=key_filename, utf8=true, config=conf_filename, out=req_filename} then
718 show_message("Certificate request written to ".. req_filename);
720 show_message("There was a problem, see OpenSSL output");
723 show_usage("cert request HOSTNAME [HOSTNAME+]", "Generates a certificate request for the supplied hostname(s)")
727 function cert_commands.generate(arg)
728 if #arg >= 1 and arg[1] ~= "--help" then
729 local cert_filename = (CFG_DATADIR or ".") .. "/" .. arg[1] .. ".crt";
730 if ask_overwrite(cert_filename) then
731 return nil, cert_filename;
733 local _, key_filename = cert_commands.key({arg[1]});
734 local _, conf_filename = cert_commands.config(arg);
736 if key_filename and conf_filename and cert_filename
737 and openssl.req{new=true, x509=true, nodes=true, key=key_filename,
738 days=365, sha1=true, utf8=true, config=conf_filename, out=cert_filename} then
739 show_message("Certificate written to ".. cert_filename);
741 show_message("There was a problem, see OpenSSL output");
744 show_usage("cert generate HOSTNAME [HOSTNAME+]", "Generates a self-signed certificate for the current hostname(s)")
748 function commands.cert(arg)
749 if #arg >= 1 and arg[1] ~= "--help" then
750 openssl = require "util.openssl";
752 local subcmd = table.remove(arg, 1);
753 if type(cert_commands[subcmd]) == "function" then
755 show_message"You need to supply at least one hostname"
758 if arg[1] ~= "--help" and not hosts[arg[1]] then
759 show_message(error_messages["no-such-host"]);
762 return cert_commands[subcmd](arg);
765 show_usage("cert config|request|generate|key", "Helpers for generating X.509 certificates and keys.")
768 ---------------------
770 if command and command:match("^mod_") then -- Is a command in a module
771 local module_name = command:match("^mod_(.+)");
772 local ret, err = modulemanager.load("*", module_name);
774 show_message("Failed to load module '"..module_name.."': "..err);
778 table.remove(arg, 1);
780 local module = modulemanager.get_module("*", module_name);
782 show_message("Failed to load module '"..module_name.."': Unknown error");
786 if not modulemanager.module_has_method(module, "command") then
787 show_message("Fail: mod_"..module_name.." does not support any commands");
791 local ok, ret = modulemanager.call_module_method(module, "command", arg);
793 if type(ret) == "number" then
795 elseif type(ret) == "string" then
800 show_message("Failed to execute command: "..error_messages[ret]);
805 if not commands[command] then -- Show help for all commands
806 function show_usage(usage, desc)
811 print("prosodyctl - Manage a Prosody server");
813 print("Usage: "..arg[0].." COMMAND [OPTIONS]");
815 print("Where COMMAND may be one of:\n");
817 local hidden_commands = require "util.set".new{ "register", "unregister", "addplugin" };
818 local commands_order = { "adduser", "passwd", "deluser", "start", "stop", "restart", "reload", "about" };
822 for _, command_name in ipairs(commands_order) do
823 local command = commands[command_name];
827 done[command_name] = true;
831 for command_name, command in pairs(commands) do
832 if not done[command_name] and not hidden_commands:contains(command_name) then
835 done[command_name] = true;
843 os.exit(commands[command]({ select(2, unpack(arg)) }));