ronin 1.5.1 → 2.0.0.beta1

data/lib/ronin/cli/commands/quote.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
+      #
+      # Produces quoted a string for a variety of programming languages.
+      #
+      # ## Usage
+      #
+      #     ronin quote [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                        Quotes the data as a Hex string
+      #     -c, --c                          Quotes the data as a C string
+      #     -j, --js                         JavaScript quotes the data
+      #     -S, --shell                      Quotes the data as a Shell String
+      #     -P, --powershell                 Quotes the data as a PowerShell String
+      #     -R, --ruby                       Quotes the data as a Ruby String
+      #     -h, --help                       Print help information
+      #
+      # ## Arguments
+      #
+      #     [FILE ...]                       Optional file(s) to process
+      #
+      class Quote < StringMethodsCommand
+
+        option :hex, short: '-X',
+                     desc: 'Quotes the data as a Hex string' do
+                       require 'ronin/support/encoding/hex'
+                       @method_calls << :hex_string
+                     end
+
+        option :c, short: '-c',
+                   desc: 'Quotes the data as a C string' do
+                     require 'ronin/support/encoding/c'
+                     @method_calls << :c_string
+                   end
+
+        option :js, short: '-j',
+                    desc: 'JavaScript quotes the data' do
+                      require 'ronin/support/encoding/js'
+                      @method_calls << :js_string
+                    end
+
+        option :shell, short: '-S',
+                       desc: 'Quotes the data as a Shell String' do
+                         require 'ronin/support/encoding/shell'
+                         @method_calls << :shell_string
+                       end
+
+        option :powershell, short: '-P',
+                            desc: 'Quotes the data as a PowerShell String' do
+                              require 'ronin/support/encoding/powershell'
+                              @method_calls << :powershell_string
+                            end
+
+        option :ruby, short: '-R',
+                      desc: 'Quotes the data as a Ruby String' do
+                        require 'ronin/support/encoding/ruby'
+                        @method_calls << :ruby_string
+                      end
+
+        description 'Produces quoted a string for a variety of programming languages'
+
+        man_page 'ronin-quote.1'
+
+        #
+        # Quotes the String.
+        #
+        # @param [String] string
+        #   The String to quote.
+        #
+        # @return [String]
+        #   The quoted String.
+        #
+        # @note
+        #   If no options are given, then `--string` is assumed.
+        #
+        def process_string(string)
+          if @method_calls.empty?
+            string.inspect
+          else
+            super(string)
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/ronin/cli/commands/rot.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_processor_command'
+
+require 'ronin/support/crypto'
+
+module Ronin
+  class CLI
+    module Commands
+      #
+      # Rotates each character of data within an alphabet.
+      #
+      # ## Usage
+      #
+      #     ronin rot [options] [FILE ...]
+      #
+      # ## Options
+      #
+      #     -f, --file FILE                  Optional file to process
+      #         --string STRING              Optional string to process
+      #     -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
+      #     -h, --help                       Print help information
+      #
+      # ## Arguments
+      #
+      #     [FILE ...]                       Optional file(s) to process
+      #
+      class Rot < StringProcessorCommand
+
+        option :alphabet, short: '-A',
+                          value: {
+                            type: String,
+                            usage: 'ABC...'
+                          },
+                          desc: 'Alphabet characters' do |str|
+                            @alphabets << str.chars
+                          end
+
+        option :modulu, short: '-n',
+                        value: {
+                          type:  Integer,
+                          usage: 'NUM'
+                        },
+                        desc: 'Number of characters to rotate' do |num|
+                          @n = num
+                        end
+
+        description "Rotates each character of data within an alphabet"
+
+        man_page 'ronin-rot.1'
+
+        # The number of characters to rotate.
+        #
+        # @return [Integer]
+        attr_reader :n
+
+        # The alphabets to rotate within.
+        #
+        # @return [Array<Array<String>>]
+        attr_reader :alphabets
+
+        #
+        # Initializes the `ronin rot` command.
+        #
+        # @param [Hash{Symbol => Object}] kwargs
+        #   Additional keywords.
+        #
+        def initialize(**kwargs)
+          super(**kwargs)
+
+          @n = 13
+          @alphabets = []
+        end
+
+        #
+        # Rotates each character in the string.
+        #
+        # @param [String] string
+        #   The input string.
+        #
+        # @return [String]
+        #   The rotated string.
+        #
+        def process_string(string)
+          if !@alphabets.empty?
+            Support::Crypto.rot(string,@n, alphabets: @alphabets)
+          else
+            Support::Crypto.rot(string,@n)
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/ronin/cli/commands/sha1.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 'ronin/cli/string_processor_command'
+
+require 'digest'
+
+module Ronin
+  class CLI
+    module Commands
+      #
+      # Calculates SHA1 hashes of data.
+      #
+      # ## Usage
+      #
+      #     ronin sha1 [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
+      #     -h, --help                       Print help information
+      #
+      # ## Arguments
+      #
+      #     [FILE ...]                       Optional file(s) to process
+      #
+      class Sha1 < StringProcessorCommand
+
+        description "Calculates SHA1 hashes of data"
+
+        man_page 'ronin-sha1.1'
+
+        def process_string(string)
+          Digest::SHA1.hexdigest(string)
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,67 @@
+# 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 'digest'
+
+module Ronin
+  class CLI
+    module Commands
+      #
+      # Calculates SHA256 hashes of data.
+      #
+      # ## Usage
+      #
+      #     ronin sha256 [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
+      #     -h, --help                       Print help information
+      #
+      # ## Arguments
+      #
+      #     [FILE ...]                       Optional file(s) to process
+      #
+      class Sha256 < StringProcessorCommand
+
+        description "Calculates SHA256 hashes of data"
+
+        man_page 'ronin-sha256.1'
+
+        #
+        # Computes a SHA256 checksum for the given String.
+        #
+        # @param [String] string
+        #   The input string.
+        #
+        # @return [String]
+        #   The SHA256 hexdigest of the given String.
+        #
+        def process_string(string)
+          Digest::SHA256.hexdigest(string)
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,67 @@
+# 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 'digest'
+
+module Ronin
+  class CLI
+    module Commands
+      #
+      # Calculates SHA512 hashes of data.
+      #
+      # ## Usage
+      #
+      #     ronin sha512 [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
+      #     -h, --help                       Print help information
+      #
+      # ## Arguments
+      #
+      #     [FILE ...]                       Optional file(s) to process
+      #
+      class Sha512 < StringProcessorCommand
+
+        description "Calculates SHA512 hashes"
+
+        man_page 'ronin-sha512.1'
+
+        #
+        # Computes a SHA512 checksum for the given String.
+        #
+        # @param [String] string
+        #   The input string.
+        #
+        # @return [String]
+        #   The SHA512 hexdigest of the given String.
+        #
+        def process_string(string)
+          Digest::SHA512.hexdigest(string)
+        end
+
+      end
+    end
+  end
+end

