ronin 1.5.1 → 2.0.0.beta1

data/man/ronin-grep.1.md

@@ -0,0 +1,206 @@
+# ronin-grep 1 "May 2022" Ronin "User Manuals"
+
+## SYNOPSIS
+
+`ronin grep` [*options*] [*FILE* ...]
+
+## DESCRIPTION
+
+Greps for common patterns in the given file(s) or input stream.
+
+## ARGUMENTS
+
+*FILE*
+  The optional file to grep. If no *FILE* arguments are given, then
+  `ronin grep` will read from standard input.
+
+## OPTIONS
+
+`-N`, `--number`
+  Searches for all numbers.
+
+`-X`, `--hex-number`
+  Searches for all hexadecimal numbers.
+
+`-V`, `--version-number`
+  Searches for all version numbers.
+
+`-w`, `--word`
+  Searches for all words.
+
+`--mac-addr`
+  Searches for all MAC addresses.
+
+`-4`, `--ipv4-addr`
+  Searches for all IPv4 addresses.
+
+`-6`, `--ipv6-addr`
+  Searches for all IPv6 addresses.
+
+`-I`, `--ip`
+  Searches for all IP addresses.
+
+`-H`, `--host`
+  Searches for all host names.
+
+`-D`, `--domain`
+  Searches for all domain names.
+
+`--uri`
+  Searches for all URIs.
+
+`-U`, `--url`
+  Searches for all URLs.
+
+`--user-name`
+  Searches for all user names.
+
+`-E`, `--email-addr`
+  Searches for all email addresses.
+
+`--obfuscated-email-addr`
+  Searches for all obfuscated email addresses.
+
+`--phone-number`
+  Searches for all phone numbers.
+
+`--ssn`
+  Searches for all Social Security Numbers (SSNs).
+
+`--amex-cc`
+  Searches for all AMEX Credit Card numbers.
+
+`--discover-cc`
+  Searches for all Discord Card numbers.
+
+`--mastercard-cc`
+  Searches for all MasterCard numbers.
+
+`--visa-cc`
+  Searches for all VISA Credit Card numbers.
+
+`--visa-mastercard-cc`
+  Searches for all VISA MasterCard numbers.
+
+`--cc`
+  Searches for all Credit Card numbers.
+
+`--file-name`
+  Searches for all file names.
+
+`--dir-name`
+  Searches for all directory names.
+
+`--relative-unix-path`
+  Searches for all relative UNIX paths.
+
+`--absolute-unix-path`
+  Searches for all absolute UNIX paths.
+
+`--unix-path`
+  Searches for all UNIX paths.
+
+`--relative-windows-path`
+  Searches for all relative Windows paths.
+
+`--absolute-windows-path`
+  Searches for all absolute Windows paths.
+
+`--windows-path`
+  Searches for all Windows paths.
+
+`--relative-path`
+  Searches for all relative paths.
+
+`--absolute-path`
+  Searches for all absolute paths.
+
+`-P`, `--path`
+  Searches for all paths.
+
+`--variable-name`
+  Searches for all variable names.
+
+`--function-name`
+  Searches for all function names.
+
+`--md5`
+  Searches for all MD5 hashes.
+
+`--sha1`
+  Searches for all SHA1 hashes.
+
+`--sha256`
+  Searches for all SHA256 hashes.
+
+`--sha512`
+  Searches for all SHA512 hashes.
+
+`--hash`
+  Searches for all hashes.
+
+`--ssh-private-key`
+  Searches for all SSH private key data.
+
+`--ssh-public-key`
+  Searches for all SSH public key data.
+
+`-K`, `--private-key`
+  Searches for all private key data.
+
+`--rsa-public-key`
+  Searches for all RSA public key data.
+
+`--dsa-public-key`
+  Searches for all DSA public key data.
+
+`--ec-public-key`
+  Searches for all EC public key data.
+
+`--public-key`
+  Searches for all public key data.
+
+`--aws-access-key-id`
+  Searches for all AWS access key IDs.
+
+`--aws-secret-access-key`
+  Searches for all AWS secret access key.
+
+`-A`, `--api-key`
+  Searches for all API keys (MD5, SHA1, SHA256, SHA512, AWS access key ID, or
+  AWS secret access key).
+
+`--single-quoted-string`
+  Searches for all single-quoted strings.
+
+`--double-quoted-string`
+  Searches for all double-quoted strings.
+
+`-S`, `--string`
+  Searches for all quoted strings.
+
+`-B`, `--base64`
+  Searches for all Base64 strings.
+
+`-e`, `--regexp` /*REGEXP*/
+  Custom regular expression to search for.
+
+`-o`, `--only-matching`
+  Only print the matching data.
+
+`-n`, `--line-number`
+  Print the line number for each line.
+
+`--with-filename`
+  Print the file name for each match.
+
+`-h`, `--help`
+  Print help information.
+
+## AUTHOR
+
+Postmodern <postmodern.mod3@gmail.com>
+
+## SEE ALSO
+
+ronin-extract(1)

