man/ronin-fuzzer.1 in ronin-1.5.0 vs man/ronin-fuzzer.1 in ronin-1.5.1

- old
+ new

@@ -1,73 +1,95 @@ -.TH ronin\-fuzzer 1 "April 2012" Ronin "User Manuals" +.\" Generated by kramdown-man 0.1.8 +.\" https://github.com/postmodern/kramdown-man#readme +.TH ronin-fuzzer 1 "April 2012" Ronin "User Manuals" +.LP .SH SYNOPSIS -.PP -\fB\fCronin fuzzer\fR [\fIoptions\fP] [\fITEMPLATE\fP] +.LP +.HP +\fBronin fuzzer\fR \[lB]\fIoptions\fP\[rB] \[lB]\fITEMPLATE\fP\[rB] +.LP .SH DESCRIPTION +.LP .PP -Fuzzes data read from a \fIFILE\fP or from \fB\fCSTDIN\fR. The fuzzed data can be written -to output files, run in commands or sent to TCP/UDP services. +Fuzzes data read from a \fIFILE\fP or from \fBSTDIN\fR\. The fuzzed data can be written +to output files, run in commands or sent to TCP\[sl]UDP services\. +.LP .SH OPTIONS +.LP .TP -\fB\fC-v\fR, \fB\fC--[no-]verbose\fR -Enable verbose output. +\fB-v\fR, \fB--[no-]verbose\fR +Enable verbose output\. +.LP .TP -\fB\fC-q\fR, \fB\fC--[no-]quiet\fR -Disable verbose output. +\fB-q\fR, \fB--[no-]quiet\fR +Disable verbose output\. +.LP .TP -\fB\fC--[no-]silent\fR -Silence all output. +\fB--[no-]silent\fR +Silence all output\. +.LP .TP -\fB\fC--[no-]color\fR -Enables color output. +\fB--[no-]color\fR +Enables color output\. +.LP .TP -\fB\fC-i\fR, \fB\fC--input\fR \fIFILE\fP -The input text FILE to parse. Data will be read from \fB\fCSTDIN\fR by default. +\fB-i\fR, \fB--input\fR \fIFILE\fP +The input text FILE to parse\. Data will be read from \fBSTDIN\fR by default\. +.LP +.HP +\fB-r\fR, \fB--rule\fR \[lB]\fIPATTERN\fP\[or]\fI\[sl]REGEXP\[sl]\fP\[or]STRING\[rB]:\[lB]\fIMETHOD\fP\[or]\fISTRING\fP\fI*N\fP\[lB]\-\fIM\fP\[rB]\[rB] +The rule to apply to the \fIINPUT\fP\. Fuzzer rules consist of a pattern and +substitution\. Patterns may be one of the following: +.LP +.nf +* A name of a Ronin Regular Expression (ex: \`unix\[ru]path\`) +* A custom Regular Expression (ex: \`\[sl]\ed\[pl]\[sl]\`) +* A plain String (ex: \`example\.com\`)\. + + Substitutions may be one of the following: + +* A method from \`Ronin::Fuzzing\` (ex: \`bad\[ru]strings\`) +* A *STRING*, repeated *N* or *M* times (ex: \`A*100\-200\`)\. +.fi +.LP .TP -\fB\fC-r\fR, \fB\fC--rule\fR [\fIPATTERN\fP|\fI/REGEXP/\fP|STRING]:[\fIMETHOD\fP|\fISTRING\fP*\fIN\fP[\-\fIM\fP]] -The rule to apply to the \fIINPUT\fP. Fuzzer rules consist of a pattern and -substitution. Patterns may be one of the following: -.RS -.IP \(bu 2 -A name of a Ronin Regular Expression (ex: \fB\fCunix_path\fR) -.IP \(bu 2 -A custom Regular Expression (ex: \fB\fC/\d+/\fR) -.IP \(bu 2 -A plain String (ex: \fB\fCexample.com\fR). -.PP -Substitutions may be one of the following: -.IP \(bu 2 -A method from \fB\fCRonin::Fuzzing\fR (ex: \fB\fCbad_strings\fR) -.IP \(bu 2 -A \fISTRING\fP, repeated \fIN\fP or \fIM\fP times (ex: \fB\fCA*100-200\fR). -.RE +\fB-o\fR, \fB--output\fR \fIPATH\fP +The output PATH to write the fuzzer to\. +.LP .TP -\fB\fC-o\fR, \fB\fC--output\fR \fIPATH\fP -The output PATH to write the fuzzer to. +\fB-c\fR, \fB--command\fR \fICOMMAND\fP +The command to run with the fuzzed data\. All ocurrences of \fB#string#\fR +will be replaced with the fuzzed data, and ocurrences of \fB#path#\fR will +be replaced with the path to the fuzzed data\. +.LP .TP -\fB\fC-c\fR, \fB\fC--command\fR \fICOMMAND\fP -The command to run with the fuzzed data. All ocurrences of \fB\fC#string#\fR will be -replaced with the fuzzed data, and ocurrences of \fB\fC#path#\fR will be replaced -with the path to the fuzzed data. +\fB-t\fR, \fB--tcp\fR \fIHOST\fP:\fIPORT\fP +The TCP service to send the fuzzed data to\. +.LP .TP -\fB\fC-t\fR, \fB\fC--tcp\fR \fIHOST\fP:\fIPORT\fP -The TCP service to send the fuzzed data to. -.TP -\fB\fC-u\fR, \fB\fC--udp\fR \fIHOST\fP:\fIPORT\fP -The UDP service to send the fuzzed data to. +\fB-u\fR, \fB--udp\fR \fIHOST\fP:\fIPORT\fP +The UDP service to send the fuzzed data to\. +.LP .SH EXAMPLES +.LP .TP -\fB\fCronin fuzzer -i http_request.txt -o bad.txt -r unix_path:bad_strings\fR +\fBronin fuzzer -i http_request.txt -o bad.txt -r unix_path:bad_strings\fR Fuzzes a HTTP request, replacing every occurrence of a UNIX path, with -strings from the \fB\fCbad_strings\fR method. +strings from the \fBbad_strings\fR method\. +.LP .SH LINKS -.TP +.LP +.PP Ronin Regular Expressions -http://ronin\-ruby.github.com/docs/ronin\-support/Regexp.html +https:\[sl]\[sl]ronin\-rb\.dev\[sl]docs\[sl]ronin\-support\[sl]Regexp\.html +.LP .TP -\fB\fCRonin::Fuzzing\fR -http://ronin\-ruby.github.com/docs/ronin\-support/Ronin/Fuzzing.html +\fBRonin::Fuzzing\fR +https:\[sl]\[sl]ronin\-rb\.dev\[sl]docs\[sl]ronin\-support\[sl]Ronin\[sl]Fuzzing\.html +.LP .SH AUTHOR +.LP .PP Postmodern -.MT postmodern.mod3@gmail.com -.ME +.MT postmodern\.mod3\[at]gmail\.com +.ME +.LP \ No newline at end of file