# srivathsannayak/ethical-hacking-notes architecture

> Architecture diagram of the GitHub repository srivathsannayak/ethical-hacking-notes, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-06-26). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/srivathsannayak/ethical-hacking-notes
- Repository: https://github.com/srivathsannayak/ethical-hacking-notes

## Overview

1. **Repository purpose**
   - This is a personal cybersecurity knowledge base, not an application.
   - The root `README.md` acts as the entry point and index to many learning tracks, labs, and writeups across offensive security, blue-team topics, networking, cloud, and certifications.

2. **Top-level architecture**
   - The repo is organized by **source/course/platform** rather than by technical layer.
   - Each top-level directory is a self-contained curriculum or platform: for example `TryHackMe`, `HackTheBox`, `HTBAcademy`, `PracticalEthicalHacking_TCMSec`, `CloudSecurity`, `CompTIA_*`, and others.
   - This makes the repository a federation of note collections instead of one unified knowledge graph.

3. **Primary content model**
   - Most content is Markdown-based documentation.
   - Individual files typically represent one lesson, one lab, one room, or one box writeup.
   - The architecture is therefore document-centric: directories are categories, and Markdown files are the atomic units of knowledge.

4. **Large challenge/writeup subsystems**
   - `TryHackMe/Rooms`, `HackTheBox/*.md`, `HTBAcademy/*`, and `picoCTF/*` are the main challenge-oriented subsystems.
   - These areas store solution writeups, flags, exploit notes, enumeration steps, and tactics for individual targets.
   - They are meant for reference and replay, and the repo explicitly warns that these may contain spoilers.

5. **Course and certification study tracks**
   - Directories like `CompTIA_220-1001`, `CompTIA_220-1002`, `CompTIA_N10-007`, `CCNA`, `CloudSecurity`, `CybersecurityAnalyst`, and the TCM Security tracks represent structured learning paths.
   - These sections are more curriculum-like than exploit writeups: they break into topics such as networking, security, troubleshooting, cloud infrastructure, OS internals, and analyst workflows.
   - Several of these are further subdivided into chapter-style subfolders with their own `README.md` files.

6. **TCM Security tracks as modular subsystems**
   - The TCM-based directories are especially hierarchical: `Intro`, `Recon`, `Enumeration`, `Privesc`, `Capstone`, `Automation`, and similar submodules reflect staged learning.
   - Examples include `PracticalEthicalHacking_TCMSec`, `LinuxPrivilegeEscalation_TCMSec`, `WindowsPrivilegeEscalation_TCMSec`, `MPP_TCMSec`, `MalwareAnalysis_TCMSec`, `MobilePentest_TCMSec`, and `BugBounty_TCMSec`.
   - These are organized as progressive skill pipelines: fundamentals → enumeration → exploitation → post-exploitation → reporting or capstone.

7. **Executable/scripted artifacts**
   - A small subset of the repo contains actual code, mainly Python, used as study artifacts or attack automation examples.
   - Notable locations include `Python101_TCMSec` and `Python201_TCMSec`, plus `HTBAcademy/BrokenAuthentication/*.py`.
   - These scripts act as supporting tools for demonstrations such as brute force, SQL injection, bind shells, keylogging, DLL injection, and other offensive-security concepts.

8. **Shared reference assets**
   - The `Assets` folder and scattered images like `CCNA/Images` support the markdown notes visually.
   - This suggests a documentation workflow where diagrams, screenshots, and proof-of-work images are stored alongside textual writeups rather than in a separate media system.

9. **Cross-cutting cheat sheet**
   - `CTFCheatsheet.md` is a shared reference layer across the whole repository.
   - It functions like a reusable toolkit or memory aid, linking techniques and common payload patterns back to the individual course and lab notes.

10. **Information flow**
   - The practical flow is: learn from a course/platform → document techniques in Markdown → capture per-room/per-box solutions → distill reusable patterns into the cheat sheet.
   - Scripts are used where documentation alone is not enough, especially for automation or proof-of-concept exploitation.
   - The repo therefore mixes static knowledge, procedural walkthroughs, and small helper programs.

