ronin 1.5.1 → 2.0.0.beta1

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

@@ -0,0 +1,213 @@
+# 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 'ronin/cli/command'
+require 'ronin/support/binary/hexdump/parser'
+
+module Ronin
+  class CLI
+    module Commands
+      #
+      # Hexdumps data in a variety of encodings and formats.
+      #
+      # ## Usage
+      #
+      #     ronin unhexdump [options] [FILE]
+      #
+      # ## Options
+      #
+      #    -o, --output FILE                Optional output file
+      #    -f, --format od|hexdump          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
+      #    -A, --address-base 2|8|10|16     Numerical base of the address column
+      #        --[no-]named-chars           Enables parsing of od-style named charactters
+      #    -h, --help                       Print help information
+      #
+      # ## Arguments
+      #
+      #    [FILE]                           Optional file to unhexdump
+      #
+      class Unhexdump < Command
+
+        # Supported types for the `-t,--type` option.
+        TYPES = [
+          :int8,
+          :uint8,
+          :char,
+          :uchar,
+          :byte, # default for --format hexdump
+          :int16,
+          :int16_le,
+          :int16_be,
+          :int16_ne,
+          :uint16,
+          :uint16_le, # default for --format od
+          :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
+        ]
+
+        usage '[options] [FILE]'
+
+        option :output, short: '-o',
+                        value: {
+                          type:  String,
+                          usage: 'FILE'
+                        },
+                        desc: 'Optional output file'
+
+        option :format, short: '-f',
+                        value: {
+                          type: [:od, :hexdump],
+                          default: :hexdump
+                        },
+                        desc: 'Format of the hexdump input'
+
+        option :type, short: '-t',
+                      value: {type: TYPES},
+                      desc:  'The binary data type to decode the data as'
+
+        BASES = {'2' => 2, '8' => 8, '10' => 10, '16' => 16}
+
+        option :base, short: '-b',
+                      value: {type: BASES},
+                      desc: 'Numerical base of the hexdumped numbers'
+
+        option :address_base, short: '-A',
+                              value: {type:  BASES},
+                              desc: 'Numerical base of the address column'
+
+        option :named_chars, long: '--[no-]named-chars',
+                             desc: 'Enables parsing of od-style named charactters'
+
+        argument :file, required: false,
+                        desc: 'Optional file to unhexdump'
+
+        man_page 'ronin-unhexdump.1'
+
+        #
+        # Runs the `unhexdump` command.
+        #
+        # @param [String, nil] file
+        #   Optional input file.
+        #
+        def run(file=nil)
+          parser = Support::Binary::Hexdump::Parser.new(
+                     **hexdump_parser_options
+                   )
+
+          input = if file
+                    begin
+                      File.open(file)
+                    rescue Errno::ENOENT
+                      print_error "no such file or directory: #{file}"
+                      exit(1)
+                    end
+                  else
+                    stdin
+                  end
+
+          data = parser.unhexdump(input)
+
+          if options[:output]
+            File.binwrite(options[:output],data)
+          else
+            stdout.write(data)
+          end
+        end
+
+        HEXDUMP_PARSER_OPTIONS = [
+          :format,
+          :type,
+          :address_base,
+          :base,
+          :named_chars
+        ]
+
+        #
+        # Builds a keyword arguments `Hash` of all command `options` that will
+        # be directly passed to
+        # `Ronin::Support::Binary::Hexdump::Parser#initialize`.
+        #
+        # @return [Hash{Symbol => Object}]
+        #
+        def hexdump_parser_options
+          kwargs = {}
+
+          HEXDUMP_PARSER_OPTIONS.each do |key|
+            kwargs[key] = options[key] if options.has_key?(key)
+          end
+
+          return kwargs
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,114 @@
+# 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 'ronin/cli/string_methods_command'
+
+module Ronin
+  class CLI
+    module Commands
+      #
+      # Unquotes a double/single quoted string.
+      #
+      # ## Usage
+      #
+      #     ronin unquote [options] [FILE ...]
+      #
+      # ## Options
+      #
+      #     -f, --file FILE                  Optional file to process
+      #         --string STRING              Optional string to process
+      #     -M, --multiline                  Process each line separately
+      #     -n, --keep-newlines              Preserves newlines at the end of each line
+      #     -X, --hex                        Unquotes the Hex string
+      #     -c, --c                          Unquotes the C string
+      #     -j, --js                         Unquotes the JavaScript String
+      #     -S, --shell                      Unquotes the Shell String
+      #     -P, --powershell                 Unquotes the PowerShell String
+      #     -R, --ruby                       Unquotes the Ruby String
+      #     -h, --help                       Print help information
+      #
+      # ## Arguments
+      #
+      #     [FILE ...]                       Optional file(s) to process
+      #
+      class Unquote < StringMethodsCommand
+
+        option :hex, short: '-X',
+                     desc: 'Unquotes the Hex string' do
+                       require 'ronin/support/encoding/hex'
+                       @method_calls << :hex_unquote
+                     end
+
+        option :c, short: '-c',
+                   desc: 'Unquotes the C string' do
+                     require 'ronin/support/encoding/c'
+                     @method_calls << :c_unquote
+                   end
+
+        option :js, short: '-j',
+                    desc: 'Unquotes the JavaScript String' do
+                      require 'ronin/support/encoding/js'
+                      @method_calls << :js_unquote
+                    end
+
+        option :shell, short: '-S',
+                       desc: 'Unquotes the Shell String' do
+                         require 'ronin/support/encoding/shell'
+                         @method_calls << :shell_unquote
+                       end
+
+        option :powershell, short: '-P',
+                            desc: 'Unquotes the PowerShell String' do
+                              require 'ronin/support/encoding/powershell'
+                              @method_calls << :powershell_unquote
+                            end
+
+        option :ruby, short: '-R',
+                      desc: 'Unquotes the Ruby String' do
+                        require 'ronin/support/encoding/ruby'
+                        @method_calls << :ruby_unquote
+                      end
+
+        description 'Unquotes a double/single quoted string'
+
+        man_page 'ronin-unquote.1'
+
+        #
+        # Unquotes the String.
+        #
+        # @param [String] string
+        #   The String to unquote.
+        #
+        # @return [String]
+        #   The unquoted String.
+        #
+        # @note
+        #   If no options are given, then `--string` is assumed.
+        #
+        def process_string(string)
+          if @method_calls.empty?
+            string.unquote
+          else
+            super(string)
+          end
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,151 @@
+# 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 'ronin/cli/value_processor_command'
+
+require 'uri'
+require 'uri/query_params'
+require 'ronin/support/network/http/core_ext/uri/http'
+
+module Ronin
+  class CLI
+    module Commands
+      #
+      # Parses URL(s).
+      #
+      # ## Usage
+      #
+      #     ronin url [options] [URL ...]
+      #
+      # ## Options
+      #
+      #     -f, --file FILE                  Optional file to read values from
+      #     -u, --user                       Print the URL's user name
+      #         --password                   Print the URL's password
+      #         --user-password              Print the URL's user name and password
+      #     -H, --host                       Print the URL's host name
+      #         --port                       Print the URL's port
+      #         --host-port                  Print the URL's host:port
+      #     -P, --path                       Print the URL's path
+      #         --path-query                 Print the URL's path and query string
+      #     -Q, --query                      Print the URL's query string
+      #     -q, --query-param NAME           Print the query param from the URL's query string
+      #     -F, --fragment                   Print the URL's fragment
+      #     -S, --status                     Print the HTTP status of each URL
+      #     -h, --help                       Print help information
+      #
+      # ## Arguments
+      #
+      #     [URL ...]                        The URL(s) to parse
+      #
+      # ## Examples
+      #
+      #     ronin url --host https://example.com/foo
+      #     ronin url --host-port https://example.com:8080/foo
+      #     ronin url --param id https://example.com/page?id=100
+      #
+      class Url < ValueProcessorCommand
+
+        usage '[options] [URL ...]'
+
+        option :user, short: '-u',
+                      desc:  "Print the URL's user name"
+
+        option :password, desc: "Print the URL's password"
+
+        option :user_password, desc: "Print the URL's user name and password"
+
+        option :host, short: '-H',
+                      desc:  "Print the URL's host name"
+
+        option :port, desc: "Print the URL's port"
+
+        option :host_port, desc: "Print the URL's host:port"
+
+        option :path, short: '-P',
+                      desc:  "Print the URL's path"
+
+        option :path_query, desc: "Print the URL's path and query string"
+
+        option :query, short: '-Q',
+                       desc:  "Print the URL's query string"
+
+        option :query_param, short: '-q',
+                             value: {
+                               type:  String,
+                               usage: 'NAME'
+                             },
+                             desc: "Print the query param from the URL's query string"
+
+        option :fragment, short: '-F',
+                          desc:  "Print the URL's fragment"
+
+        option :status, short: '-S',
+                        desc:  'Print the HTTP status of each URL'
+
+        argument :url, required: false,
+                       repeats:  true,
+                       desc:     'The URL(s) to parse'
+
+        examples [
+          "--host https://example.com/foo",
+          "--host-port https://example.com:8080/foo",
+          "--param id https://example.com/page?id=100"
+        ]
+
+        man_page 'ronin-url.1'
+
+        #
+        # Processes an individual URL.
+        #
+        # @param [String] url
+        #
+        def process_value(url)
+          uri = URI(url)
+
+          if options[:user]
+            puts uri.user
+          elsif options[:password]
+            puts uri.password
+          elsif options[:user_password]
+            puts "#{uri.user}:#{uri.password}"
+          elsif options[:host]
+            puts uri.host
+          elsif options[:host_port]
+            puts "#{uri.host}:#{uri.port}"
+          elsif options[:path]
+            puts uri.path
+          elsif options[:query]
+            puts uri.query
+          elsif options[:path_query]
+            puts uri.request_uri
+          elsif options[:param]
+            puts uri.query_params[options[:param]]
+          elsif options[:fragment]
+            puts uri.fragment
+          elsif options[:status]
+            puts "#{uri.status} #{uri}"
+          else
+            puts uri
+          end
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,91 @@
+# 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 'ronin/cli/string_processor_command'
+require 'ronin/cli/key_options'
+
+require 'ronin/support/crypto'
+
+module Ronin
+  class CLI
+    module Commands
+      #
+      # XORs each character of data with a key.
+      #
+      # ## Usage
+      #
+      #     ronin xor [options] [FILE ...]
+      #
+      # ## Options
+      #
+      #     -f, --file FILE                  Optional file to process
+      #         --string STRING              Optional string to process
+      #     -M, --multiline                  Process each line separately
+      #     -n, --keep-newlines              Preserves newlines at the end of each line
+      #     -k, --key STRING                 The key String
+      #     -K, --key-file FILE              The key file
+      #     -h, --help                       Print help information
+      #
+      # ## Arguments
+      #
+      #     [FILE ...]                       Optional file(s) to process
+      #
+      class Xor < StringProcessorCommand
+
+        include KeyOptions
+
+        description "XORs each character of data with a key."
+
+        man_page 'ronin-xor.1'
+
+        #
+        # Runs the `ronin xor` command.
+        #
+        # @param [Array<String>] files
+        #   Additional files to process.
+        #
+        def run(*files)
+          unless @key
+            print_error "must specify --key or --key-file"
+            exit(-1)
+          end
+
+          super(*files)
+        end
+
+        #
+        # XORs the string.
+        #
+        # @param [String] string
+        #   The input string.
+        #
+        # @return [String]
+        #   The XORed string.
+        #
+        def process_string(string)
+          xored_string = Support::Crypto.xor(string,@key)
+
+          # escapes the String if outputing to a TTY
+          xored_string = xored_string.dump if stdout.tty?
+          return xored_string
+        end
+
+      end
+    end
+  end
+end

