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