credlock 1.0.0__tar.gz

credlock-1.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Your Name
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

credlock-1.0.0/PKG-INFO

@@ -0,0 +1,317 @@
+Metadata-Version: 2.4
+Name: credlock
+Version: 1.0.0
+Summary: 🔐 Prevent accidental credential commits to Git
+Home-page: https://github.com/yourusername/credlock
+Author: Your Name
+Author-email: your.email@example.com
+Project-URL: Bug Reports, https://github.com/yourusername/credlock/issues
+Project-URL: Source, https://github.com/yourusername/credlock
+Keywords: security credential secret git pre-commit detection
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Software Development :: Version Control
+Classifier: Topic :: Security
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: typer[all]>=0.9.0
+Requires-Dist: rich>=13.7.0
+Requires-Dist: pyyaml>=6.0
+Provides-Extra: dev
+Requires-Dist: pytest>=7.4.0; extra == "dev"
+Requires-Dist: pytest-cov>=4.1.0; extra == "dev"
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: license-file
+Dynamic: project-url
+Dynamic: provides-extra
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+# CredLock 🔐
+
+**Prevent accidental credential commits to Git**
+
+CredLock is an automatic secret detection tool that scans your code before pushing to GitHub. It detects 50+ types of secrets (API keys, passwords, tokens, private keys) and blocks commits if sensitive data is found.
+
+## 🎯 Features
+
+- ✅ **50+ Detection Patterns**: Detects AWS keys, API tokens, passwords, database URLs, private keys, JWT tokens, and more
+- ✅ **Automatic Git Integration**: Pre-commit hook runs automatically before every push
+- ✅ **Zero Configuration**: Works out of the box, no complex setup
+- ✅ **Beautiful Terminal Output**: Color-coded, formatted scan results
+- ✅ **Scan History**: Tracks all scans locally in JSON format
+- ✅ **Custom Patterns**: Add your own detection rules
+- ✅ **Cross-Platform**: Works on macOS, Linux, and Windows
+- ✅ **Fast**: Scans directories in milliseconds
+
+## 📦 Installation
+
+### From PyPI (Recommended)
+```bash
+pip install credlock
+```
+
+### From Source
+```bash
+git clone https://github.com/yourusername/credlock.git
+cd credlock
+pip install -e .
+```
+
+## 🚀 Quick Start
+
+### 1. Install CredLock
+```bash
+pip install credlock
+```
+
+### 2. Setup Git Hook in Your Project
+```bash
+cd your-project
+credlock setup-git
+
+✅ Git pre-commit hook installed!
+```
+
+### 3. That's It!
+Now every time you `git push`, CredLock will automatically scan for secrets:
+
+```bash
+$ git push origin main
+
+🔍 Running CredLock...
+✅ No secrets found. Push allowed!
+```
+
+## 📋 Commands
+
+### Scan Directory
+```bash
+credlock scan              # Scan current directory
+credlock scan /path/to/dir # Scan specific directory
+```
+
+### View Scan History
+```bash
+credlock history           # Show last 10 scans
+credlock history --limit=5 # Show last 5 scans
+```
+
+### Configure Settings
+```bash
+credlock configure         # Interactive configuration
+```
+
+### Show Version
+```bash
+credlock --version
+```
+
+## 🔍 What Does It Detect?
+
+### AWS Credentials
+- AWS Access Key ID: `AKIA...`
+- AWS Secret Access Key
+- AWS Config files
+
+### API Keys
+- Generic API keys
+- GitHub tokens
+- Stripe keys (live and test)
+- Firebase keys
+- SendGrid API keys
+
+### Passwords & Secrets
+- Password assignments
+- Database URLs (MySQL, PostgreSQL, MongoDB)
+- Private SSH keys
+- JWT tokens
+
+### Communication Tokens
+- Slack tokens
+- Discord webhooks
+- Telegram tokens
+
+### Cloud Providers
+- Google Cloud credentials
+- Azure keys
+- DigitalOcean tokens
+- Heroku API keys
+
+### More
+- Environment variables with secrets
+- Authorization headers
+- OAuth tokens
+- **50+ total patterns**
+
+## 📝 Example Output
+
+### When Secrets Are Found
+```
+🔍 Scanning current directory...
+
+⛔ SECRETS DETECTED! Found 3 potential secrets
+
+📄 .env (2 secrets)
+  Line 2:  [aws_access_key] AWS_ACCESS_KEY_ID=AKIA...
+  Line 3:  [database_password] DB_PASSWORD=mysecret123
+
+📄 src/config.js (1 secret)
+  Line 45: [stripe_key] API_KEY = "sk_live_4eC39HqLyjWDar..."
+
+❌ PUSH BLOCKED - 3 SECRETS FOUND
+
+Recommendations:
+1. Move secrets to .env file
+2. Add .env to .gitignore
+3. Use environment variables in code
+
+$ echo ".env" >> .gitignore
+$ git rm --cached .env
+$ git commit --amend
+$ git push origin main
+```
+
+### When No Secrets Found
+```
+🔍 Scanning current directory...
+✅ No secrets found. Scan clean!
+
+Files scanned: 15
+Duration: 0.234 seconds
+```
+
+## ⚙️ Configuration
+
+CredLock is configured via `~/.credlock/config.yaml`:
+
+```yaml
+patterns_enabled: 50
+custom_patterns: {}
+ignored_files:
+  - .git/*
+  - node_modules/*
+  - __pycache__/*
+auto_scan: true
+```
+
+### Add Custom Pattern
+```bash
+credlock configure
+
+Choose: 1 (Add custom pattern)
+Pattern name: my_api_key
+Regex: MY_KEY_[A-Z0-9]{32}
+```
+
+## 🔒 Security Notes
+
+- **Secrets are NOT stored**: CredLock only detects and blocks commits
+- **No network calls**: Everything runs locally
+- **Scan history is local**: Stored in `~/.credlock/history.json`
+- **No data collection**: Your code never leaves your machine
+
+## 📚 How It Works
+
+1. **Pre-commit Hook**: Git runs CredLock before every push
+2. **File Scanning**: Reads all project files (respects .gitignore)
+3. **Pattern Matching**: Uses 50+ regex patterns to detect secrets
+4. **Reporting**: Shows findings with file names and line numbers
+5. **Exit Code**: Returns 1 if secrets found (blocks push), 0 if clean
+
+## 🐛 Troubleshooting
+
+### "credlock: command not found"
+Ensure CredLock is installed globally:
+```bash
+pip install credlock
+which credlock  # Should show /path/to/credlock
+```
+
+### Pre-commit hook not running
+Check hook is installed and executable:
+```bash
+cat .git/hooks/pre-commit
+chmod +x .git/hooks/pre-commit
+```
+
+### False positives (normal code flagged as secret)
+Add custom ignore patterns in config:
+```bash
+credlock configure
+# Choose to disable specific patterns
+```
+
+### Want to force push anyway?
+You can temporarily bypass CredLock:
+```bash
+# This skips the pre-commit hook
+git push --no-verify
+```
+
+But don't make this a habit! 🚨
+
+## 📊 Performance
+
+- Scans 100+ files in **<1 second**
+- Minimal CPU/memory overhead
+- No impact on normal Git workflow
+
+## 🤝 Contributing
+
+Found a bug? Want to add more patterns? Contributions welcome!
+
+1. Fork the repository
+2. Create a branch: `git checkout -b feature/new-pattern`
+3. Add tests for new patterns
+4. Submit a pull request
+
+## 📜 License
+
+MIT License - see LICENSE file for details
+
+## ⭐ Support
+
+- **Documentation**: Read this README
+- **Issues**: Report bugs on GitHub
+- **Discussions**: Ask questions in GitHub Discussions
+
+## 🎓 Interview Points
+
+When asked about CredLock:
+
+- **"What problem does it solve?"** → Prevents accidental secret commits, which happen all the time
+- **"How does it work?"** → Git pre-commit hook + regex pattern matching
+- **"Why local storage?"** → Fast, no dependencies, users control their data
+- **"How is it different?"** → Better UX than existing tools, modern CLI, easy setup
+- **"What's the hardest part?"** → Balancing security (not too many patterns) with usability (not too many false positives)
+
+## 📈 Future Enhancements
+
+- [ ] Team shared config (EnvVault integration)
+- [ ] Real-time monitoring dashboard
+- [ ] Slack/email notifications
+- [ ] Repository statistics
+- [ ] CI/CD pipeline integration
+- [ ] Custom rule templates
+
+---
+
+Made with ❤️ for developers who value security
+
+**Star this repo if you found it useful!** ⭐

