core/portmanager.lua
author Kim Alvefur <zash@zash.se>
Sat, 03 Mar 2012 00:54:19 +0100
changeset 4583 6f2789939d35
parent 4546 c686860ef410
child 4597 25d89c7d6aee
permissions -rw-r--r--
core.portmanager: Make sure the private flag takes precedence over global interfaces
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
4542
50aca1e0bfbd portmanager: One manager to, in the darkness, bind them
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
     1
50aca1e0bfbd portmanager: One manager to, in the darkness, bind them
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
     2
local multitable = require "util.multitable";
50aca1e0bfbd portmanager: One manager to, in the darkness, bind them
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
     3
local fire_event = prosody.events.fire_event;
50aca1e0bfbd portmanager: One manager to, in the darkness, bind them
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
     4
50aca1e0bfbd portmanager: One manager to, in the darkness, bind them
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
     5
--- Config
50aca1e0bfbd portmanager: One manager to, in the darkness, bind them
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
     6
50aca1e0bfbd portmanager: One manager to, in the darkness, bind them
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
     7
local default_interfaces = { "*" };
50aca1e0bfbd portmanager: One manager to, in the darkness, bind them
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
     8
local default_local_interfaces = { "127.0.0.1" };
50aca1e0bfbd portmanager: One manager to, in the darkness, bind them
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
     9
if config.get("*", "use_ipv6") then
50aca1e0bfbd portmanager: One manager to, in the darkness, bind them
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
    10
	table.insert(default_interfaces, "::");
50aca1e0bfbd portmanager: One manager to, in the darkness, bind them
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
    11
	table.insert(default_local_interfaces, "::1");
50aca1e0bfbd portmanager: One manager to, in the darkness, bind them
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
    12
end
50aca1e0bfbd portmanager: One manager to, in the darkness, bind them
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
    13
50aca1e0bfbd portmanager: One manager to, in the darkness, bind them
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
    14
--- Private state
50aca1e0bfbd portmanager: One manager to, in the darkness, bind them
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
    15
50aca1e0bfbd portmanager: One manager to, in the darkness, bind them
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
    16
-- service_name -> service_info
50aca1e0bfbd portmanager: One manager to, in the darkness, bind them
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
    17
local services = {};
50aca1e0bfbd portmanager: One manager to, in the darkness, bind them
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
    18
50aca1e0bfbd portmanager: One manager to, in the darkness, bind them
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
    19
-- service_name, interface (string), port (number)
50aca1e0bfbd portmanager: One manager to, in the darkness, bind them
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
    20
local active_services = multitable.new();
50aca1e0bfbd portmanager: One manager to, in the darkness, bind them
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
    21
50aca1e0bfbd portmanager: One manager to, in the darkness, bind them
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
    22
--- Private helpers
50aca1e0bfbd portmanager: One manager to, in the darkness, bind them
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
    23
4546
c686860ef410 portmanager: Pass port to friendly_error_message()
Matthew Wild <mwild1@gmail.com>
parents: 4542
diff changeset
    24
local function error_to_friendly_message(service_name, port, err)
4542
50aca1e0bfbd portmanager: One manager to, in the darkness, bind them
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
    25
	local friendly_message = err;
50aca1e0bfbd portmanager: One manager to, in the darkness, bind them
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
    26
	if err:match(" in use") then
50aca1e0bfbd portmanager: One manager to, in the darkness, bind them
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
    27
		-- FIXME: Use service_name here
50aca1e0bfbd portmanager: One manager to, in the darkness, bind them
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
    28
		if port == 5222 or port == 5223 or port == 5269 then
50aca1e0bfbd portmanager: One manager to, in the darkness, bind them
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
    29
			friendly_message = "check that Prosody or another XMPP server is "
50aca1e0bfbd portmanager: One manager to, in the darkness, bind them
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
    30
				.."not already running and using this port";
50aca1e0bfbd portmanager: One manager to, in the darkness, bind them
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
    31
		elseif port == 80 or port == 81 then
