Phase 3.3: Update CONTRIBUTING.md with learn/ folder requirements
- Add learn/ folder as required for all new projects - Add detailed section 4 explaining learn/ folder structure - List all 5 required files with descriptions - Add quality standards for educational documentation - Update PR template with learn/ folder checklist - Include verification steps using template files - Increase time estimates for intermediate (2-4d, 3-5d) and advanced (1w, 1-2w, 2-3w, 3-4w) projects This ensures all future projects have consistent, high quality educational documentation that teaches security concepts.
This commit is contained in:
CarterPerez-dev
parent
a6c72a99c9
commit
ff9d7a92f7
|
|
@ -12,12 +12,26 @@ Provide a clear description of what this pull request does.
|
|||
|
||||
## Checklist
|
||||
|
||||
**General:**
|
||||
- [ ] My code follows the existing style and conventions
|
||||
- [ ] I have tested my changes
|
||||
- [ ] I have updated relevant documentation
|
||||
- [ ] My changes do not introduce security vulnerabilities
|
||||
- [ ] I have read the CONTRIBUTING.md guidelines
|
||||
|
||||
**For Full Project Implementations:**
|
||||
- [ ] Project includes `learn/` folder with all 5 required files:
|
||||
- [ ] 00-OVERVIEW.md - Project intro and quick start
|
||||
- [ ] 01-CONCEPTS.md - Security concepts and theory
|
||||
- [ ] 02-ARCHITECTURE.md - System design and decisions
|
||||
- [ ] 03-IMPLEMENTATION.md - Code walkthrough
|
||||
- [ ] 04-CHALLENGES.md - Extension ideas
|
||||
- [ ] Educational documentation references actual code with `file:line` format
|
||||
- [ ] Includes real world examples (breaches, CVEs, incidents)
|
||||
- [ ] Uses ASCII diagrams where helpful
|
||||
- [ ] Follows writing guidelines in `.github/learn-folder-template/README.md`
|
||||
- [ ] Verified completeness with `.github/learn-folder-template/CHECKLIST.md`
|
||||
|
||||
## Related Issues
|
||||
|
||||
Link any related issues here (e.g., "Fixes #123").
|
||||
|
|
|
|||
|
|
@ -53,6 +53,7 @@ Ensure your project structure is coherent and uses **intuitive, idiomatic naming
|
|||
|
||||
**Required:**
|
||||
- `README.md` - Detailed documentation (see below)
|
||||
- `learn/` - Educational documentation folder (see section 4)
|
||||
- Complete source code
|
||||
- Any necessary configuration files
|
||||
|
||||
|
|
@ -70,10 +71,17 @@ PROJECTS/
|
|||
├── beginner/
|
||||
│ └── simple-port-scanner/
|
||||
│ ├── README.md
|
||||
│ ├── learn/
|
||||
│ │ ├── 00-OVERVIEW.md
|
||||
│ │ ├── 01-CONCEPTS.md
|
||||
│ │ ├── 02-ARCHITECTURE.md
|
||||
│ │ ├── 03-IMPLEMENTATION.md
|
||||
│ │ └── 04-CHALLENGES.md
|
||||
│ └── src/
|
||||
├── intermediate/
|
||||
│ └── oauth-token-analyzer/
|
||||
│ ├── README.md
|
||||
│ ├── learn/
|
||||
│ ├── .env.example
|
||||
│ ├── requirements.txt
|
||||
│ ├── src/
|
||||
|
|
@ -84,6 +92,7 @@ PROJECTS/
|
|||
└── advanced/
|
||||
└── bug-bounty-platform/
|
||||
├── README.md
|
||||
├── learn/
|
||||
├── .env.example
|
||||
├── docker-compose.yml
|
||||
├── backend/
|
||||
|
|
@ -92,7 +101,70 @@ PROJECTS/
|
|||
└── examples/
|
||||
```
|
||||
|
||||
### 4. Package Managers if using Python and or Node (Doesn't matter what you use for any other framework/libary/language though)
|
||||
### 4. Educational Documentation (learn/ Folder)
|
||||
|
||||
All projects must include a `learn/` directory with educational documentation. This helps users understand not just how to use your project, but how it works and what security concepts it teaches.
|
||||
|
||||
**Required files:**
|
||||
|
||||
Copy the template from `.github/learn-folder-template/` to get started:
|
||||
|
||||
```bash
|
||||
cp -r .github/learn-folder-template PROJECTS/[difficulty]/[project-name]/learn
|
||||
cd PROJECTS/[difficulty]/[project-name]/learn
|
||||
rm README.md # Remove the template instructions
|
||||
```
|
||||
|
||||
Then fill in these five files:
|
||||
|
||||
1. **00-OVERVIEW.md** - Project introduction
|
||||
- What the project does and why it matters
|
||||
- Real world scenarios where it applies
|
||||
- What users will learn (security concepts, technical skills)
|
||||
- Prerequisites and quick start instructions
|
||||
- Common issues and solutions
|
||||
|
||||
2. **01-CONCEPTS.md** - Security concepts and theory
|
||||
- Core security concepts explained in depth
|
||||
- Common attacks and defense strategies
|
||||
- Real world examples and breaches
|
||||
- Industry standards (OWASP, MITRE, CWE)
|
||||
- Further reading resources
|
||||
|
||||
3. **02-ARCHITECTURE.md** - System design
|
||||
- High level architecture diagrams
|
||||
- Component breakdown and responsibilities
|
||||
- Data flow examples
|
||||
- Design decisions and trade-offs
|
||||
- Performance and security considerations
|
||||
|
||||
4. **03-IMPLEMENTATION.md** - Code walkthrough
|
||||
- Step by step implementation guide
|
||||
- Real code from the project with file:line references
|
||||
- Security implementation details
|
||||
- Common pitfalls and debugging tips
|
||||
- Testing and deployment
|
||||
|
||||
5. **04-CHALLENGES.md** - Extension ideas
|
||||
- Easy to expert level challenges
|
||||
- Hints without full solutions
|
||||
- Real world integration ideas
|
||||
- Performance and security challenges
|
||||
|
||||
**Quality standards:**
|
||||
|
||||
- Reference actual code with `filename:line` format
|
||||
- Include real world examples (breaches, CVEs, incidents)
|
||||
- Use ASCII diagrams for architecture and data flow
|
||||
- Show common mistakes and how to avoid them
|
||||
- Write in a clear, human voice (avoid marketing speak)
|
||||
- See `.github/learn-folder-template/README.md` for detailed writing guidelines
|
||||
|
||||
**Checklist:**
|
||||
|
||||
Use `.github/learn-folder-template/CHECKLIST.md` to verify your learn/ folder is complete before submitting.
|
||||
|
||||
### 5. Package Managers if using Python and or Node (Doesn't matter what you use for any other framework/libary/language though)
|
||||
|
||||
**Python:** Use [uv](https://github.com/astral-sh/uv) for dependency management. It's faster, better, and if you think pip or poetry is superior in 2026, you're simply not ready to contribute here. (I'm only slightly joking..... but use uv pls...)
|
||||
```bash
|
||||
|
|
@ -113,7 +185,7 @@ bun install
|
|||
```
|
||||
|
||||
|
||||
### 5. README Requirements
|
||||
### 6. README Requirements
|
||||
|
||||
Your project README should include:
|
||||
|
||||
|
|
@ -128,7 +200,7 @@ Your project README should include:
|
|||
- **Security Considerations** - Any warnings or best practices
|
||||
- **License** - Project licensing information
|
||||
|
||||
### 6. Code Quality Standards
|
||||
### 7. Code Quality Standards
|
||||
|
||||
**Linting & Type Checking:**
|
||||
|
||||
|
|
@ -169,13 +241,13 @@ More info: [YAPF Documentation](https://github.com/google/yapf)
|
|||
- Dependencies from trusted sources
|
||||
- No oudtated dependencies (prefferably the current stable version)
|
||||
|
||||
### 7. Full-Stack Projects
|
||||
### 8. Full-Stack Projects
|
||||
|
||||
Building a full-stack application? Use the included template as a starting point:
|
||||
|
||||
**[Fullstack Template](./TEMPLATES/fullstack-template)** - A production-ready template with FastAPI, React, Docker, and more. Check the [GitHub repository](https://github.com/CarterPerez-dev/fullstack-template) for the latest updates.
|
||||
|
||||
### 8. Submit a Pull Request
|
||||
### 9. Submit a Pull Request
|
||||
|
||||
**Create a new branch:**
|
||||
```bash
|
||||
|
|
@ -209,6 +281,8 @@ git push origin add-your-project-name
|
|||
- [ ] Code follows existing style and conventions
|
||||
- [ ] Project has been tested
|
||||
- [ ] README documentation is complete
|
||||
- [ ] learn/ folder is complete with all 5 required files
|
||||
- [ ] Educational documentation follows quality standards
|
||||
- [ ] No security vulnerabilities introduced
|
||||
- [ ] Read and followed CONTRIBUTING.md guidelines
|
||||
|
||||
|
|
|
|||
110
README.md
110
README.md
|
|
@ -48,76 +48,76 @@ Tools, courses, certifications, communities, and frameworks for cybersecurity pr
|
|||
|
||||
| Project | Info | What You'll Learn |
|
||||
|---------|------|-------------------|
|
||||
| **[Simple Port Scanner](./PROJECTS/beginner/simple-port-scanner)**<br>Async TCP port scanner in C++ |    | TCP socket programming • Async I/O patterns • Service detection<br>[Source Code](./PROJECTS/beginner/simple-port-scanner) \| [Docs](./PROJECTS/beginner/simple-port-scanner/learn) |
|
||||
| **[Keylogger](./PROJECTS/beginner/keylogger)**<br>Capture keyboard events with timestamps |    | Event handling • File I/O • Ethical considerations<br>[Source Code](./PROJECTS/beginner/keylogger) \| [Docs](./PROJECTS/beginner/keylogger/learn) |
|
||||
| **[Caesar Cipher](./PROJECTS/beginner/caesar-cipher)**<br>CLI encryption/decryption tool |    | Classical cryptography • Brute force attacks • CLI design<br>[Source Code](./PROJECTS/beginner/caesar-cipher) \| [Docs](./PROJECTS/beginner/caesar-cipher/learn) |
|
||||
| **[DNS Lookup CLI Tool](./PROJECTS/beginner/dns-lookup)**<br>Query DNS records with WHOIS |    | DNS protocols • WHOIS queries • Reverse DNS lookup<br>[Source Code](./PROJECTS/beginner/dns-lookup) \| [Docs](./PROJECTS/beginner/dns-lookup/learn) |
|
||||
| **[Simple Vulnerability Scanner](./PROJECTS/beginner/simple-vulnerability-scanner)**<br>Check software against CVE databases |    | CVE databases • Dependency scanning • Vulnerability assessment<br>[Source Code](./PROJECTS/beginner/simple-vulnerability-scanner) \| [Docs](./PROJECTS/beginner/simple-vulnerability-scanner/learn) |
|
||||
| **[Metadata Scrubber Tool](./PROJECTS/beginner/metadata-scrubber-tool)**<br>Remove EXIF and privacy metadata |    | EXIF data • Privacy protection • Batch processing<br>[Source Code](./PROJECTS/beginner/metadata-scrubber-tool) \| [Docs](./PROJECTS/beginner/metadata-scrubber-tool/learn) |
|
||||
| **[Network Traffic Analyzer](./SYNOPSES/beginner/Network.Traffic.Analyzer.md)**<br>Capture and analyze packets |    | Packet capture • Protocol analysis • Traffic visualization<br>[Learn More](./SYNOPSES/beginner/Network.Traffic.Analyzer.md) |
|
||||
| **[Hash Cracker](./SYNOPSES/beginner/Hash.Cracker.md)**<br>Dictionary and brute-force cracking |    | Hash algorithms • Dictionary attacks • Password security<br>[Learn More](./SYNOPSES/beginner/Hash.Cracker.md) |
|
||||
| **[Steganography Tool](./SYNOPSES/beginner/Steganography.Tool.md)**<br>Hide messages in images |    | LSB steganography • Image manipulation • Data hiding<br>[Learn More](./SYNOPSES/beginner/Steganography.Tool.md) |
|
||||
| **[MAC Address Spoofer](./SYNOPSES/beginner/MAC.Address.Spoofer.md)**<br>Change network interface MAC |    | Network interfaces • MAC addresses • Vendor lookup<br>[Learn More](./SYNOPSES/beginner/MAC.Address.Spoofer.md) |
|
||||
| **[File Integrity Monitor](./SYNOPSES/beginner/File.Integrity.Monitor.md)**<br>Monitor directories with checksums |    | Cryptographic hashing • File monitoring • Alert systems<br>[Learn More](./SYNOPSES/beginner/File.Integrity.Monitor.md) |
|
||||
| **[Security News Scraper](./SYNOPSES/beginner/Security.News.Scraper.md)**<br>Aggregate cybersecurity news |    | Web scraping • CVE parsing • Database storage<br>[Learn More](./SYNOPSES/beginner/Security.News.Scraper.md) |
|
||||
| **[Phishing URL Detector](./SYNOPSES/beginner/Phishing.URL.Detector.md)**<br>Analyze URLs for phishing |    | URL analysis • Typosquatting detection • Safe browsing APIs<br>[Learn More](./SYNOPSES/beginner/Phishing.URL.Detector.md) |
|
||||
| **[Simple Port Scanner](./PROJECTS/beginner/simple-port-scanner)**<br>Async TCP port scanner in C++ |    | TCP socket programming • Async I/O patterns • Service detection<br>[Source Code](./PROJECTS/beginner/simple-port-scanner) \| [Docs](./PROJECTS/beginner/simple-port-scanner/learn) |
|
||||
| **[Keylogger](./PROJECTS/beginner/keylogger)**<br>Capture keyboard events with timestamps |    | Event handling • File I/O • Ethical considerations<br>[Source Code](./PROJECTS/beginner/keylogger) \| [Docs](./PROJECTS/beginner/keylogger/learn) |
|
||||
| **[Caesar Cipher](./PROJECTS/beginner/caesar-cipher)**<br>CLI encryption/decryption tool |    | Classical cryptography • Brute force attacks • CLI design<br>[Source Code](./PROJECTS/beginner/caesar-cipher) \| [Docs](./PROJECTS/beginner/caesar-cipher/learn) |
|
||||
| **[DNS Lookup CLI Tool](./PROJECTS/beginner/dns-lookup)**<br>Query DNS records with WHOIS |    | DNS protocols • WHOIS queries • Reverse DNS lookup<br>[Source Code](./PROJECTS/beginner/dns-lookup) \| [Docs](./PROJECTS/beginner/dns-lookup/learn) |
|
||||
| **[Simple Vulnerability Scanner](./PROJECTS/beginner/simple-vulnerability-scanner)**<br>Check software against CVE databases |    | CVE databases • Dependency scanning • Vulnerability assessment<br>[Source Code](./PROJECTS/beginner/simple-vulnerability-scanner) \| [Docs](./PROJECTS/beginner/simple-vulnerability-scanner/learn) |
|
||||
| **[Metadata Scrubber Tool](./PROJECTS/beginner/metadata-scrubber-tool)**<br>Remove EXIF and privacy metadata |    | EXIF data • Privacy protection • Batch processing<br>[Source Code](./PROJECTS/beginner/metadata-scrubber-tool) \| [Docs](./PROJECTS/beginner/metadata-scrubber-tool/learn) |
|
||||
| **[Network Traffic Analyzer](./SYNOPSES/beginner/Network.Traffic.Analyzer.md)**<br>Capture and analyze packets |    | Packet capture • Protocol analysis • Traffic visualization<br>[Learn More](./SYNOPSES/beginner/Network.Traffic.Analyzer.md) |
|
||||
| **[Hash Cracker](./SYNOPSES/beginner/Hash.Cracker.md)**<br>Dictionary and brute-force cracking |    | Hash algorithms • Dictionary attacks • Password security<br>[Learn More](./SYNOPSES/beginner/Hash.Cracker.md) |
|
||||
| **[Steganography Tool](./SYNOPSES/beginner/Steganography.Tool.md)**<br>Hide messages in images |    | LSB steganography • Image manipulation • Data hiding<br>[Learn More](./SYNOPSES/beginner/Steganography.Tool.md) |
|
||||
| **[MAC Address Spoofer](./SYNOPSES/beginner/MAC.Address.Spoofer.md)**<br>Change network interface MAC |    | Network interfaces • MAC addresses • Vendor lookup<br>[Learn More](./SYNOPSES/beginner/MAC.Address.Spoofer.md) |
|
||||
| **[File Integrity Monitor](./SYNOPSES/beginner/File.Integrity.Monitor.md)**<br>Monitor directories with checksums |    | Cryptographic hashing • File monitoring • Alert systems<br>[Learn More](./SYNOPSES/beginner/File.Integrity.Monitor.md) |
|
||||
| **[Security News Scraper](./SYNOPSES/beginner/Security.News.Scraper.md)**<br>Aggregate cybersecurity news |    | Web scraping • CVE parsing • Database storage<br>[Learn More](./SYNOPSES/beginner/Security.News.Scraper.md) |
|
||||
| **[Phishing URL Detector](./SYNOPSES/beginner/Phishing.URL.Detector.md)**<br>Analyze URLs for phishing |    | URL analysis • Typosquatting detection • Safe browsing APIs<br>[Learn More](./SYNOPSES/beginner/Phishing.URL.Detector.md) |
|
||||
| **[SSH Brute Force Detector](./SYNOPSES/beginner/SSH.Brute.Force.Detector.md)**<br>Monitor and block SSH attacks |    | Log parsing • Attack detection • Firewall automation<br>[Learn More](./SYNOPSES/beginner/SSH.Brute.Force.Detector.md) |
|
||||
| **[WiFi Network Scanner](./SYNOPSES/beginner/WiFi.Network.Scanner.md)**<br>Scan wireless networks |    | Wireless protocols • Encryption types • Rogue AP detection<br>[Learn More](./SYNOPSES/beginner/WiFi.Network.Scanner.md) |
|
||||
| **[Base64 Encoder/Decoder](./SYNOPSES/beginner/Base64.Encoder.Decoder.md)**<br>Multi-format encoding tool |    | Base64/32 encoding • URL encoding • Auto-detection<br>[Learn More](./SYNOPSES/beginner/Base64.Encoder.Decoder.md) |
|
||||
| **[WiFi Network Scanner](./SYNOPSES/beginner/WiFi.Network.Scanner.md)**<br>Scan wireless networks |    | Wireless protocols • Encryption types • Rogue AP detection<br>[Learn More](./SYNOPSES/beginner/WiFi.Network.Scanner.md) |
|
||||
| **[Base64 Encoder/Decoder](./SYNOPSES/beginner/Base64.Encoder.Decoder.md)**<br>Multi-format encoding tool |    | Base64/32 encoding • URL encoding • Auto-detection<br>[Learn More](./SYNOPSES/beginner/Base64.Encoder.Decoder.md) |
|
||||
| **[Firewall Log Parser](./SYNOPSES/beginner/Firewall.Log.Parser.md)**<br>Parse and visualize logs |    | Log parsing • Pattern recognition • Data visualization<br>[Learn More](./SYNOPSES/beginner/Firewall.Log.Parser.md) |
|
||||
| **[ARP Spoofing Detector](./SYNOPSES/beginner/ARP.Spoofing.Detector.md)**<br>Detect ARP attacks |    | ARP protocol • MAC tracking • MITM detection<br>[Learn More](./SYNOPSES/beginner/ARP.Spoofing.Detector.md) |
|
||||
| **[Windows Registry Monitor](./SYNOPSES/beginner/Windows.Registry.Monitor.md)**<br>Track registry changes |    | Windows registry • Persistence detection • System monitoring<br>[Learn More](./SYNOPSES/beginner/Windows.Registry.Monitor.md) |
|
||||
| **[Ransomware Simulator](./SYNOPSES/beginner/Ransomware.Simulator.md)**<br>Educational encryption demo |    | File encryption • Ransomware behavior • Ethical testing<br>[Learn More](./SYNOPSES/beginner/Ransomware.Simulator.md) |
|
||||
| **[ARP Spoofing Detector](./SYNOPSES/beginner/ARP.Spoofing.Detector.md)**<br>Detect ARP attacks |    | ARP protocol • MAC tracking • MITM detection<br>[Learn More](./SYNOPSES/beginner/ARP.Spoofing.Detector.md) |
|
||||
| **[Windows Registry Monitor](./SYNOPSES/beginner/Windows.Registry.Monitor.md)**<br>Track registry changes |    | Windows registry • Persistence detection • System monitoring<br>[Learn More](./SYNOPSES/beginner/Windows.Registry.Monitor.md) |
|
||||
| **[Ransomware Simulator](./SYNOPSES/beginner/Ransomware.Simulator.md)**<br>Educational encryption demo |    | File encryption • Ransomware behavior • Ethical testing<br>[Learn More](./SYNOPSES/beginner/Ransomware.Simulator.md) |
|
||||
|
||||
## Intermediate Projects
|
||||
|
||||
| Project | Info | What You'll Learn |
|
||||
|---------|------|-------------------|
|
||||
| **[Reverse Shell Handler](./SYNOPSES/intermediate/Reverse.Shell.Handler.md)**<br>Multi-client shell server |    | Socket programming • Command execution • File transfer<br>[Learn More](./SYNOPSES/intermediate/Reverse.Shell.Handler.md) |
|
||||
| **[SIEM Dashboard](./SYNOPSES/intermediate/SIEM.Dashboard.md)**<br>Log aggregation with correlation |     | SIEM concepts • Log correlation • Full-stack development<br>[Learn More](./SYNOPSES/intermediate/SIEM.Dashboard.md) |
|
||||
| **[Threat Intelligence Aggregator](./SYNOPSES/intermediate/Threat.Intelligence.Aggregator.md)**<br>Collect and enrich IOCs |    | Threat feeds • IOC enrichment • API integration<br>[Learn More](./SYNOPSES/intermediate/Threat.Intelligence.Aggregator.md) |
|
||||
| **[OAuth Token Analyzer](./SYNOPSES/intermediate/OAuth.Token.Analyzer.md)**<br>Decode and validate JWT |    | JWT tokens • OAuth vulnerabilities • Signature validation<br>[Learn More](./SYNOPSES/intermediate/OAuth.Token.Analyzer.md) |
|
||||
| **[Web Vulnerability Scanner](./SYNOPSES/intermediate/Web.Vulnerability.Scanner.md)**<br>Automated XSS, SQLi, CSRF testing |    | Web vulnerabilities • Async scanning • Plugin architecture<br>[Learn More](./SYNOPSES/intermediate/Web.Vulnerability.Scanner.md) |
|
||||
| **[DDoS Mitigation Tool](./SYNOPSES/intermediate/DDoS.Mitigation.Tool.md)**<br>Detect traffic spikes |    | DDoS detection • Rate limiting • Anomaly detection<br>[Learn More](./SYNOPSES/intermediate/DDoS.Mitigation.Tool.md) |
|
||||
| **[Reverse Shell Handler](./SYNOPSES/intermediate/Reverse.Shell.Handler.md)**<br>Multi-client shell server |    | Socket programming • Command execution • File transfer<br>[Learn More](./SYNOPSES/intermediate/Reverse.Shell.Handler.md) |
|
||||
| **[SIEM Dashboard](./SYNOPSES/intermediate/SIEM.Dashboard.md)**<br>Log aggregation with correlation |     | SIEM concepts • Log correlation • Full-stack development<br>[Learn More](./SYNOPSES/intermediate/SIEM.Dashboard.md) |
|
||||
| **[Threat Intelligence Aggregator](./SYNOPSES/intermediate/Threat.Intelligence.Aggregator.md)**<br>Collect and enrich IOCs |    | Threat feeds • IOC enrichment • API integration<br>[Learn More](./SYNOPSES/intermediate/Threat.Intelligence.Aggregator.md) |
|
||||
| **[OAuth Token Analyzer](./SYNOPSES/intermediate/OAuth.Token.Analyzer.md)**<br>Decode and validate JWT |    | JWT tokens • OAuth vulnerabilities • Signature validation<br>[Learn More](./SYNOPSES/intermediate/OAuth.Token.Analyzer.md) |
|
||||
| **[Web Vulnerability Scanner](./SYNOPSES/intermediate/Web.Vulnerability.Scanner.md)**<br>Automated XSS, SQLi, CSRF testing |    | Web vulnerabilities • Async scanning • Plugin architecture<br>[Learn More](./SYNOPSES/intermediate/Web.Vulnerability.Scanner.md) |
|
||||
| **[DDoS Mitigation Tool](./SYNOPSES/intermediate/DDoS.Mitigation.Tool.md)**<br>Detect traffic spikes |    | DDoS detection • Rate limiting • Anomaly detection<br>[Learn More](./SYNOPSES/intermediate/DDoS.Mitigation.Tool.md) |
|
||||
| **[Container Security Scanner](./SYNOPSES/intermediate/Container.Security.Scanner.md)**<br>Scan Docker misconfigurations |     | Container security • Dockerfile analysis • Docker API<br>[Learn More](./SYNOPSES/intermediate/Container.Security.Scanner.md) |
|
||||
| **[API Security Scanner](./PROJECTS/intermediate/api-security-scanner)**<br>Enterprise API vulnerability scanner |      | OWASP API Top 10 • ML fuzzing • GraphQL/SOAP testing<br>[Source Code](./PROJECTS/intermediate/api-security-scanner) \| [Docs](./PROJECTS/intermediate/api-security-scanner/learn) |
|
||||
| **[Wireless Deauth Detector](./SYNOPSES/intermediate/Wireless.Deauth.Detector.md)**<br>Monitor WiFi deauth attacks |    | Wireless security • Packet sniffing • Attack detection<br>[Learn More](./SYNOPSES/intermediate/Wireless.Deauth.Detector.md) |
|
||||
| **[Active Directory Enumeration](./SYNOPSES/intermediate/Active.Directory.Enumeration.md)**<br>Enumerate AD infrastructure |    | LDAP queries • AD structure • Privilege analysis<br>[Learn More](./SYNOPSES/intermediate/Active.Directory.Enumeration.md) |
|
||||
| **[Binary Analysis Tool](./SYNOPSES/intermediate/Binary.Analysis.Tool.md)**<br>Disassemble and analyze executables |    | Binary analysis • String extraction • Malware detection<br>[Learn More](./SYNOPSES/intermediate/Binary.Analysis.Tool.md) |
|
||||
| **[Network Intrusion Prevention](./SYNOPSES/intermediate/Network.Intrusion.Prevention.md)**<br>Real-time packet inspection |    | IPS concepts • Snort rules • Firewall integration<br>[Learn More](./SYNOPSES/intermediate/Network.Intrusion.Prevention.md) |
|
||||
| **[Password Policy Auditor](./SYNOPSES/intermediate/Password.Policy.Auditor.md)**<br>Audit password policies |    | Password security • Policy compliance • Weak password detection<br>[Learn More](./SYNOPSES/intermediate/Password.Policy.Auditor.md) |
|
||||
| **[API Security Scanner](./PROJECTS/intermediate/api-security-scanner)**<br>Enterprise API vulnerability scanner |      | OWASP API Top 10 • ML fuzzing • GraphQL/SOAP testing<br>[Source Code](./PROJECTS/intermediate/api-security-scanner) \| [Docs](./PROJECTS/intermediate/api-security-scanner/learn) |
|
||||
| **[Wireless Deauth Detector](./SYNOPSES/intermediate/Wireless.Deauth.Detector.md)**<br>Monitor WiFi deauth attacks |    | Wireless security • Packet sniffing • Attack detection<br>[Learn More](./SYNOPSES/intermediate/Wireless.Deauth.Detector.md) |
|
||||
| **[Active Directory Enumeration](./SYNOPSES/intermediate/Active.Directory.Enumeration.md)**<br>Enumerate AD infrastructure |    | LDAP queries • AD structure • Privilege analysis<br>[Learn More](./SYNOPSES/intermediate/Active.Directory.Enumeration.md) |
|
||||
| **[Binary Analysis Tool](./SYNOPSES/intermediate/Binary.Analysis.Tool.md)**<br>Disassemble and analyze executables |    | Binary analysis • String extraction • Malware detection<br>[Learn More](./SYNOPSES/intermediate/Binary.Analysis.Tool.md) |
|
||||
| **[Network Intrusion Prevention](./SYNOPSES/intermediate/Network.Intrusion.Prevention.md)**<br>Real-time packet inspection |    | IPS concepts • Snort rules • Firewall integration<br>[Learn More](./SYNOPSES/intermediate/Network.Intrusion.Prevention.md) |
|
||||
| **[Password Policy Auditor](./SYNOPSES/intermediate/Password.Policy.Auditor.md)**<br>Audit password policies |    | Password security • Policy compliance • Weak password detection<br>[Learn More](./SYNOPSES/intermediate/Password.Policy.Auditor.md) |
|
||||
| **[Cloud Asset Inventory](./SYNOPSES/intermediate/Cloud.Asset.Inventory.md)**<br>Discover cloud resources |     | Cloud APIs • Asset discovery • Cost tracking<br>[Learn More](./SYNOPSES/intermediate/Cloud.Asset.Inventory.md) |
|
||||
| **[OSINT Reconnaissance Framework](./SYNOPSES/intermediate/OSINT.Reconnaissance.Framework.md)**<br>Aggregate public intelligence |    | OSINT techniques • Data aggregation • Target profiling<br>[Learn More](./SYNOPSES/intermediate/OSINT.Reconnaissance.Framework.md) |
|
||||
| **[SSL/TLS Certificate Scanner](./SYNOPSES/intermediate/SSL.TLS.Certificate.Scanner.md)**<br>Scan for SSL misconfigurations |    | TLS/SSL protocols • Certificate validation • Cipher analysis<br>[Learn More](./SYNOPSES/intermediate/SSL.TLS.Certificate.Scanner.md) |
|
||||
| **[Mobile App Security Analyzer](./SYNOPSES/intermediate/Mobile.App.Security.Analyzer.md)**<br>Decompile and analyze mobile apps |    | APK/IPA analysis • Reverse engineering • OWASP Mobile<br>[Learn More](./SYNOPSES/intermediate/Mobile.App.Security.Analyzer.md) |
|
||||
| **[Backup Integrity Checker](./SYNOPSES/intermediate/Backup.Integrity.Checker.md)**<br>Verify backup integrity |    | Backup validation • Restoration testing • Checksum verification<br>[Learn More](./SYNOPSES/intermediate/Backup.Integrity.Checker.md) |
|
||||
| **[Web Application Firewall](./SYNOPSES/intermediate/Web.Application.Firewall.md)**<br>Reverse proxy with filtering |    | WAF concepts • Request filtering • Attack blocking<br>[Learn More](./SYNOPSES/intermediate/Web.Application.Firewall.md) |
|
||||
| **[Privilege Escalation Finder](./SYNOPSES/intermediate/Privilege.Escalation.Finder.md)**<br>Identify privilege escalation |    | Privilege escalation • SUID binaries • Weak permissions<br>[Learn More](./SYNOPSES/intermediate/Privilege.Escalation.Finder.md) |
|
||||
| **[Network Baseline Monitor](./SYNOPSES/intermediate/Network.Baseline.Monitor.md)**<br>Monitor network behavior |    | Baseline analysis • Anomaly detection • Traffic patterns<br>[Learn More](./SYNOPSES/intermediate/Network.Baseline.Monitor.md) |
|
||||
| **[OSINT Reconnaissance Framework](./SYNOPSES/intermediate/OSINT.Reconnaissance.Framework.md)**<br>Aggregate public intelligence |    | OSINT techniques • Data aggregation • Target profiling<br>[Learn More](./SYNOPSES/intermediate/OSINT.Reconnaissance.Framework.md) |
|
||||
| **[SSL/TLS Certificate Scanner](./SYNOPSES/intermediate/SSL.TLS.Certificate.Scanner.md)**<br>Scan for SSL misconfigurations |    | TLS/SSL protocols • Certificate validation • Cipher analysis<br>[Learn More](./SYNOPSES/intermediate/SSL.TLS.Certificate.Scanner.md) |
|
||||
| **[Mobile App Security Analyzer](./SYNOPSES/intermediate/Mobile.App.Security.Analyzer.md)**<br>Decompile and analyze mobile apps |    | APK/IPA analysis • Reverse engineering • OWASP Mobile<br>[Learn More](./SYNOPSES/intermediate/Mobile.App.Security.Analyzer.md) |
|
||||
| **[Backup Integrity Checker](./SYNOPSES/intermediate/Backup.Integrity.Checker.md)**<br>Verify backup integrity |    | Backup validation • Restoration testing • Checksum verification<br>[Learn More](./SYNOPSES/intermediate/Backup.Integrity.Checker.md) |
|
||||
| **[Web Application Firewall](./SYNOPSES/intermediate/Web.Application.Firewall.md)**<br>Reverse proxy with filtering |    | WAF concepts • Request filtering • Attack blocking<br>[Learn More](./SYNOPSES/intermediate/Web.Application.Firewall.md) |
|
||||
| **[Privilege Escalation Finder](./SYNOPSES/intermediate/Privilege.Escalation.Finder.md)**<br>Identify privilege escalation |    | Privilege escalation • SUID binaries • Weak permissions<br>[Learn More](./SYNOPSES/intermediate/Privilege.Escalation.Finder.md) |
|
||||
| **[Network Baseline Monitor](./SYNOPSES/intermediate/Network.Baseline.Monitor.md)**<br>Monitor network behavior |    | Baseline analysis • Anomaly detection • Traffic patterns<br>[Learn More](./SYNOPSES/intermediate/Network.Baseline.Monitor.md) |
|
||||
| **[Docker Security Audit](./PROJECTS/intermediate/docker-security-audit)**<br>CIS Docker Benchmark scanner |     | CIS benchmarks • Container security • Multiple output formats<br>[Source Code](./PROJECTS/intermediate/docker-security-audit) \| [Docs](./PROJECTS/intermediate/docker-security-audit/learn) |
|
||||
|
||||
## Advanced Projects
|
||||
|
||||
| Project | Info | What You'll Learn |
|
||||
|---------|------|-------------------|
|
||||
| **[API Rate Limiter](./PROJECTS/advanced/api-rate-limiter)**<br>Distributed rate limiting middleware |     | Token bucket algorithm • Distributed systems • Redis backend<br>[Source Code](./PROJECTS/advanced/api-rate-limiter) \| [Docs](./PROJECTS/advanced/api-rate-limiter/learn) |
|
||||
| **[Encrypted Chat Application](./PROJECTS/advanced/encrypted-p2p-chat)**<br>Real-time E2EE messaging |      | Signal Protocol • Double Ratchet • WebAuthn • WebSockets<br>[Source Code](./PROJECTS/advanced/encrypted-p2p-chat) \| [Docs](./PROJECTS/advanced/encrypted-p2p-chat/learn) |
|
||||
| **[Exploit Development Framework](./SYNOPSES/advanced/Exploit.Development.Framework.md)**<br>Modular exploitation framework |    | Exploit development • Payload generation • Plugin architecture<br>[Learn More](./SYNOPSES/advanced/Exploit.Development.Framework.md) |
|
||||
| **[AI Threat Detection](./SYNOPSES/advanced/AI.Threat.Detection.md)**<br>ML-based traffic classification |     | Machine learning • Network traffic analysis • Model deployment<br>[Learn More](./SYNOPSES/advanced/AI.Threat.Detection.md) |
|
||||
| **[Bug Bounty Platform](./PROJECTS/advanced/bug-bounty-platform)**<br>Full vulnerability disclosure platform |      | Full-stack development • CVSS scoring • Workflow automation<br>[Source Code](./PROJECTS/advanced/bug-bounty-platform) \| [Docs](./PROJECTS/advanced/bug-bounty-platform/learn) |
|
||||
| **[Cloud Security Posture Management](./SYNOPSES/advanced/Cloud.Security.Posture.Management.md)**<br>Multi-cloud misconfiguration scanner |      | Cloud security • CIS benchmarks • Multi-cloud APIs<br>[Learn More](./SYNOPSES/advanced/Cloud.Security.Posture.Management.md) |
|
||||
| **[Malware Analysis Platform](./SYNOPSES/advanced/Malware.Analysis.Platform.md)**<br>Automated sandbox analysis |     | Malware analysis • Sandboxing • YARA rules • IOC extraction<br>[Learn More](./SYNOPSES/advanced/Malware.Analysis.Platform.md) |
|
||||
| **[Quantum Resistant Encryption](./SYNOPSES/advanced/Quantum.Resistant.Encryption.md)**<br>Post-quantum cryptography |    | Post-quantum algorithms • Hybrid encryption • Kyber/Dilithium<br>[Learn More](./SYNOPSES/advanced/Quantum.Resistant.Encryption.md) |
|
||||
| **[Zero Day Vulnerability Scanner](./SYNOPSES/advanced/Zero.Day.Vulnerability.Scanner.md)**<br>Coverage-guided fuzzing |     | Fuzzing • Vulnerability research • Crash triage<br>[Learn More](./SYNOPSES/advanced/Zero.Day.Vulnerability.Scanner.md) |
|
||||
| **[Distributed Password Cracker](./SYNOPSES/advanced/Distributed.Password.Cracker.md)**<br>GPU-accelerated cracking |     | Distributed systems • GPU computing • Hash cracking<br>[Learn More](./SYNOPSES/advanced/Distributed.Password.Cracker.md) |
|
||||
| **[Kernel Rootkit Detection](./SYNOPSES/advanced/Kernel.Rootkit.Detection.md)**<br>Detect kernel-level rootkits |    | Kernel internals • Memory forensics • Rootkit detection<br>[Learn More](./SYNOPSES/advanced/Kernel.Rootkit.Detection.md) |
|
||||
| **[Blockchain Smart Contract Auditor](./SYNOPSES/advanced/Blockchain.Smart.Contract.Auditor.md)**<br>Solidity vulnerability analysis |     | Smart contracts • Static analysis • Solidity security<br>[Learn More](./SYNOPSES/advanced/Blockchain.Smart.Contract.Auditor.md) |
|
||||
| **[Adversarial ML Attacker](./SYNOPSES/advanced/Adversarial.ML.Attacker.md)**<br>Generate adversarial examples |     | Adversarial ML • FGSM/DeepFool • Model robustness<br>[Learn More](./SYNOPSES/advanced/Adversarial.ML.Attacker.md) |
|
||||
| **[Advanced Persistent Threat Simulator](./SYNOPSES/advanced/Advanced.Persistent.Threat.Simulator.md)**<br>Multi-stage APT simulation |    | APT techniques • C2 infrastructure • Lateral movement<br>[Learn More](./SYNOPSES/advanced/Advanced.Persistent.Threat.Simulator.md) |
|
||||
| **[Hardware Security Module Emulator](./SYNOPSES/advanced/Hardware.Security.Module.Emulator.md)**<br>Software HSM with PKCS#11 |    | HSM concepts • PKCS#11 interface • Cryptographic operations<br>[Learn More](./SYNOPSES/advanced/Hardware.Security.Module.Emulator.md) |
|
||||
| **[Network Covert Channel](./SYNOPSES/advanced/Network.Covert.Channel.md)**<br>Data exfiltration techniques |    | Covert channels • Data exfiltration • Steganography<br>[Learn More](./SYNOPSES/advanced/Network.Covert.Channel.md) |
|
||||
| **[Automated Penetration Testing](./SYNOPSES/advanced/Automated.Penetration.Testing.md)**<br>Full pentest automation |    | Pentest automation • Recon to exploitation • Report generation<br>[Learn More](./SYNOPSES/advanced/Automated.Penetration.Testing.md) |
|
||||
| **[Supply Chain Security Analyzer](./SYNOPSES/advanced/Supply.Chain.Security.Analyzer.md)**<br>Dependency vulnerability analysis |    | Supply chain security • Dependency analysis • Malicious packages<br>[Learn More](./SYNOPSES/advanced/Supply.Chain.Security.Analyzer.md) |
|
||||
| **[API Rate Limiter](./PROJECTS/advanced/api-rate-limiter)**<br>Distributed rate limiting middleware |     | Token bucket algorithm • Distributed systems • Redis backend<br>[Source Code](./PROJECTS/advanced/api-rate-limiter) \| [Docs](./PROJECTS/advanced/api-rate-limiter/learn) |
|
||||
| **[Encrypted Chat Application](./PROJECTS/advanced/encrypted-p2p-chat)**<br>Real-time E2EE messaging |      | Signal Protocol • Double Ratchet • WebAuthn • WebSockets<br>[Source Code](./PROJECTS/advanced/encrypted-p2p-chat) \| [Docs](./PROJECTS/advanced/encrypted-p2p-chat/learn) |
|
||||
| **[Exploit Development Framework](./SYNOPSES/advanced/Exploit.Development.Framework.md)**<br>Modular exploitation framework |    | Exploit development • Payload generation • Plugin architecture<br>[Learn More](./SYNOPSES/advanced/Exploit.Development.Framework.md) |
|
||||
| **[AI Threat Detection](./SYNOPSES/advanced/AI.Threat.Detection.md)**<br>ML-based traffic classification |     | Machine learning • Network traffic analysis • Model deployment<br>[Learn More](./SYNOPSES/advanced/AI.Threat.Detection.md) |
|
||||
| **[Bug Bounty Platform](./PROJECTS/advanced/bug-bounty-platform)**<br>Full vulnerability disclosure platform |      | Full-stack development • CVSS scoring • Workflow automation<br>[Source Code](./PROJECTS/advanced/bug-bounty-platform) \| [Docs](./PROJECTS/advanced/bug-bounty-platform/learn) |
|
||||
| **[Cloud Security Posture Management](./SYNOPSES/advanced/Cloud.Security.Posture.Management.md)**<br>Multi-cloud misconfiguration scanner |      | Cloud security • CIS benchmarks • Multi-cloud APIs<br>[Learn More](./SYNOPSES/advanced/Cloud.Security.Posture.Management.md) |
|
||||
| **[Malware Analysis Platform](./SYNOPSES/advanced/Malware.Analysis.Platform.md)**<br>Automated sandbox analysis |     | Malware analysis • Sandboxing • YARA rules • IOC extraction<br>[Learn More](./SYNOPSES/advanced/Malware.Analysis.Platform.md) |
|
||||
| **[Quantum Resistant Encryption](./SYNOPSES/advanced/Quantum.Resistant.Encryption.md)**<br>Post-quantum cryptography |    | Post-quantum algorithms • Hybrid encryption • Kyber/Dilithium<br>[Learn More](./SYNOPSES/advanced/Quantum.Resistant.Encryption.md) |
|
||||
| **[Zero Day Vulnerability Scanner](./SYNOPSES/advanced/Zero.Day.Vulnerability.Scanner.md)**<br>Coverage-guided fuzzing |     | Fuzzing • Vulnerability research • Crash triage<br>[Learn More](./SYNOPSES/advanced/Zero.Day.Vulnerability.Scanner.md) |
|
||||
| **[Distributed Password Cracker](./SYNOPSES/advanced/Distributed.Password.Cracker.md)**<br>GPU-accelerated cracking |     | Distributed systems • GPU computing • Hash cracking<br>[Learn More](./SYNOPSES/advanced/Distributed.Password.Cracker.md) |
|
||||
| **[Kernel Rootkit Detection](./SYNOPSES/advanced/Kernel.Rootkit.Detection.md)**<br>Detect kernel-level rootkits |    | Kernel internals • Memory forensics • Rootkit detection<br>[Learn More](./SYNOPSES/advanced/Kernel.Rootkit.Detection.md) |
|
||||
| **[Blockchain Smart Contract Auditor](./SYNOPSES/advanced/Blockchain.Smart.Contract.Auditor.md)**<br>Solidity vulnerability analysis |     | Smart contracts • Static analysis • Solidity security<br>[Learn More](./SYNOPSES/advanced/Blockchain.Smart.Contract.Auditor.md) |
|
||||
| **[Adversarial ML Attacker](./SYNOPSES/advanced/Adversarial.ML.Attacker.md)**<br>Generate adversarial examples |     | Adversarial ML • FGSM/DeepFool • Model robustness<br>[Learn More](./SYNOPSES/advanced/Adversarial.ML.Attacker.md) |
|
||||
| **[Advanced Persistent Threat Simulator](./SYNOPSES/advanced/Advanced.Persistent.Threat.Simulator.md)**<br>Multi-stage APT simulation |    | APT techniques • C2 infrastructure • Lateral movement<br>[Learn More](./SYNOPSES/advanced/Advanced.Persistent.Threat.Simulator.md) |
|
||||
| **[Hardware Security Module Emulator](./SYNOPSES/advanced/Hardware.Security.Module.Emulator.md)**<br>Software HSM with PKCS#11 |    | HSM concepts • PKCS#11 interface • Cryptographic operations<br>[Learn More](./SYNOPSES/advanced/Hardware.Security.Module.Emulator.md) |
|
||||
| **[Network Covert Channel](./SYNOPSES/advanced/Network.Covert.Channel.md)**<br>Data exfiltration techniques |    | Covert channels • Data exfiltration • Steganography<br>[Learn More](./SYNOPSES/advanced/Network.Covert.Channel.md) |
|
||||
| **[Automated Penetration Testing](./SYNOPSES/advanced/Automated.Penetration.Testing.md)**<br>Full pentest automation |    | Pentest automation • Recon to exploitation • Report generation<br>[Learn More](./SYNOPSES/advanced/Automated.Penetration.Testing.md) |
|
||||
| **[Supply Chain Security Analyzer](./SYNOPSES/advanced/Supply.Chain.Security.Analyzer.md)**<br>Dependency vulnerability analysis |    | Supply chain security • Dependency analysis • Malicious packages<br>[Learn More](./SYNOPSES/advanced/Supply.Chain.Security.Analyzer.md) |
|
||||
|
||||
---
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue