From eba7619786bda53b1c23ba08da2d300b326ddfcd Mon Sep 17 00:00:00 2001
From: wuhaoyang <2507865306@qq.com>
Date: Thu, 11 Jan 2024 11:03:06 +0800
Subject: [PATCH] =?UTF-8?q?=E6=96=B0=E5=A2=9E=E5=87=86=E5=88=99=EF=BC=9A?=
 =?UTF-8?q?=E5=9C=A8=E6=9E=84=E5=BB=BA=E5=91=BD=E4=BB=A4=E5=89=8D=E5=AF=B9?=
 =?UTF-8?q?=E8=BE=93=E5=85=A5=E6=95=B0=E6=8D=AE=E8=BF=9B=E8=A1=8C=E9=AA=8C?=
 =?UTF-8?q?=E8=AF=81=EF=BC=8C=E7=A1=AE=E4=BF=9D=E8=BE=93=E5=85=A5=E6=95=B0?=
 =?UTF-8?q?=E6=8D=AE=E4=BB=85=E8=83=BD=E7=94=A8=E4=BA=8E=E6=9E=84=E6=88=90?=
 =?UTF-8?q?=E5=85=81=E8=AE=B8=E7=9A=84=E5=91=BD=E4=BB=A4=E8=A1=8C=E6=88=96?=
 =?UTF-8?q?=E5=B9=B2=E9=A2=84=E5=91=BD=E4=BB=A4?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 .../keyware/sonar/java/rules/RulesList.java   |  8 +-
 .../rules/checkers/SystemFunctionChecker.java | 93 +++++++++++++++++++
 .../rules/java/SystemFunctionChecker.html     |  9 ++
 .../rules/java/SystemFunctionChecker.json     | 13 +++
 .../src/test/files/SystemFunctionChecker.java | 13 +++
 .../checkers/SystemFunctionCheckerTest.java   | 24 +++++
 6 files changed, 155 insertions(+), 5 deletions(-)
 create mode 100644 sonar-keyware-plugins-java/src/main/java/com/keyware/sonar/java/rules/checkers/SystemFunctionChecker.java
 create mode 100644 sonar-keyware-plugins-java/src/main/resources/org/sonar/l10n/java/rules/java/SystemFunctionChecker.html
 create mode 100644 sonar-keyware-plugins-java/src/main/resources/org/sonar/l10n/java/rules/java/SystemFunctionChecker.json
 create mode 100644 sonar-keyware-plugins-java/src/test/files/SystemFunctionChecker.java
 create mode 100644 sonar-keyware-plugins-java/src/test/java/com/keyware/sonar/java/rules/checkers/SystemFunctionCheckerTest.java

diff --git a/sonar-keyware-plugins-java/src/main/java/com/keyware/sonar/java/rules/RulesList.java b/sonar-keyware-plugins-java/src/main/java/com/keyware/sonar/java/rules/RulesList.java
index c642a0e..ea2e248 100644
--- a/sonar-keyware-plugins-java/src/main/java/com/keyware/sonar/java/rules/RulesList.java
+++ b/sonar-keyware-plugins-java/src/main/java/com/keyware/sonar/java/rules/RulesList.java
@@ -6,10 +6,7 @@
  */
 package com.keyware.sonar.java.rules;
 
-import com.keyware.sonar.java.rules.checkers.ABCVarNameChecker;
-import com.keyware.sonar.java.rules.checkers.AbsolutePathDetectorChecker;
-import com.keyware.sonar.java.rules.checkers.DynamicCodeChecker;
-import com.keyware.sonar.java.rules.checkers.PathAndKeywordCheck;
+import com.keyware.sonar.java.rules.checkers.*;
 import org.sonar.plugins.java.api.JavaCheck;
 
 import java.util.ArrayList;