50aca1e0bfbd portmanager: One manager to, in the darkness, bind them
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
    32
			friendly_message = "check that a HTTP server is not already using "
50aca1e0bfbd portmanager: One manager to, in the darkness, bind them
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
    33
				.."this port";
50aca1e0bfbd portmanager: One manager to, in the darkness, bind them
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
    34
		elseif port == 5280 then
50aca1e0bfbd portmanager: One manager to, in the darkness, bind them
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
    35
			friendly_message = "check that Prosody or a BOSH connection manager "
50aca1e0bfbd portmanager: One manager to, in the darkness, bind them
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
    36
				.."is not already running";
50aca1e0bfbd portmanager: One manager to, in the darkness, bind them
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
    37
		else
50aca1e0bfbd portmanager: One manager to, in the darkness, bind them
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
    38
			friendly_message = "this port is in use by another application";
50aca1e0bfbd portmanager: One manager to, in the darkness, bind them
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
    39
		end
50aca1e0bfbd portmanager: One manager to, in the darkness, bind them
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
    40
	elseif err:match("permission") then
50aca1e0bfbd portmanager: One manager to, in the darkness, bind them
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
    41
		friendly_message = "Prosody does not have sufficient privileges to use this port";
50aca1e0bfbd portmanager: One manager to, in the darkness, bind them
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
    42
	elseif err == "no ssl context" then
50aca1e0bfbd portmanager: One manager to, in the darkness, bind them
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
    43
		if not config.get("*", "core", "ssl") then
50aca1e0bfbd portmanager: One manager to, in the darkness, bind them
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
    44
			friendly_message = "there is no 'ssl' config under Host \"*\" which is "
50aca1e0bfbd portmanager: One manager to, in the darkness, bind them
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
    45
				.."require for legacy SSL ports";
50aca1e0bfbd portmanager: One manager to, in the darkness, bind them
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
    46
		else
50aca1e0bfbd portmanager: One manager to, in the darkness, bind them
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
    47
			friendly_message = "initializing SSL support failed, see previous log entries";
50aca1e0bfbd portmanager: One manager to, in the darkness, bind them
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
    48
		end
50aca1e0bfbd portmanager: One manager to, in the darkness, bind them
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
    49
	end
50aca1e0bfbd portmanager: One manager to, in the darkness, bind them
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
    50
	return friendly_message;
50aca1e0bfbd portmanager: One manager to, in the darkness, bind them
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
    51
end
50aca1e0bfbd portmanager: One manager to, in the darkness, bind them
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
    52
50aca1e0bfbd portmanager: One manager to, in the darkness, bind them
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
    53
module("portmanager", package.seeall);
50aca1e0bfbd portmanager: One manager to, in the darkness, bind them
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
    54
50aca1e0bfbd portmanager: One manager to, in the darkness, bind them
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
    55
--- Public API
50aca1e0bfbd portmanager: One manager to, in the darkness, bind them
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
    56
50aca1e0bfbd portmanager: One manager to, in the darkness, bind them
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
    57
function activate_service(service_name)
50aca1e0bfbd portmanager: One manager to, in the darkness, bind them
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
    58
	local service_info = services[service_name];
50aca1e0bfbd portmanager: One manager to, in the darkness, bind them
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
    59
	if not service_info then
50aca1e0bfbd portmanager: One manager to, in the darkness, bind them
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
    60
		return nil, "Unknown service: "..service_name;
50aca1e0bfbd portmanager: One manager to, in the darkness, bind them
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
    61
	end
50aca1e0bfbd portmanager: One manager to, in the darkness, bind them
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
    62
