ronin 1.5.1 → 2.0.0.beta1

data/lib/ronin/cli/pattern_options.rb

@@ -0,0 +1,343 @@
+# 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/support/text/patterns'
+
+module Ronin
+  class CLI
+    #
+    # Adds pattern options to a command.
+    #
+    # ## Options
+    #
+    #     -N, --number                     Searches for all numbers
+    #     -X, --hex-number                 Searches for all hexadecimal numbers
+    #     -V, --version-number             Searches for all version numbers
+    #     -w, --word                       Searches for all words
+    #         --mac-addr                   Searches for all MAC addresses
+    #     -4, --ipv4-addr                  Searches for all IPv4 addresses
+    #     -6, --ipv6-addr                  Searches for all IPv6 addresses
+    #     -I, --ip                         Searches for all IP addresses
+    #     -H, --host                       Searches for all host names
+    #     -D, --domain                     Searches for all domain names
+    #         --uri                        Searches for all URIs
+    #     -U, --url                        Searches for all URLs
+    #         --user-name                  Searches for all user names
+    #     -E, --email-addr                 Searches for all email addresses
+    #         --obfuscated-email-addr      Searches for all obfuscated email addresses
+    #         --phone-number               Searches for all phone numbers
+    #         --ssn                        Searches for all Social Security Numbers (SSNs)
+    #         --amex-cc                    Searches for all AMEX Credit Card numbers
+    #         --discover-cc                Searches for all Discord Card numbers
+    #         --mastercard-cc              Searches for all MasterCard numbers
+    #         --visa-cc                    Searches for all VISA Credit Card numbers
+    #         --visa-mastercard-cc         Searches for all VISA MasterCard numbers
+    #         --cc                         Searches for all Credit Card numbers
+    #         --file-name                  Searches for all file names
+    #         --dir-name                   Searches for all directory names
+    #         --relative-unix-path         Searches for all relative UNIX paths
+    #         --absolute-unix-path         Searches for all absolute UNIX paths
+    #         --unix-path                  Searches for all UNIX paths
+    #         --relative-windows-path      Searches for all relative Windows paths
+    #         --absolute-windows-path      Searches for all absolute Windows paths
+    #         --windows-path               Searches for all Windows paths
+    #         --relative-path              Searches for all relative paths
+    #         --absolute-path              Searches for all absolute paths
+    #     -P, --path                       Searches for all paths
+    #         --variable-name              Searches for all variable names
+    #         --function-name              Searches for all function names
+    #         --md5                        Searches for all MD5 hashes
+    #         --sha1                       Searches for all SHA1 hashes
+    #         --sha256                     Searches for all SHA256 hashes
+    #         --sha512                     Searches for all SHA512 hashes
+    #         --hash                       Searches for all hashes
+    #         --ssh-private-key            Searches for all SSH private key data
+    #         --ssh-public-key             Searches for all SSH public key data
+    #         --private-key                Searches for all private key data
+    #         --rsa-public-key             Searches for all RSA public key data
+    #         --dsa-public-key             Searches for all DSA public key data
+    #         --ec-public-key              Searches for all EC public key data
+    #         --public-key                 Searches for all public key data
+    #         --aws-access-key-id          Searches for all AWS access key IDs
+    #         --aws-secret-access-key      Searches for all AWS secret access key
+    #     -A, --api-key                    Secretes for all API keys
+    #         --single-quoted-string       Searches for all single-quoted strings
+    #         --double-quoted-string       Searches for all double-quoted strings
+    #     -S, --string                     Searches for all quoted strings
+    #     -B, --base64                     Searches for all Base64 strings
+    #     -e, --regexp /REGEXP/            Custom regular expression to search for
+    #
+    module PatternOptions
+      include Support::Text::Patterns
+
+      #
+      # Adds pattern options to the command.
+      #
+      # @param [Class<Command>] command
+      #   The command including {PatternOptions}.
+      #
+      def self.included(command)
+        command.option :number, short: '-N',
+                         desc: 'Searches for all numbers' do
+                           @pattern = NUMBER
+                         end
+
+        command.option :hex_number, short: '-X',
+                             desc: 'Searches for all hexadecimal numbers' do
+                               @pattern = NUMBER
+                             end
+
+        command.option :version_number, short: '-V',
+                                        desc: 'Searches for all version numbers' do
+                                          @pattern = VERSION_NUMBER
+                                        end
+
+        command.option :word, short: '-w',
+                       desc: 'Searches for all words' do
+                         @pattern = WORD
+                       end
+
+        command.option :mac_addr, desc: 'Searches for all MAC addresses' do
+          @pattern = MAC_ADDR
+        end
+
+        command.option :ipv4_addr, short: '-4',
+                            desc: 'Searches for all IPv4 addresses' do
+                              @pattern = IPV4_ADDR
+                            end
+
+        command.option :ipv6_addr, short: '-6',
+                            desc: 'Searches for all IPv6 addresses' do
+                              @pattern = IPV6_ADDR
+                            end
+
+        command.option :ip, short: '-I',
+                     desc: 'Searches for all IP addresses' do
+                       @pattern = IP
+                     end
+
+        command.option :host, short: '-H',
+                       desc: 'Searches for all host names' do
+                         @pattern = HOST_NAME
+                       end
+
+        command.option :domain, short: '-D',
+                         desc: 'Searches for all domain names' do
+                           @pattern = DOMAIN
+                         end
+
+        command.option :uri, desc: 'Searches for all URIs' do
+                               @pattern = URI
+                             end
+
+        command.option :url, short: '-U',
+                      desc: 'Searches for all URLs' do
+                        @pattern = URL
+                      end
+
+        command.option :user_name, desc: 'Searches for all user names' do
+          @pattern = USER_NAME
+        end
+
+        command.option :email_addr, short: '-E',
+                             desc: 'Searches for all email addresses' do
+                               @pattern = EMAIL_ADDRESS
+                             end
+
+        command.option :obfuscated_email_addr, desc: 'Searches for all obfuscated email addresses' do
+                               @pattern = OBFUSCATED_EMAIL_ADDRESS
+                             end
+
+        command.option :phone_number, desc: 'Searches for all phone numbers' do
+          @pattern = PHONE_NUMBER
+        end
+
+        command.option :ssn, desc: 'Searches for all Social Security Numbers (SSNs)' do
+          @pattern = SSN
+        end
+
+        command.option :amex_cc, desc: 'Searches for all AMEX Credit Card numbers' do
+          @pattern = AMEX_CC
+        end
+
+        command.option :discover_cc, desc: 'Searches for all Discord Card numbers' do
+          @pattern = DISCOVER_CC
+        end
+
+        command.option :mastercard_cc, desc: 'Searches for all MasterCard numbers' do
+          @pattern = MASTERCARD_CC
+        end
+
+        command.option :visa_cc, desc: 'Searches for all VISA Credit Card numbers' do
+          @pattern = VISA_CC
+        end
+
+        command.option :visa_mastercard_cc, desc: 'Searches for all VISA MasterCard numbers' do
+          @pattern = VISA_MASTERCARD_CC
+        end
+
+        command.option :cc, desc: 'Searches for all Credit Card numbers' do
+          @pattern = CC
+        end
+
+        command.option :file_name, desc: 'Searches for all file names' do
+          @pattern = FILE_NAME
+        end
+
+        command.option :dir_name, desc: 'Searches for all directory names' do
+          @pattern = DIR_NAME
+        end
+
+        command.option :relative_unix_path, desc: 'Searches for all relative UNIX paths' do
+          @pattern = RELATIVE_UNIX_PATH
+        end
+
+        command.option :absolute_unix_path, desc: 'Searches for all absolute UNIX paths' do
+          @pattern = ABSOLUTE_UNIX_PATH
+        end
+
+        command.option :unix_path, desc: 'Searches for all UNIX paths' do
+          @pattern = UNIX_PATH
+        end
+
+        command.option :relative_windows_path, desc: 'Searches for all relative Windows paths' do
+          @pattern = RELATIVE_WINDOWS_PATH
+        end
+
+        command.option :absolute_windows_path, desc: 'Searches for all absolute Windows paths' do
+          @pattern = ABSOLUTE_WINDOWS_PATH
+        end
+
+        command.option :windows_path, desc: 'Searches for all Windows paths' do
+          @pattern = WINDOWS_PATH
+        end
+
+        command.option :relative_path, desc: 'Searches for all relative paths' do
+          @pattern = RELATIVE_PATH
+        end
+
+        command.option :absolute_path, desc: 'Searches for all absolute paths' do
+          @pattern = ABSOLUTE_PATHS
+        end
+
+        command.option :path, short: '-P',
+                      desc: 'Searches for all paths' do
+                        @pattern = PATH
+                      end
+
+        command.option :variable_name, desc: 'Searches for all variable names' do
+          @pattern = VARIABLE_NAME
+        end
+
+        command.option :function_name, desc: 'Searches for all function names' do
+          @pattern = FUNCTION_NAME
+        end
+
+        command.option :md5, desc: 'Searches for all MD5 hashes' do
+          @pattern = MD5
+        end
+
+        command.option :sha1, desc: 'Searches for all SHA1 hashes' do
+          @pattern = SHA1
+        end
+
+        command.option :sha256, desc: 'Searches for all SHA256 hashes' do
+          @pattern = SHA256
+        end
+
+        command.option :sha512, desc: 'Searches for all SHA512 hashes' do
+          @pattern = SHA512
+        end
+
+        command.option :hash, desc: 'Searches for all hashes' do
+          @pattern = HASH
+        end
+
+        command.option :ssh_private_key, desc: 'Searches for all SSH private key data' do
+          @pattern = SSH_PRIVATE_KEY
+        end
+
+        command.option :ssh_public_key, desc: 'Searches for all SSH public key data' do
+          @pattern = SSH_PUBLIC_KEY
+        end
+
+        command.option :private_key, short: '-K',
+                                     desc: 'Searches for all private key data' do
+                                       @pattern = PRIVATE_KEY
+                                     end
+
+        command.option :rsa_public_key, desc: 'Searches for all RSA public key data' do
+          @pattern = RSA_PUBLIC_KEY
+        end
+
+        command.option :dsa_public_key, desc: 'Searches for all DSA public key data' do
+          @pattern = DSA_PUBLIC_KEY
+        end
+
+        command.option :ec_public_key, desc: 'Searches for all EC public key data' do
+          @pattern = EC_PUBLIC_KEY
+        end
+
+        command.option :ssh_public_key, desc: 'Searches for all SSH public key data' do
+          @pattern = SSH_PUBLIC_KEY
+        end
+
+        command.option :public_key, desc: 'Searches for all public key data' do
+          @pattern = PUBLIC_KEY
+        end
+
+        command.option :aws_access_key_id, desc: 'Searches for all AWS access key IDs' do
+          @pattern = AWS_ACCESS_KEY_ID
+        end
+
+        command.option :aws_secret_access_key, desc: 'Searches for all AWS secret access key' do
+          @pattern = AWS_SECRET_ACCESS_KEY
+        end
+
+        command.option :api_key, short: '-A',
+                                 desc: 'Secretes for all API keys' do
+                                   @pattern = API_KEY
+                                 end
+
+        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
+          @pattern = DOUBLE_QUOTED_STRING
+        end
+
+        command.option :string, short: '-S',
+                         desc: 'Searches for all quoted strings' do
+                           @pattern = STRING
+                         end
+
+        command.option :base64, short: '-B',
+                        desc: 'Searches for all Base64 strings' do
+                          @pattern = BASE64
+                        end
+
+        command.option :regexp, short: '-e',
+                        value: {type: Regexp},
+                        desc: 'Custom regular expression to search for' do |regexp|
+                          @pattern = regexp
+                        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,153 @@
+# 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/printing/syntax_highlighting'
+
+module Ronin
+  class CLI
+    module Printing
+      #
+      # Common methods for {Commands::Http} and {HTTPShell}.
+      #
+      module HTTP
+        include SyntaxHighlighting
+
+        #
+        # Ensures that a final new-line is printed after the given text.
+        #
+        # @param [String] text
+        #   The previous text that was printed.
+        #
+        def print_last_newline(text)
+          if (stdout.tty? && text && !text.end_with?("\n"))
+            puts
+          end
+        end
+
+        #
+        # Prints a plain unhighlighted response body.
+        #
+        # @param [Net::HTTPResponse] response
+        #   The HTTP response object.
+        #
+        def print_plain_body(response)
+          last_chunk = nil
+
+          response.read_body do |chunk|
+            print chunk
+
+            last_chunk = chunk
+          end
+
+          print_last_newline(last_chunk)
+        end
+
+        #
+        # Returns the syntax lexer for the given `Content-Type` header.
+        #
+        # @param [String] content_type
+        #   The HTTP `Content-Type` header value.
+        #
+        # @return [Rouge::Lexers::HTML,
+        #          Rouge::Lexers::XML,
+        #          Rouge::Lexers::JavaScript,
+        #          Rouge::Lexers::JSON,
+        #          Rouge::Lexers::PlainText]
+        #   The specific syntax lexer or `nil` if the `Content-Type` was not
+        #   recognized.
+        #
+        def syntax_lexer_for_content_type(content_type)
+          syntax_lexer_for(mimetype: content_type.sub(/;.*$/,''))
+        end
+
+        #
+        # Prints a syntax highlgihted 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
+
+            print @syntax_formatter.format(lexer.lex(chunk))
+
+            last_chunk = chunk
+          end
+
+          print_last_newline(last_chunk)
+        end
+
+        #
+        # Prints the response body.
+        #
+        # @param [Net::HTTPResponse] response
+        #   The HTTP response object.
+        #
+        def print_body(response)
+          if ansi?
+            print_highlighted_body(response)
+          else
+            print_plain_body(response)
+          end
+        end
+
+        #
+        # Prints the respnse headers.
+        #
+        # @param [Net::HTTPResponse] response
+        #   The HTTP response object.
+        #
+        def print_headers(response)
+          color = if    response.code < '300' then colors.green
+                  elsif response.code < '400' then colors.yellow
+                  else                             colors.red
+                  end
+
+          puts "#{colors.bold}#{color}HTTP/#{response.http_version} #{response.code}#{colors.reset}"
+
+          response.each_capitalized do |name,value|
+            puts "#{color}#{colors.bold(name)}: #{value}#{colors.reset}"
+          end
+
+          puts
+        end
+
+        #
+        # Prints the response.
+        #
+        # @param [Net::HTTPResponse] response
+        #   The HTTP response object.
+        #
+        # @param [Boolean] show_headers
+        #   Controls whether the response headers are printed.
+        #
+        def print_response(response, show_headers: nil)
+          print_headers(response) if show_headers
+          print_body(response)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,96 @@
+# 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 'command_kit/colors'
+require 'rouge'
+
+module Ronin
+  class CLI
+    module Printing
+      module SyntaxHighlighting
+        include CommandKit::Colors
+
+        #
+        # Initializes the syntax highlighter.
+        #
+        # @param [Hash{Symbol => Object}] kwargs
+        #   Additional keyword arguments.
+        #
+        def initialize(**kwargs)
+          super(**kwargs)
+
+          if ansi?
+            @syntax_formatter = syntax_formatter
+          end
+        end
+
+        #
+        # Loads the syntax lexer for the filename, mimetype, or source code.
+        #
+        # @param [String] filename
+        #   The filename to infer the syntax from.
+        #
+        # @param [String] mimetype
+        #   The MIME-type to infer the syntax from.
+        #
+        # @param [String] source
+        #   The source code to infer the syntax from.
+        #
+        # @return [Rouge::Lexer]
+        #
+        def syntax_lexer_for(filename: nil, mimetype: nil, source: nil)
+          Rouge::Lexer.guess(
+            filename: filename,
+            mimetype: mimetype,
+            source:   source
+          )
+        end
+
+        #
+        # Looks up the syntax lexer class.
+        #
+        # @param [String] name
+        #   The syntax name.
+        #
+        # @return [Class<Rouge::Lexer>, nil]
+        #
+        def syntax_lexer(name)
+          Rouge::Lexer.find(name)
+        end
+
+        #
+        # The syntax highlighter theme.
+        #
+        # @return [Rouge::Theme]
+        #
+        def syntax_theme
+          Rouge::Themes::Molokai.new
+        end
+
+        #
+        # The syntax formatter.
+        #
+        # @return [Rouge::Formatters::Terminal256]
+        #
+        def syntax_formatter
+          Rouge::Formatters::Terminal256.new(syntax_theme)
+        end
+      end
+    end
+  end
+end

