added fuzzing/README file
authorMichael Rash <mbr@cipherdyne.org>
Thu, 25 Oct 2012 04:20:55 +0000 (00:20 -0400)
committerMichael Rash <mbr@cipherdyne.org>
Thu, 25 Oct 2012 04:20:55 +0000 (00:20 -0400)
test/fuzzing/README [new file with mode: 0644]

diff --git a/test/fuzzing/README b/test/fuzzing/README
new file mode 100644 (file)
index 0000000..4bac9b8
--- /dev/null
@@ -0,0 +1,44 @@
+
+### Generating new fuzzing SPA packets:
+
+- Apply a patch or set of patches to libfko to ignore error conditions and
+  recompile.
+- Run the test suite as follows to generate new fuzzing SPA packets:
+
+    # ./test-fwknop.pl --enable-perl-module-pkt-gen
+
+      [+] Starting the fwknop test suite...
+
+          args: --enable-perl-module-pkt-gen
+
+          Saved results from previous run to: output.last/
+
+      [perl FKO module] [compile/install] to: ./FKO.......................pass (1)
+      [perl FKO module] [FUZZING] generate invalid SPA pkts...............pass (2)
+
+      [+] Wrote 169 fuzzing SPA packets to fuzzing/fuzzing_spa_packets.tmp...
+
+- Review the packet data in the fuzzing_spa_packets.tmp file, and move to
+  fuzzing/fuzzing_spa_packets if acceptable.
+- Reverse the fuzzing patch mentioned above and recompile.
+- Now send the packets through libfko as follows:
+
+    # ./test-fwknop.pl --enable-perl-module-checks --include "perl FKO"
+
+- If there is another patch to apply, then add a fuzzing tag so that the
+  packets can easily be differentiated and appended to the official
+  "fuzzing_spa_packets" file:
+
+    # ./test-fwknop.pl --enable-perl-module-pkt-gen --fuzzing-pkts-append --fuzzing-test-tag "no_colon_1"
+
+      [+] Starting the fwknop test suite...
+
+          args: --enable-perl-module-pkt-gen --fuzzing-pkts-append --fuzzing-test-tag no_colon_1
+
+              Saved results from previous run to: output.last/
+
+       [perl FKO module] [compile/install] to: ./FKO.......................pass (1)
+       [perl FKO module] [FUZZING] generate invalid SPA pkts...............pass (2)
+
+       [+] Wrote 169 fuzzing SPA packets to fuzzing/fuzzing_spa_packets.tmp...
+