@@ -37,7 +34,8 @@ public final class RulesList {
                 ABCVarNameChecker.class,
                 AbsolutePathDetectorChecker.class,
                 PathAndKeywordCheck.class,
-                DynamicCodeChecker.class
+                DynamicCodeChecker.class,
+                SystemFunctionChecker.class
                 /*SpringControllerRequestMappingEntityRule.class,
                 AvoidAnnotationRule.class,
                 AvoidBrandInMethodNamesRule.class,
diff --git a/sonar-keyware-plugins-java/src/main/java/com/keyware/sonar/java/rules/checkers/SystemFunctionChecker.java b/sonar-keyware-plugins-java/src/main/java/com/keyware/sonar/java/rules/checkers/SystemFunctionChecker.java
new file mode 100644
index 0000000..dd9445e
--- /dev/null
+++ b/sonar-keyware-plugins-java/src/main/java/com/keyware/sonar/java/rules/checkers/SystemFunctionChecker.java
@@ -0,0 +1,93 @@
+package com.keyware.sonar.java.rules.checkers;/*
+ *@title SystemFunctionChecker
+ *@description
+ *@author Admin
+ *@version 1.0
+ *@create 2024/1/11 9:29
+ */
+
+import org.sonar.check.Rule;
+import org.sonar.java.checks.helpers.ExpressionsHelper;
+import org.sonar.plugins.java.api.IssuableSubscriptionVisitor;
+import org.sonar.plugins.java.api.semantic.Symbol;
+import org.sonar.plugins.java.api.tree.*;
+
+import java.util.*;
+
+/**
+ * 在构建命令前对输入数据进行“白名单”机制验证
+ *
+ * @author WuHaoYang
+ * @date 2024/1/10
+ */
+@Rule(key = "SystemFunctionChecker")
+public class SystemFunctionChecker extends IssuableSubscriptionVisitor {
+
+    private static final Set<String> SYSTEM_FUNCTION_NAMES = new HashSet<>(Arrays.asList(
+            "exec",
+            "getRuntime().exec",
+            "ProcessBuilder.command"
+    ));
+
+    @Override
+    public List<Tree.Kind> nodesToVisit() {
+        return Arrays.asList(Tree.Kind.METHOD_INVOCATION, Tree.Kind.NEW_CLASS);
+    }
+
+    @Override
+    public void visitNode(Tree tree) {
+        if (tree.is(Tree.Kind.METHOD_INVOCATION)) {
+            MethodInvocationTree methodInvocationTree = (MethodInvocationTree) tree;
+
+            ExpressionTree methodSelect = methodInvocationTree.methodSelect();
+            if (methodSelect.is(Tree.Kind.MEMBER_SELECT)) {
+                MemberSelectExpressionTree memberSelect = (MemberSelectExpressionTree) methodSelect;
+                String methodName = memberSelect.identifier().name();
+
+                if (SYSTEM_FUNCTION_NAMES.contains(methodName)) {
+                    checkSystemCommand(methodInvocationTree.arguments(), methodInvocationTree);
+                }
+            }
+        } else if (tree.is(Tree.Kind.NEW_CLASS)) {
+            NewClassTree newClassTree = (NewClassTree) tree;
+            String className = newClassTree.symbolType().name();
+
+            if (className.equals("ProcessBuilder")) {//判断是否为ProcessBuilder
+                checkSystemCommand(newClassTree.arguments(), newClassTree);
+            }
+        }
+    }
+
+    private void checkSystemCommand(List<ExpressionTree> arguments, Tree tree) {
+        for (int i = 0; i < arguments.size(); i++) {
+            ExpressionTree argument = arguments.get(i);
+
+            // 获取方法的参数
+            Tree parentMethod = findEnclosingMethod(tree);
+            if (parentMethod != null && parentMethod.is(Tree.Kind.METHOD)) {
+                MethodTree methodTree = (MethodTree) parentMethod;
+                List<VariableTree> parameters = methodTree.parameters();
+
+                // 检查执行系统命令对象的参数是否与方法的入参相等
+                if (i < parameters.size()) {
+                    String parameterName = parameters.get(i).simpleName().name();
+                    if (argument.is(Tree.Kind.IDENTIFIER) && ((IdentifierTree) argument).name().equals(parameterName)) {
+                        System.out.println("参数"+parameterName);
+                        reportIssue(tree, "在构建命令前对输入数据进行验证");
+                    }
+                }
+            }
+        }
+    }
+
+    public void reportIssue(Tree tree, String message) {
+        context.reportIssue(this, tree, message);
+    }
+
+    private Tree findEnclosingMethod(Tree tree) {
+        while (tree != null && !tree.is(Tree.Kind.METHOD)) {
+            tree = tree.parent();
+        }
+        return tree;
+    }
+}
diff --git a/sonar-keyware-plugins-java/src/main/resources/org/sonar/l10n/java/rules/java/SystemFunctionChecker.html b/sonar-keyware-plugins-java/src/main/resources/org/sonar/l10n/java/rules/java/SystemFunctionChecker.html
new file mode 100644
index 0000000..90a9af4
--- /dev/null
+++ b/sonar-keyware-plugins-java/src/main/resources/org/sonar/l10n/java/rules/java/SystemFunctionChecker.html
@@ -0,0 +1,9 @@
+<p>在构建命令前对输入数据进行验证</p>
+<h2>在构建命令前对输入数据进行验证</h2>
+<pre>
+
+</pre>
+<h2>合规解决方案</h2>
+<pre>
+
+</pre>
diff --git a/sonar-keyware-plugins-java/src/main/resources/org/sonar/l10n/java/rules/java/SystemFunctionChecker.json b/sonar-keyware-plugins-java/src/main/resources/org/sonar/l10n/java/rules/java/SystemFunctionChecker.json
new file mode 100644
index 0000000..45c653b
--- /dev/null
+++ b/sonar-keyware-plugins-java/src/main/resources/org/sonar/l10n/java/rules/java/SystemFunctionChecker.json
@@ -0,0 +1,13 @@
+{
+  "title": "在构建命令前对输入数据进行验证",
+  "type": "CODE_SMELL",
+  "status": "ready",
+  "remediation": {
+    "func": "Constant\/Issue",
+    "constantCost": "5min"
+  },
+  "tags": [
+    "28suo"
+  ],
+  "defaultSeverity": "Minor"
+}
\ No newline at end of file
diff --git a/sonar-keyware-plugins-java/src/test/files/SystemFunctionChecker.java b/sonar-keyware-plugins-java/src/test/files/SystemFunctionChecker.java
new file mode 100644
index 0000000..905f001
--- /dev/null
+++ b/sonar-keyware-plugins-java/src/test/files/SystemFunctionChecker.java
@@ -0,0 +1,13 @@
+
+
+class SystemFunctionChecker{
+    public void add(String command){
+        Process process = Runtime.getRuntime().exec(command); // Noncompliant {{在构建命令前对输入数据进行验证}}
+
+    }
+
+    public void det(String commands){
+
+        ProcessBuilder pb = new ProcessBuilder(commands);// Noncompliant {{在构建命令前对输入数据进行验证}}
+    }
+}
\ No newline at end of file
diff --git a/sonar-keyware-plugins-java/src/test/java/com/keyware/sonar/java/rules/checkers/SystemFunctionCheckerTest.java b/sonar-keyware-plugins-java/src/test/java/com/keyware/sonar/java/rules/checkers/SystemFunctionCheckerTest.java
new file mode 100644
index 0000000..8ab8dce
--- /dev/null
+++ b/sonar-keyware-plugins-java/src/test/java/com/keyware/sonar/java/rules/checkers/SystemFunctionCheckerTest.java
@@ -0,0 +1,24 @@
+package com.keyware.sonar.java.rules.checkers;/*
+ *@title SystemFunctionCheckerTest
+ *@description
+ *@author Admin
+ *@version 1.0
+ *@create 2024/1/11 9:35
+ */
+
+import com.keyware.sonar.java.utils.FilesUtils;
+import org.junit.jupiter.api.Test;
+import org.sonar.java.checks.verifier.CheckVerifier;
+
+public class SystemFunctionCheckerTest {
+
+
+    @Test
+    public void test(){
+        CheckVerifier.newVerifier()
+                .onFile("src/test/files/SystemFunctionChecker.java")
+                .withCheck(new SystemFunctionChecker())
+                .withClassPath(FilesUtils.getClassPath("target/test-jars"))
+                .verifyIssues();
+    }
+}