ronin 2.0.0 → 2.0.2

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

@@ -17,6 +17,7 @@
 #
 
 require 'ronin/cli/command'
+require 'ronin/cli/host_and_port'
 require 'ronin/core/cli/logging'
 
 require 'ronin/support/network/tcp/proxy'
@@ -30,7 +31,7 @@ module Ronin
   class CLI
     module Commands
       #
-      # Starts a TCP/UDP intercept proxy.
+      # Starts a TCP/UDP/SSL/TLS intercept proxy server.
       #
       # ## Usage
       #
@@ -38,35 +39,26 @@ module Ronin
       #
       # ## Options
       #
-      #     -v, --[no-]verbose               Enable verbose output.
-      #     -q, --[no-]quiet                 Disable verbose output.
-      #         --[no-]silent                Silence all output.
-      #     -t, --[no-]tcp                   TCP Proxy.
-      #                                      Default: true
-      #     -S, --[no-]ssl                   SSL Proxy.
-      #     -T, --[no-]tls                   TLS Proxy.
-      #     -u, --[no-]udp                   UDP Proxy.
-      #     -x, --[no-]hexdump               Enable hexdump output.
-      #     -r, --rewrite [/REGEXP/:STRING] Rewrite rules.
-      #         --rewrite-client [/REGEXP/:STRING]
-      #                                      Client rewrite rules.
-      #         --rewrite-server [/REGEXP/:STRING]
-      #                                      Server rewrite rules.
-      #     -i, --ignore [/REGEXP/ [...]]    Ignore rules.
-      #         --ignore-client [/REGEXP/ [...]]
-      #                                      Client ignore rules.
-      #         --ignore-server [/REGEXP/ [...]]
-      #                                      Server ignore rules.
-      #     -C, --close [/REGEXP/ [...]]     Close rules.
-      #         --close-client [/REGEXP/ [...]]
-      #                                      Client close rules.
-      #         --close-server [/REGEXP/ [...]]
-      #                                      Server close rules.
-      #     -R, --reset [/REGEXP/ [...]]     Reset rules.
-      #         --reset-client [/REGEXP/ [...]]
-      #                                      Client reset rules.
-      #         --reset-server [/REGEXP/ [...]]
-      #                                      Server reset rules.
+      #     -t, --tcp                        TCP Proxy
+      #     -S, --ssl                        SSL Proxy
+      #     -T, --tls                        TLS Proxy
+      #     -u, --udp                        UDP Proxy
+      #     -x, --[no-]hexdump               Enable hexdump output
+      #     -r, --rewrite /REGEXP/:STRING    Rewrite rules
+      #         --rewrite-client /REGEXP/:STRING
+      #                                      Client rewrite rules
+      #         --rewrite-server /REGEXP/:STRING
+      #                                      Server rewrite rules
+      #     -i, --ignore /REGEXP/            Ignore rules
+      #         --ignore-client /REGEXP/     Client ignore rules
+      #         --ignore-server /REGEXP/     Server ignore rules
+      #     -C, --close /REGEXP/             Close rules
+      #         --close-client /REGEXP/      Client close rules
+      #         --close-server /REGEXP/      Server close rules
+      #     -R, --reset /REGEXP/             Reset rules
+      #         --reset-client /REGEXP/      Client reset rules
+      #         --reset-server /REGEXP/      Server reset rules
+      #     -h, --help                       Print help information
       #
       # ## Arguments
       #
@@ -74,8 +66,14 @@ module Ronin
       #                                      listen on.
       #     REMOTE_HOST:REMOTE_PORT          The remote server to proxy data to.
       #
+      # ## Examples
+      #
+      #     ronin proxy 8080 google.com:80
+      #     ronin proxy --udp --hexdump 0.0.0.0:53 8.8.8.8:53
+      #
       class Proxy < Command
 
+        include HostAndPort
         include Core::CLI::Logging
 
         usage '[PROXY_HOST:]PROXY_PORT UPSTREAM_HOST:UPSTREAM_PORT'
@@ -115,7 +113,7 @@ module Ronin
 
         option :rewrite_client, value: {
                                   type:  String,
-                                  usage: '/REGEXP/:STRING',
+                                  usage: '/REGEXP/:STRING'
                                 },
                                 desc: 'Client rewrite rules' do |value|
                                   @rewrite_client << parse_rewrite_rule(value)
