README.md

OSCP Exam Report Template in Markdown

I created an OSCP Exam Report Template in Markdown so LaTeX, Microsoft Office Word, LibreOffice Writter are no longer needed during your OSCP exam!

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

whoisflynn improved template v3.2

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)

Mentions

• Mentions on social medias:

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

• 15th Top Offensive Security Open Source Projects (2 January 2020)

Credits

Report Templates:

• Official Offensive Security Template v1 (UNLICENSED): https://support.offensive-security.com/oscp-exam-guide/#suggested-documentation-templates
• whoisflynn improved template v3.2 (UNLICENSED): https://github.com/whoisflynn/OSCP-Exam-Report-Template

Pandoc Template:

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

Placeholder image:

• Generated by https://imgplaceholder.com/