ronin 2.0.5 → 2.1.0.rc1

data/man/ronin-decode.1

@@ -1,127 +1,96 @@
-.\" Generated by kramdown-man 0.1.8
+.\" Generated by kramdown-man 1.0.1
 .\" https://github.com/postmodern/kramdown-man#readme
 .TH ronin-decode 1 "2023-02-01" Ronin "User Manuals"
-.LP
+.SH NAME
+.PP
+ronin\-decode \- Decodes each character of data from a variety of encodings
 .SH SYNOPSIS
-.LP
-.HP
+.PP
 \fBronin decode \fR \[lB]\fIoptions\fP\[rB] \[lB]\fIFILE\fP \.\.\.\[rB]
-.LP
 .SH DESCRIPTION
-.LP
 .PP
 Decodes each character of the given data from 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
+\fB\-f\fR, \fB\-\-file\fR \fIFILE\fP
 Optional file to process\.
-.LP
 .TP
-\fB--string\fR \fISTRING\fP
+\fB\-\-string\fR \fISTRING\fP
 Optional string to process\.
-.LP
 .TP
-\fB-M\fR, \fB--multiline\fR
+\fB\-M\fR, \fB\-\-multiline\fR
 Process each line of input separately\.
-.LP
 .TP
-\fB-n\fR, \fB--keep-newlines\fR
+\fB\-n\fR, \fB\-\-keep\-newlines\fR
 Preserves newlines at the end of each line\.
-.LP
 .TP
-\fB--base16\fR
+\fB\-\-base16\fR
 Base16 decodes the data\.
-.LP
 .TP
-\fB--base32\fR
+\fB\-\-base32\fR
 Base32 decodes the data\.
-.LP
-.HP
-\fB-b\fR, \fB--base64\fR\[lB]\fB=\fR\fIstrict\fP\[or]\fIurl\fP\[rB]
+.TP
+\fB\-b\fR, \fB\-\-base64\fR\[lB]\fB\[eq]\fR\fIstrict\fP\[or]\fIurl\fP\[rB]
 Base64 decodes 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
 .TP
-\fB-z\fR, \fB--zlib\fR
+\fB\-z\fR, \fB\-\-zlib\fR
 Zlib uncompresses the data\.
-.LP
 .TP
-\fB-g\fR, \fB--gzip\fR
+\fB\-g\fR, \fB\-\-gzip\fR
 gzip uncompresses the data\.