@@ -123,14 +121,14 @@ module Ronin
 
         option :rewrite_server, value: {
                                   type:  String,
-                                  usage: '/REGEXP/:STRING',
+                                  usage: '/REGEXP/:STRING'
                                 },
                                 desc: 'Server rewrite rules' do |value|
                                   @rewrite_server << parse_rewrite_rule(value)
                                 end
 
         option :ignore, short: '-i',
-                        value: {type:  Regexp},
+                        value: {type: Regexp},
                         desc: 'Ignore rules' do |regexp|
                           @ignore << regexp
                         end
@@ -146,7 +144,7 @@ module Ronin
                                end
 
         option :close, short: '-C',
-                       value: {type:  Regexp},
+                       value: {type: Regexp},
                        desc: 'Close rules' do |regexp|
                          @close << regexp
                        end
@@ -183,7 +181,7 @@ module Ronin
         argument :upstream, usage: 'UPSTREAM_HOST:UPSTREAM_PORT',
                             desc:  'The upstream server to proxy data to'
 
-        description 'Starts a TCP/UDP/SSL/TLS intercept proxy'
+        description 'Starts a TCP/UDP/SSL/TLS intercept proxy server'
 
         examples [
           "8080 google.com:80",
@@ -294,14 +292,12 @@ module Ronin
           local, upstream = *args
 
           if local.include?(':')
-            proxy_host, proxy_port = local.split(':',2)
-            proxy_port = proxy_port.to_i
+            proxy_host, proxy_port = host_and_port(local)
           else
             proxy_port = local.to_i
           end
 
-          upstream_host, upstream_port = upstream.split(':',2)
-          upstream_port = upstream_port.to_i
+          upstream_host, upstream_port = host_and_port(upstream)
 
           if options[:hexdump]
             @hexdumper = Hexdump::Hexdump.new
@@ -430,7 +426,7 @@ module Ronin
           end
 
           regexp  = Regexp.new(string[1...index])
-          pattern = string[index+2..]
+          pattern = string[(index + 2)..]
 
           return regexp, pattern
         end
@@ -465,7 +461,7 @@ module Ronin
         def address(connection)
           case connection
           when Array
-            socket, (host, port) = connection
+            _socket, (host, port) = connection
 
             "#{host}:#{port}"
           when TCPSocket, UDPSocket

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

@@ -37,7 +37,7 @@ module Ronin
       #     -M, --multiline                  Process each line separately
       #         --keep-newlines              Preserves newlines at the end of each line
       #     -A, --alphabet ABC...            Alphabet characters
-      #     -n, --modulu NUM                 Number of characters to rotate
+      #     -n, --modulo NUM                 Number of characters to rotate (Default: 13)
       #     -h, --help                       Print help information
       #
       # ## Arguments
@@ -55,13 +55,14 @@ module Ronin
                             @alphabets << str.chars
                           end
 
-        option :modulu, short: '-n',
+        option :modulo, short: '-n',
                         value: {
-                          type:  Integer,
-                          usage: 'NUM'
+                          type:    Integer,
+                          usage:   'NUM',
+                          default: 13
                         },
                         desc: 'Number of characters to rotate' do |num|
-                          @n = num
+                          @modulo = num
                         end
 
         description "Rotates each character of data within an alphabet"
@@ -71,7 +72,7 @@ module Ronin
         # The number of characters to rotate.
         #
         # @return [Integer]
-        attr_reader :n
+        attr_reader :modulo
 
         # The alphabets to rotate within.
         #
@@ -87,7 +88,7 @@ module Ronin
         def initialize(**kwargs)
           super(**kwargs)
 
-          @n = 13
+          @modulo    = 13
           @alphabets = []
         end
 
@@ -101,10 +102,10 @@ module Ronin
         #   The rotated string.
         #
         def process_string(string)
-          if !@alphabets.empty?
-            Support::Crypto.rot(string,@n, alphabets: @alphabets)
+          unless @alphabets.empty?
+            Support::Crypto.rot(string,@modulo, alphabets: @alphabets)
           else
-            Support::Crypto.rot(string,@n)
+            Support::Crypto.rot(string,@modulo)
           end
         end
 

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

@@ -85,7 +85,7 @@ module Ronin
         description 'Prints all strings within a file/stream belonging to the given character set'
 
         examples [
-          '--hex -n 32 file.bin',
+          '--hex -n 32 file.bin'
         ]
 
         man_page 'ronin-strings.1'

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

@@ -140,7 +140,7 @@ module Ronin
                       desc: 'Numerical base of the hexdumped numbers'
 
         option :address_base, short: '-A',
-                              value: {type:  BASES},
+                              value: {type: BASES},
                               desc: 'Numerical base of the address column'
 
         option :named_chars, long: '--[no-]named-chars',

data/lib/ronin/cli/dns.rb

@@ -20,6 +20,9 @@ require 'ronin/support/network/dns'
 
 module Ronin
   class CLI
+    #
+    # Mixin for adding DNS support to commands.
+    #
     module DNS
       #
       # Adds the `-N,--nameserver HOST|IP` option to the command which is

data/lib/ronin/cli/file_processor_command.rb

@@ -20,6 +20,9 @@ require 'ronin/cli/command'
 
 module Ronin
   class CLI
+    #
+    # Base class for all commands which process files.
+    #
     class FileProcessorCommand < Command
 
       argument :file, required: false,

data/lib/ronin/cli/host_and_port.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+#
+# Copyright (c) 2006-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
+#
+# Ronin is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Ronin is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with Ronin.  If not, see <https://www.gnu.org/licenses/>.
+#
+
+require 'addressable'
+
+module Ronin
+  class CLI
+    #
+    # Mixin which adds methods for parsing `host:port` pairs.
+    #
+    module HostAndPort
+      #
+      # Parses a `host:port` pair.
+      #
+      # @param [String] string
+      #   The string containing the `host:port` pair.
+      #
+      # @return [(String, Integer)]
+      #   The parsed host and port.
+      #
+      def host_and_port(string)
+        host, port = string.split(':',2)
+
+        return host, port.to_i
+      end
+
+      #
+      # Parses the host and port from the given URL.
+      #
+      # @param [String] url
+      #   The URL to parse.
+      #
+      # @return [(String, Integer)]
+      #   The host and port components of the URL.
+      #
+      def host_and_port_from_url(url)
+        uri = Addressable::URI.parse(url)
+
+        return uri.normalized_host, uri.inferred_port
+      end
+    end
+  end
+end

data/lib/ronin/cli/http_shell.rb

@@ -23,6 +23,9 @@ require 'ronin/support/network/http'
 
 module Ronin
   class CLI
+    #
+    # The interactive HTTP shell for the `ronin http --shell` command.
+    #
     class HTTPShell < Core::CLI::CommandShell
 
       include Printing::HTTP
@@ -40,14 +43,14 @@ module Ronin
       #
       # Initializes the HTTP Shell.
       #
-      # @param [URI::HTTP, String] base_url
+      # @param [Addressable::URI] base_url
       #   The base URL to connect to.
       #
       # @param [Hash{Symbol => Object}] kwargs
       #   Additional arguments for `Ronin::Support::Network::HTTP#connect_uri`.
       #
       def initialize(base_url, **kwargs)
-        @base_url = URI(base_url)
+        @base_url = base_url
         @http     = Support::Network::HTTP.connect_uri(@base_url,**kwargs)
 
         super()
@@ -62,6 +65,18 @@ module Ronin
         "#{@base_url}"
       end
 
+      command :cd, usage:   'PATH',
+                   summary: 'Changes the base URL path'
+
+      #
+      # The `cd` shell command.
+      #
+      # @param [String] path
+      #
+      def cd(path)
+        @base_url.path = join(path)
+      end
+
       command :get, usage:   'PATH[?QUERY] [BODY]',
                     summary: 'Performs a GET request'
 
@@ -151,7 +166,7 @@ module Ronin
       # The `delete` shell command.
       #
       # @param [String] path
-      #  
+      #
       def delete(path)
         request(:delete,path)
       end
@@ -253,18 +268,6 @@ module Ronin
         request(:unlock,path)
       end
 
-      command :cd, usage:   'PATH',
-                   summary: 'Changes the base URL path'
-
-      #
-      # The `cd` shell command.
-      #
-      # @param [String] path
-      #
-      def cd(path)
-        @base_url.path = join(path)
-      end
-
       command :headers, usage:   '[{set | unset} NAME [VALUE]]',
                         summary: 'Manages the request headers'
 
@@ -340,7 +343,7 @@ module Ronin
       def request(method,path,**kwargs)
         path = join(path)
 
-        @http.request(method,path) do |response|
+        @http.request(method,path,**kwargs) do |response|
           print_response(response)
         end
       end

data/lib/ronin/cli/key_options.rb

@@ -44,11 +44,9 @@ module Ronin
                                     usage: 'FILE'
                                   },
                                   desc: 'The key file' do |path|
