Merge 0.9->trunk
[prosody.git] / prosodyctl
index 4d3c47908e864f60ed7bba4e0456d5cf994f48fb..4d7f678fa2e767b05381657f719f09156e8e0904 100755 (executable)
@@ -51,6 +51,7 @@ local prosody = {
        lock_globals = function () end;
        unlock_globals = function () end;
        installed = CFG_SOURCEDIR ~= nil;
+       core_post_stanza = function () end; -- TODO: mod_router!
 };
 _G.prosody = prosody;
 
@@ -61,16 +62,17 @@ 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);
@@ -81,6 +83,7 @@ do
                local file = io.open(filename);
                if file then
                        file:close();
+                       ENV_CONFIG = filename;
                        CFG_CONFIGDIR = filename:match("^(.*)[\\/][^\\/]*$");
                        break;
                end
@@ -107,11 +110,11 @@ do
                os.exit(1);
        end
 end
-local original_logging_config = config.get("*", "core", "log");
-config.set("*", "core", "log", { { levels = { min="info" }, to = "console" } });
+local original_logging_config = config.get("*", "log");
+config.set("*", "log", { { levels = { min="info" }, to = "console" } });
 
-local data_path = config.get("*", "core", "data_path") or CFG_DATADIR or "data";
-local custom_plugin_paths = config.get("*", "core", "plugin_paths");
+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...
@@ -132,7 +135,7 @@ 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
@@ -140,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);
@@ -160,8 +163,9 @@ 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");
@@ -264,17 +268,18 @@ local show_yesno = prosodyctl.show_yesno;
 local show_prompt = prosodyctl.show_prompt;
 local read_password = prosodyctl.read_password;
 
-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];
 
 function commands.adduser(arg)
+       local jid_split = require "util.jid".split;
        if not arg[1] or arg[1] == "--help" then
                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]]
@@ -309,11 +314,12 @@ function commands.adduser(arg)
 end
 
 function commands.passwd(arg)
+       local jid_split = require "util.jid".split;
        if not arg[1] or arg[1] == "--help" then
                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]]
@@ -348,11 +354,12 @@ function commands.passwd(arg)
 end
 
 function commands.deluser(arg)
+       local jid_split = require "util.jid".split;
        if not arg[1] or arg[1] == "--help" then
                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]]
@@ -407,7 +414,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();
@@ -639,8 +646,8 @@ function commands.unregister(arg)
        return 1;
 end
 
-local openssl = require "util.openssl";
-local lfs = require "lfs";
+local openssl;
+local lfs;
 
 local cert_commands = {};
 
@@ -650,25 +657,35 @@ end
 
 function cert_commands.config(arg)
        if #arg >= 1 and arg[1] ~= "--help" then
-               local conf_filename = (CFG_DATADIR or ".") .. "/" .. arg[1] .. ".cnf";
+               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);
-               for k, v in pairs(conf.distinguished_name) do
-                       local nv;
-                       if k == "commonName" then 
-                               v = arg[1]
-                       elseif k == "emailAddress" then
-                               v = "xmpp@" .. arg[1];
-                       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"
+               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
-                       conf.distinguished_name[k] = nv ~= "." and nv or nil;
                end
                local conf_file = io.open(conf_filename, "w");
                conf_file:write(conf:serialize());
@@ -683,7 +700,7 @@ end
 
 function cert_commands.key(arg)
        if #arg >= 1 and arg[1] ~= "--help" then
-               local key_filename = (CFG_DATADIR or ".") .. "/" .. arg[1] .. ".key";
+               local key_filename = (CFG_DATADIR or "./certs") .. "/" .. arg[1] .. ".key";
                if ask_overwrite(key_filename) then
                        return nil, key_filename;
                end
@@ -705,7 +722,7 @@ end
 
 function cert_commands.request(arg)
        if #arg >= 1 and arg[1] ~= "--help" then
-               local req_filename = (CFG_DATADIR or ".") .. "/" .. arg[1] .. ".req";
+               local req_filename = (CFG_DATADIR or "./certs") .. "/" .. arg[1] .. ".req";
                if ask_overwrite(req_filename) then
                        return nil, req_filename;
                end
@@ -723,7 +740,7 @@ end
 
 function cert_commands.generate(arg)
        if #arg >= 1 and arg[1] ~= "--help" then
-               local cert_filename = (CFG_DATADIR or ".") .. "/" .. arg[1] .. ".cert";
+               local cert_filename = (CFG_DATADIR or "./certs") .. "/" .. arg[1] .. ".crt";
                if ask_overwrite(cert_filename) then
                        return nil, cert_filename;
                end
@@ -744,6 +761,8 @@ 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
@@ -760,6 +779,253 @@ function commands.cert(arg)
        show_usage("cert config|request|generate|key", "Helpers for generating X.509 certificates and keys.")
 end
 
