-
Notifications
You must be signed in to change notification settings - Fork 698
SONARJAVA-5683 S2077 Fix FN on strings built with String.format()/formatted(). #5246
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 4 commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
119bacd
S2077 Fix FN on strings built with String.format()/formatted().
tomasz-tylenda-sonarsource 2f1c199
QG
tomasz-tylenda-sonarsource a8fb085
minor
tomasz-tylenda-sonarsource 126fc7d
First review
tomasz-tylenda-sonarsource 774ad5f
Handle primitive wrappers
tomasz-tylenda-sonarsource d96fe5f
Handle missing semantics
tomasz-tylenda-sonarsource File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -28,6 +28,7 @@ | |
import org.sonar.plugins.java.api.JavaFileScannerContext; | ||
import org.sonar.plugins.java.api.semantic.MethodMatchers; | ||
import org.sonar.plugins.java.api.semantic.Symbol; | ||
import org.sonar.plugins.java.api.semantic.Type; | ||
import org.sonar.plugins.java.api.tree.AssignmentExpressionTree; | ||
import org.sonar.plugins.java.api.tree.ExpressionTree; | ||
import org.sonar.plugins.java.api.tree.IdentifierTree; | ||
|
@@ -112,6 +113,14 @@ public class SQLInjectionCheck extends IssuableSubscriptionVisitor { | |
.withAnyParameters() | ||
.build()); | ||
|
||
private static final String JAVA_LANG_STRING = "java.lang.String"; | ||
|
||
private static final MethodMatchers FORMAT_METHODS = MethodMatchers.create() | ||
.ofTypes(JAVA_LANG_STRING) | ||
.names("format", "formatted") | ||
.withAnyParameters() | ||
.build(); | ||
|
||
private static final String MAIN_MESSAGE = "Make sure using a dynamically formatted SQL query is safe here."; | ||
|
||
@Override | ||
|
@@ -123,20 +132,20 @@ public List<Tree.Kind> nodesToVisit() { | |
public void visitNode(Tree tree) { | ||
if (anyMatch(tree)) { | ||
Optional<ExpressionTree> sqlStringArg = arguments(tree) | ||
.filter(arg -> arg.symbolType().is("java.lang.String")) | ||
.filter(arg -> arg.symbolType().is(JAVA_LANG_STRING)) | ||
.findFirst(); | ||
|
||
if (sqlStringArg.isPresent()) { | ||
ExpressionTree sqlArg = sqlStringArg.get(); | ||
if (isDynamicConcatenation(sqlArg)) { | ||
if (isDynamicString(sqlArg)) { | ||
reportIssue(sqlArg, MAIN_MESSAGE); | ||
} else if (sqlArg.is(Tree.Kind.IDENTIFIER)) { | ||
IdentifierTree identifierTree = (IdentifierTree) sqlArg; | ||
Symbol symbol = identifierTree.symbol(); | ||
ExpressionTree initializerOrExpression = getInitializerOrExpression(symbol.declaration()); | ||
List<AssignmentExpressionTree> reassignments = getReassignments(symbol.owner().declaration(), symbol.usages()); | ||
|
||
if ((initializerOrExpression != null && isDynamicConcatenation(initializerOrExpression)) || | ||
if ((initializerOrExpression != null && isDynamicString(initializerOrExpression)) || | ||
reassignments.stream().anyMatch(SQLInjectionCheck::isDynamicPlusAssignment)) { | ||
reportIssue(sqlArg, MAIN_MESSAGE, secondaryLocations(initializerOrExpression, reassignments, identifierTree.name()), null); | ||
} | ||
|
@@ -197,7 +206,35 @@ private static boolean isDynamicPlusAssignment(ExpressionTree arg) { | |
return arg.is(Tree.Kind.PLUS_ASSIGNMENT) && !((AssignmentExpressionTree) arg).expression().asConstant().isPresent(); | ||
} | ||
|
||
private static boolean isDynamicString(ExpressionTree arg) { | ||
return isDynamicConcatenation(arg) || isDynamicFormat(arg); | ||
} | ||
|
||
private static boolean isDynamicConcatenation(ExpressionTree arg) { | ||
return arg.is(Tree.Kind.PLUS) && !arg.asConstant().isPresent(); | ||
} | ||
|
||
private static boolean isDynamicFormat(Tree tree) { | ||
return tree instanceof MethodInvocationTree mit | ||
&& FORMAT_METHODS.matches(mit) | ||
&& hasDynamicStringParameters(mit); | ||
} | ||
|
||
/** | ||
* Checks if parameters to format/formatted are dynamic variables susceptible to SQL injection. | ||
*/ | ||
private static boolean hasDynamicStringParameters(MethodInvocationTree mit) { | ||
boolean firstArg = true; | ||
for (ExpressionTree arg: mit.arguments()) { | ||
Type type = arg.symbolType(); | ||
// `format` has a variant with Locale as the first argument - we do not need to check that parameter. | ||
boolean isFirstLocaleArgument = firstArg && !type.isUnknown() && type.is("java.util.Locale"); | ||
// Primitives will not lead to SQL injection, so the code is compliant. | ||
if (!isFirstLocaleArgument && !type.isPrimitive() && arg.asConstant().isEmpty()) { | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. We could also use isPrimitiveWrapper There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Done. |
||
return true; | ||
} | ||
firstArg = false; | ||
} | ||
return false; | ||
} | ||
} |
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
&& !type.isUnknown()
seems useless, remove or invert the logicThere was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Moved and tested.