Offensive Security Exam Report Template

Requirements

1. Docker and docker-compose

sudo apt update
sudo apt install -y docker.io
sudo systemctl enable docker --now
sudo apt install docker-compose
sudo usermod -aG docker $USER
sudo reboot now

2. Recomended screenshot tool

• xclip (Snipping Tool that saves images on clipboard)

sudo apt install xclip flameshot

Important

After intall, add keyboard shortcut (keyboard > Application Shortcuts > +Add)

Shortcut: Alt + S
Command: flameshot gui

3. VSCode

• Download and install manually official vscode: https://code.visualstudio.com/docs/?dv=linux64_deb
• VSCode extensions:

< Manage extension settings and edit folloing path:

Tip

For paste images on documents: CTRL + ALT + V

Usage

git clone https://github.com/ohydra/OSCP-Report-Template.git
cd ~/OSCP-Report-Template

And now, in VSCode inport the folder like the following example:

Tip

For build the report easily, use the terminal window inside VSCode.

Build report

After editing, and to verifying the report's build, execute the commands below in order:

• Generate the docker image with

./build.sh

• Enter the container that has all the LaTeX dependencies

./run.sh

• Generate pdf with

./build_pdf.sh

Customize

build_pdf.sh contains the paths from the source and the target, do not change the main folder src as this is hardcoded in the osert.rb, but you can change the report.md to something else.

Same for output folder (do not change it), but you can change the filename to something else.

#!/bin/bash
ruby osert.rb generate 'src/report.md' 'output/report.pdf'

Report Templates:

• OSCP whoisflynn improved template v3.2
  

• OSCP Official Offensive Security Template v1
  

• Others

  • Network Penetration Testing:

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

  • Web Application:

    • OSWA
      • Official Offensive Security Template v1
    • OSWE
      • Official Offensive Security Template v1
      • [noraj][noraj] improved template v1
      • [xl-sec][XL-SEC] improved template v1

  • Exploit Development:

    • OSED
      • Official Offensive Security Template v1
      • [epi][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:

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	WA	Wireless Attacks	PEN-210
OSEP	Offensive Security Experienced Penetration Tester	ETBD	Evasion Techniques and Breaching Defenses	PEN-300
OSWA	Offensive Security Web Assessor	WAKL	Web Attacks with Kali Linux	WEB-200
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
OSMR	Offensive Security macOS Researcher	MCB	macOS Control Bypasses	EXP-312
OSEE	Offensive Security Exploitation Expert	AWE	Advanced Windows Exploitation	EXP-401
OSCE	Offensive Security Certified Expert	CTP	Cracking the Perimeter	N/A
OSDA	Offensive Security Defense Analyst	SODA	Security Operations and Defensive Analysis	SOC-200
OSTH	Offensive Security Threat Hunting	TH	Threat Hunting	TH-200
OSIR	Offensive Security Incident Response	IR	Incident Response	IR-200

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)

Note

The respective color categories can be changed on the top of report.md file.

Credits

• Cloned and modified from https://github.com/blu3drag0nsec/report-template
• Inspired in the work of https://github.com/noraj/OSCP-Exam-Report-Template-Markdown