Skip to main content

Find secrets in your codebase.

Project description

Package Version Python Version Build Status Code Coverage Downloads Known Vulnerabilities

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
  --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.1.tar.gz (12.7 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.1-py2.py3-none-any.whl (21.4 kB view details)

Uploaded Python 2Python 3

File details

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

File metadata

  • Download URL: truffleHog3-2.0.1.tar.gz
  • Upload date:
  • Size: 12.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.23.0 setuptools/45.2.0 requests-toolbelt/0.9.1 tqdm/4.43.0 CPython/3.7.5

File hashes

Hashes for truffleHog3-2.0.1.tar.gz
Algorithm Hash digest
SHA256 e6761025a64ad8e5f432b73df00673c3143d951398701a123214923b6765001d
MD5 be91acb107d7e7536f69d69b77980f98
BLAKE2b-256 9e9e43c621f30004648c99bf674d586c76f31b973255c7705d8b0ac52ffc030a

See more details on using hashes here.

File details

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

File metadata

  • Download URL: truffleHog3-2.0.1-py2.py3-none-any.whl
  • Upload date:
  • Size: 21.4 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.23.0 setuptools/45.2.0 requests-toolbelt/0.9.1 tqdm/4.43.0 CPython/3.7.5

File hashes

Hashes for truffleHog3-2.0.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 fe8ce9e97c707a7b7aa2ece7006fe0491cd73a2f9c5eea96229e1f0b706741ec
MD5 4c46a3d625517dda281c5485c8a585c6
BLAKE2b-256 ae11f28f5f85a09533e3c8922021028386443826637c4078c2bda9c17e813ffa

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