Skip to content

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

15 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

🚩 hackref β€” CTF Knowledge Index & Field Manual

GitHub Stars GitHub Forks Built with Astro Tailwind CSS

hackref is a minimal, fast field manual for Capture The Flag (CTF) beginners and cybersecurity competitors. It organizes essential concepts, techniques, tools, and command cheatsheets across 9 key CTF domains into concise, actionable guides.

🌐 Live Website: hackref.shovon.bd


✨ Features

  • 🎯 9 Core CTF Domains: Comprehensive field guides covering:
    • 🌐 Web Exploitation: SQLi, XSS, Command Injection, SSRF, JWT, File Inclusion, and 403 Bypasses.
    • πŸ” Cryptography: RSA attacks, Classical Ciphers, XOR, Hash Length Extension, and Padding Oracle.
    • βš™οΈ Reverse Engineering: Static & dynamic analysis, GDB/pwndbg basics, and Ghidra decompilation.
    • πŸ’₯ Binary Exploitation (Pwn): Buffer overflows, ROP chains, format strings, and shellcode.
    • πŸ” Forensics: Memory dump analysis (Volatility), PCAP packet analysis, and file carving (Binwalk).
    • πŸ•΅οΈ OSINT: Username enumeration, domain recon, and metadata extraction.
    • πŸ–ΌοΈ Steganography: LSB extraction, audio stego, and hidden image bit-plane analysis.
    • πŸ“‘ Networking: Wireshark packet dissection, Nmap scanning, and network protocols.
    • 🧩 Misc: Esoteric languages, jailbreaks, and zip password cracking.
  • 🧰 Curated Tools Directory: Indexed collection of essential CTF tools (sqlmap, pwntools, gdb, radare2, zsteg, etc.) with direct repo links.
  • ⚑ Blazing Fast Performance: Built with Astro for zero-JS baseline HTML, styled with Tailwind CSS v4.
  • πŸ” Static Search: Powered by Pagefind for instant client-side full-text search across all guides.
  • πŸ“‘ RSS & Sitemap: Built-in RSS feed (/rss.xml) and automated XML sitemap generation.

πŸ“‚ Project Structure

hackref/
β”œβ”€β”€ public/                # Static assets & web manifest
β”œβ”€β”€ src/
β”‚   β”œβ”€β”€ components/        # UI components (Header, Footer, Sidebar, Icons, Badges)
β”‚   β”œβ”€β”€ content/
β”‚   β”‚   β”œβ”€β”€ categories/    # Category metadata (web, crypto, rev, pwn, etc.)
β”‚   β”‚   └── articles/      # Markdown field guides & tutorials
β”‚   β”œβ”€β”€ data/              # Tools directory dataset
β”‚   β”œβ”€β”€ layouts/           # Page layouts (Layout.astro, DocsLayout.astro)
β”‚   β”œβ”€β”€ lib/               # Utility functions & content helpers
β”‚   β”œβ”€β”€ pages/             # Astro routes (/categories, /articles, /tools, rss.xml)
β”‚   └── content.config.ts  # Astro Content Collections schema definitions
β”œβ”€β”€ package.json
└── astro.config.mjs       # Astro configuration & integrations

πŸš€ Getting Started

Prerequisites

  • Node.js: >= 22.12.0
  • pnpm: >= 9.0.0

Installation & Local Setup

  1. Clone the repository:

    git clone https://github.com/sh00von/hackref.git
    cd hackref
  2. Install dependencies:

    pnpm install
  3. Start the development server:

    pnpm dev

    Open http://localhost:4321 in your browser.

  4. Build for production:

    pnpm build
  5. Preview production build:

    pnpm preview

🀝 Contributing

Contributions are welcome! If you find a typo, want to expand an existing guide, or want to add a new CTF tool:

  1. Fork the repository.
  2. Create a feature branch (git checkout -b guide/new-web-technique).
  3. Commit your changes (git commit -m 'Add XXE vulnerability guide').
  4. Push to the branch (git push origin guide/new-web-technique).
  5. Open a Pull Request.

⭐ Support

If you find hackref helpful for your CTF journey or security practice, please consider leaving a Star on GitHub β€” it helps others discover the project!


πŸ“„ License

Created by Md. Minaruzzaman Shovon. Open source under the MIT License.

About

🚩 Minimal field manual and reference index for Capture The Flag (CTF) beginners & cybersecurity competitors.

Resources

Contributing

Stars

1 star

Watchers

0 watching

Forks

Contributors

Languages