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
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
credsleuth-0.0.19.tar.gz
(6.5 kB
view details)
Built Distribution
File details
Details for the file credsleuth-0.0.19.tar.gz
.
File metadata
- Download URL: credsleuth-0.0.19.tar.gz
- Upload date:
- Size: 6.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.18.4 setuptools/18.5 requests-toolbelt/0.8.0 tqdm/4.27.0 CPython/2.7.10
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 |
6ee16a653740de484bf332d83dccf3c188255d4955e1b41d6c205b8707b13d53
|
|
MD5 |
7ab5199d3f0e4e2bbab4e35e79448a27
|
|
BLAKE2b-256 |
04605ff3a48fe2cb42bc8b015ac58688dde0951fec58e3ac939dd5fd61021338
|
File details
Details for the file credsleuth-0.0.19-py3-none-any.whl
.
File metadata
- Download URL: credsleuth-0.0.19-py3-none-any.whl
- Upload date:
- Size: 7.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.18.4 setuptools/18.5 requests-toolbelt/0.8.0 tqdm/4.27.0 CPython/2.7.10
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 |
e5b06698aa69e1536c87888c87cfe19c9d44be4222c583c8c58661f37e15876c
|
|
MD5 |
42e728f03d6e57ef56d2c7c96bd00c1c
|
|
BLAKE2b-256 |
b78e689cc93d366544cc43ebbaa947fb669fe3ab55d3a15223222241812db1cc
|