credlock-1.0.0/README.md

@@ -0,0 +1,273 @@
+# CredLock 🔐
+
+**Prevent accidental credential commits to Git**
+
+CredLock is an automatic secret detection tool that scans your code before pushing to GitHub. It detects 50+ types of secrets (API keys, passwords, tokens, private keys) and blocks commits if sensitive data is found.
+
+## 🎯 Features
+
+- ✅ **50+ Detection Patterns**: Detects AWS keys, API tokens, passwords, database URLs, private keys, JWT tokens, and more
+- ✅ **Automatic Git Integration**: Pre-commit hook runs automatically before every push
+- ✅ **Zero Configuration**: Works out of the box, no complex setup
+- ✅ **Beautiful Terminal Output**: Color-coded, formatted scan results
+- ✅ **Scan History**: Tracks all scans locally in JSON format
+- ✅ **Custom Patterns**: Add your own detection rules
+- ✅ **Cross-Platform**: Works on macOS, Linux, and Windows
+- ✅ **Fast**: Scans directories in milliseconds
+
+## 📦 Installation
+
+### From PyPI (Recommended)
+```bash
+pip install credlock
+```
+
+### From Source
+```bash
+git clone https://github.com/yourusername/credlock.git
+cd credlock
+pip install -e .
+```
+
+## 🚀 Quick Start
+
+### 1. Install CredLock
+```bash
+pip install credlock
+```
+
+### 2. Setup Git Hook in Your Project
+```bash
+cd your-project
+credlock setup-git
+
+✅ Git pre-commit hook installed!
+```
+
+### 3. That's It!
+Now every time you `git push`, CredLock will automatically scan for secrets:
+
+```bash
+$ git push origin main
+
+🔍 Running CredLock...
+✅ No secrets found. Push allowed!
+```
+
+## 📋 Commands
+
+### Scan Directory
+```bash
+credlock scan              # Scan current directory
+credlock scan /path/to/dir # Scan specific directory
+```
+
+### View Scan History
+```bash
+credlock history           # Show last 10 scans
+credlock history --limit=5 # Show last 5 scans
+```
+
+### Configure Settings
+```bash
+credlock configure         # Interactive configuration
+```
+
+### Show Version
+```bash
+credlock --version
+```
+
+## 🔍 What Does It Detect?
+
+### AWS Credentials
+- AWS Access Key ID: `AKIA...`
+- AWS Secret Access Key
+- AWS Config files
+
+### API Keys
+- Generic API keys
+- GitHub tokens
+- Stripe keys (live and test)
+- Firebase keys
+- SendGrid API keys
+
+### Passwords & Secrets
+- Password assignments
+- Database URLs (MySQL, PostgreSQL, MongoDB)
+- Private SSH keys
+- JWT tokens
+
+### Communication Tokens
+- Slack tokens
+- Discord webhooks
+- Telegram tokens
+
+### Cloud Providers
+- Google Cloud credentials
+- Azure keys
+- DigitalOcean tokens
+- Heroku API keys
+
+### More
+- Environment variables with secrets
+- Authorization headers
+- OAuth tokens
+- **50+ total patterns**
+
+## 📝 Example Output
+
+### When Secrets Are Found
+```
+🔍 Scanning current directory...
+
+⛔ SECRETS DETECTED! Found 3 potential secrets
+
+📄 .env (2 secrets)
+  Line 2:  [aws_access_key] AWS_ACCESS_KEY_ID=AKIA...
+  Line 3:  [database_password] DB_PASSWORD=mysecret123
+
+📄 src/config.js (1 secret)
+  Line 45: [stripe_key] API_KEY = "sk_live_4eC39HqLyjWDar..."
+
+❌ PUSH BLOCKED - 3 SECRETS FOUND
+
+Recommendations:
+1. Move secrets to .env file
+2. Add .env to .gitignore
+3. Use environment variables in code
+
+$ echo ".env" >> .gitignore
+$ git rm --cached .env
+$ git commit --amend
+$ git push origin main
+```
+
+### When No Secrets Found
+```
+🔍 Scanning current directory...
+✅ No secrets found. Scan clean!
+
+Files scanned: 15
+Duration: 0.234 seconds
+```
+
+## ⚙️ Configuration
+
+CredLock is configured via `~/.credlock/config.yaml`:
+
+```yaml
+patterns_enabled: 50
+custom_patterns: {}
+ignored_files:
+  - .git/*
+  - node_modules/*
+  - __pycache__/*
+auto_scan: true
+```
+
+### Add Custom Pattern
+```bash
+credlock configure
+
+Choose: 1 (Add custom pattern)
+Pattern name: my_api_key
+Regex: MY_KEY_[A-Z0-9]{32}
+```
+
+## 🔒 Security Notes
+
+- **Secrets are NOT stored**: CredLock only detects and blocks commits
+- **No network calls**: Everything runs locally
+- **Scan history is local**: Stored in `~/.credlock/history.json`
+- **No data collection**: Your code never leaves your machine
+
+## 📚 How It Works
+
+1. **Pre-commit Hook**: Git runs CredLock before every push
+2. **File Scanning**: Reads all project files (respects .gitignore)
+3. **Pattern Matching**: Uses 50+ regex patterns to detect secrets
+4. **Reporting**: Shows findings with file names and line numbers
+5. **Exit Code**: Returns 1 if secrets found (blocks push), 0 if clean
+
+## 🐛 Troubleshooting
+
+### "credlock: command not found"
+Ensure CredLock is installed globally:
+```bash
+pip install credlock
+which credlock  # Should show /path/to/credlock
+```
+
+### Pre-commit hook not running
+Check hook is installed and executable:
+```bash
+cat .git/hooks/pre-commit
+chmod +x .git/hooks/pre-commit
+```
+
+### False positives (normal code flagged as secret)
+Add custom ignore patterns in config:
+```bash
+credlock configure
+# Choose to disable specific patterns
+```
+
+### Want to force push anyway?
+You can temporarily bypass CredLock:
+```bash
+# This skips the pre-commit hook
+git push --no-verify
+```
+
+But don't make this a habit! 🚨
+
+## 📊 Performance
+
+- Scans 100+ files in **<1 second**
+- Minimal CPU/memory overhead
+- No impact on normal Git workflow
+
+## 🤝 Contributing
+
+Found a bug? Want to add more patterns? Contributions welcome!
+
+1. Fork the repository
+2. Create a branch: `git checkout -b feature/new-pattern`
+3. Add tests for new patterns
+4. Submit a pull request
+
+## 📜 License
+
+MIT License - see LICENSE file for details
+
+## ⭐ Support
+
+- **Documentation**: Read this README
+- **Issues**: Report bugs on GitHub
+- **Discussions**: Ask questions in GitHub Discussions
+
+## 🎓 Interview Points
+
+When asked about CredLock:
+
+- **"What problem does it solve?"** → Prevents accidental secret commits, which happen all the time
+- **"How does it work?"** → Git pre-commit hook + regex pattern matching
+- **"Why local storage?"** → Fast, no dependencies, users control their data
+- **"How is it different?"** → Better UX than existing tools, modern CLI, easy setup
+- **"What's the hardest part?"** → Balancing security (not too many patterns) with usability (not too many false positives)
+
+## 📈 Future Enhancements
+
+- [ ] Team shared config (EnvVault integration)
+- [ ] Real-time monitoring dashboard
+- [ ] Slack/email notifications
+- [ ] Repository statistics
+- [ ] CI/CD pipeline integration
+- [ ] Custom rule templates
+
+---
+
+Made with ❤️ for developers who value security
+
+**Star this repo if you found it useful!** ⭐

credlock-1.0.0/credlock/__init__.py

@@ -0,0 +1,8 @@
+"""CredLock - Prevent accidental secret commits to Git"""
+
+__version__ = "1.0.0"
+__author__ = "Your Name"
+__description__ = "Automatic credential detection in your code"
+
+# Version info
+VERSION = __version__