[regex_redos] Regular expression denial of service (ReDoS)
What this check looks for
Regular expressions that may backtrack catastrophically (ReDoS), in:
location ~ ...,if ($var ~ ...),server_name ~ ...,rewrite ...andmapregex keys,gzip_disable(matched againstUser-Agent),valid_referers ~...(matched againstReferer),fastcgi_split_path_info(matched against the URI), andproxy_redirect ~...andproxy_cookie_*regexes (matched against upstreamLocationandSet-Cookieheaders).
Why this is a problem
An ambiguous pattern, such as one with nested quantifiers, can take exponential time on crafted input. NGINX uses PCRE2's default match limit, so each such request costs the worker about 0.1 s of CPU (less with pcre_jit) and logs pcre2_match() failed: -47. A location or if match that hits the limit also fails the request with 500.
Bad configuration
location ~ (a+)+$ {
return 200 "ok";
}
Better configuration
Avoid nested quantifiers such as (a+)+ or (.*)+, keep alternations unambiguous, and test patterns with recheck:
location ~ ^a+$ {
return 200 "ok";
}
Configuration
This plugin is opt-in. It does not run unless you point it at a ReDoS checking service.
url
The plugin POSTs each regex to this URL and expects a response in the recheck JSON format, for example from recheck-http-api. By default it is empty and the plugin skips.
CLI
gixy --regex-redos-url "http://127.0.0.1:8080/"
Config
[regex_redos]
url = http://127.0.0.1:8080/
Additional notes
- A regex the checker reports as vulnerable is MEDIUM. Nothing is reported when the checker cannot decide or cannot be reached, or when the
requestspackage is missing. - More background: ReDoS in nginx directives.