noraj/OSCP-Exam-Report-Template-Markdown

Offensive Security Exam Report Template in Markdown

I created an Offensive Security Exam Report Template in Markdown so LaTeX, Microsoft Office Word, LibreOffice Writer are no longer needed during your Offensive Security OSCP, OSWE, OSEE, OSWP, OSEP, OSED, OSWA, OSDA, OSMR, OSTH, OSIR exam!

Now you can be efficient and faster during your exam report redaction!

• :rocket: Speed up writing, don't lose time during the 24 hours of exam report redaction
• :star: No formatting hassle with WYSIWYG editors, byebye unwanted whitespaces and linefeeds from Microsoft Office Word and LibreOffice Writer
• :memo: Re-use your Markdown notes, you'll be so glad not having to reformat the bold and italic from your Markdown notes into the report
• :lock: Version control ready, save your markdown template into a PRIVATE git repository, you now have an incremental backup, version control works with Markdown (.md) as it's text but not with binaries (.doc, .odt)
• :pen: Use your favorite editor or note taking app, with Markdown you'll be able to use your favorite editor (VSCode, Atom, etc.) or note taking app (Vnote, QOwnNotes, Boostnote, etc.) to write your exam report, you won't have to switch to Windows to use MS Word.
• :tophat: Clean & professional style, a professional looking report for your professional certification
• :ok_hand: Error free, use the generation script to generate the report and archive, you won't do any submission format and name mistake that way

Examples:

OSCP whoisflynn improved template v3.2

OSCP Official Offensive Security Template v1

Requirements

• Pandoc
• LaTeX (eg. TeX Live) in order to get pdflatex or xelatex
• Eisvogel Pandoc LaTeX PDF Template
• p7zip (if you want to use the script, for generating the archive)

Examples for common distros:

• ArchLinux: pacman -S p7zip haskell-pandoc texlive-basic texlive-fontsextra texlive-fontsrecommended texlive-latexextra
• openSUSE: zypper in texlive-scheme-medium pandoc p7zip-full
• Ubuntu: apt install texlive-latex-recommended texlive-fonts-extra texlive-latex-extra pandoc p7zip-full

Usage

Write your report in markdown.

Automatic

There is a script that will:

1. Let you choose the template
2. Let you choose the syntax highlight style
3. Generate the PDF (+ preview option)
4. Generate the 7z archive
5. Output MD5 hash for verification after uploading

Choose and copy a template that you will use to write your report:

ruby osert.rb init

Generate your PDF report and 7z archive

ruby osert.rb generate

[!TIP] If you run the generation several times, you may want to check the options (ruby osert.rb generate -h) to save time on the interactive prompt.

[!NOTE] osert is available as an official package on BlackArch Linux: pacman -S osert.

Manual

Generate the report PDF from the markdown template:

pandoc src/OSCP-exam-report-template_whoisflynn_v3.2.md \
-o output/OSCP-OS-XXXXX-Exam-Report.pdf \
--from markdown+yaml_metadata_block+raw_html \
--template eisvogel \
--table-of-contents \
--toc-depth 6 \
--number-sections \
--top-level-division=chapter \
--highlight-style breezedark \
--resource-path=.:src

You can change the code syntax highlight theme with --highlight-style.

Color sets

Well rendering color sets you can use in the template YAML frontmatter:

Syntax highlight themes can be listed with pandoc --list-highlight-styles.

Available templates

Report Templates:

Network Penetration Testing:

• OSCP
  • Official Offensive Security Template v1
  • Official Offensive Security Template v2
  • whoisflynn improved template v3.2
• OSWP
  • Official Offensive Security Template v1
• OSEP
  • Official Offensive Security Template v1
  • ceso improved template v1

Web Application:

• OSWA
  • Official Offensive Security Template v1
• OSWE
  • Official Offensive Security Template v1
  • noraj improved template v1
  • xl-sec improved template v1

Exploit Development:

• OSED
  • Official Offensive Security Template v1
  • epi improved template v1
• OSEE
  • Official Offensive Security Template v1
• OSCE (deprecated)
  • Official Offensive Security Template v1
• OSMR
  • Official Offensive Security Template v1

Security Operations:

• OSDA
  • Official Offensive Security Template v1

Threat Hunting:

• OSTH
  • Official Offensive Security Template v1

Incident Response:

• OSIR
  • Official Offensive Security Template v1

Offensive Security course table:

Community projects

Docker containers:

• ret2src docker
• Tripex48 docker

Mentions

• John Hammond - OSCP - Taking Notes & Resources (video) (2019-10-06)
• John Hammond - OSEP - Offensive Security Experienced Penetration Tester (video) (2021-02-05)
• 3rd Top Offensive Security Open Source Projects (2022-01-27)
• Recent mentions on social medias: Social-searcher
• Articles:
  • Unofficial OSCP Approved Tools by FalconSpy (2019-06-05)
  • OSCP Certification Journey by cougarbytes (2020-06-30)
  • Stress-free OSCP report making by Craig Underhill (2020-04-06) (Raw Archive, use about:reader?url= for better look in Firefox)

Stargazers over time

Credits

Report Templates:

• OSCP
  • Official Offensive Security Template (UNLICENSED)
  • whoisflynn improved template (UNLICENSED)
• OSWE
  • Official Offensive Security Template (UNLICENSED)
  • noraj improved template (UNLICENSED)
  • XL-SEC improved template (UNLICENSED)
• OSCE
  • Official Offensive Security Template (UNLICENSED)
• OSEE
  • Official Offensive Security Template (UNLICENSED)
• OSWP
  • Official Offensive Security Template (UNLICENSED)
• OSED
  • Official Offensive Security Template (UNLICENSED)
  • epi improved template (UNLICENSED)
• OSEP
  • Official Offensive Security Template (UNLICENSED)
  • ceso improved template (UNLICENSED)
• OSWA
  • Official Offensive Security Template (UNLICENSED)
• OSDA
  • Official Offensive Security Template (UNLICENSED)
• OSMR
  • Official Offensive Security Template (UNLICENSED)
• OSTH
  • Official Offensive Security Template (UNLICENSED)
• OSIR
  • Official Offensive Security Template (UNLICENSED)

Pandoc Template:

• Eisvogel (LICENCE): https://github.com/Wandmalfarbe/pandoc-latex-template

Placeholder image:

• Generated by https://imgplaceholder.com/