[1223] Change FormattedMessage pattern heuristic #1885
Merged
+68
−18
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ppkarwasz
force-pushed
the
formatted-message
branch
from
06f2554 to
33341b5
Compare
vy
reviewed
Oct 23, 2023
We change the order in which `FormattedMessage` checks the format of the
provided pattern: we first check for the presence of `{}` placeholders
and only then for `java.util.Format` specifiers.
This eliminates the need for a potentially exponential regular
expression evalutation, which was reported by Spotbugs (apache#1849).
The Javadoc and documentation were improved to clarify the heuristic
used by `FormattedMessage`.
Closes apache#1223.
Remark: since `FormattedMessage` used the **same** regular expression as
`java.util.Format`, if a message uses `java.util.Format` specifiers, it
is still vulnerable to a ReDOS.
ppkarwasz
force-pushed
the
formatted-message
branch
from
d4b0192 to
0dfdd8e
Compare
Let me rephrase that: the regular expression we were using was identical to This PR just removes a "potential ReDOS" warning found by our static analysis tools. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
We change the order in which
FormattedMessagechecks the format of the provided pattern: we first check for the presence of{}placeholders and only then forjava.util.Formatspecifiers.This eliminates the need for a potentially exponential regular expression evalutation, which was reported by Spotbugs (#1849).
The Javadoc and documentation were improved to clarify the heuristic used by
FormattedMessage.Closes #1223.
Remark: since
FormattedMessageused the same regular expression asjava.util.Format, if a message usesjava.util.Formatspecifiers, it is still vulnerable to a ReDOS.