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"
68 if arg[1] == "--config" and arg[2] then
69 table.insert(filenames, arg[2]);
70 table.remove(arg, 1); table.remove(arg, 1);
72 table.insert(filenames, CFG_CONFIGDIR.."/"..arg[2]);
75 for _, format in ipairs(config.parsers()) do
76 table.insert(filenames, (CFG_CONFIGDIR or ".").."/prosody.cfg."..format);
79 for _,_filename in ipairs(filenames) do
81 local file = io.open(filename);
84 CFG_CONFIGDIR = filename:match("^(.*)[\\/][^\\/]*$");
88 local ok, level, err = config.load(filename);
91 print("**************************");
92 if level == "parser" then
93 print("A problem occured while reading the config file "..(CFG_CONFIGDIR or ".").."/prosody.cfg.lua");
94 local err_line, err_message = tostring(err):match("%[string .-%]:(%d*): (.*)");
95 print("Error"..(err_line and (" on line "..err_line) or "")..": "..(err_message or tostring(err)));
97 elseif level == "file" then
98 print("Prosody was unable to find the configuration file.");
99 print("We looked for: "..(CFG_CONFIGDIR or ".").."/prosody.cfg.lua");
100 print("A sample config file is included in the Prosody download called prosody.cfg.lua.dist");
101 print("Copy or rename it to prosody.cfg.lua and edit as necessary.");
103 print("More help on configuring Prosody can be found at http://prosody.im/doc/configure");
105 print("**************************");
110 local original_logging_config = config.get("*", "core", "log");
111 config.set("*", "core", "log", { { levels = { min="info" }, to = "console" } });
113 local data_path = config.get("*", "core", "data_path") or CFG_DATADIR or "data";
114 local custom_plugin_paths = config.get("*", "core", "plugin_paths");
115 if custom_plugin_paths then
116 local path_sep = package.config:sub(3,3);
117 -- path1;path2;path3;defaultpath...
118 CFG_PLUGINDIR = table.concat(custom_plugin_paths, path_sep)..path_sep..(CFG_PLUGINDIR or "plugins");
120 prosody.paths = { source = CFG_SOURCEDIR, config = CFG_CONFIGDIR,
121 plugins = CFG_PLUGINDIR or "plugins", data = data_path };
123 if prosody.installed then
124 -- Change working directory to data path.
125 require "lfs".chdir(data_path);
128 require "core.loggingmanager"
130 dependencies.log_warnings();
132 -- Switch away from root and into the prosody user --
133 local switched_user, current_uid;
135 local want_pposix_version = "0.3.5";
136 local ok, pposix = pcall(require, "util.pposix");
138 if ok and pposix then
139 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
140 current_uid = pposix.getuid();
141 if current_uid == 0 then
143 local desired_user = config.get("*", "core", "prosody_user") or "prosody";
144 local desired_group = config.get("*", "core", "prosody_group") or desired_user;
145 local ok, err = pposix.setgid(desired_group);
147 ok, err = pposix.initgroups(desired_user);
150 ok, err = pposix.setuid(desired_user);
153 switched_user = true;
156 if not switched_user then
158 print("Warning: Couldn't switch to Prosody user/group '"..tostring(desired_user).."'/'"..tostring(desired_group).."': "..tostring(err));
162 -- Set our umask to protect data files
163 pposix.umask(config.get("*", "core", "umask") or "027");
164 pposix.setenv("HOME", data_path);
166 print("Error: Unable to load pposix module. Check that Prosody is installed correctly.")
167 print("For more help send the below error to us through http://prosody.im/discuss");
168 print(tostring(pposix))
172 local function test_writeable(filename)
173 local f, err = io.open(filename, "a");
181 local unwriteable_files = {};
182 if type(original_logging_config) == "string" and original_logging_config:sub(1,1) ~= "*" then
183 local ok, err = test_writeable(original_logging_config);
185 table.insert(unwriteable_files, err);
187 elseif type(original_logging_config) == "table" then
188 for _, rule in ipairs(original_logging_config) do
189 if rule.filename then
190 local ok, err = test_writeable(rule.filename);
192 table.insert(unwriteable_files, err);
198 if #unwriteable_files > 0 then
199 print("One of more of the Prosody log files are not");
200 print("writeable, please correct the errors and try");
201 print("starting prosodyctl again.");
203 for _, err in ipairs(unwriteable_files) do
211 local error_messages = setmetatable({
212 ["invalid-username"] = "The given username is invalid in a Jabber ID";
213 ["invalid-hostname"] = "The given hostname is invalid";
214 ["no-password"] = "No password was supplied";
215 ["no-such-user"] = "The given user does not exist on the server";
216 ["no-such-host"] = "The given hostname does not exist in the config";
217 ["unable-to-save-data"] = "Unable to store, perhaps you don't have permission?";
218 ["no-pidfile"] = "There is no 'pidfile' option in the configuration file, see http://prosody.im/doc/prosodyctl#pidfile for help";
219 ["no-posix"] = "The mod_posix module is not enabled in the Prosody config file, see http://prosody.im/doc/prosodyctl for more info";
220 ["no-such-method"] = "This module has no commands";
221 ["not-running"] = "Prosody is not running";
222 }, { __index = function (t,k) return "Error: "..(tostring(k):gsub("%-", " "):gsub("^.", string.upper)); end });
224 hosts = prosody.hosts;
226 local function make_host(hostname)
229 events = prosody.events,
231 users = require "core.usermanager".new_null_provider(hostname)
235 for hostname, config in pairs(config.getconfig()) do
236 hosts[hostname] = make_host(hostname);
239 local modulemanager = require "core.modulemanager"
241 local prosodyctl = require "util.prosodyctl"
243 -----------------------
245 -- FIXME: Duplicate code waiting for util.startup
246 function read_version()
247 -- Try to determine version
248 local version_file = io.open((CFG_SOURCEDIR or ".").."/prosody.version");
250 prosody.version = version_file:read("*a"):gsub("%s*$", "");
251 version_file:close();
252 if #prosody.version == 12 and prosody.version:match("^[a-f0-9]+$") then
253 prosody.version = "hg:"..prosody.version;
256 prosody.version = "unknown";
260 local show_message, show_warning = prosodyctl.show_message, prosodyctl.show_warning;
261 local show_usage = prosodyctl.show_usage;
262 local getchar, getpass = prosodyctl.getchar, prosodyctl.getpass;
263 local show_yesno = prosodyctl.show_yesno;
264 local show_prompt = prosodyctl.show_prompt;
265 local read_password = prosodyctl.read_password;
267 local prosodyctl_timeout = (config.get("*", "core", "prosodyctl_timeout") or 5) * 2;
268 -----------------------
270 local command = arg[1];
272 function commands.adduser(arg)
273 if not arg[1] or arg[1] == "--help" then
274 show_usage([[adduser JID]], [[Create the specified user account in Prosody]]);
277 local user, host = arg[1]:match("([^@]+)@(.+)");
278 if not user and host then
279 show_message [[Failed to understand JID, please supply the JID you want to create]]
280 show_usage [[adduser user@host]]
285 show_message [[Please specify a JID, including a host. e.g. alice@example.com]];
289 if not hosts[host] then
290 show_warning("The host '%s' is not listed in the configuration file (or is not enabled).", host)
291 show_warning("The user will not be able to log in until this is changed.");
292 hosts[host] = make_host(host);
295 if prosodyctl.user_exists{ user = user, host = host } then
296 show_message [[That user already exists]];
300 local password = read_password();
301 if not password then return 1; end
303 local ok, msg = prosodyctl.adduser { user = user, host = host, password = password };
305 if ok then return 0; end
311 function commands.passwd(arg)
312 if not arg[1] or arg[1] == "--help" then
313 show_usage([[passwd JID]], [[Set the password for the specified user account in Prosody]]);
316 local user, host = arg[1]:match("([^@]+)@(.+)");
317 if not user and host then
318 show_message [[Failed to understand JID, please supply the JID you want to set the password for]]
319 show_usage [[passwd user@host]]
324 show_message [[Please specify a JID, including a host. e.g. alice@example.com]];
328 if not hosts[host] then
329 show_warning("The host '%s' is not listed in the configuration file (or is not enabled).", host)
330 show_warning("The user will not be able to log in until this is changed.");
331 hosts[host] = make_host(host);
334 if not prosodyctl.user_exists { user = user, host = host } then
335 show_message [[That user does not exist, use prosodyctl adduser to create a new user]]
339 local password = read_password();
340 if not password then return 1; end
342 local ok, msg = prosodyctl.passwd { user = user, host = host, password = password };
344 if ok then return 0; end
346 show_message(error_messages[msg])
350 function commands.deluser(arg)
351 if not arg[1] or arg[1] == "--help" then
352 show_usage([[deluser JID]], [[Permanently remove the specified user account from Prosody]]);
355 local user, host = arg[1]:match("([^@]+)@(.+)");
356 if not user and host then
357 show_message [[Failed to understand JID, please supply the JID you want to set the password for]]
358 show_usage [[passwd user@host]]
363 show_message [[Please specify a JID, including a host. e.g. alice@example.com]];
367 if not hosts[host] then
368 show_warning("The host '%s' is not listed in the configuration file (or is not enabled).", host)
369 show_warning("The user will not be able to log in until this is changed.");
370 hosts[host] = make_host(host);
373 if not prosodyctl.user_exists { user = user, host = host } then
374 show_message [[That user does not exist on this server]]
378 local ok, msg = prosodyctl.deluser { user = user, host = host };
380 if ok then return 0; end
382 show_message(error_messages[msg])
386 function commands.start(arg)
387 if arg[1] == "--help" then
388 show_usage([[start]], [[Start Prosody]]);
391 local ok, ret = prosodyctl.isrunning();
393 show_message(error_messages[ret]);
398 local ok, ret = prosodyctl.getpid();
400 show_message("Couldn't get running Prosody's PID");
401 show_message(error_messages[ret]);
404 show_message("Prosody is already running with PID %s", ret or "(unknown)");
408 local ok, ret = prosodyctl.start();
410 if config.get("*", "core", "daemonize") ~= false then
413 local ok, running = prosodyctl.isrunning();
414 if ok and running then
417 show_message("Still waiting...");
418 elseif i >= prosodyctl_timeout then
419 show_message("Prosody is still not running. Please give it some time or check your log files for errors.");
425 show_message("Started");
430 show_message("Failed to start Prosody");
431 show_message(error_messages[ret])
435 function commands.status(arg)
436 if arg[1] == "--help" then
437 show_usage([[status]], [[Reports the running status of Prosody]]);
441 local ok, ret = prosodyctl.isrunning();
443 show_message(error_messages[ret]);
448 local ok, ret = prosodyctl.getpid();
450 show_message("Couldn't get running Prosody's PID");
451 show_message(error_messages[ret]);
454 show_message("Prosody is running with PID %s", ret or "(unknown)");
457 show_message("Prosody is not running");
458 if not switched_user and current_uid ~= 0 then
460 print(" You will also see this if prosodyctl is not running under");
461 print(" the same user account as Prosody. Try running as root (e.g. ");
462 print(" with 'sudo' in front) to gain access to Prosody's real status.");
469 function commands.stop(arg)
470 if arg[1] == "--help" then
471 show_usage([[stop]], [[Stop a running Prosody server]]);
475 if not prosodyctl.isrunning() then
476 show_message("Prosody is not running");
480 local ok, ret = prosodyctl.stop();
484 local ok, running = prosodyctl.isrunning();
485 if ok and not running then
488 show_message("Still waiting...");
489 elseif i >= prosodyctl_timeout then
490 show_message("Prosody is still running. Please give it some time or check your log files for errors.");
496 show_message("Stopped");
500 show_message(error_messages[ret]);
504 function commands.restart(arg)
505 if arg[1] == "--help" then
506 show_usage([[restart]], [[Restart a running Prosody server]]);
511 return commands.start(arg);
514 function commands.about(arg)
516 if arg[1] == "--help" then
517 show_usage([[about]], [[Show information about this Prosody installation]]);
521 local array = require "util.array";
522 local keys = require "util.iterators".keys;
524 print("Prosody "..(prosody.version or "(unknown version)"));
526 print("# Prosody directories");
527 print("Data directory: ", CFG_DATADIR or "./");
528 print("Plugin directory:", CFG_PLUGINDIR or "./");
529 print("Config directory:", CFG_CONFIGDIR or "./");
530 print("Source directory:", CFG_SOURCEDIR or "./");
532 print("# Lua environment");
533 print("Lua version: ", _G._VERSION);
535 print("Lua module search paths:");
536 for path in package.path:gmatch("[^;]+") do
540 print("Lua C module search paths:");
541 for path in package.cpath:gmatch("[^;]+") do
545 local luarocks_status = (pcall(require, "luarocks.loader") and "Installed ("..(luarocks.cfg.program_version or "2.x+")..")")
546 or (pcall(require, "luarocks.require") and "Installed (1.x)")
548 print("LuaRocks: ", luarocks_status);
550 print("# Lua module versions");
551 local module_versions, longest_name = {}, 8;
552 for name, module in pairs(package.loaded) do
553 if type(module) == "table" and rawget(module, "_VERSION")
554 and name ~= "_G" and not name:match("%.") then
555 if #name > longest_name then
556 longest_name = #name;
558 module_versions[name] = module._VERSION;
561 local sorted_keys = array.collect(keys(module_versions)):sort();
562 for _, name in ipairs(array.collect(keys(module_versions)):sort()) do
563 print(name..":"..string.rep(" ", longest_name-#name), module_versions[name]);
568 function commands.reload(arg)
569 if arg[1] == "--help" then
570 show_usage([[reload]], [[Reload Prosody's configuration and re-open log files]]);
574 if not prosodyctl.isrunning() then
575 show_message("Prosody is not running");
579 local ok, ret = prosodyctl.reload();
582 show_message("Prosody log files re-opened and config file reloaded. You may need to reload modules for some changes to take effect.");
586 show_message(error_messages[ret]);
589 -- ejabberdctl compatibility
591 function commands.register(arg)
592 local user, host, password = unpack(arg);
593 if (not (user and host)) or arg[1] == "--help" then
594 if user ~= "--help" then
596 show_message [[No username specified]]
598 show_message [[Please specify which host you want to register the user on]];
601 show_usage("register USER HOST [PASSWORD]", "Register a user on the server, with the given password");
605 password = read_password();
607 show_message [[Unable to register user with no password]];
612 local ok, msg = prosodyctl.adduser { user = user, host = host, password = password };
614 if ok then return 0; end
616 show_message(error_messages[msg])
620 function commands.unregister(arg)
621 local user, host = unpack(arg);
622 if (not (user and host)) or arg[1] == "--help" then
623 if user ~= "--help" then
625 show_message [[No username specified]]
627 show_message [[Please specify which host you want to unregister the user from]];
630 show_usage("unregister USER HOST [PASSWORD]", "Permanently remove a user account from the server");
634 local ok, msg = prosodyctl.deluser { user = user, host = host };
636 if ok then return 0; end
638 show_message(error_messages[msg])
645 local cert_commands = {};
647 local function ask_overwrite(filename)
648 return lfs.attributes(filename) and not show_yesno("Overwrite "..filename .. "?");
651 function cert_commands.config(arg)
652 if #arg >= 1 and arg[1] ~= "--help" then
653 local conf_filename = (CFG_DATADIR or ".") .. "/" .. arg[1] .. ".cnf";
654 if ask_overwrite(conf_filename) then
655 return nil, conf_filename;
657 local conf = openssl.config.new();
658 conf:from_prosody(hosts, config, arg);
659 for k, v in pairs(conf.distinguished_name) do
661 if k == "commonName" then
663 elseif k == "emailAddress" then
664 v = "xmpp@" .. arg[1];
666 nv = show_prompt(("%s (%s):"):format(k, nv or v));
667 nv = (not nv or nv == "") and v or nv;
668 if nv:find"[\192-\252][\128-\191]+" then
669 conf.req.string_mask = "utf8only"
671 conf.distinguished_name[k] = nv ~= "." and nv or nil;
673 local conf_file = io.open(conf_filename, "w");
674 conf_file:write(conf:serialize());
677 show_message("Config written to " .. conf_filename);
678 return nil, conf_filename;
680 show_usage("cert config HOSTNAME [HOSTNAME+]", "Builds a certificate config file covering the supplied hostname(s)")
684 function cert_commands.key(arg)
685 if #arg >= 1 and arg[1] ~= "--help" then
686 local key_filename = (CFG_DATADIR or ".") .. "/" .. arg[1] .. ".key";
687 if ask_overwrite(key_filename) then
688 return nil, key_filename;
690 os.remove(key_filename); -- This file, if it exists is unlikely to have write permissions
691 local key_size = tonumber(arg[2] or show_prompt("Choose key size (2048):") or 2048);
692 local old_umask = pposix.umask("0377");
693 if openssl.genrsa{out=key_filename, key_size} then
694 os.execute(("chmod 400 '%s'"):format(key_filename));
695 show_message("Key written to ".. key_filename);
696 pposix.umask(old_umask);
697 return nil, key_filename;
699 show_message("There was a problem, see OpenSSL output");
701 show_usage("cert key HOSTNAME <bits>", "Generates a RSA key named HOSTNAME.key\n "
702 .."Prompts for a key size if none given")
706 function cert_commands.request(arg)
707 if #arg >= 1 and arg[1] ~= "--help" then
708 local req_filename = (CFG_DATADIR or ".") .. "/" .. arg[1] .. ".req";
709 if ask_overwrite(req_filename) then
710 return nil, req_filename;
712 local _, key_filename = cert_commands.key({arg[1]});
713 local _, conf_filename = cert_commands.config(arg);
714 if openssl.req{new=true, key=key_filename, utf8=true, config=conf_filename, out=req_filename} then
715 show_message("Certificate request written to ".. req_filename);
717 show_message("There was a problem, see OpenSSL output");
720 show_usage("cert request HOSTNAME [HOSTNAME+]", "Generates a certificate request for the supplied hostname(s)")
724 function cert_commands.generate(arg)
725 if #arg >= 1 and arg[1] ~= "--help" then
726 local cert_filename = (CFG_DATADIR or ".") .. "/" .. arg[1] .. ".crt";
727 if ask_overwrite(cert_filename) then
728 return nil, cert_filename;
730 local _, key_filename = cert_commands.key({arg[1]});
731 local _, conf_filename = cert_commands.config(arg);
733 if key_filename and conf_filename and cert_filename
734 and openssl.req{new=true, x509=true, nodes=true, key=key_filename,
735 days=365, sha1=true, utf8=true, config=conf_filename, out=cert_filename} then
736 show_message("Certificate written to ".. cert_filename);
738 show_message("There was a problem, see OpenSSL output");
741 show_usage("cert generate HOSTNAME [HOSTNAME+]", "Generates a self-signed certificate for the current hostname(s)")
745 function commands.cert(arg)
746 if #arg >= 1 and arg[1] ~= "--help" then
747 openssl = require "util.openssl";
749 local subcmd = table.remove(arg, 1);
750 if type(cert_commands[subcmd]) == "function" then
752 show_message"You need to supply at least one hostname"
755 if arg[1] ~= "--help" and not hosts[arg[1]] then
756 show_message(error_messages["no-such-host"]);
759 return cert_commands[subcmd](arg);
762 show_usage("cert config|request|generate|key", "Helpers for generating X.509 certificates and keys.")
765 ---------------------
767 if command and command:match("^mod_") then -- Is a command in a module
768 local module_name = command:match("^mod_(.+)");
769 local ret, err = modulemanager.load("*", module_name);
771 show_message("Failed to load module '"..module_name.."': "..err);
775 table.remove(arg, 1);
777 local module = modulemanager.get_module("*", module_name);
779 show_message("Failed to load module '"..module_name.."': Unknown error");
783 if not modulemanager.module_has_method(module, "command") then
784 show_message("Fail: mod_"..module_name.." does not support any commands");
788 local ok, ret = modulemanager.call_module_method(module, "command", arg);
790 if type(ret) == "number" then
792 elseif type(ret) == "string" then
797 show_message("Failed to execute command: "..error_messages[ret]);
802 if not commands[command] then -- Show help for all commands
803 function show_usage(usage, desc)
808 print("prosodyctl - Manage a Prosody server");
810 print("Usage: "..arg[0].." COMMAND [OPTIONS]");
812 print("Where COMMAND may be one of:\n");
814 local hidden_commands = require "util.set".new{ "register", "unregister", "addplugin" };
815 local commands_order = { "adduser", "passwd", "deluser", "start", "stop", "restart", "reload", "about" };
819 for _, command_name in ipairs(commands_order) do
820 local command = commands[command_name];
824 done[command_name] = true;
828 for command_name, command in pairs(commands) do
829 if not done[command_name] and not hidden_commands:contains(command_name) then
832 done[command_name] = true;
840 os.exit(commands[command]({ select(2, unpack(arg)) }));