com.github.jcustenborder.kafka.connect.utils

Class RegexUtils

java.lang.Object

com.github.jcustenborder.kafka.connect.utils.RegexUtils

public final class RegexUtils
extends Object

Utility class for performing regex operations with timeout protection against ReDoS attacks. This class provides methods for regex replacement, finding, and matching operations.

Design Decision:

• Custom ExecutorService: Considered using a dedicated ExecutorService to manage threads for regex operations. However, this would require explicit lifecycle management (shutdown, resource cleanup) and would complicate usage for consumers of this utility class.
• Common Thread Pool: Using the common thread pool (e.g., via CompletableFuture) was considered, but multiple blocking operations might exhaust the common ForkJoinPool for other users.
• ManagedBlocker: The chosen approach is to use a custom ForkJoinPool.ManagedBlocker. This allows for dispatching blocking operations without exhausting the common ForkJoinPool, while avoiding the complexity of explicit thread pool management. This approach provides a balance between safety, performance, and ease of use for consumers.

See also: OWASP ReDoS

Method Summary

Modifier and Type	Method and Description
static boolean	find(Pattern pattern, String input, long timeoutMs) Executes a matcher().find() operation with timeout protection.
static boolean	matches(Pattern pattern, String input, long timeoutMs) Executes a matcher().matches() operation with timeout protection.
static String	replaceAll(String input, Map<Pattern,String> replacements, long timeoutMs) Executes a matcher().replaceAll(String) operation with timeout protection.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

replaceAll

public static String replaceAll(String input,
                                Map<Pattern,String> replacements,
                                long timeoutMs)
                         throws InterruptedException,
                                ExecutionException,
                                TimeoutException

Executes a matcher().replaceAll(String) operation with timeout protection. See class-level JavaDoc for details on ReDoS protection.

Parameters:

input - The input string

replacements - The regex operation to perform

timeoutMs - The timeout in milliseconds

Returns:

The result of the operation

Throws:

InterruptedException - if the current thread is interrupted

ExecutionException - if the operation throws an exception

TimeoutException - if the operation exceeds the specified timeout

find

public static boolean find(Pattern pattern,
                           String input,
                           long timeoutMs)
                    throws InterruptedException,
                           ExecutionException,
                           TimeoutException

Executes a matcher().find() operation with timeout protection. See class-level JavaDoc for details on ReDoS protection.

Parameters:

pattern - The pattern to match

input - The input string

timeoutMs - The timeout in milliseconds

Returns:

true if the pattern is found, false otherwise

Throws:

InterruptedException - if the current thread is interrupted

ExecutionException - if the operation throws an exception

TimeoutException - if the operation exceeds the specified timeout

matches

public static boolean matches(Pattern pattern,
                              String input,
                              long timeoutMs)
                       throws InterruptedException,
                              ExecutionException,
                              TimeoutException

Executes a matcher().matches() operation with timeout protection. See class-level JavaDoc for details on ReDoS protection.

Parameters:

pattern - The pattern to match

input - The input string

timeoutMs - The timeout in milliseconds

Returns:

true if the pattern matches the entire input, false otherwise

Throws:

InterruptedException - if the current thread is interrupted

ExecutionException - if the operation throws an exception

TimeoutException - if the operation exceeds the specified timeout