-                                    begin
-                                      @key = File.binread(path)
-                                    rescue Errno::ENOENT
-                                      raise(OptionParser::InvalidArgument,"no such file or directory: #{path.inspect}")
-                                    end
+                                    @key = File.binread(path)
+                                  rescue Errno::ENOENT
+                                    raise(OptionParser::InvalidArgument,"no such file or directory: #{path.inspect}")
                                   end
       end
 

data/lib/ronin/cli/method_options.rb

@@ -22,7 +22,6 @@ module Ronin
     # Allows adding options which call methods on a given object.
     #
     module MethodOptions
-
       # The method calls to apply to an object.
       #
       # @return [Array<Symbol, (Symbol, Array)>]
@@ -65,7 +64,6 @@ module Ronin
 
         return object
       end
-
     end
   end
 end

data/lib/ronin/cli/pattern_options.rb

@@ -129,7 +129,6 @@ module Ronin
                                         desc: 'Searches for all version numbers' do
                                           @pattern = VERSION_NUMBER
                                         end
-
       end
 
       #
@@ -182,13 +181,13 @@ module Ronin
                                 end
 
         command.option :uri, desc: 'Searches for all URIs' do
-                               @pattern = URI
-                             end
+          @pattern = URI
+        end
 
         command.option :url, short: '-U',
                              desc: 'Searches for all URLs' do
                                @pattern = URL
