EarlyBird 敏感数据检测工具使用手册

EarlyBird 敏感数据检测工具使用手册

earlybird EarlyBird is a sensitive data detection tool capable of scanning source code repositories for clear text password violations, PII, outdated cryptography methods, key files and more. 项目地址: https://gitcode.com/gh_mirrors/ea/earlybird

EarlyBird 是一款由美国运通公司开发的开源工具，旨在扫描源代码仓库以识别明文密码违规、个人敏感信息（PII）、过时的加密方法、密钥文件等安全漏洞。

1. 目录结构及介绍

EarlyBird 的项目目录结构清晰地组织了其不同功能组件和资源：

americanexpress/earlybird
├── build.bat               # Windows 平台构建脚本
├── build.sh                # Linux 和 macOS 平台构建脚本
├── changelog.md            # 更新日志
├── CODEOFCONDUCT.md        # 代码行为准则
├── CODEOWNERS             # 指定代码审查者
├── config                  # 配置相关文件夹，可能存放扫描规则或默认设置
├── docs                    # 文档资料
├── ge_ignore               # 可能用于定义Git忽略的文件模式
├── gitignore               # Git忽略文件列表
├── go.mod                  # Go语言的依赖管理文件
├── go.sum                  # Go依赖的校验文件
├── install.bat             # Windows 安装脚本
├── install.sh              # Linux 和 macOS 安装脚本
├── pre-commit.sample       # 预提交钩子示例，用于在Git中集成 EarlyBird
├── pre-commit_windows.sample # Windows预提交钩子示例
├── README.md               # 主要的项目说明文档
├── releaserc.json          # 可能与版本发布流程相关
├── security.md             # 安全相关信息
└── ...

重要文件简介:

• build.bat 和 build.sh: 构建脚本，用于生成 EarlyBird 的可执行文件。
• install.bat 和 install.sh: 安装脚本，帮助将工具安装到系统路径中。
• README.md: 包含快速入门指南、安装步骤和基本用法。
• config 文件夹: 存放配置模板或默认配置文件，影响扫描规则和行为。
• go.*: Go语言特有的文件，用于包管理和依赖声明。

2. 启动文件介绍

EarlyBird的运行并不直接通过一个典型的"启动文件"进行，而是通过命令行调用来执行。核心的执行程序名为 go-earlybird 或在Windows环境下为 go-earlybird.exe。这些可通过构建过程得到，并且在正确安装后，可以通过命令行直接调用。

例如，基本的扫描命令格式如下：

go-earlybird --path=/指定路径

或者在Windows上：

go-earlybird.exe --path=C:\指定路径

如果要扫描远程仓库，则可以使用：

go-earlybird --git=https://github.com/americanexpress/earlybird

3. 配置文件介绍

EarlyBird的配置细节并未直接在提供的链接中列出具体的配置文件内容，但一般情况下，配置通过以下方式进行：

• 默认配置: 工具安装后，可能会有默认配置文件位于安装目录下的特定位置。
• 环境变量: 使用某些环境变量来调整工具的行为。
• 命令行参数: 如 --git, --path 等是直接的扫描控制参数，更多高级配置或特定规则可能需通过特定命令行选项指定或通过外部配置文件加载。

为了自定义扫描行为，用户可能需要修改或创建自己的配置文件，这通常涉及了解工具的文档以获取支持的配置项和格式。由于具体配置文件内容未直接展示，实际操作时应参考 README.md 中的相关章节或项目文档中的“Usage”、“Configuration”部分。

earlybird EarlyBird is a sensitive data detection tool capable of scanning source code repositories for clear text password violations, PII, outdated cryptography methods, key files and more. 项目地址: https://gitcode.com/gh_mirrors/ea/earlybird