core/portmanager.lua

   1 local config = require "core.configmanager";
   2 local certmanager = require "core.certmanager";
   3 local server = require "net.server";
   4
   5 local log = require "util.logger".init("portmanager");
   6 local multitable = require "util.multitable";
   7 local set = require "util.set";
   8
   9 local table = table;
  10 local setmetatable, rawset, rawget = setmetatable, rawset, rawget;
  11 local type, tonumber, ipairs, pairs = type, tonumber, ipairs, pairs;
  12
  13 local prosody = prosody;
  14 local fire_event = prosody.events.fire_event;
  15
  16 module "portmanager";
  17
  18 --- Config
  19
  20 local default_interfaces = { "*" };
  21 local default_local_interfaces = { "127.0.0.1" };
  22 if config.get("*", "use_ipv6") then
  23         table.insert(default_interfaces, "::");
  24         table.insert(default_local_interfaces, "::1");
  25 end
  26
  27 --- Private state
  28
  29 -- service_name -> { service_info, ... }
  30 local services = setmetatable({}, { __index = function (t, k) rawset(t, k, {}); return rawget(t, k); end });
  31
  32 -- service_name, interface (string), port (number)
  33 local active_services = multitable.new();
  34
  35 --- Private helpers
  36
  37 local function error_to_friendly_message(service_name, port, err)
  38         local friendly_message = err;
  39         if err:match(" in use") then
  40                 -- FIXME: Use service_name here
  41                 if port == 5222 or port == 5223 or port == 5269 then
  42                         friendly_message = "check that Prosody or another XMPP server is "
  43                                 .."not already running and using this port";
  44                 elseif port == 80 or port == 81 then
  45                         friendly_message = "check that a HTTP server is not already using "
  46                                 .."this port";
  47                 elseif port == 5280 then
  48                         friendly_message = "check that Prosody or a BOSH connection manager "
  49                                 .."is not already running";
  50                 else
  51                         friendly_message = "this port is in use by another application";
  52                 end
  53         elseif err:match("permission") then
  54                 friendly_message = "Prosody does not have sufficient privileges to use this port";
  55         elseif err == "no ssl context" then
  56                 if not config.get("*", "core", "ssl") then
  57                         friendly_message = "there is no 'ssl' config under Host \"*\" which is "
  58                                 .."require for legacy SSL ports";
  59                 else
  60                         friendly_message = "initializing SSL support failed, see previous log entries";
  61                 end
  62         end
  63         return friendly_message;
  64 end
  65
  66 prosody.events.add_handler("item-added/net-provider", function (event)
  67         local item = event.item;
  68         register_service(item.name, item);
  69 end);
  70 prosody.events.add_handler("item-removed/net-provider", function (event)
  71         local item = event.item;
  72         unregister_service(item.name, item);
  73 end);
  74
  75 --- Public API
  76
  77 function activate(service_name)
  78         local service_info = services[service_name][1];
  79         if not service_info then
  80                 return nil, "Unknown service: "..service_name;
  81         end
  82
  83         local listener = service_info.listener;
  84
  85         local config_prefix = (service_info.config_prefix or service_name).."_";
  86         if config_prefix == "_" then
  87                 config_prefix = "";
  88         end
  89
  90         local bind_interfaces = config.get("*", config_prefix.."interfaces")
  91                 or config.get("*", config_prefix.."interface") -- COMPAT w/pre-0.9
  92                 or (service_info.private and default_local_interfaces)
  93                 or config.get("*", "interfaces")
  94                 or config.get("*", "interface") -- COMPAT w/pre-0.9
  95                 or listener.default_interface -- COMPAT w/pre0.9
  96                 or default_interfaces
  97         bind_interfaces = set.new(type(bind_interfaces)~="table" and {bind_interfaces} or bind_interfaces);
  98
  99         local bind_ports = set.new(config.get("*", config_prefix.."ports")
 100                 or service_info.default_ports
 101                 or {service_info.default_port
 102                     or listener.default_port -- COMPAT w/pre-0.9
 103                    });
 104
 105         local mode, ssl = listener.default_mode or "*a";
 106
 107         for interface in bind_interfaces do
 108                 for port in bind_ports do
 109                         port = tonumber(port);
 110                         if #active_services:search(nil, interface, port) > 0 then
 111                                 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>");
 112                         else
 113                                 -- Create SSL context for this service/port
 114                                 if service_info.encryption == "ssl" then
 115                                         local ssl_config = config.get("*", config_prefix.."ssl");
 116                                         ssl = certmanager.create_context(service_info.name.." port "..port, "server", ssl_config and (ssl_config[port]
 117                                                 or (ssl_config.certificate and ssl_config)));
 118                                 end
 119                                 -- Start listening on interface+port
 120                                 local handler, err = server.addserver(interface, port, listener, mode, ssl);
 121                                 if not handler then
 122                                         log("error", "Failed to open server port %d on %s, %s", port, interface, error_to_friendly_message(service_name, port, err));
 123                                 else
 124                                         log("debug", "Added listening service %s to [%s]:%d", service_name, interface, port);
 125                                         active_services:add(service_name, interface, port, {
 126                                                 server = handler;
 127                                                 service = service_info;
 128                                         });
 129                                 end
 130                         end
 131                 end
 132         end
 133         log("info", "Activated service '%s'", service_name);
 134         return true;
 135 end
 136
 137 function deactivate(service_name, service_info)
 138         for name, interface, port, n, active_service
 139                 in active_services:iter(service_name or service_info and service_info.name, nil, nil, nil) do
 140                 if service_info == nil or active_service.service == service_info then
 141                         close(interface, port);
 142                 end
 143         end
 144         log("info", "Deactivated service '%s'", service_name or service_info.name);
 145 end
 146
 147 function register_service(service_name, service_info)
 148         table.insert(services[service_name], service_info);
 149
 150         if not active_services:get(service_name) then
 151                 log("debug", "No active service for %s, activating...", service_name);
 152                 local ok, err = activate(service_name);
 153                 if not ok then
 154                         log("error", "Failed to activate service '%s': %s", service_name, err or "unknown error");
 155                 end
 156         end
 157
 158         fire_event("service-added", { name = service_name, service = service_info });
 159         return true;
 160 end
 161
 162 function unregister_service(service_name, service_info)
 163         log("debug", "Unregistering service: %s", service_name);
 164         local service_info_list = services[service_name];
 165         for i, service in ipairs(service_info_list) do
 166                 if service == service_info then
 167                         table.remove(service_info_list, i);
 168                 end
 169         end
 170         deactivate(nil, service_info);
 171         if #service_info_list > 0 then -- Other services registered with this name
 172                 activate(service_name); -- Re-activate with the next available one
 173         end
 174         fire_event("service-removed", { name = service_name, service = service_info });
 175 end
 176
 177 function close(interface, port)
 178         local service, server = get_service_at(interface, port);
 179         if not service then
 180                 return false, "port-not-open";
 181         end
 182         server:close();
 183         active_services:remove(service.name, interface, port);
 184         log("debug", "Removed listening service %s from [%s]:%d", service.name, interface, port);
 185         return true;
 186 end
 187
 188 function get_service_at(interface, port)
 189         local data = active_services:search(nil, interface, port)[1][1];
 190         return data.service, data.server;
 191 end
 192
 193 function get_service(service_name)
 194         return services[service_name];
 195 end
 196
 197 function get_active_services(...)
 198         return active_services;
 199 end
 200
 201 function get_registered_services()
 202         return services;
 203 end
 204
 205 return _M;