项目作者: dxa4481

项目描述 :
Searches through git repositories for high entropy strings and secrets, digging deep into commit history
高级语言: Python
项目地址: git://github.com/dxa4481/truffleHog.git
创建时间: 2016-12-31T05:08:12Z
项目社区:https://github.com/dxa4481/truffleHog

开源协议:GNU General Public License v2.0

下载



GoReleaser Logo

TruffleHog


Find leaked credentials.





Go Report Card
License
Total Detectors


:magright: _Now Scanning





…and more

To learn more about TruffleHog and its features and capabilities, visit our product page.

:globe_with_meridians: TruffleHog Enterprise

Are you interested in continuously monitoring Git, Jira, Slack, Confluence, Microsoft Teams, Sharepoint, and more.. for credentials? We have an enterprise product that can help! Learn more at https://trufflesecurity.com/trufflehog-enterprise.

We take the revenue from the enterprise product to fund more awesome open source projects that the whole community can benefit from.

What is TruffleHog 🐽

TruffleHog is the most powerful secrets Discovery, Classification, Validation, and Analysis tool. In this context secret refers to a credential a machine uses to authenticate itself to another machine. This includes API keys, database passwords, private encryption keys, and more…

Discovery 🔍

TruffleHog can look for secrets in many places including Git, chats, wikis, logs, API testing platforms, object stores, filesystems and more

Classification 📁

TruffleHog classifies over 800 secret types, mapping them back to the specific identity they belong to. Is it an AWS secret? Stripe secret? Cloudflare secret? Postgres password? SSL Private key? Sometimes its hard to tell looking at it, so TruffleHog classifies everything it finds.

Validation ✅

For every secret TruffleHog can classify, it can also log in to confirm if that secret is live or not. This step is critical to know if there’s an active present danger or not.

Analysis 🔬

For the 20 some of the most commonly leaked out credential types, instead of sending one request to check if the secret can log in, TruffleHog can send many requests to learn everything there is to know about the secret. Who created it? What resources can it access? What permissions does it have on those resources?

:loudspeaker: Join Our Community

Have questions? Feedback? Jump in slack or discord and hang out with us

Join our Slack Community

Join the Secret Scanning Discord

:tv: Demo

GitHub scanning demo

  1. docker run --rm -it -v "$PWD:/pwd" trufflesecurity/trufflehog:latest github --org=trufflesecurity

:floppy_disk: Installation

Several options available for you:

MacOS users

  1. brew install trufflehog

Docker:

Ensure Docker engine is running before executing the following commands:

Unix

  1. docker run --rm -it -v "$PWD:/pwd" trufflesecurity/trufflehog:latest github --repo https://github.com/trufflesecurity/test_keys

Windows Command Prompt

  1. docker run --rm -it -v "%cd:/=\%:/pwd" trufflesecurity/trufflehog:latest github --repo https://github.com/trufflesecurity/test_keys

Windows PowerShell

  1. docker run --rm -it -v "${PWD}:/pwd" trufflesecurity/trufflehog github --repo https://github.com/trufflesecurity/test_keys

M1 and M2 Mac

  1. docker run --platform linux/arm64 --rm -it -v "$PWD:/pwd" trufflesecurity/trufflehog:latest github --repo https://github.com/trufflesecurity/test_keys

Binary releases

  1. Download and unpack from https://github.com/trufflesecurity/trufflehog/releases

Compile from source

  1. git clone https://github.com/trufflesecurity/trufflehog.git
  2. cd trufflehog; go install

Using installation script

  1. curl -sSfL https://raw.githubusercontent.com/trufflesecurity/trufflehog/main/scripts/install.sh | sh -s -- -b /usr/local/bin

Using installation script, verify checksum signature (requires cosign to be installed)

  1. curl -sSfL https://raw.githubusercontent.com/trufflesecurity/trufflehog/main/scripts/install.sh | sh -s -- -v -b /usr/local/bin

Using installation script to install a specific version

  1. curl -sSfL https://raw.githubusercontent.com/trufflesecurity/trufflehog/main/scripts/install.sh | sh -s -- -b /usr/local/bin <ReleaseTag like v3.56.0>

:closed_lock_with_key: Verifying the artifacts

Checksums are applied to all artifacts, and the resulting checksum file is signed using cosign.