-                            end
+                             end
       end
 
       #
@@ -320,11 +319,11 @@ module Ronin
           @pattern = FUNCTION_NAME
         end
 
-        command.option :single_quoted_string,  desc: 'Searches for all single-quoted strings' do
+        command.option :single_quoted_string, desc: 'Searches for all single-quoted strings' do
           @pattern = SINGLE_QUOTED_STRING
         end
 
-        command.option :double_quoted_string,  desc: 'Searches for all double-quoted strings' do
+        command.option :double_quoted_string, desc: 'Searches for all double-quoted strings' do
           @pattern = DOUBLE_QUOTED_STRING
         end
 

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

@@ -22,6 +22,9 @@ require 'rouge'
 module Ronin
   class CLI
     module Printing
+      #
+      # Mixin that adds syntax highlighting to commands.
+      #
       module SyntaxHighlighting
         include CommandKit::Colors
 

data/lib/ronin/cli/typo_options.rb

@@ -73,7 +73,7 @@ module Ronin
       # @return [Ronin::Support::Text::Typo::Generator]
       #
       def typo_generator
-        @type_generator ||= Support::Text::Typo.generator(**@typo_kwargs)
+        @typo_generator ||= Support::Text::Typo.generator(**@typo_kwargs)
       end
     end
   end

data/lib/ronin/cli/value_processor_command.rb

@@ -40,7 +40,7 @@ module Ronin
       # @return [Array<String>]
       attr_reader :files
 
-      # 
+      #
       # Initializes the command.
       #
       # @param [Hash{Symbol => Object}] kwargs

data/lib/ronin/config.rb

@@ -60,7 +60,7 @@ module Ronin
     #
     # @api semipublic
     #
-    def Config.load(name=nil)
+    def self.load(name=nil)
       dir, file = if name then [CONFIG_DIR, "#{name}.rb"]
                   else         [PATH, 'config.rb']
                   end
@@ -80,12 +80,12 @@ module Ronin
     #
     # @api semipublic
     #
-    def Config.tmp_dir(sub_path=nil)
+    def self.tmp_dir(sub_path=nil)
       if sub_path
         sub_path = File.expand_path(File.join('',sub_path))
         path     = File.join(TMP_DIR,sub_path)
 