+function commands.check(arg)
+       local what = table.remove(arg, 1);
+       local array, set = require "util.array", require "util.set";
+       local it = require "util.iterators";
+       local ok = true;
+       if not what or what == "config" then
+               print("Checking config...");
+               local known_global_options = set.new({
+                       "pidfile", "log", "plugin_paths", "prosody_user", "prosody_group", "daemonize",
+                       "umask", "prosodyctl_timeout", "use_ipv6", "use_libevent", "network_settings"
+               });
+               local config = config.getconfig();
+               -- Check that we have any global options (caused by putting a host at the top)
+               if it.count(it.filter("log", pairs(config["*"]))) == 0 then
+                       ok = false;
+                       print("");
+                       print("    No global options defined. Perhaps you have put a host definition at the top")
+                       print("    of the config file? They should be at the bottom, see http://prosody.im/doc/configure#overview");
+               end
+               -- Check for global options under hosts
+               local global_options = set.new(it.to_array(it.keys(config["*"])));
+               for host, options in it.filter("*", pairs(config)) do
+                       local host_options = set.new(it.to_array(it.keys(options)));
+                       local misplaced_options = set.intersection(host_options, known_global_options);
+                       for name in pairs(options) do
+                               if name:match("^interfaces?")
+                               or name:match("_ports?$") or name:match("_interfaces?$")
+                               or name:match("_ssl$") then
+                                       misplaced_options:add(name);
+                               end
+                       end
+                       if not misplaced_options:empty() then
+                               ok = false;
+                               print("");
+                               local n = it.count(misplaced_options);
+                               print("    You have "..n.." option"..(n>1 and "s " or " ").."set under "..host.." that should be");
+                               print("    in the global section of the config file, above any VirtualHost or Component definitions,")
+                               print("    see http://prosody.im/doc/configure#overview for more information.")
+                               print("");
+                               print("    You need to move the following option"..(n>1 and "s" or "")..": "..table.concat(it.to_array(misplaced_options), ", "));
+                       end
+                       local subdomain = host:match("^[^.]+");
+                       if not(host_options:contains("component_module")) and (subdomain == "jabber" or subdomain == "xmpp"
+                          or subdomain == "chat" or subdomain == "im") then
+                               print("");
+                               print("    Suggestion: If "..host.. " is a new host with no real users yet, consider renaming it now to");
+                               print("     "..host:gsub("^[^.]+%.", "")..". You can use SRV records to redirect XMPP clients and servers to "..host..".");
+                               print("     For more information see: http://prosody.im/doc/dns");
+                       end
+               end
+               
+               print("Done.\n");
+       end
+       if not what or what == "dns" then
+               local dns = require "net.dns";
+               local ip = require "util.ip";
+               local c2s_ports = set.new(config.get("*", "c2s_ports") or {5222});
+               local s2s_ports = set.new(config.get("*", "s2s_ports") or {5269});
+               
+               local c2s_srv_required, s2s_srv_required;
+               if not c2s_ports:contains(5222) then
+                       c2s_srv_required = true;
+               end
+               if not s2s_ports:contains(5269) then
+                       s2s_srv_required = true;
+               end
+               
+               local problem_hosts = set.new();
+               
+               local external_addresses, internal_addresses = set.new(), set.new();
+               
+               local fqdn = socket.dns.tohostname(socket.dns.gethostname());
+               if fqdn then
+                       local res = dns.lookup(fqdn, "A");
+                       if res then
+                               for _, record in ipairs(res) do
+                                       external_addresses:add(record.a);
+                               end
+                       end
+                       local res = dns.lookup(fqdn, "AAAA");
+                       if res then
+                               for _, record in ipairs(res) do
+                                       external_addresses:add(record.aaaa);
+                               end
+                       end
+               end
+               
+               local local_addresses = socket.local_addresses and socket.local_addresses() or {};
+               
+               for addr in it.values(local_addresses) do
+                       if not ip.new_ip(addr).private then
+                               external_addresses:add(addr);
+                       else
+                               internal_addresses:add(addr);
+                       end
+               end
+               
+               if external_addresses:empty() then
+                       print("");
+                       print("   Failed to determine the external addresses of this server. Checks may be inaccurate.");
+                       c2s_srv_required, s2s_srv_required = true, true;
+               end
+               
+               local v6_supported = not not socket.tcp6;
+               
+               for host, host_options in it.filter("*", pairs(config.getconfig())) do
+                       local all_targets_ok, some_targets_ok = true, false;
+                       
+                       local is_component = not not host_options.component_module;
+                       print("Checking DNS for "..(is_component and "component" or "host").." "..host.."...");
+                       local target_hosts = set.new();
+                       if not is_component then
+                               local res = dns.lookup("_xmpp-client._tcp."..host..".", "SRV");
+                               if res then
+                                       for _, record in ipairs(res) do
+                                               target_hosts:add(record.srv.target);
+                                               if not c2s_ports:contains(record.srv.port) then
+                                                       print("    SRV target "..record.srv.target.." contains unknown client port: "..record.srv.port);
+                                               end
+                                       end
+                               else
+                                       if c2s_srv_required then
+                                               print("    No _xmpp-client SRV record found for "..host..", but it looks like you need one.");
+                                               all_targst_ok = false;
+                                       else
+                                               target_hosts:add(host);
+                                       end
+                               end
+                       end
+                       local res = dns.lookup("_xmpp-server._tcp."..host..".", "SRV");
+                       if res then
+                               for _, record in ipairs(res) do
+                                       target_hosts:add(record.srv.target);
+                                       if not s2s_ports:contains(record.srv.port) then
+                                               print("    SRV target "..record.srv.target.." contains unknown server port: "..record.srv.port);
+                                       end
+                               end
+                       else
+                               if s2s_srv_required then
+                                       print("    No _xmpp-server SRV record found for "..host..", but it looks like you need one.");
+                                       all_targets_ok = false;
+                               else
+                                       target_hosts:add(host);
+                               end
+                       end
+                       if target_hosts:empty() then
+                               target_hosts:add(host);
+                       end
+                       
+                       if target_hosts:contains("localhost") then
+                               print("    Target 'localhost' cannot be accessed from other servers");
+                               target_hosts:remove("localhost");
+                       end
+                       
+                       local modules = set.new(it.to_array(it.values(host_options.modules_enabled)))
+                                       + set.new(it.to_array(it.values(config.get("*", "modules_enabled"))))
+                                       + set.new({ config.get(host, "component_module") });
+
+                       if modules:contains("proxy65") then
+                               local proxy65_target = config.get(host, "proxy65_address") or host;
+                               local A, AAAA = dns.lookup(proxy65_target, "A"), dns.lookup(proxy65_target, "AAAA");
+                               local prob = {};
+                               if not A then
+                                       table.insert(prob, "A");
+                               end
+                               if v6_supported and not AAAA then
+                                       table.insert(prob, "AAAA");
+                               end
+                               if #prob > 0 then
+                                       print("    File transfer proxy "..proxy65_target.." has no "..table.concat(prob, "/").." record. Create one or set 'proxy65_address' to the correct host/IP.");
+                               end
+                       end
+                       
+                       for host in target_hosts do
+                               local host_ok_v4, host_ok_v6;
+                               local res = dns.lookup(host, "A");
+                               if res then
+                                       for _, record in ipairs(res) do
+                                               if external_addresses:contains(record.a) then
+                                                       some_targets_ok = true;
+                                                       host_ok_v4 = true;
+                                               elseif internal_addresses:contains(record.a) then
+                                                       host_ok_v4 = true;
+                                                       some_targets_ok = true;
+                                                       print("    "..host.." A record points to internal address, external connections might fail");
+                                               else
+                                                       print("    "..host.." A record points to unknown address "..record.a);
+                                                       all_targets_ok = false;
+                                               end
+                                       end
+                               end
+                               local res = dns.lookup(host, "AAAA");
+                               if res then
+                                       for _, record in ipairs(res) do
+                                               if external_addresses:contains(record.aaaa) then
+                                                       some_targets_ok = true;
+                                                       host_ok_v6 = true;
+                                               elseif internal_addresses:contains(record.aaaa) then
+                                                       host_ok_v6 = true;
+                                                       some_targets_ok = true;
+                                                       print("    "..host.." AAAA record points to internal address, external connections might fail");
+                                               else
+                                                       print("    "..host.." AAAA record points to unknown address "..record.aaaa);
+                                                       all_targets_ok = false;
+                                               end
+                                       end
+                               end
+                               
+                               local bad_protos = {}
+                               if not host_ok_v4 then
+                                       table.insert(bad_protos, "IPv4");
+                               end
+                               if not host_ok_v6 then
+                                       table.insert(bad_protos, "IPv6");
+                               end
+                               if #bad_protos > 0 then
+                                       print("    Host "..host.." does not seem to resolve to this server ("..table.concat(bad_protos, "/")..")");
+                               end
+                               if host_ok_v6 and not v6_supported then
+                                       print("    Host "..host.." has AAAA records, but your version of LuaSocket does not support IPv6.");
+                                       print("      Please see http://prosody.im/doc/ipv6 for more information.");
+                               end
+                       end
+                       if not all_targets_ok then
+                               print("    "..(some_targets_ok and "Only some" or "No").." targets for "..host.." appear to resolve to this server.");
+                               if is_component then
+                                       print("    DNS records are necessary if you want users on other servers to access this component.");
+                               end
+                               problem_hosts:add(host);
+                       end
+                       print("");
+               end
+               if not problem_hosts:empty() then
+                       print("");
+                       print("For more information about DNS configuration please see http://prosody.im/doc/dns");
+                       print("");
+                       ok = false;
+               end
+       end
+       if not ok then
+               print("Problems found, see above.");
+       else
+               print("All checks passed, congratulations!");
+       end
+       return ok and 0 or 2;
+end
+
 ---------------------
 
 if command and command:match("^mod_") then -- Is a command in a module