3 releases (stable)
1.1.0 | Aug 9, 2022 |
---|---|
1.0.0 | Aug 1, 2022 |
0.1.0 | Aug 1, 2022 |
#1964 in Command line utilities
22 downloads per month
13KB
202 lines
Fencer
Fencer is a mini-CLI tool that can used to scan various kind of secrets/credentials that are hardcoded into a project source code files
Features
-
Identiying the secrets injected into the source code and outputs it along with the kind of secret (Eg: AWS Creds, Github Personal Access Token)
-
Exluding sub-dirs within the project that does not have UTF 8 encoded files like build/, target/
Installation
Installation Using Cargo
If you installed Cargo, the official Rust Package manager, run the following command:
cargo install fencer
https://crates.io/crates/fencer
Installing the executable directly
If rust/cargo isn't installed on your machine, you can directly install the executable from the repo's release page
Building the docker locally
This repo comes in with a Dockerfile that can be built and run locally
docker build -t fencer:local .
Usage Examples
Local Execution
❯ fencer --help
Fencer 1.0.0
Naresh, nareshbalajia@mail.com
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 Execution
Mounting the project directory using the docker run command would enable the tool to be run via Docker
docker run -v "$(pwd)"/<project_dir_path>:/app -it nareshbalajia/fencer:latest --project_dir /app
Supported Secrets
Secret Type | Match Pattern |
---|---|
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 | String Match |
ssh_ec | String Match |
passwords | REGEX/String Match |
Dependencies
~6–15MB
~174K SLoC