Skip to main content

A rule based library to help identify credentials and secrets in files and strings.

Project description

Credential Sleuth

A rule driven library for detecting secrets and credentials within files and strings.

Simple Usage

Finding secrets in a string:

import credsleuth

data = """
Hello, world
Password=123
aws_access_key_id = AKIAIOSFODNN7EXAMPLE
Goodbye
"""
print(credsleuth.check_string(data))

Finding secrets in a file:

import credsleuth

print(credsleuth.check_file("filename.txt"))

Command line usage

credsleuth filename.txt

Advanced Usage

Customizing configuration

import credsleuth

config = credsleuth.ConfigEngine()
config.verbose = True
config.rules_file = 'custom_rules.json'

credsleuth.check_file('filename.txt', config)

Installation

pip install --user credsleuth

Writing Rules

See rules.json for an example in extending rules definitions.

Todo

  • Add some comments to codebase
  • Add pretty output options for command line execution.
  • Write a proper read me.
  • Build model to detect credentials based upon entropy
  • Search multiple files

Project details


Download files

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

Files for credsleuth, version 0.0.19
Filename, size File type Python version Upload date Hashes
Filename, size credsleuth-0.0.19-py3-none-any.whl (7.1 kB) File type Wheel Python version py3 Upload date Hashes View hashes
Filename, size credsleuth-0.0.19.tar.gz (6.5 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page