README_CN.md

DongTai-agent-java

---

English version

项目介绍

DongTai-agent-java 是洞态IAST 针对 Java 应用开发的数据采集端。在添加 dongtai-agent 代理的 Java 应用中，通过改写类字节码的方式采集所需数据，然后将数据发送至 DongTai-openapi 服务，再由云端引擎处理数据判断是否存在安全漏洞。

DongTai-agent-java 由agent.jar、dongtai-core.jar 、dongtai-inject.jar、dongtai-servlet.jar四部分构成，其中：

• agent.jar用来管理 agent 的生命周期和配置。agent 的生命周期包括下载、安装、启动、停止、重启、卸载。agent 的配置包括配置应用启动模式、漏洞检验模式、是否开启代理等。
• dongtai-core.jar是核心 jar 包，其主要功能是：字节码插桩、数据采集、数据预处理、数据上报、第三方组件管理等。
• dongtai-inject.jar是间谍 jar 包，用于注入至BootStrap ClassLoader，后续在目标应用中调用dongtai-core.jar中的数据采集方法。
• dongtai-servlet.jar用于获取应用发送的请求以及收到的响应，用于数据展示以及请求重放功能。

应用场景

• DevOps流程
• 上线前安全测试
• 第三方组件管理
• 代码审计
• 0 Day挖掘

快速上手

快速使用

请参考：快速开始

快速开发

1. Fork DongTai-agent-java 项目到自己的github仓库并 clone 项目：

   git clone https://github.com/<your-username>/DongTai-agent-java

2. 根据需求编写代码

3. 使用 Maven 编译 DongTai-agent-java ：

   mvn clean package -Dmaven.test.skip=true

   • jdk版本为1.8

4. 编译结束后会在项目根目录生成文件夹./release：

   release
   ├── dongtai-agent.jar
   └── lib
       ├── dongtai-servlet.jar
       ├── dongtai-core.jar
       └── dongtai-inject.jar
   

5. 拷贝dongtai-core.jar、dongtai-inject.jar、dongtai-servlet.jar到系统临时目录。获取系统临时目录可运行以下 Java 代码：

   System.getProperty("java.io.tmpdir.dongtai");

6. 运行应用，测试代码（以SpringBoot应用为例）：java -javaagent:/path/to/dongtai-agent.jar -Ddongtai.debug=true -jar app.jar

7. 贡献代码。如果您想要向洞态 IAST 团队贡献代码，请阅读完整的贡献指南

支持的Java版本及中间件

• Java 1.8+
• Tomcat、Jetty、WebLogic、WebSphere、SpringBoot等主流软件和中间件

notice: jdk 1.6开发的Agent需要使用Maven 3.2.5进行构建