You need the following tool to verify signature:

Verification steps are as follow:

  1. Download the artifact files you want, and the following files from the releases page.

    • trufflehog_{version}_checksums.txt
    • trufflehog_{version}_checksums.txt.pem
    • trufflehog_{version}_checksums.txt.sig
  2. Verify the signature:

    1. cosign verify-blob <path to trufflehog_{version}_checksums.txt> \
    2. --certificate <path to trufflehog_{version}_checksums.txt.pem> \
    3. --signature <path to trufflehog_{version}_checksums.txt.sig> \
    4. --certificate-identity-regexp 'https://github\.com/trufflesecurity/trufflehog/\.github/workflows/.+' \
    5. --certificate-oidc-issuer "https://token.actions.githubusercontent.com"
  3. Once the signature is confirmed as valid, you can proceed to validate that the SHA256 sums align with the downloaded artifact:

    1. sha256sum --ignore-missing -c trufflehog_{version}_checksums.txt

Replace {version} with the downloaded files version

Alternatively, if you are using installation script, pass -v option to perform signature verification.
This required Cosign binary to be installed prior to running installation script.

:rocket: Quick Start

1: Scan a repo for only verified secrets

Command:

  1. trufflehog git https://github.com/trufflesecurity/test_keys --results=verified,unknown

Expected output:

  1. 🐷🔑🐷 TruffleHog. Unearth your secrets. 🐷🔑🐷
  2. Found verified result 🐷🔑
  3. Detector Type: AWS
  4. Decoder Type: PLAIN
  5. Raw result: AKIAYVP4CIPPERUVIFXG
  6. Line: 4
  7. Commit: fbc14303ffbf8fb1c2c1914e8dda7d0121633aca
  8. File: keys
  9. Email: counter <counter@counters-MacBook-Air.local>
  10. Repository: https://github.com/trufflesecurity/test_keys
  11. Timestamp: 2022-06-16 10:17:40 -0700 PDT
  12. ...

2: Scan a GitHub Org for only verified secrets

  1. trufflehog github --org=trufflesecurity --results=verified,unknown

3: Scan a GitHub Repo for only verified keys and get JSON output

Command:

  1. trufflehog git https://github.com/trufflesecurity/test_keys --results=verified,unknown --json

Expected output:

  1. {"SourceMetadata":{"Data":{"Git":{"commit":"fbc14303ffbf8fb1c2c1914e8dda7d0121633aca","file":"keys","email":"counter \u003ccounter@counters-MacBook-Air.local\u003e","repository":"https://github.com/trufflesecurity/test_keys","timestamp":"2022-06-16 10:17:40 -0700 PDT","line":4}}},"SourceID":0,"SourceType":16,"SourceName":"trufflehog - git","DetectorType":2,"DetectorName":"AWS","DecoderName":"PLAIN","Verified":true,"Raw":"AKIAYVP4CIPPERUVIFXG","Redacted":"AKIAYVP4CIPPERUVIFXG","ExtraData":{"account":"595918472158","arn":"arn:aws:iam::595918472158:user/canarytokens.com@@mirux23ppyky6hx3l6vclmhnj","user_id":"AIDAYVP4CIPPJ5M54LRCY"},"StructuredData":null}
  2. ...

4: Scan a GitHub Repo + its Issues and Pull Requests

  1. trufflehog github --repo=https://github.com/trufflesecurity/test_keys --issue-comments --pr-comments

5: Scan an S3 bucket for verified keys

  1. trufflehog s3 --bucket=<bucket name> --results=verified,unknown

6: Scan S3 buckets using IAM Roles

  1. trufflehog s3 --role-arn=<iam role arn>

7: Scan a Github Repo using SSH authentication in docker

  1. docker run --rm -v "$HOME/.ssh:/root/.ssh:ro" trufflesecurity/trufflehog:latest git ssh://github.com/trufflesecurity/test_keys

8: Scan individual files or directories

  1. trufflehog filesystem path/to/file1.txt path/to/file2.txt path/to/dir

9: Scan a local git repo

Clone the git repo. For example git@github.com:trufflesecurity/test_keys.git">test keys repo.

  1. $ git clone git@github.com:trufflesecurity/test_keys.git

Run trufflehog from the parent directory (outside the git repo).

  1. $ trufflehog git file://test_keys --results=verified,unknown

