OSCP Exam Report Template in Markdown
This is my OSCP exam notes template, based on the fine work by noraj in his OSCP-Exam-Report-Template-Markdown (LICENSE)
This allow fast and efficient note writing during both the labs and the exam.
Instead of one huge report file, this template is based on several smaller markdown files, which are stitched together using MarkdownPP before generating the final report with Pandoc.
The report text is the whoisflynn improved version of the official PWK Example Report.
pdflatex
or xelatex
OSID=""
.Add exercises to the Lab/Exercises directory, save as .md files. Prefix the file with the chapter number, to ensure that the exercises will be included in the correct order.
Add targets in Lab/Targets and Exam/Targets, save as .md files.
You can change the code syntax highlight theme by modifying --highlight-style
in generate-report.sh.
Well rendering color sets you can use in the template YAML:
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) |
VS Code is a very good editor, and it is also a very good Markdown editor! The following extensions will make it even better (better for more than just Markdown):
To make it even better, install Fira Code and Noto Color Emoji:
sudo apt install fonts-firacode
sudo apt install fonts-noto-color-emoji
{
"telemetry.enableTelemetry": false,
"telemetry.enableCrashReporter": false,
"editor.formatOnSave": true,
"workbench.iconTheme": "vscode-icons",
"editor.fontFamily": "Fira Code,Noto Color Emoji",
"editor.fontSize": 14,
"editor.fontLigatures": true,
"markdown-pdf.executablePath": "/opt/google/chrome/chrome",
"editor.codeActionsOnSave": {
"source.fixAll.markdownlint": true
}
}
MarkdownPP has a bug that will break include statements inside C-code blocks. This bug has been fixed in this fork: https://github.com/miguelangelnieto/markdown-pp
noraj OSCP-Exam-Report-Template-Markdown ((LICENSE)): https://github.com/noraj/OSCP-Exam-Report-Template-Markdown
JohnHammond oscp-notetaking (UNLICENSED): https://github.com/JohnHammond/oscp-notetaking
whoisflynn improved template v3.2 (UNLICENSED): https://github.com/whoisflynn/OSCP-Exam-Report-Template
Eisvogel (LICENSE): https://github.com/Wandmalfarbe/pandoc-latex-template