| Repos | \ntrufflesecurity/trufflehog | \n
|---|---|
| Views | \n![\"views\"](\"https://views.whatilearened.today/views/github/trufflesecurity/trufflehog.svg\") | \n
| Stars | \n![\"stars\"](\"https://img.shields.io/github/stars/trufflesecurity/trufflehog?color=f2f08d&logo=Undertale&logoColor=eb4630\") | \n
| Forks | \n![\"forks\"](\"https://img.shields.io/github/forks/trufflesecurity/trufflehog?color=ba86eb&logo=Handshake&logoColor=ea6aa6\") | \n
| License | \n![\"license\"](\"https://img.shields.io/github/license/trufflesecurity/trufflehog?logo=data%3Aimage%2Fpng%3Bbase64%2CiVBORw0KGgoAAAANSUhEUgAAADAAAAAwCAYAAABXAvmHAAAACXBIWXMAAAsTAAALEwEAmpwYAAAD3klEQVR4nO3YSUzUUBgH8JroWVrUGJfEm7sXNcSDFxMTL2pi4sHEgxeNRowXgpEWBDURR%2BNANOKOK66ooKJGBXeEGRcWAcEVFGQRHFwQmH5%2F0wHaeWHI9DUDU5L5knehdOb7zfe%2B19cnCJGIRCQiEYlQB7YJIyGL8aosulVZ6iRFQjiGKkudWg5aLlpOppNXnfPqw5U0DYRJmVxjCgFF3BLuZGmAoVUiKEArmX7D7USgsQporgGa3gHfK4H6cuBbCVD3Gqh1A5%2BLgE%2BFwIenQM0joDofqLoHVNwBym8CpTnAm2zQq0sgdxbIdQZUlAkqPAZ6dgj05ADoYRoofy%2FoXiro7k5QXjLopgzKiQNlLDaqoIguEwBjzqP5PfDjE9DyIXyI63FMTwQFMCVrqwNav4QfoRg58QF%2BfrMHQrEK8DToCMqNAyWNHfxmTRoLOrmSRVgGtDfqCEqZOHQrzo4pbCUsA3416Qi6EQ9KGjcEFRgHOrOKnU6WAb9bGETYekKxCvjTag9E4pje54Dk5QP8bbMHYv%2FC3ueAeJkP0OGxB%2BJpBnArYR8EYQQnoN1ANFaBnPP5l8SrseYQL06Adk0FJY8HOWaBMleAHjh0hPosIzlo8v0A%2F34ZiOeHra0qKRPMVSI7tv%2B92tw%2FvhxUeBRq4VELgM7fBqK5GpRmoQLXNpubTu6zoNRpgT8nPQbq84wd%2FICuvyxiKHqiNAfI3wM6uIhBqGkLiiwAOsKDqOht7Itr9Vy8SjRBEWfyAbr%2FhR1BfpVQFdHJB%2FB2hh7x7j6QpwCVeeYQ2krUB5Clcj6A2m0gWj%2BD0mL49zW5cQyCHLN7rjlmmatEyXX%2FCrTzA%2FoQxZkWl9GJTCVo%2ByTj87%2B4giPKcv0qIHo4AV4D0VZrrQI34pnpRM65xue%2FzAreE4%2FT%2FSoglfEByMsiQtATlL3RAJ5YHrSx6ZDfS70s7uMHhBpR%2FYB5s0PW6oERp1b6%2FfrRhK3SDL5Tie6OQUHQlQ3sVDu%2BzPck9vWE9str%2B6IjS9gHmWPahaDJ%2BwCK6NIBBXsHB9HykXsxwDphlCmAdvplabUJNnZPB94%2FNt6xOe8XzEbP2WhM3WAg1Gub6tH%2B3Q1Pg376R9q4uqlno6gdHGjDOQ90eb01AHM6rYiuUJ1Oq4r4FVuj5vR9BzM9WgNvOywDhiIYQFvgbcfwAfwMvHcaPgBPA%2FDyHGjPbN9A8amebcdwAdD5Nf375txqewNUReoyvwBIXYLdQpWlhwFWqtPaCPD3AsFuASV6qqqIlb0JvkVC1FL9WkLUUlUWK3zXZLFC%2B1%2FBroFto6OsXIuEYJP4DzzW2YFV1oJaAAAAAElFTkSuQmCC\") | \n
| UpdatedAt | \n![\"last-commit\"](\"https://img.shields.io/github/last-commit/trufflesecurity/trufflehog?display_timestamp=committer&logo=data%3Aimage%2Fpng%3Bbase64%2CiVBORw0KGgoAAAANSUhEUgAAAB4AAAAeCAYAAAA7MK6iAAAACXBIWXMAAAsTAAALEwEAmpwYAAAFHUlEQVR4nLVX7U9aVxwm26dlX%2Fdhbx%2B2%2FQnbkvUbrdUAQgJJIfUDNWDTTmOv1FQUFaPJ4kusrV01Jt1sNpctS2u3botZtmxd9tJSFSoqKqIF5bYDFLCovClefstzJ8wXRLDZLznkcO4557n3d3%2FneZ4rEOQZt1WqF%2B8XFr4%2BfOLEe2joY0zwf8ToyZPvjEgkLY%2Bk0mmrXO6dKinxzGk0fjT0x%2BRyr0UqncYczM1rc4tQ%2BIrp2LGXdo4NC4VvWqTS72wqlc%2Br13ORri6KdXdnbOHLlwlzJpRKn6W4%2BK6poOCNnIAfHj%2F%2BwahIZB4vKnqZf0qJpNIql%2Fv8TU0cNl5rbyc3w0QnTp3y2LTaJ7M1NaxDr2fRn1SpPG6Gia21tfE34TcaOay1iMUVOQFbFYqIWSo1W8TiAVanC0evXOEB7Wp14HFb22zE5fqLOC5ERLQWidNaNI4uEcc9i7hcJldHh2NWrQ5gDdbOlpaumIuLb2atAQDPnz0b8NbWcmxVVRJ3HmxpScwwzOJmKDRGe8LlCZDLG9g7TInV1Ql7dbXbV1e3gT0WKirCFomkPyvwXFlZGJOjV6%2BSt64uudDZOU5EUcox%2FMEQDVvt6MbcN27Y3Ayzhv3spaUrB6Z9qrJSO19ezj8p2pLBkJy%2BcCHJxWI5gW5tcfRRz1dU19GfGkou9PZO4smR9jGFwpex4Dy3bvnmKypotbU13VidjqYZhrj49rvMEt%2F%2FYqLz9d00NjW%2Fczgyo9O51zs6aNlo5FDtu0DZgQFhlGXJ0dBADoNhd6uvp6Whoayg7N9LVGH8mD4b%2FHnftUQoNG4vLQ0gixMqlW%2B4qOjtNHDg3r1f6YiRSGxRy7UvqLb9U4qkqnxPONva5lDpHr1%2ByyKRNKWBZy5edMUHB2m5ry%2B%2BEQw%2Bzgf4zo9%2F0ocN3WRzLBw4J%2BJyPWCrqmIgGYtUOsWD4oxZFQoPUjGpVHqI4%2FafkQPC6fZQeeM1%2BvLuIQnjuBWQDDCscrmHP9eoNPAtBqfOnXuaK%2Bh6JEbGrs%2BpvvMmxeIbh863abVPeYySEo9FJHpNMFJY%2BP5cWZkfg7O1tSwYCeSQLTY3E8Q09%2FBVPJUlxQjshT1BscCY02r9UDUBfvCHB66pcfPA3lyAe3ngr3%2F47XDgaJzsly7xwA6NZtlUUPCuAHqaSjUIP%2Bsue8BRWAC%2FNfQ7JZPZ59s0Gj7VtpISz4hQ%2BCpfXGMKhZcvLpUKxfWM8ohvf7p%2FODjHBfcVF8Isk82g1FHykcVFE%2BUZAAX47aE%2FMl4PO50Pnuh0%2Fx4nmcyWPsdwDhBx6CmkLV%2FgFDjYKxOJOFtb0wQyIhL9RyCwK3AOfIGp1YFEBhnMJcLRWEbKdKQoU6ncTZkIEDicAy%2F81dVuEM5RwPfey4xOx0Ik%2FI2NnFki%2BWafOoFIYFcgYZCyxd7eCUjbc4AmF65ft%2FkMhk3o%2B5hc7sMJyqjJEGvYFaQFIr7Y0wPw8BFAY%2B6%2Bvmk3w6zzRuDMmZVRsfh8RtA0uETSD7uCBT6DYQN6iveU0fpkYLjE6qrVrtOxeNKU9THLZJ9kBU2JBsBhV5AivB%2FoKaQNKgPCBwDYaIfZC4adThOqF4WENViLJwVoXobfLBKVw67AOaTsLc65TaVK21vQ4La99eKcYg5vbxsbObzTQ9N7UKDgUO1wDjiDIIBshh5ztg39nQMLSZBH4OzBOUDEQXm206d3fcLgswbXQA4PhcK3nhswU1Bz8wvQ09RHG%2FoYy3ejfwBNmtoYqLA0XgAAAABJRU5ErkJggg%3D%3D&label=UpdatedAt\") | \n
| CreatedAt | \n![\"create-at\"](\"https://img.shields.io/github/created-at/trufflesecurity/trufflehog?logo=data%3Aimage%2Fpng%3Bbase64%2CiVBORw0KGgoAAAANSUhEUgAAAB4AAAAeCAYAAAA7MK6iAAAACXBIWXMAAAsTAAALEwEAmpwYAAAFHUlEQVR4nLVX7U9aVxwm26dlX%2Fdhbx%2B2%2FQnbkvUbrdUAQgJJIfUDNWDTTmOv1FQUFaPJ4kusrV01Jt1sNpctS2u3botZtmxd9tJSFSoqKqIF5bYDFLCovClefstzJ8wXRLDZLznkcO4557n3d3%2FneZ4rEOQZt1WqF%2B8XFr4%2BfOLEe2joY0zwf8ToyZPvjEgkLY%2Bk0mmrXO6dKinxzGk0fjT0x%2BRyr0UqncYczM1rc4tQ%2BIrp2LGXdo4NC4VvWqTS72wqlc%2Br13ORri6KdXdnbOHLlwlzJpRKn6W4%2BK6poOCNnIAfHj%2F%2BwahIZB4vKnqZf0qJpNIql%2Fv8TU0cNl5rbyc3w0QnTp3y2LTaJ7M1NaxDr2fRn1SpPG6Gia21tfE34TcaOay1iMUVOQFbFYqIWSo1W8TiAVanC0evXOEB7Wp14HFb22zE5fqLOC5ERLQWidNaNI4uEcc9i7hcJldHh2NWrQ5gDdbOlpaumIuLb2atAQDPnz0b8NbWcmxVVRJ3HmxpScwwzOJmKDRGe8LlCZDLG9g7TInV1Ql7dbXbV1e3gT0WKirCFomkPyvwXFlZGJOjV6%2BSt64uudDZOU5EUcox%2FMEQDVvt6MbcN27Y3Ayzhv3spaUrB6Z9qrJSO19ezj8p2pLBkJy%2BcCHJxWI5gW5tcfRRz1dU19GfGkou9PZO4smR9jGFwpex4Dy3bvnmKypotbU13VidjqYZhrj49rvMEt%2F%2FYqLz9d00NjW%2Fczgyo9O51zs6aNlo5FDtu0DZgQFhlGXJ0dBADoNhd6uvp6Whoayg7N9LVGH8mD4b%2FHnftUQoNG4vLQ0gixMqlW%2B4qOjtNHDg3r1f6YiRSGxRy7UvqLb9U4qkqnxPONva5lDpHr1%2ByyKRNKWBZy5edMUHB2m5ry%2B%2BEQw%2Bzgf4zo9%2F0ocN3WRzLBw4J%2BJyPWCrqmIgGYtUOsWD4oxZFQoPUjGpVHqI4%2FafkQPC6fZQeeM1%2BvLuIQnjuBWQDDCscrmHP9eoNPAtBqfOnXuaK%2Bh6JEbGrs%2BpvvMmxeIbh863abVPeYySEo9FJHpNMFJY%2BP5cWZkfg7O1tSwYCeSQLTY3E8Q09%2FBVPJUlxQjshT1BscCY02r9UDUBfvCHB66pcfPA3lyAe3ngr3%2F47XDgaJzsly7xwA6NZtlUUPCuAHqaSjUIP%2Bsue8BRWAC%2FNfQ7JZPZ59s0Gj7VtpISz4hQ%2BCpfXGMKhZcvLpUKxfWM8ohvf7p%2FODjHBfcVF8Isk82g1FHykcVFE%2BUZAAX47aE%2FMl4PO50Pnuh0%2Fx4nmcyWPsdwDhBx6CmkLV%2FgFDjYKxOJOFtb0wQyIhL9RyCwK3AOfIGp1YFEBhnMJcLRWEbKdKQoU6ncTZkIEDicAy%2F81dVuEM5RwPfey4xOx0Ik%2FI2NnFki%2BWafOoFIYFcgYZCyxd7eCUjbc4AmF65ft%2FkMhk3o%2B5hc7sMJyqjJEGvYFaQFIr7Y0wPw8BFAY%2B6%2Bvmk3w6zzRuDMmZVRsfh8RtA0uETSD7uCBT6DYQN6iveU0fpkYLjE6qrVrtOxeNKU9THLZJ9kBU2JBsBhV5AivB%2FoKaQNKgPCBwDYaIfZC4adThOqF4WENViLJwVoXobfLBKVw67AOaTsLc65TaVK21vQ4La99eKcYg5vbxsbObzTQ9N7UKDgUO1wDjiDIIBshh5ztg39nQMLSZBH4OzBOUDEQXm206d3fcLgswbXQA4PhcK3nhswU1Bz8wvQ09RHG%2FoYy3ejfwBNmtoYqLA0XgAAAABJRU5ErkJggg%3D%3D&label=CreatedAt\") | \n
![](\"https://cdn.jsdelivr.net/gh/eryajf/tu@main/img/image_20240420_214408.gif\")
\n| Repos | \ntrufflesecurity/trufflehog | \n
|---|---|
| Views | \n | \n
| Stars | \n | \n
| Forks | \n | \n
| License | \n | \n
| UpdatedAt | \n | \n
| CreatedAt | \n | \n
\n\n ![\"GoReleaser](\"https://storage.googleapis.com/trufflehog-static-sources/pixel_pig.png\"){kind=tracking}
Find leaked credentials.
\n\n
\n
\n
![](\"assets/scanning_logos.svg\")
\n...and more
\nTo learn more about about TruffleHog and its features and capabilities, visit our product page.
\nAre 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.
\nWe take the revenue from the enterprise product to fund more awesome open source projects that the whole community can benefit from.
\n\nTruffleHog 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...
\nTruffleHog can look for secrets in many places including Git, chats, wikis, logs, API testing platforms, object stores, filesystems and more
\nTruffleHog 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.
\nFor 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.
\nFor 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?
\nHave questions? Feedback? Jump in slack or discord and hang out with us
\nJoin our Slack Community
\nJoin the Secret Scanning Discord
\n![\"License\"](\"https://img.shields.io/badge/license-AGPL--3.0-brightgreen\"){kind=icon}
![\"Total](\"https://img.shields.io/github/directory-file-count/trufflesecurity/truffleHog/pkg/detectors?label=Total%20Detectors&type=dir\")
![\"GitHub](\"https://storage.googleapis.com/truffle-demos/non-interactive.svg\")
docker run --rm -it -v \"$PWD:/pwd\" trufflesecurity/trufflehog:latest github --org=trufflesecuritySeveral options available for you:
\nbrew install trufflehogEnsure Docker engine is running before executing the following commands:
\ndocker 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/releasesgit clone https://github.com/trufflesecurity/trufflehog.git\ncd trufflehog; go installcurl -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.
\nYou need the following tool to verify signature:
\nVerification steps are as follow:
\nDownload the artifact files you want, and the following files from the releases page.
\nVerify the signature:
\ncosign verify-blob <path to trufflehog_{version}_checksums.txt> \\\n--certificate <path to trufflehog_{version}_checksums.txt.pem> \\\n--signature <path to trufflehog_{version}_checksums.txt.sig> \\\n--certificate-identity-regexp 'https://github\\.com/trufflesecurity/trufflehog/\\.github/workflows/.+' \\\n--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:
\nsha256sum --ignore-missing -c trufflehog_{version}_checksums.txtReplace {version} with the downloaded files version
Alternatively, if you are using installation script, pass -v option to perform signature verification.
\nThis required Cosign binary to be installed prior to running installation script.
Command:
\ntrufflehog git https://github.com/trufflesecurity/test_keys --results=verified,unknownExpected output:
\n🐷🔑🐷 TruffleHog. Unearth your secrets. 🐷🔑🐷\n\nFound verified result 🐷🔑\nDetector Type: AWS\nDecoder Type: PLAIN\nRaw result: AKIAYVP4CIPPERUVIFXG\nLine: 4\nCommit: fbc14303ffbf8fb1c2c1914e8dda7d0121633aca\nFile: keys\nEmail: counter <counter@counters-MacBook-Air.local>\nRepository: https://github.com/trufflesecurity/test_keys\nTimestamp: 2022-06-16 10:17:40 -0700 PDT\n...\ntrufflehog github --org=trufflesecurity --results=verified,unknownCommand:
\ntrufflehog git https://github.com/trufflesecurity/test_keys --results=verified,unknown --jsonExpected output:
\n{\"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}\n...\ntrufflehog github --repo=https://github.com/trufflesecurity/test_keys --issue-comments --pr-commentstrufflehog s3 --bucket=<bucket name> --results=verified,unknowntrufflehog 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/dirClone the git repo. For example test keys repo.
\n$ git clone git@github.com:trufflesecurity/test_keys.gitRun trufflehog from the parent directory (outside the git repo).
\n$ trufflehog git file://test_keys --results=verified,unknowntrufflehog gcs --project-id=<project-ID> --cloud-environment --results=verified,unknownUse the --image flag multiple times to scan multiple images.
trufflehog docker --image trufflesecurity/secrets --results=verified,unknownSet 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.
trufflehog git file://. --since-commit main --branch feature-1 --results=verified,unknown --failUse 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 adminThere are two ways to authenticate to a local cluster with TruffleHog: (1) username and password, (2) service token.
\ntrufflehog elasticsearch --nodes 192.168.14.3 192.168.14.4 --username truffle --password hogtrufflehog 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.
\ntrufflehog elasticsearch \\\n --cloud-id 'search-prod:dXMtY2Vx...YjM1ODNlOWFiZGRlNjI0NA==' \\\n --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.
\ntrufflehog github-experimental --repo https://github.com/<USER>/<REPO>.git --object-discoveryIn 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.
\nFor more information on Cross Fork Object References, please read our blog post.
\ntrufflehog 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🐷🔑🐷 TruffleHog. Unearth your secrets. 🐷🔑🐷 and the program exits, what gives?\n--token flag with a personal access tokentrufflehog:ignore comment on the line containing the secret to ignore that secrets.TruffleHog v3 is a complete rewrite in Go with many new powerful features.
\nFor 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.
TruffleHog has a sub-command for each source of data that you may want to scan:
\nEach subcommand can have options that you can see with the --help flag provided to the sub command:
$ trufflehog git --help\nusage: TruffleHog git [<flags>] <uri>\n\nFind credentials in git repositories.\n\nFlags:\n -h, --help Show context-sensitive help (also try --help-long and --help-man).\n --log-level=0 Logging verbosity on a scale of 0 (info) to 5 (trace). Can be disabled with \"-1\".\n --profile Enables profiling and sets a pprof and fgprof server on :18066.\n -j, --json Output in JSON format.\n --json-legacy Use the pre-v3.0 JSON format. Only works with git, gitlab, and github sources.\n --github-actions Output in GitHub Actions format.\n --concurrency=20 Number of concurrent workers.\n --no-verification Don't verify the results.\n --results=RESULTS Specifies which type(s) of results to output: verified, unknown, unverified, filtered_unverified. Defaults to all types.\n --allow-verification-overlap\n Allow verification of similar credentials across detectors\n --filter-unverified Only output first unverified result per chunk per detector if there are more than one results.\n --filter-entropy=FILTER-ENTROPY\n Filter unverified results with Shannon entropy. Start with 3.0.\n --config=CONFIG Path to configuration file.\n --print-avg-detector-time\n Print the average time spent on each detector.\n --no-update Don't check for updates.\n --fail Exit with code 183 if results are found.\n --verifier=VERIFIER ... Set custom verification endpoints.\n --custom-verifiers-only Only use custom verification endpoints.\n --archive-max-size=ARCHIVE-MAX-SIZE\n Maximum size of archive to scan. (Byte units eg. 512B, 2KB, 4MB)\n --archive-max-depth=ARCHIVE-MAX-DEPTH\n Maximum depth of archive to scan.\n --archive-timeout=ARCHIVE-TIMEOUT\n Maximum time to spend extracting an archive.\n --include-detectors=\"all\" Comma separated list of detector types to include. Protobuf name or IDs may be used, as well as ranges.\n --exclude-detectors=EXCLUDE-DETECTORS\n 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.\n --version Show application version.\n -i, --include-paths=INCLUDE-PATHS\n Path to file with newline separated regexes for files to include in scan.\n -x, --exclude-paths=EXCLUDE-PATHS\n Path to file with newline separated regexes for files to exclude in scan.\n --exclude-globs=EXCLUDE-GLOBS\n Comma separated list of globs to exclude in scan. This option filters at the `git log` level, resulting in faster scans.\n --since-commit=SINCE-COMMIT\n Commit to start scan from.\n --branch=BRANCH Branch to scan.\n --max-depth=MAX-DEPTH Maximum depth of commits to scan.\n --bare Scan bare repository (e.g. useful while using in pre-receive hooks)\n\nArgs:\n <uri> Git repository URL. https://, file://, or ssh:// schema expected.\nFor example, to scan a git repository, start with
trufflehog git https://github.com/trufflesecurity/trufflehog.git\nThe 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.
\nThe 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:
\ntrufflehog s3 --bucket=<bucket-name>To scan a specific bucket using an assumed role:
\ntrufflehog 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:
\ntrufflehog s3 --role-arn=<iam-role-arn-1> --role-arn=<iam-role-arn-2>Exit Codes:
\n--fail flag is used.![\":octocat:\"](\"https://github.githubassets.com/images/icons/emoji/octocat.png\" "\\":octocat:\\""){kind=icon}
TruffleHog Github Actionon:\n push:\n branches:\n - main\n pull_request:\n\njobs:\n test:\n runs-on: ubuntu-latest\n steps:\n - name: Checkout code\n uses: actions/checkout@v4\n with:\n fetch-depth: 0\n - name: Secret Scanning\n uses: trufflesecurity/trufflehog@main\n with:\n extra_args: --results=verified,unknown\nIn 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.
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:
\n...\n - shell: bash\n run: |\n if [ \"${{ github.event_name }}\" == \"push\" ]; then\n echo \"depth=$(($(jq length <<< '${{ toJson(github.event.commits) }}') + 2))\" >> $GITHUB_ENV\n echo \"branch=${{ github.ref_name }}\" >> $GITHUB_ENV\n fi\n if [ \"${{ github.event_name }}\" == \"pull_request\" ]; then\n echo \"depth=$((${{ github.event.pull_request.commits }}+2))\" >> $GITHUB_ENV\n echo \"branch=${{ github.event.pull_request.head.ref }}\" >> $GITHUB_ENV\n fi\n - uses: actions/checkout@v3\n with:\n ref: ${{env.branch}}\n fetch-depth: ${{env.depth}}\n - uses: trufflesecurity/trufflehog@main\n with:\n extra_args: --results=verified,unknown\n...\nDepending 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.
TruffleHog statically detects https://canarytokens.org/.
\n![\"image\"](\"https://private-user-images.githubusercontent.com/52866392/306720861-74ace530-08c5-4eaf-a169-84a73e328f6f.png?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3NTMwNjc1OTEsIm5iZiI6MTc1MzA2NzI5MSwicGF0aCI6Ii81Mjg2NjM5Mi8zMDY3MjA4NjEtNzRhY2U1MzAtMDhjNS00ZWFmLWExNjktODRhNzNlMzI4ZjZmLnBuZz9YLUFtei1BbGdvcml0aG09QVdTNC1ITUFDLVNIQTI1NiZYLUFtei1DcmVkZW50aWFsPUFLSUFWQ09EWUxTQTUzUFFLNFpBJTJGMjAyNTA3MjElMkZ1cy1lYXN0LTElMkZzMyUyRmF3czRfcmVxdWVzdCZYLUFtei1EYXRlPTIwMjUwNzIxVDAzMDgxMVomWC1BbXotRXhwaXJlcz0zMDAmWC1BbXotU2lnbmF0dXJlPTAwMzNhNWVkYWI5ZWVjOTllMzg4NmJhNDU2ZDkwNzllZTQwODUzMGIxZjFiZjk4NjM3NjY1ZDMxNTE5OTYyNGMmWC1BbXotU2lnbmVkSGVhZGVycz1ob3N0In0.J4GktrpKEL4-xTzHwzqPR0EXhLnqG7xkrExM65hLqI0\")
- name: TruffleHog\n uses: trufflesecurity/trufflehog@main\n with:\n # Repository path\n path:\n # Start scanning from here (usually main branch).\n base:\n # Scan commits until here (usually dev branch).\n head: # optional\n # Extra args to be passed to the trufflehog cli.\n extra_args: --log-level=2 --results=verified,unknownIf 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.
- name: scan-push\n uses: trufflesecurity/trufflehog@main\n with:\n base: \"\"\n head: ${{ github.ref_name }}\n extra_args: --results=verified,unknown\nstages:\n - security\n\nsecurity-secrets:\n stage: security\n allow_failure: false\n image: alpine:latest\n variables:\n SCAN_PATH: \".\" # Set the relative path in the repo to scan\n before_script:\n - apk add --no-cache git curl jq\n - curl -sSfL https://raw.githubusercontent.com/trufflesecurity/trufflehog/main/scripts/install.sh | sh -s -- -b /usr/local/bin\n script:\n - trufflehog filesystem \"$SCAN_PATH\" --results=verified,unknown --fail --json | jq\n rules:\n - 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.
\nTruffleHog can be used in a pre-commit hook to prevent credentials from leaking before they ever leave your computer.
\nSee the pre-commit hook documentation for more information.
\nTruffleHog supports detection and verification of custom regular expressions.
\nFor detection, at least one regular expression and keyword is required.
\nA keyword is a fixed literal string identifier that appears in or around
\nthe regex to be detected. To allow maximum flexibility for verification, a
\nwebhook is used containing the regular expression matches.
TruffleHog will send a JSON POST request containing the regex matches to a
\nconfigured webhook endpoint. If the endpoint responds with a 200 OK response
\nstatus 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,
\nand excluded word lists checked against the secret (captured group if present, entire match if capture group is not present). Note that if
\nyour 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.
\nHere is how to setup a custom regex detector with verification server.
\nTruffleHog supports running a deeper analysis of a credential to view its permissions and the resources it has access to.
\ntrufflehog analyzeThis project exists thanks to all the people who contribute. [Contribute].
\n\nContributions are very welcome! Please see our contribution guidelines first.
\nWe no longer accept contributions to TruffleHog v2, but that code is available in the v2 branch.
We have published some documentation and tooling to get started on adding new secret detectors. Let's improve detection together!
\nCurrently, trufflehog is in heavy development and no guarantees can be made on
\nthe stability of the public APIs at this time.
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.