data/man/ronin-help.1

@@ -1,6 +1,6 @@
 .\" Generated by kramdown-man 0.1.8
 .\" https://github.com/postmodern/kramdown-man#readme
-.TH ronin-help 1 "April 2012" Ronin "User Manuals"
+.TH ronin-help 1 "May 2022" Ronin "User Manuals"
 .LP
 .SH SYNOPSIS
 .LP
@@ -22,20 +22,8 @@ The optional command to get detailed help information on\.
 .SH OPTIONS
 .LP
 .TP
-\fB-v\fR, \fB--[no-]verbose\fR
-Enable verbose output\.
-.LP
-.TP
-\fB-q\fR, \fB--[no-]quiet\fR
-Disable verbose output\.
-.LP
-.TP
-\fB--[no-]silent\fR
-Silence all output\.
-.LP
-.TP
-\fB--[no-]color\fR
-Enables color output\.
+\fB-h\fR, \fB--help\fR
+Print help information
 .LP
 .SH AUTHOR
 .LP

data/man/ronin-help.1.md

@@ -1,4 +1,4 @@
-# ronin-help 1 "April 2012" Ronin "User Manuals"
+# ronin-help 1 "May 2022" Ronin "User Manuals"
 
 ## SYNOPSIS
 
@@ -16,17 +16,8 @@ COMMAND.
 
 ## OPTIONS
 
-`-v`, `--[no-]verbose`
-	Enable verbose output.
-
-`-q`, `--[no-]quiet`
-	Disable verbose output.
-
-`--[no-]silent`
-	Silence all output.
-
-`--[no-]color`
-	Enables color output.
+`-h`, `--help`
+  Print help information
 
 ## AUTHOR
 

data/man/ronin-hexdump.1