10: Scan GCS buckets for verified secrets

  1. trufflehog gcs --project-id=<project-ID> --cloud-environment --results=verified,unknown

11: Scan a Docker image for verified secrets

Use the --image flag multiple times to scan multiple images.

  1. # to scan from a remote registry
  2. trufflehog docker --image trufflesecurity/secrets --results=verified,unknown
  3. # to scan from the local docker daemon
  4. trufflehog docker --image docker://new_image:tag --results=verified,unknown
  5. # to scan from an image saved as a tarball
  6. trufflehog docker --image file://path_to_image.tar --results=verified,unknown

12: Scan in CI

Set the --since-commit flag to your default branch that people merge into (ex: “main”). Set the --branch flag to your PR’s branch name (ex: “feature-1”). Depending on the CI/CD platform you use, this value can be pulled in dynamically (ex: CIRCLE_BRANCH in Circle CI and TRAVIS_PULL_REQUEST_BRANCH in Travis CI). If the repo is cloned and the target branch is already checked out during the CI/CD workflow, then --branch HEAD should be sufficient. The --fail flag will return an 183 error code if valid credentials are found.

  1. trufflehog git file://. --since-commit main --branch feature-1 --results=verified,unknown --fail

13: Scan a Postman workspace

Use the --workspace-id, --collection-id, --environment flags multiple times to scan multiple targets.

  1. trufflehog postman --token=<postman api token> --workspace-id=<workspace id>

14: Scan a Jenkins server

  1. trufflehog jenkins --url https://jenkins.example.com --username admin --password admin

15: Scan an Elasticsearch server

Scan a Local Cluster

There are two ways to authenticate to a local cluster with TruffleHog: (1) username and password, (2) service token.

Connect to a local cluster with username and password

  1. trufflehog elasticsearch --nodes 192.168.14.3 192.168.14.4 --username truffle --password hog

Connect to a local cluster with a service token

  1. trufflehog elasticsearch --nodes 192.168.14.3 192.168.14.4 --service-token AAEWVaWM...Rva2VuaSDZ

Scan an Elastic Cloud Cluster

To scan a cluster on Elastic Cloud, you’ll need a Cloud ID and API key.

  1. trufflehog elasticsearch \
  2. --cloud-id 'search-prod:dXMtY2Vx...YjM1ODNlOWFiZGRlNjI0NA==' \
  3. --api-key 'MlVtVjBZ...ZSYlduYnF1djh3NG5FQQ=='

16. Scan a GitHub Repository for Cross Fork Object References and Deleted Commits

The following command will enumerate deleted and hidden commits on a GitHub repository and then scan them for secrets. This is an alpha release feature.

  1. trufflehog github-experimental --repo https://github.com/<USER>/<REPO>.git --object-discovery

In addition to the normal TruffleHog output, the --object-discovery flag creates two files in a new $HOME/.trufflehog directory: valid_hidden.txt and invalid.txt. These are used to track state during commit enumeration, as well as to provide users with a complete list of all hidden and deleted commits (valid_hidden.txt). If you’d like to automatically remove these files after scanning, please add the flag --delete-cached-data.

Note: Enumerating all valid commits on a repository using this method takes between 20 minutes and a few hours, depending on the size of your repository. We added a progress bar to keep you updated on how long the enumeration will take. The actual secret scanning runs extremely fast.

For more information on Cross Fork Object References, please read our blog post.

17. Scan Hugging Face

Scan a Hugging Face Model, Dataset or Space

  1. trufflehog huggingface --model <model_id> --space <space_id> --dataset <dataset_id>

Scan all Models, Datasets and Spaces belonging to a Hugging Face Organization or User

  1. trufflehog huggingface --org <orgname> --user <username>

(Optionally) When scanning an organization or user, you can skip an entire class of resources with --skip-models, --skip-datasets, --skip-spaces OR a particular resource with --ignore-models <model_id>, --ignore-datasets <dataset_id>, --ignore-spaces <space_id>.

Scan Discussion and PR Comments

  1. trufflehog huggingface --model <model_id> --include-discussions --include-prs

18. Scan stdin Input

  1. aws s3 cp s3://example/gzipped/data.gz - | gunzip -c | trufflehog stdin

