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 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 --- Public API
  74
  75 function activate(service_name)
  76         local service_info = services[service_name][1];
  77         if not service_info then
  78                 return nil, "Unknown service: "..service_name;
  79         end
  80
  81         local listener = service_info.listener;
  82
  83         local config_prefix = (service_info.config_prefix or service_name).."_";
  84         if config_prefix == "_" then
  85                 config_prefix = "";
  86         end
  87
  88         local bind_interfaces = config.get("*", config_prefix.."interfaces")
  89                 or config.get("*", config_prefix.."interface") -- COMPAT w/pre-0.9
  90                 or (service_info.private and (config.get("*", "local_interfaces") or default_local_interfaces))
  91                 or config.get("*", "interfaces")
  92                 or config.get("*", "interface") -- COMPAT w/pre-0.9
  93                 or listener.default_interface -- COMPAT w/pre0.9
  94                 or default_interfaces
  95         bind_interfaces = set.new(type(bind_interfaces)~="table" and {bind_interfaces} or bind_interfaces);
  96
  97         local bind_ports = config.get("*", config_prefix.."ports")
  98                 or service_info.default_ports
  99                 or {service_info.default_port
 100                     or listener.default_port -- COMPAT w/pre-0.9
 101                    }
 102         bind_ports = set.new(type(bind_ports) ~= "table" and { bind_ports } or bind_ports );
 103
 104         local mode, ssl = listener.default_mode or "*a";
 105
 106         for interface in bind_interfaces do
 107                 for port in bind_ports do
 108                         local port_number = tonumber(port);
 109                         if not port_number then
 110                                 log("error", "Invalid port number specified for service '%s': %s", service_info.name, tostring(port));
 111                         elseif #active_services:search(nil, interface, port_number) > 0 then
 112                                 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>");
 113                         else
 114                                 local err;
 115                                 -- Create SSL context for this service/port
 116                                 if service_info.encryption == "ssl" then
 117                                         local ssl_config = config.get("*", config_prefix.."ssl");
 118                                         ssl, err = certmanager.create_context(service_info.name.." port "..port, "server", ssl_config and (ssl_config[port_number]
 119                                                 or (ssl_config.certificate and ssl_config)));
 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                                                 log("debug", "Added listening service %s to [%s]:%d", service_name, interface, port_number);
 131                                                 active_services:add(service_name, interface, port_number, {
 132                                                         server = handler;
 133                                                         service = service_info;
 134                                                 });
 135                                         end
 136                                 end
 137                         end
 138                 end
 139         end
 140         log("info", "Activated service '%s'", service_name);
 141         return true;
 142 end
 143
 144 function deactivate(service_name, service_info)
 145         for name, interface, port, n, active_service
 146                 in active_services:iter(service_name or service_info and service_info.name, nil, nil, nil) do
 147                 if service_info == nil or active_service.service == service_info then
 148                         close(interface, port);
 149                 end
 150         end
 151         log("info", "Deactivated service '%s'", service_name or service_info.name);
 152 end
 153
 154 function register_service(service_name, service_info)
 155         table.insert(services[service_name], service_info);
 156
 157         if not active_services:get(service_name) then
 158                 log("debug", "No active service for %s, activating...", service_name);
 159                 local ok, err = activate(service_name);
 160                 if not ok then
 161                         log("error", "Failed to activate service '%s': %s", service_name, err or "unknown error");
 162                 end
 163         end
 164
 165         fire_event("service-added", { name = service_name, service = service_info });
 166         return true;
 167 end
 168
 169 function unregister_service(service_name, service_info)
 170         log("debug", "Unregistering service: %s", service_name);
 171         local service_info_list = services[service_name];
 172         for i, service in ipairs(service_info_list) do
 173                 if service == service_info then
 174                         table.remove(service_info_list, i);
 175                 end
 176         end
 177         deactivate(nil, service_info);
 178         if #service_info_list > 0 then -- Other services registered with this name
 179                 activate(service_name); -- Re-activate with the next available one
 180         end
 181         fire_event("service-removed", { name = service_name, service = service_info });
 182 end
 183
 184 function close(interface, port)
 185         local service, server = get_service_at(interface, port);
 186         if not service then
 187                 return false, "port-not-open";
 188         end
 189         server:close();
 190         active_services:remove(service.name, interface, port);
 191         log("debug", "Removed listening service %s from [%s]:%d", service.name, interface, port);
 192         return true;
 193 end
 194
 195 function get_service_at(interface, port)
 196         local data = active_services:search(nil, interface, port)[1][1];
 197         return data.service, data.server;
 198 end
 199
 200 function get_service(service_name)
 201         return (services[service_name] or {})[1];
 202 end
 203
 204 function get_active_services(...)
 205         return active_services;
 206 end
 207
 208 function get_registered_services()
 209         return services;
 210 end
 211
 212 return _M;