ronin 1.5.1 → 2.0.0.beta1

data/man/ronin-email-addr.1.md

@@ -0,0 +1,54 @@
+# ronin-email-addr 1 "May 2022" Ronin "User Manuals"
+
+## SYNOPSIS
+
+`ronin email-addr` [*options*] [*EMAIL_ADDR* ...]
+
+## DESCRIPTION
+
+Processes one or more email addresses.
+
+## OPTIONS
+
+`-i`, `--input` *FILE*
+  Optional input file to read the email addresses from.
+
+`-O`, `--obfuscate`
+  Obfuscates the given email address(es).
+
+`--enum-obfuscations`
+  Enumerate over every possible obfuscation of the given email address(es).
+
+`-D`, `--deobfuscate`
+  Deobfuscates the given email address(es).
+
+`-n`, `--name`
+  Extracts the Name part of the email address(es).
+
+`-m`, `--mailbox`
+  Extracts the mailbox part of the email address(es).
+
+`-d`, `--domain`
+  Extracts the domain part of the email address(es).
+
+`-N`, `--normalize`
+  Normalizes the given email address(es) by removing the Name, routing,
+  and mailbox tag.
+
+`-h`, `--help`
+  Print help information
+
+## EXAMPLES
+
+Deobfuscates an email address:
+
+    $ ronin email-addr --deobfuscate "john{DOT}smith{AT}example{DOT}com"'
+
+Extracts the domain name from a list of email addresses:
+
+    $ ronin email-addr --input emails.txt --domain
+
+## AUTHOR
+
+Postmodern <postmodern.mod3@gmail.com>
+

data/man/ronin-encode.1

@@ -0,0 +1,103 @@
+.\" Generated by kramdown-man 0.1.8
+.\" https://github.com/postmodern/kramdown-man#readme
+.TH ronin-encode 1 "May 2022" Ronin "User Manuals"
+.LP
+.SH SYNOPSIS
+.LP
+.HP
+\fBronin encode \fR \[lB]\fIoptions\fP\[rB] \[lB]\fIFILE\fP \.\.\.\[rB]
+.LP
+.SH DESCRIPTION
+.LP
+.PP
+Encodes each character of the given data into a variety of formats\.
+.LP
+.SH ARGUMENTS
+.LP
+.TP
+\fIFILE\fP
+The optional file to read and process\. If no \fIFILE\fP arguments are given,
+input will be read from \fBstdin\fR\.
+.LP
+.SH OPTIONS
+.LP
+.TP
+\fB-f\fR, \fB--file\fR \fIFILE\fP
+Optional file to process\.
+.LP
+.TP
+\fB--string\fR \fISTRING\fP
+Optional string to process\.
+.LP
+.TP
+\fB-M\fR, \fB--multiline\fR
+Process each line of input separately\.
+.LP
+.TP
+\fB-n\fR, \fB--keep-newlines\fR
+Preserves newlines at the end of each line\.
+.LP
+.TP
+\fB--base32\fR
+Base32 encodes the data\.
+.LP
+.HP
+\fB-b\fR, \fB--base64\fR\[lB]\fB=\fR\fIstrict\fP\[or]\fIurl\fP\[rB]
+Base64 encodes the data\. If the \fBstrict\fR or \fBurl\fR option value is given,
+it will enable \fBstrict\fR or \fBurl\fR Base64 encoding mode, respectively\.
+.LP
+.HP
+\fB-c, \fR\-\-c\`
+Encodes the data as a C string\.
+.LP
+.TP
+\fB-X\fR, \fB--hex\fR
+Hex encode the data (ex: \fB414141...\fR)\.
+.LP
+.TP
+\fB-H\fR, \fB--html\fR
+HTML encodes the data\.
+.LP
+.TP
+\fB-u\fR, \fB--uri\fR
+URI encodes the data\.
+.LP
+.TP
+\fB--http\fR
+HTTP encodes the data\.
+.LP
+.TP
+\fB-j\fR, \fB--js\fR
+JavaScript encodes the data\.
+.LP
+.TP
+\fB-S\fR, \fB--shell\fR
+Encodes the data as a Shell String\.
+.LP
+.TP
+\fB-P\fR, \fB--powershell\fR
+Encodes the data as a PowerShell String\.
+.LP
+.TP
+\fB-R\fR, \fB--ruby\fR
+Encodes the data as a Ruby String\.
+.LP
+.TP
+\fB-x\fR, \fB--xml\fR
+XML encodes the data\.
+.LP
+.TP
+\fB-h\fR, \fB--help\fR
+Print help information\.
+.LP
+.SH AUTHOR
+.LP
+.PP
+Postmodern 
+.MT postmodern\.mod3\[at]gmail\.com
+.ME
+.LP
+.SH SEE ALSO
+.LP
+.PP
+ronin\-decode(1)

data/man/ronin-encode.1.md

@@ -0,0 +1,77 @@
+# ronin-encode 1 "May 2022" Ronin "User Manuals"
+
+## SYNOPSIS
+
+`ronin encode ` [*options*] [*FILE* ...]
+
+## DESCRIPTION
+
+Encodes each character of the given data into a variety of formats.
+
+## ARGUMENTS
+
+*FILE*
+  The optional file to read and process. If no *FILE* arguments are given,
+  input will be read from `stdin`.
+
+## OPTIONS
+
+`-f`, `--file` *FILE*
+  Optional file to process.
+
+`--string` *STRING*
+  Optional string to process.
+
+`-M`, `--multiline`
+  Process each line of input separately.
+
+`-n`, `--keep-newlines`
+  Preserves newlines at the end of each line.
+
+`--base32`
+  Base32 encodes the data.
+
+`-b`, `--base64`[`=`*strict*\|*url*]
+  Base64 encodes the data. If the `strict` or `url` option value is given,
+  it will enable `strict` or `url` Base64 encoding mode, respectively.
+
+`-c, `--c`
+  Encodes the data as a C string.
+
+`-X`, `--hex`
+  Hex encode the data (ex: `414141...`).
+
+`-H`, `--html`
+  HTML encodes the data.
+
+`-u`, `--uri`
+  URI encodes the data.
+
+`--http`
+  HTTP encodes the data.
+
+`-j`, `--js`
+  JavaScript encodes the data.
+
+`-S`, `--shell`
+  Encodes the data as a Shell String.
+
+`-P`, `--powershell`
+  Encodes the data as a PowerShell String.
+
+`-R`, `--ruby`
+  Encodes the data as a Ruby String.
+
+`-x`, `--xml`
+  XML encodes the data.
+
+`-h`, `--help`
+  Print help information.
+
+## AUTHOR
+
+Postmodern <postmodern.mod3@gmail.com>
+
+## SEE ALSO
+
+ronin-decode(1)

