Skip to content

Java: whitelist variable name tokenImage for java/sensitive-log as it's used in code generated by JavaCC #16028

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.

Sign up for GitHub

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
owen-mc merged 5 commits into from
Mar 25, 2024
Merged

Java: whitelist variable name tokenImage for java/sensitive-log as it's used in code generated by JavaCC #16028

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
63a04c0
Add test with `tokenImage` as used in JavaCC
owen-mc Mar 23, 2024
4832dc5
Whitelist variable name `tokenImage`
owen-mc Mar 23, 2024
f4b3bae
Add test for ParseException use of `tokenImage`
owen-mc Mar 23, 2024
821f399
Add change note
owen-mc Mar 23, 2024
ac6c4ad
Apply suggestions from code review
owen-mc Mar 24, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion java/ql/lib/semmle/code/java/security/SensitiveLoggingQuery.qll
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,8 @@ class VariableWithSensitiveName extends Variable {
VariableWithSensitiveName() {
exists(string name | name = this.getName() |
name.regexpMatch(getCommonSensitiveInfoRegex()) and
not name.regexpMatch("(?i).*null.*")
not name.regexpMatch("(?i).*null.*") and
name != "tokenImage" // appears in parser code generated by JavaCC
)
}
}
Expand Down
4 changes: 4 additions & 0 deletions java/ql/src/change-notes/2024-03-24-sensitive-log-whitelist-tokenimage.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
category: minorAnalysis
---
* Variables named `tokenImage` are no longer sources for the `java/sensitive-log` query. This is because this variable name is used in parsing code generated by JavaCC, so it causes a large number of false positive alerts.
27 changes: 27 additions & 0 deletions java/ql/test/query-tests/security/CWE-532/TokenSequenceParserTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
import org.apache.logging.log4j.Logger;

interface TokenSequenceParserConstants {
/** Literal token values. */
String[] tokenImage = {
"<EOF>",
};
}

public class TokenSequenceParserTest implements TokenSequenceParserConstants {
void test(String password) {
Logger logger = null;

logger.info("When parsing found this: " + tokenImage[0]); // Safe
}

}

class ParseExceptionTest extends Exception {
String[] tokenImage;

void test() {
Logger logger = null;

logger.info("When parsing found this: " + tokenImage[0]); // Safe
}
}