50aca1e0bfbd portmanager: One manager to, in the darkness, bind them
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
    63
	local bind_interfaces = set.new(config.get("*", service_name.."_interfaces")
50aca1e0bfbd portmanager: One manager to, in the darkness, bind them
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
    64
		or config.get("*", service_name.."_interface") -- COMPAT w/pre-0.9
4583
6f2789939d35 core.portmanager: Make sure the private flag takes precedence over global interfaces
Kim Alvefur <zash@zash.se>
parents: 4546
diff changeset
    65
		or (service_info.private and default_local_interfaces)
4542
50aca1e0bfbd portmanager: One manager to, in the darkness, bind them
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
    66
		or config.get("*", "interfaces")
50aca1e0bfbd portmanager: One manager to, in the darkness, bind them
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
    67
		or config.get("*", "interface") -- COMPAT w/pre-0.9
50aca1e0bfbd portmanager: One manager to, in the darkness, bind them
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
    68
		or service_info.default_interface -- COMPAT w/pre0.9
50aca1e0bfbd portmanager: One manager to, in the darkness, bind them
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
    69
		or default_interfaces);
50aca1e0bfbd portmanager: One manager to, in the darkness, bind them
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
    70
	
50aca1e0bfbd portmanager: One manager to, in the darkness, bind them
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
    71
	local bind_ports = set.new(config.get("*", service_name.."_ports")
50aca1e0bfbd portmanager: One manager to, in the darkness, bind them
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
    72
		or (service_info.multiplex and config.get("*", "ports"))
50aca1e0bfbd portmanager: One manager to, in the darkness, bind them
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
    73
		or service_info.default_ports
50aca1e0bfbd portmanager: One manager to, in the darkness, bind them
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
    74
		or {service_info.default_port});
50aca1e0bfbd portmanager: One manager to, in the darkness, bind them
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
    75
50aca1e0bfbd portmanager: One manager to, in the darkness, bind them
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
    76
	local listener = service_info.listener;
50aca1e0bfbd portmanager: One manager to, in the darkness, bind them
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
    77
	local mode = listener.default_mode or "*a";
50aca1e0bfbd portmanager: One manager to, in the darkness, bind them
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
    78
	local ssl;
50aca1e0bfbd portmanager: One manager to, in the darkness, bind them
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
    79
	if service_info.encryption == "ssl" then
50aca1e0bfbd portmanager: One manager to, in the darkness, bind them
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
    80
		ssl = prosody.global_ssl_ctx;
50aca1e0bfbd portmanager: One manager to, in the darkness, bind them
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
    81
		if not ssl then
50aca1e0bfbd portmanager: One manager to, in the darkness, bind them
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
    82
			return nil, "global-ssl-context-required";
50aca1e0bfbd portmanager: One manager to, in the darkness, bind them
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
    83
		end
50aca1e0bfbd portmanager: One manager to, in the darkness, bind them
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
    84
	end
50aca1e0bfbd portmanager: One manager to, in the darkness, bind them
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
    85
	
50aca1e0bfbd portmanager: One manager to, in the darkness, bind them
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
    86
	for interface in bind_interfaces do
50aca1e0bfbd portmanager: One manager to, in the darkness, bind them
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
    87
		for port in bind_ports do
50aca1e0bfbd portmanager: One manager to, in the darkness, bind them
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
    88
			if not service_info.multiplex and #active_services:search(nil, interface, port) > 0 then
50aca1e0bfbd portmanager: One manager to, in the darkness, bind them
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
    89
				log("error", "Multiple services configured to listen on the same port: %s, %s", table.concat(active_services:search(nil, interface, port), ", "), service_name);
50aca1e0bfbd portmanager: One manager to, in the darkness, bind them
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
    90
			else
50aca1e0bfbd portmanager: One manager to, in the darkness, bind them
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
    91
				local handler, err = server.addserver(interface, port, listener, mode, ssl);
50aca1e0bfbd portmanager: One manager to, in the darkness, bind them
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
    92
				if not handler then
4546
c686860ef410 portmanager: Pass port to friendly_error_message()
Matthew Wild <mwild1@gmail.com>
parents: 4542
diff changeset
    93
					log("error", "Failed to open server port %d on %s, %s", port, interface, error_to_friendly_message(service_name, port, err));
4542
50aca1e0bfbd portmanager: One manager to, in the darkness, bind them
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
    94
				else
50aca1e0bfbd portmanager: One manager to, in the darkness, bind them
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
    95
					log("debug", "Added listening service %s to [%s]:%d", service_name, interface, port);
