veracode/vrm-runtime-agent

Veracode Risk Manager Runtime Agent 镜像文档

概述

Veracode Risk Manager Runtime Agent是一款轻量级代理组件，专为监控应用程序运行时安全风险而设计。该镜像可部署在应用服务器或容器环境中，通过实时采集应用运行时数据，检测潜在安全漏洞、评估风险等级并与Veracode Risk Manager平台集成，帮助用户持续掌握应用安全状态并及时响应安全威胁。

核心功能和特性

实时风险监控

• 持续监控应用程序运行时行为，实时捕捉异常操作、未授权访问尝试等安全事件
• 支持对应用依赖组件、配置参数、网络交互等多维度安全状态监控

漏洞检测与风险评估

• 基于Veracode安全知识库自动识别运行时已知漏洞（如OWASP Top 10风险）
• 结合漏洞严重程度、利用难度、影响范围生成风险评分，辅助优先级决策

平台集成能力

• 无缝对接Veracode Risk Manager平台，支持风险数据实时同步与集中管理
• 可在平台端查看详细风险报告、趋势分析及修复建议

轻量级部署

• 镜像体积小巧，资源占用低，对应用性能影响极小
• 支持无侵入式部署，无需修改应用源代码即可集成

安全数据传输

• 采用TLS加密协议传输风险数据，确保数据在传输过程中的安全性
• 本地缓存机制优化网络不稳定情况下的数据完整性

使用场景和适用范围

企业级应用环境

适用于企业内部部署的各类应用系统（Web应用、微服务、API服务等）的持续安全监控

生产环境安全管控

部署于生产环境，实时监控应用运行时安全状态，及时发现并预警潜在安全威胁

CI/CD流程集成

可集成至CI/CD流水线末端，在应用部署前或部署后自动启动监控，确保上线应用符合安全要求

多环境一致性监控

支持开发、测试、预生产、生产等多环境部署，确保各环境安全监控策略一致

使用方法和配置说明

前提条件

• 已注册Veracode账户并拥有Veracode Risk Manager平台访问权限
• 获取有效的API密钥（API Key）和API密钥密钥（API Secret）
• 目标环境已安装Docker引擎（版本20.10及以上）

快速启动（docker run）

bash
docker run -d \
  --name veracode-runtime-agent \
  -e VERACODE_API_KEY="your-api-key" \
  -e VERACODE_API_SECRET="your-api-secret" \
  -e AGENT_NAME="my-app-agent" \
  -e PLATFORM_URL="https://riskmanager.veracode.com" \
  -e MONITOR_TARGET="http://my-app:8080" \
  -v /var/run/docker.sock:/var/run/docker.sock \
  veracode/risk-manager-runtime-agent:latest

环境变量配置

Docker Compose配置示例

yaml
version: '3.8'
services:
  app:
    image: my-app:latest
    ports:
      - "8080:8080"

  veracode-agent:
    image: veracode/risk-manager-runtime-agent:latest
    depends_on:
      - app
    environment:
      - VERACODE_API_KEY="your-api-key"
      - VERACODE_API_SECRET="your-api-secret"
      - AGENT_NAME="my-app-agent"
      - PLATFORM_URL="https://riskmanager.veracode.com"
      - MONITOR_TARGET="http://app:8080"
      - SCAN_INTERVAL=60
      - LOG_LEVEL=INFO
    volumes:
      - /var/run/docker.sock:/var/run/docker.sock

配置参数说明

高级配置可通过挂载配置文件实现，默认配置文件路径：/etc/veracode/agent/config.yaml

yaml
agent:
  name: "my-app-agent"
  log_level: "INFO"
  scan_interval: 300
  max_retries: 3
platform:
  url: "https://riskmanager.veracode.com"
  timeout: 30
  tls_verify: true
monitor:
  target: "http://my-app:8080"
  include_paths: ["/api/*", "/admin/*"]
  exclude_paths: ["/health", "/metrics"]

部署验证

1. 查看容器日志确认连接状态：

   bash
   docker logs veracode-runtime-agent
   

   出现"Successfully connected to Veracode Risk Manager platform"表示连接成功

2. 在Veracode Risk Manager平台验证：登录后导航至"Agent Management"页面，确认Agent状态为"Active"

常见问题

• 连接平台失败：检查API密钥/密钥正确性、网络连通性及代理配置
• 监控目标无数据：确认MONITOR_TARGET配置正确，目标应用运行正常且Agent有权限访问
• 资源占用过高：调整SCAN_INTERVAL增大扫描间隔，或通过--memory和--cpus限制容器资源