data/man/ronin-encrypt.1

@@ -0,0 +1,75 @@
+.\" Generated by kramdown-man 0.1.8
+.\" https://github.com/postmodern/kramdown-man#readme
+.TH ronin-encrypt 1 "May 2022" Ronin "User Manuals"
+.LP
+.SH SYNOPSIS
+.LP
+.HP
+\fBronin encrypt\fR \[lB]\fIoptions\fP\[rB] \[lB]\fIFILE\fP \.\.\.\[rB]
+.LP
+.SH DESCRIPTION
+.LP
+.PP
+Encrypts data\.
+.LP
+.SH ARGUMENTS
+.LP
+.TP
+\fIFILE\fP
+The optional file to read and encrypt\. If no \fIFILE\fP arguments are given,
+input will be read from \fBstdin\fR\.
+.LP
+.SH OPTIONS
+.LP
+.TP
+\fB-k\fR, \fB--key\fR \fISTRING\fP
+The raw key string for the cipher\.
+.LP
+.TP
+\fB-K\fR, \fB--key-file\fR \fIFILE\fP
+Reads the key string from the file\.
+.LP
+.TP
+\fB-c\fR, \fB--cipher\fR \fINAME\fP
+The cipher to encrypt with\. See \fB--list-ciphers\fR for a list of supported
+ciphers\. Default to \fBaes-256-cbc\fR if not given\.
+.LP
+.TP
+\fB-P\fR, \fB--password\fR \fIPASSWORD\fP
+The password to encrypt with\.
+.LP
+.TP
+\fB-H\fR, \fB--hash\fR \fBmd5\fR\[or]\fBsha1\fR\[or]\fBsha256\fR\[or]\fBsha512\fR
+The hash algorithm to use for the password\. Default to \fBsha256\fR if not given\.
+.LP
+.TP
+\fB--iv\fR \fISTRING\fP
+Sets the Initial Vector (IV) value of the cipher\.
+.LP
+.TP
+\fB--padding\fR \fINUM\fP
+Sets the padding size, in bytes, of the encryption cipher\.
+.LP
+.TP
+\fB-b\fR, \fB--block-size\fR \fINUM\fP
+The size, in bytes, to read data in\. Default to \fB16384\fR if not given\.
+.LP
+.TP
+\fB--list-ciphers\fR
+List the supported ciphers and exits\.
+.LP
+.TP
+\fB-h\fR, \fB--help\fR
+Print help information\.
+.LP
+.SH AUTHOR
+.LP
+.PP
+Postmodern 
+.MT postmodern\.mod3\[at]gmail\.com
+.ME
+.LP
+.SH SEE ALSO
+.LP
+.PP
+ronin\-decrypt(1)

