🔍 A powerful desktop GUI application for scanning GitHub repositories and commit history to detect accidentally committed sensitive information like API keys, passwords, tokens, and other security vulnerabilities.
🚀 Fast • 🎯 Accurate • 🔒 Secure • 🎨 User-Friendly
⚠️ IMPORTANT: GitGuard is a defensive security tool designed to help users identify accidentally committed sensitive information in their own repositories. Never use this tool to scan repositories you don't own or have explicit permission to analyze.
|
|
🔑 API Keys & Tokens (Click to expand)
| Service | Pattern Example | Risk Level |
|---|---|---|
| 🔶 AWS Access Keys | AKIA[0-9A-Z]{16} |
🔴 Critical |
| 🐙 GitHub PAT | ghp_[a-zA-Z0-9]{36} |
🔴 Critical |
| 🔥 Firebase Keys | AIza[0-9A-Za-z-_]{35} |
🟠 High |
| 💳 Stripe API | sk_live_, sk_test_ |
🔴 Critical |
| 📧 SendGrid | SG.[0-9A-Za-z-_]{22} |
🟠 High |
| 📱 Twilio | AC[a-f0-9]{32} |
🟠 High |
| 💰 PayPal | EO[0-9A-Za-z-_]{50} |
🔴 Critical |
| 🛍️ Shopify | shpat_[a-zA-Z0-9]{32} |
🟠 High |
🗃️ Database Credentials (Click to expand)
- 🍃 MongoDB:
mongodb://[user:pass@]host:port/db - 🐬 MySQL:
mysql://[user:pass@]host:port/db - 🐘 PostgreSQL:
postgresql://[user:pass@]host:port/db - 🗄️ Redis: Connection strings with embedded credentials
- 🔗 Generic DB URLs: Any connection URL with embedded credentials
🔐 Private Keys & Certificates (Click to expand)
- 🔑 RSA Private Keys:
-----BEGIN RSA PRIVATE KEY----- - 🔒 SSH Private Keys:
-----BEGIN OPENSSH PRIVATE KEY----- - 🛡️ PGP Private Keys:
-----BEGIN PGP PRIVATE KEY----- - 📜 SSL/TLS Certificates: Various certificate formats
- 🎫 JWT Tokens: JSON Web Tokens with high entropy
🌍 Environment Variables (Click to expand)
- ⚡ Common Secrets:
SECRET,PASSWORD,TOKEN,KEY - ☁️ AWS Variables:
AWS_ACCESS_KEY,AWS_SECRET_KEY - 🔧 API Keys:
.envformat API keys and tokens - 🐳 Docker Secrets: Docker Compose environment secrets
- ☸️ Kubernetes: Secret manifests and config maps
|
|
|
- ⚔️ Basic Auth False Positives: Enhanced filtering for game content ("Basic Sword" vs authentication)
- 🧮 Checksum File Handling: Proper exclusion of Go package checksums (go.sum) from secret detection
- 🔍 Template Pattern Recognition: Filter environment variable templates like
${JWT_SECRET} - 🗃️ Database Credential Filtering: Smart detection of test/development database connections
# Clone the repository
git clone https://github.com/dev-alt/GitGuard.git
cd GitGuard
# Install dependencies
pip install -r requirements.txt
# Launch GitGuard
python src/gui.py- 🔐 Authenticate: Enter your GitHub token in the Authentication tab
- 📂 Load Repositories: Browse and select repositories from your GitHub account
- 🔍 Configure Scan: Choose scan depth and configure detection patterns
▶️ Start Scanning: Click scan and watch real-time progress- 📊 Review Results: Export results to HTML, CSV, or JSON formats
🛠️ Create Your Own Detection Rules!
GitGuard includes a powerful GUI-based pattern editor for creating custom detection rules:
# Example Custom Pattern
Name: Internal API Key
Description: Company-specific API key format
Pattern: MYCO_API_[A-Za-z0-9]{32}
Risk Level: HIGHFeatures:
- 🎯 Real-time Regex Testing: Test patterns before saving
- 📚 Pattern Library: Import/Export pattern collections
- 🔧 JSON Export/Import: Share patterns across installations
- ✅ Validation: Automatic pattern validation and suggestions
⚙️ Scanning Configuration (Click to expand)
- 🏄 Surface (Latest Commit): Fast scanning of current repository state
- 🏊 Deep (Full History): Complete commit history analysis
- 🏗️ Custom: User-defined commit range and file filtering
- 📊 Batch Processing: Configure concurrent file operations
- 🎯 File Prioritization: Scan high-risk files first
- 💾 Intelligent Caching: Skip unchanged repositories
- ⏱️ Timeout Controls: Prevent hung operations
📊 Export Formats (Click to expand)
- 🌐 HTML: Interactive reports with charts and statistics
- 📄 CSV: Spreadsheet-compatible tabular data
- 📝 JSON: Structured data for programmatic analysis
- 📈 Risk Visualization: Color-coded severity indicators
- 📊 Statistical Analysis: Finding counts by type and severity
- 🔗 Interactive Navigation: Click-to-view source code
- 📅 Metadata: Scan configuration and timestamp information
We welcome contributions! Here's how you can help:
- 🍴 Fork the repository
- 🌿 Create a feature branch (
git checkout -b feature/amazing-feature) - 💾 Commit your changes (
git commit -m 'Add amazing feature') - 🚀 Push to branch (
git push origin feature/amazing-feature) - 📮 Open a Pull Request
This project is licensed under the MIT License - see the LICENSE file for details.
- 🐙 GitHub API: For providing excellent repository access
- 🐍 Python Community: For the amazing ecosystem and libraries
- 🔐 Security Researchers: For inspiration and pattern identification
- 👥 Open Source Community: For feedback and contributions
