跳到主要内容
版本:Next

Java Agent

配置安装参数

参数名说明类型可选参数预设值
dongtai.app.name设置项目名称String名称保证唯一Demo Project
dongtai.app.version设置项目版本String应用版本号V1.0
dongtai.app.create设置是否自动创建项目Booleantrue or falsefalse
dongtai.debug开启后加载本地系统临时目录中的检测引擎Booleantrue or falsefalse
iast.server.modelocal模式支持、POST请求包展示、污点位置及污点值展示等功能Stringlocal or remotelocal
iast.engine.delay.time延迟启动功能,单位:秒Integer任意整型数字0
iast.dump.class.enable是否 dump 修改后的字节码Booleantrue or falsefalse
iast.dump.class.pathdump 字节码的路径String任意有权限路径/tmp/iast-class-dump/
dongtai.server.urlDongtai OpenAPI URLStringURL 格式https://openapi.iast.io
dongtai.server.tokenDongtai OpenAPI TokenStringUser Token
dongtai.response.length向 Dongtai OpenAPI 发送的响应体长度Integer大于 0 的整形数字null
dongtai.log是否把日志输出到本地文件Booleantrue or falsetrue
dongtai.log.path指定日志文件所在目录String任意有读写权限的目录agent.jar 当前目录
dongtai.log.level指定日志等级Stringinfo, debuginfo
dongtai.server.package指定是否从洞态Server端下载agent依赖包booleantrue, falsetrue
dongtai.cluster.name集群名称StringURL 格式
dongtai.cluster.version集群版本String集群版本号

热部署安装参数

参数名说明类型可选参数预设值
app_name设置项目名称String名称保证唯一Demo Project
app_create设置是否自动创建项目Booleantrue or falsefalse
app_version设置项目版本String应用版本号V1.0
debug开启后加载本地系统临时目录中的检测引擎Booleantrue or falsefalse
dongtai_serverDongtai OpenAPI UrlStringURL 格式
dongtai_tokenDongtai OpenAPI TokenString
modeAgent 加载/卸载Stringinstall or uninstall
pid应用程序进程 IDString
cluster_name设置集群名称String名称保证唯一
cluster_version设置集群版本String集群版本号
server_package设置是否从云端下载引擎Stringtrue or false
log_level设置日志等级String
log_path设置日志存放路径设置是否从云端下载引擎String任意有读写权限的目录

用例

info

测试项目:SpringDemo

  • 当需要将应用绑定到云端项目 SpringDemo 时:

    java -javaagent:/path/to/agent.jar -Ddongtai.app.name=SpringDemo -jar SpringDemo.jar
  • 当需要排查 Agent 报错问题或者二次开发 Agent 时需要本地调试:

    java -javaagent:/path/to/agent.jar -Ddongtai.debug=true -jar SpringDemo.jar
  • 当启动 Agent 影响了应用的运行,需设置 Agent 延迟启动时间,以 15 秒 为例:

    java -javaagent:/path/to/agent.jar -Diast.engine.delay.time=15 -jar SpringDemo.jar
  • 当排查 agent 异常或者研究字节码转换原理时,在目录 /tmp/class 查看转换后的字节码文件:

    java -javaagent:/path/to/agent.jar -Diast.dump.class.enable=true -Diast.dump.class.path=/tmp/class -jar SpringDemo.jar
  • 当需要设置检测能力为 hunter/normal 时(hunter 模式的使用场景:代码审计,normal 模式使用场景:企业内部检测漏洞):

    java -javaagent:/path/to/agent.jar -Diast.mode=hunter/normal -jar SpringDemo.jar
  • 当热部署安装需集群配置时的参数参考:

    java -jar agent.jar -m install -p pid --app_name "app_name" --app_create "true" --app_version "v1.0" --dongtai_server "https://iast.io/openapi" --dongtai_token "a303ab4bedc93f96808335d023d7ac4d2ba00773" --cluster_name "cluster_name" --cluster_version "v1.0" --server_package "false" --log_level "info" --log_path "/tmp"