data/lib/ronin/{ui/cli/commands.rb → cli/string_methods_command.rb}

@@ -1,7 +1,6 @@
+# frozen_string_literal: true
 #
-# Copyright (c) 2006-2021 Hal Brodigan (postmodern.mod3 at gmail.com)
-#
-# This file is part of ronin.
+# 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
@@ -17,20 +16,32 @@
 # along with Ronin.  If not, see <https://www.gnu.org/licenses/>.
 #
 
-require 'open_namespace'
+require 'ronin/cli/string_processor_command'
+require 'ronin/cli/method_options'
 
 module Ronin
-  module UI
-    module CLI
+  class CLI
+    #
+    # Base class for all commands that process strings by calling one or more
+    # methods on them.
+    #
+    class StringMethodsCommand < StringProcessorCommand
+
+      include MethodOptions
+
       #
-      # The {Commands} namespace contains all of the {Command} classes
-      # available to {CLI}.
+      # Processes the string.
       #
-      module Commands
-        include OpenNamespace
-
-        self.namespace_root = File.join('ronin','ui','cli','commands')
+      # @param [String] string
+      #   The string to process.
+      #
+      # @return [String]
+      #   The end result string.
+      #
+      def process_string(string)
+        apply_method_options(string)
       end
+
     end
   end
 end