ronin 2.0.0.beta4 → 2.0.0.beta5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5047531634d67c95bffe7f55e125d652912fbc93017b7b84d9799e5fda3a4c55
-  data.tar.gz: 60b99b27727f849d19cb3518aecc6784069533f1ef2dfd4a66faed0b9fc6633f
+  metadata.gz: cb9de0474fa609d9ea978a63c3a24a6c2c365acc13db40dbfdc60d86e90571bb
+  data.tar.gz: c0503139e4f1b5fddf7319e4438a160b3b43200ce8c081e2a408d9fe0a458218
 SHA512:
-  metadata.gz: '08cec0e4936d6a029ff5b71d5a35e348c8e5beee92a1042121fcbe379f65eeed38b84a63fa319c5b314090e6ffc2d80005acfef1e061e90e81d28c1e867409ce'
-  data.tar.gz: dd78e3a1fd48f63ff26cc26eaecab7d7efe2e72369f5e166c39c418dc8e097853bb97cb12cac84e24705a6c56bbc2b2aa458e3b649946030328980979390876e
+  metadata.gz: b2e44b4023cabd18f04156ea5b3c2627697ea6878906d45c4ec371d9e5f5dcf832de97f9969415c1ed2860deaa15662ceb227378866b75c90b1fb2dea473cbe5
+  data.tar.gz: 964c7fd654dc78ee26d757138b47f26aa57cc5dd6210cfcfa0bb1e401b80c5acc331aa12230e4ccf741eea8eda583b90ea80c285113547cbbbea39239b6b86fb

data/.github/workflows/ruby.yml

@@ -21,6 +21,7 @@ jobs:
         uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
       - name: Install libsqlite3
         run: |
           sudo apt update -y && \

data/README.md

