Skip to main content

Find secrets in your codebase.

Project description

Package Version Python Version Downloads Build Status Code Coverage

truffleHog3

This is an enhanced version of truffleHog scanner

Report Preview

Important

TruffleHog 2.x is not backwards compatible with 1.x branch, see new trufflehog.yaml and Help

New

  • Python 3.6
  • flake8 compliant code
  • output to file in different formats: text, JSON, YAML, HTML
  • option to disable Git history checks - scan simple files/directories
  • option to exclude files/directories, see trufflehog.yaml
  • config file support with automatic detection in source code directory

Installation

Package is available on PyPI

pip install truffleHog3

Customizing

List of default regexes was moved into repository, see rules.yaml

Help

usage: trufflehog3 [options] source

Find secrets in your codebase.

positional arguments:
  source             URLs or paths to local folders for secret searching

optional arguments:
  -h, --help         show this help message and exit
  -v, --verbose      enable verbose logging {-v, -vv, -vvv}
  -c, --config       path to config file
  -o, --output       write report to file
  -f, --format       output format {text, json, yaml, html}
  -r, --rules        ignore default regexes and source from file
  -R, --render-html  render HTML report from JSON or YAML
  --branch           name of the repository branch to be scanned
  --since-commit     scan starting from a given commit hash
  --skip-strings     skip matching strings
  --skip-paths       skip paths matching regex
  --line-numbers     include line numbers in match
  --max-depth        max commit depth for searching
  --no-regex         disable high signal regex checks
  --no-entropy       disable entropy checks
  --no-history       disable commit history check
  --no-current       disable current status check

Thanks

Special thanks to Dylan Ayrey (@dxa4481), developer of the original truffleHog scanner

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

truffleHog3-2.0.6.tar.gz (19.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

truffleHog3-2.0.6-py2.py3-none-any.whl (21.4 kB view details)

Uploaded Python 2Python 3

File details

Details for the file truffleHog3-2.0.6.tar.gz.

File metadata

  • Download URL: truffleHog3-2.0.6.tar.gz
  • Upload date:
  • Size: 19.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.7.0 requests/2.25.1 setuptools/56.0.0 requests-toolbelt/0.9.1 tqdm/4.51.0 CPython/3.9.5

File hashes

Hashes for truffleHog3-2.0.6.tar.gz
Algorithm Hash digest
SHA256 083de54e9b11dad0f5c15c0ec4dfba9bb9f695468432aed38d6d2e16af520090
MD5 657f393fa6f1f494c30eec38643e4e30
BLAKE2b-256 36d448775b94dcd32673f107dfd7f33b2fd65c56aa846c7b1f4efe2070597366

See more details on using hashes here.

File details

Details for the file truffleHog3-2.0.6-py2.py3-none-any.whl.

File metadata

  • Download URL: truffleHog3-2.0.6-py2.py3-none-any.whl
  • Upload date:
  • Size: 21.4 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.7.0 requests/2.25.1 setuptools/56.0.0 requests-toolbelt/0.9.1 tqdm/4.51.0 CPython/3.9.5

File hashes

Hashes for truffleHog3-2.0.6-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 0d7f5282b3bb0df0497cf927b098ba60fd3bcb2f93f1a9eebe5fd9a401913ed9
MD5 4dac12465e2def816b2a68c855f5f940
BLAKE2b-256 e42a82c51f799b1828cd89b06f46435301e91086ea320e812199fb7ac758a03b

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page