Merge pull request #591 from java-sec/feat-jar-embedded-version

feat: 运维流程完善，Version.java修改为编译期自动注入

Author: CC11001100

dongtai-agent/src/main/java/io/dongtai/iast/agent/IastProperties.java

@@ -2,14 +2,16 @@
 
 import io.dongtai.iast.agent.util.FileUtils;
 import io.dongtai.iast.agent.util.GsonUtils;
-import io.dongtai.iast.common.constants.AgentConstant;
 import io.dongtai.iast.common.constants.PropertyConstant;
+import io.dongtai.iast.common.constants.Version;
 import io.dongtai.log.DongTaiLog;
 import io.dongtai.log.ErrorCode;
 
 import java.io.File;
 import java.io.InputStream;
-import java.util.*;
+import java.util.HashMap;
+import java.util.Map;
+import java.util.Properties;
 
 /**
  * @author [email protected]
@@ -103,7 +105,7 @@ public static String initTmpDir() {
         }
         dir.append(sysTmpDir).append(File.separator)
                 .append("dongtai-").append(System.getProperty("user.name")).append(File.separator)
-                .append(AgentConstant.VERSION_VALUE).append(File.separator);
+                .append(Version.VERSION).append(File.separator);
 
         TMP_DIR = dir.toString();
         System.setProperty("java.io.tmpdir.dongtai", TMP_DIR);

dongtai-agent/src/main/java/io/dongtai/iast/agent/report/AgentRegisterReport.java

@@ -10,11 +10,11 @@
 import io.dongtai.iast.agent.util.HttpClientUtils;
 import io.dongtai.iast.common.constants.AgentConstant;
 import io.dongtai.iast.common.constants.ApiPath;
+import io.dongtai.iast.common.constants.Version;
 import io.dongtai.iast.common.utils.base64.Base64Encoder;
 import io.dongtai.log.DongTaiLog;
 import io.dongtai.log.ErrorCode;
 
-
 import java.io.*;
 import java.net.*;
 import java.nio.charset.StandardCharsets;
@@ -49,7 +49,7 @@ private String generateAgentRegisterMsg() {
             object.put("uuid", uuid);
         }
         object.put("name", AgentRegisterReport.getAgentToken());
-        object.put("version", AgentConstant.VERSION_VALUE);
+        object.put("version", Version.VERSION);
         object.put("projectName", getProjectName());
         object.put("clusterName", getClusterName());
         object.put("clusterVersion", getClusterVersion());
@@ -81,7 +81,7 @@ public static String getAgentToken() {
             String osName = System.getProperty("os.name");
             String hostname = getInternalHostName();
             AGENT_NAME =
-                    osName + "-" + hostname + "-" + AgentConstant.VERSION_VALUE + "-" + IastProperties.getInstance()
+                    osName + "-" + hostname + "-" + Version.VERSION + "-" + IastProperties.getInstance()
                             .getEngineName();
         }
         return AGENT_NAME;

dongtai-common/pom.xml

@@ -13,6 +13,7 @@
 
     <properties>
         <apache-httpclient.version>4.5.13</apache-httpclient.version>
+        <templating-maven-plugin.version>1.0.0</templating-maven-plugin.version>
     </properties>
 
     <dependencies>
@@ -41,6 +42,23 @@
 
     <build>
         <plugins>
+            <plugin>
+                <groupId>org.codehaus.mojo</groupId>
+                <artifactId>templating-maven-plugin</artifactId>
+                <version>${templating-maven-plugin.version}</version>
+                <executions>
+                    <execution>
+                        <id>filtering-java-templates</id>
+                        <goals>
+                            <goal>filter-sources</goal>
+                        </goals>
+                        <configuration>
+                            <!-- 此处配置的是模板文件的位置 -->
+                            <!--                            <sourceDirectory>src/main/java-templates</sourceDirectory>-->
+                        </configuration>
+                    </execution>
+                </executions>
+            </plugin>
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-shade-plugin</artifactId>

dongtai-common/src/main/java-templates/io/dongtai/iast/common/constants/Version.java

@@ -0,0 +1,14 @@
+package io.dongtai.iast.common.constants;
+
+/**
+ * @author CC11001100
+ */
+public class Version {
+
+    // templating-maven-plugin 插件的 filter-sources goal 会把这个字段注入进来
+    public static final String VERSION = "${project.version}";
+
+    private Version() {
+    }
+
+}

