ronin 2.0.0 → 2.0.1

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

@@ -60,7 +60,7 @@ module Ronin
       # ## Arguments
       #
       #    [FILE]                           Optional file to hexdump
-      # 
+      #
       class Hexdump < FileProcessorCommand
 
         # Supported types for the `-t,--type` option.
@@ -149,7 +149,7 @@ module Ronin
         option :length, short: '-L',
                         value: {
                           type: Integer,
-                          usage: 'LEN',
+                          usage: 'LEN'
                         },
                         desc: 'Length of data to hexdump'
 
@@ -399,7 +399,7 @@ module Ronin
             end
 
             regexp = Regexp.new(value[1...index])
-            style  = parse_style(value[index+2..])
+            style  = parse_style(value[(index + 2)..])
 
             return [regexp, style]
           else
@@ -408,7 +408,7 @@ module Ronin
             end
 
             pattern = value[0...index]
-            style   = parse_style(value[index+1..])
+            style   = parse_style(value[(index + 1)..])
 
             return [pattern, style]
           end
@@ -445,34 +445,65 @@ module Ronin
             kwargs[key] = options[key] if options.has_key?(key)
           end
 
-          if (index_style   = options[:style_index]) ||
-             (numeric_style = options[:style_numeric]) ||
-             (chars_style   = options[:style_chars])
-            kwargs[:style] = {}
-            kwargs[:style][:index]   = index_style   if index_style
-            kwargs[:style][:numeric] = numeric_style if numeric_style
-            kwargs[:style][:chars]   = chars_style   if chars_style
+          if options.has_key?(:style_index)   ||
+             options.has_key?(:style_numeric) ||
+             options.has_key?(:style_chars)
+            kwargs[:style] = hexdump_style_kwargs
           end
 
           if !@highlight_index.empty?   ||
              !@highlight_numeric.empty? ||
              !@highlight_chars.empty?
-            kwargs[:highlights] = {}
+            kwargs[:highlights] = hexdump_highlights_kwargs
+          end
 
-            unless @highlight_index.empty?
-              kwargs[:highlights][:index] = @highlight_index
-            end
+          return kwargs
+        end
 
-            unless @highlight_numeric.empty?
-              kwargs[:highlights][:numeric] = @highlight_numeric
-            end
+        #
+        # The hexdump `style:` keyword arguments.
+        #
+        # @return [Hash{Symbol => Object}]
+        #
+        def hexdump_style_kwargs
+          style = {}
 
-            unless @highlight_chars.empty?
-              kwargs[:highlights][:chars] = @highlight_chars
-            end
+          if (index_style = options[:style_index])
+            style[:index] = index_style
           end
 
-          return kwargs
+          if (numeric_style = options[:style_numeric])
+            style[:numeric] = numeric_style
+          end
+
+          if (chars_style = options[:style_chars])
+            style[:chars] = chars_style
+          end
+
+          return style
+        end
+
+        #
+        # The hexdump `highlights:` keyword arguments.
+        #
+        # @return [Hash{Symbol => Object}]
+        #
+        def hexdump_highlights_kwargs
+          highlights = {}
+
+          unless @highlight_index.empty?
+            highlights[:index] = @highlight_index
+          end
+
+          unless @highlight_numeric.empty?
+            highlights[:numeric] = @highlight_numeric
+          end
+
+          unless @highlight_chars.empty?
+            highlights[:chars] = @highlight_chars
+          end
+
+          return highlights
         end
 
       end

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

@@ -57,7 +57,7 @@ module Ronin
         option :hash, short: '-H',
                       value: {
                         type:    [:md5, :sha1, :sha256, :sha512],
-                        default: :sha1,
+                        default: :sha1
                       },
                       desc: 'Hash algorithm to use'
 

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

@@ -37,10 +37,10 @@ module Ronin
       #     -f, --file FILE                  Optional file to read values from
       #         --subdomain SUBNAME          Converts the hostname to a sub-domain
       #     -d, --domain                     Converts the hostname to a domain
-      #     -T, --tld                        Converts the hostname to it's TLD 
+      #     -T, --tld                        Converts the hostname to it's TLD
       #     -s, --suffix                     Converts the hostname to it's suffix
       #     -S, --change-suffix SUFFIX       Changes the suffix of each hostname
-      #         --enum-tlds                  Enumerates over every TLD 
+      #         --enum-tlds                  Enumerates over every TLD
       #         --enum-suffixes[={icann|private}]
       #                                      Enumerates over every domain suffix
       #         --enum-subdomains FILE       Enumerates over every subdomain in the wordlist

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

@@ -22,6 +22,7 @@ require 'ronin/cli/http_shell'
 require 'ronin/support/network/http'
 
 require 'command_kit/options/verbose'
+require 'addressable/uri'
 
 module Ronin
   class CLI
@@ -74,6 +75,9 @@ module Ronin
         include CommandKit::Options::Verbose
         include Printing::HTTP
 
