Searches through git repositories for secrets, digging deep into commit history and branches. This is effective at finding secrets accidentally committed.
Have questions? Feedback? Jump in slack and hang out with me
https://join.slack.com/t/trufflehog-community/shared_invite/zt-nzznzf8w-y1Lg4PnnLupzlYuwq_AUHA
truffleHog previously functioned by running entropy checks on git diffs. This functionality still exists, but high signal regex checks have been added, and the ability to suppress entropy checking has also been added.
truffleHog --regex --entropy=False https://github.com/dxa4481/truffleHog.gitor
truffleHog file:///user/dxa4481/codeprojects/truffleHog/With the --include_paths and --exclude_paths options, it is also possible to limit scanning to a subset of objects in the Git history by defining regular expressions (one per line) in a file to match the targeted object paths. To illustrate, see the example include and exclude files below:
include-patterns.txt:
src/
# lines beginning with "#" are treated as comments and are ignored
gradle/
# regexes must match the entire path, but can use python's regex syntax for
# case-insensitive matching and other advanced options
(?i).*\.(properties|conf|ini|txt|y(a)?ml)$
(.*/)?id_[rd]sa$exclude-patterns.txt:
(.*/)?\.classpath$
.*\.jmx$
(.*/)?test/(.*/)?resources/These filter files could then be applied by:
trufflehog --include_paths include-patterns.txt --exclude_paths exclude-patterns.txt file://path/to/my/repo.gitWith these filters, issues found in files in the root-level src directory would be reported, unless they had the .classpath or .jmx extension, or if they were found in the src/test/dev/resources/ directory, for example. Additional usage information is provided when calling trufflehog with the -h or --help options.
These features help cut down on noise, and makes the tool easier to shove into a devops pipeline.
pip install truffleHogCustom regexes can be added with the following flag --rules /path/to/rules. This should be a json file of the following format:
{
"RSA private key": "-----BEGIN EC PRIVATE KEY-----"
}Things like subdomain enumeration, s3 bucket detection, and other useful regexes highly custom to the situation can be added.
Feel free to also contribute high signal regexes upstream that you think will benefit the community. Things like Azure keys, Twilio keys, Google Compute keys, are welcome, provided a high signal regex can be constructed.
trufflehog's base rule set sources from https://github.com/dxa4481/truffleHogRegexes/blob/master/truffleHogRegexes/regexes.json
To explicitly allow particular secrets (e.g. self-signed keys used only for local testing) you can provide an allow list --allow /path/to/allow in the following format:
{
"local self signed test key": "-----BEGIN EC PRIVATE KEY-----\nfoobar123\n-----END EC PRIVATE KEY-----",
"git cherry pick SHAs": "regex:Cherry picked from .*",
"Public certificate MIIEexDD...XmWEX4AX": "key:MIIEexDD...XmWEX4AX"
}- Values beginning with
regex:will be used as regular expressions. Values without this will be literal, with some automatic conversions (e.g. flexible newlines). - Values beginning with
key:will use a custom regex to match a multi-line key or certificate which may include start and end lines-----BEGIN EC PRIVATE KEY-----/-----END EC PRIVATE KEY-----or-----BEGIN CERTIFICATE-----/-----END CERTIFICATE-----etc.
This module will go through the entire commit history of each branch, and check each diff from each commit, and check for secrets. This is both by regex and by entropy. For entropy checks, truffleHog will evaluate the shannon entropy for both the base64 char set and hexidecimal char set for every blob of text greater than 20 characters comprised of those character sets in each diff. If at any point a high entropy string >20 characters is detected, it will print to the screen.
usage: truffleHog.py [-h] [--json]
[--format {NONE,TERSE,TERSE_NC,FULL,FULL_NC,JSON}]
[--regex] [--rules RULES] [--allow ALLOW]
[--entropy DO_ENTROPY] [--since_commit SINCE_COMMIT]
[--max_depth MAX_DEPTH] [--branch BRANCH]
[-i INCLUDE_PATHS_FILE] [-x EXCLUDE_PATHS_FILE]
[--exclude_commits EXCLUDE_COMMITS_FILE]
[--repo_path REPO_PATH] [--cleanup]
[--log {CRITICAL,FATAL,ERROR,WARN,WARNING,INFO,DEBUG,NOTSET}]
[--log_file LOG_FILE] [--check CHECK_RULES]
git_url
Find secrets hidden in the depths of git.
positional arguments:
git_url URL for secret searching
optional arguments:
-h, --help show this help message and exit
--json Output in JSON format, equivalent to --format=JSON
--format {NONE,TERSE,TERSE_NC,FULL,FULL_NC,JSON}
Format for result output; NONE No output, TERSE First
line of commit message and only matching lines from
the diff, TERSE_NC First line of commit message and
only matching lines from the diff with no coloring,
FULL Entire commit message and entire diff, FULL_NC
Entire commit message and entire diff with no
coloring, JSON Entire commit message and entire diff
in JSON format
--regex Enable high signal regex checks
--rules RULES Ignore default regexes and source from json file
--allow ALLOW Explicitly allow regexes from json list file
--entropy DO_ENTROPY Enable entropy checks
--since_commit SINCE_COMMIT
Only scan from a given commit hash
--max_depth MAX_DEPTH
The max commit depth to go back when searching for
secrets
--branch BRANCH Name of the branch to be scanned
-i INCLUDE_PATHS_FILE, --include_paths INCLUDE_PATHS_FILE
File with regular expressions (one per line), at least
one of which must match a Git object path in order for
it to be scanned; lines starting with "#" are treated
as comments and are ignored. If empty or not provided
(default), all Git object paths are included unless
otherwise excluded via the --exclude_paths option.
-x EXCLUDE_PATHS_FILE, --exclude_paths EXCLUDE_PATHS_FILE
File with regular expressions (one per line), none of
which may match a Git object path in order for it to
be scanned; lines starting with "#" are treated as
comments and are ignored. If empty or not provided
(default), no Git object paths are excluded unless
effectively excluded via the --include_paths option.
--exclude_commits EXCLUDE_COMMITS_FILE
File with commit hashes (one per line). lines starting
with "#" are treated as comments and are ignored.
--repo_path REPO_PATH
Path to the cloned repo. If provided, git_url will not
be used
--cleanup Clean up all temporary result files
--log {CRITICAL,FATAL,ERROR,WARN,WARNING,INFO,DEBUG,NOTSET}
Set logging level
--log_file LOG_FILE Write log to file
--check CHECK_RULES Check rules
First, enter the directory containing the git repository
cd /path/to/gitTo launch the trufflehog with the docker image, run the following"
docker run --rm -v "$(pwd):/proj" dxa4481/trufflehog file:///proj-v mounts the current working dir (pwd) to the /proj dir in the Docker container
file:///proj references that very same /proj dir in the container (which is also set as the default working dir in the Dockerfile)
A way to detect and not scan binary diffsDon't rescan diffs if already looked at in another branchA since commit X featurePrint the file affected