-        FileUtils.mkdir_p(path) unless File.exist?(path)
+        FileUtils.mkdir_p(path) unless File.directory?(path)
         return path
       end
 

data/lib/ronin/version.rb

@@ -17,6 +17,6 @@
 #
 
 module Ronin
-  # ronin version 
-  VERSION = '2.0.0'
+  # ronin version
+  VERSION = '2.0.2'
 end

data/man/ronin-asn.1

@@ -1,6 +1,6 @@
 .\" Generated by kramdown-man 0.1.8
 .\" https://github.com/postmodern/kramdown-man#readme
-.TH ronin-asn 1 "May 2022" Ronin "User Manuals"
+.TH ronin-asn 1 "2023-02-01" Ronin "User Manuals"
 .LP
 .SH SYNOPSIS
 .LP
@@ -109,6 +109,16 @@ Enumerate over all IP addresses for all ASN records belonging to the given ISP:
     ronin asn \-\-enum\-ips \-N EDGECAST
 .fi
 .LP
+.SH ENVIRONMENT
+.LP
+.TP
+\fIHOME\fP
+Alternate location for the user\[cq]s home directory\.
+.LP
+.TP
+\fIXDG\[ru]CONFIG\[ru]HOME\fP
+Alternate location for the \fB~/.config\fR directory\.
+.LP
 .SH FILES
 .LP
 .TP

data/man/ronin-asn.1.md

@@ -1,4 +1,4 @@
-# ronin-asn 1 "May 2022" Ronin "User Manuals"
+# ronin-asn 1 "2023-02-01" Ronin "User Manuals"
 
 ## SYNOPSIS
 
@@ -75,6 +75,14 @@ Enumerate over all IP addresses for all ASN records belonging to the given ISP:
 
         ronin asn --enum-ips -N EDGECAST
 
+## ENVIRONMENT
+
+*HOME*
+  Alternate location for the user's home directory.
+
+*XDG_CONFIG_HOME*
+  Alternate location for the `~/.config` directory.
+
 ## FILES
 
 `~/.cache/ronin/ronin-support/ip2asn-combined.tsv.gz`

data/man/ronin-banner-grab.1

@@ -1,6 +1,6 @@
 .\" Generated by kramdown-man 0.1.8
 .\" https://github.com/postmodern/kramdown-man#readme
-.TH ronin-banner-grab 1 "May 2022" Ronin "User Manuals"
+.TH ronin-banner-grab 1 "2023-02-01" Ronin "User Manuals"
 .LP
 .SH SYNOPSIS
 .LP

data/man/ronin-banner-grab.1.md

@@ -1,4 +1,4 @@
-# ronin-banner-grab 1 "May 2022" Ronin "User Manuals"
+# ronin-banner-grab 1 "2023-02-01" Ronin "User Manuals"
 
 ## SYNOPSIS
 

data/man/ronin-bitflip.1

@@ -1,6 +1,6 @@
 .\" Generated by kramdown-man 0.1.8
 .\" https://github.com/postmodern/kramdown-man#readme
-.TH ronin-bitflip 1 "May 2022" Ronin "User Manuals"
+.TH ronin-bitflip 1 "2023-02-01" Ronin "User Manuals"
 .LP
 .SH SYNOPSIS
 .LP

data/man/ronin-bitflip.1.md

@@ -1,4 +1,4 @@
-# ronin-bitflip 1 "May 2022" Ronin "User Manuals"
+# ronin-bitflip 1 "2023-02-01" Ronin "User Manuals"
 
 ## SYNOPSIS
 

data/man/ronin-cert-dump.1

@@ -1,6 +1,6 @@
 .\" Generated by kramdown-man 0.1.8
 .\" https://github.com/postmodern/kramdown-man#readme
-.TH ronin-cert-dump 1 "May 2022" Ronin "User Manuals"
+.TH ronin-cert-dump 1 "2023-02-01" Ronin "User Manuals"
 .LP
 .SH SYNOPSIS
 .LP

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

@@ -1,4 +1,4 @@
-# ronin-cert-dump 1 "May 2022" Ronin "User Manuals"
+# ronin-cert-dump 1 "2023-02-01" Ronin "User Manuals"
 
 ## SYNOPSIS