util.cache: Add support for creating a proxy table to a cache, that looks and acts...
[prosody.git] / core / portmanager.lua
index a6e8b38f81d35cecac744126cd71ed20849727a1..ad1a0be397edd976f45852e5744f2aa354cce5e1 100644 (file)
@@ -1,6 +1,7 @@
 local config = require "core.configmanager";
 local certmanager = require "core.certmanager";
 local server = require "net.server";
+local socket = require "socket";
 
 local log = require "util.logger".init("portmanager");
 local multitable = require "util.multitable";
@@ -8,22 +9,28 @@ local set = require "util.set";
 
 local table = table;
 local setmetatable, rawset, rawget = setmetatable, rawset, rawget;
-local type, tonumber, ipairs, pairs = type, tonumber, ipairs, pairs;
+local type, tonumber, tostring, ipairs = type, tonumber, tostring, ipairs;
 
 local prosody = prosody;
 local fire_event = prosody.events.fire_event;
 
-module "portmanager";
+local _ENV = nil;
 
 --- Config
 
-local default_interfaces = { "*" };
-local default_local_interfaces = { "127.0.0.1" };
-if config.get("*", "use_ipv6") then
+local default_interfaces = { };
+local default_local_interfaces = { };
+if config.get("*", "use_ipv4") ~= false then
+       table.insert(default_interfaces, "*");
+       table.insert(default_local_interfaces, "127.0.0.1");
+end
+if socket.tcp6 and config.get("*", "use_ipv6") ~= false then
        table.insert(default_interfaces, "::");
        table.insert(default_local_interfaces, "::1");
 end
 
+local default_mode = config.get("*", "network_default_read_size") or 4096;
+
 --- Private state
 
 -- service_name -> { service_info, ... }
@@ -34,7 +41,7 @@ local active_services = multitable.new();
 
 --- Private helpers
 
-local function error_to_friendly_message(service_name, port, err)
+local function error_to_friendly_message(service_name, port, err) --luacheck: ignore 212/service_name
        local friendly_message = err;
        if err:match(" in use") then
                -- FIXME: Use service_name here
@@ -52,34 +59,18 @@ local function error_to_friendly_message(service_name, port, err)
                end
        elseif err:match("permission") then
                friendly_message = "Prosody does not have sufficient privileges to use this port";
-       elseif err == "no ssl context" then
-               if not config.get("*", "core", "ssl") then
-                       friendly_message = "there is no 'ssl' config under Host \"*\" which is "
-                               .."require for legacy SSL ports";
-               else
-                       friendly_message = "initializing SSL support failed, see previous log entries";
-               end
        end
        return friendly_message;
 end
 
-prosody.events.add_handler("item-added/net-provider", function (event)
-       local item = event.item;
-       register_service(item.name, item);
-end);
-prosody.events.add_handler("item-removed/net-provider", function (event)
-       local item = event.item;
-       unregister_service(item.name, item);
-end);
-
 --- Public API
 
-function activate(service_name)
+local function activate(service_name)
        local service_info = services[service_name][1];
        if not service_info then
                return nil, "Unknown service: "..service_name;
        end
-       
+
        local listener = service_info.listener;
 
        local config_prefix = (service_info.config_prefix or service_name).."_";
@@ -89,63 +80,81 @@ function activate(service_name)
 
        local bind_interfaces = config.get("*", config_prefix.."interfaces")
                or config.get("*", config_prefix.."interface") -- COMPAT w/pre-0.9
-               or (service_info.private and default_local_interfaces)
+               or (service_info.private and (config.get("*", "local_interfaces") or default_local_interfaces))
                or config.get("*", "interfaces")
                or config.get("*", "interface") -- COMPAT w/pre-0.9
                or listener.default_interface -- COMPAT w/pre0.9
                or default_interfaces
        bind_interfaces = set.new(type(bind_interfaces)~="table" and {bind_interfaces} or bind_interfaces);
-       
-       local bind_ports = set.new(config.get("*", config_prefix.."ports")
+
+       local bind_ports = config.get("*", config_prefix.."ports")
                or service_info.default_ports
                or {service_info.default_port
                    or listener.default_port -- COMPAT w/pre-0.9
-                  });
+                  }
+       bind_ports = set.new(type(bind_ports) ~= "table" and { bind_ports } or bind_ports );
+
+       local mode, ssl = listener.default_mode or default_mode;
+       local hooked_ports = {};
 
-       local mode, ssl = listener.default_mode or "*a";
-       
        for interface in bind_interfaces do
                for port in bind_ports do
-                       port = tonumber(port);
-                       if #active_services:search(nil, interface, port) > 0 then
+                       local port_number = tonumber(port);
+                       if not port_number then
+                               log("error", "Invalid port number specified for service '%s': %s", service_info.name, tostring(port));
+                       elseif #active_services:search(nil, interface, port_number) > 0 then
                                log("error", "Multiple services configured to listen on the same port ([%s]:%d): %s, %s", interface, port, active_services:search(nil, interface, port)[1][1].service.name or "<unnamed>", service_name or "<unnamed>");
                        else
+                               local err;
                                -- Create SSL context for this service/port
                                if service_info.encryption == "ssl" then