data/man/ronin-encrypt.1.md

@@ -0,0 +1,56 @@
+# ronin-encrypt 1 "May 2022" Ronin "User Manuals"
+
+## SYNOPSIS
+
+`ronin encrypt` [*options*] [*FILE* ...]
+
+## DESCRIPTION
+
+Encrypts data.
+
+## ARGUMENTS
+
+*FILE*
+  The optional file to read and encrypt. If no *FILE* arguments are given,
+  input will be read from `stdin`.
+
+## OPTIONS
+
+`-k`, `--key` *STRING*
+  The raw key string for the cipher.
+
+`-K`, `--key-file` *FILE*
+  Reads the key string from the file.
+
+`-c`, `--cipher` *NAME*
+  The cipher to encrypt with. See `--list-ciphers` for a list of supported
+  ciphers. Default to `aes-256-cbc` if not given.
+
+`-P`, `--password` *PASSWORD*
+  The password to encrypt with.
+
+`-H`, `--hash` `md5`\|`sha1`\|`sha256`\|`sha512`
+  The hash algorithm to use for the password. Default to `sha256` if not given.
+
+`--iv` *STRING*
+  Sets the Initial Vector (IV) value of the cipher.
+
+`--padding` *NUM*
+  Sets the padding size, in bytes, of the encryption cipher.
+
+`-b`, `--block-size` *NUM*
+  The size, in bytes, to read data in. Default to `16384` if not given.
+
+`--list-ciphers`
+  List the supported ciphers and exits.
+
+`-h`, `--help`
+  Print help information.
+
+## AUTHOR
+
+Postmodern <postmodern.mod3@gmail.com>
+
+## SEE ALSO
+
+ronin-decrypt(1)

data/man/ronin-entropy.1

@@ -0,0 +1,43 @@
+.\" Generated by kramdown-man 0.1.8
+.\" https://github.com/postmodern/kramdown-man#readme
+.TH ronin-entropy 1 "May 2022" Ronin "User Manuals"
+.LP
+.SH SYNOPSIS
+.LP
+.HP
+\fBronin entropy\fR \[lB]\fIoptions\fP\[rB] \[lB]\fIFILE\fP \.\.\.\[rB]
+.LP
+.SH DESCRIPTION
+.LP
+.PP
+Filters each line by it\[cq]s Shannon Entropy\.
+.LP
+.SH ARGUMENTS
+.LP
+.TP
+\fIFILE\fP
+The optional file to read and filter\. If no \fIFILE\fP arguments are given, then
+\fBronin entropy\fR will read from standard input\.
+.LP
+.SH OPTIONS
+.LP
+.HP
+\fB-e\fR, \fB--entropy\fR DEC
+The minimum required entropy value\. If the \fB-e\fR,\fB--entropy\fR option is not
+given, it will default to \fB4.0\fR\.
+.LP
+.TP
+\fB-h\fR, \fB--help\fR
+Print help information\.
+.LP
+.SH AUTHOR
+.LP
+.PP
+Postmodern 
+.MT postmodern\.mod3\[at]gmail\.com
+.ME
+.LP
+.SH SEE ALSO
+.LP
+.PP
+ronin\-extract(1)

data/man/ronin-entropy.1.md

@@ -0,0 +1,32 @@
+# ronin-entropy 1 "May 2022" Ronin "User Manuals"
+
+## SYNOPSIS
+
+`ronin entropy` [*options*] [*FILE* ...]
+
+## DESCRIPTION
+
+Filters each line by it's Shannon Entropy.
+
+## ARGUMENTS
+
+*FILE*
+  The optional file to read and filter. If no *FILE* arguments are given, then
+  `ronin entropy` will read from standard input.
+
+## OPTIONS
+
+`-e`, `--entropy` DEC
+  The minimum required entropy value. If the `-e`,`--entropy` option is not
+  given, it will default to `4.0`.
+
+`-h`, `--help`
+  Print help information.
+
+## AUTHOR
+
+Postmodern <postmodern.mod3@gmail.com>
+
+## SEE ALSO
+
+ronin-extract(1)

data/man/ronin-escape.1