@@ -2,6 +2,7 @@
 
 [![CI](https://github.com/ronin-rb/ronin/actions/workflows/ruby.yml/badge.svg)](https://github.com/ronin-rb/ronin/actions/workflows/ruby.yml)
 [![Code Climate](https://codeclimate.com/github/ronin-rb/ronin.svg)](https://codeclimate.com/github/ronin-rb/ronin)
+[![Gem Version](https://badge.fury.io/rb/ronin.svg)](https://badge.fury.io/rb/ronin)
 
 * [Website](https://ronin-rb.dev)
 * [Source](https://github.com/ronin-rb/ronin)
@@ -14,7 +15,7 @@
 ## Description
 
 [Ronin][website] is a free and Open Source [Ruby] toolkit for security research
-and development. Ronin contains many different [CLI commands](#snopsis) and
+and development. Ronin contains many different [CLI commands](#synopsis) and
 [Ruby libraries][ronin-rb] for a variety of security tasks, such as
 encoding/decoding data, filter IPs/hosts/URLs, querying ASNs, querying DNS,
 HTTP, [scanning for web vulnerabilities][ronin-vulns-synopsis],
@@ -687,7 +688,7 @@ $ ronin typosquat --unregistered microsoft.com
 
 Dump information about a SSL/TLS certificate:
 
-```shrll
+```shell
 $ ronin cert-dump https://example.com/
 ```
 

data/gemspec.yml

@@ -96,12 +96,12 @@ dependencies:
   async-io: ~> 1.0
   wordlist: ~> 1.0
   # Ronin dependencies:
-  ronin-support: ~> 1.0.0.beta2
+  ronin-support: ~> 1.0.0.beta3
   ronin-core: ~> 0.1.0.beta1
   ronin-repos: ~> 0.1.0.beta1
-  ronin-db: ~> 0.1.0.beta2
-  ronin-fuzzer: ~> 0.1.0.beta1
-  ronin-web: ~> 1.0.0.beta3
+  ronin-db: ~> 0.1.0.beta3
+  ronin-fuzzer: ~> 0.1.0.beta2
+  ronin-web: ~> 1.0.0.beta4
   ronin-code-asm: ~> 1.0.0.beta1
   ronin-code-sql: ~> 2.0.0.beta1
   ronin-payloads: ~> 0.1.0.beta1

data/lib/ronin/cli/commands/asn.rb

@@ -40,7 +40,7 @@ module Ronin
       #     -f, --file FILE                  Overrides the default ASN list file (Default: ~/.cache/ronin/ronin-support/ip2asn-combined.tsv.gz)
       #     -u, --update                     Updates the ASN list file
       #     -n, --number NUM|AS...           Searches for all ASN records with the AS number
-      #     -C XX|None|Uknown,               Searches for all ASN records with the country code
+      #     -C XX|None|Unknown,              Searches for all ASN records with the country code
       #         --country-code
       #     -N, --name NAME                  Searches for all ASN records with the matching name
       #     -I, --ip IP                      Queries the ASN record for the IP
@@ -96,7 +96,7 @@ module Ronin
         option :country_code, short: '-C',
                               value: {
                                 type:  /[A-Z]{2}|None|Unknown/,
-                                usage: 'XX|None|Uknown'
+                                usage: 'XX|None|Unknown'
                               },
                               desc: 'Searches for all ASN records with the country code'
 

data/lib/ronin/cli/commands/bitflip.rb

@@ -107,7 +107,7 @@ module Ronin
         end
 
         #
-        # Formats a bit-fipped string.
+        # Formats a bit-flipped string.
         #
         # @param [String] string
         #   The bit-flipped String.

data/lib/ronin/cli/commands/grep.rb

@@ -208,7 +208,7 @@ module Ronin
         end
 
         #
-        # Optionally prints the filename or linenumber prefix for a line.
+        # Optionally prints the filename or line-number prefix for a line.
         #
         # @param [String] filename
         #

data/lib/ronin/cli/commands/highlight.rb

@@ -85,7 +85,7 @@ module Ronin
         end
 
         #
-        # Syntax highlights an input strema.
+        # Syntax highlights an input stream.
         #
         # @param [File, IO] input
         #   The input file or `stdin`.

data/lib/ronin/cli/commands/http.rb

@@ -323,17 +323,23 @@ module Ronin
         def process_value(url)
           url = URI(url)
 
-          Support::Network::HTTP.request(
-            @http_method, url, proxy:        @proxy,
-                               user_agent:   @user_agent,
-                               user:         url.user,
-                               password:     url.password,
-                               query_params: @query_params,
-                               headers:      @headers,
-                               body:         @body,
-                               form_data:    @form_data,
-                               &method(:print_response)
-          )
+          response = begin
+                       Support::Network::HTTP.request(
+                         @http_method, url, proxy:        @proxy,
+                                            user_agent:   @user_agent,
+                                            user:         url.user,
+                                            password:     url.password,
+                                            query_params: @query_params,
+                                            headers:      @headers,
+                                            body:         @body,
+                                            form_data:    @form_data
+                       )
+                     rescue => error
+                       print_error(error.message)
+                       exit(1)
+                     end
+
+          print_response(response)
         end
 
         #

data/lib/ronin/cli/commands/tips.rb

@@ -116,7 +116,7 @@ module Ronin
         end
 
         #
-        # Gets a path to a random tipe.
+        # Gets a path to a random tip.
         #
         # @param [String, nil] category
         #   The optional tips category to select the random tip from.

data/lib/ronin/cli/commands/typosquat.rb

@@ -96,7 +96,7 @@ module Ronin
         end
 
         #
-        # Enumerates over each typo squate of the domain.
+        # Enumerates over each typosquat of the domain.
         #
         # @param [String] domain
         #   The domain to typo squat.

data/lib/ronin/cli/commands/unhexdump.rb

@@ -17,7 +17,7 @@
 #
 
 require 'ronin/cli/command'
-require 'ronin/support/binary/hexdump/parser'
+require 'ronin/support/binary/unhexdump/parser'
 
 module Ronin
   class CLI
@@ -32,7 +32,7 @@ module Ronin
       # ## Options
       #
       #    -o, --output FILE                Optional output file
-      #    -f, --format od|hexdump          Format of the hexdump input (Default: hexdump)
+      #    -f, --format hexdump|od          Format of the hexdump input (Default: hexdump)
       #    -t int8|uint8|char|uchar|byte|int16|int16_le|int16_be|int16_ne|uint16|uint16_le|uint16_be|uint16_ne|short|short_le|short_be|short_ne|ushort|ushort_le|ushort_be|ushort_ne|int32|int32_le|int32_be|int32_ne|uint32|uint32_le|uint32_be|uint32_ne|int|long|long_le|long_be|long_ne|uint|ulong|ulong_le|ulong_be|ulong_ne|int64|int64_le|int64_be|int64_ne|uint64|uint64_le|uint64_be|uint64_ne|long_long|long_long_le|long_long_be|long_long_ne|ulong_long|ulong_long_le|ulong_long_be|ulong_long_ne|float|float_le|float_be|float_ne|double|double_le|double_be|double_ne,
       #        --type                       The binary data type to decode the data as
       #    -b, --base 2|8|10|16             Numerical base of the hexdumped numbers
@@ -124,7 +124,7 @@ module Ronin
 
         option :format, short: '-f',
                         value: {
-                          type: [:od, :hexdump],
+                          type: [:hexdump, :od],
                           default: :hexdump
                         },
                         desc: 'Format of the hexdump input'
@@ -158,7 +158,7 @@ module Ronin
         #   Optional input file.
         #
         def run(file=nil)
-          parser = Support::Binary::Hexdump::Parser.new(
+          parser = Support::Binary::Unhexdump::Parser.new(
                      **hexdump_parser_options
                    )
 
@@ -182,6 +182,9 @@ module Ronin
           end
         end
 
+        # Maps command-line options to
+        # `Ronin::Support::Binary::Unhexdump::Parser#initialize` keyword
+        # arguments.
         HEXDUMP_PARSER_OPTIONS = [
           :format,
           :type,
@@ -193,7 +196,7 @@ module Ronin
         #
         # Builds a keyword arguments `Hash` of all command `options` that will
         # be directly passed to
-        # `Ronin::Support::Binary::Hexdump::Parser#initialize`.
+        # `Ronin::Support::Binary::Unhexdump::Parser#initialize`.
         #
         # @return [Hash{Symbol => Object}]
         #

data/lib/ronin/cli/http_shell.rb

@@ -328,7 +328,7 @@ module Ronin
       # Sends an HTTP request.
       #
       # @param [Symbol] method
-      #   The HTTP request mehtod name.
+      #   The HTTP request method name.
       #
       # @param [String] path
       #   The path for the request.

data/lib/ronin/cli/printing/http.rb

@@ -49,7 +49,7 @@ module Ronin
           last_chunk = nil
 
           response.read_body do |chunk|
-            print chunk
+            stdout.write(chunk)
 
             last_chunk = chunk
           end
@@ -60,7 +60,7 @@ module Ronin
         #
         # Returns the syntax lexer for the given `Content-Type` header.
         #
-        # @param [String] content_type
+        # @param [String, nil] content_type
         #   The HTTP `Content-Type` header value.
         #
         # @return [Rouge::Lexers::HTML,
@@ -72,26 +72,27 @@ module Ronin
         #   recognized.
         #
         def syntax_lexer_for_content_type(content_type)
-          syntax_lexer_for(mimetype: content_type.sub(/;.*$/,''))
+          mimetype = content_type && content_type.sub(/;.*$/,'')
+
+          syntax_lexer_for(mimetype: mimetype)
         end
 
         #
-        # Prints a syntax highlgihted response body.
+        # Prints a syntax highlighted response body.
         #
         # @param [Net::HTTPResponse] response
         #   The HTTP response object.
         #
         def print_highlighted_body(response)
           content_type = response['Content-Type']
-          is_utf8      = content_type && content_type.include?('charset=utf-8')
 
           lexer      = syntax_lexer_for_content_type(content_type)
           last_chunk = nil
 
           response.read_body do |chunk|
-            chunk.force_encoding(Encoding::UTF_8) if is_utf8
+            chunk.force_encoding(Encoding::UTF_8)
 
-            print @syntax_formatter.format(lexer.lex(chunk))
+            stdout.write(@syntax_formatter.format(lexer.lex(chunk)))
 
             last_chunk = chunk
           end
@@ -114,7 +115,7 @@ module Ronin
         end
 
         #
-        # Prints the respnse headers.
+        # Prints the response headers.
         #
         # @param [Net::HTTPResponse] response
         #   The HTTP response object.

data/lib/ronin/cli/string_processor_command.rb

@@ -37,7 +37,7 @@ module Ronin
         attr_reader :string
 
         #
-        # Initializes the stirng value.
+        # Initializes the string value.
         #
         # @param [String] string
         #   The string value.
@@ -120,7 +120,7 @@ module Ronin
       # Runs the command.
       #
       # @param [Array<String>] files
-      #   Additional files to proceess.
+      #   Additional files to process.
       #
       def run(*files)
         if (files.empty? && @input_values.empty?)

data/lib/ronin/cli.rb

@@ -46,6 +46,7 @@ module Ronin
     command_aliases['dec'] = 'decode'
     command_aliases['nc']  = 'netcat'
 
+    # Additional `ronin-` commands to checkout.
     ADDITIONAL_RONIN_COMMANDS = %w[
       ronin-repos
       ronin-db

data/lib/ronin/version.rb

@@ -18,5 +18,5 @@
 
 module Ronin
   # ronin version 
-  VERSION = '2.0.0.beta4'
+  VERSION = '2.0.0.beta5'
 end

data/man/ronin-asn.1

@@ -20,7 +20,7 @@ the given \fINUMBER\fP, \fINAME\fP, or \fICOUNTRY\fP code\.
 Prints multi\-line human readable output\.
 .LP
 .TP
-\fB-U\fR, \fB--ur\fRl \fIURI\fP
+\fB-U\fR, \fB--url\fR \fIURI\fP
 Overrides the default ASN list URL\. Defaults to
 \fBhttps://iptoasn.com/data/ip2asn-combined.tsv.gz\fR\.
 .LP
@@ -38,7 +38,7 @@ Updates the ASN list file\.
 Searches for all ASN records with the AS number\.
 .LP
 .TP
-\fB-C\fR, \fB--country-code\fR \fIXX\fP\[or]\fBNone\fR\[or]\fBUknown\fR
+\fB-C\fR, \fB--country-code\fR \fIXX\fP\[or]\fBNone\fR\[or]\fBUnknown\fR
 Searches for all ASN records with the country code\.
 .LP
 .TP

data/man/ronin-asn.1.md

@@ -14,7 +14,7 @@ the given *NUMBER*, *NAME*, or *COUNTRY* code.
 `-v`, `--verbose`
   Prints multi-line human readable output.
 
-`-U`, `--ur`l *URI*
+`-U`, `--url` *URI*
   Overrides the default ASN list URL. Defaults to
   `https://iptoasn.com/data/ip2asn-combined.tsv.gz`.
 
@@ -28,7 +28,7 @@ the given *NUMBER*, *NAME*, or *COUNTRY* code.
 `-n`, `--number` *NUM*\|AS*NUM*
   Searches for all ASN records with the AS number.
 
-`-C`, `--country-code` *XX*|`None`|`Uknown`
+`-C`, `--country-code` *XX*|`None`|`Unknown`
   Searches for all ASN records with the country code.
 
 `-N`, `--name` *NAME*

data/man/ronin-cert-dump.1

@@ -55,35 +55,35 @@ Print help information\.
 Print the certificate information for the cert file:
 .LP
 .nf
-ronin cert\-dump ssl\.crt
+    ronin cert\-dump ssl\.crt
 .fi
 .LP
 .PP
 Print the certificate information for a SSL\[sl]TLS service:
 .LP
 .nf
-ronin cert\-dump github\.com:443
+    ronin cert\-dump github\.com:443
 .fi
 .LP
 .PP
 Print the certificate information for a URL:
 .LP
 .nf
-ronin cert\-dump https:\[sl]\[sl]github\.com
+    ronin cert\-dump https:\[sl]\[sl]github\.com
 .fi
 .LP
 .PP
-Only print the Common Nmae (CN) for a SSL\[sl]TLS service:
+Only print the Common Name (CN) for a SSL\[sl]TLS service:
 .LP
 .nf
-ronin cert\-dump \-C 93\.184\.216\.34:443
+    ronin cert\-dump \-C 93\.184\.216\.34:443
 .fi
 .LP
 .PP
 Only print the \fBsubjectAltName\fRs for a SSL\[sl]TLS service:
 .LP
 .nf
-ronin cert\-dump \-A wired\.com:443
+    ronin cert\-dump \-A wired\.com:443
 .fi
 .LP
 .SH AUTHOR

data/man/ronin-cert-dump.1.md

@@ -41,23 +41,23 @@ Prints SSL/TLS certificate information for one or more SSL/TLS services,
 
 Print the certificate information for the cert file:
 
-    ronin cert-dump ssl.crt
+        ronin cert-dump ssl.crt
 
 Print the certificate information for a SSL/TLS service:
 
-    ronin cert-dump github.com:443
+        ronin cert-dump github.com:443
 
 Print the certificate information for a URL:
 
-    ronin cert-dump https://github.com
+        ronin cert-dump https://github.com
 
-Only print the Common Nmae (CN) for a SSL/TLS service:
+Only print the Common Name (CN) for a SSL/TLS service:
 
-    ronin cert-dump -C 93.184.216.34:443
+        ronin cert-dump -C 93.184.216.34:443
 
 Only print the `subjectAltName`s for a SSL/TLS service:
 
-    ronin cert-dump -A wired.com:443
+        ronin cert-dump -A wired.com:443
 
 ## AUTHOR
 

data/man/ronin-email-addr.1

@@ -57,14 +57,14 @@ Print help information
 Deobfuscates an email address:
 .LP
 .nf
-\[Do] ronin email\-addr \-\-deobfuscate \[dq]john\[lC]DOT\[rC]smith\[lC]AT\[rC]example\[lC]DOT\[rC]com\[dq]\(aq
+    ronin email\-addr \-\-deobfuscate \[dq]john\[lC]DOT\[rC]smith\[lC]AT\[rC]example\[lC]DOT\[rC]com\[dq]\(aq
 .fi
 .LP
 .PP
 Extracts the domain name from a list of email addresses:
 .LP
 .nf
-\[Do] ronin email\-addr \-\-input emails\.txt \-\-domain
+    ronin email\-addr \-\-input emails\.txt \-\-domain
 .fi
 .LP
 .SH AUTHOR

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

@@ -42,11 +42,11 @@ Processes one or more email addresses.
 
 Deobfuscates an email address:
 
-    $ ronin email-addr --deobfuscate "john{DOT}smith{AT}example{DOT}com"'
+        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
+        ronin email-addr --input emails.txt --domain
 
 ## AUTHOR
 

data/man/ronin-hexdump.1

@@ -310,6 +310,195 @@ Background colors:
 \fBon_white\fR
 .RE
 .LP
+.SH EXAMPLES
+.LP
+.PP
+Hexdump a file:
+.LP
+.nf
+    \[Do] ronin hexdump \[sl]bin\[sl]ls
+    00000000  7f 45 4c 46 02 01 01 00 00 00 00 00 00 00 00 00  \[or]\.ELF\.\.\.\.\.\.\.\.\.\.\.\.\[or]
+    00000010  03 00 3e 00 01 00 00 00 d0 6b 00 00 00 00 00 00  \[or]\.\.>\.\.\.\.\.\.k\.\.\.\.\.\.\[or]
+    00000020  40 00 00 00 00 00 00 00 18 23 02 00 00 00 00 00  \[or]\[at]\.\.\.\.\.\.\.\.\[sh]\.\.\.\.\.\.\[or]
+    00000030  00 00 00 00 40 00 38 00 0d 00 40 00 20 00 1f 00  \[or]\.\.\.\.\[at]\.8\.\.\.\[at]\. \.\.\.\[or]
+    00000040  06 00 00 00 04 00 00 00 40 00 00 00 00 00 00 00  \[or]\.\.\.\.\.\.\.\.\[at]\.\.\.\.\.\.\.\[or]
+    00000050  40 00 00 00 00 00 00 00 40 00 00 00 00 00 00 00  \[or]\[at]\.\.\.\.\.\.\.\[at]\.\.\.\.\.\.\.\[or]
+    \.\.\.
+.fi
+.LP
+.PP
+Hexdump a UTF\-8 data:
+.LP
+.nf
+    \[Do] ronin hexdump \-\-encoding utf8 file\.txt
+    00000000  e8 80 80 e8 80 80 e8 80 80 e8 80 80 e8 80 80 e8  \[or]耀耀耀耀耀\.\[or]
+    00000010  80 80 e8 80 80 e8 80 80                          \[or]\.\.耀耀\[or]
+    00000018
+.fi
+.LP
+.PP
+Control the number of columns:
+.LP
+.nf
+    \[Do] ronin hexdump \-\-columns 10 a\.txt
+    00000000  41 41 41 41 41 41 41 41 41 41  \[or]AAAAAAAAAA\[or]
+    \.\.\.
+.fi
+.LP
+.PP
+Show repeating data instead of omitting them with a \fB*\fR:
+.LP
+.nf
+    \[Do] ronin hexdump \-\-repeating a\.txt
+    00000000  41 41 41 41 41 41 41 41 41 41  \[or]AAAAAAAAAA\[or]
+    0000000a  41 41 41 41 41 41 41 41 41 41  \[or]AAAAAAAAAA\[or]
+    00000014  41 41 41 41 41 41 41 41 41 41  \[or]AAAAAAAAAA\[or]
+.fi
+.LP
+.PP
+Grouping columns together:
+.LP
+.nf
+    \[Do] ronin hexdump \-\-group\-columns 4 \-\-columns 16 abcd\.txt
+    00000000  41 42 43 44  41 42 43 44  41 42 43 44  41 42 43 44  \[or]ABCDABCDABCDABCD\[or]
+    \.\.\.
+.fi
+.LP
+.PP
+Grouping the characters together:
+.LP
+.nf
+    \[Do] ronin hexdump \-\-group\-chars 4 abcd\.txt
+    00000000  41 42 43 44 41 42 43 44 41 42 43 44 41 42 43 44  \[or]ABCD\[or]ABCD\[or]ABCD\[or]ABCD\[or]
+    \.\.\.
+.fi
+.LP
+.PP
+Disabling the characters column:
+.LP
+.nf
+    \[Do] ronin hexdump \-\-no\-chars\-column a\.txt
+    00000000  41 41 41 41 41 41 41 41 41 41 41 41 41 41 41 41
+    \.\.\.
+.fi
+.LP
+.PP
+Print the numbers as decimals (base 10):
+.LP
+.nf
+    \[Do] ronin hexdump \-\-base 10 hello\.txt
+    00000000  104 101 108 108 111   0                                          \[or]hello\.\[or]
+.fi
+.LP
+.PP
+Print the numbers as octals (base 8):
+.LP
+.nf
+    \[Do] ronin hexdump \-\-base 8 hello\.txt
+    00000000  0150 0145 0154 0154 0157 0000                                                    \[or]hello\.\[or]
+.fi
+.LP
+.PP
+Print the numbers as binary (base 2):
+.LP
+.nf
+    \[Do] ronin hexdump \-\-base 2 hello\.txt
+    00000000  01101000 01100101 01101100 01101100 01101111 00000000                                                                                            \[or]hello\.\[or]
+.fi
+.LP
+.PP
+Decode \fBuint32\fR values:
+.LP
+.nf
+    \[Do] ronin hexdump \-\-type uint32 abcd\.txt
+    00000000  44434241 44434241 44434241 44434241  \[or]ABCDABCDABCDABCD\[or]
+    \.\.\.
+.fi
+.LP
+.PP
+Decode \fBuint32\fR (little\-endian) values:
+.LP
+.nf
+    \[Do] ronin hexdump \-\-type uint32\[ru]le abcd\.txt
+    00000000  44434241 44434241 44434241 44434241  \[or]ABCDABCDABCDABCD\[or]
+    \.\.\.
+.fi
+.LP
+.PP
+Decode \fBuint32\fR (big\-endian) values:
+.LP
+.nf
+    \[Do] ronin hexdump \-\-type uint32\[ru]be abcd\.txt
+    00000000  41424344 41424344 41424344 41424344  \[or]ABCDABCDABCDABCD\[or]
+    \.\.\.
+.fi
+.LP
+.PP
+Decode \fBint32\fR values:
+.LP
+.nf
+    \[Do] ronin hexdump \-\-type int32 \-\-base 10 data\.bin
+    00000000       65535         \-1                          \[or]\.\.\.\.\.\.\.\.\[or]
+    00000008
+.fi
+.LP
+.PP
+Decode characters:
+.LP
+.nf
+    \[Do] ronin hexdump \-\-type char hello\.txt
+    00000000    h   e   l   l   o  \e0                                          \[or]hello\.\[or]
+    00000006
+.fi
+.LP
+.PP
+Decode \fBfloat\fR values:
+.LP
+.nf
+    \[Do] ronin hexdump \-\-type float64\[ru]le floats\.bin
+    00000000          0\.000000e\[pl]00         1\.000000e\[pl]00  \[or]\.\.\.\.\.\.\.\.\.\.\.\.\.\.\.?\[or]
+    00000010         \-1\.000000e\[pl]00                  NaN  \[or]\.\.\.\.\.\.\.\.\.\.\.\.\.\.\.\.\[or]
+    \.\.\.
+.fi
+.LP
+.PP
+Skipping to an offset:
+.LP
+.nf
+    \[Do] ronin hexdump \-\-offset 7 data\.bin
+.fi
+.LP
+.PP
+Zero\-pad the data:
+.LP
+.nf
+    \[Do] ronin hexdump \-\-type uint32\[ru]be \-\-zero\-pad abcd\.txt
+    00000000  41424344 41424344 41424344 41424344  \[or]ABCDABCDABCDABCD\[or]
+    00000010  41420000                             \[or]AB\.\.\[or]
+    00000014
+.fi
+.LP
+.PP
+ANSI coloring:
+.LP
+.nf
+    \[Do] ronin hexdump \-\-style\-index white \e
+                    \-\-style\-numeric green \e
+                    \-\-style\-chars cyan \e
+                    data\.bin
+.fi
+.LP
+.PP
+ANSI highlighting:
+.LP
+.nf
+    \[Do] ronin hexdump \-\-highlight\-index \[sl]00\[Do]\[sl]:white,bold \e
+                    \-\-highlight\-numeric \[sl]\(ha\[lB]8\-f\[rB]\[lB]0\-9a\-f\[rB]\[Do]\[sl]:faint \e
+                    \-\-highlight\-numeric \[sl]f\[sl]:cyan \e
+                    \-\-highlight\-numeric 00:black,on\[ru]red \e
+                    \-\-highlight\-chars \[sl]\[lB]\(ha\e\.\[rB]\[pl]\[sl]:green data\.bin
+.fi
+.LP
 .SH AUTHOR
 .LP
 .PP

data/man/ronin-hexdump.1.md

@@ -188,6 +188,135 @@ Background colors:
 * `on_cyan`
 * `on_white`
 
+## EXAMPLES
+
+Hexdump a file:
+
+        $ ronin hexdump /bin/ls
+        00000000  7f 45 4c 46 02 01 01 00 00 00 00 00 00 00 00 00  |.ELF............|
+        00000010  03 00 3e 00 01 00 00 00 d0 6b 00 00 00 00 00 00  |..>......k......|
+        00000020  40 00 00 00 00 00 00 00 18 23 02 00 00 00 00 00  |@........#......|
+        00000030  00 00 00 00 40 00 38 00 0d 00 40 00 20 00 1f 00  |....@.8...@. ...|
+        00000040  06 00 00 00 04 00 00 00 40 00 00 00 00 00 00 00  |........@.......|
+        00000050  40 00 00 00 00 00 00 00 40 00 00 00 00 00 00 00  |@.......@.......|
+        ...
+
+Hexdump a UTF-8 data:
+
+        $ ronin hexdump --encoding utf8 file.txt
+        00000000  e8 80 80 e8 80 80 e8 80 80 e8 80 80 e8 80 80 e8  |耀耀耀耀耀.|
+        00000010  80 80 e8 80 80 e8 80 80                          |..耀耀|
+        00000018
+
+Control the number of columns:
+
+        $ ronin hexdump --columns 10 a.txt
+        00000000  41 41 41 41 41 41 41 41 41 41  |AAAAAAAAAA|
+        ...
+
+Show repeating data instead of omitting them with a `*`:
+
+        $ ronin hexdump --repeating a.txt
+        00000000  41 41 41 41 41 41 41 41 41 41  |AAAAAAAAAA|
+        0000000a  41 41 41 41 41 41 41 41 41 41  |AAAAAAAAAA|
+        00000014  41 41 41 41 41 41 41 41 41 41  |AAAAAAAAAA|
+
+Grouping columns together:
+
+        $ ronin hexdump --group-columns 4 --columns 16 abcd.txt
+        00000000  41 42 43 44  41 42 43 44  41 42 43 44  41 42 43 44  |ABCDABCDABCDABCD|
+        ...
+
+Grouping the characters together:
+
+        $ ronin hexdump --group-chars 4 abcd.txt
+        00000000  41 42 43 44 41 42 43 44 41 42 43 44 41 42 43 44  |ABCD|ABCD|ABCD|ABCD|
+        ...
+
+Disabling the characters column:
+
+        $ ronin hexdump --no-chars-column a.txt
+        00000000  41 41 41 41 41 41 41 41 41 41 41 41 41 41 41 41
+        ...
+
+Print the numbers as decimals (base 10):
+
+        $ ronin hexdump --base 10 hello.txt
+        00000000  104 101 108 108 111   0                                          |hello.|
+
+Print the numbers as octals (base 8):
+
+        $ ronin hexdump --base 8 hello.txt
+        00000000  0150 0145 0154 0154 0157 0000                                                    |hello.|
+
+Print the numbers as binary (base 2):
+
+        $ ronin hexdump --base 2 hello.txt
+        00000000  01101000 01100101 01101100 01101100 01101111 00000000                                                                                            |hello.|
+
+Decode `uint32` values:
+
+        $ ronin hexdump --type uint32 abcd.txt
+        00000000  44434241 44434241 44434241 44434241  |ABCDABCDABCDABCD|
+        ...
+
+Decode `uint32` (little-endian) values:
+
+        $ ronin hexdump --type uint32_le abcd.txt
+        00000000  44434241 44434241 44434241 44434241  |ABCDABCDABCDABCD|
+        ...
+
+Decode `uint32` (big-endian) values:
+
+        $ ronin hexdump --type uint32_be abcd.txt
+        00000000  41424344 41424344 41424344 41424344  |ABCDABCDABCDABCD|
+        ...
+
+Decode `int32` values:
+
+        $ ronin hexdump --type int32 --base 10 data.bin
+        00000000       65535         -1                          |........|
+        00000008
+
+Decode characters:
+
+        $ ronin hexdump --type char hello.txt
+        00000000    h   e   l   l   o  \0                                          |hello.|
+        00000006
+
+Decode `float` values:
+
+        $ ronin hexdump --type float64_le floats.bin
+        00000000          0.000000e+00         1.000000e+00  |...............?|
+        00000010         -1.000000e+00                  NaN  |................|
+        ...
+
+Skipping to an offset:
+
+        $ ronin hexdump --offset 7 data.bin
+
+Zero-pad the data:
+
+        $ ronin hexdump --type uint32_be --zero-pad abcd.txt
+        00000000  41424344 41424344 41424344 41424344  |ABCDABCDABCDABCD|
+        00000010  41420000                             |AB..|
+        00000014
+
+ANSI coloring:
+
+        $ ronin hexdump --style-index white \
+                        --style-numeric green \
+                        --style-chars cyan \
+                        data.bin
+
+ANSI highlighting:
+
+        $ ronin hexdump --highlight-index /00$/:white,bold \
+                        --highlight-numeric /^[8-f][0-9a-f]$/:faint \
+                        --highlight-numeric /f/:cyan \
+                        --highlight-numeric 00:black,on_red \
+                        --highlight-chars /[^\.]+/:green data.bin
+
 ## AUTHOR
 
 Postmodern <postmodern.mod3@gmail.com>

data/man/ronin-new-project.1

@@ -41,6 +41,36 @@ Adds a \fBDockerfile\fR to the new project\.
 \fB-h\fR, \fB--help\fR
 Print help information
 .LP
+.SH EXAMPLES
+.LP
+.PP
+Generate a new Ruby project:
+.LP
+.nf
+ronin new project path\[sl]to\[sl]dir
+.fi
+.LP
+.PP
+Set the desired ruby version for the project:
+.LP
+.nf
+ronin new project \-\-ruby\-version 3\.2\.0 path\[sl]to\[sl]dir
+.fi
+.LP
+.PP
+Add a \fBRakefile\fR to the project for defining automated tasks:
+.LP
+.nf
+ronin new project \-\-rakefile path\[sl]to\[sl]dir
+.fi
+.LP
+.PP
+Add a \fBDockerfile\fR to the project:
+.LP
+.nf
+ronin new project \-\-dockerfile path\[sl]to\[sl]dir
+.fi
+.LP
 .SH AUTHOR
 .LP
 .PP

data/man/ronin-new-project.1.md

@@ -31,6 +31,24 @@ Creates a new Ruby project directory.
 `-h`, `--help`
   Print help information
 
+## EXAMPLES
+
+Generate a new Ruby project:
+
+    ronin new project path/to/dir
+
+Set the desired ruby version for the project:
+
+    ronin new project --ruby-version 3.2.0 path/to/dir
+
+Add a `Rakefile` to the project for defining automated tasks:
+
+    ronin new project --rakefile path/to/dir
+
+Add a `Dockerfile` to the project:
+
+    ronin new project --dockerfile path/to/dir
+
 ## AUTHOR
 
 Postmodern <postmodern.mod3@gmail.com>

data/man/ronin-new-script.1

@@ -24,6 +24,15 @@ The path to the new script file\.
 \fB-h\fR, \fB--help\fR
 Print help information
 .LP
+.SH EXAMPLES
+.LP
+.PP
+Generate a new Ruby script:
+.LP
+.nf
+ronin new script file\.rb
+.fi
+.LP
 .SH AUTHOR
 .LP
 .PP

data/man/ronin-new-script.1.md

@@ -18,6 +18,12 @@ Creates a new standalone Ruby script.
 `-h`, `--help`
   Print help information
 
+## EXAMPLES
+
+Generate a new Ruby script:
+
+    ronin new script file.rb
+
 ## AUTHOR
 
 Postmodern <postmodern.mod3@gmail.com>

data/man/ronin-new.1

@@ -38,6 +38,22 @@ Generates a new standalone Ruby script\.
 \fIhelp\fP
 Lists available \fBronin new\fR commands\.
 .LP
+.SH EXAMPLES
+.LP
+.PP
+Generate a new Ruby script:
+.LP
+.nf
+    ronin new script file\.rb
+.fi
+.LP
+.PP
+Generate a new Ruby project:
+.LP
+.nf
+    ronin new project path\[sl]to\[sl]dir
+.fi
+.LP
 .SH AUTHOR
 .LP
 .PP

data/man/ronin-new.1.md

@@ -29,6 +29,16 @@ Creates a new project or script.
 *help*
   Lists available `ronin new` commands.
 
+## EXAMPLES
+
+Generate a new Ruby script:
+
+        ronin new script file.rb
+
+Generate a new Ruby project:
+
+        ronin new project path/to/dir
+
 ## AUTHOR
 
 Postmodern <postmodern.mod3@gmail.com>

data/man/ronin-proxy.1

@@ -5,7 +5,7 @@
 .SH SYNOPSIS
 .LP
 .HP
-\fBronin proxy\fR \[lB]\fIoptions\fP\[rB] \[lB]\fIPROXY\[ru]HOST\fP:\[rB]\fIPROXY\[ru]PORT\fP \fIUPSTREAM\[ru]HOST\fP:\fIUPSTRAM\[ru]PORT\fP
+\fBronin proxy\fR \[lB]\fIoptions\fP\[rB] \[lB]\fIPROXY\[ru]HOST\fP:\[rB]\fIPROXY\[ru]PORT\fP \fIUPSTREAM\[ru]HOST\fP:\fIUPSTREAM\[ru]PORT\fP
 .LP
 .SH DESCRIPTION
 .LP
@@ -104,15 +104,21 @@ Reset the connection if the server sends a message matching the REGEXP\.
 .LP
 .SH EXAMPLES
 .LP
-.TP
-\fBronin proxy 8080 google.com:80\fR
+.PP
 Starts a TCP proxy listening on \fBlocalhost\fR port 8080 that forwards all data
-to \fBgoogle.com\fR port 80\.
+to \fBgoogle.com\fR port 80:
 .LP
-.TP
-\fBsudo ronin proxy --udp --hexdump 0.0.0.0:53 8.8.8.8:53\fR
+.nf
+    ronin proxy 8080 google\.com:80
+.fi
+.LP
+.PP
 Starts a UDP proxy listening on \fB0.8.0.0\fR port 53 that forwards all data to
-\fB8.8.8.8\fR port 53\.
+\fB8.8.8.8\fR port 53:
+.LP
+.nf
+    sudo ronin proxy \-\-udp \-\-hexdump 0\.0\.0\.0:53 8\.8\.8\.8:53
+.fi
 .LP
 .SH AUTHOR
 .LP

data/man/ronin-proxy.1.md

@@ -2,7 +2,7 @@
 
 ## SYNOPSIS
 
-`ronin proxy` [*options*] [*PROXY_HOST*:]*PROXY_PORT* *UPSTREAM_HOST*:*UPSTRAM_PORT*
+`ronin proxy` [*options*] [*PROXY_HOST*:]*PROXY_PORT* *UPSTREAM_HOST*:*UPSTREAM_PORT*
 
 ## DESCRIPTION
 
@@ -79,13 +79,15 @@ Starts the Ronin TCP/UDP/SSL/TLS Proxy.
 
 ## EXAMPLES
 
-`ronin proxy 8080 google.com:80`
-  Starts a TCP proxy listening on `localhost` port 8080 that forwards all data
-  to `google.com` port 80.
+Starts a TCP proxy listening on `localhost` port 8080 that forwards all data
+to `google.com` port 80:
 
-`sudo ronin proxy --udp --hexdump 0.0.0.0:53 8.8.8.8:53`
-  Starts a UDP proxy listening on `0.8.0.0` port 53 that forwards all data to
-  `8.8.8.8` port 53.
+        ronin proxy 8080 google.com:80
+
+Starts a UDP proxy listening on `0.8.0.0` port 53 that forwards all data to
+`8.8.8.8` port 53:
+
+        sudo ronin proxy --udp --hexdump 0.0.0.0:53 8.8.8.8:53
 
 ## AUTHOR
 

data/man/ronin-unhexdump.1

@@ -25,6 +25,10 @@ The optional path to the file to un\-hexdump\.
 \fB-o\fR, \fB--output\fR \fIFILE\fP
 Optional path to the output file\.
 .LP
+.HP
+\fB-f\fR, \fB--format\fR \[lB]\fBhexdump\fR\[or]\fBod\fR\[rB]
+Specifies the hexdump format to parse\.
+.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:
@@ -174,6 +178,29 @@ Enables parsing of \fBod\fR\-style named characters (ex: \fBnul\fR)\.
 \fB-h\fR, \fB--help\fR
 Prints help information\.
 .LP
+.SH EXAMPLES
+.LP
+.PP
+Unhexdump a \fBhexdump -C\fR hexdump:
+.LP
+.nf
+    ronin unhexdump \-o raw\.bin hexdump\.txt
+.fi
+.LP
+.PP
+Unhexdump a \fBhexdump\fR hexdump:
+.LP
+.nf
+    ronin unhexdump \-o raw\.bin \-t uint16\[ru]le hexdump\.txt
+.fi
+.LP
+.PP
+Unhexdump an \fBod\fR hexdump:
+.LP
+.nf
+    ronin unhexdump \-o raw\.bin \-f od od\.txt
+.fi
+.LP
 .SH AUTHOR
 .LP
 .PP

data/man/ronin-unhexdump.1.md

@@ -19,6 +19,9 @@ Supports a variety of formats, bases, and encodings.
 `-o`, `--output` *FILE*
   Optional path to the output file.
 
+`-f`, `--format` [`hexdump`\|`od`]
+  Specifies the hexdump format to parse.
+
 `-t`, `--type` *TYPE*
   The binary data type to decode the data as. Must be one of the following:
 
@@ -98,6 +101,20 @@ Supports a variety of formats, bases, and encodings.
 `-h`, `--help`
   Prints help information.
 
+## EXAMPLES
+
+Unhexdump a `hexdump -C` hexdump:
+
+        ronin unhexdump -o raw.bin hexdump.txt
+
+Unhexdump a `hexdump` hexdump:
+
+        ronin unhexdump -o raw.bin -t uint16_le hexdump.txt
+
+Unhexdump an `od` hexdump:
+
+        ronin unhexdump -o raw.bin -f od od.txt
+
 ## AUTHOR
 
 Postmodern <postmodern.mod3@gmail.com>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ronin
 version: !ruby/object:Gem::Version
-  version: 2.0.0.beta4
+  version: 2.0.0.beta5
 platform: ruby
 authors:
 - Postmodern
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-01-15 00:00:00.000000000 Z
+date: 2023-01-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: open_namespace
@@ -72,14 +72,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0.beta2
+        version: 1.0.0.beta3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0.beta2
+        version: 1.0.0.beta3
 - !ruby/object:Gem::Dependency
   name: ronin-core
   requirement: !ruby/object:Gem::Requirement
@@ -114,42 +114,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.0.beta2
+        version: 0.1.0.beta3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.0.beta2
+        version: 0.1.0.beta3
 - !ruby/object:Gem::Dependency
   name: ronin-fuzzer
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.0.beta1
+        version: 0.1.0.beta2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.0.beta1
+        version: 0.1.0.beta2
 - !ruby/object:Gem::Dependency
   name: ronin-web
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0.beta3
+        version: 1.0.0.beta4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0.beta3
+        version: 1.0.0.beta4
 - !ruby/object:Gem::Dependency
   name: ronin-code-asm
   requirement: !ruby/object:Gem::Requirement