data/lib/ronin/cli/commands/strings.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/file_processor_command'
+require 'ronin/cli/char_set_options'
+
+module Ronin
+  class CLI
+    module Commands
+      #
+      # Finds all strings within a file/stream with a certain character set.
+      #
+      # ## Usage
+      #
+      #     ronin strings [options] [FILE ...]
+      #
+      # ## Options
+      #
+      #     -N, --numeric                    Searches for numeric characters (0-9)
+      #     -O, --octal                      Searches for octal characters (0-7)
+      #     -X, --upper-hex                  Searches for uppercase hexadecimal (0-9, A-F)
+      #     -x, --lower-hex                  Searches for lowercase hexadecimal (0-9, a-f)
+      #     -H, --hex                        Searches for hexadecimal chars (0-9, a-f, A-F)
+      #         --upper-alpha                Searches for uppercase alpha chars (A-Z)
+      #         --lower-alpha                Searches for lowercase alpha chars (a-z)
+      #     -A, --alpha                      Searches for alpha chars (a-z, A-Z)
+      #         --alpha-num                  Searches for alpha-numeric chars (a-z, A-Z, 0-9)
+      #     -P, --punct                      Searches for punctuation chars
+      #     -S, --symbols                    Searches for symbolic chars
+      #     -s, --space                      Searches for all whitespace chars
+      #     -v, --visible                    Searches for all visible chars
+      #     -p, --printable                  Searches for all printable chars
+      #     -C, --control                    Searches for all control chars (\x00-\x1f, \x7f)
+      #     -a, --signed-ascii               Searches for all signed ASCII chars (\x00-\x7f)
+      #         --ascii                      Searches for all ASCII chars (\x00-\xff)
+      #     -c, --chars CHARS                Searches for all chars in the custom char-set
+      #     -i, --include-chars CHARS        Include the additional chars to the char-set
+      #     -e, --exclude-chars CHARS        Exclude the additional chars from the char-set
+      #     -n, --min-length LEN             Minimum length of strings to print (Default: 4)
+      #
+      # ## Arguments
+      #
+      #     [FILE ...]                       The file(s) to read
+      #
+      # ## Examples
+      #
+      #     ronin strings --hex -n 32 file.bin
+      #
+      class Strings < FileProcessorCommand
+
+        include CharSetOptions
+
+        usage '[options] [FILE ...]'
+
+        option :min_length, short: '-n',
+                            value: {
+                              type: Integer,
+                              usage: 'LEN',
+                              default: 4
+                            },
+                            desc: 'Minimum length of strings to print'
+
+        option :null_byte, short: '-0',
+                           desc: 'Print each string terminated with a null byte'
+
+        argument :file, required: false,
+                        repeats:  true,
+                        desc:     'The file(s) to read'
+
+        description 'Prints all strings within a file/stream belonging to the given character set'
+
+        examples [
+          '--hex -n 32 file.bin',
+        ]
+
+        man_page 'ronin-strings.1'
+
+        #
+        # Opens the file in binary mode.
+        #
+        # @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(file,&block)
+          super(file,'rb',&block)
+        end
+
+        #
+        # Scans the input stream for printable strings.
+        #
+        # @param [IO, StringIO] input
+        #   The input string.
+        #
+        def process_input(input)
+          buffer     = String.new
+          min_length = options[:min_length]
+
+          input.each_char do |char|
+            if @char_set.include_char?(char)
+              buffer << char
+            else
+              print_buffer(buffer) if buffer.length >= min_length
+              buffer.clear
+            end
+          end
+
+          # print any remaining chars
+          print_buffer(buffer) if buffer.length >= min_length
+        end
+
+        #
+        # Prints a buffer to `STDOUT`.
+        #
+        # @param [String] buffer
+        #
+        def print_buffer(buffer)
+          if options[:null_byte]
+            stdout.write(buffer)
+            putc("\0")
+          else
+            puts buffer
+          end
+        end
+
+      end
+    end
+  end
+end