-.LP
-.HP
-\fB-c, \fR\-\-c\`
+.TP
+\fB\-c, \fR\-\-c\`
 Decodes the data as a C string\.
-.LP
 .TP
-\fB-X\fR, \fB--hex\fR
-Hex decode the data (ex: \fB414141...\fR)\.
-.LP
+\fB\-X\fR, \fB\-\-hex\fR
+Hex decode the data (ex: \fB414141\.\.\.\fR)\.
 .TP
-\fB-H\fR, \fB--html\fR
+\fB\-H\fR, \fB\-\-html\fR
 HTML decodes the data\.
-.LP
 .TP
-\fB-u\fR, \fB--uri\fR
+\fB\-u\fR, \fB\-\-uri\fR
 URI decodes the data\.
-.LP
 .TP
-\fB--http\fR
+\fB\-\-http\fR
 HTTP decodes the data\.
-.LP
 .TP
-\fB-j\fR, \fB--js\fR
+\fB\-j\fR, \fB\-\-js\fR
 JavaScript decodes the data\.
-.LP
 .TP
-\fB-S\fR, \fB--shell\fR
+\fB\-S\fR, \fB\-\-shell\fR
 Decodes the data as a Shell String\.
-.LP
 .TP
-\fB-P\fR, \fB--powershell\fR
+\fB\-P\fR, \fB\-\-powershell\fR
 Decodes the data as a PowerShell String\.
-.LP
 .TP
-\fB--punycode\fR
+\fB\-\-punycode\fR
 Decodes the data as Punycode\.
-.LP
 .TP
-\fB-Q\fR, \fB--quoted-printable\fR
+\fB\-Q\fR, \fB\-\-quoted\-printable\fR
 Decodes the data as Quoted Printable\.
-.LP
 .TP
-\fB-R\fR, \fB--ruby\fR
+\fB\-R\fR, \fB\-\-ruby\fR
 Ruby decodes the data\.
-.LP
 .TP
-\fB--uudecode\fR
+\fB\-\-uudecode\fR
 uudecodes the data\.
-.LP
 .TP
-\fB-x\fR, \fB--xml\fR
+\fB\-x\fR, \fB\-\-xml\fR
 XML decodes the data\.
-.LP
 .TP
-\fB-h\fR, \fB--help\fR
+\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\-encode(1)
+.BR ronin\-encode (1)

data/man/ronin-decode.1.md

@@ -1,5 +1,9 @@
 # ronin-decode 1 "2023-02-01" Ronin "User Manuals"
 
+## NAME
+
+ronin-decode - Decodes each character of data from a variety of encodings
+
 ## SYNOPSIS
 
 `ronin decode ` [*options*] [*FILE* ...]
@@ -11,80 +15,80 @@ Decodes each character of the given data from a variety of formats.
 ## ARGUMENTS
 
 *FILE*
-  The optional file to read and process. If no *FILE* arguments are given,
+: 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.
+: Optional file to process.
 
 `--string` *STRING*
-  Optional string to process.
+: Optional string to process.
 
 `-M`, `--multiline`
-  Process each line of input separately.
+: Process each line of input separately.
 
 `-n`, `--keep-newlines`
-  Preserves newlines at the end of each line.
+: Preserves newlines at the end of each line.
 
 `--base16`
-  Base16 decodes the data.
+: Base16 decodes the data.
 
 `--base32`
-  Base32 decodes the data.
+: Base32 decodes the data.
 
 `-b`, `--base64`[`=`*strict*\|*url*]
-  Base64 decodes the data. If the `strict` or `url` option value is given,
+: Base64 decodes the data. If the `strict` or `url` option value is given,
   it will enable `strict` or `url` Base64 encoding mode, respectively.
 
 `-z`, `--zlib`
-  Zlib uncompresses the data.
+: Zlib uncompresses the data.
 
 `-g`, `--gzip`
-  gzip uncompresses the data.
+: gzip uncompresses the data.
 
 `-c, `--c`
-  Decodes the data as a C string.
+: Decodes the data as a C string.
 
 `-X`, `--hex`
-  Hex decode the data (ex: `414141...`).
+: Hex decode the data (ex: `414141...`).
 
 `-H`, `--html`
-  HTML decodes the data.
+: HTML decodes the data.
 
 `-u`, `--uri`
-  URI decodes the data.
+: URI decodes the data.
 
 `--http`
-  HTTP decodes the data.
+: HTTP decodes the data.
 
 `-j`, `--js`
-  JavaScript decodes the data.
+: JavaScript decodes the data.
 
 `-S`, `--shell`
-  Decodes the data as a Shell String.
+: Decodes the data as a Shell String.
 
 `-P`, `--powershell`
-  Decodes the data as a PowerShell String.
+: Decodes the data as a PowerShell String.
 
 `--punycode`
-  Decodes the data as Punycode.
+: Decodes the data as Punycode.
 
 `-Q`, `--quoted-printable`
-  Decodes the data as Quoted Printable.
+: Decodes the data as Quoted Printable.
 
 `-R`, `--ruby`
-  Ruby decodes the data.
+: Ruby decodes the data.
 
 `--uudecode`
-  uudecodes the data.
+: uudecodes the data.
 
 `-x`, `--xml`
-  XML decodes the data.
+: XML decodes the data.
 
 `-h`, `--help`
-  Print help information.
+: Print help information.
 
 ## AUTHOR
 
@@ -92,4 +96,4 @@ Postmodern <postmodern.mod3@gmail.com>
 
 ## SEE ALSO
 
-ronin-encode(1)
+[ronin-encode](ronin-encode.1.md)

data/man/ronin-decrypt.1

@@ -1,105 +1,90 @@
-.\" Generated by kramdown-man 0.1.8
+.\" Generated by kramdown-man 1.0.1
 .\" https://github.com/postmodern/kramdown-man#readme
 .TH ronin-decrypt 1 "2023-02-01" Ronin "User Manuals"
-.LP
+.SH NAME
+.PP
+ronin\-decrypt \- Decrypts data
 .SH SYNOPSIS
-.LP
-.HP
+.PP
 \fBronin decrypt\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 decrypt\. 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
+\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
+\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 decrypt with\. See \fB--list-ciphers\fR for a list of supported
-ciphers\. Default to \fBaes-256-cbc\fR if not given\.
-.LP
+\fB\-c\fR, \fB\-\-cipher\fR \fINAME\fP
+The cipher to decrypt with\. See \fB\-\-list\-ciphers\fR for a list of supported
+ciphers\. Default to \fBaes\-256\-cbc\fR if not given\.
 .TP
-\fB-P\fR, \fB--password\fR \fIPASSWORD\fP
+\fB\-P\fR, \fB\-\-password\fR \fIPASSWORD\fP
 The password to decrypt with\.
-.LP
 .TP
-\fB-H\fR, \fB--hash\fR \fBmd5\fR\[or]\fBsha1\fR\[or]\fBsha256\fR\[or]\fBsha512\fR
+\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
+\fB\-\-iv\fR \fISTRING\fP
 Sets the Initial Vector (IV) value of the cipher\.
-.LP
 .TP
-\fB--padding\fR \fINUM\fP
+\fB\-\-padding\fR \fINUM\fP
 Sets the padding size, in bytes, of the decryption cipher\.
-.LP
 .TP
-\fB-b\fR, \fB--block-size\fR \fINUM\fP
+\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
+\fB\-\-list\-ciphers\fR
 List the supported ciphers and exits\.
-.LP
 .TP
-\fB-h\fR, \fB--help\fR
+\fB\-h\fR, \fB\-\-help\fR
 Print help information\.
-.LP
 .SH EXAMPLES
-.LP
 .PP
 Decrypt a file using AES\-256 (CBC mode) with a password:
-.LP
-.nf
-    \[Do] ronin decrypt \-\-cipher aes\-256\-cbc \-\-password \[dq]\.\.\.\[dq] encrypted\.bin
-.fi
-.LP
+.PP
+.RS 4
+.EX
+\[Do] ronin decrypt \-\-cipher aes\-256\-cbc \-\-password \[dq]\.\.\.\[dq] encrypted\.bin
+.EE
+.RE
 .PP
 Decrypt a file using a raw key string:
-.LP
-.nf
-    \[Do] ronin decrypt \-\-cipher aes\-256\-cbc \-\-key \[dq]12345abcdef\.\.\.\[dq] encrypted\.bin
-.fi
-.LP
+.PP
+.RS 4
+.EX
+\[Do] ronin decrypt \-\-cipher aes\-256\-cbc \-\-key \[dq]12345abcdef\.\.\.\[dq] encrypted\.bin
+.EE
+.RE
 .PP
 Decrypt a file using a raw key read from a file:
-.LP
-.nf
-    \[Do] ronin decrypt \-\-cipher aes\-256\-cbc \-\-key\-file key\.bin encrypted\.bin
-.fi
-.LP
+.PP
+.RS 4
+.EX
+\[Do] ronin decrypt \-\-cipher aes\-256\-cbc \-\-key\-file key\.bin encrypted\.bin
+.EE
+.RE
 .PP
 Specifying a custom IV (initialization vector):
-.LP
-.nf
-    \[Do] ronin decrypt \-\-cipher aes\-256\-cbc \-\-key \[dq]\.\.\.\[dq] \-\-iv \[dq]\.\.\.\[dq] encrypted\.bin
-.fi
-.LP
+.PP
+.RS 4
+.EX
+\[Do] ronin decrypt \-\-cipher aes\-256\-cbc \-\-key \[dq]\.\.\.\[dq] \-\-iv \[dq]\.\.\.\[dq] encrypted\.bin
+.EE
+.RE
 .SH AUTHOR
-.LP
 .PP
 Postmodern 
 .MT postmodern\.mod3\[at]gmail\.com
 .ME
-.LP
 .SH SEE ALSO
-.LP
 .PP
-ronin\-encrypt(1)
+.BR ronin\-encrypt (1)

data/man/ronin-decrypt.1.md

@@ -1,5 +1,9 @@
 # ronin-decrypt 1 "2023-02-01" Ronin "User Manuals"
 
+## NAME
+
+ronin-decrypt - Decrypts data
+
 ## SYNOPSIS
 
 `ronin decrypt` [*options*] [*FILE* ...]
@@ -11,59 +15,59 @@ Encrypts data.
 ## ARGUMENTS
 
 *FILE*
-  The optional file to read and decrypt. If no *FILE* arguments are given,
+: The optional file to read and decrypt. If no *FILE* arguments are given,
   input will be read from `stdin`.
 
 ## OPTIONS
 
 `-k`, `--key` *STRING*
-  The raw key string for the cipher.
+: The raw key string for the cipher.
 
 `-K`, `--key-file` *FILE*
-  Reads the key string from the file.
+: Reads the key string from the file.
 
 `-c`, `--cipher` *NAME*
-  The cipher to decrypt with. See `--list-ciphers` for a list of supported
+: The cipher to decrypt with. See `--list-ciphers` for a list of supported
   ciphers. Default to `aes-256-cbc` if not given.
 
 `-P`, `--password` *PASSWORD*
-  The password to decrypt with.
+: The password to decrypt with.
 
 `-H`, `--hash` `md5`\|`sha1`\|`sha256`\|`sha512`
-  The hash algorithm to use for the password. Default to `sha256` if not given.
+: 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.
+: Sets the Initial Vector (IV) value of the cipher.
 
 `--padding` *NUM*
-  Sets the padding size, in bytes, of the decryption cipher.
+: Sets the padding size, in bytes, of the decryption cipher.
 
 `-b`, `--block-size` *NUM*
-  The size, in bytes, to read data in. Default to `16384` if not given.
+: The size, in bytes, to read data in. Default to `16384` if not given.
 
 `--list-ciphers`
-  List the supported ciphers and exits.
+: List the supported ciphers and exits.
 
 `-h`, `--help`
-  Print help information.
+: Print help information.
 
 ## EXAMPLES
 
 Decrypt a file using AES-256 (CBC mode) with a password:
 
-        $ ronin decrypt --cipher aes-256-cbc --password "..." encrypted.bin
+    $ ronin decrypt --cipher aes-256-cbc --password "..." encrypted.bin
 
 Decrypt a file using a raw key string:
 
-        $ ronin decrypt --cipher aes-256-cbc --key "12345abcdef..." encrypted.bin
+    $ ronin decrypt --cipher aes-256-cbc --key "12345abcdef..." encrypted.bin
 
 Decrypt a file using a raw key read from a file:
 
-        $ ronin decrypt --cipher aes-256-cbc --key-file key.bin encrypted.bin
+    $ ronin decrypt --cipher aes-256-cbc --key-file key.bin encrypted.bin
 
 Specifying a custom IV (initialization vector):
 
-        $ ronin decrypt --cipher aes-256-cbc --key "..." --iv "..." encrypted.bin
+    $ ronin decrypt --cipher aes-256-cbc --key "..." --iv "..." encrypted.bin
 
 ## AUTHOR
 
@@ -71,4 +75,4 @@ Postmodern <postmodern.mod3@gmail.com>
 
 ## SEE ALSO
 
-ronin-encrypt(1)
+[ronin-encrypt](ronin-encrypt.1.md)

data/man/ronin-dns-proxy.1

@@ -0,0 +1,100 @@
+.\" Generated by kramdown-man 1.0.1
+.\" https://github.com/postmodern/kramdown-man#readme
+.TH ronin-dns-proxy 1 "2024-01-01" Ronin "User Manuals"
+.SH NAME
+.PP
+ronin\-dns\-proxy \- Starts a DNS proxy
+.SH SYNOPSIS
+.PP
+\fBronin dns\-proxy\fR \[lB]\fIoptions\fP\[rB] \[lB]\fIHOST\fP\[rB] \fIPORT\fP
+.SH DESCRIPTION
+.PP
+Starts a DNS proxy that can intercept DNS queries and forward other queries to
+update stream DNS nameservers\.
+.SH ARGUMENTS
+.TP
+\fIHOST\fP
+The optional IP address to listen on\.
+.TP
+\fIPORT\fP
+The port number to listen on\.
+.SH OPTIONS
+.TP
+\fB\-n\fR, \fB\-\-nameserver\fR \fIIP\fP
+A nameserver IP address to foreward DNS queries to\.
+.TP
+\fB\-r\fR, \fB\-\-rule\fR \fIRECORD\[ru]TYPE\fP\fB:\fR\fINAME\fP\fB:\fR\fIRESULT\fP\[or]\fIRECORD\[ru]TYPE\fP\fB:\[sl]\fR\fIREGEXP\fP\fB\[sl]:\fR\fIRESULT\fP
+Adds a rule to the DNS proxy\. Each rule consists of a \fIRECORD\[ru]TYPE\fP, \fINAME\fP,
+and a \fIRESULT\fP\.
+.RS
+.PP
+The \fIRECORD\[ru]TYPE\fP is a DNS record type:
+.RE
+.RS
+.RS
+.IP \(bu 2
+\fBA\fR
+.IP \(bu 2
+\fBAAAA\fR
+.IP \(bu 2
+\fBANY\fR
+.IP \(bu 2
+\fBCNAME\fR
+.IP \(bu 2
+\fBHINFO\fR
+.IP \(bu 2
+\fBLOC\fR
+.IP \(bu 2
+\fBMINFO\fR
+.IP \(bu 2
+\fBMX\fR
+.IP \(bu 2
+\fBNS\fR
+.IP \(bu 2
+\fBPTR\fR
+.IP \(bu 2
+\fBSOA\fR
+.IP \(bu 2
+\fBSRV\fR
+.IP \(bu 2
+\fBTXT\fR
+.IP \(bu 2
+\fBWKS\fR
+.RE
+.RE
+.RS
+.PP
+The \fINAME\fP is the host name of the record\.
+If the \fINAME\fP starts with a \fB\[sl]\fR and ends with a \fB\[sl]\fR, then it will be treated
+as a Regex\.
+.RE
+.RS
+.PP
+The \fIRESULT\fP is either the result value or an DNS error code:
+.RE
+.RS
+.RS
+.IP \(bu 2
+\fBNoError\fR
+.IP \(bu 2
+\fBFormErr\fR
+.IP \(bu 2
+\fBServFail\fR
+.IP \(bu 2
+\fBNXDomain\fR
+.IP \(bu 2
+\fBNotImp\fR
+.IP \(bu 2
+\fBRefused\fR
+.IP \(bu 2
+\fBNotAuth\fR
+.RE
+.RE
+.SH AUTHOR
+.PP
+Postmodern 
+.MT postmodern\.mod3\[at]gmail\.com
+.ME
+.SH SEE ALSO
+.PP
+.BR ronin\-dns (1)

data/man/ronin-dns-proxy.1.md

@@ -0,0 +1,70 @@
+# ronin-dns-proxy 1 "2024-01-01" Ronin "User Manuals"
+
+## NAME
+
+ronin-dns-proxy - Starts a DNS proxy
+
+## SYNOPSIS
+
+`ronin dns-proxy` [*options*] [*HOST*] *PORT*
+
+## DESCRIPTION
+
+Starts a DNS proxy that can intercept DNS queries and forward other queries to
+update stream DNS nameservers.
+
+## ARGUMENTS
+
+*HOST*
+: The optional IP address to listen on.
+
+*PORT*
+: The port number to listen on.
+
+## OPTIONS
+
+`-n`, `--nameserver` *IP*
+: A nameserver IP address to foreward DNS queries to.
+
+`-r`, `--rule` *RECORD_TYPE*`:`*NAME*`:`*RESULT*\|*RECORD_TYPE*`:/`*REGEXP*`/:`*RESULT*
+: Adds a rule to the DNS proxy. Each rule consists of a *RECORD_TYPE*, *NAME*,
+  and a *RESULT*.
+
+  The *RECORD_TYPE* is a DNS record type:
+
+  * `A`
+  * `AAAA`
+  * `ANY`
+  * `CNAME`
+  * `HINFO`
+  * `LOC`
+  * `MINFO`
+  * `MX`
+  * `NS`
+  * `PTR`
+  * `SOA`
+  * `SRV`
+  * `TXT`
+  * `WKS`
+
+  The *NAME* is the host name of the record.
+  If the *NAME* starts with a `/` and ends with a `/`, then it will be treated
+  as a Regex.
+
+  The *RESULT* is either the result value or an DNS error code:
+
+  * `NoError`
+  * `FormErr`
+  * `ServFail`
+  * `NXDomain`
+  * `NotImp`
+  * `Refused`
+  * `NotAuth`
+
+## AUTHOR
+
+Postmodern <postmodern.mod3@gmail.com>
+
+## SEE ALSO
+
+[ronin-dns](ronin-dns.1.md)