mod_privacy: Fix selecting the top resource (fixes #694)
[prosody.git] / prosodyctl
index cfc5ca77a979d74268a5483455984ec2da170462..4c3ae981521e6ee2b109589fc729ba09af18cf45 100755 (executable)
@@ -18,10 +18,22 @@ CFG_DATADIR=os.getenv("PROSODY_DATADIR");
 
 -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --
 
+local function is_relative(path)
+       local path_sep = package.config:sub(1,1);
+        return ((path_sep == "/" and path:sub(1,1) ~= "/")
+       or (path_sep == "\\" and (path:sub(1,1) ~= "/" and path:sub(2,3) ~= ":\\")))
+end
+
 -- Tell Lua where to find our libraries
 if CFG_SOURCEDIR then
-       package.path = CFG_SOURCEDIR.."/?.lua;"..package.path;
-       package.cpath = CFG_SOURCEDIR.."/?.so;"..package.cpath;
+       local function filter_relative_paths(path)
+               if is_relative(path) then return ""; end
+       end
+       local function sanitise_paths(paths)
+               return (paths:gsub("[^;]+;?", filter_relative_paths):gsub(";;+", ";"));
+       end
+       package.path = sanitise_paths(CFG_SOURCEDIR.."/?.lua;"..package.path);
+       package.cpath = sanitise_paths(CFG_SOURCEDIR.."/?.so;"..package.cpath);
 end
 
 -- Substitute ~ with path to home directory in data path
@@ -32,27 +44,35 @@ if CFG_DATADIR then
 end
 
 -- Global 'prosody' object
-prosody = {
+local prosody = {
        hosts = {};
        events = require "util.events".new();
        platform = "posix";
        lock_globals = function () end;
        unlock_globals = function () end;
+       installed = CFG_SOURCEDIR ~= nil;
+       core_post_stanza = function () end; -- TODO: mod_router!
 };
-local prosody = prosody;
+_G.prosody = prosody;
+
+local dependencies = require "util.dependencies";
+if not dependencies.check_dependencies() then
+       os.exit(1);
+end
 
 config = require "core.configmanager"
 
+local ENV_CONFIG;
 do
        local filenames = {};
        
        local filename;
        if arg[1] == "--config" and arg[2] then
                table.insert(filenames, arg[2]);
-               table.remove(arg, 1); table.remove(arg, 1);
                if CFG_CONFIGDIR then
                        table.insert(filenames, CFG_CONFIGDIR.."/"..arg[2]);
                end
+               table.remove(arg, 1); table.remove(arg, 1);
        else
                for _, format in ipairs(config.parsers()) do
                        table.insert(filenames, (CFG_CONFIGDIR or ".").."/prosody.cfg."..format);
@@ -63,6 +83,7 @@ do
                local file = io.open(filename);
                if file then
                        file:close();
+                       ENV_CONFIG = filename;
                        CFG_CONFIGDIR = filename:match("^(.*)[\\/][^\\/]*$");
                        break;
                end
@@ -89,22 +110,32 @@ do
                os.exit(1);
        end
 end
-local original_logging_config = config.get("*", "core", "log");
-config.set("*", "core", "log", { { levels = { min="info" }, to = "console" } });
-
-require "core.loggingmanager"
+local original_logging_config = config.get("*", "log");
+config.set("*", "log", { { levels = { min="info" }, to = "console" } });
+
+local data_path = config.get("*", "data_path") or CFG_DATADIR or "data";
+local custom_plugin_paths = config.get("*", "plugin_paths");
+if custom_plugin_paths then
+       local path_sep = package.config:sub(3,3);
+       -- path1;path2;path3;defaultpath...
+       CFG_PLUGINDIR = table.concat(custom_plugin_paths, path_sep)..path_sep..(CFG_PLUGINDIR or "plugins");
+end
+prosody.paths = { source = CFG_SOURCEDIR, config = CFG_CONFIGDIR, 
+                 plugins = CFG_PLUGINDIR or "plugins", data = data_path };
 
-if not require "util.dependencies".check_dependencies() then
-       os.exit(1);
+if prosody.installed then
+       -- Change working directory to data path.
+       require "lfs".chdir(data_path);
 end
 
-local data_path = config.get("*", "core", "data_path") or CFG_DATADIR or "data";
-require "util.datamanager".set_data_path(data_path);
+require "core.loggingmanager"
+
+dependencies.log_warnings();
 
 -- Switch away from root and into the prosody user --
 local switched_user, current_uid;
 
-local want_pposix_version = "0.3.5";
+local want_pposix_version = "0.3.6";
 local ok, pposix = pcall(require, "util.pposix");
 
 if ok and pposix then
@@ -112,8 +143,8 @@ if ok and pposix then
        current_uid = pposix.getuid();
        if current_uid == 0 then
                -- We haz root!
-               local desired_user = config.get("*", "core", "prosody_user") or "prosody";
-               local desired_group = config.get("*", "core", "prosody_group") or desired_user;
+               local desired_user = config.get("*", "prosody_user") or "prosody";
+               local desired_group = config.get("*", "prosody_group") or desired_user;
                local ok, err = pposix.setgid(desired_group);
                if ok then
                        ok, err = pposix.initgroups(desired_user);
@@ -132,11 +163,14 @@ if ok and pposix then
        end
        
        -- Set our umask to protect data files
-       pposix.umask(config.get("*", "core", "umask") or "027");
+       pposix.umask(config.get("*", "umask") or "027");
+       pposix.setenv("HOME", data_path);
+       pposix.setenv("PROSODY_CONFIG", ENV_CONFIG);
 else
        print("Error: Unable to load pposix module. Check that Prosody is installed correctly.")
        print("For more help send the below error to us through http://prosody.im/discuss");
        print(tostring(pposix))
+       os.exit(1);
 end
 
 local function test_writeable(filename)
@@ -183,8 +217,10 @@ local error_messages = setmetatable({
                ["invalid-hostname"] = "The given hostname is invalid";
                ["no-password"] = "No password was supplied";
                ["no-such-user"] = "The given user does not exist on the server";
+               ["no-such-host"] = "The given hostname does not exist in the config";
                ["unable-to-save-data"] = "Unable to store, perhaps you don't have permission?";
                ["no-pidfile"] = "There is no 'pidfile' option in the configuration file, see http://prosody.im/doc/prosodyctl#pidfile for help";
+               ["invalid-pidfile"] = "The 'pidfile' option in the configuration file is not a string, see http://prosody.im/doc/prosodyctl#pidfile for help";
                ["no-posix"] = "The mod_posix module is not enabled in the Prosody config file, see http://prosody.im/doc/prosodyctl for more info";
                ["no-such-method"] = "This module has no commands";
                ["not-running"] = "Prosody is not running";
@@ -196,6 +232,7 @@ local function make_host(hostname)
        return {
                type = "local",
                events = prosody.events,
+               modules = {},
                users = require "core.usermanager".new_null_provider(hostname)
        };
 end
@@ -204,94 +241,37 @@ for hostname, config in pairs(config.getconfig()) do
        hosts[hostname] = make_host(hostname);
 end
        
-require "core.modulemanager"
+local modulemanager = require "core.modulemanager"
 
-require "util.prosodyctl"
+local prosodyctl = require "util.prosodyctl"
 require "socket"
 -----------------------
 
-function show_message(msg, ...)
-       print(msg:format(...));
-end
-
-function show_warning(msg, ...)
-       print(msg:format(...));
-end
-
-function show_usage(usage, desc)
-       print("Usage: "..arg[0].." "..usage);
-       if desc then
-               print(" "..desc);
-       end
-end
-
-local function getchar(n)
-       local stty_ret = os.execute("stty raw -echo 2>/dev/null");
-       local ok, char;
-       if stty_ret == 0 then
-               ok, char = pcall(io.read, n or 1);
-               os.execute("stty sane");
-       else
-               ok, char = pcall(io.read, "*l");
-               if ok then
-                       char = char:sub(1, n or 1);
+ -- FIXME: Duplicate code waiting for util.startup
+function read_version()
+       -- Try to determine version
+       local version_file = io.open((CFG_SOURCEDIR or ".").."/prosody.version");
+       if version_file then
+               prosody.version = version_file:read("*a"):gsub("%s*$", "");
+               version_file:close();
+               if #prosody.version == 12 and prosody.version:match("^[a-f0-9]+$") then
+                       prosody.version = "hg:"..prosody.version;
                end
-       end
-       if ok then
-               return char;
-       end
-end
-       
-local function getpass()
-       local stty_ret = os.execute("stty -echo 2>/dev/null");
-       if stty_ret ~= 0 then
-               io.write("\027[08m"); -- ANSI 'hidden' text attribute
-       end
-       local ok, pass = pcall(io.read, "*l");
-       if stty_ret == 0 then
-               os.execute("stty sane");
        else
-               io.write("\027[00m");
-       end
-       io.write("\n");
-       if ok then
-               return pass;
+               prosody.version = "unknown";
        end
 end
 
-function show_yesno(prompt)
-       io.write(prompt, " ");
-       local choice = getchar():lower();
-       io.write("\n");
-       if not choice:match("%a") then
-               choice = prompt:match("%[.-(%U).-%]$");
-               if not choice then return nil; end
-       end
-       return (choice == "y");
-end
+local show_message, show_warning = prosodyctl.show_message, prosodyctl.show_warning;
+local show_usage = prosodyctl.show_usage;
+local getchar, getpass = prosodyctl.getchar, prosodyctl.getpass;
+local show_yesno = prosodyctl.show_yesno;
+local show_prompt = prosodyctl.show_prompt;
+local read_password = prosodyctl.read_password;
 
-local function read_password()
-       local password;
-       while true do
-               io.write("Enter new password: ");
-               password = getpass();
-               if not password then
-                       show_message("No password - cancelled");
-                       return;
-               end
-               io.write("Retype new password: ");
-               if getpass() ~= password then
-                       if not show_yesno [=[Passwords did not match, try again? [Y/n]]=] then
-                               return;
-                       end
-               else
-                       break;
-               end
-       end
-       return password;
-end
+local jid_split = require "util.jid".prepped_split;
 
-local prosodyctl_timeout = (config.get("*", "core", "prosodyctl_timeout") or 5) * 2;
+local prosodyctl_timeout = (config.get("*", "prosodyctl_timeout") or 5) * 2;
 -----------------------
 local commands = {};
 local command = arg[1];
@@ -301,7 +281,7 @@ function commands.adduser(arg)
                show_usage([[adduser JID]], [[Create the specified user account in Prosody]]);
                return 1;
        end
-       local user, host = arg[1]:match("([^@]+)@(.+)");
+       local user, host = jid_split(arg[1]);
        if not user and host then
                show_message [[Failed to understand JID, please supply the JID you want to create]]
                show_usage [[adduser user@host]]
@@ -340,7 +320,7 @@ function commands.passwd(arg)
                show_usage([[passwd JID]], [[Set the password for the specified user account in Prosody]]);
                return 1;
        end
-       local user, host = arg[1]:match("([^@]+)@(.+)");
+       local user, host = jid_split(arg[1])
        if not user and host then
                show_message [[Failed to understand JID, please supply the JID you want to set the password for]]
                show_usage [[passwd user@host]]
@@ -379,7 +359,7 @@ function commands.deluser(arg)
                show_usage([[deluser JID]], [[Permanently remove the specified user account from Prosody]]);
                return 1;
        end
-       local user, host = arg[1]:match("([^@]+)@(.+)");
+       local user, host = jid_split(arg[1]);
        if not user and host then
                show_message [[Failed to understand JID, please supply the JID you want to set the password for]]
                show_usage [[passwd user@host]]
@@ -393,7 +373,6 @@ function commands.deluser(arg)
        
        if not hosts[host] then
                show_warning("The host '%s' is not listed in the configuration file (or is not enabled).", host)
-               show_warning("The user will not be able to log in until this is changed.");
                hosts[host] = make_host(host);
        end
 
@@ -402,7 +381,7 @@ function commands.deluser(arg)
                return 1;
        end
        
-       local ok, msg = prosodyctl.passwd { user = user, host = host };
+       local ok, msg = prosodyctl.deluser { user = user, host = host };
        
        if ok then return 0; end
        
@@ -434,7 +413,7 @@ function commands.start(arg)
        
        local ok, ret = prosodyctl.start();
        if ok then
-               if config.get("*", "core", "daemonize") ~= false then
+               if config.get("*", "daemonize") ~= false then
                        local i=1;
                        while true do
                                local ok, running = prosodyctl.isrunning();
@@ -538,6 +517,81 @@ function commands.restart(arg)
        return commands.start(arg);
 end
 
+function commands.about(arg)
+       read_version();
+       if arg[1] == "--help" then
+               show_usage([[about]], [[Show information about this Prosody installation]]);
+               return 1;
+       end
+       
+       local array = require "util.array";
+       local keys = require "util.iterators".keys;
+       
+       print("Prosody "..(prosody.version or "(unknown version)"));
+       print("");
+       print("# Prosody directories");
+       print("Data directory:  ", CFG_DATADIR or "./");
+       print("Plugin directory:", CFG_PLUGINDIR or "./");
+       print("Config directory:", CFG_CONFIGDIR or "./");
+       print("Source directory:", CFG_SOURCEDIR or "./");
+       print("");
+       print("# Lua environment");
+       print("Lua version:             ", _G._VERSION);
+       print("");
+       print("Lua module search paths:");
+       for path in package.path:gmatch("[^;]+") do
+               print("  "..path);
+       end
+       print("");
+       print("Lua C module search paths:");
+       for path in package.cpath:gmatch("[^;]+") do
+               print("  "..path);
+       end
+       print("");
+       local luarocks_status = (pcall(require, "luarocks.loader") and "Installed ("..(package.loaded["luarocks.cfg"].program_version or "2.x+")..")")
+               or (pcall(require, "luarocks.require") and "Installed (1.x)")
+               or "Not installed";
+       print("LuaRocks:        ", luarocks_status);
+       print("");
+       print("# Lua module versions");
+       local module_versions, longest_name = {}, 8;
+       for name, module in pairs(package.loaded) do
+               if type(module) == "table" and rawget(module, "_VERSION")
+               and name ~= "_G" and not name:match("%.") then
+                       if #name > longest_name then
+                               longest_name = #name;
+                       end
+                       module_versions[name] = module._VERSION;
+               end
+       end
+       local sorted_keys = array.collect(keys(module_versions)):sort();
+       for _, name in ipairs(array.collect(keys(module_versions)):sort()) do
+               print(name..":"..string.rep(" ", longest_name-#name), module_versions[name]);
+       end
+       print("");
+end
+
+function commands.reload(arg)
+       if arg[1] == "--help" then
+               show_usage([[reload]], [[Reload Prosody's configuration and re-open log files]]);
+               return 1;
+       end
+
+       if not prosodyctl.isrunning() then
+               show_message("Prosody is not running");
+               return 1;
+       end
+       
+       local ok, ret = prosodyctl.reload();
+       if ok then
+               
+               show_message("Prosody log files re-opened and config file reloaded. You may need to reload modules for some changes to take effect.");
+               return 0;
+       end
+
+       show_message(error_messages[ret]);
+       return 1;
+end
 -- ejabberdctl compatibility
 
 function commands.register(arg)
@@ -591,6 +645,144 @@ function commands.unregister(arg)
        return 1;
 end
 
+local openssl;
+local lfs;
+
+local cert_commands = {};
+
+local function ask_overwrite(filename)
+       return lfs.attributes(filename) and not show_yesno("Overwrite "..filename .. "?");
+end
+
+function cert_commands.config(arg)
+       if #arg >= 1 and arg[1] ~= "--help" then
+               local conf_filename = (CFG_DATADIR or "./certs") .. "/" .. arg[1] .. ".cnf";
+               if ask_overwrite(conf_filename) then
+                       return nil, conf_filename;
+               end
+               local conf = openssl.config.new();
+               conf:from_prosody(hosts, config, arg);
+               show_message("Please provide details to include in the certificate config file.");
+               show_message("Leave the field empty to use the default value or '.' to exclude the field.")
+               for i, k in ipairs(openssl._DN_order) do
+                       local v = conf.distinguished_name[k];
+                       if v then
+                               local nv;
+                               if k == "commonName" then
+                                       v = arg[1]
+                               elseif k == "emailAddress" then
+                                       v = "xmpp@" .. arg[1];
+                               elseif k == "countryName" then
+                                       local tld = arg[1]:match"%.([a-z]+)$";
+                                       if tld and #tld == 2 and tld ~= "uk" then
+                                               v = tld:upper();
+                                       end
+                               end
+                               nv = show_prompt(("%s (%s):"):format(k, nv or v));
+                               nv = (not nv or nv == "") and v or nv;
+                               if nv:find"[\192-\252][\128-\191]+" then
+                                       conf.req.string_mask = "utf8only"
+                               end
+                               conf.distinguished_name[k] = nv ~= "." and nv or nil;
+                       end
+               end
+               local conf_file, err = io.open(conf_filename, "w");
+               if not conf_file then
+                       show_warning("Could not open OpenSSL config file for writing");
+                       show_warning(err);
+                       os.exit(1);
+               end
+               conf_file:write(conf:serialize());
+               conf_file:close();
+               print("");
+               show_message("Config written to " .. conf_filename);
+               return nil, conf_filename;
+       else
+               show_usage("cert config HOSTNAME [HOSTNAME+]", "Builds a certificate config file covering the supplied hostname(s)")
+       end
+end
+
+function cert_commands.key(arg)
+       if #arg >= 1 and arg[1] ~= "--help" then
+               local key_filename = (CFG_DATADIR or "./certs") .. "/" .. arg[1] .. ".key";
+               if ask_overwrite(key_filename) then
+                       return nil, key_filename;
+               end
+               os.remove(key_filename); -- This file, if it exists is unlikely to have write permissions
+               local key_size = tonumber(arg[2] or show_prompt("Choose key size (2048):") or 2048);
+               local old_umask = pposix.umask("0377");
+               if openssl.genrsa{out=key_filename, key_size} then
+                       os.execute(("chmod 400 '%s'"):format(key_filename));
+                       show_message("Key written to ".. key_filename);
+                       pposix.umask(old_umask);
+                       return nil, key_filename;
+               end
+               show_message("There was a problem, see OpenSSL output");
+       else
+               show_usage("cert key HOSTNAME <bits>", "Generates a RSA key named HOSTNAME.key\n "
+               .."Prompts for a key size if none given")
+       end
+end
+
+function cert_commands.request(arg)
+       if #arg >= 1 and arg[1] ~= "--help" then
+               local req_filename = (CFG_DATADIR or "./certs") .. "/" .. arg[1] .. ".req";
+               if ask_overwrite(req_filename) then
+                       return nil, req_filename;
+               end
+               local _, key_filename = cert_commands.key({arg[1]});
+               local _, conf_filename = cert_commands.config(arg);
+               if openssl.req{new=true, key=key_filename, utf8=true, config=conf_filename, out=req_filename} then
+                       show_message("Certificate request written to ".. req_filename);
+               else
+                       show_message("There was a problem, see OpenSSL output");
+               end
+       else
+               show_usage("cert request HOSTNAME [HOSTNAME+]", "Generates a certificate request for the supplied hostname(s)")
+       end
+end
+
+function cert_commands.generate(arg)
+       if #arg >= 1 and arg[1] ~= "--help" then
+               local cert_filename = (CFG_DATADIR or "./certs") .. "/" .. arg[1] .. ".crt";
+               if ask_overwrite(cert_filename) then
+                       return nil, cert_filename;
+               end
+               local _, key_filename = cert_commands.key({arg[1]});
+               local _, conf_filename = cert_commands.config(arg);
+               local ret;
+               if key_filename and conf_filename and cert_filename
+                       and openssl.req{new=true, x509=true, nodes=true, key=key_filename,
+                               days=365, sha1=true, utf8=true, config=conf_filename, out=cert_filename} then
+                       show_message("Certificate written to ".. cert_filename);
+               else
+                       show_message("There was a problem, see OpenSSL output");
+               end
+       else
+               show_usage("cert generate HOSTNAME [HOSTNAME+]", "Generates a self-signed certificate for the current hostname(s)")
+       end
+end
+
+function commands.cert(arg)
+       if #arg >= 1 and arg[1] ~= "--help" then
+               openssl = require "util.openssl";
+               lfs = require "lfs";
+               local subcmd = table.remove(arg, 1);
+               if type(cert_commands[subcmd]) == "function" then
+                       if not arg[1] then
+                               show_message"You need to supply at least one hostname"
+                               arg = { "--help" };
+                       end
+                       if arg[1] ~= "--help" and not hosts[arg[1]] then
+                               show_message(error_messages["no-such-host"]);
+                               return
+                       end
+                       return cert_commands[subcmd](arg);
+               end
+       end
+       show_usage("cert config|request|generate|key", "Helpers for generating X.509 certificates and keys.")
+end
+
 ---------------------
 
 if command and command:match("^mod_") then -- Is a command in a module
@@ -641,7 +833,7 @@ if not commands[command] then -- Show help for all commands
        print("Where COMMAND may be one of:\n");
 
        local hidden_commands = require "util.set".new{ "register", "unregister", "addplugin" };
-       local commands_order = { "adduser", "passwd", "deluser", "start", "stop", "restart" };
+       local commands_order = { "adduser", "passwd", "deluser", "start", "stop", "restart", "reload", "about" };
 
        local done = {};