:question: FAQ

  • All I see is 🐷🔑🐷 TruffleHog. Unearth your secrets. 🐷🔑🐷 and the program exits, what gives?
    • That means no secrets were detected
  • Why is the scan taking a long time when I scan a GitHub org
    • Unauthenticated GitHub scans have rate limits. To improve your rate limits, include the --token flag with a personal access token
  • It says a private key was verified, what does that mean?
    • Check out our Driftwood blog post to learn how to do this, in short we’ve confirmed the key can be used live for SSH or SSL Blog post
  • Is there an easy way to ignore specific secrets?
    • If the scanned source supports line numbers, then you can add a trufflehog:ignore comment on the line containing the secret to ignore that secrets.

:newspaper: What’s new in v3?

TruffleHog v3 is a complete rewrite in Go with many new powerful features.

  • We’ve added over 700 credential detectors that support active verification against their respective APIs.
  • We’ve also added native support for scanning GitHub, GitLab, Docker, filesystems, S3, GCS, Circle CI and Travis CI.
  • Instantly verify private keys against millions of github users and billions of TLS certificates using our Driftwood technology.
  • Scan binaries, documents, and other file formats
  • Available as a GitHub Action and a pre-commit hook

What is credential verification?

For every potential credential that is detected, we’ve painstakingly implemented programmatic verification against the API that we think it belongs to. Verification eliminates false positives. For example, the AWS credential detector performs a GetCallerIdentity API call against the AWS API to verify if an AWS credential is active.

:memo: Usage

TruffleHog has a sub-command for each source of data that you may want to scan:

  • git
  • github
  • gitlab
  • docker
  • s3
  • filesystem (files and directories)
  • syslog
  • circleci
  • travisci
  • gcs (Google Cloud Storage)
  • postman
  • jenkins
  • elasticsearch
  • stdin
  • multi-scan

Each subcommand can have options that you can see with the --help flag provided to the sub command:

  1. $ trufflehog git --help
  2. usage: TruffleHog git [<flags>] <uri>
  3. Find credentials in git repositories.
  4. Flags:
  5. -h, --help Show context-sensitive help (also try --help-long and --help-man).
  6. --log-level=0 Logging verbosity on a scale of 0 (info) to 5 (trace). Can be disabled with "-1".
  7. --profile Enables profiling and sets a pprof and fgprof server on :18066.
  8. -j, --json Output in JSON format.
  9. --json-legacy Use the pre-v3.0 JSON format. Only works with git, gitlab, and github sources.
  10. --github-actions Output in GitHub Actions format.
  11. --concurrency=20 Number of concurrent workers.
  12. --no-verification Don't verify the results.
  13. --results=RESULTS Specifies which type(s) of results to output: verified, unknown, unverified, filtered_unverified. Defaults to all types.
  14. --allow-verification-overlap
  15. Allow verification of similar credentials across detectors
  16. --filter-unverified Only output first unverified result per chunk per detector if there are more than one results.
  17. --filter-entropy=FILTER-ENTROPY
  18. Filter unverified results with Shannon entropy. Start with 3.0.
  19. --config=CONFIG Path to configuration file.
  20. --print-avg-detector-time
  21. Print the average time spent on each detector.
  22. --no-update Don't check for updates.
  23. --fail Exit with code 183 if results are found.
  24. --verifier=VERIFIER ... Set custom verification endpoints.
  25. --custom-verifiers-only Only use custom verification endpoints.
  26. --archive-max-size=ARCHIVE-MAX-SIZE
  27. Maximum size of archive to scan. (Byte units eg. 512B, 2KB, 4MB)
  28. --archive-max-depth=ARCHIVE-MAX-DEPTH
  29. Maximum depth of archive to scan.
  30. --archive-timeout=ARCHIVE-TIMEOUT
  31. Maximum time to spend extracting an archive.
  32. --include-detectors="all" Comma separated list of detector types to include. Protobuf name or IDs may be used, as well as ranges.
  33. --exclude-detectors=EXCLUDE-DETECTORS
  34. Comma separated list of detector types to exclude. Protobuf name or IDs may be used, as well as ranges. IDs defined here take precedence over the include list.
  35. --version Show application version.
  36. -i, --include-paths=INCLUDE-PATHS
  37. Path to file with newline separated regexes for files to include in scan.
  38. -x, --exclude-paths=EXCLUDE-PATHS
  39. Path to file with newline separated regexes for files to exclude in scan.
  40. --exclude-globs=EXCLUDE-GLOBS
  41. Comma separated list of globs to exclude in scan. This option filters at the `git log` level, resulting in faster scans.
  42. --since-commit=SINCE-COMMIT
  43. Commit to start scan from.
  44. --branch=BRANCH Branch to scan.
  45. --max-depth=MAX-DEPTH Maximum depth of commits to scan.
  46. --bare Scan bare repository (e.g. useful while using in pre-receive hooks)
  47. Args:
  48. <uri> Git repository URL. https://, file://, or ssh:// schema expected.

