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;
56 local dependencies = require "util.dependencies";
57 if not dependencies.check_dependencies() then
61 config = require "core.configmanager"
67 if arg[1] == "--config" and arg[2] then
68 table.insert(filenames, arg[2]);
69 table.remove(arg, 1); table.remove(arg, 1);
71 table.insert(filenames, CFG_CONFIGDIR.."/"..arg[2]);
74 for _, format in ipairs(config.parsers()) do
75 table.insert(filenames, (CFG_CONFIGDIR or ".").."/prosody.cfg."..format);
78 for _,_filename in ipairs(filenames) do
80 local file = io.open(filename);
83 CFG_CONFIGDIR = filename:match("^(.*)[\\/][^\\/]*$");
87 local ok, level, err = config.load(filename);
90 print("**************************");
91 if level == "parser" then
92 print("A problem occured while reading the config file "..(CFG_CONFIGDIR or ".").."/prosody.cfg.lua");
93 local err_line, err_message = tostring(err):match("%[string .-%]:(%d*): (.*)");
94 print("Error"..(err_line and (" on line "..err_line) or "")..": "..(err_message or tostring(err)));
96 elseif level == "file" then
97 print("Prosody was unable to find the configuration file.");
98 print("We looked for: "..(CFG_CONFIGDIR or ".").."/prosody.cfg.lua");
99 print("A sample config file is included in the Prosody download called prosody.cfg.lua.dist");
100 print("Copy or rename it to prosody.cfg.lua and edit as necessary.");
102 print("More help on configuring Prosody can be found at http://prosody.im/doc/configure");
104 print("**************************");
109 local original_logging_config = config.get("*", "core", "log");
110 config.set("*", "core", "log", { { levels = { min="info" }, to = "console" } });
112 local data_path = config.get("*", "core", "data_path") or CFG_DATADIR or "data";
113 local custom_plugin_paths = config.get("*", "core", "plugin_paths");
114 if custom_plugin_paths then
115 local path_sep = package.config:sub(3,3);
116 -- path1;path2;path3;defaultpath...
117 CFG_PLUGINDIR = table.concat(custom_plugin_paths, path_sep)..path_sep..(CFG_PLUGINDIR or "plugins");
119 prosody.paths = { source = CFG_SOURCEDIR, config = CFG_CONFIGDIR,
120 plugins = CFG_PLUGINDIR or "plugins", data = data_path };
122 require "core.loggingmanager"
124 dependencies.log_warnings();
126 -- Switch away from root and into the prosody user --
127 local switched_user, current_uid;
129 local want_pposix_version = "0.3.5";
130 local ok, pposix = pcall(require, "util.pposix");
132 if ok and pposix then
133 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
134 current_uid = pposix.getuid();
135 if current_uid == 0 then
137 local desired_user = config.get("*", "core", "prosody_user") or "prosody";
138 local desired_group = config.get("*", "core", "prosody_group") or desired_user;
139 local ok, err = pposix.setgid(desired_group);
141 ok, err = pposix.initgroups(desired_user);
144 ok, err = pposix.setuid(desired_user);
147 switched_user = true;
150 if not switched_user then
152 print("Warning: Couldn't switch to Prosody user/group '"..tostring(desired_user).."'/'"..tostring(desired_group).."': "..tostring(err));
156 -- Set our umask to protect data files
157 pposix.umask(config.get("*", "core", "umask") or "027");
159 print("Error: Unable to load pposix module. Check that Prosody is installed correctly.")
160 print("For more help send the below error to us through http://prosody.im/discuss");
161 print(tostring(pposix))
164 local function test_writeable(filename)
165 local f, err = io.open(filename, "a");
173 local unwriteable_files = {};
174 if type(original_logging_config) == "string" and original_logging_config:sub(1,1) ~= "*" then
175 local ok, err = test_writeable(original_logging_config);
177 table.insert(unwriteable_files, err);
179 elseif type(original_logging_config) == "table" then
180 for _, rule in ipairs(original_logging_config) do
181 if rule.filename then
182 local ok, err = test_writeable(rule.filename);
184 table.insert(unwriteable_files, err);
190 if #unwriteable_files > 0 then
191 print("One of more of the Prosody log files are not");
192 print("writeable, please correct the errors and try");
193 print("starting prosodyctl again.");
195 for _, err in ipairs(unwriteable_files) do
203 local error_messages = setmetatable({
204 ["invalid-username"] = "The given username is invalid in a Jabber ID";
205 ["invalid-hostname"] = "The given hostname is invalid";
206 ["no-password"] = "No password was supplied";
207 ["no-such-user"] = "The given user does not exist on the server";
208 ["unable-to-save-data"] = "Unable to store, perhaps you don't have permission?";
209 ["no-pidfile"] = "There is no 'pidfile' option in the configuration file, see http://prosody.im/doc/prosodyctl#pidfile for help";
210 ["no-posix"] = "The mod_posix module is not enabled in the Prosody config file, see http://prosody.im/doc/prosodyctl for more info";
211 ["no-such-method"] = "This module has no commands";
212 ["not-running"] = "Prosody is not running";
213 }, { __index = function (t,k) return "Error: "..(tostring(k):gsub("%-", " "):gsub("^.", string.upper)); end });
215 hosts = prosody.hosts;
217 local function make_host(hostname)
220 events = prosody.events,
221 users = require "core.usermanager".new_null_provider(hostname)
225 for hostname, config in pairs(config.getconfig()) do
226 hosts[hostname] = make_host(hostname);
229 require "core.modulemanager"
231 require "util.prosodyctl"
233 -----------------------
235 local show_message, show_warning = prosodyctl.show_message, prosodyctl.show_warning;
236 local show_usage = prosodyctl.show_usage;
237 local getchar, getpass = prosodyctl.getchar, prosodyctl.getpass;
238 local show_yesno = prosodyctl.show_yesno;
239 local show_prompt = prosodyctl.show_prompt;
240 local read_password = prosodyctl.read_password;
242 local prosodyctl_timeout = (config.get("*", "core", "prosodyctl_timeout") or 5) * 2;
243 -----------------------
245 local command = arg[1];
247 function commands.adduser(arg)
248 if not arg[1] or arg[1] == "--help" then
249 show_usage([[adduser JID]], [[Create the specified user account in Prosody]]);
252 local user, host = arg[1]:match("([^@]+)@(.+)");
253 if not user and host then
254 show_message [[Failed to understand JID, please supply the JID you want to create]]
255 show_usage [[adduser user@host]]
260 show_message [[Please specify a JID, including a host. e.g. alice@example.com]];
264 if not hosts[host] then
265 show_warning("The host '%s' is not listed in the configuration file (or is not enabled).", host)
266 show_warning("The user will not be able to log in until this is changed.");
267 hosts[host] = make_host(host);
270 if prosodyctl.user_exists{ user = user, host = host } then
271 show_message [[That user already exists]];
275 local password = read_password();
276 if not password then return 1; end
278 local ok, msg = prosodyctl.adduser { user = user, host = host, password = password };
280 if ok then return 0; end
286 function commands.passwd(arg)
287 if not arg[1] or arg[1] == "--help" then
288 show_usage([[passwd JID]], [[Set the password for the specified user account in Prosody]]);
291 local user, host = arg[1]:match("([^@]+)@(.+)");
292 if not user and host then
293 show_message [[Failed to understand JID, please supply the JID you want to set the password for]]
294 show_usage [[passwd user@host]]
299 show_message [[Please specify a JID, including a host. e.g. alice@example.com]];
303 if not hosts[host] then
304 show_warning("The host '%s' is not listed in the configuration file (or is not enabled).", host)
305 show_warning("The user will not be able to log in until this is changed.");
306 hosts[host] = make_host(host);
309 if not prosodyctl.user_exists { user = user, host = host } then
310 show_message [[That user does not exist, use prosodyctl adduser to create a new user]]
314 local password = read_password();
315 if not password then return 1; end
317 local ok, msg = prosodyctl.passwd { user = user, host = host, password = password };
319 if ok then return 0; end
321 show_message(error_messages[msg])
325 function commands.deluser(arg)
326 if not arg[1] or arg[1] == "--help" then
327 show_usage([[deluser JID]], [[Permanently remove the specified user account from Prosody]]);
330 local user, host = arg[1]:match("([^@]+)@(.+)");
331 if not user and host then
332 show_message [[Failed to understand JID, please supply the JID you want to set the password for]]
333 show_usage [[passwd user@host]]
338 show_message [[Please specify a JID, including a host. e.g. alice@example.com]];
342 if not hosts[host] then
343 show_warning("The host '%s' is not listed in the configuration file (or is not enabled).", host)
344 show_warning("The user will not be able to log in until this is changed.");
345 hosts[host] = make_host(host);
348 if not prosodyctl.user_exists { user = user, host = host } then
349 show_message [[That user does not exist on this server]]
353 local ok, msg = prosodyctl.passwd { user = user, host = host };
355 if ok then return 0; end
357 show_message(error_messages[msg])
361 function commands.start(arg)
362 if arg[1] == "--help" then
363 show_usage([[start]], [[Start Prosody]]);
366 local ok, ret = prosodyctl.isrunning();
368 show_message(error_messages[ret]);
373 local ok, ret = prosodyctl.getpid();
375 show_message("Couldn't get running Prosody's PID");
376 show_message(error_messages[ret]);
379 show_message("Prosody is already running with PID %s", ret or "(unknown)");
383 local ok, ret = prosodyctl.start();
385 if config.get("*", "core", "daemonize") ~= false then
388 local ok, running = prosodyctl.isrunning();
389 if ok and running then
392 show_message("Still waiting...");
393 elseif i >= prosodyctl_timeout then
394 show_message("Prosody is still not running. Please give it some time or check your log files for errors.");
400 show_message("Started");
405 show_message("Failed to start Prosody");
406 show_message(error_messages[ret])
410 function commands.status(arg)
411 if arg[1] == "--help" then
412 show_usage([[status]], [[Reports the running status of Prosody]]);
416 local ok, ret = prosodyctl.isrunning();
418 show_message(error_messages[ret]);
423 local ok, ret = prosodyctl.getpid();
425 show_message("Couldn't get running Prosody's PID");
426 show_message(error_messages[ret]);
429 show_message("Prosody is running with PID %s", ret or "(unknown)");
432 show_message("Prosody is not running");
433 if not switched_user and current_uid ~= 0 then
435 print(" You will also see this if prosodyctl is not running under");
436 print(" the same user account as Prosody. Try running as root (e.g. ");
437 print(" with 'sudo' in front) to gain access to Prosody's real status.");
444 function commands.stop(arg)
445 if arg[1] == "--help" then
446 show_usage([[stop]], [[Stop a running Prosody server]]);
450 if not prosodyctl.isrunning() then
451 show_message("Prosody is not running");
455 local ok, ret = prosodyctl.stop();
459 local ok, running = prosodyctl.isrunning();
460 if ok and not running then
463 show_message("Still waiting...");
464 elseif i >= prosodyctl_timeout then
465 show_message("Prosody is still running. Please give it some time or check your log files for errors.");
471 show_message("Stopped");
475 show_message(error_messages[ret]);
479 function commands.restart(arg)
480 if arg[1] == "--help" then
481 show_usage([[restart]], [[Restart a running Prosody server]]);
486 return commands.start(arg);
489 function commands.about(arg)
490 if arg[1] == "--help" then
491 show_usage([[about]], [[Show information about this Prosody installation]]);
495 require "util.array";
496 require "util.iterators";
498 print("Prosody "..(prosody.version or "(unknown version)"));
500 print("# Prosody directories");
501 print("Data directory: ", CFG_DATADIR or "./");
502 print("Plugin directory:", CFG_PLUGINDIR or "./");
503 print("Config directory:", CFG_CONFIGDIR or "./");
504 print("Source directory:", CFG_SOURCEDIR or "./");
506 print("# Lua environment");
507 print("Lua version: ", _G._VERSION);
509 print("Lua module search paths:");
510 for path in package.path:gmatch("[^;]+") do
514 print("Lua C module search paths:");
515 for path in package.cpath:gmatch("[^;]+") do
519 local luarocks_status = (pcall(require, "luarocks.loader") and "Installed ("..(luarocks.cfg.program_version or "2.x+")..")")
520 or (pcall(require, "luarocks.require") and "Installed (1.x)")
522 print("LuaRocks: ", luarocks_status);
524 print("# Lua module versions");
525 local module_versions, longest_name = {}, 8;
526 for name, module in pairs(package.loaded) do
527 if type(module) == "table" and rawget(module, "_VERSION")
528 and name ~= "_G" and not name:match("%.") then
529 if #name > longest_name then
530 longest_name = #name;
532 module_versions[name] = module._VERSION;
535 local sorted_keys = array.collect(keys(module_versions)):sort();
536 for _, name in ipairs(array.collect(keys(module_versions)):sort()) do
537 print(name..":"..string.rep(" ", longest_name-#name), module_versions[name]);
542 function commands.reload(arg)
543 if arg[1] == "--help" then
544 show_usage([[reload]], [[Reload Prosody's configuration and re-open log files]]);
548 if not prosodyctl.isrunning() then
549 show_message("Prosody is not running");
553 local ok, ret = prosodyctl.reload();
556 show_message("Prosody log files re-opened and config file reloaded. You may need to reload modules for some changes to take effect.");
560 show_message(error_messages[ret]);
563 -- ejabberdctl compatibility
565 function commands.register(arg)
566 local user, host, password = unpack(arg);
567 if (not (user and host)) or arg[1] == "--help" then
568 if user ~= "--help" then
570 show_message [[No username specified]]
572 show_message [[Please specify which host you want to register the user on]];
575 show_usage("register USER HOST [PASSWORD]", "Register a user on the server, with the given password");
579 password = read_password();
581 show_message [[Unable to register user with no password]];
586 local ok, msg = prosodyctl.adduser { user = user, host = host, password = password };
588 if ok then return 0; end
590 show_message(error_messages[msg])
594 function commands.unregister(arg)
595 local user, host = 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 unregister the user from]];
604 show_usage("unregister USER HOST [PASSWORD]", "Permanently remove a user account from the server");
608 local ok, msg = prosodyctl.deluser { user = user, host = host };
610 if ok then return 0; end
612 show_message(error_messages[msg])
616 local x509 = require "util.x509";
617 local genx509san = x509.genx509san;
618 local opensslbaseconf = x509.baseconf;
619 local seralizeopensslbaseconf = x509.serialize_conf;
621 local cert_commands = {};
623 -- TODO Should this be moved to util.prosodyctl or x509?
624 function cert_commands.config(arg)
625 if #arg >= 1 and arg[1] ~= "--help" then
626 local conf_filename = (CFG_DATADIR or ".") .. "/" .. arg[1] .. ".cnf";
627 if os.execute("test -f "..conf_filename) == 0
628 and not show_yesno("Overwrite "..conf_filename .. "?") then
629 return nil, conf_filename;
631 local conf = opensslbaseconf();
632 conf.subject_alternative_name = genx509san(hosts, config, arg, true)
633 for k, v in pairs(conf.distinguished_name) do
635 if k == "commonName" then
637 elseif k == "emailAddress" then
638 v = "xmpp@" .. arg[1];
640 nv = show_prompt(("%s (%s):"):format(k, nv or v));
641 nv = (not nv or nv == "") and v or nv;
642 conf.distinguished_name[k] = nv ~= "." and nv or nil;
644 local conf_file = io.open(conf_filename, "w");
645 conf_file:write(seralizeopensslbaseconf(conf));
648 show_message("Config written to " .. conf_filename);
649 return nil, conf_filename;
651 show_usage("cert config HOSTNAME", "generates config for OpenSSL")
655 function cert_commands.key(arg)
656 if #arg >= 1 and arg[1] ~= "--help" then
657 local key_filename = (CFG_DATADIR or ".") .. "/" .. arg[1] .. ".key";
658 if os.execute("test -f "..key_filename) == 0
659 and not show_yesno("Overwrite "..key_filename .. "?") then
660 return nil, key_filename;
662 local key_size = tonumber(arg[2] or show_prompt("Choose key size (2048):") or 2048);
663 os.execute(("openssl genrsa -out %s %d"):format(key_filename, tonumber(key_size)));
664 os.execute(("chmod 400 %s"):format(key_filename));
665 show_message("Key written to ".. key_filename);
666 return nil, key_filename;
668 show_usage("cert key HOSTNAME <bits>", "Generates a RSA key")
672 function cert_commands.request(arg)
673 if #arg >= 1 and arg[1] ~= "--help" then
674 local req_filename = (CFG_DATADIR or ".") .. "/" .. arg[1] .. ".req";
675 if os.execute("test -f "..req_filename) == 0
676 and not show_yesno("Overwrite "..req_filename .. "?") then
677 return nil, req_filename;
679 local _, key_filename = cert_commands.key({arg[1]});
680 local _, conf_filename = cert_commands.config({arg[1]});
681 os.execute(("openssl req -new -key %s -utf8 -config %s -out %s")
682 :format(key_filename, conf_filename, req_filename));
683 show_message("Certificate request written to ".. req_filename);
685 show_usage("cert request HOSTNAME", "Generates a certificate request")
689 function cert_commands.generate(arg)
690 if #arg >= 1 and arg[1] ~= "--help" then
691 local cert_filename = (CFG_DATADIR or ".") .. "/" .. arg[1] .. ".cert";
692 if os.execute("test -f "..cert_filename) == 0
693 and not show_yesno("Overwrite "..cert_filename .. "?") then
694 return nil, cert_filename;
696 local _, key_filename = cert_commands.key({arg[1]});
697 local _, conf_filename = cert_commands.config({arg[1]});
698 os.execute(("openssl req -new -x509 -nodes -key %s -days 365 -sha1 -utf8 -config %s -out %s")
699 :format(key_filename, conf_filename, cert_filename));
700 show_message("Certificate written to ".. cert_filename);
702 show_usage("cert generate HOSTNAME", "Generates a self-signed certificate")
706 function commands.cert(arg)
707 if #arg >= 1 and arg[1] ~= "--help" then
708 local subcmd = table.remove(arg, 1);
709 if type(cert_commands[subcmd]) == "function" then
710 return cert_commands[subcmd](arg);
713 show_usage("cert config|request|generate|key", "Helpers for X.509 certificates.")
716 ---------------------
718 if command and command:match("^mod_") then -- Is a command in a module
719 local module_name = command:match("^mod_(.+)");
720 local ret, err = modulemanager.load("*", module_name);
722 show_message("Failed to load module '"..module_name.."': "..err);
726 table.remove(arg, 1);
728 local module = modulemanager.get_module("*", module_name);
730 show_message("Failed to load module '"..module_name.."': Unknown error");
734 if not modulemanager.module_has_method(module, "command") then
735 show_message("Fail: mod_"..module_name.." does not support any commands");
739 local ok, ret = modulemanager.call_module_method(module, "command", arg);
741 if type(ret) == "number" then
743 elseif type(ret) == "string" then
748 show_message("Failed to execute command: "..error_messages[ret]);
753 if not commands[command] then -- Show help for all commands
754 function show_usage(usage, desc)
759 print("prosodyctl - Manage a Prosody server");
761 print("Usage: "..arg[0].." COMMAND [OPTIONS]");
763 print("Where COMMAND may be one of:\n");
765 local hidden_commands = require "util.set".new{ "register", "unregister", "addplugin" };
766 local commands_order = { "adduser", "passwd", "deluser", "start", "stop", "restart", "reload", "about" };
770 for _, command_name in ipairs(commands_order) do
771 local command = commands[command_name];
775 done[command_name] = true;
779 for command_name, command in pairs(commands) do
780 if not done[command_name] and not hidden_commands:contains(command_name) then
783 done[command_name] = true;
791 os.exit(commands[command]({ select(2, unpack(arg)) }));