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