Skip to main content

A Python security scanner for hardcoded secrets and API keys.

Project description

Sherlock Scanner

Sherlock is a Python-based security scanner designed to detect hardcoded secrets and API keys in files and directories.

Features

  • ✅ Scans for API keys, passwords, and secrets in codebases.
  • ✅ CLI-based tool for easy use in CI/CD pipelines.
  • ✅ Recursively scans files and directories.

Installation

You can install Sherlock directly from PyPI:

pip install sherlock-scanner

Scan the current directory for secrets

sherlock .

Scan a specific folder

sherlock /path/to/code

Example Output:

⚠️ Security issues found:
[
  {
    "file": "example.py",
    "issue": "API Key found",
    "severity": "HIGH"
  }
]

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

sherlock_scanner-1.0.1.tar.gz (2.5 kB view details)

Uploaded Source

Built Distribution

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

sherlock_scanner-1.0.1-py3-none-any.whl (3.1 kB view details)

Uploaded Python 3

File details

Details for the file sherlock_scanner-1.0.1.tar.gz.

File metadata

  • Download URL: sherlock_scanner-1.0.1.tar.gz
  • Upload date:
  • Size: 2.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.12.3

File hashes

Hashes for sherlock_scanner-1.0.1.tar.gz
Algorithm Hash digest
SHA256 5c38e238fdecdbbfff36a1db21fc033ade44c73b87806ff96cfb72a9c6c979dd
MD5 ef0b5bffecb20a0dd320254fb7c6fc85
BLAKE2b-256 722657427107e44c988298ea2f3d9e8b3375345550a26aec9feec9f89ef0784e

See more details on using hashes here.

File details

Details for the file sherlock_scanner-1.0.1-py3-none-any.whl.

File metadata

File hashes

Hashes for sherlock_scanner-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 3eb075f0bcd2944e699bd643f0eebb27d9731dbcddc68f0b5b52de51dd7c31a4
MD5 3e7f1efd242fc1470f8a89cf36eb2c24
BLAKE2b-256 0da4c5155edefac60085778082200fa31ca9513fc730a6a9118517387a74345e

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