data/lib/ronin/cli/file_processor_command.rb

@@ -0,0 +1,94 @@
+# 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 'ronin/cli/command'
+
+module Ronin
+  class CLI
+    class FileProcessorCommand < Command
+
+      argument :file, required: false,
+                      repeats:  true,
+                      desc:     'Option file(s) to process'
+
+      #
+      # Runs the command and processes files or stdin.
+      #
+      # @param [Array<String>] files
+      #   Optional files to process.
+      #
+      def run(*files)
+        if files.empty?
+          process_input(stdin)
+        else
+          files.each(&method(:process_file))
+        end
+      end
+
+      #
+      # Opens a file for reading.
+      #
+      # @param [Stirng] path
+      #   The path to the file to open.
+      #
+      # @param [String] mode
+      #   The mode to open the file with.
+      #
+      # @yield [file]
+      #   If a block is given, the newly opened file will be yielded.
+      #   Once the block returns the file will automatically be closed.
+      #
+      # @yieldparam [File] file
+      #   The newly opened file.
+      #
+      # @return [File, nil]
+      #   If no block is given, the newly opened file object will be returned.
+      #   If no block was given, then `nil` will be returned.
+      #
+      def open_file(path,mode='r',&block)
+        File.open(path,mode,&block)
+      rescue Errno::ENOENT
+        print_error "no such file or directory: #{path}"
+        exit(1)
+      end
+
+      #
+      # Processes a file.
+      #
+      # @param [String] path
+      #   The path to the file to read and process.
+      #
+      def process_file(path)
+        open_file(path,&method(:process_input))
+      end
+
+      #
+      # Processes an input stream.
+      #
+      # @param [File, IO] input
+      #   The opened file or the `stdin` input stream.
+      #
+      # @abstract
+      #
+      def process_input(input)
+        raise(NotImplementedError,"#{self.class}##{__method__} method was not implemented")
+      end
+
+    end
+  end
+end