Software `/` code `/` prosody

Annotate

plugins/mod_http.lua @ 11632:21a1b9fb08a1

mod_admin_adhoc: Delete "Get User Password" command This doesn't really make sense today. It doesn't even work with mod_auth_internal_hashed, which should be the default. And even with a supporting authentication module, why would we just hand out the password? One use case may be to recover a forgotten password. While not yet included with Prosody, there are better ways to handle forgotten passwords, usually by resetting them to a new password.

author	Kim Alvefur <zash@zash.se>
date	Sun, 27 Jun 2021 21:51:21 +0200
parent	11410:2ea70d291429
child	11727:f3aee8a825cc

rev	line source
4635 ea5215bd2783 mod_http: Provide HTTP service. Waqas Hussain <waqas20@gmail.com> parents: diff changeset	1 -- Prosody IM
4664 7438b3c68576 mod_http: Revamp module for new API and config Matthew Wild <mwild1@gmail.com> parents: 4636 diff changeset	2 -- Copyright (C) 2008-2012 Matthew Wild
7438b3c68576 mod_http: Revamp module for new API and config Matthew Wild <mwild1@gmail.com> parents: 4636 diff changeset	3 -- Copyright (C) 2008-2012 Waqas Hussain
5776 bd0ff8ae98a8 Remove all trailing whitespace Florian Zeitz <florob@babelmonkeys.de> parents: 5427 diff changeset	4 --
4635 ea5215bd2783 mod_http: Provide HTTP service. Waqas Hussain <waqas20@gmail.com> parents: diff changeset	5 -- This project is MIT/X11 licensed. Please see the
ea5215bd2783 mod_http: Provide HTTP service. Waqas Hussain <waqas20@gmail.com> parents: diff changeset	6 -- COPYING file in the source package for more information.
ea5215bd2783 mod_http: Provide HTTP service. Waqas Hussain <waqas20@gmail.com> parents: diff changeset	7 --
ea5215bd2783 mod_http: Provide HTTP service. Waqas Hussain <waqas20@gmail.com> parents: diff changeset	8
ea5215bd2783 mod_http: Provide HTTP service. Waqas Hussain <waqas20@gmail.com> parents: diff changeset	9 module:set_global();
10409 abfc05495d8b mod_http: Soften dependency on mod_http_errors Kim Alvefur <zash@zash.se> parents: 10315 diff changeset	10 pcall(function ()
abfc05495d8b mod_http: Soften dependency on mod_http_errors Kim Alvefur <zash@zash.se> parents: 10315 diff changeset	11 module:depends("http_errors");
abfc05495d8b mod_http: Soften dependency on mod_http_errors Kim Alvefur <zash@zash.se> parents: 10315 diff changeset	12 end);
4635 ea5215bd2783 mod_http: Provide HTTP service. Waqas Hussain <waqas20@gmail.com> parents: diff changeset	13
5374 b62c6cbcb065 mod_http: Import portmanager Kim Alvefur <zash@zash.se> parents: 5332 diff changeset	14 local portmanager = require "core.portmanager";
4892 6c8074f47ca4 mod_http: Add module:http_url([app_name,][default_path]) for a module to get a guess at its external URL Matthew Wild <mwild1@gmail.com> parents: 4774 diff changeset	15 local moduleapi = require "core.moduleapi";
6c8074f47ca4 mod_http: Add module:http_url([app_name,][default_path]) for a module to get a guess at its external URL Matthew Wild <mwild1@gmail.com> parents: 4774 diff changeset	16 local url_parse = require "socket.url".parse;
5093 1ce9e8068dda mod_http: Rework how module:http_url() builds the url. Kim Alvefur <zash@zash.se> parents: 5092 diff changeset	17 local url_build = require "socket.url".build;
9504 cfbea3064aa9 mod_http: Move normalize_path to util.http Kim Alvefur <zash@zash.se> parents: 9503 diff changeset	18 local normalize_path = require "util.http".normalize_path;
9797 071538a567d5 mod_http: Determine CORS methods to whitelist from actual methods used Kim Alvefur <zash@zash.se> parents: 9796 diff changeset	19 local set = require "util.set";
4892 6c8074f47ca4 mod_http: Add module:http_url([app_name,][default_path]) for a module to get a guess at its external URL Matthew Wild <mwild1@gmail.com> parents: 4774 diff changeset	20
10923 dff1aebd0f2b mod_http: Support CIDR for trusted proxies. Boris Grozev <boris@jitsi.org> parents: 10841 diff changeset	21 local ip_util = require "util.ip";
dff1aebd0f2b mod_http: Support CIDR for trusted proxies. Boris Grozev <boris@jitsi.org> parents: 10841 diff changeset	22 local new_ip = ip_util.new_ip;
dff1aebd0f2b mod_http: Support CIDR for trusted proxies. Boris Grozev <boris@jitsi.org> parents: 10841 diff changeset	23 local match_ip = ip_util.match;
dff1aebd0f2b mod_http: Support CIDR for trusted proxies. Boris Grozev <boris@jitsi.org> parents: 10841 diff changeset	24 local parse_cidr = ip_util.parse_cidr;
4892 6c8074f47ca4 mod_http: Add module:http_url([app_name,][default_path]) for a module to get a guess at its external URL Matthew Wild <mwild1@gmail.com> parents: 4774 diff changeset	25
4664 7438b3c68576 mod_http: Revamp module for new API and config Matthew Wild <mwild1@gmail.com> parents: 4636 diff changeset	26 local server = require "net.http.server";
7438b3c68576 mod_http: Revamp module for new API and config Matthew Wild <mwild1@gmail.com> parents: 4636 diff changeset	27
4736 3514338c59c3 net.http.server, mod_http: Support http_default_host config option to specify where to direct requests for unknown HTTP vhosts Matthew Wild <mwild1@gmail.com> parents: 4724 diff changeset	28 server.set_default_host(module:get_option_string("http_default_host"));
3514338c59c3 net.http.server, mod_http: Support http_default_host config option to specify where to direct requests for unknown HTTP vhosts Matthew Wild <mwild1@gmail.com> parents: 4724 diff changeset	29
7580 588ed6451984 mod_http: Allow configuring http parser size limits Kim Alvefur <zash@zash.se> parents: 6598 diff changeset	30 server.set_option("body_size_limit", module:get_option_number("http_max_content_size"));
588ed6451984 mod_http: Allow configuring http parser size limits Kim Alvefur <zash@zash.se> parents: 6598 diff changeset	31 server.set_option("buffer_size_limit", module:get_option_number("http_max_buffer_size"));
588ed6451984 mod_http: Allow configuring http parser size limits Kim Alvefur <zash@zash.se> parents: 6598 diff changeset	32
9793 9993fd021d19 mod_http: Solve CORS problems once and for all Kim Alvefur <zash@zash.se> parents: 9504 diff changeset	33 -- CORS settigs
9797 071538a567d5 mod_http: Determine CORS methods to whitelist from actual methods used Kim Alvefur <zash@zash.se> parents: 9796 diff changeset	34 local opt_methods = module:get_option_set("access_control_allow_methods", { "GET", "OPTIONS" });
9793 9993fd021d19 mod_http: Solve CORS problems once and for all Kim Alvefur <zash@zash.se> parents: 9504 diff changeset	35 local opt_headers = module:get_option_set("access_control_allow_headers", { "Content-Type" });
10258 4ff2f14f9ac7 mod_http: Add support for configuring CORS Access-Control-Allow-Credentials Matthew Wild <mwild1@gmail.com> parents: 9852 diff changeset	36 local opt_credentials = module:get_option_boolean("access_control_allow_credentials", false);
9793 9993fd021d19 mod_http: Solve CORS problems once and for all Kim Alvefur <zash@zash.se> parents: 9504 diff changeset	37 local opt_max_age = module:get_option_number("access_control_max_age", 2 * 60 * 60);
9993fd021d19 mod_http: Solve CORS problems once and for all Kim Alvefur <zash@zash.se> parents: 9504 diff changeset	38
4667 d0cfc49f3f2b mod_http: Support for default_path in apps Matthew Wild <mwild1@gmail.com> parents: 4664 diff changeset	39 local function get_http_event(host, app_path, key)
4664 7438b3c68576 mod_http: Revamp module for new API and config Matthew Wild <mwild1@gmail.com> parents: 4636 diff changeset	40 local method, path = key:match("^(%S+)%s+(.+)$");
4721 1c6c4c53f08a mod_http: Routes now require a method to be specified, but the path has become optional (defaults to the base path with no trailing '/' Matthew Wild <mwild1@gmail.com> parents: 4720 diff changeset	41 if not method then -- No path specified, default to "" (base path)
1c6c4c53f08a mod_http: Routes now require a method to be specified, but the path has become optional (defaults to the base path with no trailing '/' Matthew Wild <mwild1@gmail.com> parents: 4720 diff changeset	42 method, path = key, "";
4664 7438b3c68576 mod_http: Revamp module for new API and config Matthew Wild <mwild1@gmail.com> parents: 4636 diff changeset	43 end
4721 1c6c4c53f08a mod_http: Routes now require a method to be specified, but the path has become optional (defaults to the base path with no trailing '/' Matthew Wild <mwild1@gmail.com> parents: 4720 diff changeset	44 if method:sub(1,1) == "/" then
1c6c4c53f08a mod_http: Routes now require a method to be specified, but the path has become optional (defaults to the base path with no trailing '/' Matthew Wild <mwild1@gmail.com> parents: 4720 diff changeset	45 return nil;
1c6c4c53f08a mod_http: Routes now require a method to be specified, but the path has become optional (defaults to the base path with no trailing '/' Matthew Wild <mwild1@gmail.com> parents: 4720 diff changeset	46 end
5092 a89f8f2f2943 mod_http: Don't produce paths with double / if a module is set to serve / Kim Alvefur <zash@zash.se> parents: 4915 diff changeset	47 if app_path == "/" and path:sub(1,1) == "/" then
a89f8f2f2943 mod_http: Don't produce paths with double / if a module is set to serve / Kim Alvefur <zash@zash.se> parents: 4915 diff changeset	48 app_path = "";
a89f8f2f2943 mod_http: Don't produce paths with double / if a module is set to serve / Kim Alvefur <zash@zash.se> parents: 4915 diff changeset	49 end
9376 220468f7a103 mod_http: Support global HTTP modules Kim Alvefur <zash@zash.se> parents: 9338 diff changeset	50 if host == "*" then
220468f7a103 mod_http: Support global HTTP modules Kim Alvefur <zash@zash.se> parents: 9338 diff changeset	51 return method:upper().." "..app_path..path;
220468f7a103 mod_http: Support global HTTP modules Kim Alvefur <zash@zash.se> parents: 9338 diff changeset	52 else
220468f7a103 mod_http: Support global HTTP modules Kim Alvefur <zash@zash.se> parents: 9338 diff changeset	53 return method:upper().." "..host..app_path..path;
220468f7a103 mod_http: Support global HTTP modules Kim Alvefur <zash@zash.se> parents: 9338 diff changeset	54 end
4664 7438b3c68576 mod_http: Revamp module for new API and config Matthew Wild <mwild1@gmail.com> parents: 4636 diff changeset	55 end
4635 ea5215bd2783 mod_http: Provide HTTP service. Waqas Hussain <waqas20@gmail.com> parents: diff changeset	56
4702 5a85e541de1a mod_http: Switch to single option for specifying HTTP app bases, http_paths. Keys are app/module names, values are base paths. Matthew Wild <mwild1@gmail.com> parents: 4696 diff changeset	57 local function get_base_path(host_module, app_name, default_app_path)
5332 5b73ac268a9e mod_http: Expand $host in http_paths Kim Alvefur <zash@zash.se> parents: 5230 diff changeset	58 return (normalize_path(host_module:get_option("http_paths", {})[app_name] -- Host
4702 5a85e541de1a mod_http: Switch to single option for specifying HTTP app bases, http_paths. Keys are app/module names, values are base paths. Matthew Wild <mwild1@gmail.com> parents: 4696 diff changeset	59 or module:get_option("http_paths", {})[app_name] -- Global
5332 5b73ac268a9e mod_http: Expand $host in http_paths Kim Alvefur <zash@zash.se> parents: 5230 diff changeset	60 or default_app_path)) -- Default
6025 583e5c1365fe mod_http: Use hostname from the correct context (thanks gryffus) Kim Alvefur <zash@zash.se> parents: 5427 diff changeset	61 :gsub("%$(%w+)", { host = host_module.host });
4892 6c8074f47ca4 mod_http: Add module:http_url([app_name,][default_path]) for a module to get a guess at its external URL Matthew Wild <mwild1@gmail.com> parents: 4774 diff changeset	62 end
6c8074f47ca4 mod_http: Add module:http_url([app_name,][default_path]) for a module to get a guess at its external URL Matthew Wild <mwild1@gmail.com> parents: 4774 diff changeset	63
6504 e1659f32852e mod_http: For URLs that end with / or wildcard handlers, add a low-priority redirect from without to with slash Kim Alvefur <zash@zash.se> parents: 6086 diff changeset	64 local function redir_handler(event)
e1659f32852e mod_http: For URLs that end with / or wildcard handlers, add a low-priority redirect from without to with slash Kim Alvefur <zash@zash.se> parents: 6086 diff changeset	65 event.response.headers.location = event.request.path.."/";
7518 829ebe806e82 mod_http: Fix indentation in redir_handler Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 7359 diff changeset	66 if event.request.url.query then
829ebe806e82 mod_http: Fix indentation in redir_handler Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 7359 diff changeset	67 event.response.headers.location = event.response.headers.location .. "?" .. event.request.url.query
829ebe806e82 mod_http: Fix indentation in redir_handler Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 7359 diff changeset	68 end
6504 e1659f32852e mod_http: For URLs that end with / or wildcard handlers, add a low-priority redirect from without to with slash Kim Alvefur <zash@zash.se> parents: 6086 diff changeset	69 return 301;
e1659f32852e mod_http: For URLs that end with / or wildcard handlers, add a low-priority redirect from without to with slash Kim Alvefur <zash@zash.se> parents: 6086 diff changeset	70 end
e1659f32852e mod_http: For URLs that end with / or wildcard handlers, add a low-priority redirect from without to with slash Kim Alvefur <zash@zash.se> parents: 6086 diff changeset	71
5093 1ce9e8068dda mod_http: Rework how module:http_url() builds the url. Kim Alvefur <zash@zash.se> parents: 5092 diff changeset	72 local ports_by_scheme = { http = 80, https = 443, };
1ce9e8068dda mod_http: Rework how module:http_url() builds the url. Kim Alvefur <zash@zash.se> parents: 5092 diff changeset	73
4892 6c8074f47ca4 mod_http: Add module:http_url([app_name,][default_path]) for a module to get a guess at its external URL Matthew Wild <mwild1@gmail.com> parents: 4774 diff changeset	74 -- Helper to deduce a module's external URL
6c8074f47ca4 mod_http: Add module:http_url([app_name,][default_path]) for a module to get a guess at its external URL Matthew Wild <mwild1@gmail.com> parents: 4774 diff changeset	75 function moduleapi.http_url(module, app_name, default_path)
6c8074f47ca4 mod_http: Add module:http_url([app_name,][default_path]) for a module to get a guess at its external URL Matthew Wild <mwild1@gmail.com> parents: 4774 diff changeset	76 app_name = app_name or (module.name:gsub("^http_", ""));
5183 8461e8ed7c09 mod_http: Rename variable for clarity Matthew Wild <mwild1@gmail.com> parents: 5180 diff changeset	77 local external_url = url_parse(module:get_option_string("http_external_url")) or {};
6026 8a8be471ec72 mod_http: Fix http_external_url setting without an explicit port Kim Alvefur <zash@zash.se> parents: 6025 diff changeset	78 if external_url.scheme and external_url.port == nil then
8a8be471ec72 mod_http: Fix http_external_url setting without an explicit port Kim Alvefur <zash@zash.se> parents: 6025 diff changeset	79 external_url.port = ports_by_scheme[external_url.scheme];
8a8be471ec72 mod_http: Fix http_external_url setting without an explicit port Kim Alvefur <zash@zash.se> parents: 6025 diff changeset	80 end
4892 6c8074f47ca4 mod_http: Add module:http_url([app_name,][default_path]) for a module to get a guess at its external URL Matthew Wild <mwild1@gmail.com> parents: 4774 diff changeset	81 local services = portmanager.get_active_services();
4915 3fbc01d1fc5a mod_http: Fix traceback when no HTTP services succeed in binding Matthew Wild <mwild1@gmail.com> parents: 4911 diff changeset	82 local http_services = services:get("https") or services:get("http") or {};
8969 48d0b908f8b6 mod_http: Silecence harmless warnings Kim Alvefur <zash@zash.se> parents: 8596 diff changeset	83 for interface, ports in pairs(http_services) do -- luacheck: ignore 213/interface
8970 75c3b1bd9d7b mod_http: Rename loop variable to avoid name clash [luacheck] Kim Alvefur <zash@zash.se> parents: 8969 diff changeset	84 for port, service in pairs(ports) do -- luacheck: ignore 512
5093 1ce9e8068dda mod_http: Rework how module:http_url() builds the url. Kim Alvefur <zash@zash.se> parents: 5092 diff changeset	85 local url = {
8970 75c3b1bd9d7b mod_http: Rename loop variable to avoid name clash [luacheck] Kim Alvefur <zash@zash.se> parents: 8969 diff changeset	86 scheme = (external_url.scheme or service[1].service.name);
5190 76c73bd3d483 mod_http: Make module:http_url() aware of http_host Kim Alvefur <zash@zash.se> parents: 5183 diff changeset	87 host = (external_url.host or module:get_option_string("http_host", module.host));
5183 8461e8ed7c09 mod_http: Rename variable for clarity Matthew Wild <mwild1@gmail.com> parents: 5180 diff changeset	88 port = tonumber(external_url.port) or port or 80;
9502 09e7b0048ebe mod_http: Make sure path from http_external_url always ends with a slash (fixes #1183) Kim Alvefur <zash@zash.se> parents: 7867 diff changeset	89 path = normalize_path(external_url.path or "/", true)..
5093 1ce9e8068dda mod_http: Rework how module:http_url() builds the url. Kim Alvefur <zash@zash.se> parents: 5092 diff changeset	90 (get_base_path(module, app_name, default_path or "/"..app_name):sub(2));
1ce9e8068dda mod_http: Rework how module:http_url() builds the url. Kim Alvefur <zash@zash.se> parents: 5092 diff changeset	91 }
1ce9e8068dda mod_http: Rework how module:http_url() builds the url. Kim Alvefur <zash@zash.se> parents: 5092 diff changeset	92 if ports_by_scheme[url.scheme] == url.port then url.port = nil end
1ce9e8068dda mod_http: Rework how module:http_url() builds the url. Kim Alvefur <zash@zash.se> parents: 5092 diff changeset	93 return url_build(url);
4892 6c8074f47ca4 mod_http: Add module:http_url([app_name,][default_path]) for a module to get a guess at its external URL Matthew Wild <mwild1@gmail.com> parents: 4774 diff changeset	94 end
6c8074f47ca4 mod_http: Add module:http_url([app_name,][default_path]) for a module to get a guess at its external URL Matthew Wild <mwild1@gmail.com> parents: 4774 diff changeset	95 end
11066 dc41c8dfd2b1 mod_http: Silence warnings when running under prosodyctl Matthew Wild <mwild1@gmail.com> parents: 11022 diff changeset	96 if prosody.process_type == "prosody" then
dc41c8dfd2b1 mod_http: Silence warnings when running under prosodyctl Matthew Wild <mwild1@gmail.com> parents: 11022 diff changeset	97 module:log("warn", "No http ports enabled, can't generate an external URL");
dc41c8dfd2b1 mod_http: Silence warnings when running under prosodyctl Matthew Wild <mwild1@gmail.com> parents: 11022 diff changeset	98 end
6598 4b4852c4f96a mod_http: Return a static string from module:http_url() when no ports are enabled and log a warning Kim Alvefur <zash@zash.se> parents: 6597 diff changeset	99 return "http://disabled.invalid/";
4702 5a85e541de1a mod_http: Switch to single option for specifying HTTP app bases, http_paths. Keys are app/module names, values are base paths. Matthew Wild <mwild1@gmail.com> parents: 4696 diff changeset	100 end
5a85e541de1a mod_http: Switch to single option for specifying HTTP app bases, http_paths. Keys are app/module names, values are base paths. Matthew Wild <mwild1@gmail.com> parents: 4696 diff changeset	101
10258 4ff2f14f9ac7 mod_http: Add support for configuring CORS Access-Control-Allow-Credentials Matthew Wild <mwild1@gmail.com> parents: 9852 diff changeset	102 local function apply_cors_headers(response, methods, headers, max_age, allow_credentials, origin)
9793 9993fd021d19 mod_http: Solve CORS problems once and for all Kim Alvefur <zash@zash.se> parents: 9504 diff changeset	103 response.headers.access_control_allow_methods = tostring(methods);
9993fd021d19 mod_http: Solve CORS problems once and for all Kim Alvefur <zash@zash.se> parents: 9504 diff changeset	104 response.headers.access_control_allow_headers = tostring(headers);
9993fd021d19 mod_http: Solve CORS problems once and for all Kim Alvefur <zash@zash.se> parents: 9504 diff changeset	105 response.headers.access_control_max_age = tostring(max_age)
9993fd021d19 mod_http: Solve CORS problems once and for all Kim Alvefur <zash@zash.se> parents: 9504 diff changeset	106 response.headers.access_control_allow_origin = origin or "*";
10258 4ff2f14f9ac7 mod_http: Add support for configuring CORS Access-Control-Allow-Credentials Matthew Wild <mwild1@gmail.com> parents: 9852 diff changeset	107 if allow_credentials then
4ff2f14f9ac7 mod_http: Add support for configuring CORS Access-Control-Allow-Credentials Matthew Wild <mwild1@gmail.com> parents: 9852 diff changeset	108 response.headers.access_control_allow_credentials = "true";
4ff2f14f9ac7 mod_http: Add support for configuring CORS Access-Control-Allow-Credentials Matthew Wild <mwild1@gmail.com> parents: 9852 diff changeset	109 end
9793 9993fd021d19 mod_http: Solve CORS problems once and for all Kim Alvefur <zash@zash.se> parents: 9504 diff changeset	110 end
9993fd021d19 mod_http: Solve CORS problems once and for all Kim Alvefur <zash@zash.se> parents: 9504 diff changeset	111
4664 7438b3c68576 mod_http: Revamp module for new API and config Matthew Wild <mwild1@gmail.com> parents: 4636 diff changeset	112 function module.add_host(module)
9376 220468f7a103 mod_http: Support global HTTP modules Kim Alvefur <zash@zash.se> parents: 9338 diff changeset	113 local host = module.host;
220468f7a103 mod_http: Support global HTTP modules Kim Alvefur <zash@zash.se> parents: 9338 diff changeset	114 if host ~= "*" then
220468f7a103 mod_http: Support global HTTP modules Kim Alvefur <zash@zash.se> parents: 9338 diff changeset	115 host = module:get_option_string("http_host", host);
220468f7a103 mod_http: Support global HTTP modules Kim Alvefur <zash@zash.se> parents: 9338 diff changeset	116 end
4664 7438b3c68576 mod_http: Revamp module for new API and config Matthew Wild <mwild1@gmail.com> parents: 4636 diff changeset	117 local apps = {};
7438b3c68576 mod_http: Revamp module for new API and config Matthew Wild <mwild1@gmail.com> parents: 4636 diff changeset	118 module.environment.apps = apps;
7438b3c68576 mod_http: Revamp module for new API and config Matthew Wild <mwild1@gmail.com> parents: 4636 diff changeset	119 local function http_app_added(event)
7438b3c68576 mod_http: Revamp module for new API and config Matthew Wild <mwild1@gmail.com> parents: 4636 diff changeset	120 local app_name = event.item.name;
4667 d0cfc49f3f2b mod_http: Support for default_path in apps Matthew Wild <mwild1@gmail.com> parents: 4664 diff changeset	121 local default_app_path = event.item.default_path or "/"..app_name;
4892 6c8074f47ca4 mod_http: Add module:http_url([app_name,][default_path]) for a module to get a guess at its external URL Matthew Wild <mwild1@gmail.com> parents: 4774 diff changeset	122 local app_path = get_base_path(module, app_name, default_app_path);
6c8074f47ca4 mod_http: Add module:http_url([app_name,][default_path]) for a module to get a guess at its external URL Matthew Wild <mwild1@gmail.com> parents: 4774 diff changeset	123 if not app_name then
4664 7438b3c68576 mod_http: Revamp module for new API and config Matthew Wild <mwild1@gmail.com> parents: 4636 diff changeset	124 -- TODO: Link to docs
7438b3c68576 mod_http: Revamp module for new API and config Matthew Wild <mwild1@gmail.com> parents: 4636 diff changeset	125 module:log("error", "HTTP app has no 'name', add one or use module:provides('http', app)");
7438b3c68576 mod_http: Revamp module for new API and config Matthew Wild <mwild1@gmail.com> parents: 4636 diff changeset	126 return;
7438b3c68576 mod_http: Revamp module for new API and config Matthew Wild <mwild1@gmail.com> parents: 4636 diff changeset	127 end
7438b3c68576 mod_http: Revamp module for new API and config Matthew Wild <mwild1@gmail.com> parents: 4636 diff changeset	128 apps[app_name] = apps[app_name] or {};
7438b3c68576 mod_http: Revamp module for new API and config Matthew Wild <mwild1@gmail.com> parents: 4636 diff changeset	129 local app_handlers = apps[app_name];
9793 9993fd021d19 mod_http: Solve CORS problems once and for all Kim Alvefur <zash@zash.se> parents: 9504 diff changeset	130
9797 071538a567d5 mod_http: Determine CORS methods to whitelist from actual methods used Kim Alvefur <zash@zash.se> parents: 9796 diff changeset	131 local app_methods = opt_methods;
11397 27a22a1f141c mod_http: Allow modifying CORS header list via :provides API Kim Alvefur <zash@zash.se> parents: 11396 diff changeset	132 local app_headers = opt_headers;
11396 f6bb3b193277 mod_http: Allow setting the CORS credentials flag via :provides API Kim Alvefur <zash@zash.se> parents: 11387 diff changeset	133 local app_credentials = opt_credentials;
9797 071538a567d5 mod_http: Determine CORS methods to whitelist from actual methods used Kim Alvefur <zash@zash.se> parents: 9796 diff changeset	134
9793 9993fd021d19 mod_http: Solve CORS problems once and for all Kim Alvefur <zash@zash.se> parents: 9504 diff changeset	135 local function cors_handler(event_data)
9993fd021d19 mod_http: Solve CORS problems once and for all Kim Alvefur <zash@zash.se> parents: 9504 diff changeset	136 local request, response = event_data.request, event_data.response;
11397 27a22a1f141c mod_http: Allow modifying CORS header list via :provides API Kim Alvefur <zash@zash.se> parents: 11396 diff changeset	137 apply_cors_headers(response, app_methods, app_headers, opt_max_age, app_credentials, request.headers.origin);
9793 9993fd021d19 mod_http: Solve CORS problems once and for all Kim Alvefur <zash@zash.se> parents: 9504 diff changeset	138 end
9993fd021d19 mod_http: Solve CORS problems once and for all Kim Alvefur <zash@zash.se> parents: 9504 diff changeset	139
9796 adfb29f44412 mod_http: Set up to handle OPTIONS Kim Alvefur <zash@zash.se> parents: 9793 diff changeset	140 local function options_handler(event_data)
adfb29f44412 mod_http: Set up to handle OPTIONS Kim Alvefur <zash@zash.se> parents: 9793 diff changeset	141 cors_handler(event_data);
adfb29f44412 mod_http: Set up to handle OPTIONS Kim Alvefur <zash@zash.se> parents: 9793 diff changeset	142 return "";
adfb29f44412 mod_http: Set up to handle OPTIONS Kim Alvefur <zash@zash.se> parents: 9793 diff changeset	143 end
adfb29f44412 mod_http: Set up to handle OPTIONS Kim Alvefur <zash@zash.se> parents: 9793 diff changeset	144
11396 f6bb3b193277 mod_http: Allow setting the CORS credentials flag via :provides API Kim Alvefur <zash@zash.se> parents: 11387 diff changeset	145 if event.item.cors then
f6bb3b193277 mod_http: Allow setting the CORS credentials flag via :provides API Kim Alvefur <zash@zash.se> parents: 11387 diff changeset	146 local cors = event.item.cors;
f6bb3b193277 mod_http: Allow setting the CORS credentials flag via :provides API Kim Alvefur <zash@zash.se> parents: 11387 diff changeset	147 if cors.credentials ~= nil then
f6bb3b193277 mod_http: Allow setting the CORS credentials flag via :provides API Kim Alvefur <zash@zash.se> parents: 11387 diff changeset	148 app_credentials = cors.credentials;
f6bb3b193277 mod_http: Allow setting the CORS credentials flag via :provides API Kim Alvefur <zash@zash.se> parents: 11387 diff changeset	149 end
11397 27a22a1f141c mod_http: Allow modifying CORS header list via :provides API Kim Alvefur <zash@zash.se> parents: 11396 diff changeset	150 if cors.headers then
27a22a1f141c mod_http: Allow modifying CORS header list via :provides API Kim Alvefur <zash@zash.se> parents: 11396 diff changeset	151 for header, enable in pairs(cors.headers) do
27a22a1f141c mod_http: Allow modifying CORS header list via :provides API Kim Alvefur <zash@zash.se> parents: 11396 diff changeset	152 if enable and not app_headers:contains(header) then
27a22a1f141c mod_http: Allow modifying CORS header list via :provides API Kim Alvefur <zash@zash.se> parents: 11396 diff changeset	153 app_headers = app_headers + set.new { header };
27a22a1f141c mod_http: Allow modifying CORS header list via :provides API Kim Alvefur <zash@zash.se> parents: 11396 diff changeset	154 elseif not enable and app_headers:contains(header) then
27a22a1f141c mod_http: Allow modifying CORS header list via :provides API Kim Alvefur <zash@zash.se> parents: 11396 diff changeset	155 app_headers = app_headers - set.new { header };
27a22a1f141c mod_http: Allow modifying CORS header list via :provides API Kim Alvefur <zash@zash.se> parents: 11396 diff changeset	156 end
27a22a1f141c mod_http: Allow modifying CORS header list via :provides API Kim Alvefur <zash@zash.se> parents: 11396 diff changeset	157 end
27a22a1f141c mod_http: Allow modifying CORS header list via :provides API Kim Alvefur <zash@zash.se> parents: 11396 diff changeset	158 end
11396 f6bb3b193277 mod_http: Allow setting the CORS credentials flag via :provides API Kim Alvefur <zash@zash.se> parents: 11387 diff changeset	159 end
f6bb3b193277 mod_http: Allow setting the CORS credentials flag via :provides API Kim Alvefur <zash@zash.se> parents: 11387 diff changeset	160
11022 3e5bc34be734 mod_http: Add way to signal that a module supports streaming uploads Kim Alvefur <zash@zash.se> parents: 11021 diff changeset	161 local streaming = event.item.streaming_uploads;
3e5bc34be734 mod_http: Add way to signal that a module supports streaming uploads Kim Alvefur <zash@zash.se> parents: 11021 diff changeset	162
11399 d5d895313be2 mod_http: Warn if app is missing 'route' Kim Alvefur <zash@zash.se> parents: 11397 diff changeset	163 if not event.item.route then
d5d895313be2 mod_http: Warn if app is missing 'route' Kim Alvefur <zash@zash.se> parents: 11397 diff changeset	164 -- TODO: Link to docs
11400 19a59cb7311e mod_http: Improve message for missing 'route' Kim Alvefur <zash@zash.se> parents: 11399 diff changeset	165 module:log("error", "HTTP app %q provides no 'route', add one to handle HTTP requests", app_name);
11399 d5d895313be2 mod_http: Warn if app is missing 'route' Kim Alvefur <zash@zash.se> parents: 11397 diff changeset	166 return;
d5d895313be2 mod_http: Warn if app is missing 'route' Kim Alvefur <zash@zash.se> parents: 11397 diff changeset	167 end
d5d895313be2 mod_http: Warn if app is missing 'route' Kim Alvefur <zash@zash.se> parents: 11397 diff changeset	168
d5d895313be2 mod_http: Warn if app is missing 'route' Kim Alvefur <zash@zash.se> parents: 11397 diff changeset	169 for key, handler in pairs(event.item.route) do
4667 d0cfc49f3f2b mod_http: Support for default_path in apps Matthew Wild <mwild1@gmail.com> parents: 4664 diff changeset	170 local event_name = get_http_event(host, app_path, key);
4664 7438b3c68576 mod_http: Revamp module for new API and config Matthew Wild <mwild1@gmail.com> parents: 4636 diff changeset	171 if event_name then
9797 071538a567d5 mod_http: Determine CORS methods to whitelist from actual methods used Kim Alvefur <zash@zash.se> parents: 9796 diff changeset	172 local method = event_name:match("^%S+");
071538a567d5 mod_http: Determine CORS methods to whitelist from actual methods used Kim Alvefur <zash@zash.se> parents: 9796 diff changeset	173 if not app_methods:contains(method) then
071538a567d5 mod_http: Determine CORS methods to whitelist from actual methods used Kim Alvefur <zash@zash.se> parents: 9796 diff changeset	174 app_methods = app_methods + set.new{ method };
071538a567d5 mod_http: Determine CORS methods to whitelist from actual methods used Kim Alvefur <zash@zash.se> parents: 9796 diff changeset	175 end
9796 adfb29f44412 mod_http: Set up to handle OPTIONS Kim Alvefur <zash@zash.se> parents: 9793 diff changeset	176 local options_event_name = event_name:gsub("^%S+", "OPTIONS");
4724 a8c234332258 mod_http: Allow a route value to be static data rather than a handler function Matthew Wild <mwild1@gmail.com> parents: 4721 diff changeset	177 if type(handler) ~= "function" then
a8c234332258 mod_http: Allow a route value to be static data rather than a handler function Matthew Wild <mwild1@gmail.com> parents: 4721 diff changeset	178 local data = handler;
a8c234332258 mod_http: Allow a route value to be static data rather than a handler function Matthew Wild <mwild1@gmail.com> parents: 4721 diff changeset	179 handler = function () return data; end
a8c234332258 mod_http: Allow a route value to be static data rather than a handler function Matthew Wild <mwild1@gmail.com> parents: 4721 diff changeset	180 elseif event_name:sub(-2, -1) == "/*" then
5230 6f5640375358 mod_http: Fix path length pattern Kim Alvefur <zash@zash.se> parents: 5204 diff changeset	181 local base_path_len = #event_name:match("/.+$");
4669 0e0a72679f77 mod_http: Pass portion of path that matched wildcard to wildcard handlers, as a second parameter Matthew Wild <mwild1@gmail.com> parents: 4667 diff changeset	182 local _handler = handler;
8972 0b254439d451 mod_http: Rename argument to avoid name clash with outer scope [luacheck] Kim Alvefur <zash@zash.se> parents: 8971 diff changeset	183 handler = function (_event)
0b254439d451 mod_http: Rename argument to avoid name clash with outer scope [luacheck] Kim Alvefur <zash@zash.se> parents: 8971 diff changeset	184 local path = _event.request.path:sub(base_path_len);
0b254439d451 mod_http: Rename argument to avoid name clash with outer scope [luacheck] Kim Alvefur <zash@zash.se> parents: 8971 diff changeset	185 return _handler(_event, path);
4669 0e0a72679f77 mod_http: Pass portion of path that matched wildcard to wildcard handlers, as a second parameter Matthew Wild <mwild1@gmail.com> parents: 4667 diff changeset	186 end;
6504 e1659f32852e mod_http: For URLs that end with / or wildcard handlers, add a low-priority redirect from without to with slash Kim Alvefur <zash@zash.se> parents: 6086 diff changeset	187 module:hook_object_event(server, event_name:sub(1, -3), redir_handler, -1);
e1659f32852e mod_http: For URLs that end with / or wildcard handlers, add a low-priority redirect from without to with slash Kim Alvefur <zash@zash.se> parents: 6086 diff changeset	188 elseif event_name:sub(-1, -1) == "/" then
e1659f32852e mod_http: For URLs that end with / or wildcard handlers, add a low-priority redirect from without to with slash Kim Alvefur <zash@zash.se> parents: 6086 diff changeset	189 module:hook_object_event(server, event_name:sub(1, -2), redir_handler, -1);
4669 0e0a72679f77 mod_http: Pass portion of path that matched wildcard to wildcard handlers, as a second parameter Matthew Wild <mwild1@gmail.com> parents: 4667 diff changeset	190 end
11022 3e5bc34be734 mod_http: Add way to signal that a module supports streaming uploads Kim Alvefur <zash@zash.se> parents: 11021 diff changeset	191 if not streaming then
11021 9673c95895fb net.http.parser: Allow specifying sink for large request bodies Kim Alvefur <zash@zash.se> parents: 10923 diff changeset	192 -- COMPAT Modules not compatible with streaming uploads behave as before.
9673c95895fb net.http.parser: Allow specifying sink for large request bodies Kim Alvefur <zash@zash.se> parents: 10923 diff changeset	193 local _handler = handler;
9673c95895fb net.http.parser: Allow specifying sink for large request bodies Kim Alvefur <zash@zash.se> parents: 10923 diff changeset	194 function handler(event) -- luacheck: ignore 432/event
9673c95895fb net.http.parser: Allow specifying sink for large request bodies Kim Alvefur <zash@zash.se> parents: 10923 diff changeset	195 if event.request.body ~= false then
9673c95895fb net.http.parser: Allow specifying sink for large request bodies Kim Alvefur <zash@zash.se> parents: 10923 diff changeset	196 return _handler(event);
9673c95895fb net.http.parser: Allow specifying sink for large request bodies Kim Alvefur <zash@zash.se> parents: 10923 diff changeset	197 end
9673c95895fb net.http.parser: Allow specifying sink for large request bodies Kim Alvefur <zash@zash.se> parents: 10923 diff changeset	198 end
9673c95895fb net.http.parser: Allow specifying sink for large request bodies Kim Alvefur <zash@zash.se> parents: 10923 diff changeset	199 end
4664 7438b3c68576 mod_http: Revamp module for new API and config Matthew Wild <mwild1@gmail.com> parents: 4636 diff changeset	200 if not app_handlers[event_name] then
10315 d4c538a7d655 mod_http: Unhook CORS related event handlers Kim Alvefur <zash@zash.se> parents: 10258 diff changeset	201 app_handlers[event_name] = {
d4c538a7d655 mod_http: Unhook CORS related event handlers Kim Alvefur <zash@zash.se> parents: 10258 diff changeset	202 main = handler;
d4c538a7d655 mod_http: Unhook CORS related event handlers Kim Alvefur <zash@zash.se> parents: 10258 diff changeset	203 cors = cors_handler;
d4c538a7d655 mod_http: Unhook CORS related event handlers Kim Alvefur <zash@zash.se> parents: 10258 diff changeset	204 options = options_handler;
d4c538a7d655 mod_http: Unhook CORS related event handlers Kim Alvefur <zash@zash.se> parents: 10258 diff changeset	205 };
4696 4700e318add1 mod_http: Use module:hook/unhook_event_object() so that handlers get unregistered if mod_http is unloaded Matthew Wild <mwild1@gmail.com> parents: 4678 diff changeset	206 module:hook_object_event(server, event_name, handler);
9793 9993fd021d19 mod_http: Solve CORS problems once and for all Kim Alvefur <zash@zash.se> parents: 9504 diff changeset	207 module:hook_object_event(server, event_name, cors_handler, 1);
9796 adfb29f44412 mod_http: Set up to handle OPTIONS Kim Alvefur <zash@zash.se> parents: 9793 diff changeset	208 module:hook_object_event(server, options_event_name, options_handler, -1);
4664 7438b3c68576 mod_http: Revamp module for new API and config Matthew Wild <mwild1@gmail.com> parents: 4636 diff changeset	209 else
7438b3c68576 mod_http: Revamp module for new API and config Matthew Wild <mwild1@gmail.com> parents: 4636 diff changeset	210 module:log("warn", "App %s added handler twice for '%s', ignoring", app_name, event_name);
4636 41983ec223f0 mod_http: Include handlers of non-global modules. Waqas Hussain <waqas20@gmail.com> parents: 4635 diff changeset	211 end
4664 7438b3c68576 mod_http: Revamp module for new API and config Matthew Wild <mwild1@gmail.com> parents: 4636 diff changeset	212 else
7359 a5a080c12c96 Update every link to the documentation to use HTTPS Emmanuel Gil Peyrot <linkmauve@linkmauve.fr> parents: 7247 diff changeset	213 module:log("error", "Invalid route in %s, %q. See https://prosody.im/doc/developers/http#routes", app_name, key);
4636 41983ec223f0 mod_http: Include handlers of non-global modules. Waqas Hussain <waqas20@gmail.com> parents: 4635 diff changeset	214 end
4635 ea5215bd2783 mod_http: Provide HTTP service. Waqas Hussain <waqas20@gmail.com> parents: diff changeset	215 end
6597 321321f566fb mod_http: Log a debug message when adding new http apps and warn if no http ports are enabled Kim Alvefur <zash@zash.se> parents: 6596 diff changeset	216 local services = portmanager.get_active_services();
321321f566fb mod_http: Log a debug message when adding new http apps and warn if no http ports are enabled Kim Alvefur <zash@zash.se> parents: 6596 diff changeset	217 if services:get("https") or services:get("http") then
10460 5ce6cbb5ce6a mod_http: Log served URLs at 'info' level Kim Alvefur <zash@zash.se> parents: 10409 diff changeset	218 module:log("info", "Serving '%s' at %s", app_name, module:http_url(app_name, app_path));
11066 dc41c8dfd2b1 mod_http: Silence warnings when running under prosodyctl Matthew Wild <mwild1@gmail.com> parents: 11022 diff changeset	219 elseif prosody.process_type == "prosody" then
6597 321321f566fb mod_http: Log a debug message when adding new http apps and warn if no http ports are enabled Kim Alvefur <zash@zash.se> parents: 6596 diff changeset	220 module:log("warn", "Not listening on any ports, '%s' will be unreachable", app_name);
321321f566fb mod_http: Log a debug message when adding new http apps and warn if no http ports are enabled Kim Alvefur <zash@zash.se> parents: 6596 diff changeset	221 end
4635 ea5215bd2783 mod_http: Provide HTTP service. Waqas Hussain <waqas20@gmail.com> parents: diff changeset	222 end
5776 bd0ff8ae98a8 Remove all trailing whitespace Florian Zeitz <florob@babelmonkeys.de> parents: 5427 diff changeset	223
4664 7438b3c68576 mod_http: Revamp module for new API and config Matthew Wild <mwild1@gmail.com> parents: 4636 diff changeset	224 local function http_app_removed(event)
7438b3c68576 mod_http: Revamp module for new API and config Matthew Wild <mwild1@gmail.com> parents: 4636 diff changeset	225 local app_handlers = apps[event.item.name];
7438b3c68576 mod_http: Revamp module for new API and config Matthew Wild <mwild1@gmail.com> parents: 4636 diff changeset	226 apps[event.item.name] = nil;
10315 d4c538a7d655 mod_http: Unhook CORS related event handlers Kim Alvefur <zash@zash.se> parents: 10258 diff changeset	227 for event_name, handlers in pairs(app_handlers) do
d4c538a7d655 mod_http: Unhook CORS related event handlers Kim Alvefur <zash@zash.se> parents: 10258 diff changeset	228 module:unhook_object_event(server, event_name, handlers.main);
d4c538a7d655 mod_http: Unhook CORS related event handlers Kim Alvefur <zash@zash.se> parents: 10258 diff changeset	229 module:unhook_object_event(server, event_name, handlers.cors);
d4c538a7d655 mod_http: Unhook CORS related event handlers Kim Alvefur <zash@zash.se> parents: 10258 diff changeset	230 local options_event_name = event_name:gsub("^%S+", "OPTIONS");
d4c538a7d655 mod_http: Unhook CORS related event handlers Kim Alvefur <zash@zash.se> parents: 10258 diff changeset	231 module:unhook_object_event(server, options_event_name, handlers.options);
4664 7438b3c68576 mod_http: Revamp module for new API and config Matthew Wild <mwild1@gmail.com> parents: 4636 diff changeset	232 end
4636 41983ec223f0 mod_http: Include handlers of non-global modules. Waqas Hussain <waqas20@gmail.com> parents: 4635 diff changeset	233 end
5776 bd0ff8ae98a8 Remove all trailing whitespace Florian Zeitz <florob@babelmonkeys.de> parents: 5427 diff changeset	234
4664 7438b3c68576 mod_http: Revamp module for new API and config Matthew Wild <mwild1@gmail.com> parents: 4636 diff changeset	235 module:handle_items("http-provider", http_app_added, http_app_removed);
4736 3514338c59c3 net.http.server, mod_http: Support http_default_host config option to specify where to direct requests for unknown HTTP vhosts Matthew Wild <mwild1@gmail.com> parents: 4724 diff changeset	236
9376 220468f7a103 mod_http: Support global HTTP modules Kim Alvefur <zash@zash.se> parents: 9338 diff changeset	237 if host ~= "*" then
220468f7a103 mod_http: Support global HTTP modules Kim Alvefur <zash@zash.se> parents: 9338 diff changeset	238 server.add_host(host);
220468f7a103 mod_http: Support global HTTP modules Kim Alvefur <zash@zash.se> parents: 9338 diff changeset	239 function module.unload()
220468f7a103 mod_http: Support global HTTP modules Kim Alvefur <zash@zash.se> parents: 9338 diff changeset	240 server.remove_host(host);
220468f7a103 mod_http: Support global HTTP modules Kim Alvefur <zash@zash.se> parents: 9338 diff changeset	241 end
4736 3514338c59c3 net.http.server, mod_http: Support http_default_host config option to specify where to direct requests for unknown HTTP vhosts Matthew Wild <mwild1@gmail.com> parents: 4724 diff changeset	242 end
4635 ea5215bd2783 mod_http: Provide HTTP service. Waqas Hussain <waqas20@gmail.com> parents: diff changeset	243 end
ea5215bd2783 mod_http: Provide HTTP service. Waqas Hussain <waqas20@gmail.com> parents: diff changeset	244
9376 220468f7a103 mod_http: Support global HTTP modules Kim Alvefur <zash@zash.se> parents: 9338 diff changeset	245 module.add_host(module); -- set up handling on global context too
220468f7a103 mod_http: Support global HTTP modules Kim Alvefur <zash@zash.se> parents: 9338 diff changeset	246
8594 b4a0bc46c82d mod_http: Set request.ip on all HTTP requests (moves code out of mod_bosh) (fixes #540) Kim Alvefur <zash@zash.se> parents: 7868 diff changeset	247 local trusted_proxies = module:get_option_set("trusted_proxies", { "127.0.0.1", "::1" })._items;
b4a0bc46c82d mod_http: Set request.ip on all HTTP requests (moves code out of mod_bosh) (fixes #540) Kim Alvefur <zash@zash.se> parents: 7868 diff changeset	248
10923 dff1aebd0f2b mod_http: Support CIDR for trusted proxies. Boris Grozev <boris@jitsi.org> parents: 10841 diff changeset	249 local function is_trusted_proxy(ip)
11385 c81b6b8c6b19 mod_http: Optimize proxy IP check Kim Alvefur <zash@zash.se> parents: 11383 diff changeset	250 if trusted_proxies[ip] then
c81b6b8c6b19 mod_http: Optimize proxy IP check Kim Alvefur <zash@zash.se> parents: 11383 diff changeset	251 return true;
c81b6b8c6b19 mod_http: Optimize proxy IP check Kim Alvefur <zash@zash.se> parents: 11383 diff changeset	252 end
10923 dff1aebd0f2b mod_http: Support CIDR for trusted proxies. Boris Grozev <boris@jitsi.org> parents: 10841 diff changeset	253 local parsed_ip = new_ip(ip)
dff1aebd0f2b mod_http: Support CIDR for trusted proxies. Boris Grozev <boris@jitsi.org> parents: 10841 diff changeset	254 for trusted_proxy in trusted_proxies do
dff1aebd0f2b mod_http: Support CIDR for trusted proxies. Boris Grozev <boris@jitsi.org> parents: 10841 diff changeset	255 if match_ip(parsed_ip, parse_cidr(trusted_proxy)) then
dff1aebd0f2b mod_http: Support CIDR for trusted proxies. Boris Grozev <boris@jitsi.org> parents: 10841 diff changeset	256 return true;
dff1aebd0f2b mod_http: Support CIDR for trusted proxies. Boris Grozev <boris@jitsi.org> parents: 10841 diff changeset	257 end
dff1aebd0f2b mod_http: Support CIDR for trusted proxies. Boris Grozev <boris@jitsi.org> parents: 10841 diff changeset	258 end
dff1aebd0f2b mod_http: Support CIDR for trusted proxies. Boris Grozev <boris@jitsi.org> parents: 10841 diff changeset	259 return false
dff1aebd0f2b mod_http: Support CIDR for trusted proxies. Boris Grozev <boris@jitsi.org> parents: 10841 diff changeset	260 end
dff1aebd0f2b mod_http: Support CIDR for trusted proxies. Boris Grozev <boris@jitsi.org> parents: 10841 diff changeset	261
11410 2ea70d291429 mod_http: Consolidate handling of proxied connection details Kim Alvefur <zash@zash.se> parents: 11409 diff changeset	262 local function get_forwarded_connection_info(request) --> ip:string, secure:boolean
11409 d30c44a829c1 net.http.server: Set request.ip so mod_http doesn't have to Kim Alvefur <zash@zash.se> parents: 11408 diff changeset	263 local ip = request.ip;
11410 2ea70d291429 mod_http: Consolidate handling of proxied connection details Kim Alvefur <zash@zash.se> parents: 11409 diff changeset	264 local secure = request.secure; -- set by net.http.server
8594 b4a0bc46c82d mod_http: Set request.ip on all HTTP requests (moves code out of mod_bosh) (fixes #540) Kim Alvefur <zash@zash.se> parents: 7868 diff changeset	265 local forwarded_for = request.headers.x_forwarded_for;
11410 2ea70d291429 mod_http: Consolidate handling of proxied connection details Kim Alvefur <zash@zash.se> parents: 11409 diff changeset	266 if forwarded_for then
10841 22f783d80eec mod_http: Tell luacheck to ignore the long comment lines Kim Alvefur <zash@zash.se> parents: 10840 diff changeset	267 -- luacheck: ignore 631
10840 a83bfb266b15 mod_http: Add documentation to the non-obvious logic of get_ip_from_request Jonas Schäfer <jonas@wielicki.name> parents: 10465 diff changeset	268 -- This logic looks weird at first, but it makes sense.
a83bfb266b15 mod_http: Add documentation to the non-obvious logic of get_ip_from_request Jonas Schäfer <jonas@wielicki.name> parents: 10465 diff changeset	269 -- The for loop will take the last non-trusted-proxy IP from `forwarded_for`.
a83bfb266b15 mod_http: Add documentation to the non-obvious logic of get_ip_from_request Jonas Schäfer <jonas@wielicki.name> parents: 10465 diff changeset	270 -- We append the original request IP to the header. Then, since the last IP wins, there are two cases:
a83bfb266b15 mod_http: Add documentation to the non-obvious logic of get_ip_from_request Jonas Schäfer <jonas@wielicki.name> parents: 10465 diff changeset	271 -- Case a) The original request IP is not in trusted proxies, in which case the X-Forwarded-For header will, effectively, be ineffective; the original request IP will win because it overrides any other IP in the header.
a83bfb266b15 mod_http: Add documentation to the non-obvious logic of get_ip_from_request Jonas Schäfer <jonas@wielicki.name> parents: 10465 diff changeset	272 -- Case b) The original request IP is in trusted proxies. In that case, the if branch in the for loop will skip the last IP, causing it to be ignored. The second-to-last IP will be taken instead.
a83bfb266b15 mod_http: Add documentation to the non-obvious logic of get_ip_from_request Jonas Schäfer <jonas@wielicki.name> parents: 10465 diff changeset	273 -- Case c) If the second-to-last IP is also a trusted proxy, it will also be ignored, iteratively, up to the last IP which isn’t in trusted proxies.
a83bfb266b15 mod_http: Add documentation to the non-obvious logic of get_ip_from_request Jonas Schäfer <jonas@wielicki.name> parents: 10465 diff changeset	274 -- Case d) If all IPs are in trusted proxies, something went obviously wrong and the logic never overwrites `ip`, leaving it at the original request IP.
8594 b4a0bc46c82d mod_http: Set request.ip on all HTTP requests (moves code out of mod_bosh) (fixes #540) Kim Alvefur <zash@zash.se> parents: 7868 diff changeset	275 forwarded_for = forwarded_for..", "..ip;
b4a0bc46c82d mod_http: Set request.ip on all HTTP requests (moves code out of mod_bosh) (fixes #540) Kim Alvefur <zash@zash.se> parents: 7868 diff changeset	276 for forwarded_ip in forwarded_for:gmatch("[^%s,]+") do
10923 dff1aebd0f2b mod_http: Support CIDR for trusted proxies. Boris Grozev <boris@jitsi.org> parents: 10841 diff changeset	277 if not is_trusted_proxy(forwarded_ip) then
8594 b4a0bc46c82d mod_http: Set request.ip on all HTTP requests (moves code out of mod_bosh) (fixes #540) Kim Alvefur <zash@zash.se> parents: 7868 diff changeset	278 ip = forwarded_ip;
b4a0bc46c82d mod_http: Set request.ip on all HTTP requests (moves code out of mod_bosh) (fixes #540) Kim Alvefur <zash@zash.se> parents: 7868 diff changeset	279 end
b4a0bc46c82d mod_http: Set request.ip on all HTTP requests (moves code out of mod_bosh) (fixes #540) Kim Alvefur <zash@zash.se> parents: 7868 diff changeset	280 end
b4a0bc46c82d mod_http: Set request.ip on all HTTP requests (moves code out of mod_bosh) (fixes #540) Kim Alvefur <zash@zash.se> parents: 7868 diff changeset	281 end
11410 2ea70d291429 mod_http: Consolidate handling of proxied connection details Kim Alvefur <zash@zash.se> parents: 11409 diff changeset	282
2ea70d291429 mod_http: Consolidate handling of proxied connection details Kim Alvefur <zash@zash.se> parents: 11409 diff changeset	283 secure = secure or request.headers.x_forwarded_proto == "https";
2ea70d291429 mod_http: Consolidate handling of proxied connection details Kim Alvefur <zash@zash.se> parents: 11409 diff changeset	284
2ea70d291429 mod_http: Consolidate handling of proxied connection details Kim Alvefur <zash@zash.se> parents: 11409 diff changeset	285 return ip, secure;
8594 b4a0bc46c82d mod_http: Set request.ip on all HTTP requests (moves code out of mod_bosh) (fixes #540) Kim Alvefur <zash@zash.se> parents: 7868 diff changeset	286 end
b4a0bc46c82d mod_http: Set request.ip on all HTTP requests (moves code out of mod_bosh) (fixes #540) Kim Alvefur <zash@zash.se> parents: 7868 diff changeset	287
8596 71da54c7f797 mod_http: Pass util.events object to API, fixes traceback Kim Alvefur <zash@zash.se> parents: 8594 diff changeset	288 module:wrap_object_event(server._events, false, function (handlers, event_name, event_data)
8594 b4a0bc46c82d mod_http: Set request.ip on all HTTP requests (moves code out of mod_bosh) (fixes #540) Kim Alvefur <zash@zash.se> parents: 7868 diff changeset	289 local request = event_data.request;
11410 2ea70d291429 mod_http: Consolidate handling of proxied connection details Kim Alvefur <zash@zash.se> parents: 11409 diff changeset	290 if request and is_trusted_proxy(request.ip) then
8594 b4a0bc46c82d mod_http: Set request.ip on all HTTP requests (moves code out of mod_bosh) (fixes #540) Kim Alvefur <zash@zash.se> parents: 7868 diff changeset	291 -- Not included in eg http-error events
11410 2ea70d291429 mod_http: Consolidate handling of proxied connection details Kim Alvefur <zash@zash.se> parents: 11409 diff changeset	292 request.ip, request.secure = get_forwarded_connection_info(request);
8594 b4a0bc46c82d mod_http: Set request.ip on all HTTP requests (moves code out of mod_bosh) (fixes #540) Kim Alvefur <zash@zash.se> parents: 7868 diff changeset	293 end
9338 9beb767295d4 Revert 2dc7490899ae::5d6b252bc36f: Unfinished and broken Kim Alvefur <zash@zash.se> parents: 9336 diff changeset	294 return handlers(event_name, event_data);
8594 b4a0bc46c82d mod_http: Set request.ip on all HTTP requests (moves code out of mod_bosh) (fixes #540) Kim Alvefur <zash@zash.se> parents: 7868 diff changeset	295 end);
b4a0bc46c82d mod_http: Set request.ip on all HTTP requests (moves code out of mod_bosh) (fixes #540) Kim Alvefur <zash@zash.se> parents: 7868 diff changeset	296
5120 bcabea740c00 mod_{admin_telnet,c2s,component,http,net_multiplex,s2s}: Use module:provides() instead of module:add_item(). Waqas Hussain <waqas20@gmail.com> parents: 5093 diff changeset	297 module:provides("net", {
4635 ea5215bd2783 mod_http: Provide HTTP service. Waqas Hussain <waqas20@gmail.com> parents: diff changeset	298 name = "http";
4664 7438b3c68576 mod_http: Revamp module for new API and config Matthew Wild <mwild1@gmail.com> parents: 4636 diff changeset	299 listener = server.listener;
4635 ea5215bd2783 mod_http: Provide HTTP service. Waqas Hussain <waqas20@gmail.com> parents: diff changeset	300 default_port = 5280;
ea5215bd2783 mod_http: Provide HTTP service. Waqas Hussain <waqas20@gmail.com> parents: diff changeset	301 multiplex = {
ea5215bd2783 mod_http: Provide HTTP service. Waqas Hussain <waqas20@gmail.com> parents: diff changeset	302 pattern = "^[A-Z]";
ea5215bd2783 mod_http: Provide HTTP service. Waqas Hussain <waqas20@gmail.com> parents: diff changeset	303 };
ea5215bd2783 mod_http: Provide HTTP service. Waqas Hussain <waqas20@gmail.com> parents: diff changeset	304 });
ea5215bd2783 mod_http: Provide HTTP service. Waqas Hussain <waqas20@gmail.com> parents: diff changeset	305
5120 bcabea740c00 mod_{admin_telnet,c2s,component,http,net_multiplex,s2s}: Use module:provides() instead of module:add_item(). Waqas Hussain <waqas20@gmail.com> parents: 5093 diff changeset	306 module:provides("net", {
4635 ea5215bd2783 mod_http: Provide HTTP service. Waqas Hussain <waqas20@gmail.com> parents: diff changeset	307 name = "https";
4664 7438b3c68576 mod_http: Revamp module for new API and config Matthew Wild <mwild1@gmail.com> parents: 4636 diff changeset	308 listener = server.listener;
7438b3c68576 mod_http: Revamp module for new API and config Matthew Wild <mwild1@gmail.com> parents: 4636 diff changeset	309 default_port = 5281;
4635 ea5215bd2783 mod_http: Provide HTTP service. Waqas Hussain <waqas20@gmail.com> parents: diff changeset	310 encryption = "ssl";
ea5215bd2783 mod_http: Provide HTTP service. Waqas Hussain <waqas20@gmail.com> parents: diff changeset	311 multiplex = {
10465 09697a673015 mod_net_multiplex: Add support for using ALPN Kim Alvefur <zash@zash.se> parents: 10460 diff changeset	312 protocol = "http/1.1";
4635 ea5215bd2783 mod_http: Provide HTTP service. Waqas Hussain <waqas20@gmail.com> parents: diff changeset	313 pattern = "^[A-Z]";
ea5215bd2783 mod_http: Provide HTTP service. Waqas Hussain <waqas20@gmail.com> parents: diff changeset	314 };
ea5215bd2783 mod_http: Provide HTTP service. Waqas Hussain <waqas20@gmail.com> parents: diff changeset	315 });

prosody

21a1b9fb08a1

plugins/mod_http.lua

Software / code / prosody

Annotate

plugins/mod_http.lua @ 11632:21a1b9fb08a1

Software `/` code `/` prosody