Regex Injection

ID

java.regex_injection

Severity

critical

Resource

Injection

Language

Java

Tags

CWE:1333, CWE:625, NIST.SP.800-53, OWASP:2004:A9, PCI-DSS:6.5.1

Description

Improper neutralization of external input used in a regular expression ('Regex Injection').

Regular Expression (Regex) Injection arises when input from users is directly concatenated into a regex pattern without validation or sanitization. This can allow an attacker to manipulate the pattern used for searching or matching, potentially bypassing validation or security checks.

Rationale

Consider the following example in Java:

String userInput = request.getParameter("input");
String regex = "^(input: " + userInput + ")$";
Pattern pattern = Pattern.compile(regex);
Matcher matcher = pattern.matcher(someString);
if (matcher.find()) {
    // Process the match
}

In this code, the userInput is directly embedded into the regex pattern. If the input contains special regex characters or sequences, it can alter the intended structure of the expression. For example, an input of "test)|(^.*$" could manipulate the pattern to match virtually any string, circumventing the intended constraints.

Remediation

To remediate Regular Expression Injection vulnerabilities, you can use the following strategies:

  1. Escape User Input: Always escape user input to be included in regex patterns, using the library’s 'regexp quoting' functions.

  2. Use Strict Validation: Implement strict validation on input prior to its inclusion in a regex pattern. Ensuring that input only contains expected characters significantly lowers the risk of injection.

  3. Predefine Regular Expressions: Avoid dynamically building regex patterns based on user input. Instead, use predefined patterns that safely incorporate user input as part of the matching process.

  4. Input Filtering: Apply input filtering to remove known harmful characters or sequences from user input before processing them in regex operations.

  5. Security Tools and Static Analysis: Utilize SAST tools to identify regex injection vulnerabilities during the development process. These tools can provide early warnings about unsafe patterns or input concatenations.

By following these measures, you not only prevent Regular Expression Injection but also ensure that your application remains robust and secure against a variety of input-based exploits.

Java provides Pattern.quote() to safely handle meta-characters from user input, nullifying their special purpose:

String userInput = request.getParameter("input");
String safeRegex = "^(input: " + Pattern.quote(userInput) + ")$";

So the vulnerable code above would become:

String userInput = request.getParameter("input");
// Fix regex injection by escaping regex meta-characters,
// so userInput will be matched literally
String safeRegex = "^(input: " + Pattern.quote(userInput) + ")$";
Pattern pattern = Pattern.compile(safeRegex);
Matcher matcher = pattern.matcher(someString);
if (matcher.find()) {
    // Process the match
}

Configuration

The detector has the following configurable parameters:

  • sources, that indicates the source kinds to check.

  • neutralizations, that indicates the neutralization kinds to check.

Unless you need to change the default behavior, you typically do not need to configure this detector.

References