dxa4481/trufflehog

truffleHog镜像说明

镜像概述

truffleHog是一款Git仓库敏感信息扫描工具，可深入分析提交历史与分支，检测意外提交的密钥、凭证等秘密。支持正则规则检查、熵检测及路径过滤，适用于DevOps流水线、代码审计等场景。

核心功能

• 多方式检测：结合正则规则（高信号）和熵检测（识别高熵字符串）；
• 路径过滤：通过--include_paths/--exclude_paths指定扫描/排除的文件路径；
• 自定义规则：使用--rules导入自定义正则规则文件；
• 允许列表：通过--allow设置可忽略的合法敏感信息；
• 灵活参数：支持指定提交起始点、分支、扫描深度等。

使用场景

• DevOps流水线：集成到CI/CD中，防止敏感信息泄露；
• 代码审计：对仓库历史提交进行全面安全检查；
• 仓库迁移前：扫描旧仓库中的潜在敏感数据。

配置说明

关键参数

• --regex：启用正则规则检查；
• --entropy False：关闭熵检测；
• --include_paths <文件>：指定需扫描的路径正则列表；
• --exclude_paths <文件>：指定需排除的路径正则列表；
• --rules <文件>：导入自定义规则JSON文件；
• --allow <文件>：导入允许忽略的敏感信息JSON文件。

Docker部署示例

1. 进入Git仓库目录：

bash
cd /path/to/your/git/repo

2. 运行镜像扫描：

bash
docker run --rm -v "$(pwd):/proj" dxa4481/trufflehog file:///proj

（-v将本地仓库目录挂载到容器内/proj，file:///proj指定扫描该目录）