For example, to scan a git repository, start with

  1. trufflehog git https://github.com/trufflesecurity/trufflehog.git

Configuration

TruffleHog supports defining custom regex detectors
and multiple sources in a configuration file provided via the --config flag.
The regex detectors can be used with any subcommand, while the sources defined
in configuration are only for the multi-scan subcommand.

The configuration format for sources can be found on Truffle Security’s
source configuration documentation page.

Example GitHub source configuration and options reference:

  1. sources:
  2. - connection:
  3. '@type': type.googleapis.com/sources.GitHub
  4. repositories:
  5. - https://github.com/trufflesecurity/test_keys.git
  6. unauthenticated: {}
  7. name: example config scan
  8. type: SOURCE_TYPE_GITHUB
  9. verify: true

You may define multiple connections under the sources key (see above), and
TruffleHog will scan all of the sources concurrently.

S3

The S3 source supports assuming IAM roles for scanning in addition to IAM users. This makes it easier for users to scan multiple AWS accounts without needing to rely on hardcoded credentials for each account.

The IAM identity that TruffleHog uses initially will need to have AssumeRole privileges as a principal in the trust policy of each IAM role to assume.

To scan a specific bucket using locally set credentials or instance metadata if on an EC2 instance:

  1. trufflehog s3 --bucket=<bucket-name>

To scan a specific bucket using an assumed role:

  1. trufflehog s3 --bucket=<bucket-name> --role-arn=<iam-role-arn>

Multiple roles can be passed as separate arguments. The following command will attempt to scan every bucket each role has permissions to list in the S3 API:

  1. trufflehog s3 --role-arn=<iam-role-arn-1> --role-arn=<iam-role-arn-2>

Exit Codes:

  • 0: No errors and no results were found.
  • 1: An error was encountered. Sources may not have completed scans.
  • 183: No errors were encountered, but results were found. Will only be returned if --fail flag is used.

:octocat: TruffleHog Github Action

General Usage

  1. on:
  2. push:
  3. branches:
  4. - main
  5. pull_request:
  6. jobs:
  7. test:
  8. runs-on: ubuntu-latest
  9. steps:
  10. - name: Checkout code
  11. uses: actions/checkout@v4
  12. with:
  13. fetch-depth: 0
  14. - name: Secret Scanning
  15. uses: trufflesecurity/trufflehog@main
  16. with:
  17. extra_args: --results=verified,unknown

In the example config above, we’re scanning for live secrets in all PRs and Pushes to main. Only code changes in the referenced commits are scanned. If you’d like to scan an entire branch, please see the “Advanced Usage” section below.

Shallow Cloning

If you’re incorporating TruffleHog into a standalone workflow and aren’t running any other CI/CD tooling alongside TruffleHog, then we recommend using Shallow Cloning to speed up your workflow. Here’s an example for how to do it:

  1. ...
  2. - shell: bash
  3. run: |
  4. if [ "${{ github.event_name }}" == "push" ]; then
  5. echo "depth=$(($(jq length <<< '${{ toJson(github.event.commits) }}') + 2))" >> $GITHUB_ENV
  6. echo "branch=${{ github.ref_name }}" >> $GITHUB_ENV
  7. fi
  8. if [ "${{ github.event_name }}" == "pull_request" ]; then
  9. echo "depth=$((${{ github.event.pull_request.commits }}+2))" >> $GITHUB_ENV
  10. echo "branch=${{ github.event.pull_request.head.ref }}" >> $GITHUB_ENV
  11. fi
  12. - uses: actions/checkout@v3
  13. with:
  14. ref: ${{env.branch}}
  15. fetch-depth: ${{env.depth}}
  16. - uses: trufflesecurity/trufflehog@main
  17. with:
  18. extra_args: --results=verified,unknown
  19. ...

