# OSCP Exam Report Template in Markdown | Markdown Templates For Offensive Security **URL:** \ **Category:** Tools & Scripts\ **Tags:** tools, hacking, freebies, documents\ **Created:** [March 26, 2021, 1:30pm UTC](https://onehack.st/t/oscp-exam-report-template-in-markdown-markdown-templates-for-offensive-security/176701 "2021-03-26T13:30:21Z")\ **Posts on this page:** 1\ **Page:** 1
**Author:** ![TheStrength](https://onehack.st/user_avatar/onehack.st/thestrength/32/46753_2.png) [@TheStrength](https://onehack.st/u/TheStrength)\ **Post date:** [March 26, 2021, 1:30pm UTC](https://onehack.st/t/oscp-exam-report-template-in-markdown-markdown-templates-for-offensive-security/176701/1 "2021-03-26T13:30:21Z")
![image](https://onehack.st/uploads/default/original/3X/9/1/916980db76a827fee2bd8ed1a0ef2b76f87c3ed2.png) 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 lose 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](https://support.offensive-security.com/oscp-exam-guide/#submission-format-and-name) mistake that way Examples: **OSCP whoisflynn improved template v3.2** [![](https://camo.githubusercontent.com/8a323055693c3cc7ead954c261f5eaee801f9d1e90a065602470c7ca6f5c7bec/68747470733a2f2f692e696d6775722e636f6d2f5a3334345943512e706e67)](https://camo.githubusercontent.com/8a323055693c3cc7ead954c261f5eaee801f9d1e90a065602470c7ca6f5c7bec/68747470733a2f2f692e696d6775722e636f6d2f5a3334345943512e706e67) [![](https://camo.githubusercontent.com/c9b50d0838e73d38772fdf353856bf2b6afa8dcc67d37a0567028177a541e1e7/68747470733a2f2f692e696d6775722e636f6d2f776567624e59722e706e67)](https://camo.githubusercontent.com/c9b50d0838e73d38772fdf353856bf2b6afa8dcc67d37a0567028177a541e1e7/68747470733a2f2f692e696d6775722e636f6d2f776567624e59722e706e67) **OSCP Official Offensive Security Template v1** [![](https://camo.githubusercontent.com/4d30d09d319e332c2c6009fa17ed900dd58526bd2b3b83ab432f985a42844835/68747470733a2f2f692e696d6775722e636f6d2f397a6f574666722e706e67)](https://camo.githubusercontent.com/4d30d09d319e332c2c6009fa17ed900dd58526bd2b3b83ab432f985a42844835/68747470733a2f2f692e696d6775722e636f6d2f397a6f574666722e706e67) [![](https://camo.githubusercontent.com/da37d8900baae9a9fa1bfcb5a32c5d3157a9fcb1df456c7009c276a820f24a05/68747470733a2f2f692e696d6775722e636f6d2f4d5753677866682e706e67)](https://camo.githubusercontent.com/da37d8900baae9a9fa1bfcb5a32c5d3157a9fcb1df456c7009c276a820f24a05/68747470733a2f2f692e696d6775722e636f6d2f4d5753677866682e706e67) ## Requirements - [Pandoc](https://pandoc.org/installing.html) - LaTeX (eg. [TeX Live](http://www.tug.org/texlive/)) in order to get `pdflatex` or `xelatex` - [Eisvogel Pandoc LaTeX PDF Template](https://github.com/Wandmalfarbe/pandoc-latex-template#installation) - [p7zip](http://p7zip.sourceforge.net/) (if you want to use the script, for generating the archive) Examples for common distros: - ArchLinux: `pacman -S texlive-most pandoc p7zip` - openSUSE: `zypper in texlive-scheme-medium pandoc p7zip-full` - Ubuntu: `apt install texlive-full 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 4. Generate the 7z archive ```auto ruby generate.rb ``` ### Manual Generate the report PDF from the markdown template: ```auto 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`](https://pandoc.org/MANUAL.html#option--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: Penetration Testing: - **OSCP** - [Official Offensive Security Template v1](https://github.com/noraj/OSCP-Exam-Report-Template-Markdown/blob/master/output/OSCP-exam-report-template_OS_v1.pdf) - [Official Offensive Security Template v2](https://github.com/noraj/OSCP-Exam-Report-Template-Markdown/blob/master/output/OSCP-exam-report-template_OS_v2.pdf) - [whoisflynn](https://github.com/whoisflynn) improved [template](https://github.com/noraj/OSCP-Exam-Report-Template-Markdown/blob/master/output/OSCP-exam-report-template_whoisflynn_v3.2.pdf) v3.2 - **OSWP** - [Official Offensive Security Template v1](https://github.com/noraj/OSCP-Exam-Report-Template-Markdown/blob/master/output/OSWP-exam-report-template_OS_v1.pdf) - **OSEP** - [Official Offensive Security Template v1](https://github.com/noraj/OSCP-Exam-Report-Template-Markdown/blob/master/output/OSEP-exam-report-template_OS_v1.pdf) Web Application: - **OSWE** - [Official Offensive Security Template v1](https://github.com/noraj/OSCP-Exam-Report-Template-Markdown/blob/master/output/OSWE-exam-report-template_OS_v1.pdf) - [noraj](https://github.com/noraj) improved [template](https://github.com/noraj/OSCP-Exam-Report-Template-Markdown/blob/master/output/OSWE-exam-report-template_noraj_v1.pdf) v1 Exploit Development: - **OSED** - [Official Offensive Security Template v1](https://github.com/noraj/OSCP-Exam-Report-Template-Markdown/blob/master/output/OSED-exam-report-template_OS_v1.pdf) - [epi](https://github.com/epi052) improved [template](https://github.com/noraj/OSCP-Exam-Report-Template-Markdown/blob/master/output/OSED-exam-report-template_epi_v1.pdf) v1 - **OSEE** - [Official Offensive Security Template v1](https://github.com/noraj/OSCP-Exam-Report-Template-Markdown/blob/master/output/OSEE-exam-report-template_OS_v1.pdf) - **OSCE** ( **deprecated** ) - [Official Offensive Security Template v1](https://github.com/noraj/OSCP-Exam-Report-Template-Markdown/blob/master/output/OSCE-exam-report-template_OS_v1.pdf) Offensive Security course table: | Exam acronym | Exam name | Lab acronym | Lab name | Course designation | | --- | --- | --- | --- | --- | | **OSCP** | Offensive Security Certified Professional | PWK | Penetration Testing with Kali Linux | PEN-200 | | **OSWP** | Offensive Security Wireless Professional | OSWA | Offensive Security Wireless Attacks | PEN-210 | | **OSEP** | Offensive Security Experienced Penetration Tester | ETBD | Evasion Techniques and Breaching Defenses | PEN-300 | | **OSWE** | Offensive Security Web Expert | AWAE | Advanced Web Attacks and Exploitation | WEB-300 | | **OSED** | Offensive Security Exploit Developer | WUMED | Windows User Mode Exploit Development | EXP-301 | | **OSEE** | Offensive Security Exploitation Expert | AWE | Advanced Windows Exploitation | EXP-401 | | **OSCE** | Offensive Security Certified Expert | CTP | Cracking the Perimeter | N/A | ## Mentions - John Hammond - OSCP - Taking Notes & Resources (video) (2019-10-06) [![OSCP - Taking Notes & Resources](https://camo.githubusercontent.com/77b4f55e947eef82454ca9f027c3f39de204eaac608df2e2997cacbf919e3827/687474703a2f2f696d672e796f75747562652e636f6d2f76692f4d51476f7a5a7a485577512f302e6a7067)](https://www.youtube.com/watch?v=MQGozZzHUwQ) - 5th [Top Offensive Security Open Source Projects](https://awesomeopensource.com/projects/offensive-security) (2021-01-13) - Recent mentions on social medias: [Social-searcher](https://www.social-searcher.com/social-buzz/?q5=https%3A%2F%2Fgithub.com%2Fnoraj%2FOSCP-Exam-Report-Template-Markdown) - Articles: - [Stress-free OSCP report making](https://craigunder.me/stress-free-oscp-report-making/) by Craig Underhill (2020-04-06) - [Unofficial OSCP Approved Tools](https://falconspy.medium.com/unofficial-oscp-approved-tools-b2b4e889e707) by FalconSpy (2019-06-05) - [Journey from nothing to OSCP](https://cjhackerz.net/posts/journey-from-nothing-to-oscp/) by CJHackerz (2020-06-30) ## Stargazers over time [![Stargazers over time](https://camo.githubusercontent.com/c65a34182363f6879b119568799a1c9333fdce993046b32b79e43dd1560081fd/68747470733a2f2f7374617263686172742e63632f6e6f72616a2f4f5343502d4578616d2d5265706f72742d54656d706c6174652d4d61726b646f776e2e737667)](https://starchart.cc/noraj/OSCP-Exam-Report-Template-Markdown) ## Credits Report Templates: - **OSCP** - [Official Offensive Security Template](https://help.offensive-security.com/hc/en-us/articles/360040165632#suggested-documentation-templates) (UNLICENSED) - [whoisflynn improved template](https://github.com/whoisflynn/OSCP-Exam-Report-Template) (UNLICENSED) - **OSWE** - [Official Offensive Security Template](https://help.offensive-security.com/hc/en-us/articles/360046869951-OSWE-Exam-Guide#suggested-documentation-templates) (UNLICENSED) - [noraj improved template](https://github.com/noraj/OSCP-Exam-Report-Template-Markdown/blob/master/src/OSWE-exam-report-template_noraj_v1.md) (UNLICENSED) - **OSCE** - [Official Offensive Security Template](https://help.offensive-security.com/hc/en-us/articles/360046801331-OSCE-Exam-Guide#suggested-documentation-templates) (UNLICENSED) - **OSEE** - [Official Offensive Security Template](https://help.offensive-security.com/hc/en-us/articles/360046458732-OSEE-Exam-Guide#Documentation%20Requirements) (UNLICENSED) - **OSWP** - [Official Offensive Security Template](https://help.offensive-security.com/hc/en-us/articles/360046904731-OSWP-Exam-Guide#suggested-documentation-templates) (UNLICENSED) - **OSED** - [Official Offensive Security Template](https://help.offensive-security.com/hc/en-us/articles/360052977212-OSED-Exam-Guide#suggested-documentation-templates) (UNLICENSED) - [epi improved template](https://github.com/noraj/OSCP-Exam-Report-Template-Markdown/blob/master/src/OSED-exam-report-template_epi_v1.md) (UNLICENSED) - **OSEP** - [Official Offensive Security Template](https://help.offensive-security.com/hc/en-us/articles/360050293792-OSEP-Exam-Guide#suggested-documentation-templates) (UNLICENSED) Pandoc Template: - Eisvogel ([LICENCE](https://github.com/Wandmalfarbe/pandoc-latex-template/blob/master/LICENSE)): [https://github.com/Wandmalfarbe/pandoc-latex-template](https://github.com/Wandmalfarbe/pandoc-latex-template) Placeholder image: - Generated by [https://imgplaceholder.com/](https://imgplaceholder.com/) ## GitHub: > **[GitHub - noraj/OSCP-Exam-Report-Template-Markdown: :orange\_book: Markdown Templates for Offensive...](https://github.com/noraj/OSCP-Exam-Report-Template-Markdown)** > > :orange\_book: Markdown Templates for Offensive Security OSCP, OSWE, OSCE, OSEE, OSWP exam report