dongtai-common/src/main/java/io/dongtai/iast/common/constants/AgentConstant.java

@@ -1,7 +1,10 @@
 package io.dongtai.iast.common.constants;
 
 public class AgentConstant {
-    public static final String VERSION_VALUE = "v1.14.0";
+
+    // 2023-9-19 15:35:27 修改为使用插件在编译器自动注入而不是手动修改
+//    public static final String VERSION_VALUE = "v1.14.0";
+
     public static final String LANGUAGE = "JAVA";
     public static final String THREAD_NAME_PREFIX = "DongTai-IAST-";
     public static final String THREAD_NAME_PREFIX_CORE = "DongTai-IAST-Core-";

dongtai-core/src/main/java/io/dongtai/iast/core/AgentEngine.java

@@ -1,6 +1,7 @@
 package io.dongtai.iast.core;
 
 import io.dongtai.iast.common.constants.AgentConstant;
+import io.dongtai.iast.common.constants.Version;
 import io.dongtai.iast.common.state.AgentState;
 import io.dongtai.iast.common.state.State;
 import io.dongtai.iast.core.handler.hookpoint.models.policy.PolicyManager;
@@ -71,7 +72,7 @@ public static void install(String mode, String propertiesFilePath, Integer agent
             StartUpTimeReport.sendReport(EngineManager.getAgentId(), (int) stopWatch.getTime());
             DongTaiLog.info("DongTai Engine is successfully installed to the JVM, and it takes {} s",
                     stopWatch.getTime() / 1000);
-            DongTaiLog.info("DongTai Agent Version: {}, DongTai Server: {}", AgentConstant.VERSION_VALUE, cfg.getBaseUrl());
+            DongTaiLog.info("DongTai Agent Version: {}, DongTai Server: {}", Version.VERSION, cfg.getBaseUrl());
             inject(inst);
             new ServiceDirReport().send();
         } catch (Throwable e) {

dongtai-core/src/main/java/io/dongtai/iast/core/handler/hookpoint/controller/impl/HttpImpl.java

@@ -1,12 +1,16 @@
 package io.dongtai.iast.core.handler.hookpoint.controller.impl;
 
-import io.dongtai.iast.common.config.*;
-import io.dongtai.iast.common.constants.AgentConstant;
+import io.dongtai.iast.common.config.ConfigBuilder;
+import io.dongtai.iast.common.config.ConfigKey;
+import io.dongtai.iast.common.config.RequestDenyList;
+import io.dongtai.iast.common.constants.Version;
 import io.dongtai.iast.common.string.StringUtils;
 import io.dongtai.iast.core.EngineManager;
 import io.dongtai.iast.core.handler.bypass.BlackUrlBypass;
 import io.dongtai.iast.core.handler.hookpoint.IastClassLoader;
-import io.dongtai.iast.core.utils.*;
+import io.dongtai.iast.core.utils.HttpClientUtils;
+import io.dongtai.iast.core.utils.PropertyUtils;
+import io.dongtai.iast.core.utils.ReflectUtils;
 import io.dongtai.iast.core.utils.matcher.ConfigMatcher;
 import io.dongtai.log.DongTaiLog;
 
@@ -87,7 +91,7 @@ public static void solveHttpRequest(Object obj, Object req, Object resp, Map<Str
                 if (setHeaderMethod != null) {
                     if (enableVersionHeader) {
                         String versionHeaderKey = ConfigBuilder.getInstance().get(ConfigKey.VERSION_HEADER_KEY);
-                        setHeaderMethod.invoke(resp, versionHeaderKey, AgentConstant.VERSION_VALUE);
+                        setHeaderMethod.invoke(resp, versionHeaderKey, Version.VERSION);
                     }
                     if (dastMarkHeader != null) {
                         String reqId = EngineManager.getAgentId() + "."