@@ -367,7 +367,32 @@ Pre-commit hooks are configured in `.pre-commit-config.yaml`. The default config
367367| 🐍 Python | Ruff linting and formatting | ✅ Active |
368368| 🐚 Bash | ShellCheck and shfmt formatting | ✅ Active |
369369| 📄 Markdown | PyMarkdown validation | ✅ Active |
370- | 🔒 Security | Private key detection | ✅ Active |
370+ | 🔒 Security | Private key detection, API key detection, token scanning | ✅ Active |
371+
372+ #### Secret Detection
373+
374+ The framework includes comprehensive secret detection via ` scripts/detect-secrets.sh ` :
375+
376+ ** What It Detects** :
377+
378+ - ✅ API keys (Stripe, OpenAI, Google, AWS, etc.)
379+ - ✅ GitHub tokens (PATs, OAuth tokens)
380+ - ✅ Cloud provider credentials (AWS, GCP, Azure)
381+ - ✅ Private keys (SSH, TLS, signing keys)
382+ - ✅ OAuth tokens and refresh tokens
383+ - ✅ JWT tokens
384+ - ✅ High-entropy strings (potential secrets)
385+
386+ ** False Positive Filtering** :
387+
388+ - ✅ Ignores variable names (e.g., ` api_key = ` )
389+ - ✅ Ignores example/placeholder values
390+ - ✅ Ignores URLs and API endpoints
391+ - ✅ Ignores comments and documentation
392+ - ✅ Excludes test files and example files
393+
394+ If secrets are detected, the commit will be blocked. Use example placeholders like
395+ ` YOUR_API_KEY_HERE ` instead of real secrets.
371396
372397### CI/CD Configuration
373398
@@ -429,7 +454,7 @@ This framework is designed with security as the highest priority:
429454| Security Feature | Status | Description |
430455| -----------------| --------| -------------|
431456| 🔐 Secrets Protection | ✅ Active | Comprehensive ` .gitignore ` prevents accidental secret commits |
432- | 🔍 Automated Detection | ✅ Active | Pre-commit hooks detect private keys and other secrets |
457+ | 🔍 Automated Detection | ✅ Active | Pre-commit hooks detect secrets via detect- secrets.sh |
433458| 🛡️ Least Privilege | ✅ Active | All scripts should use least privilege principles |
434459| ✅ Input Validation | ✅ Active | All inputs should be treated as untrusted |
435460| 📋 Audit Trail | ✅ Active | Pre-commit logs provide an audit trail of quality checks |
@@ -475,6 +500,7 @@ Licensed under the Apache License, Version 2.0. See [LICENSE](LICENSE) for full
475500| ` .pre-commit-config.yaml ` | Quality check configuration | ✅ Required |
476501| ` .github/workflows/ci.yaml ` | CI/CD pipeline definition | ✅ Required |
477502| ` scripts/run-precommit.sh ` | Pre-commit execution wrapper (use this, not ` pre-commit ` directly) | ✅ Required |
503+ | ` scripts/detect-secrets.sh ` | Secret detection script (runs automatically via pre-commit) | ✅ Required |
478504| ` bootstrap-template-structure.sh ` | Recreate template structure | ✅ Optional |
479505
480506---
0 commit comments