50aca1e0bfbd portmanager: One manager to, in the darkness, bind them
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
    96
					active_services:add(service_name, interface, port, {
50aca1e0bfbd portmanager: One manager to, in the darkness, bind them
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
    97
						server = handler;
50aca1e0bfbd portmanager: One manager to, in the darkness, bind them
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
    98
						service = service_info;
50aca1e0bfbd portmanager: One manager to, in the darkness, bind them
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
    99
					});
50aca1e0bfbd portmanager: One manager to, in the darkness, bind them
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
   100
				end
50aca1e0bfbd portmanager: One manager to, in the darkness, bind them
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
   101
			end
50aca1e0bfbd portmanager: One manager to, in the darkness, bind them
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
   102
		end
50aca1e0bfbd portmanager: One manager to, in the darkness, bind them
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
   103
	end
50aca1e0bfbd portmanager: One manager to, in the darkness, bind them
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
   104
	log("info", "Activated service '%s'", service_name);
50aca1e0bfbd portmanager: One manager to, in the darkness, bind them
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
   105
end
50aca1e0bfbd portmanager: One manager to, in the darkness, bind them
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
   106
50aca1e0bfbd portmanager: One manager to, in the darkness, bind them
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
   107
function deactivate(service_name)
50aca1e0bfbd portmanager: One manager to, in the darkness, bind them
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
   108
	local active = active_services:search(service_name)[1];
50aca1e0bfbd portmanager: One manager to, in the darkness, bind them
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
   109
	if not active then return; end
50aca1e0bfbd portmanager: One manager to, in the darkness, bind them
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
   110
	for interface, ports in pairs(active) do
50aca1e0bfbd portmanager: One manager to, in the darkness, bind them
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
   111
		for port, active_service in pairs(ports) do
50aca1e0bfbd portmanager: One manager to, in the darkness, bind them
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
   112
			active_service:close();
50aca1e0bfbd portmanager: One manager to, in the darkness, bind them
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
   113
			active_services:remove(service_name, interface, port, active_service);
50aca1e0bfbd portmanager: One manager to, in the darkness, bind them
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
   114
			log("debug", "Removed listening service %s from [%s]:%d", service_name, interface, port);
50aca1e0bfbd portmanager: One manager to, in the darkness, bind them
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
   115
		end
50aca1e0bfbd portmanager: One manager to, in the darkness, bind them
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
   116
	end
50aca1e0bfbd portmanager: One manager to, in the darkness, bind them
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
   117
	log("info", "Deactivated service '%s'", service_name);
50aca1e0bfbd portmanager: One manager to, in the darkness, bind them
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
   118
end
50aca1e0bfbd portmanager: One manager to, in the darkness, bind them
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
   119
50aca1e0bfbd portmanager: One manager to, in the darkness, bind them
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
   120
function register_service(service_name, service_info)
50aca1e0bfbd portmanager: One manager to, in the darkness, bind them
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
   121
	services[service_name] = service_info;
50aca1e0bfbd portmanager: One manager to, in the darkness, bind them
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
   122
50aca1e0bfbd portmanager: One manager to, in the darkness, bind them
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
   123
	if not active_services[service_name] then
50aca1e0bfbd portmanager: One manager to, in the darkness, bind them
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
   124
		activate_service(service_name);
50aca1e0bfbd portmanager: One manager to, in the darkness, bind them
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
   125
	end
50aca1e0bfbd portmanager: One manager to, in the darkness, bind them
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
   126
	
50aca1e0bfbd portmanager: One manager to, in the darkness, bind them
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
   127
	fire_event("service-added", { name = service_name, service = service_info });
50aca1e0bfbd portmanager: One manager to, in the darkness, bind them
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
   128
	return true;
50aca1e0bfbd portmanager: One manager to, in the darkness, bind them
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
   129
end
50aca1e0bfbd portmanager: One manager to, in the darkness, bind them
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
   130
50aca1e0bfbd portmanager: One manager to, in the darkness, bind them
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
   131
50aca1e0bfbd portmanager: One manager to, in the darkness, bind them
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
   132
return _M;