Skip to content

Latest commit

 

History

History
104 lines (76 loc) · 4.03 KB

README.md

File metadata and controls

104 lines (76 loc) · 4.03 KB

API_SNATCHER

A Security Research Tool for Detecting Exposed API Keys

license last-commit repo-top-language repo-language-count

📍 Overview

API_SNATCHER is an ethical security research tool designed to help organizations and developers identify accidentally exposed API keys in public repositories. By detecting potential security risks early, we help prevent unauthorized access and protect sensitive resources. This tool is intended for security researchers, penetration testers, and organizations conducting security audits of their own codebases.

👾 Features

  • Ethical Key Detection: Scans public repositories for potentially exposed API keys
  • Smart Filtering: Excludes example keys and placeholder patterns to reduce false positives
  • Rate Limit Friendly: Respects GitHub API rate limits to ensure sustainable usage
  • Responsible Disclosure: Includes guidelines for ethically reporting found credentials
  • Customizable Search: Configurable maximum results and search patterns
  • Random Result Selection: Helps identify different exposed keys in each scan

📁 Project Structure

└── api_snatcher/
    ├── main.py              # Core scanning logic
    └── requirements.txt     # Project dependencies

🚀 Getting Started

☑️ Prerequisites

  • Python 3.7+
  • GitHub Personal Access Token
  • Understanding of responsible disclosure practices

⚙️ Installation

  1. Clone the repository:
git clone https://github.com/mp3skater/api_snatcher
  1. Install dependencies:
pip install -r requirements.txt

🤖 Usage

Run the scanner with your GitHub token:

from main import GitHubKeyScanner

scanner = GitHubKeyScanner(github_token="your_github_token")
findings = scanner.search_for_keys(max_results=5)

🔰 Contributing

We welcome contributions that enhance the tool's security research capabilities while maintaining ethical standards. Please follow these guidelines:

  1. Focus on improving detection accuracy
  2. Add features that help prevent false positives
  3. Enhance responsible disclosure capabilities
  4. Improve documentation and usage guidelines

🚨 Responsible Usage Guidelines

  1. Only scan public repositories you have permission to audit
  2. Immediately report found credentials to repository owners
  3. Never use or test discovered API keys
  4. Follow responsible disclosure practices
  5. Document all findings for proper reporting

📌 Project Roadmap

  • Initial key detection implementation
  • Add support for multiple API key patterns
  • Implement automated responsible disclosure notifications
  • Create detailed security reporting templates
  • Add rate limit optimization features

🎗 License

This project is released under the MIT License to promote open security research while maintaining ethical guidelines.

🙌 Acknowledgments

  • Security research community
  • GitHub API documentation
  • Open source security tools
  • Responsible disclosure frameworks

Note: This tool is designed for security research and helping organizations identify their exposed credentials. Always obtain proper authorization before conducting security research and follow responsible disclosure practices.