- Notifications
You must be signed in to change notification settings - Fork1.8k
Find, verify, and analyze leaked credentials
License
trufflesecurity/trufflehog
Folders and files
| Name | Name | Last commit message | Last commit date | |
|---|---|---|---|---|
Repository files navigation
Find leaked credentials.
...and more
To learn more about about TruffleHog and its features and capabilities, visit ourproduct page.
Are you interested in continuously monitoringGit, Jira, Slack, Confluence, Microsoft Teams, Sharepoint, and more.. for credentials? We have an enterprise product that can help! Learn more athttps://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.
TruffleHog is the most powerful secretsDiscovery, Classification, Validation, andAnalysis 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...
TruffleHog can look for secrets in many places including Git, chats, wikis, logs, API testing platforms, object stores, filesystems and more
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.
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.
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?
Have questions? Feedback? Jump in slack or discord and hang out with us
Join ourSlack Community
Join theSecret Scanning Discord
docker run --rm -it -v"$PWD:/pwd" trufflesecurity/trufflehog:latest github --org=trufflesecuritySeveral options available for you:
brew install trufflehog
Ensure Docker engine is running before executing the following commands:
docker run --rm -it -v"$PWD:/pwd" trufflesecurity/trufflehog:latest github --repo https://github.com/trufflesecurity/test_keysdocker run --rm -it -v"%cd:/=\%:/pwd" trufflesecurity/trufflehog:latest github --repo https://github.com/trufflesecurity/test_keysdocker run --rm -it -v"${PWD}:/pwd" trufflesecurity/trufflehog github --repo https://github.com/trufflesecurity/test_keysdocker run --platform linux/arm64 --rm -it -v"$PWD:/pwd" trufflesecurity/trufflehog:latest github --repo https://github.com/trufflesecurity/test_keysDownload and unpack from https://github.com/trufflesecurity/trufflehog/releases
git clone https://github.com/trufflesecurity/trufflehog.gitcd trufflehog; go install
curl -sSfL https://raw.githubusercontent.com/trufflesecurity/trufflehog/main/scripts/install.sh| sh -s -- -b /usr/local/bincurl -sSfL https://raw.githubusercontent.com/trufflesecurity/trufflehog/main/scripts/install.sh| sh -s -- -v -b /usr/local/bincurl -sSfL https://raw.githubusercontent.com/trufflesecurity/trufflehog/main/scripts/install.sh| sh -s -- -b /usr/local/bin<ReleaseTag like v3.56.0>
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:
Download the artifact files you want, and the following files from thereleases page.
- trufflehog_{version}_checksums.txt
- trufflehog_{version}_checksums.txt.pem
- trufflehog_{version}_checksums.txt.sig
Verify the signature:
cosign verify-blob<path to trufflehog_{version}_checksums.txt> \--certificate<path to trufflehog_{version}_checksums.txt.pem> \--signature<path to trufflehog_{version}_checksums.txt.sig> \--certificate-identity-regexp'https://github\.com/trufflesecurity/trufflehog/\.github/workflows/.+' \--certificate-oidc-issuer"https://token.actions.githubusercontent.com"
Once the signature is confirmed as valid, you can proceed to validate that the SHA256 sums align with the downloaded artifact:
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.
Command:
trufflehog git https://github.com/trufflesecurity/test_keys --results=verified,unknown
Expected output:
🐷🔑🐷 TruffleHog. Unearth your secrets. 🐷🔑🐷Found verified result 🐷🔑Detector Type: AWSDecoder Type: PLAINRaw result: AKIAYVP4CIPPERUVIFXGLine: 4Commit: fbc14303ffbf8fb1c2c1914e8dda7d0121633acaFile: keysEmail: counter <counter@counters-MacBook-Air.local>Repository: https://github.com/trufflesecurity/test_keysTimestamp: 2022-06-16 10:17:40 -0700 PDT...trufflehog github --org=trufflesecurity --results=verified,unknown
Command:
trufflehog git https://github.com/trufflesecurity/test_keys --results=verified,unknown --json
Expected output:
{"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}...trufflehog github --repo=https://github.com/trufflesecurity/test_keys --issue-comments --pr-comments
trufflehog s3 --bucket=<bucket name> --results=verified,unknown
trufflehog s3 --role-arn=<iam role arn>
docker run --rm -v"$HOME/.ssh:/root/.ssh:ro" trufflesecurity/trufflehog:latest git ssh://github.com/trufflesecurity/test_keystrufflehog filesystem path/to/file1.txt path/to/file2.txt path/to/dir
Clone the git repo. For example test keys repo.
$ git clone git@github.com:trufflesecurity/test_keys.git
Run trufflehog from the parent directory (outside the git repo).
$ trufflehog git file://test_keys --results=verified,unknown
trufflehog gcs --project-id=<project-ID> --cloud-environment --results=verified,unknown
Use the--image flag multiple times to scan multiple images.
trufflehog docker --image trufflesecurity/secrets --results=verified,unknown
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 andTRAVIS_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.
trufflehog git file://. --since-commit main --branch feature-1 --results=verified,unknown --fail
Use the--workspace-id,--collection-id,--environment flags multiple times to scan multiple targets.
trufflehog postman --token=<postman api token> --workspace-id=<workspace id>
trufflehog jenkins --url https://jenkins.example.com --username admin --password admin
There are two ways to authenticate to a local cluster with TruffleHog: (1) username and password, (2) service token.
trufflehog elasticsearch --nodes 192.168.14.3 192.168.14.4 --username truffle --password hog
trufflehog elasticsearch --nodes 192.168.14.3 192.168.14.4 --service-token ‘AAEWVaWM...Rva2VuaSDZ’
To scan a cluster on Elastic Cloud, you’ll need a Cloud ID and API key.
trufflehog elasticsearch \ --cloud-id'search-prod:dXMtY2Vx...YjM1ODNlOWFiZGRlNjI0NA==' \ --api-key'MlVtVjBZ...ZSYlduYnF1djh3NG5FQQ=='
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.
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 andinvalid.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, pleaseread our blog post.
trufflehog huggingface --model<model_id> --space<space_id> --dataset<dataset_id>
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>.
trufflehog huggingface --model<model_id> --include-discussions --include-prs
- 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
--tokenflag with a personal access token
- Unauthenticated GitHub scans have rate limits. To improve your rate limits, include the
- 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 SSLBlog post
- Is there an easy way to ignore specific secrets?
- If the scanned sourcesupports line numbers, then you can add a
trufflehog:ignorecomment on the line containing the secret to ignore that secrets.
- If the scanned sourcesupports line numbers, then you can add a
TruffleHog v3 is a complete rewrite in Go with many new powerful features.
- We'veadded over 700 credential detectors that support active verification against their respective APIs.
- We've also added nativesupport for scanning GitHub, GitLab, Docker, filesystems, S3, GCS, Circle CI and Travis CI.
- Instantly verify private keys against millions of github users andbillions of TLS certificates using ourDriftwood technology.
- Scan binaries, documents, and other file formats
- Available as a GitHub Action and a pre-commit hook
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, theAWS credential detector performs aGetCallerIdentity API call against the AWS API to verify if an AWS credential is active.
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
Each subcommand can have options that you can see with the--help flag provided to the sub command:
$ trufflehog git --helpusage: TruffleHog git [<flags>] <uri>Find credentials in git repositories.Flags: -h, --help Show context-sensitive help (also try --help-long and --help-man). --log-level=0 Logging verbosity on a scale of 0 (info) to 5 (trace). Can be disabled with "-1". --profile Enables profiling and sets a pprof and fgprof server on :18066. -j, --json Output in JSON format. --json-legacy Use the pre-v3.0 JSON format. Only works with git, gitlab, and github sources. --github-actions Output in GitHub Actions format. --concurrency=20 Number of concurrent workers. --no-verification Don't verify the results. --results=RESULTS Specifies which type(s) of results to output: verified, unknown, unverified, filtered_unverified. Defaults to all types. --allow-verification-overlap Allow verification of similar credentials across detectors --filter-unverified Only output first unverified result per chunk per detector if there are more than one results. --filter-entropy=FILTER-ENTROPY Filter unverified results with Shannon entropy. Start with 3.0. --config=CONFIG Path to configuration file. --print-avg-detector-time Print the average time spent on each detector. --no-update Don't check for updates. --fail Exit with code 183 if results are found. --verifier=VERIFIER ... Set custom verification endpoints. --custom-verifiers-only Only use custom verification endpoints. --archive-max-size=ARCHIVE-MAX-SIZE Maximum size of archive to scan. (Byte units eg. 512B, 2KB, 4MB) --archive-max-depth=ARCHIVE-MAX-DEPTH Maximum depth of archive to scan. --archive-timeout=ARCHIVE-TIMEOUT Maximum time to spend extracting an archive. --include-detectors="all" Comma separated list of detector types to include. Protobuf name or IDs may be used, as well as ranges. --exclude-detectors=EXCLUDE-DETECTORS 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. --version Show application version. -i, --include-paths=INCLUDE-PATHS Path to file with newline separated regexes for files to include in scan. -x, --exclude-paths=EXCLUDE-PATHS Path to file with newline separated regexes for files to exclude in scan. --exclude-globs=EXCLUDE-GLOBS Comma separated list of globs to exclude in scan. This option filters at the `git log` level, resulting in faster scans. --since-commit=SINCE-COMMIT Commit to start scan from. --branch=BRANCH Branch to scan. --max-depth=MAX-DEPTH Maximum depth of commits to scan. --bare Scan bare repository (e.g. useful while using in pre-receive hooks)Args: <uri> Git repository URL. https://, file://, or ssh:// schema expected.For example, to scan agit repository, start with
trufflehog git https://github.com/trufflesecurity/trufflehog.gitThe 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 haveAssumeRole privileges as a principal in thetrust policy of each IAM role to assume.
To scan a specific bucket using locally set credentials or instance metadata if on an EC2 instance:
trufflehog s3 --bucket=<bucket-name>
To scan a specific bucket using an assumed role:
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:
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
--failflag is used.
TruffleHog Github Actionon: push: branches: - main pull_request:jobs: test: runs-on: ubuntu-latest steps: - name: Checkout code uses: actions/checkout@v4 with: fetch-depth: 0 - name: Secret Scanning uses: trufflesecurity/trufflehog@main with: extra_args: --results=verified,unknownIn the example config above, we're scanning for live secrets in all PRs and Pushes tomain. 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.
If you're incorporating TruffleHog into a standalone workflow and aren't running any other CI/CD tooling alongside TruffleHog, then we recommend usingShallow Cloning to speed up your workflow. Here's an example for how to do it:
... - shell: bash run: | if [ "${{ github.event_name }}" == "push" ]; then echo "depth=$(($(jq length <<< '${{ toJson(github.event.commits) }}') + 2))" >> $GITHUB_ENV echo "branch=${{ github.ref_name }}" >> $GITHUB_ENV fi if [ "${{ github.event_name }}" == "pull_request" ]; then echo "depth=$((${{ github.event.pull_request.commits }}+2))" >> $GITHUB_ENV echo "branch=${{ github.event.pull_request.head.ref }}" >> $GITHUB_ENV fi - uses: actions/checkout@v3 with: ref: ${{env.branch}} fetch-depth: ${{env.depth}} - uses: trufflesecurity/trufflehog@main with: extra_args: --results=verified,unknown...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 thefetch-depth flag in the checkout action in addition to the relevant branch. Now our checkout process should be much shorter.
TruffleHog statically detectshttps://canarytokens.org/ and lets you know when they're present without setting them off. You can learn more here:https://trufflesecurity.com/canaries
-name:TruffleHoguses:trufflesecurity/trufflehog@mainwith:# Repository pathpath:# Start scanning from here (usually main branch).base:# Scan commits until here (usually dev branch).head:# optional# Extra args to be passed to the trufflehog cli.extra_args:--log-level=2 --results=verified,unknown
If you'd like to specify specificbase andhead refs, you can use thebase argument (--since-commit flag in TruffleHog CLI) and thehead 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.
- name: scan-push uses: trufflesecurity/trufflehog@main with: base: "" head: ${{ github.ref_name }} extra_args: --results=verified,unknownstages: -securitysecurity-secrets:stage:securityallow_failure:falseimage:alpine:latestvariables:SCAN_PATH:"."# Set the relative path in the repo to scanbefore_script: -apk add --no-cache git curl jq -curl -sSfL https://raw.githubusercontent.com/trufflesecurity/trufflehog/main/scripts/install.sh | sh -s -- -b /usr/local/binscript: -trufflehog filesystem "$SCAN_PATH" --results=verified,unknown --fail --json | jqrules: -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.
TruffleHog can be used in a pre-commit hook to prevent credentials from leaking before they ever leave your computer.
Key Usage Note:
- For optimal hook efficacy, execute
git addfollowed bygit commitseparately. This ensures TruffleHog analyzes all intended changes. - Avoid using
git commit -am, as it might bypass pre-commit hook execution for unstaged modifications.
An example.pre-commit-config.yaml is provided (seepre-commit.com for installation).
repos: -repo:localhooks: -id:trufflehogname:TruffleHogdescription:Detect secrets in your data.entry:bash -c 'trufflehog git file://. --since-commit HEAD --results=verified,unknown --fail'# For running trufflehog in docker, use the following entry instead:# entry: bash -c 'docker run --rm -v "$(pwd):/workdir" -i --rm trufflesecurity/trufflehog:latest git file:///workdir --since-commit HEAD --results=verified,unknown --fail'language:systemstages:["commit", "push"]
TruffleHog supports detection and verification of custom regular expressions.For detection, at least oneregular expression andkeyword is required.Akeyword is a fixed literal string identifier that appears in or aroundthe regex to be detected. To allow maximum flexibility for verification, awebhook is used containing the regular expression matches.
TruffleHog will send a JSON POST request containing the regex matches to aconfigured webhook endpoint. If the endpoint responds with a200 OK responsestatus 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 ifyour custom detector has multipleregex set (in this examplehogID, andhogToken), 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.
Here is how to setup a custom regex detector with verification server.
TruffleHog supports running a deeper analysis of a credential to view its permissions and the resources it has access to.
trufflehog analyze
This project exists thanks to all the people who contribute. [Contribute].
Contributions are very welcome! Please see ourcontribution guidelines first.
We no longer accept contributions to TruffleHog v2, but that code is available in thev2 branch.
We have published somedocumentation and tooling to get started on adding new secret detectors. Let's improve detection together!
Currently, trufflehog is in heavy development and no guarantees can be made onthe stability of the public APIs at this time.
Since v3.0, TruffleHog is released under a AGPL 3 license, included inLICENSE. 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.
About
Find, verify, and analyze leaked credentials