+        # `http://` and `https://` URL validation regex.
+        URL_REGEX = URI::DEFAULT_PARSER.make_regexp(%w[http https])
+
         usage '[options] {URL [...] | --shell URL}'
 
         option :method, value: {
@@ -147,10 +151,14 @@ module Ronin
         end
 
         option :shell, value: {
-                         type:  String,
+                         type:  URL_REGEX,
                          usage: 'URL'
                        },
-                       desc: 'Open an interactive HTTP shell'
+                       desc: 'Open an interactive HTTP shell' do |url|
+                         options[:shell] = Addressable::URI.parse(url)
+                       rescue Addressable::URI::InvalidURIError => error
+                         raise(OptionParser::InvalidArgument,"invalid URL: #{error.message}")
+                       end
 
         option :proxy, short: '-P',
                        value: {
@@ -172,11 +180,9 @@ module Ronin
 
         option :user_agent, short: '-u',
                             value: {
-                              type: Hash[
-                                Support::Network::HTTP::UserAgents::ALIASES.keys.map { |key|
-                                  [key.to_s.tr('_','-'), key]
-                                }
-                              ]
+                              type: Support::Network::HTTP::UserAgents::ALIASES.transform_keys { |key|
+                                key.to_s.tr('_','-')
+                              }
                             },
                             desc: 'The User-Agent to use' do |name|
                               @user_agent = name
@@ -326,25 +332,36 @@ module Ronin
         #   The URL to request.
         #
         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
-          ) do |response|
-            # NOTE: we must call HTTP.request with a block to avoid causing
-            # #read_body to be called twice.
-            print_response(response)
+          unless url =~ URL_REGEX
+            print_error "invalid URL: #{url.inspect}"
+            return
+          end
+
+          uri = begin
+                  Addressable::URI.parse(url)
+                rescue Addressable::URI::InvalidURIError => error
+                  print_error "invalid URL: #{error.message}"
+                  return
+                end
+
+          begin
+            Support::Network::HTTP.request(
+              @http_method, uri, proxy:        @proxy,
+                                 user_agent:   @user_agent,
+                                 query_params: @query_params,
+                                 headers:      @headers,
+                                 body:         @body,
+                                 form_data:    @form_data
+            ) do |response|
+              # NOTE: we must call HTTP.request with a block to avoid causing
+              # #read_body to be called twice.
+              print_response(response)
+            end
+          rescue StandardError => error
+            if verbose? then print_exception(error)
+            else             print_error(error.message)
+            end
           end
-        rescue => error
-          print_error(error.message)
-          exit(1)
         end
 
         #

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

@@ -135,12 +135,12 @@ module Ronin
                            desc: 'The query string for the URI'
 
         option :http, desc: 'Converts the IP address into a http:// URI' do
-          options[:uri] = true
+          options[:uri]        = true
           options[:uri_scheme] = 'http'
         end
 
         option :https, desc: 'Converts the IP address into a https:// URI' do
-          options[:uri] = true
+          options[:uri]        = true
           options[:uri_scheme] = 'https'
         end
 

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

@@ -47,7 +47,7 @@ module Ronin
       #    ronin iprange 1.1.2-4.10-50
       #    ronin iprange --start 1.1.1.10 --stop 1.1.4.100
       #    ronin iprange --file list.txt
-      # 
+      #
       class Iprange < ValueProcessorCommand
 
         usage '[options] [IP_RANGE ... | --start IP --stop IP]'
@@ -104,7 +104,7 @@ module Ronin
           if !@start.empty? && !@stop.empty?
             unless @start.length == @stop.length
               print_error "must specify an equal number of --start and --stop options"
-              exit -1
+              exit(-1)
             end
 
             @start.zip(@stop).each do |(start,stop)|

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

@@ -132,16 +132,14 @@ module Ronin
 
         option :ssl_key, value: {
                            type: String,
-                           usage: 'FILE',
+                           usage: 'FILE'
                          },
                          desc: 'Specifies the SSL key file'
 
         option :ssl_verify, value: {
-                              type: Hash[
-                                Support::Network::SSL::VERIFY.keys.map { |key|
-                                  [key.to_s.tr('_','-'), key]
-                                }
-                              ]
+                              type: Support::Network::SSL::VERIFY.transform_keys { |key|
+                                key.to_s.tr('_','-')
+                              }
                             },
                             desc: 'SSL verification mode'
 
@@ -301,16 +299,15 @@ module Ronin
         # The client event loop.
         #
         def client_loop
-          endpoint = async_endpoint
-          stdin = async_stdin
-          finished = Async::Notification.new
-
+          finished    = Async::Notification.new
+          endpoint    = async_endpoint
+          stdin       = async_stdin
           buffer_size = options[:buffer_size]
 
           Async do |task|
             socket = begin
                        endpoint.connect
-                     rescue => error
+                     rescue StandardError => error
                        print_error(error.message)
                        exit(1)
                      end
@@ -319,25 +316,23 @@ module Ronin
 
             begin
               client = task.async do
-                begin
-                  while (data = stream.read_partial(buffer_size))
-                    print_data(data)
-                  end
-                rescue EOFError
-                ensure
-                  finished.signal
+                while (data = stream.read_partial(buffer_size))
+                  print_data(data)
                 end
+              rescue EOFError
+                # ignore EOFError
+              ensure
+                finished.signal
               end
 
               user = task.async do
-                begin
-                  while (data = stdin.read_partial(buffer_size))
-                    socket.write(data)
-                  end
-                rescue EOFError
-                ensure
-                  finished.signal
+                while (data = stdin.read_partial(buffer_size))
+                  socket.write(data)
                 end
+              rescue EOFError
+                # ignore EOFError
+              ensure
+                finished.signal
               end
 
               finished.wait
@@ -353,12 +348,11 @@ module Ronin
         # The server event loop.
         #
         def server_loop
-          endpoint = async_endpoint
-          stdin = async_stdin
-          finished = Async::Notification.new
-
+          finished    = Async::Notification.new
+          endpoint    = async_endpoint
+          stdin       = async_stdin
+          clients     = []
           buffer_size = options[:buffer_size]
-          clients = []
 
           Async do |task|
             endpoint.accept do |socket|
@@ -374,6 +368,7 @@ module Ronin
                   print_data(data)
                 end
               rescue EOFError
+                # ignore EOFError
               end
 
               clients.delete(socket)
@@ -384,18 +379,17 @@ module Ronin
             end
 
             task.async do
-              begin
-                while (data = stdin.read_partial(buffer_size))
-                  clients.each { |client| client.write(data) }
-                end
-              rescue EOFError
-              ensure
-                finished.signal
+              while (data = stdin.read_partial(buffer_size))
+                clients.each { |client| client.write(data) }
               end
+            rescue EOFError
+              # ignore EOFError
+            ensure
+              finished.signal
             end
 
             finished.wait
-          rescue => error
+          rescue StandardError => error
             print_error(error.message)
             exit(1)
           ensure

data/lib/ronin/cli/commands/new/project.rb

@@ -23,26 +23,26 @@ require 'ronin/root'
 module Ronin
   class CLI
     module Commands
-      #
-      # Creates new Ruby project directory.
-      #
-      # ## Usage
-      #
-      #     ronin new project [options] DIR
-      #
-      # ## Options
-      #
-      #         --git                        Initializes a git repo
-      #         --ruby-version VERSION       The desired ruby version for the project
-      #         --rakefile                   Creates a Rakefile
-      #     -D, --dockerfile                 Adds a Dockerfile to the new project
-      #     -h, --help                       Print help information
-      #
-      # ## Arguments
-      # 
-      #     PATH                             The directory to create
-      #
       class New < Command
+        #
+        # Creates new Ruby project directory.
+        #
+        # ## Usage
+        #
+        #     ronin new project [options] DIR
+        #
+        # ## Options
+        #
+        #         --git                        Initializes a git repo
+        #         --ruby-version VERSION       The desired ruby version for the project
+        #         --rakefile                   Creates a Rakefile
+        #     -D, --dockerfile                 Adds a Dockerfile to the new project
+        #     -h, --help                       Print help information
+        #
+        # ## Arguments
+        #
+        #     PATH                             The directory to create
+        #
         class Project < Command
 
           include Core::CLI::Generator

data/lib/ronin/cli/commands/new/script.rb

@@ -23,25 +23,25 @@ require 'ronin/root'
 module Ronin
   class CLI
     module Commands
-      #
-      # Creates a new standalone Ruby script.
-      #
-      # ## Usage
-      #
-      #     ronin new script PATH
-      #
-      # ## Arguments
-      #
-      #     PATH                             The script file to create
-      #
       class New < Command
+        #
+        # Creates a new standalone Ruby script.
+        #
+        # ## Usage
+        #
+        #     ronin new script PATH
+        #
+        # ## Arguments
+        #
+        #     PATH                             The script file to create
+        #
         class Script < Command
 
           include Core::CLI::Generator
 
           template_dir File.join(ROOT,'data','new')
 
-          usage' PATH'
+          usage 'PATH'
 
           argument :path, required: true,
                           desc:     'The script file to create'

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'
@@ -76,6 +77,7 @@ module Ronin
       #
       class Proxy < Command
 
+        include HostAndPort
         include Core::CLI::Logging
 
         usage '[PROXY_HOST:]PROXY_PORT UPSTREAM_HOST:UPSTREAM_PORT'
@@ -115,7 +117,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 +125,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 +148,7 @@ module Ronin
                                end
 
         option :close, short: '-C',
-                       value: {type:  Regexp},
+                       value: {type: Regexp},
                        desc: 'Close rules' do |regexp|
                          @close << regexp
                        end
@@ -294,14 +296,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 +430,7 @@ module Ronin
           end
 
           regexp  = Regexp.new(string[1...index])
-          pattern = string[index+2..]
+          pattern = string[(index + 2)..]
 
           return regexp, pattern
         end
@@ -465,7 +465,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