hohn/codeql
1
0
Fork 0
mirror of https://github.com/github/codeql.git synced 2026-04-26 09:15:12 +02:00
Code Issues Packages Projects Releases Wiki Activity

Refactor more system property access logic

Browse Source
This commit is contained in:
Jonathan Leitschuh
2022-03-02 19:33:05 -05:00
parent 3c53a05e16
commit a7adbb7291
8 changed files with 182 additions and 102 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
java/ql/lib/semmle/code/java/JDK.qll
View File

@@ -202,21 +202,6 @@ class TypeFile extends Class {
TypeFile() { this.hasQualifiedName("java.io", "File") }
}
/** The field `java.io.File.separator` or `java.io.File.separatorChar` */
class FieldFileSeparator extends Field {
FieldFileSeparator() {
this.getDeclaringType() instanceof TypeFile and this.hasName(["separator", "separatorChar"])
}
}
/* The field `java.io.File.pathSeparator` or `java.io.File.pathSeparatorChar` */
class FieldFilePathSeparator extends Field {
FieldFilePathSeparator() {
this.getDeclaringType() instanceof TypeFile and
this.hasName(["pathSeparator", "pathSeparatorChar"])
}
}
// --- Standard methods ---
/**
* Any constructor of class `java.lang.ProcessBuilder`.

20
java/ql/lib/semmle/code/java/StringFormat.qll
View File

@@ -4,6 +4,7 @@
import java
import dataflow.DefUse
private import semmle.code.java.environment.SystemProperty
/**
* A library method that formats a number of its arguments according to a
@@ -312,24 +313,7 @@ private predicate formatStringValue(Expr e, string fmtvalue) {
or
formatStringValue(e.(ChooseExpr).getAResultExpr(), fmtvalue)
or
exists(Method getprop, MethodAccess ma, string prop |
e = ma and
ma.getMethod() = getprop and
getprop.hasName("getProperty") and
getprop.getDeclaringType().hasQualifiedName("java.lang", "System") and
getprop.getNumberOfParameters() = 1 and
ma.getAnArgument().(StringLiteral).getValue() = prop and
(prop = "line.separator" or prop = "file.separator" or prop = "path.separator") and
fmtvalue = "x" // dummy value
)
or
exists(Field f |
e = f.getAnAccess() and
fmtvalue = "x" // dummy value
|
f instanceof FieldFileSeparator or
f instanceof FieldFilePathSeperator
)
e = getSystemProperty(["line.separator", "file.separator", "path.separator"]) and fmtvalue = "x" // dummy value
)
}

194
java/ql/lib/semmle/code/java/environment/SystemProperty.qll
View File

@@ -1,14 +1,49 @@
import java
private import semmle.code.java.frameworks.apache.Lang
/**
* Gets Expr that return the value of `propertyName` from `System.getProperty()`.
* Gets Expr that return the value of `propertyName` from `System.getProperty()`.
*/
Expr getSystemProperty(string propertyName) {
result = getSystemPropertyFromSystem(propertyName) or
result = getSystemPropertyFromFile(propertyName) or
result = getSystemPropertyFromApacheSystemUtils(propertyName) or
result = getSystemPropertyFromApacheFileUtils(propertyName) or
result = getSystemPropertyFromGuava(propertyName) or
result = getSystemPropertyFromOperatingSystemMXBean(propertyName) or
result = getSystemPropertyFromSpringProperties(propertyName)
}
private MethodAccess getSystemPropertyFromSystem(string propertyName) {
result =
any(MethodAccessSystemGetProperty methodAccessSystemGetProperty |
methodAccessSystemGetProperty.hasCompileTimeConstantGetPropertyName(propertyName)
) or
result = getSystemPropertyFromApacheSystemUtils(propertyName) or
result = getSystemPropertyFromApacheFileUtils(propertyName) or
result = getSystemPropertyFromOperatingSystemMXBean(propertyName)
)
or
exists(Method m | result.getMethod() = m | m.hasName("lineSeparator")) and
propertyName = "line.separator"
}
private FieldAccess getSystemPropertyFromFile(string propertyName) {
result.getField() instanceof FieldFileSeparator and propertyName = "file.separator"
or
result.getField() instanceof FieldFilePathSeparator and propertyName = "path.separator"
}
/** The field `java.io.File.separator` or `java.io.File.separatorChar` */
private class FieldFileSeparator extends Field {
FieldFileSeparator() {
this.getDeclaringType() instanceof TypeFile and this.hasName(["separator", "separatorChar"])
}
}
/* The field `java.io.File.pathSeparator` or `java.io.File.pathSeparatorChar` */
private class FieldFilePathSeparator extends Field {
FieldFilePathSeparator() {
this.getDeclaringType() instanceof TypeFile and
this.hasName(["pathSeparator", "pathSeparatorChar"])
}
}
/**
@@ -17,84 +52,84 @@ Expr getSystemProperty(string propertyName) {
*/
private FieldAccess getSystemPropertyFromApacheSystemUtils(string propertyName) {
exists(Field f | f = result.getField() and f.getDeclaringType() instanceof ApacheSystemUtils |
f.getName() = "AWT_TOOLKIT" and propertyName = "awt.toolkit"
f.hasName("AWT_TOOLKIT") and propertyName = "awt.toolkit"
or
f.getName() = "FILE_ENCODING" and propertyName = "file.encoding"
f.hasName("FILE_ENCODING") and propertyName = "file.encoding"
or
f.getName() = "FILE_SEPARATOR" and propertyName = "file.separator"
f.hasName("FILE_SEPARATOR") and propertyName = "file.separator"
or
f.getName() = "JAVA_AWT_FONTS" and propertyName = "java.awt.fonts"
f.hasName("JAVA_AWT_FONTS") and propertyName = "java.awt.fonts"
or
f.getName() = "JAVA_AWT_GRAPHICSENV" and propertyName = "java.awt.graphicsenv"
f.hasName("JAVA_AWT_GRAPHICSENV") and propertyName = "java.awt.graphicsenv"
or
f.getName() = "JAVA_AWT_HEADLESS" and propertyName = "java.awt.headless"
f.hasName("JAVA_AWT_HEADLESS") and propertyName = "java.awt.headless"
or
f.getName() = "JAVA_AWT_PRINTERJOB" and propertyName = "java.awt.printerjob"
f.hasName("JAVA_AWT_PRINTERJOB") and propertyName = "java.awt.printerjob"
or
f.getName() = "JAVA_CLASS_PATH" and propertyName = "java.class.path"
f.hasName("JAVA_CLASS_PATH") and propertyName = "java.class.path"
or
f.getName() = "JAVA_CLASS_VERSION" and propertyName = "java.class.version"
f.hasName("JAVA_CLASS_VERSION") and propertyName = "java.class.version"
or
f.getName() = "JAVA_COMPILER" and propertyName = "java.compiler"
f.hasName("JAVA_COMPILER") and propertyName = "java.compiler"
or
f.getName() = "JAVA_EXT_DIRS" and propertyName = "java.ext.dirs"
f.hasName("JAVA_EXT_DIRS") and propertyName = "java.ext.dirs"
or
f.getName() = "JAVA_HOME" and propertyName = "java.home"
f.hasName("JAVA_HOME") and propertyName = "java.home"
or
f.getName() = "JAVA_IO_TMPDIR" and propertyName = "java.io.tmpdir"
f.hasName("JAVA_IO_TMPDIR") and propertyName = "java.io.tmpdir"
or
f.getName() = "JAVA_LIBRARY_PATH" and propertyName = "java.library.path"
f.hasName("JAVA_LIBRARY_PATH") and propertyName = "java.library.path"
or
f.getName() = "JAVA_RUNTIME_NAME" and propertyName = "java.runtime.name"
f.hasName("JAVA_RUNTIME_NAME") and propertyName = "java.runtime.name"
or
f.getName() = "JAVA_RUNTIME_VERSION" and propertyName = "java.runtime.version"
f.hasName("JAVA_RUNTIME_VERSION") and propertyName = "java.runtime.version"
or
f.getName() = "JAVA_SPECIFICATION_NAME" and propertyName = "java.specification.name"
f.hasName("JAVA_SPECIFICATION_NAME") and propertyName = "java.specification.name"
or
f.getName() = "JAVA_SPECIFICATION_VENDOR" and propertyName = "java.specification.vendor"
f.hasName("JAVA_SPECIFICATION_VENDOR") and propertyName = "java.specification.vendor"
or
f.getName() = "JAVA_UTIL_PREFS_PREFERENCES_FACTORY" and
f.hasName("JAVA_UTIL_PREFS_PREFERENCES_FACTORY") and
propertyName = "java.util.prefs.PreferencesFactory"
or
f.getName() = "JAVA_VENDOR" and propertyName = "java.vendor"
f.hasName("JAVA_VENDOR") and propertyName = "java.vendor"
or
f.getName() = "JAVA_VENDOR_URL" and propertyName = "java.vendor.url"
f.hasName("JAVA_VENDOR_URL") and propertyName = "java.vendor.url"
or
f.getName() = "JAVA_VERSION" and propertyName = "java.version"
f.hasName("JAVA_VERSION") and propertyName = "java.version"
or
f.getName() = "JAVA_VM_INFO" and propertyName = "java.vm.info"
f.hasName("JAVA_VM_INFO") and propertyName = "java.vm.info"
or
f.getName() = "JAVA_VM_NAME" and propertyName = "java.vm.name"
f.hasName("JAVA_VM_NAME") and propertyName = "java.vm.name"
or
f.getName() = "JAVA_VM_SPECIFICATION_NAME" and propertyName = "java.vm.specification.name"
f.hasName("JAVA_VM_SPECIFICATION_NAME") and propertyName = "java.vm.specification.name"
or
f.getName() = "JAVA_VM_SPECIFICATION_VENDOR" and propertyName = "java.vm.specification.vendor"
f.hasName("JAVA_VM_SPECIFICATION_VENDOR") and propertyName = "java.vm.specification.vendor"
or
f.getName() = "JAVA_VM_VENDOR" and propertyName = "java.vm.vendor"
f.hasName("JAVA_VM_VENDOR") and propertyName = "java.vm.vendor"
or
f.getName() = "JAVA_VM_VERSION" and propertyName = "java.vm.version"
f.hasName("JAVA_VM_VERSION") and propertyName = "java.vm.version"
or
f.getName() = "LINE_SEPARATOR" and propertyName = "line.separator"
f.hasName("LINE_SEPARATOR") and propertyName = "line.separator"
or
f.getName() = "OS_ARCH" and propertyName = "os.arch"
f.hasName("OS_ARCH") and propertyName = "os.arch"
or
f.getName() = "OS_NAME" and propertyName = "os.name"
f.hasName("OS_NAME") and propertyName = "os.name"
or
f.getName() = "OS_VERSION" and propertyName = "os.version"
f.hasName("OS_VERSION") and propertyName = "os.version"
or
f.getName() = "PATH_SEPARATOR" and propertyName = "path.separator"
f.hasName("PATH_SEPARATOR") and propertyName = "path.separator"
or
f.getName() = "USER_COUNTRY" and propertyName = "user.country"
f.hasName("USER_COUNTRY") and propertyName = "user.country"
or
f.getName() = "USER_DIR" and propertyName = "user.dir"
f.hasName("USER_DIR") and propertyName = "user.dir"
or
f.getName() = "USER_HOME" and propertyName = "user.home"
f.hasName("USER_HOME") and propertyName = "user.home"
or
f.getName() = "USER_LANGUAGE" and propertyName = "user.language"
f.hasName("USER_LANGUAGE") and propertyName = "user.language"
or
f.getName() = "USER_NAME" and propertyName = "user.name"
f.hasName("USER_NAME") and propertyName = "user.name"
or
f.getName() = "USER_TIMEZONE" and propertyName = "user.timezone"
f.hasName("USER_TIMEZONE") and propertyName = "user.timezone"
)
}
@@ -109,6 +144,70 @@ private MethodAccess getSystemPropertyFromApacheFileUtils(string propertyName) {
)
}
private MethodAccess getSystemPropertyFromGuava(string propertyName) {
exists(EnumConstant ec |
ec.getDeclaringType().hasQualifiedName("com.google.common.base", "StandardSystemProperty") and
result.getQualifier() = ec.getAnAccess() and
result.getMethod().hasName("value")
|
ec.hasName("JAVA_VERSION") and propertyName = "java.version"
or
ec.hasName("JAVA_VENDOR") and propertyName = "java.vendor"
or
ec.hasName("JAVA_VENDOR_URL") and propertyName = "java.vendor.url"
or
ec.hasName("JAVA_HOME") and propertyName = "java.home"
or
ec.hasName("JAVA_VM_SPECIFICATION_VERSION") and propertyName = "java.vm.specification.version"
or
ec.hasName("JAVA_VM_SPECIFICATION_VENDOR") and propertyName = "java.vm.specification.vendor"
or
ec.hasName("JAVA_VM_SPECIFICATION_NAME") and propertyName = "java.vm.specification.name"
or
ec.hasName("JAVA_VM_VERSION") and propertyName = "java.vm.version"
or
ec.hasName("JAVA_VM_VENDOR") and propertyName = "java.vm.vendor"
or
ec.hasName("JAVA_VM_NAME") and propertyName = "java.vm.name"
or
ec.hasName("JAVA_SPECIFICATION_VERSION") and propertyName = "java.specification.version"
or
ec.hasName("JAVA_SPECIFICATION_VENDOR") and propertyName = "java.specification.vendor"
or
ec.hasName("JAVA_SPECIFICATION_NAME") and propertyName = "java.specification.name"
or
ec.hasName("JAVA_CLASS_VERSION") and propertyName = "java.class.version"
or
ec.hasName("JAVA_CLASS_PATH") and propertyName = "java.class.path"
or
ec.hasName("JAVA_LIBRARY_PATH") and propertyName = "java.library.path"
or
ec.hasName("JAVA_IO_TMPDIR") and propertyName = "java.io.tmpdir"
or
ec.hasName("JAVA_COMPILER") and propertyName = "java.compiler"
or
ec.hasName("JAVA_EXT_DIRS") and propertyName = "java.ext.dirs"
or
ec.hasName("OS_NAME") and propertyName = "os.name"
or
ec.hasName("OS_ARCH") and propertyName = "os.arch"
or
ec.hasName("OS_VERSION") and propertyName = "os.version"
or
ec.hasName("FILE_SEPARATOR") and propertyName = "file.separator"
or
ec.hasName("PATH_SEPARATOR") and propertyName = "path.separator"
or
ec.hasName("LINE_SEPARATOR") and propertyName = "line.separator"
or
ec.hasName("USER_NAME") and propertyName = "user.name"
or
ec.hasName("USER_HOME") and propertyName = "user.home"
or
ec.hasName("USER_DIR") and propertyName = "user.dir"
)
}
private MethodAccess getSystemPropertyFromOperatingSystemMXBean(string propertyName) {
exists(Method m |
m = result.getMethod() and
@@ -121,3 +220,12 @@ private MethodAccess getSystemPropertyFromOperatingSystemMXBean(string propertyN
m.getName() = "getVersion" and propertyName = "os.version"
)
}
private MethodAccess getSystemPropertyFromSpringProperties(string propertyName) {
exists(Method m |
m = result.getMethod() and
m.getDeclaringType().hasQualifiedName("org.springframework.core", "SpringProperties") and
m.hasName("getProperty")
) and
result.getArgument(0).(CompileTimeConstantExpr).getStringValue() = propertyName
}

23
java/ql/lib/semmle/code/java/os/OSCheck.qll
View File

@@ -68,11 +68,12 @@ private class IsWindowsFromSystemProp extends IsWindowsGuard instanceof MethodAc
}
/**
* Holds when the Guard is an equality check between the Field `f` and the string or char constant `compareToLiteral`.
* Holds when the Guard is an equality check between the system property with the name `propertyName`
* and the string or char constant `compareToLiteral`.
*/
private Guard isOsFromFieldEqualityCheck(Field f, string compareToLiteral) {
private Guard isOsFromFieldEqualityCheck(string propertyName, string compareToLiteral) {
result
.isEquality(any(FieldAccess fa | fa.getField() = f),
.isEquality(getSystemProperty(propertyName),
any(Literal literal |
(literal instanceof CharacterLiteral or literal instanceof StringLiteral) and
literal.getValue() = compareToLiteral
@@ -80,27 +81,19 @@ private Guard isOsFromFieldEqualityCheck(Field f, string compareToLiteral) {
}
private class IsWindowsFromCharPathSeperator extends IsWindowsGuard {
IsWindowsFromCharPathSeperator() {
this = isOsFromFieldEqualityCheck(any(FieldFilePathSeparator f), ";")
}
IsWindowsFromCharPathSeperator() { this = isOsFromFieldEqualityCheck("path.separator", "\\") }
}
private class IsWindowsFromCharSeperator extends IsWindowsGuard {
IsWindowsFromCharSeperator() {
this = isOsFromFieldEqualityCheck(any(FieldFileSeparator f), "\\")
}
IsWindowsFromCharSeperator() { this = isOsFromFieldEqualityCheck("file.separator", ";") }
}
private class IsUnixFromCharPathSeperator extends IsUnixGuard {
IsUnixFromCharPathSeperator() {
this = isOsFromFieldEqualityCheck(any(FieldFilePathSeparator f), ":")
}
IsUnixFromCharPathSeperator() { this = isOsFromFieldEqualityCheck("path.separator", "/") }
}
private class IsUnixFromCharSeperator extends IsUnixGuard {
IsUnixFromCharSeperator() {
this = isOsFromFieldEqualityCheck(any(FieldFileSeparator f), "/")
}
IsUnixFromCharSeperator() { this = isOsFromFieldEqualityCheck("file.separator", ":") }
}
private class IsUnixFromSystemProp extends IsAnyUnixGuard instanceof MethodAccess {

8
java/ql/test/library-tests/os/Test.java
View File

@@ -56,6 +56,10 @@ public class Test {
if (File.separator == "\\") {
onlyOnWindows();
}
if (System.getProperty("path.separator").equals("\\")) {
onlyOnWindows();
}
}
void testUnix() {
@@ -89,6 +93,10 @@ public class Test {
if (File.separator == "/") {
onlyOnUnix();
}
if (System.getProperty("path.separator").equals("/")) {
onlyOnUnix();
}
}
void testLinux() {

16
java/ql/test/library-tests/os/any-unix-test.expected
View File

@@ -27,11 +27,11 @@
| ../../stubs/apache-commons-lang3-3.7/org/apache/commons/lang3/SystemUtils.java:1415:5:1415:84 | IS_OS_SOLARIS |
| ../../stubs/apache-commons-lang3-3.7/org/apache/commons/lang3/SystemUtils.java:1427:5:1427:83 | IS_OS_SUN_OS |
| ../../stubs/apache-commons-lang3-3.7/org/apache/commons/lang3/SystemUtils.java:1625:5:1625:80 | IS_OS_ZOS |
| Test.java:95:13:95:73 | contains(...) |
| Test.java:99:13:99:59 | contains(...) |
| Test.java:103:13:103:35 | SystemUtils.IS_OS_LINUX |
| Test.java:109:14:109:36 | SystemUtils.IS_OS_LINUX |
| Test.java:117:13:117:62 | contains(...) |
| Test.java:121:14:121:72 | contains(...) |
| Test.java:125:14:125:34 | SystemUtils.IS_OS_MAC |
| Test.java:131:14:131:45 | SystemUtils.IS_OS_MAC_OSX_MOJAVE |
| Test.java:103:13:103:73 | contains(...) |
| Test.java:107:13:107:59 | contains(...) |
| Test.java:111:13:111:35 | SystemUtils.IS_OS_LINUX |
| Test.java:117:14:117:36 | SystemUtils.IS_OS_LINUX |
| Test.java:125:13:125:62 | contains(...) |
| Test.java:129:14:129:72 | contains(...) |
| Test.java:133:14:133:34 | SystemUtils.IS_OS_MAC |
| Test.java:139:14:139:45 | SystemUtils.IS_OS_MAC_OSX_MOJAVE |

7
java/ql/test/library-tests/os/unix-test.expected
View File

@@ -1,4 +1,5 @@
| ../../stubs/apache-commons-lang3-3.7/org/apache/commons/lang3/SystemUtils.java:1439:5:1439:81 | IS_OS_UNIX |
| Test.java:62:13:62:95 | contains(...) |
| Test.java:66:13:66:84 | contains(...) |
| Test.java:70:13:70:34 | SystemUtils.IS_OS_UNIX |
| Test.java:66:13:66:95 | contains(...) |
| Test.java:70:13:70:84 | contains(...) |
| Test.java:74:13:74:34 | SystemUtils.IS_OS_UNIX |
| Test.java:97:13:97:60 | equals(...) |

1
java/ql/test/library-tests/os/windows-test.expected
View File

@@ -3,3 +3,4 @@
| Test.java:24:13:24:75 | contains(...) |
| Test.java:28:13:28:75 | contains(...) |
| Test.java:32:13:32:37 | SystemUtils.IS_OS_WINDOWS |
| Test.java:60:13:60:61 | equals(...) |