Code Monkey home page Code Monkey logo

pentest-report-template-latex's Introduction

Pre word

Hey there! Before I say anything else, I borrowed this template from Sudneo and made it my own. Thank them for anything that actually works, thank me for all the wonky additions ;).

I was wildly unhappy with the lack of latex templates with (in my humble opinion) a decent design. So I tried making my own and used it for my eCPPTv2 exam.

Things I added:

  • newtcolorboxes as section titles. Check examples and custom.tex to see how they work. E.g. \boxhighsection{Privilege Escalation through Misconfiguration (High 8.8)}[CWE 250]
  • \image to easily include images works as follows: \image[optional size]{image.png}{Description text} E.G. \image[420pt]{hafunny.png}{A very descriptive description.} Ow they also automatically get assigned a Figure number.
  • Pretty code boxes. See Critical template for info.

I guess that was all I'm useful for. Find a decently written write up by Sudneo below, my apologies if I have broken any of his stuff ;)

Penetration Testing Template

This is a template I am compiling together in preparation for the eCPPT exam.

The content is mostly taken from TCM's Report and some cosmetic changes are added.

Motivation

The reasons why I wanted to convert the template in LaTeX are:

  • I find LaTeX formatting to be stable and with it there is no need to mess with a WYSIWYG editor, dragging tables etc.
  • I can integrate it with Vim for a more productive experience.

Content of the Repo

This repository contains:

  • The LaTeX source code and corresponding images for the report
  • Vim snippets I used to automate some parts, in particular, the sections about the findings.

Vim

The idea of this template is that the main part will be fairly constant across engagements, while the part that changes the most (findings) should be smooth to write. For this reason, the plan is to use Vim with Ultisnips, to generate table for findings in a very quick way, with pre-filled options and structure.

How to Use

To get started, just clone this repo and add the content of snippets.vim to your custom snippets file or to your LaTeX filetype snippets.

Variables and definitions

The LaTeX code should be straightforward and commented, but it's worth mentioning that you can customize the look using the following definitions:

% Name of the Company
\newcommand{\companyName}{Company Name}
% Shortened name of the company (use \companyName if full name should be used)
\newcommand{\companyNameShort}{CN}
% Name of the document
\newcommand{\reportName}{Security Assessment Finding Report}
% Name of pentesting company
\newcommand{\pentester}{Sudneo Security}
% Shortened name of the pentesting company (use \pentester if full name should be used)
\newcommand{\pentesterShort}{SSec}
% URL of pentesting company
\newcommand{\pentesterSite}{\url{https://coolbyte.eu}}

Also, all the images in the images directory can be referenced directly.

Finally, if you want to change the colors used, please change them in the header to maintain a consistent look:

\definecolor{link-blue}{RGB}{6,69,173}
\definecolor{dark-green}{RGB}{52,133,62}
\definecolor{light-blue}{RGB}{127, 180, 240}
\definecolor{dark-blue}{RGB}{72, 120, 224}
\definecolor{heading-grey}{RGB}{181, 185, 189}
\definecolor{Critical}{RGB}{173, 35, 10}
\definecolor{High}{RGB}{224, 133, 47}
\definecolor{Moderate}{RGB}{237, 199, 7}
\definecolor{Low}{RGB}{93,186,105}
\definecolor{Informational}{RGB}{78, 142, 245}

pentest-report-template-latex's People

Contributors

savdbroek avatar

Stargazers

 avatar Chu Tiến Thịnh avatar A. S. M. Muhiminul Hasan avatar Etienne avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.