legitartifactsuser/legit

Legit Security CLI 镜像文档

镜像概述

Legit Security CLI 镜像为 Legit Security 官方提供的容器化命令行工具，用于在容器环境中执行安全扫描、合规检查及安全策略管理等操作。该镜像封装了 Legit Security CLI 的完整运行环境，支持跨平台一致执行，简化了安全工具的部署与使用流程。

核心功能与特性

• 漏洞扫描：支持对应用代码、依赖项（如npm、Maven、PyPI等）进行自动化漏洞检测，识别已知安全漏洞。
• 合规性检查：内置行业标准合规规则（如OWASP Top 10、CIS Benchmarks等），可生成合规性报告。
• 安全策略执行：支持自定义安全策略，强制执行团队或企业级安全规范，如禁止使用高危依赖、强制代码安全审查等。
• 多格式报告：扫描结果支持JSON、HTML、XML等多种输出格式，便于集成至安全管理平台或导出存档。
• 轻量级设计：基于 Alpine Linux 构建，镜像体积小，启动速度快，适合CI/CD流水线等资源敏感场景。

使用场景与适用范围

• CI/CD流水线集成：在代码提交、构建阶段自动触发安全扫描，提前发现并阻断安全风险。
• 本地开发环境：开发人员在本地执行扫描，实时了解代码安全状态，减少线上漏洞引入。
• 服务器安全审计：对服务器环境中的应用依赖或配置进行定期扫描，生成安全审计报告。
• 批量安全评估：对多个项目或服务进行批量扫描，统一管理安全状态与修复进度。

使用方法与配置说明

1. 镜像拉取

bash
docker pull legitsecurity/cli:latest

2. 基本使用示例

2.1 执行基础漏洞扫描

bash
docker run --rm -v $(pwd):/app legitsecurity/cli:latest scan /app

• 说明：挂载当前目录（/app）至容器，对目录内代码及依赖项执行漏洞扫描，结果默认输出至控制台。

2.2 指定输出格式与路径

bash
docker run --rm -v $(pwd):/app -v $(pwd)/reports:/reports \
  legitsecurity/cli:latest scan /app --output json --report-path /reports/scan-result.json

• 说明：将扫描结果以JSON格式保存至宿主机的./reports/scan-result.json文件。

2.3 集成API密钥（如需认证）

bash
docker run --rm -e LEGIT_API_KEY="your-api-key" \
  legitsecurity/cli:latest scan /app --sync-to-dashboard

• 说明：通过环境变量LEGIT_API_KEY传入API密钥，扫描结果同步至Legit Security云端控制台。

3. 常用命令参数

4. 环境变量配置

5. 持久化数据与配置

如需持久化配置文件或扫描报告，可通过挂载目录实现：

bash
# 挂载配置文件目录
docker run --rm -v $(pwd)/config:/etc/legit \
  legitsecurity/cli:latest scan /app --config /etc/legit/custom-config.yaml

# 挂载报告目录
docker run --rm -v $(pwd)/reports:/var/legit/reports \
  legitsecurity/cli:latest scan /app --report-path /var/legit/reports/result.html

注意事项

• 执行扫描时需确保容器对目标目录有读取权限，建议通过-v参数挂载宿主机目录。
• 部分高级功能（如云端同步）需提前在Legit Security平台注册并获取API密钥。
• 如需集成至CI/CD流水线，建议结合镜像标签（如1.2.0）而非latest，确保版本稳定性。