# penretem

_Sounds like passata 'cause it is as delicious_

Penetration Test report template written in [typst](https://typst.app).

- Provides a *Management Summary*, *Test Scope*, *Findings*, and *Appendix* section
- Easy to use, handles the formatting and typesetting hassle for you - as well as all those text you copy-paste anyway
- Supports [CVSS V3.1](https://www.first.org/cvss/v3-1/)
- Supports [TLP V2.0](https://www.first.org/tlp/)
- Supports [MITRE ATT&CK](https://attack.mitre.org/) references
- Supports [CVE](https://cve.mitre.org/) references

## Usage

Clone this repository and start writing. For a normal, off-the-shelf report, you'll only need to edit the `main.typ` and `findings.typ`.

After that, run `typst compile main.typ`.

The template has some placeholders. They are highlighted in red; to make double-sure that all of them are removed before you submit the report, call `#helper.panicOnPlaceholder.update(true)`. The `typst compile` call will then panic at the first placeholder it finds.

## License

penretem is licensed under [EUPL v1.2](https://interoperable-europe.ec.europa.eu/collection/eupl/eupl-text-eupl-12). Please contribute updates, fixes, and enhancements of this template. The cybersecurity scene depends on sharing.