doc updates to include material about AFL support

This commit is contained in:
Michael Rash
2014-11-15 00:15:55 -05:00
parent aaa44656bc
commit 665b65ef3e
3 changed files with 24 additions and 7 deletions
+7
View File
@@ -21,6 +21,13 @@ fwknop-2.6.4 (10//2014):
https://fedoraproject.org/wiki/FirewallD
- [server] Added support for the 'American Fuzzy Lop' (AFL) fuzzer from
Michal Zalewski. This requires that fwknop is compiled with the
'--enable-afl-fuzzing' argument to the configure script as this allows
encryption/digest short circuiting in a manner necessary for AFL to
function properly. The benefit of this strategy is that AFL can fuzz the
SPA packet decoding routines implemented by libfko. See the test/afl/
directory for some automation around AFL fuzzing.
- (Bill Stubbs) submitted a patch to fix a bug where fwknopd could not
handle Ethernet frames that include the Frame Check Sequence (FCS)
header. This header is four bytes long, and is placed at the end of each
+3 -2
View File
@@ -1038,8 +1038,9 @@ The most comprehensive way to gain diagnostic information on *fwknop* is to run
the test suite 'test-fwknop.pl' script located in the 'test/' directory in the fwknop
sources. The test suite sends fwknop through a large number of run time
tests, has 'valgrind' support, validates both SPA encryption and HMAC results
against OpenSSL, and even has its own built in fuzzer for SPA communications.
For more basic diagnostic information, *fwknop* can be executed with the *-T*
against OpenSSL, and even has its own built in fuzzer for SPA communications (and
fwknop in version 2.6.4 supports the 'American Fuzzy Lop' (AFL) from Michal Zalewski
as well). For more basic diagnostic information, *fwknop* can be executed with the *-T*
(or *--test*) command line option. This will have *fwknop* simply create and
print the SPA packet information, then run it through a decrypt/decode cycle
and print it again. In addition, the *--verbose* command line switch is useful
+14 -5
View File
@@ -72,7 +72,7 @@ COMMAND-LINE OPTIONS
*-D, --dump-config*::
Dump the configuration values that *fwknopd* derives from the
'@sysconfdir@/fwknop/fwknopd.conf'' (or override files) and '@sysconfdir@/fwknop/access.conf' on stderr.
'@sysconfdir@/fwknop/fwknopd.conf' (or override files) and '@sysconfdir@/fwknop/access.conf' on stderr.
*--dump-serv-err-codes*::
Dump all possible *fwknopd* error codes to stdout and exit. This option is
@@ -87,6 +87,15 @@ COMMAND-LINE OPTIONS
version of fwknop will not have code compiled in to enable this capability
at run time. It is documented here for completeness.
*-A, --afl-fuzzing*::
Instruct *fwknopd* to acquire SPA packets directly from stdin in support of
fuzzing operations from the 'American Fuzzy Lop' (AFL) fuzzer written by Michal
Zalewski. This requires that *fwknop* is compiled with the '--enable-afl-fuzzing'
argument to the *configure* script as this allows encryption/digest short
circuiting in a manner necessary for AFL to function properly. The benefit of
this strategy is that AFL can fuzz the SPA packet decoding routines implemented
by *libfko*.
*--fw-list-all*::
List all firewall rules including those that have nothing to do with
*fwknopd*.
@@ -116,7 +125,7 @@ COMMAND-LINE OPTIONS
*-O, --override-config*='<file>'::
Override config variable values that are normally read from the
'@sysconfdir@/fwknop/fwknopd.conf'' file with values from the specified file. Multiple
'@sysconfdir@/fwknop/fwknopd.conf' file with values from the specified file. Multiple
override config files can be given as a comma-separated list.
*-p, --pid-file*='<pid-file>'::
@@ -127,7 +136,7 @@ COMMAND-LINE OPTIONS
*-P, --pcap-filter*='<filter>'::
Specify a Berkeley packet filter statement on the *fwknopd* command
line. This overrides the value of the PCAP_FILTER variable taken
from the '@sysconfdir@/fwknop/fwknopd.conf'' file.
from the '@sysconfdir@/fwknop/fwknopd.conf' file.
*--pcap-file*='<pcap-file>'::
This option instructs *fwknopd* to read packet data from a pcap file
@@ -186,7 +195,7 @@ COMMAND-LINE OPTIONS
FWKNOPD CONFIG AND ACCESS VARIABLES
-----------------------------------
*fwknopd* references the '@sysconfdir@/fwknop/fwknopd.conf'' file for configuration variables
*fwknopd* references the '@sysconfdir@/fwknop/fwknopd.conf' file for configuration variables
that define its operational parameters (what network interface and port
to sniff, what features to enable/disable, etc.). The 'fwknopd.conf' file
does not define any access control directives.
@@ -202,7 +211,7 @@ This section list the more prominent configuration variables used by
*fwknopd*. It is not a complete list. There are directives for the type
of firewall used by *fwknopd* (i.e. _iptables_, _ipfw_, or _pf_). You will
want to make sure to check these to make sure they have appropriate values.
See the '@sysconfdir@/fwknop/fwknopd.conf'' file for the full list and corresponding details.
See the '@sysconfdir@/fwknop/fwknopd.conf' file for the full list and corresponding details.
*PCAP_INTF* '<interface>'::
Specify the ethernet interface on which *fwknopd* will sniff packets.