-                                       local ssl_config = config.get("*", config_prefix.."ssl");
-                                       ssl = certmanager.create_context(service_info.name.." port "..port, "server", ssl_config and (ssl_config[port]
-                                               or (ssl_config.certificate and ssl_config)));
+                                       local global_ssl_config = config.get("*", "ssl") or {};
+                                       local prefix_ssl_config = config.get("*", config_prefix.."ssl") or global_ssl_config;
+                                       ssl, err = certmanager.create_context(service_info.name.." port "..port, "server",
+                                               prefix_ssl_config[interface],
+                                               prefix_ssl_config[port],
+                                               prefix_ssl_config,
+                                               service_info.ssl_config or {},
+                                               global_ssl_config[interface],
+                                               global_ssl_config[port]);
+                                       if not ssl then
+                                               log("error", "Error binding encrypted port for %s: %s", service_info.name, error_to_friendly_message(service_name, port_number, err) or "unknown error");
+                                       end
                                end
-                               -- Start listening on interface+port
-                               local handler, err = server.addserver(interface, port, listener, mode, ssl);
-                               if not handler then
-                                       log("error", "Failed to open server port %d on %s, %s", port, interface, error_to_friendly_message(service_name, port, err));
-                               else
-                                       log("debug", "Added listening service %s to [%s]:%d", service_name, interface, port);
-                                       active_services:add(service_name, interface, port, {
-                                               server = handler;
-                                               service = service_info;
-                                       });
+                               if not err then
+                                       -- Start listening on interface+port
+                                       local handler, err = server.addserver(interface, port_number, listener, mode, ssl);
+                                       if not handler then
+                                               log("error", "Failed to open server port %d on %s, %s", port_number, interface, error_to_friendly_message(service_name, port_number, err));
+                                       else
+                                               table.insert(hooked_ports, "["..interface.."]:"..port_number);
+                                               log("debug", "Added listening service %s to [%s]:%d", service_name, interface, port_number);
+                                               active_services:add(service_name, interface, port_number, {
+                                                       server = handler;
+                                                       service = service_info;
+                                               });
+                                       end
                                end
                        end
                end
        end
-       log("info", "Activated service '%s'", service_name);
+       log("info", "Activated service '%s' on %s", service_name, #hooked_ports == 0 and "no ports" or table.concat(hooked_ports, ", "));
        return true;
 end
 
-function deactivate(service_name)
-       local active = active_services:search(service_name)[1];
-       if not active then return; end
-       for interface, ports in pairs(active) do
-               for port, active_service in pairs(ports) do
+local close; -- forward declaration
+
+local function deactivate(service_name, service_info)
+       for name, interface, port, n, active_service --luacheck: ignore 213/name 213/n
+               in active_services:iter(service_name or service_info and service_info.name, nil, nil, nil) do
+               if service_info == nil or active_service.service == service_info then
                        close(interface, port);
                end
        end
-       log("info", "Deactivated service '%s'", service_name);
+       log("info", "Deactivated service '%s'", service_name or service_info.name);
 end
 
-function register_service(service_name, service_info)
+local function register_service(service_name, service_info)
        table.insert(services[service_name], service_info);
 
        if not active_services:get(service_name) then
@@ -155,33 +164,34 @@ function register_service(service_name, service_info)
                        log("error", "Failed to activate service '%s': %s", service_name, err or "unknown error");
                end
        end
-       
+
        fire_event("service-added", { name = service_name, service = service_info });
        return true;
 end
 
-function unregister_service(service_name, service_info)
+local function unregister_service(service_name, service_info)
+       log("debug", "Unregistering service: %s", service_name);
        local service_info_list = services[service_name];
        for i, service in ipairs(service_info_list) do
                if service == service_info then
                        table.remove(service_info_list, i);
                end
        end
-       if active_services[service_name] == service_info then
-               deactivate(service_name);
-               if #service_info_list > 0 then -- Other services registered with this name
-                       activate(service_name); -- Re-activate with the next available one
-               end
+       deactivate(nil, service_info);
+       if #service_info_list > 0 then -- Other services registered with this name
+               activate(service_name); -- Re-activate with the next available one
        end
        fire_event("service-removed", { name = service_name, service = service_info });
 end
 
+local get_service_at -- forward declaration
+
 function close(interface, port)
-       local service, server = get_service_at(interface, port);
+       local service, service_server = get_service_at(interface, port);
        if not service then
                return false, "port-not-open";
        end
-       server:close();
+       service_server:close();
        active_services:remove(service.name, interface, port);
        log("debug", "Removed listening service %s from [%s]:%d", service.name, interface, port);
        return true;
@@ -192,16 +202,37 @@ function get_service_at(interface, port)
        return data.service, data.server;
 end
 
-function get_service(service_name)
-       return services[service_name];
+local function get_service(service_name)
+       return (services[service_name] or {})[1];
 end
 
-function get_active_services(...)
+local function get_active_services()
        return active_services;
 end
 
-function get_registered_services()
+local function get_registered_services()
        return services;
 end
 
-return _M;
+-- Event handlers
+
+prosody.events.add_handler("item-added/net-provider", function (event)
+       local item = event.item;
+       register_service(item.name, item);
+end);
+prosody.events.add_handler("item-removed/net-provider", function (event)
+       local item = event.item;
+       unregister_service(item.name, item);
+end);
+
+return {
+       activate = activate;
+       deactivate = deactivate;
+       register_service = register_service;
+       unregister_service = unregister_service;
+       close = close;
+       get_service_at = get_service_at;
+       get_service = get_service;
+       get_active_services = get_active_services;
+       get_registered_services = get_registered_services;
+};