@@ -0,0 +1,323 @@
+.\" Generated by kramdown-man 0.1.8
+.\" https://github.com/postmodern/kramdown-man#readme
+.TH ronin-hexdump 1 "May 2022" Ronin "User Manuals"
+.LP
+.SH SYNOPSIS
+.LP
+.HP
+\fBronin hexdump\fR \[lB]\fIoptions\fP\[rB] \[lB]\fIFILE\fP \.\.\.\[rB]
+.LP
+.SH DESCRIPTION
+.LP
+.PP
+Hexdumps data in a variety of encodings and formats\.
+.LP
+.SH ARGUMENTS
+.LP
+.TP
+\fIFILE\fP
+The optional path to the file(s) to hexdump\.
+.LP
+.SH OPTIONS
+.LP
+.TP
+\fB-t\fR, \fB--type\fR \fITYPE\fP
+The binary data type to decode the data as\. Must be one of the following:
+.LP
+.RS
+.IP \(bu 2
+\fBint8\fR
+.IP \(bu 2
+\fBuint8\fR
+.IP \(bu 2
+\fBchar\fR
+.IP \(bu 2
+\fBuchar\fR
+.IP \(bu 2
+\fBbyte\fR
+.IP \(bu 2
+\fBint16\fR
+.IP \(bu 2
+\fBint16_le\fR
+.IP \(bu 2
+\fBint16_be\fR
+.IP \(bu 2
+\fBint16_ne\fR
+.IP \(bu 2
+\fBuint16\fR
+.IP \(bu 2
+\fBuint16_le\fR
+.IP \(bu 2
+\fBuint16_be\fR
+.IP \(bu 2
+\fBuint16_ne\fR
+.IP \(bu 2
+\fBshort\fR
+.IP \(bu 2
+\fBshort_le\fR
+.IP \(bu 2
+\fBshort_be\fR
+.IP \(bu 2
+\fBshort_ne\fR
+.IP \(bu 2
+\fBushort\fR
+.IP \(bu 2
+\fBushort_le\fR
+.IP \(bu 2
+\fBushort_be\fR
+.IP \(bu 2
+\fBushort_ne\fR
+.IP \(bu 2
+\fBint32\fR
+.IP \(bu 2
+\fBint32_le\fR
+.IP \(bu 2
+\fBint32_be\fR
+.IP \(bu 2
+\fBint32_ne\fR
+.IP \(bu 2
+\fBuint32\fR
+.IP \(bu 2
+\fBuint32_le\fR
+.IP \(bu 2
+\fBuint32_be\fR
+.IP \(bu 2
+\fBuint32_ne\fR
+.IP \(bu 2
+\fBint\fR
+.IP \(bu 2
+\fBlong\fR
+.IP \(bu 2
+\fBlong_le\fR
+.IP \(bu 2
+\fBlong_be\fR
+.IP \(bu 2
+\fBlong_ne\fR
+.IP \(bu 2
+\fBuint\fR
+.IP \(bu 2
+\fBulong\fR
+.IP \(bu 2
+\fBulong_le\fR
+.IP \(bu 2
+\fBulong_be\fR
+.IP \(bu 2
+\fBulong_ne\fR
+.IP \(bu 2
+\fBint64\fR
+.IP \(bu 2
+\fBint64_le\fR
+.IP \(bu 2
+\fBint64_be\fR
+.IP \(bu 2
+\fBint64_ne\fR
+.IP \(bu 2
+\fBuint64\fR
+.IP \(bu 2
+\fBuint64_le\fR
+.IP \(bu 2
+\fBuint64_be\fR
+.IP \(bu 2
+\fBuint64_ne\fR
+.IP \(bu 2
+\fBlong_long\fR
+.IP \(bu 2
+\fBlong_long_le\fR
+.IP \(bu 2
+\fBlong_long_be\fR
+.IP \(bu 2
+\fBlong_long_ne\fR
+.IP \(bu 2
+\fBulong_long\fR
+.IP \(bu 2
+\fBulong_long_le\fR
+.IP \(bu 2
+\fBulong_long_be\fR
+.IP \(bu 2
+\fBulong_long_ne\fR
+.IP \(bu 2
+\fBfloat\fR
+.IP \(bu 2
+\fBfloat_le\fR
+.IP \(bu 2
+\fBfloat_be\fR
+.IP \(bu 2
+\fBfloat_ne\fR
+.IP \(bu 2
+\fBdouble\fR
+.IP \(bu 2
+\fBdouble_le\fR
+.IP \(bu 2
+\fBdouble_be\fR
+.IP \(bu 2
+\fBdouble_ne\fR
+.RE
+.LP
+.TP
+\fB-O\fR, \fB--offset\fR \fIINDEX\fP
+Start reading data at the given offset within the file or data stream\.
+.LP
+.TP
+\fB-L\fR, \fB--length\fR \fILEN\fP
+Only read at most \fILEN\fP bytes of data\.
+.LP
+.TP
+\fB-Z\fR, \fB--zero-pad\fR
+Enables zero\-padding the input data so that it aligns with the data type
+specified by \fB-t\fR,\fB--type\fR\.
+.LP
+.TP
+\fB-c\fR, \fB--columns\fR \fIWIDTH\fP
+The number of bytes to hexdump per line\.
+.LP
+.TP
+\fB-g\fR, \`\-\-group\-columns \fIWIDTH\fP
+Groups the columns of hexdumped numbers together into groupings of \fIWIDTH\fP\.
+.LP
+.TP
+\fB-G\fR, \fB--group-chars\fR \fIWIDTH\fP\[or]\fBtype\fR
+Group the characters into columns of groupings of \fIWIDTH\fP, separated by the
+\fB|\fR character\. If \fBtype\fR is given, the size of the \fB-t\fR,\fB--type\fR type in bytes
+will be used for the character grouping width\.
+.LP
+.TP
+\fB-r\fR, \fB--[no-]repeating\fR
+Allows consecutive repeating lines in hexdump output\. By default consecutive 
+repeating lines of data are omitted by a single \fB*\fR line\.
+.LP
+.TP
+\fB-b\fR, \fB--base\fR \fB2\fR\[or]\fB8\fR\[or]\fB10\fR\[or]\fB16\fR
+The numeric base to print hexdumped numbers in\.
+.LP
+.TP
+\fB-B\fR, \fB--index-base\fR \fB2\fR\[or]\fB8\fR\[or]\fB10\fR\[or]\fB16\fR
+The numeric base to print the index addresses in\.
+.LP
+.TP
+\fB-I\fR, \fB--index-offset\fR \fIINT\fP
+The starting value for the index addresses\.
+.LP
+.TP
+\fB-C\fR, \fB--[no-]chars-column\fR
+Enables or disables the display of the characters column\.
+.LP
+.TP
+\fB-E\fR, \fB--encoding\fR \fBascii\fR\[or]\fButf8\fR
+The character encoding to display the characters in\. Default to \fBascii\fR\.
+.LP
+.TP
+\fB--style-index\fR \fISTYLE\fP
+Applies ANSI styling to the index column\.
+See the \fIANSI STYLES\fP section for all possible style names\.
+.LP
+.TP
+\fB--style-numeric\fR \fISTYLE\fP
+Applies ANSI styling to the numeric column\.
+See the \fIANSI STYLES\fP section for all possible style names\.
+.LP
+.TP
+\fB--style-chars\fR \fISTYLE\fP
+Applies ANSI styling to the characters column\.
+See the \fIANSI STYLES\fP section for all possible style names\.
+.LP
+.TP
+\fB--highlight-index\fR \fIPATTERN\fP:\fISTYLE\fP
+Applies ANSI highlighting to the index column\.
+\fIPATTERN\fP may be either a literal \fISTRING\fP value or a \[sl]\fIREGEXP\fP\[sl] value\.
+See the \fIANSI STYLES\fP section for all possible style names\.
+.LP
+.TP
+\fB--highlight-numeric\fR \fIPATTERN\fP:\fISTYLE\fP
+Applies ANSI highlighting to the numeric column
+\fIPATTERN\fP may be either a literal \fISTRING\fP value or a \[sl]\fIREGEXP\fP\[sl] value\.
+See the \fIANSI STYLES\fP section for all possible style names\.
+.LP
+.TP
+\fB--highlight-chars\fR \fIPATTERN\fP:\fISTYLE\fP
+Applies ANSI highlighting to the characters column
+\fIPATTERN\fP may be either a literal \fISTRING\fP value or a \[sl]\fIREGEXP\fP\[sl] value\.
+See the \fIANSI STYLES\fP section for all possible style names\.
+.LP
+.TP
+\fB-h\fR, \fB--help\fR
+Prints help information\.
+.LP
+.SH ANSI STYLES
+.LP
+.PP
+An ANSI style string is comma\-separated list of one or more ANSI style names
+(ex: \fBgray,bold\fR)\.
+.LP
+.PP
+Font styles:
+.LP
+.RS
+.IP \(bu 2
+\fBbold\fR
+.IP \(bu 2
+\fBfaint\fR
+.IP \(bu 2
+\fBitalic\fR
+.IP \(bu 2
+\fBunderline\fR
+.IP \(bu 2
+\fBinvert\fR
+.IP \(bu 2
+\fBstrike\fR
+.RE
+.LP
+.PP
+Foreground colors:
+.LP
+.RS
+.IP \(bu 2
+\fBblack\fR
+.IP \(bu 2
+\fBred\fR
+.IP \(bu 2
+\fBgreen\fR
+.IP \(bu 2
+\fByellow\fR
+.IP \(bu 2
+\fBblue\fR
+.IP \(bu 2
+\fBmagenta\fR
+.IP \(bu 2
+\fBcyan\fR
+.IP \(bu 2
+\fBwhite\fR
+.RE
+.LP
+.PP
+Background colors:
+.LP
+.RS
+.IP \(bu 2
+\fBon_black\fR
+.IP \(bu 2
+\fBon_red\fR
+.IP \(bu 2
+\fBon_green\fR
+.IP \(bu 2
+\fBon_yellow\fR
+.IP \(bu 2
+\fBon_blue\fR
+.IP \(bu 2
+\fBon_magenta\fR
+.IP \(bu 2
+\fBon_cyan\fR
+.IP \(bu 2
+\fBon_white\fR
+.RE
+.LP
+.SH AUTHOR
+.LP
+.PP
+Postmodern 
+.MT postmodern\.mod3\[at]gmail\.com
+.ME
+.LP
+.SH SEE ALSO
+.LP
+.PP
+ronin\-unhexdump(1)