Repository files navigation

Deepfence SecretScanner can find unprotected secrets in container images or file systems.

• SecretScanner is a standalone tool that retrieves and searches container and host filesystems, matching the contents against a database of approximately 140 secret types.
• SecretScanner is also included inThreatMapper, an open source scanner that identifies vulnerable dependencies and unprotected secrets in cloud native applications, and ranks these vulnerabilities based on their risk-of-exploit (example)

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 ourblog for more details.

Use SecretScanner if you need a lightweight, efficient method to scan container images and filesystems for possible secrets (keys, tokens, passwords). You can then review these possible 'secrets' to determine if any of them should be removed from production deployments.

For full instructions, refer to theSecretScanner Documentation.

Install docker and run SecretScanner on a container image using the following instructions:

• Build SecretScanner:

./bootstrap.shdocker build --rm=true --tag=quay.io/deepfenceio/deepfence_secret_scanner_ce:2.5.7 -f Dockerfile.

• Or, pull the latest build from docker hub by doing:

docker pull quay.io/deepfenceio/deepfence_secret_scanner_ce:2.5.7

Run this command to generate a license key. Work/official email id has to be used.

curl https://license.deepfence.io/threatmapper/generate-license?first_name=<FIRST_NAME>&last_name=<LAST_NAME>&email=<EMAIL>&company=<ORGANIZATION_NAME>&resend_email=true

• Pull a container image for scanning:

docker pull node:8.11

• Set Product and Licence and scan it::

docker run -i --rm --name=deepfence-secretscanner \    -e DEEPFENCE_PRODUCT=<ThreatMapper or ThreatStryker> \    -e DEEPFENCE_LICENSE=<ThreatMapper or ThreatStryker license key> \    -v /var/run/docker.sock:/var/run/docker.sock \    quay.io/deepfenceio/deepfence_secret_scanner_ce:2.5.7 \    --image-name node:8.11 \    --output json> node.json

Rules can also be cached to use next run by mounting a seperate path and passingrules-path argument

docker run -i --rm --name=deepfence-yarahunter \     -e DEEPFENCE_PRODUCT=<ThreatMapper or ThreatStryker> \     -e DEEPFENCE_LICENSE=<ThreatMapper or ThreatStryker license key> \     -v /var/run/docker.sock:/var/run/docker.sock \     -v /tmp/rules:/tmp/rules \     quay.io/deepfenceio/deepfence_secret_scanner_ce:2.5.7 \     --image-name node:8.11 \     --rules-path=/tmp/rules \     --output json> node.json

We have built upon the configuration file fromshhgit project.

Thank you for using SecretScanner.

• Start with the documentation
• Got a question, need some help? Find the Deepfence team on Slack
• Got a feature request or found a bug? Raise an issue
• productsecurityat deepfencedot io: Found a security issue? Share it in confidence
• Find out more atdeepfence.io

For any security-related issues in the SecretScanner project, contactproductsecurityat deepfencedot io.

Please file GitHub issues as needed, and join the Deepfence CommunitySlack channel.

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.