3 个版本 (稳定)
1.1.0 | 2022 年 8 月 9 日 |
---|---|
1.0.0 | 2022 年 8 月 1 日 |
0.1.0 | 2022 年 8 月 1 日 |
#1964 在 命令行实用工具
每月 22 次下载
13KB
202 行
剑客
剑客是一个迷你 CLI 工具,可以用于扫描项目源代码文件中硬编码的各种秘密/凭据
特性
-
识别注入到源代码中的秘密,并输出秘密类型(例如:AWS 凭据、GitHub 个人访问令牌)
-
排除项目中的子目录,这些子目录没有 UTF 8 编码的文件,如 build/、target/
安装
使用 Cargo 安装
如果您已安装 Cargo,官方的 Rust 包管理器,请运行以下命令
cargo install fencer
https://crates.io/crates/fencer
直接安装可执行文件
如果您的机器上未安装 rust/cargo,您可以直接从仓库的发布页面安装可执行文件
本地构建 Docker
此仓库包含一个 Dockerfile,可以在本地构建和运行
docker build -t fencer:local .
使用示例
本地执行
❯ fencer --help
Fencer 1.0.0
Naresh, [email protected]
A mini CLI tool to scan creds and secrets in source code
USAGE:
fencer [OPTIONS] --project_dir <project_dir>
OPTIONS:
-e, --exclude_paths <exclude_paths>
The directories to exclude for the scan [default: target build .git]
-h, --help
Print help information
-p, --project_dir <project_dir>
Input the relative path to the project dirs
-V, --version
Print version information
Docker 执行
使用 docker run 命令挂载项目目录将使工具可以通过 Docker 运行
docker run -v "$(pwd)"/<project_dir_path>:/app -it nareshbalajia/fencer:latest --project_dir /app
支持的秘密
秘密类型 | 匹配模式 |
---|---|
aws | REGEX |
amazon_mws_auth_token | REGEX |
authorization_basic | REGEX |
authorization_bearer | REGEX |
authorization_api | REGEX |
google_api | REGEX |
google_oauth | REGEX |
heroku_api | REGEX |
firebase | REGEX |
facebook_access_token | REGEX |
github_access_token | REGEX |
ssh_rsa | 字符串匹配 |
ssh_ec | 字符串匹配 |
passwords | REGEX/字符串匹配 |
依赖项
~6–15MB
~174K SLoC