@@ -0,0 +1,94 @@
+.\" Generated by kramdown-man 0.1.8
+.\" https://github.com/postmodern/kramdown-man#readme
+.TH ronin-escape 1 "May 2022" Ronin "User Manuals"
+.LP
+.SH SYNOPSIS
+.LP
+.HP
+\fBronin escape\fR \[lB]\fIoptions\fP\[rB] \[lB]\fIFILE\fP \.\.\.\[rB]
+.LP
+.SH DESCRIPTION
+.LP
+.PP
+Escapes each special character for a variety of encodings\.
+.LP
+.SH ARGUMENTS
+.LP
+.TP
+\fIFILE\fP
+The optional file to read and process\. If no \fIFILE\fP arguments are given,
+input will be read from \fBstdin\fR\.
+.LP
+.SH OPTIONS
+.LP
+.TP
+\fB-i\fR, \fB--input\fR \fIFILE\fP
+Optional input file to read from\.
+.LP
+.TP
+\fB--string\fR \fISTRING\fP
+Optional string to process\.
+.LP
+.TP
+\fB-M\fR, \fB--multiline\fR
+Process each line separately\.
+.LP
+.TP
+\fB-n\fR, \fB--keep-newlines\fR
+Preserves newlines at the end of each line\.
+.LP
+.TP
+\fB-c\fR, \fB--c\fR
+Escapes the data as a C string\.
+.LP
+.TP
+\fB-X\fR, \fB--hex\fR
+Escapes the data as a hex string (ex: \[lq]ABC\ex01\ex02\ex03\.\.\.\[rq])
+.LP
+.TP
+\fB-H\fR, \fB--html\fR
+HTML escapes the data\.
+.LP
+.TP
+\fB-u\fR, \fB--uri\fR
+URI escapes the data\.
+.LP
+.TP
+\fB--http\fR
+HTTP escapes the data\.
+.LP
+.TP
+\fB-j\fR, \fB--js\fR
+JavaScript escapes the data\.
+.LP
+.TP
+\fB-S\fR, \fB--shell\fR
+Escapes the data as a Shell String\.
+.LP
+.TP
+\fB-P\fR, \fB--powershell\fR
+Escapes the data as a PowerShell String\.
+.LP
+.TP
+\fB-R\fR, \fB--ruby\fR
+Escapes the data as a Ruby String\.
+.LP
+.TP
+\fB-x\fR, \fB--xml\fR
+XML escapes the data\.
+.LP
+.TP
+\fB-h\fR, \fB--help\fR
+Print help information\.
+.LP
+.SH AUTHOR
+.LP
+.PP
+Postmodern 
+.MT postmodern\.mod3\[at]gmail\.com
+.ME
+.LP
+.SH SEE ALSO
+.LP
+.PP
+ronin\-unescape(1)

data/man/ronin-escape.1.md

@@ -0,0 +1,70 @@
+# ronin-escape 1 "May 2022" Ronin "User Manuals"
+
+## SYNOPSIS
+
+`ronin escape` [*options*] [*FILE* ...]
+
+## DESCRIPTION
+
+Escapes each special character for a variety of encodings.
+
+## ARGUMENTS
+
+*FILE*
+  The optional file to read and process. If no *FILE* arguments are given,
+  input will be read from `stdin`.
+
+## OPTIONS
+
+`-i`, `--input` *FILE*
+  Optional input file to read from.
+
+`--string` *STRING*
+  Optional string to process.
+
+`-M`, `--multiline`
+  Process each line separately.
+
+`-n`, `--keep-newlines`
+  Preserves newlines at the end of each line.
+
+`-c`, `--c`
+  Escapes the data as a C string.
+
+`-X`, `--hex`
+  Escapes the data as a hex string (ex: "ABC\x01\x02\x03...")
+
+`-H`, `--html`
+  HTML escapes the data.
+
+`-u`, `--uri`
+  URI escapes the data.
+
+`--http`
+  HTTP escapes the data.
+
+`-j`, `--js`
+  JavaScript escapes the data.
+
+`-S`, `--shell`
+  Escapes the data as a Shell String.
+
+`-P`, `--powershell`
+  Escapes the data as a PowerShell String.
+
+`-R`, `--ruby`
+  Escapes the data as a Ruby String.
+
+`-x`, `--xml`
+  XML escapes the data.
+
+`-h`, `--help`
+  Print help information.
+
+## AUTHOR
+
+Postmodern <postmodern.mod3@gmail.com>
+
+## SEE ALSO
+
+ronin-unescape(1)