From 193a7c3900441c67c2f87ff4322bb38a9929fb11 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Stefan=20Gr=C3=B6nke?= <stefan@gronke.net>
Date: Sat, 11 Jul 2026 09:39:17 +0000
Subject: [PATCH 1/2] fix(templates): make finding templates and example
 validate against the schema

The placeholder id "..." is no valid xs:ID and the finding template and
example lacked the required number attribute, so the documents authors
start from failed schema validation from the first second.
The template comment now documents the id constraints and the number
attribute.
---
 doc/examples/examplefinding.xml         | 2 +-
 templates/pentestreport/finding.xml     | 7 +++++--
 templates/pentestreport/non-finding.xml | 2 +-
 3 files changed, 7 insertions(+), 4 deletions(-)

diff --git a/doc/examples/examplefinding.xml b/doc/examples/examplefinding.xml
index 134ec11b..bf7f5da4 100644
--- a/doc/examples/examplefinding.xml
+++ b/doc/examples/examplefinding.xml
@@ -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.
diff --git a/templates/pentestreport/finding.xml b/templates/pentestreport/finding.xml
index 8b2f3f57..507ef5de 100644
--- a/templates/pentestreport/finding.xml
+++ b/templates/pentestreport/finding.xml
@@ -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.
 
diff --git a/templates/pentestreport/non-finding.xml b/templates/pentestreport/non-finding.xml
index 911d7b40..4a4a7266 100644
--- a/templates/pentestreport/non-finding.xml
+++ b/templates/pentestreport/non-finding.xml
@@ -1,4 +1,4 @@
-<non-finding id="..." number="00">
+<non-finding id="unique_non_finding_id" number="00">
 
   <title>Title Case</title>
 

From 10b2c7ce6c16fee5c5b61f0a3fb7a6a8b0e02e2c Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Stefan=20Gr=C3=B6nke?= <stefan@gronke.net>
Date: Sat, 11 Jul 2026 09:39:17 +0000
Subject: [PATCH 2/2] fix(sample-report): correct the spearphishing finding id

The id carried a typo ("spearphising") that made it deviate from the
filename-matching convention the templates document.
---
 sample-report/source/findings/spearphishing.xml | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/sample-report/source/findings/spearphishing.xml b/sample-report/source/findings/spearphishing.xml
index dbe7474b..0c5b90a1 100644
--- a/sample-report/source/findings/spearphishing.xml
+++ b/sample-report/source/findings/spearphishing.xml
@@ -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>