11. **Boundaries and coupling**
   - Each top-level directory is largely independent and can be read on its own.
   - Coupling is low: most cross-references are conceptual rather than code-level dependencies.
   - The only obvious shared dependencies are the common Markdown format, the asset folder, and the cheat sheet.

12. **Operational characteristics**
   - There is no build system, package manager, or deployment pipeline visible here.
   - The effective runtime is just “Markdown viewer + occasional Python interpreter” for the example scripts.
   - From an architecture-diagram perspective, this repo is best modeled as a **documentation/learning knowledge base** with a few embedded automation examples, not as a software service.

Main entry points: [`README.md`](https://github.com/srivathsannayak/ethical-hacking-notes/blob/main/README.md) (Root index), [`CTFCheatsheet.md`](https://github.com/srivathsannayak/ethical-hacking-notes/blob/main/CTFCheatsheet.md) (CTF cheatsheet), [`HTBAcademy/README.md`](https://github.com/srivathsannayak/ethical-hacking-notes/blob/main/HTBAcademy/README.md) (HTB Academy), [`PracticalEthicalHacking_TCMSec/README.md`](https://github.com/srivathsannayak/ethical-hacking-notes/blob/main/PracticalEthicalHacking_TCMSec/README.md) (PEH)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_docs["Documentation"]
  node_root_readme["Root index<br/>entrypoint markdown<br/>[README.md]"]
  node_cheatsheet["CTF cheatsheet<br/>shared reference<br/>[CTFCheatsheet.md]"]
end

subgraph group_challenges["Challenge Writeups"]
  node_tryhackme["TryHackMe<br/>platform notes<br/>[README.md]"]
  node_tryhackme_rooms["Rooms<br/>room writeups<br/>[README.md]"]
  node_hackthebox["HackTheBox<br/>box writeups<br/>[README.md]"]
  node_htb_academy["HTB Academy<br/>academy modules<br/>[README.md]"]
  node_portswigger["PortSwigger<br/>web labs<br/>[README.md]"]
  node_picoctf["picoCTF<br/>ctf tracks<br/>[README.md]"]
end

subgraph group_courses["Courses"]
  node_tcm_peh["PEH<br/>tcm track<br/>[README.md]"]
  node_tcm_linux_pe["Linux privesc<br/>tcm track<br/>[README.md]"]
  node_tcm_windows_pe["Windows privesc<br/>tcm track<br/>[README.md]"]
  node_tcm_malware["Malware analysis<br/>tcm track<br/>[README.md]"]
  node_tcm_mpp["MPP<br/>tcm track<br/>[README.md]"]
  node_tcm_mobile["Mobile pentest<br/>tcm track<br/>[README.md]"]
  node_ccna["CCNA<br/>networking notes<br/>[README.md]"]
  node_cloudsec["Cloud security<br/>cloud curriculum<br/>[README.md]"]
  node_comptia_a["CompTIA 220-1001<br/>cert track<br/>[README.md]"]
  node_comptia_b["CompTIA 220-1002<br/>cert track<br/>[README.md]"]
  node_comptia_net["CompTIA N10-007<br/>cert track<br/>[README.md]"]
  node_cyber_analyst["Cyber analyst<br/>cert track<br/>[README.md]"]
end

subgraph group_scripts["Scripts"]
  node_tcm_python101["Python 101<br/>script track<br/>[README.md]"]
  node_tcm_python201["Python 201<br/>script track<br/>[README.md]"]
end

subgraph group_assets["Assets"]
  node_assets_dir[("Assets<br/>media library")]
end

node_root_readme -->|"indexes"| node_tryhackme
node_root_readme -->|"indexes"| node_hackthebox
node_root_readme -->|"indexes"| node_htb_academy
node_root_readme -->|"indexes"| node_portswigger
node_root_readme -->|"indexes"| node_picoctf
node_root_readme -->|"indexes"| node_tcm_peh
node_root_readme -->|"indexes"| node_cloudsec
node_root_readme -->|"indexes"| node_comptia_a
node_root_readme -->|"indexes"| node_cyber_analyst
node_tryhackme -->|"contains"| node_tryhackme_rooms
node_htb_academy -->|"reuses"| node_cheatsheet
node_tryhackme_rooms -->|"distills"| node_cheatsheet
node_hackthebox -->|"distills"| node_cheatsheet
node_picoctf -->|"distills"| node_cheatsheet
node_htb_academy -.->|"uses"| node_tcm_python101
node_htb_academy -.->|"uses"| node_tcm_python201
node_tcm_peh -.->|"supports"| node_tcm_python101
node_tcm_peh -.->|"supports"| node_tcm_python201
node_ccna -->|"illustrates"| node_assets_dir
node_cloudsec -->|"illustrates"| node_assets_dir
node_root_readme -->|"references"| node_assets_dir
node_root_readme -->|"references"| node_cheatsheet

click node_root_readme "https://github.com/srivathsannayak/ethical-hacking-notes/blob/main/README.md"
click node_cheatsheet "https://github.com/srivathsannayak/ethical-hacking-notes/blob/main/CTFCheatsheet.md"
click node_assets_dir "https://github.com/srivathsannayak/ethical-hacking-notes/tree/main/Assets"
click node_tryhackme "https://github.com/srivathsannayak/ethical-hacking-notes/blob/main/TryHackMe/README.md"
click node_tryhackme_rooms "https://github.com/srivathsannayak/ethical-hacking-notes/blob/main/TryHackMe/Rooms/README.md"
click node_hackthebox "https://github.com/srivathsannayak/ethical-hacking-notes/blob/main/HackTheBox/README.md"
click node_htb_academy "https://github.com/srivathsannayak/ethical-hacking-notes/blob/main/HTBAcademy/README.md"
click node_portswigger "https://github.com/srivathsannayak/ethical-hacking-notes/blob/main/PortSwigger/README.md"
click node_picoctf "https://github.com/srivathsannayak/ethical-hacking-notes/blob/main/picoCTF/README.md"
click node_tcm_peh "https://github.com/srivathsannayak/ethical-hacking-notes/blob/main/PracticalEthicalHacking_TCMSec/README.md"
click node_tcm_linux_pe "https://github.com/srivathsannayak/ethical-hacking-notes/blob/main/LinuxPrivilegeEscalation_TCMSec/README.md"
click node_tcm_windows_pe "https://github.com/srivathsannayak/ethical-hacking-notes/blob/main/WindowsPrivilegeEscalation_TCMSec/README.md"
click node_tcm_malware "https://github.com/srivathsannayak/ethical-hacking-notes/blob/main/MalwareAnalysis_TCMSec/README.md"
click node_tcm_mpp "https://github.com/srivathsannayak/ethical-hacking-notes/blob/main/MPP_TCMSec/README.md"
click node_tcm_mobile "https://github.com/srivathsannayak/ethical-hacking-notes/blob/main/MobilePentest_TCMSec/README.md"
click node_tcm_python101 "https://github.com/srivathsannayak/ethical-hacking-notes/blob/main/Python101_TCMSec/README.md"
click node_tcm_python201 "https://github.com/srivathsannayak/ethical-hacking-notes/blob/main/Python201_TCMSec/README.md"
click node_ccna "https://github.com/srivathsannayak/ethical-hacking-notes/blob/main/CCNA/README.md"
click node_cloudsec "https://github.com/srivathsannayak/ethical-hacking-notes/blob/main/CloudSecurity/README.md"
click node_comptia_a "https://github.com/srivathsannayak/ethical-hacking-notes/blob/main/CompTIA_220-1001/README.md"
click node_comptia_b "https://github.com/srivathsannayak/ethical-hacking-notes/blob/main/CompTIA_220-1002/README.md"
click node_comptia_net "https://github.com/srivathsannayak/ethical-hacking-notes/blob/main/CompTIA_N10-007/README.md"
click node_cyber_analyst "https://github.com/srivathsannayak/ethical-hacking-notes/blob/main/CybersecurityAnalyst/README.md"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_root_readme,node_cheatsheet toneBlue
class node_tryhackme,node_tryhackme_rooms,node_hackthebox,node_htb_academy,node_portswigger,node_picoctf toneAmber
class node_tcm_peh,node_tcm_linux_pe,node_tcm_windows_pe,node_tcm_malware,node_tcm_mpp,node_tcm_mobile,node_ccna,node_cloudsec,node_comptia_a,node_comptia_b,node_comptia_net,node_cyber_analyst toneMint
class node_tcm_python101,node_tcm_python201 toneRose
class node_assets_dir toneIndigo
```

## Components

### Documentation

Markdown-centric learning notes and writeups

- [Root index](https://github.com/srivathsannayak/ethical-hacking-notes/blob/main/README.md): entrypoint markdown · Repository landing page and global table of contents · `README.md`
- [CTF cheatsheet](https://github.com/srivathsannayak/ethical-hacking-notes/blob/main/CTFCheatsheet.md): shared reference · Cross-cutting technique and payload reference · `CTFCheatsheet.md`

### Challenge Writeups

Per-room, per-box, and per-gym solution notes

- [TryHackMe](https://github.com/srivathsannayak/ethical-hacking-notes/blob/main/TryHackMe/README.md): platform notes · TryHackMe learning tracks and room writeups · `TryHackMe/README.md`
- [Rooms](https://github.com/srivathsannayak/ethical-hacking-notes/blob/main/TryHackMe/Rooms/README.md): room writeups · Individual TryHackMe room solution notes · `TryHackMe/Rooms/README.md`
- [HackTheBox](https://github.com/srivathsannayak/ethical-hacking-notes/blob/main/HackTheBox/README.md): box writeups · Individual Hack The Box machine notes · `HackTheBox/README.md`
- [HTB Academy](https://github.com/srivathsannayak/ethical-hacking-notes/blob/main/HTBAcademy/README.md): academy modules · Hack The Box Academy topic notes and labs · `HTBAcademy/README.md`
- [PortSwigger](https://github.com/srivathsannayak/ethical-hacking-notes/blob/main/PortSwigger/README.md): web labs · Web security training notes and topics · `PortSwigger/README.md`
- [picoCTF](https://github.com/srivathsannayak/ethical-hacking-notes/blob/main/picoCTF/README.md): ctf tracks · picoCTF learning guides and picoGym notes · `picoCTF/README.md`

### Courses

Structured study tracks and curriculum-style notes

- [PEH](https://github.com/srivathsannayak/ethical-hacking-notes/blob/main/PracticalEthicalHacking_TCMSec/README.md): tcm track · Practical Ethical Hacking progression · `PracticalEthicalHacking_TCMSec/README.md`
- [Linux privesc](https://github.com/srivathsannayak/ethical-hacking-notes/blob/main/LinuxPrivilegeEscalation_TCMSec/README.md): tcm track · Linux privilege escalation curriculum · `LinuxPrivilegeEscalation_TCMSec/README.md`
- [Windows privesc](https://github.com/srivathsannayak/ethical-hacking-notes/blob/main/WindowsPrivilegeEscalation_TCMSec/README.md): tcm track · Windows privilege escalation curriculum · `WindowsPrivilegeEscalation_TCMSec/README.md`
- [Malware analysis](https://github.com/srivathsannayak/ethical-hacking-notes/blob/main/MalwareAnalysis_TCMSec/README.md): tcm track · Static, dynamic, and reverse engineering study path · `MalwareAnalysis_TCMSec/README.md`
- [MPP](https://github.com/srivathsannayak/ethical-hacking-notes/blob/main/MPP_TCMSec/README.md): tcm track · Multi-stage domain, foothold, and C2 workflow · `MPP_TCMSec/README.md`
- [Mobile pentest](https://github.com/srivathsannayak/ethical-hacking-notes/blob/main/MobilePentest_TCMSec/README.md): tcm track · Android and iOS assessment notes · `MobilePentest_TCMSec/README.md`
- [CCNA](https://github.com/srivathsannayak/ethical-hacking-notes/blob/main/CCNA/README.md): networking notes · Networking study notes with image support · `CCNA/README.md`
- [Cloud security](https://github.com/srivathsannayak/ethical-hacking-notes/blob/main/CloudSecurity/README.md): cloud curriculum · Cloud security fundamentals and operations notes · `CloudSecurity/README.md`
- [CompTIA 220-1001](https://github.com/srivathsannayak/ethical-hacking-notes/blob/main/CompTIA_220-1001/README.md): cert track · Core hardware, networking, and troubleshooting notes · `CompTIA_220-1001/README.md`
- [CompTIA 220-1002](https://github.com/srivathsannayak/ethical-hacking-notes/blob/main/CompTIA_220-1002/README.md): cert track · Operating systems, security, and procedures notes · `CompTIA_220-1002/README.md`
- [CompTIA N10-007](https://github.com/srivathsannayak/ethical-hacking-notes/blob/main/CompTIA_N10-007/README.md): cert track · Network concepts, operations, and troubleshooting notes · `CompTIA_N10-007/README.md`
- [Cyber analyst](https://github.com/srivathsannayak/ethical-hacking-notes/blob/main/CybersecurityAnalyst/README.md): cert track · SOC, threat intel, compliance, and capstone notes · `CybersecurityAnalyst/README.md`

### Scripts

Small Python proof-of-concept and automation examples

- [Python 101](https://github.com/srivathsannayak/ethical-hacking-notes/blob/main/Python101_TCMSec/README.md): script track · Introductory Python examples for offensive tasks · `Python101_TCMSec/README.md`
- [Python 201](https://github.com/srivathsannayak/ethical-hacking-notes/blob/main/Python201_TCMSec/README.md): script track · Advanced Python and Windows API examples · `Python201_TCMSec/README.md`

### Assets

Shared images and visual references

- [Assets](https://github.com/srivathsannayak/ethical-hacking-notes/tree/main/Assets): media library · Shared images and supporting visuals · `Assets`

## Connections

- Root index → TryHackMe: indexes · Root index points to the TryHackMe collection
- Root index → HackTheBox: indexes · Root index points to HackTheBox writeups
- Root index → HTB Academy: indexes · Root index points to HTB Academy notes
- Root index → PortSwigger: indexes · Root index points to PortSwigger content
- Root index → picoCTF: indexes · Root index points to picoCTF materials
- Root index → PEH: indexes · Root index points to a major TCM track
- Root index → Cloud security: indexes · Root index points to cloud security notes
- Root index → CompTIA 220-1001: indexes · Root index points to certification study notes
- Root index → Cyber analyst: indexes · Root index points to analyst-focused study notes
- TryHackMe → Rooms: contains · TryHackMe is primarily surfaced through room writeups
- HTB Academy → CTF cheatsheet: reuses · Academy notes feed shared tactics into the cheatsheet
- Rooms → CTF cheatsheet: distills · Room solutions are condensed into reusable references
- HackTheBox → CTF cheatsheet: distills · Box writeups contribute patterns and payloads to the cheatsheet
- picoCTF → CTF cheatsheet: distills · CTF learnings are captured in the shared reference layer
- HTB Academy → Python 101: uses · Some academy exercises rely on supporting Python scripts
- HTB Academy → Python 201: uses · Advanced labs and PoCs rely on Python examples
- PEH → Python 101: supports · Intro hacking curriculum is paired with practical Python tools
- PEH → Python 201: supports · Advanced hacking curriculum is paired with exploit-oriented scripts
- CCNA → Assets: illustrates · Networking notes use diagrams and screenshots from the assets folder
- Cloud security → Assets: illustrates · Cloud notes can reference shared visuals
- Root index → Assets: references · Repository entry point acknowledges shared media assets
- Root index → CTF cheatsheet: references · Root entry point links to the shared cheat sheet conceptually