/OSCP-Exam-Report-Generator-From-Markdown

:orange_book: OSCP Exam Report Template in Markdown

Primary LanguageRubyMIT LicenseMIT

Notice - This repo has moved to GitLab - https://gitlab.com/initinfosec/OSCP-Exam-Report-Generator-From-Markdown

OSCP Exam Report from Markdown Generator

Rawsec's CyberSecurity Inventory GitHub stars GitHub forks GitHub license

Fork & update/overhaul of noraj's original script to provide more flexibility & ease in report generation.

  • included options for user-defined/custom-made template & added TJNull's OSCP exam report from TJ-JPT jex file
  • added a variety of selections in menu to create more options without custom report mods
  • created setup.sh file to install & stage requirements w/o manual placement of dependencies [Kali Linux specific]

Requirements

  • kali with sudo access
  • report written in md
  • ruby installed (presume script wiill be running from kali, so not included in setup.sh)

Usage

  1. Write your report in markdown.
  2. Run git clone https://github.com/initinfosec/OSCP-Exam-Report-Template-Markdown.git
  3. Run ./setup.sh to install necessary software & template (pandoc, LaTeX-full, p7zip-full, eisvogel template)
  4. Copy markdown report below header information in desired template
  5. Run ruby generate.rb to go through automatic generation detailed below.
  6. Step through menu to make choices - use numbers only for selections - header & report will modify according to selections
  7. PDF and 7z archive will be generated
  8. Manually verify output before submitting.

Automatic

running ruby generate.rb will:

  1. Let you choose the template
  2. Let you choose the syntax highlight style
  3. Enter your OS-ID & email
  4. Choose report type: (lab & exam or exam only)
  5. Let you choose the titlepage colour, titlepage text colour
  6. Generate the PDF
  7. Generate the 7z archive

notices / caveats

  • no fancy input verification - make sure your OS-ID & email are correct. Make sure your selections from menu options are numbers only
  • can now choose custom colour from menu option - choice must be 6 character hex representation only
  • no need to modify header info before running ruby script - will edit needed info as you go
  • make sure image paths are correct (either full/explicit or reletive paths) before generation so pandoc includes them in the PDF.

From noraj:

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

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

Stargazers over time

Stargazers over time

Credits

Original script:

Report Templates:

Pandoc Template:

Placeholder image:

OffSec Logo image: