Skip to content

fix: corpus validity #165

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
PeterMosmans merged 2 commits into from
Jul 21, 2026
Merged

fix: corpus validity #165

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
193a7c3
fix(templates): make finding templates and example validate against t…
gronke Jul 11, 2026
10b2c7c
fix(sample-report): correct the spearphishing finding id
gronke Jul 11, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion doc/examples/examplefinding.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<finding threatLevel="Moderate" type="Escalation">
<finding id="examplefinding" threatLevel="Moderate" type="Escalation" number="1">
<title>Example Title</title>
<description>
A specialized piece of malware can be crafted to bypass local anti-virus software and to cheat during tests.
Expand Down
2 changes: 1 addition & 1 deletion sample-report/source/findings/spearphishing.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<finding id="spearphising" threatLevel="High" type="Social engineering" number="10">
<finding id="spearphishing" threatLevel="High" type="Social engineering" number="10">
<title>Social engineering</title>

<description>
Expand Down
7 changes: 5 additions & 2 deletions templates/pentestreport/finding.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,11 @@
<finding id="..." threatLevel="Moderate" type="Information Leak">
<finding id="unique_finding_id" threatLevel="Moderate" type="Information Leak" number="1">

<!--
id needs to be unique across the report, preferably identical to the filename
(without extension).
(without extension). It must be a valid XML ID: it starts with a letter or
underscore and contains no spaces.

number is the finding number within the report.

threatLevel can be Low, Moderate, Elevated, High or Extreme.

Expand Down
2 changes: 1 addition & 1 deletion templates/pentestreport/non-finding.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<non-finding id="..." number="00">
<non-finding id="unique_non_finding_id" number="00">

<title>Title Case</title>

Expand Down
Loading