securecodebox/hook-persistence-elastic 镜像文档

镜像概述和主要用途

OWASP secureCodeBox 是一个自动化、可扩展的开源解决方案，旨在通过简单轻量的界面集成各类安全漏洞扫描器。其核心使命是支持 DevSecOps 团队在不同场景下轻松实现安全漏洞测试的自动化，帮助团队在开发流程早期发现低风险问题，释放渗透测试人员资源以专注于重大安全问题。

本镜像 securecodebox/hook-persistence-elastic（以下简称"Elasticsearch 持久化钩子"）是 secureCodeBox 生态的一部分，作为钩子（Hook）组件与解析器（Parser）镜像配合使用，负责将扫描结果（findings）和报告持久化存储到 Elasticsearch 或 OpenSearch 索引中，支持后续的搜索、分析与可视化。

核心功能和特性

• 结果持久化：将 secureCodeBox 扫描产生的 findings 和报告保存至 Elasticsearch 或 OpenSearch 索引，实现数据长期存储。
• 多引擎支持：兼容 Elasticsearch 和 OpenSearch，配置方式一致。
• 轻量集成：作为 ReadOnly Hook 部署于 Kubernetes 命名空间，与 secureCodeBox 其他组件（如扫描器、解析器）无缝协作。
• 可扩展性：支持自定义索引配置，适应不同规模的扫描数据管理需求。
• 可视化支持：存储的数据可通过 Kibana 等工具进行可视化分析，辅助安全态势感知。

使用场景和适用范围

适用场景

• DevSecOps 流程集成：在持续集成/持续部署（CI/CD） pipeline 中，自动将安全扫描结果持久化，支持后续审计与追溯。
• 安全漏洞管理：集中存储多轮扫描结果，便于跟踪漏洞修复进度和趋势分析。
• 团队协作：为安全团队、开发团队提供统一的漏洞数据访问入口，支持基于数据的决策。

适用范围

• 已部署 secureCodeBox 核心组件的 Kubernetes 环境。
• 需要对安全扫描结果进行长期存储和可视化分析的组织或团队。
• 使用 Elasticsearch 或 OpenSearch 作为数据存储和检索平台的场景。

详细的使用方法和配置说明

前提条件

• 已安装 Docker 或 Kubernetes 环境。
• 已部署 Elasticsearch 或 OpenSearch 服务，并确保网络可访问。
• 已部署 secureCodeBox 核心组件（如 operator、解析器等）。

镜像拉取

docker pull securecodebox/hook-persistence-elastic

Docker 部署示例

基础运行命令

docker run --rm \
  -e ELASTICSEARCH_HOST=elasticsearch.example.com \
  -e ELASTICSEARCH_PORT=9200 \
  -e ELASTICSEARCH_INDEX=securecodebox-findings \
  securecodebox/hook-persistence-elastic

环境变量配置说明

Kubernetes 集成（通过 Helm）

作为 secureCodeBox 的一部分，推荐通过 Helm Chart 部署：

helm install persistence-elastic securecodebox/hook-persistence-elastic \
  --set elasticsearch.host=elasticsearch.example.com \
  --set elasticsearch.port=9200 \
  --set elasticsearch.index=securecodebox-findings

使用说明

该钩子需与 secureCodeBox 解析器镜像配合工作：解析器处理原始扫描结果生成结构化 findings，钩子将 findings 写入 Elasticsearch。部署后，钩子会自动监听扫描任务完成事件，无需手动触发。

支持的标签

• latest：最新稳定版本
• 版本化标签：如 3.0.0、2.9.0、2.8.0 等，对应具体发布版本

社区与支持

社区资源

• GitHub 仓库：secureCodeBox/secureCodeBox
• 官方文档：securecodebox.io/docs
• OWASP 项目页面：OWASP secureCodeBox
• Slack 频道：OWASP Slack #project-securecodebox
• ****：@

许可证信息

本镜像基于 Apache-2.0 许可证 开源，详情参见 LICENSE。

请注意：本镜像可能包含基础镜像及依赖软件的其他许可证（如 Bash 等系统工具），用户需自行确保使用符合相关许可证要求。

![License]([***]