core/portmanager.lua

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