kubeshop/testkube-zap-executor

!https://raw.githubusercontent.com/kubeshop/testkube/main/assets/testkube-color-gray.png

TestKube ZAP执行器

概述

TestKube ZAP执行器是一款测试执行器，用于在TestKube中运行ZED***代理（ZAP）扫描，帮助用户在TestKube环境中便捷地进行Web应用安全测试。

核心功能和特性

• 支持多种ZAP扫描类型：zap/api（API扫描）、zap/baseline（基线扫描）、zap/full（全面扫描）
• 支持通过本地文件或Git仓库定义测试配置
• 可通过YAML配置文件自定义扫描参数（目标地址、格式、认证信息等）
• 与TestKube CLI无缝集成，支持测试的创建、运行和监控
• 支持配置文件挂载，实现扫描规则自定义

使用场景和适用范围

• Web应用安全基线检查
• API接口安全扫描（支持OpenAPI、SOAP、GraphQL格式）
• 全面渗透测试自动化
• 持续集成/持续部署（CI/CD）流程中的安全测试环节

使用方法和配置说明

安装部署

TestKube默认已集成ZAP执行器。如需手动构建和部署，执行以下命令：

bash
kubectl apply -f examples/zap-executor.yaml

创建和运行测试

通过本地文件创建测试

bash
# 创建API扫描测试
kubectl testkube create test --file contrib/executor/zap/examples/zap-tk-api.yaml --type "zap/api" --name api-test --copy-files contrib/executor/zap/examples/zap-tk-api.conf:zap-tk-api.conf
# 运行API扫描测试并监控
kubectl testkube run test --watch api-test

# 创建基线扫描测试
kubectl testkube create test --file contrib/executor/zap/examples/zap-tk-baseline.yaml --type "zap/baseline" --name baseline-test --copy-files contrib/executor/zap/examples/zap-tk-baseline.conf:zap-tk-baseline.conf
# 运行基线扫描测试并监控
kubectl testkube run test --watch baseline-test

# 创建全面扫描测试
kubectl testkube create test --file contrib/executor/zap/examples/zap-tk-full.yaml --type "zap/full" --name full-test --copy-files contrib/executor/zap/examples/zap-tk-full.conf:zap-tk-full.conf
# 运行全面扫描测试并监控
kubectl testkube run test --watch full-test

通过Git仓库创建测试

bash
# 从Git仓库创建API扫描测试
kubectl testkube create test --git-uri https://github.com/kubeshop/testkube.git --type "zap/api" --name git-api-test --executor-args "zap-api.yaml" --git-branch main --git-path contrib/executor/zap/examples
# 运行Git仓库API扫描测试并监控
kubectl testkube run test --watch git-api-test

# 从Git仓库创建基线扫描测试
kubectl testkube create test --git-uri https://github.com/kubeshop/testkube.git --type "zap/baseline" --name git-baseline-test --executor-args "zap-baseline.yaml" --git-branch main --git-path contrib/executor/zap/examples
# 运行Git仓库基线扫描测试并监控
kubectl testkube run test --watch git-baseline-test

# 从Git仓库创建全面扫描测试
kubectl testkube create test --git-uri https://github.com/kubeshop/testkube.git --type "zap/full" --name git-full-test --executor-args "zap-full.yaml" --git-branch main --git-path contrib/executor/zap/examples
# 运行Git仓库全面扫描测试并监控
kubectl testkube run test --watch full-test-git

配置文件说明

ZAP扫描参数通过YAML配置文件定义，示例如下：

yaml
api:
  # -t 目标API定义地址
  target: https://www.example.com/openapi.json
  # -f API格式，支持openapi、soap或graphql
  format: openapi
  # -O 覆盖远程OpenAPI规范中的主机名
  hostname: https://www.example.com
  # -S 安全模式，跳过主动扫描仅执行基线扫描
  safe: true
  # -c 配置文件路径
  config: examples/zap-api.conf
  # -d 显示调试信息
  debug: true
  # -s 简短输出模式
  short: false
  # -l 显示的最低级别：PASS、IGNORE、INFO、WARN或FAIL
  level: INFO
  # -c 上下文文件路径
  context: examples/context.config
  # 用于认证扫描的用户名
  user: anonymous
  # 被动扫描等待延迟（秒）
  delay: 5
  # ZAP启动和被动扫描的最大等待时间（分钟）
  time: 60
  # ZAP命令行选项
  zap_options: -config aaa=bbb
  # -I 是否在警告时使ZAP扫描失败
  fail_on_warn: false

问题与改进

请通过https://github.com/kubeshop/testkube/issues%E6%8A%A5%E5%91%8A%E6%89%80%E6%9C%89%E9%97%AE%E9%A2%98%E3%80%82