MINOR: uri_normalizer: Add a percent-upper normalizer

This normalizer uppercases the hexadecimal characters used in percent-encoding.

See GitHub Issue #714.
This commit is contained in:
Tim Duesterhus 2021-04-15 21:46:02 +02:00 committed by Christopher Faulet
parent d7b89be30a
commit a407193376
6 changed files with 172 additions and 1 deletions

View File

@ -6014,6 +6014,7 @@ http-request early-hint <name> <fmt> [ { if | unless } <condition> ]
http-request normalize-uri <normalizer> [ { if | unless } <condition> ]
http-request normalize-uri dotdot [ full ] [ { if | unless } <condition> ]
http-request normalize-uri merge-slashes [ { if | unless } <condition> ]
http-request normalize-uri percent-upper [ strict ] [ { if | unless } <condition> ]
http-request normalize-uri sort-query [ { if | unless } <condition> ]
Performs normalization of the request's URI. The following normalizers are
@ -6046,6 +6047,19 @@ http-request normalize-uri sort-query [ { if | unless } <condition> ]
- // -> /
- /foo//bar -> /foo/bar
- percent-upper: Uppercases letters within percent-encoded sequences
(RFC 3986#6.2.21).
Example:
- /%6f -> /%6F
- /%zz -> /%zz
If the "strict" option is specified then invalid sequences will result
in a HTTP 400 Bad Request being returned.
Example:
- /%zz -> HTTP 400
- sort-query: Sorts the query string parameters by parameter name.
Parameters are assumed to be delimited by '&'. Shorter names sort before
longer names and identical parameter names maintain their relative order.

View File

@ -106,6 +106,8 @@ enum act_normalize_uri {
ACT_NORMALIZE_URI_DOTDOT,
ACT_NORMALIZE_URI_DOTDOT_FULL,
ACT_NORMALIZE_URI_SORT_QUERY,
ACT_NORMALIZE_URI_PERCENT_UPPER,
ACT_NORMALIZE_URI_PERCENT_UPPER_STRICT,
};
/* NOTE: if <.action_ptr> is defined, the referenced function will always be

View File

@ -18,6 +18,7 @@
#include <haproxy/uri_normalizer-t.h>
enum uri_normalizer_err uri_normalizer_percent_upper(const struct ist input, int strict, struct ist *dst);
enum uri_normalizer_err uri_normalizer_path_dotdot(const struct ist path, int full, struct ist *dst);
enum uri_normalizer_err uri_normalizer_path_merge_slashes(const struct ist path, struct ist *dst);
enum uri_normalizer_err uri_normalizer_query_sort(const struct ist query, const char delim, struct ist *dst);

View File

@ -8,7 +8,7 @@ feature ignore_unknown_macro
server s1 {
rxreq
txresp
} -repeat 34 -start
} -repeat 43 -start
haproxy h1 -conf {
defaults
@ -58,6 +58,30 @@ haproxy h1 -conf {
default_backend be
frontend fe_percent_upper
bind "fd@${fe_percent_upper}"
http-request set-var(txn.before) url
http-request normalize-uri percent-upper
http-request set-var(txn.after) url
http-response add-header before %[var(txn.before)]
http-response add-header after %[var(txn.after)]
default_backend be
frontend fe_percent_upper_strict
bind "fd@${fe_percent_upper_strict}"
http-request set-var(txn.before) url
http-request normalize-uri percent-upper strict
http-request set-var(txn.after) url
http-response add-header before %[var(txn.before)]
http-response add-header after %[var(txn.after)]
default_backend be
backend be
server s1 ${s1_addr}:${s1_port}
@ -249,3 +273,42 @@ client c3 -connect ${h1_fe_sort_query_sock} {
expect resp.http.before == "*"
expect resp.http.after == "*"
} -run
client c4 -connect ${h1_fe_percent_upper_sock} {
txreq -url "/a?a=a"
rxresp
expect resp.http.before == "/a?a=a"
expect resp.http.after == "/a?a=a"
txreq -url "/%aa?a=%aa"
rxresp
expect resp.http.before == "/%aa?a=%aa"
expect resp.http.after == "/%AA?a=%AA"
txreq -url "/%zz?a=%zz"
rxresp
expect resp.status == 200
expect resp.http.before == "/%zz?a=%zz"
expect resp.http.after == "/%zz?a=%zz"
txreq -req OPTIONS -url "*"
rxresp
expect resp.http.before == "*"
expect resp.http.after == "*"
} -run
client c5 -connect ${h1_fe_percent_upper_strict_sock} {
txreq -url "/a?a=a"
rxresp
expect resp.http.before == "/a?a=a"
expect resp.http.after == "/a?a=a"
txreq -url "/%aa?a=%aa"
rxresp
expect resp.http.before == "/%aa?a=%aa"
expect resp.http.after == "/%AA?a=%AA"
txreq -url "/%zz?a=%zz"
rxresp
expect resp.status == 400
} -run

View File

@ -267,6 +267,24 @@ static enum act_return http_action_normalize_uri(struct act_rule *rule, struct p
break;
}
case ACT_NORMALIZE_URI_PERCENT_UPPER:
case ACT_NORMALIZE_URI_PERCENT_UPPER_STRICT: {
const struct ist path = http_get_path(uri);
struct ist newpath = ist2(replace->area, replace->size);
if (!isttest(path))
goto leave;
err = uri_normalizer_percent_upper(path, rule->action == ACT_NORMALIZE_URI_PERCENT_UPPER_STRICT, &newpath);
if (err != URI_NORMALIZER_ERR_NONE)
break;
if (!http_replace_req_path(htx, newpath, 1))
goto fail_rewrite;
break;
}
}
switch (err) {
@ -352,6 +370,21 @@ static enum act_parse_ret parse_http_normalize_uri(const char **args, int *orig_
rule->action = ACT_NORMALIZE_URI_SORT_QUERY;
}
else if (strcmp(args[cur_arg], "percent-upper") == 0) {
cur_arg++;
if (strcmp(args[cur_arg], "strict") == 0) {
cur_arg++;
rule->action = ACT_NORMALIZE_URI_PERCENT_UPPER_STRICT;
}
else if (!*args[cur_arg]) {
rule->action = ACT_NORMALIZE_URI_PERCENT_UPPER;
}
else if (strcmp(args[cur_arg], "if") != 0 && strcmp(args[cur_arg], "unless") != 0) {
memprintf(err, "unknown argument '%s' for 'percent-upper' normalizer", args[cur_arg]);
return ACT_RET_PRS_ERR;
}
}
else {
memprintf(err, "unknown normalizer '%s'", args[cur_arg]);
return ACT_RET_PRS_ERR;

View File

@ -15,8 +15,66 @@
#include <haproxy/api.h>
#include <haproxy/buf.h>
#include <haproxy/chunk.h>
#include <haproxy/tools.h>
#include <haproxy/uri_normalizer.h>
/* Uppercases letters used in percent encoding.
*
* If `strict` is set to 0 then percent characters that are not followed by a
* hexadecimal digit are returned as-is without modifying the following letters.
* If `strict` is set to 1 then `URI_NORMALIZER_ERR_INVALID_INPUT` is returned
* for invalid sequences.
*/
enum uri_normalizer_err uri_normalizer_percent_upper(const struct ist input, int strict, struct ist *dst)
{
enum uri_normalizer_err err;
const size_t size = istclear(dst);
struct ist output = *dst;
struct ist scanner = input;
/* The output will have the same length. */
if (size < istlen(input)) {
err = URI_NORMALIZER_ERR_ALLOC;
goto fail;
}
while (istlen(scanner)) {
const char current = istshift(&scanner);
if (current == '%') {
if (istlen(scanner) >= 2) {
if (ishex(istptr(scanner)[0]) && ishex(istptr(scanner)[1])) {
output = __istappend(output, current);
output = __istappend(output, toupper(istshift(&scanner)));
output = __istappend(output, toupper(istshift(&scanner)));
continue;
}
}
if (strict) {
err = URI_NORMALIZER_ERR_INVALID_INPUT;
goto fail;
}
else {
output = __istappend(output, current);
}
}
else {
output = __istappend(output, current);
}
}
*dst = output;
return URI_NORMALIZER_ERR_NONE;
fail:
return err;
}
/* Merges `/../` with preceding path segments.
*
* If `full` is set to `0` then `/../` will be printed at the start of the resulting