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

Uploaded Python 2Python 3

File details

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

File metadata

  • Download URL: truffleHog3-2.0.0.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.0.tar.gz
Algorithm Hash digest
SHA256 16583d1f9b21bb6e1b6d8c1dff2d7b8f26db245a3eed34038847c9e4e772c4ea
MD5 3ea897a75261c63725dfeccb4226c448
BLAKE2b-256 e1f073777b9224a1bf0dcd5c4cbc9f24aeb23faa5892100052653bb153622195

See more details on using hashes here.

File details

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

File metadata

  • Download URL: truffleHog3-2.0.0-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.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 eb14dd49b220838ce84cd58f22f9568e9cff6a60edfb6c7d9a032feff58bd4d9
MD5 7c3bbc443ae9994fc8a705796fd9a263
BLAKE2b-256 390fa3f36c47ac965a4db48cbdff1227c22e3ee92d86a5397b080107600e16ae

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