Name:trufflehog
Category:Static Code Analysis
Publisher:trickest
Created:6/23/2021
Container:quay.io/trickest/trufflehog:v3.89.2
Output Type:
License:Unknown

Parameters

key
string
--keyS3 key used to authenticate.
org
string
required
--orgGitHub/GitLab organization to scan.
bare
boolean
--bareScan bare repository (e.g. useful while using in pre-receive hooks)
file
file
required
Path to file to scan (must use the `filesystem` mode)
json
boolean
--jsonOutput in JSON format.
mode
string
required
Scan mode (available options: git, github, gitlab, filesystem, s3, gcs, circleci, docker, travisci, postman, elasticsearch, jenkins)
repo
string
required
--repoGitHub/GitLab repository to scan.
debug
boolean
--debugRun in debug mode.
image
string
required
--imageDocker image to scan. Image registry is assumed.
nodes
string
--nodesElasticsearch nodes
token
string
required
--tokenAuthentication token
trace
boolean
--traceRun in trace mode.
branch
string
--branchBranch to scan.
bucket
string
--bucketName of S3 bucket to scan.
config
file
--configPath to configuration file.
secret
string
--secretS3 secret used to authenticate.
api-key
boolean
--api-keyElasticsearch API key.
git-url
string
required
Git repository URL. https://, file://, or ssh:// schema expected (must use the `git` mode)
cloud-id
boolean
--cloud-idElasticsearch cloud ID.
endpoint
string
--endpointGitHub/GitLab endpoint
password
boolean
--passwordAuthentication password
role-arn
string
--role-arnSpecify the ARN of an IAM role to assume for scanning.
username
boolean
--usernameAuthentication username
verifier
string
--verifierSet custom verification endpoints.
directory
folder
required
Path to directory to scan (must use the `filesystem` mode)
max-depth
string
--max-depthMaximum depth of commits to scan.
no-update
boolean
--no-updateDon't check for updates.
project-id
boolean
--project-idGCS project ID used to authenticate. Can NOT be used with unauth scan.
query-json
boolean
--query-jsonFilters the documents to search
concurrency
string
--concurrencyNumber of concurrent workers (default: 1).
environment
string
--environmentPostman environment to scan. You can repeat this flag.
json-legacy
boolean
--json-legacyUse the pre-v3.0 JSON format. Only works with git, gitlab, and github sources.
pr-comments
boolean
--pr-commentsInclude pull request descriptions and comments in scan.
since-commit
string
--since-commitCommit to start scan from.
without-auth
boolean
--without-authScan GCS buckets without authentication. This will only work for public buckets
workspace-id
string
--workspace-idPostman workspace ID to scan. You can repeat this flag.
collection-id
string
--collection-idPostman collection ID to scan. You can repeat this flag.
exclude-globs
string
--exclude-globsComma separated list of globs to exclude in scan. This option filters at the `git log` level, resulting in faster scans.
exclude-paths
file
--exclude-pathsPath to file with newline separated regexes for files to exclude in scan.
exclude-repos
string
--exclude-reposRepositories to include in an org scan. This can also be a glob pattern. Must use Github repo full name. Example: trufflesecurity/trufflehog, trufflesecurity/t*
gist-comments
boolean
--gist-commentsInclude gist comments in scan.
include-forks
boolean
--include-forksInclude forks in scan.
include-paths
file
--include-pathsPath to file with newline separated regexes for files to include in scan.
include-repos
string
--include-reposRepositories to include in an org scan. This can also be a glob pattern. Must use Github repo full name. Example: trufflesecurity/trufflehog, trufflesecurity/t*
index-pattern
boolean
--index-patternFilters the indices to search
only-verified
boolean
--only-verifiedOnly output verified results.
service-token
boolean
--service-tokenElasticsearch service token.
session-token
string
--session-tokenS3 session token used to authenticate temporary credentials.
filter-entropy
string
--filter-entropyFilter unverified results with Shannon entropy. Start with 3.0.
github-actions
boolean
--github-actionsOutput in GitHub Actions format.
issue-comments
boolean
--issue-commentsInclude issue descriptions and comments in scan.
archive-timeout
string
--archive-timeoutMaximum time to spend extracting an archive.
exclude-buckets
string
--exclude-bucketsBuckets to exclude from scan. Comma separated list of buckets. Globs are supported
exclude-objects
string
--exclude-objectsObjects to exclude from scan. Comma separated list of buckets. Globs are supported
include-buckets
string
--include-bucketsBuckets to scan. Comma separated list of buckets. Globs are supported
include-members
boolean
--include-membersInclude organization member repositories in scan.
include-objects
string
--include-objectsObjects to scan. Comma separated list of buckets. Globs are supported
max-object-size
string
--max-object-sizeMaximum size of objects to scan. Objects larger than this will be skipped. (Byte units eg. 512B, 2KB, 4MB)
no-verification
boolean
--no-verificationDon't verify the results
service-account
file
--service-accountPath to GCS service account JSON file.
since-timestamp
boolean
--since-timestamp--since-timestamp
workspace-paths
file
--workspace-pathsPath to Postman workspaces.
archive-max-size
string
--archive-max-sizeMaximum size of archive to scan. (Byte units eg. 512B, 2KB, 4MB)
best-effort-scan
boolean
--best-effort-scanAttempts to continuously scan a cluster
collection-paths
file
--collection-pathsPath to Postman collections.
archive-max-depth
string
--archive-max-depthMaximum depth of archive to scan.
cloud-environment
boolean
--cloud-environmentUse default IAM credentials in cloud environment.
environment-paths
file
--environment-pathsPath to Postman environments.
exclude-detectors
string
--exclude-detectorsComma 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.
filter-unverified
boolean
--filter-unverifiedOnly output first unverified result per chunk per detector if there are more than one results.
include-detectors
string
--include-detectorsComma separated list of detector types to include. Protobuf name or IDs may be used, as well as ranges.
exclude-environments
string
--exclude-environmentsEnvironment to exclude from scan. You can repeat this flag.
include-environments
string
--include-environmentsEnvironment to include in scan. You can repeat this flag.
exclude-collection-id
string
--exclude-collection-idCollection ID to exclude from scan. You can repeat this flag.
include-collection-id
string
--include-collection-idCollection ID to include in scan. You can repeat this flag.
--print-avg-detector-timePrint the average time spent on each detector.