Deepfence SecretScanner can find any potential secrets in container images or file systems.
What are Secrets?
Secrets are any kind of sensitive or private data which gives authorized users permission to access critical IT infrastructure (such as accounts, devices, network, cloud based services), applications, storage, databases and other kinds of critical data for an organization. For example, passwords, AWS access IDs, AWS secret access keys, Google OAuth Key etc. are secrets. Secrets should be strictly kept private. However, sometimes attackers can easily access secrets due to flawed security policies or inadvertent mistakes by developers. Sometimes developers use default secrets or leave hard-coded secrets such as passwords, API keys, encryption keys, SSH keys, tokens etc. in container images, especially during rapid development and deployment cycles in CI/CD pipeline. Also, sometimes users store passwords in plain text. Leakage of secrets to unauthorized entities can put your organization and infrastructure at serious security risk.
Deepfence SecretScanner helps users scan their container images or local directories on hosts and outputs a JSON file with details of all the secrets found.
Check out our blog for more details.
Command line options
$ ./SecretScanner --help
Usage of ./SecretScanner:
Searches for config.yaml from given directory. If not set, tries to find it from SecretScanner binary's and current directory
Debug levels are one of FATAL, ERROR, IMPORTANT, WARN, INFO, DEBUG. Only levels higher than the debug-level are displayed (default "ERROR")
Name of the image along with tag to scan for secrets
Output json file name. If not set, it will automatically create a filename based on image or dir name
Specify local directory (absolute path) which to scan. Scans only given directory recursively.
Maximum number of matches of same pattern in one file. This is used only when multi-match option is enabled. (default 3)
Maximum number of secrets to find in one container image or file system. (default 1000)
Maximum file size to process in KB (default 256)
Output multiple matches of same pattern in one file. By default, only one match of a pattern is output for a file for better performance
Output directory where json file will be stored. If not set, it will output to current directory
Directory to process and store repositories/matches (default "/tmp")
Number of concurrent threads (default number of logical CPUs)
Quickly Try Using Docker
Install docker and run SecretScanner on a container image using the following instructions:
- Build SecretScanner:
docker build --rm=true --tag=deepfenceio/secretscanning:latest -f Dockerfile .
- Or, pull the latest build from docker hub by doing:
docker pull deepfenceio/secretscanning
- Pull a container image for scanning:
docker pull node:8.11
- Run SecretScanner:
Scan a container image:
docker run -it --rm --name=deepfence-secretscanner -v $(pwd):/home/deepfence/output -v /var/run/docker.sock:/var/run/docker.sock -v /usr/bin/docker:/usr/bin/docker deepfenceio/secretscanning -image-name node:8.11
Scan a local directory:
docker run -it --rm --name=deepfence-secretscanner -v $(pwd):/home/deepfence/output -v /var/run/docker.sock:/var/run/docker.sock -v /usr/bin/docker:/usr/bin/docker deepfenceio/secretscanning -local /home/deepfence/src/SecretScanner/test
By default, SecretScanner will also create json files with details of all the secrets found in the current working directory. You can explicitly specify the output directory and json filename using the appropriate options.
- Install Docker
- Install Hyperscan
- Install go for your platform (version 1.14)
- Install go modules, if needed:
go get github.com/deepfence/SecretScannerwill download and build SecretScanner automatically in
$HOME/go/bindirectory. Or, clone this repository and run
go build -v -ito build the executable in the current directory.
- Edit config.yaml file as needed and run the secret scanner with the appropriate config file directory.
For reference, the Install file has commands to build on an ubuntu system.
Instructions to Run on Local Host
./SecretScanner -config-path /path/to/config.yaml/dir -local test
./SecretScanner -config-path /path/to/config.yaml/dir -image-name node:8.11
Sample SecretScanner Output
We have built upon the configuration file from shhgit project.
This tool is not meant to be used for hacking. Please use it only for legitimate purposes like detecting secrets on the infrastructure you own, not on others’ infrastructure. DEEPFENCE shall not be liable for loss of profit, loss of business, other financial loss, or any other loss or damage which may be caused, directly or indirectly, by the inadequacy of SecretScanner for any purpose or use thereof or by any defect or deficiency therein.