Merge pull request #126 from nineinchnick/threats-template

render threats into a human readable format

CHANGELOG.md

@@ -1,6 +1,7 @@
 # 1.1.3
 
 - Added HTML docs using pdoc [#110](https://github.com/izar/pytm/pull/110)
+- Added a markdown file with threats [#126](https://github.com/izar/pytm/pull/126)
 - Fixed drawing nested boudnaries [#117](https://github.com/izar/pytm/pull/117)
 
 # 1.1.2

Makefile

@@ -18,6 +18,10 @@ all: $(models:.py=/report.html) $(models:.py=/dfd.png) $(models:.py=/seq.png) do
 docs/pytm/index.html: $(wildcard pytm/*.py)
 	PYTHONPATH=. pdoc --html --force --output-dir docs pytm
 
+docs/threats.md: $(wildcard pytm/threatlib/*.json)
+	printf "# Threat database\n" > $@
+	jq -r ".[] | \"$$(cat docs/threats.jq)\"" $< >> $@
+
 clean:
 	rm -rf dist/* build/* $(models:.py=/*)
 
@@ -52,7 +56,7 @@ image:
 	docker build -t $(DOCKER_IMG) .
 
 .PHONY: docs
-docs: docs/pytm/index.html
+docs: docs/pytm/index.html docs/threats.md
 
 .PHONY: fmt
 fmt:

docs/threats.jq

@@ -0,0 +1,24 @@
+## \(.SID) \(.description)
+
+\(.details)
+
+<dl>
+  <dt>Severity</dt>
+  <dd>\(.severity)</dd>
+
+  <dt>Prerequisites</dt>
+  <dd>\(.prerequisites)</dd>
+
+  <dt>Example</dt>
+  <dd>\(.example)</dd>
+
+  <dt>Mitigations</dt>
+  <dd>\(.mitigations)</dd>
+
+  <dt>References</dt>
+  <dd>\(.references)</dd>
+
+  <dt>Condition</dt>
+  <dd>\(.condition)</dd>
+</dl>
+\n\n