1 local config = require "core.configmanager";
2 local certmanager = require "core.certmanager";
3 local server = require "net.server";
4 local socket = require "socket";
6 local log = require "util.logger".init("portmanager");
7 local multitable = require "util.multitable";
8 local set = require "util.set";
11 local setmetatable, rawset, rawget = setmetatable, rawset, rawget;
12 local type, tonumber, tostring, ipairs, pairs = type, tonumber, tostring, ipairs, pairs;
14 local prosody = prosody;
15 local fire_event = prosody.events.fire_event;
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");
27 if socket.tcp6 and config.get("*", "use_ipv6") ~= false then
28 table.insert(default_interfaces, "::");
29 table.insert(default_local_interfaces, "::1");
32 local default_mode = config.get("*", "network_default_read_size") or 4096;
36 -- service_name -> { service_info, ... }
37 local services = setmetatable({}, { __index = function (t, k) rawset(t, k, {}); return rawget(t, k); end });
39 -- service_name, interface (string), port (number)
40 local active_services = multitable.new();
44 local function error_to_friendly_message(service_name, port, err)
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 "
54 elseif port == 5280 then
55 friendly_message = "check that Prosody or a BOSH connection manager "
56 .."is not already running";
58 friendly_message = "this port is in use by another application";
60 elseif err:match("permission") then
61 friendly_message = "Prosody does not have sufficient privileges to use this port";
63 return friendly_message;
66 prosody.events.add_handler("item-added/net-provider", function (event)
67 local item = event.item;
68 register_service(item.name, item);
70 prosody.events.add_handler("item-removed/net-provider", function (event)
71 local item = event.item;
72 unregister_service(item.name, item);
75 local function duplicate_ssl_config(ssl_config)
76 local ssl_config = type(ssl_config) == "table" and ssl_config or {};
79 for k, v in pairs(ssl_config) do
87 function activate(service_name)
88 local service_info = services[service_name][1];
89 if not service_info then
90 return nil, "Unknown service: "..service_name;
93 local listener = service_info.listener;
95 local config_prefix = (service_info.config_prefix or service_name).."_";
96 if config_prefix == "_" then
100 local bind_interfaces = config.get("*", config_prefix.."interfaces")
101 or config.get("*", config_prefix.."interface") -- COMPAT w/pre-0.9
102 or (service_info.private and (config.get("*", "local_interfaces") or default_local_interfaces))
103 or config.get("*", "interfaces")
104 or config.get("*", "interface") -- COMPAT w/pre-0.9
105 or listener.default_interface -- COMPAT w/pre0.9
106 or default_interfaces
107 bind_interfaces = set.new(type(bind_interfaces)~="table" and {bind_interfaces} or bind_interfaces);
109 local bind_ports = config.get("*", config_prefix.."ports")
110 or service_info.default_ports
111 or {service_info.default_port
112 or listener.default_port -- COMPAT w/pre-0.9
114 bind_ports = set.new(type(bind_ports) ~= "table" and { bind_ports } or bind_ports );
116 local mode, ssl = listener.default_mode or default_mode;
117 local hooked_ports = {};
119 for interface in bind_interfaces do
120 for port in bind_ports do
121 local port_number = tonumber(port);
122 if not port_number then
123 log("error", "Invalid port number specified for service '%s': %s", service_info.name, tostring(port));
124 elseif #active_services:search(nil, interface, port_number) > 0 then
125 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>");
128 -- Create SSL context for this service/port
129 if service_info.encryption == "ssl" then
130 local ssl_config = duplicate_ssl_config((config.get("*", config_prefix.."ssl") and config.get("*", config_prefix.."ssl")[interface])
131 or (config.get("*", config_prefix.."ssl") and config.get("*", config_prefix.."ssl")[port])
132 or config.get("*", config_prefix.."ssl")
133 or (config.get("*", "ssl") and config.get("*", "ssl")[interface])
134 or (config.get("*", "ssl") and config.get("*", "ssl")[port])
135 or config.get("*", "ssl"));
136 -- add default entries for, or override ssl configuration
137 if ssl_config and service_info.ssl_config then
138 for key, value in pairs(service_info.ssl_config) do
139 if not service_info.ssl_config_override and not ssl_config[key] then
140 ssl_config[key] = value;
141 elseif service_info.ssl_config_override then
142 ssl_config[key] = value;
147 ssl, err = certmanager.create_context(service_info.name.." port "..port, "server", ssl_config);
149 log("error", "Error binding encrypted port for %s: %s", service_info.name, error_to_friendly_message(service_name, port_number, err) or "unknown error");
153 -- Start listening on interface+port
154 local handler, err = server.addserver(interface, port_number, listener, mode, ssl);
156 log("error", "Failed to open server port %d on %s, %s", port_number, interface, error_to_friendly_message(service_name, port_number, err));
158 table.insert(hooked_ports, "["..interface.."]:"..port_number);
159 log("debug", "Added listening service %s to [%s]:%d", service_name, interface, port_number);
160 active_services:add(service_name, interface, port_number, {
162 service = service_info;
169 log("info", "Activated service '%s' on %s", service_name, #hooked_ports == 0 and "no ports" or table.concat(hooked_ports, ", "));
173 function deactivate(service_name, service_info)
174 for name, interface, port, n, active_service
175 in active_services:iter(service_name or service_info and service_info.name, nil, nil, nil) do
176 if service_info == nil or active_service.service == service_info then
177 close(interface, port);
180 log("info", "Deactivated service '%s'", service_name or service_info.name);
183 function register_service(service_name, service_info)
184 table.insert(services[service_name], service_info);
186 if not active_services:get(service_name) then
187 log("debug", "No active service for %s, activating...", service_name);
188 local ok, err = activate(service_name);
190 log("error", "Failed to activate service '%s': %s", service_name, err or "unknown error");
194 fire_event("service-added", { name = service_name, service = service_info });
198 function unregister_service(service_name, service_info)
199 log("debug", "Unregistering service: %s", service_name);
200 local service_info_list = services[service_name];
201 for i, service in ipairs(service_info_list) do
202 if service == service_info then
203 table.remove(service_info_list, i);
206 deactivate(nil, service_info);
207 if #service_info_list > 0 then -- Other services registered with this name
208 activate(service_name); -- Re-activate with the next available one
210 fire_event("service-removed", { name = service_name, service = service_info });
213 function close(interface, port)
214 local service, server = get_service_at(interface, port);
216 return false, "port-not-open";
219 active_services:remove(service.name, interface, port);
220 log("debug", "Removed listening service %s from [%s]:%d", service.name, interface, port);
224 function get_service_at(interface, port)
225 local data = active_services:search(nil, interface, port)[1][1];
226 return data.service, data.server;
229 function get_service(service_name)
230 return (services[service_name] or {})[1];
233 function get_active_services(...)
234 return active_services;
237 function get_registered_services()