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);
77 function activate(service_name)
78 local service_info = services[service_name][1];
79 if not service_info then
80 return nil, "Unknown service: "..service_name;
83 local listener = service_info.listener;
85 local config_prefix = (service_info.config_prefix or service_name).."_";
86 if config_prefix == "_" then
90 local bind_interfaces = config.get("*", config_prefix.."interfaces")
91 or config.get("*", config_prefix.."interface") -- COMPAT w/pre-0.9
92 or (service_info.private and (config.get("*", "local_interfaces") or default_local_interfaces))
93 or config.get("*", "interfaces")
94 or config.get("*", "interface") -- COMPAT w/pre-0.9
95 or listener.default_interface -- COMPAT w/pre0.9
97 bind_interfaces = set.new(type(bind_interfaces)~="table" and {bind_interfaces} or bind_interfaces);
99 local bind_ports = config.get("*", config_prefix.."ports")
100 or service_info.default_ports
101 or {service_info.default_port
102 or listener.default_port -- COMPAT w/pre-0.9
104 bind_ports = set.new(type(bind_ports) ~= "table" and { bind_ports } or bind_ports );
106 local mode, ssl = listener.default_mode or default_mode;
107 local hooked_ports = {};
109 for interface in bind_interfaces do
110 for port in bind_ports do
111 local port_number = tonumber(port);
112 if not port_number then
113 log("error", "Invalid port number specified for service '%s': %s", service_info.name, tostring(port));
114 elseif #active_services:search(nil, interface, port_number) > 0 then
115 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>");
118 -- Create SSL context for this service/port
119 if service_info.encryption == "ssl" then
120 local global_ssl_config = config.get("*", "ssl") or {};
121 local prefix_ssl_config = config.get("*", config_prefix.."ssl") or global_ssl_config;
122 ssl, err = certmanager.create_context(service_info.name.." port "..port, "server",
123 service_info.ssl_config or {},
124 prefix_ssl_config[interface],
125 prefix_ssl_config[port],
127 global_ssl_config[interface],
128 global_ssl_config[port]);
130 log("error", "Error binding encrypted port for %s: %s", service_info.name, error_to_friendly_message(service_name, port_number, err) or "unknown error");
134 -- Start listening on interface+port
135 local handler, err = server.addserver(interface, port_number, listener, mode, ssl);
137 log("error", "Failed to open server port %d on %s, %s", port_number, interface, error_to_friendly_message(service_name, port_number, err));
139 table.insert(hooked_ports, "["..interface.."]:"..port_number);
140 log("debug", "Added listening service %s to [%s]:%d", service_name, interface, port_number);
141 active_services:add(service_name, interface, port_number, {
143 service = service_info;
150 log("info", "Activated service '%s' on %s", service_name, #hooked_ports == 0 and "no ports" or table.concat(hooked_ports, ", "));
154 function deactivate(service_name, service_info)
155 for name, interface, port, n, active_service
156 in active_services:iter(service_name or service_info and service_info.name, nil, nil, nil) do
157 if service_info == nil or active_service.service == service_info then
158 close(interface, port);
161 log("info", "Deactivated service '%s'", service_name or service_info.name);
164 function register_service(service_name, service_info)
165 table.insert(services[service_name], service_info);
167 if not active_services:get(service_name) then
168 log("debug", "No active service for %s, activating...", service_name);
169 local ok, err = activate(service_name);
171 log("error", "Failed to activate service '%s': %s", service_name, err or "unknown error");
175 fire_event("service-added", { name = service_name, service = service_info });
179 function unregister_service(service_name, service_info)
180 log("debug", "Unregistering service: %s", service_name);
181 local service_info_list = services[service_name];
182 for i, service in ipairs(service_info_list) do
183 if service == service_info then
184 table.remove(service_info_list, i);
187 deactivate(nil, service_info);
188 if #service_info_list > 0 then -- Other services registered with this name
189 activate(service_name); -- Re-activate with the next available one
191 fire_event("service-removed", { name = service_name, service = service_info });
194 function close(interface, port)
195 local service, server = get_service_at(interface, port);
197 return false, "port-not-open";
200 active_services:remove(service.name, interface, port);
201 log("debug", "Removed listening service %s from [%s]:%d", service.name, interface, port);
205 function get_service_at(interface, port)
206 local data = active_services:search(nil, interface, port)[1][1];
207 return data.service, data.server;
210 function get_service(service_name)
211 return (services[service_name] or {})[1];
214 function get_active_services(...)
215 return active_services;
218 function get_registered_services()