README.md

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, OSCE, OSEE, OSWP exam!

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

• 🚀 Speed up writing, don't loose time during the 24 hours of exam report redaction
• ⭐ No formatting hassle with WYSIWYG editors, byebye unwanted whitespaces and linefeeds from Microsoft Office Word and LibreOffice Writer
• 📝 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
• 🔒 Version control ready, save your markdown template into a PRIVATE git repository, you know have an incremental backup, version control works with Markdown (.md) as it's text but not with binaries (.doc, .odt)
• 🖊️ 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.
• 🎩 Clean & professional style, a professional looking report for your professional certification
• 👌 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)

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
4. Generate the 7z archive

ruby generate.rb

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

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:

titlepage-color	titlepage-text-color	titlepage-rule-color
DC143C (Crimson)	FFFFFF (White)	FFFFFF (White)
00FF7F (SpringGreen)	006400 DarkGreen	000000 (Black)
1E90FF (DodgerBlue)	FFFAFA (Snow)	FFFAFA (Snow)
483D8B (DarkSlateBlue)	FFFAFA (Snow)	FFFAFA (Snow)
FFD700 (Gold)	000000 (Black)	000000 (Black)
FFEFD5 (PapayaWhip)	000000 (Black)	000000 (Black)
FF8C00 (DarkOrange)	000000 (Black)	000000 (Black)
FFEF96 (no name)	50394C (no name)	50394C (no name)

Available templates

Report Templates:

• OSCP
  • Official Offensive Security Template v1
  • whoisflynn improved template v3.2
• OSWE
  • Official Offensive Security Template v1
• OSCE
  • Official Offensive Security Template v1
• OSEE
  • Official Offensive Security Template v1
• OSWP
  • Official Offensive Security Template v1

Mentions

• Recent mentions on social medias:

• John Hammond - OSCP - Taking Notes & Resources (video)

• 8th Top Offensive Security Open Source Projects (08 Apr. 2020)

Stargazers over time

Credits

Report Templates:

• OSCP
  • Official Offensive Security Template v1 (UNLICENSED)
  • whoisflynn improved template v3.2 (UNLICENSED)
• OSWE
  • Official Offensive Security Template v1 (UNLICENSED)
• OSCE
  • Official Offensive Security Template v1 (UNLICENSED)
• OSEE
  • Official Offensive Security Template v1 (UNLICENSED)
• OSWP
  • Official Offensive Security Template v1 (UNLICENSED)

Pandoc Template:

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

Placeholder image:

• Generated by https://imgplaceholder.com/