Depending on the event type (push or PR), we calculate the number of commits present. Then we add 2, so that we can reference a base commit before our code changes. We pass that integer value to the fetch-depth flag in the checkout action in addition to the relevant branch. Now our checkout process should be much shorter.

Canary detection

TruffleHog statically detects https://canarytokens.org/.

image

Advanced Usage

  1. - name: TruffleHog
  2. uses: trufflesecurity/trufflehog@main
  3. with:
  4. # Repository path
  5. path:
  6. # Start scanning from here (usually main branch).
  7. base:
  8. # Scan commits until here (usually dev branch).
  9. head: # optional
  10. # Extra args to be passed to the trufflehog cli.
  11. extra_args: --log-level=2 --results=verified,unknown

If you’d like to specify specific base and head refs, you can use the base argument (--since-commit flag in TruffleHog CLI) and the head argument (--branch flag in the TruffleHog CLI). We only recommend using these arguments for very specific use cases, where the default behavior does not work.

Advanced Usage: Scan entire branch

  1. - name: scan-push
  2. uses: trufflesecurity/trufflehog@main
  3. with:
  4. base: ""
  5. head: ${{ github.ref_name }}
  6. extra_args: --results=verified,unknown

TruffleHog GitLab CI

Example Usage

  1. stages:
  2. - security
  3. security-secrets:
  4. stage: security
  5. allow_failure: false
  6. image: alpine:latest
  7. variables:
  8. SCAN_PATH: "." # Set the relative path in the repo to scan
  9. before_script:
  10. - apk add --no-cache git curl jq
  11. - curl -sSfL https://raw.githubusercontent.com/trufflesecurity/trufflehog/main/scripts/install.sh | sh -s -- -b /usr/local/bin
  12. script:
  13. - trufflehog filesystem "$SCAN_PATH" --results=verified,unknown --fail --json | jq
  14. rules:
  15. - if: '$CI_PIPELINE_SOURCE == "merge_request_event"'

In the example pipeline above, we’re scanning for live secrets in all repository directories and files. This job runs only when the pipeline source is a merge request event, meaning it’s triggered when a new merge request is created.

Pre-commit Hook

TruffleHog can be used in a pre-commit hook to prevent credentials from leaking before they ever leave your computer.

See the pre-commit hook documentation for more information.

Regex Detector (alpha)

TruffleHog supports detection and verification of custom regular expressions.
For detection, at least one regular expression and keyword is required.
A keyword is a fixed literal string identifier that appears in or around
the regex to be detected. To allow maximum flexibility for verification, a
webhook is used containing the regular expression matches.

TruffleHog will send a JSON POST request containing the regex matches to a
configured webhook endpoint. If the endpoint responds with a 200 OK response
status code, the secret is considered verified.

Custom Detectors support a few different filtering mechanisms: entropy, regex targeting the entire match, regex targeting the captured secret,
and excluded word lists checked against the secret (captured group if present, entire match if capture group is not present). Note that if
your custom detector has multiple regex set (in this example hogID, and hogToken), then the filters get applied to each regex. Here is an example of a custom detector using these filters.

NB: This feature is alpha and subject to change.

Regex Detector Example

Here is how to setup a custom regex detector with verification server.

:mag: Analyze

TruffleHog supports running a deeper analysis of a credential to view its permissions and the resources it has access to.

  1. trufflehog analyze

:heart: Contributors

This project exists thanks to all the people who contribute. [Contribute].



:computer: Contributing

Contributions are very welcome! Please see our contribution guidelines first.

We no longer accept contributions to TruffleHog v2, but that code is available in the v2 branch.

Adding new secret detectors

We have published some documentation and tooling to get started on adding new secret detectors. Let’s improve detection together!

Use as a library

Currently, trufflehog is in heavy development and no guarantees can be made on
the stability of the public APIs at this time.

License Change

Since v3.0, TruffleHog is released under a AGPL 3 license, included in LICENSE. TruffleHog v3.0 uses none of the previous codebase, but care was taken to preserve backwards compatibility on the command line interface. The work previous to this release is still available licensed under GPL 2.0 in the history of this repository and the previous package releases and tags. A completed CLA is required for us to accept contributions going forward.