Merge pull request cncf#1124 from DavidKorczynski/fuzzing-handbook-init

Add fuzzing handbook
Michael-Susu12138 · Nov 3, 2023 · d9e43fd · d9e43fd
2 parents 85768ad + f06239d
commit d9e43fd
Show file tree

Hide file tree

Showing 23 changed files with 2,079 additions and 0 deletions.
diff --git a/security-fuzzing-handbook/README.md b/security-fuzzing-handbook/README.md
@@ -0,0 +1,21 @@
+# Fuzzing handbook
+
+Handbook for assisting in fuzzing integrations.
+
+## Building the handbook
+
+The PDF of the handbook is build with each change to the handbook.
+
+In order to build the PDF tou need to pull the pandoc/extra docker image [link](https://hub.docker.com/r/pandoc/extra)
+
+```bash
+docker pull pandoc/extra
+```
+
+Then, you can run from this folder (may need sudo):
+
+```bash
+./build.sh
+```
+
+which will update the handbook.
diff --git a/security-fuzzing-handbook/build.sh b/security-fuzzing-handbook/build.sh
@@ -0,0 +1,7 @@
+
+docker run --rm \
+             --volume "$(pwd):/data" \
+	     --user $(id -u):$(id -g) \
+	     pandoc/extra fuzzing-handbook.md \
+	     -o handbook-fuzzing.pdf \
+	     --template eisvogel --listings
diff --git a/security-fuzzing-handbook/fuzzing-handbook.md b/security-fuzzing-handbook/fuzzing-handbook.md
diff --git a/security-fuzzing-handbook/handbook-fuzzing.pdf b/security-fuzzing-handbook/handbook-fuzzing.pdf
diff --git a/security-fuzzing-handbook/imgs/Code-coverage-of-example-project.png b/security-fuzzing-handbook/imgs/Code-coverage-of-example-project.png
diff --git a/security-fuzzing-handbook/imgs/Coverage-guided-fuzzing-overview.png b/security-fuzzing-handbook/imgs/Coverage-guided-fuzzing-overview.png
diff --git a/security-fuzzing-handbook/imgs/Function-level-fuzzing-introspection.png b/security-fuzzing-handbook/imgs/Function-level-fuzzing-introspection.png
diff --git a/security-fuzzing-handbook/imgs/Fuzzing-code-coverage-report.png b/security-fuzzing-handbook/imgs/Fuzzing-code-coverage-report.png
diff --git a/security-fuzzing-handbook/imgs/Fuzzing-key-components.png b/security-fuzzing-handbook/imgs/Fuzzing-key-components.png
diff --git a/security-fuzzing-handbook/imgs/Historical-progession-of-example-project.png b/security-fuzzing-handbook/imgs/Historical-progession-of-example-project.png
diff --git a/security-fuzzing-handbook/imgs/LibFuzzer-engine-overview.png b/security-fuzzing-handbook/imgs/LibFuzzer-engine-overview.png
diff --git a/security-fuzzing-handbook/imgs/Minimized-testcase-provided-per-issue.png b/security-fuzzing-handbook/imgs/Minimized-testcase-provided-per-issue.png
diff --git a/security-fuzzing-handbook/imgs/Monorail-issues-are-closed-automatically.png b/security-fuzzing-handbook/imgs/Monorail-issues-are-closed-automatically.png
diff --git a/security-fuzzing-handbook/imgs/OSS-Fuzz-GitHub-bot-automatically-closes-issus.png b/security-fuzzing-handbook/imgs/OSS-Fuzz-GitHub-bot-automatically-closes-issus.png
diff --git a/security-fuzzing-handbook/imgs/OSS-Fuzz-GitHub-bot-reporting-an-issue.png b/security-fuzzing-handbook/imgs/OSS-Fuzz-GitHub-bot-reporting-an-issue.png
diff --git a/security-fuzzing-handbook/imgs/OSS-Fuzz-detailed-stack-trace.png b/security-fuzzing-handbook/imgs/OSS-Fuzz-detailed-stack-trace.png
diff --git a/security-fuzzing-handbook/imgs/OSS-Fuzz-issue-overview.png b/security-fuzzing-handbook/imgs/OSS-Fuzz-issue-overview.png
diff --git a/security-fuzzing-handbook/imgs/Open-source-fuzz-introspection-overview.png b/security-fuzzing-handbook/imgs/Open-source-fuzz-introspection-overview.png
diff --git a/security-fuzzing-handbook/imgs/Source-level-code-coverage.png b/security-fuzzing-handbook/imgs/Source-level-code-coverage.png
diff --git a/security-fuzzing-handbook/imgs/cncf-logo-footer.png b/security-fuzzing-handbook/imgs/cncf-logo-footer.png
diff --git a/security-fuzzing-handbook/imgs/cncf-stacked-color.png b/security-fuzzing-handbook/imgs/cncf-stacked-color.png
diff --git a/security-fuzzing-handbook/imgs/envoy-introspector-profile.png b/security-fuzzing-handbook/imgs/envoy-introspector-profile.png
diff --git a/security-fuzzing-handbook/imgs/vitess-fuzzing-landscape.png b/security-fuzzing-handbook/imgs/vitess-fuzzing-landscape.png