ronin 1.5.1 → 2.0.0.beta1

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

@@ -0,0 +1,190 @@
+# 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
+    module Commands
+      #
+      # Prints a random tip on how to use `ronin`.
+      #
+      # ## Usage
+      #
+      #     ronin tips [options]
+      #
+      # ## Options
+      #
+      #        --list-categories            Prints all category names
+      #    -c, --category STR               Print a random tip from the category
+      #    -s, --search TEXT                Searches all tip files for the text
+      #    -h, --help                       Print help information
+      #
+      class Tips < Command
+
+        # Path to the `data/tips/` directory.
+        TIPS_DIR = File.join(__dir__,'..','..','..','..','data','tips')
+
+        option :list_categories, desc: 'Prints all category names'
+
+        option :category, value: true,
+                          short: '-c',
+                          desc:  'Print a random tip from the category'
+
+        option :search, value: {
+                          type:  String,
+                          usage: 'TEXT'
+                        },
+                        short: '-s',
+                        desc:  'Searches all tip files for the text'
+
+        description 'Prints a random tip on how to use ronin'
+
+        man_page 'ronin-tips.1'
+
+        #
+        # Runs the tip command.
+        #
+        def run
+          if options[:list_categories]
+            puts tip_category_names
+          else
+            category = options[:category]
+
+            if category && !tip_category_names.include?(category)
+              print_error "unknown category name: #{category}."
+              print_error "please see `ronin tips --list-categories` for all category names."
+              exit(1)
+            end
+
+            if options[:search]
+              print_matching_tips(options[:search], category: category)
+            else
+              print_random_tip(category)
+            end
+          end
+        end
+
+        #
+        # All of the paths to the tip category directories.
+        #
+        # @return [Array<String>]
+        #
+        def tip_category_paths
+          Dir[File.join(TIPS_DIR,'*/')]
+        end
+
+        #
+        # All of the tip category names.
+        #
+        # @return [Array<String>]
+        #
+        def tip_category_names
+          tip_category_paths.map { |path| File.basename(path) }
+        end
+
+        #
+        # Gets the paths to all of the tip files.
+        #
+        # @param [String, nil] category
+        #   The optional tips category to select the tip files from.
+        #
+        # @return [Array<String>]
+        #   The paths to all files in `data/tips/`.
+        #
+        def tip_paths(category=nil)
+          glob_pattern = if category then File.join(TIPS_DIR,category,'*.txt')
+                         else             File.join(TIPS_DIR,'{*/}*.txt')
+                         end
+
+          return Dir[glob_pattern]
+        end
+
+        #
+        # Gets a path to a random tipe.
+        #
+        # @param [String, nil] category
+        #   The optional tips category to select the random tip from.
+        #
+        # @return [String]
+        #   The path to the random tip.
+        #
+        def random_tip_path(category=nil)
+          tip_paths(category).sample
+        end
+
+        #
+        # Searches through all tip files for the given text.
+        #
+        # @param [String] text
+        #   The text to search for.
+        #
+        # @param [String, nil] category
+        #   The optional tips category to search within.
+        #
+        # @return [Array<String>]
+        #   The paths to the tip files containing the matching text.
+        #
+        def search_tip_files(text, category: nil)
+          tip_paths(category).select do |path|
+            File.read(path).include?(text)
+          end
+        end
+
+        #
+        # Prints a tip at the given path.
+        #
+        # @param [String] path
+        #   The path to the tip file.
+        #
+        def print_tip(path)
+          contents = File.read(path)
+
+          puts contents
+
+          unless contents.end_with?("#{$/}#{$/}")
+            puts
+            puts
+          end
+        end
+
+        #
+        # Prints a random tip.
+        #
+        # @param [String, nil] category
+        #   The optional tips category to select the random tip from.
+        #
+        # @api private
+        #
+        def print_random_tip(category=nil)
+          print_tip(random_tip_path(category))
+        end
+
+        #
+        # Prints all tips that contain the given text.
+        #
+        def print_matching_tips(text, category: nil)
+          search_tip_files(text, category: category).each do |path|
+            print_tip(path)
+          end
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,118 @@
+# 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/core/cli/logging'
+require 'ronin/support/network/tld/list'
+
+require 'command_kit/options/verbose'
+
+module Ronin
+  class CLI
+    module Commands
+      #
+      # Updates and parses the TLD list file.
+      #
+      # ## Usage
+      #
+      #     ronin tld-list [options]
+      #
+      # ## Options
+      #
+      #     -v, --verbose                    Enables verbose output
+      #     -u, --update                     Updates the TLD list file
+      #     -U, --url URL                    URL to the TLD list (Default: https://data.iana.org/TLD/tlds-alpha-by-domain.txt)
+      #     -p, --path FILE                  Path to the TLD list file (Default: ~/.cache/ronin/ronin-support/tlds-alpha-by-domain.txt)
+      #     -h, --help                       Print help information
+      #
+      class TldList < Command
+
+        include Ronin::Support::Network::TLD
+        include CommandKit::Options::Verbose
+        include Core::CLI::Logging
+
+        option :update, short: '-u',
+                        desc: 'Updates the TLD list file'
+
+        option :url, short: '-U',
+                     value: {
+                       type:  String,
+                       usage: 'URL',
+                       default: List::URL
+                     },
+                     desc: 'URL to the TLD list'
+
+        option :path, short: '-p',
+                      value: {
+                        type:  String,
+                        usage: 'FILE',
+                        default: List::PATH
+                      },
+                      desc: 'Path to the TLD list file'
+
+        description "Updates and parses the TLD list file"
+
+        man_page 'ronin-tld-list.1'
+
+        def run(*args)
+          if !File.file?(options[:path])
+            download
+          elsif options[:update] || stale?
+            update
+          end
+
+          list_file = List.load_file(options[:path])
+
+          list_file.each do |tld|
+            puts tld
+          end
+        end
+
+        #
+        # Determines if the TLD list file is stale.
+        #
+        def stale?
+          List.stale?(options[:path])
+        end
+
+        #
+        # Downloads the TLD list file.
+        #
+        def download
+          if verbose?
+            log_info "Downloading TLD list from #{options[:url]} to #{options[:path]} ..."
+          end
+
+          List.download(url: options[:url], path: options[:path])
+        end
+
+        #
+        # Updates the TLD list file.
+        #
+        def update
+          if verbose?
+            log_info "Updating TLD list file #{options[:path]} ..."
+          end
+
+          List.update(path: options[:path])
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,80 @@
+# 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 'ronin/cli/typo_options'
+
+module Ronin
+  class CLI
+    module Commands
+      #
+      # Generates typos in words.
+      #
+      # ## Usage
+      #
+      #     ronin typo [options] [WORD ...]
+      #
+      # ## Options
+      #
+      #     -f, --file FILE                  Optional file to process
+      #         --omit-chars                 Toggles whether to omit repeated characters
+      #         --repeat-chars               Toggles whether to repeat single characters
+      #         --swap-chars                 Toggles whether to swap certain common character pairs
+      #         --change-suffix              Toggles whether to change the suffix of words
+      #     -E, --enum                       Enumerates over every possible typo of a word
+      #     -h, --help                       Print help information
+      #
+      # ## Arguments
+      #
+      #     [WORD ...]                       Optional word(s) to typo
+      #
+      class Typo < ValueProcessorCommand
+
+        include TypoOptions
+
+        option :enum, short: '-E',
+                      desc:  'Enumerates over every possible typo of a word'
+
+        argument :word, repeats:  true,
+                        required: false,
+                        desc:     'Optional word(s) to typo'
+
+        description 'Generates typos in words'
+
+        man_page 'ronin-typo.1'
+
+        #
+        # Processes each word.
+        #
+        # @param [String] word
+        #   A word argument to typo.
+        #
+        def process_value(word)
+          if options[:enum]
+            typo_generator.each_substitution(word) do |typo|
+              puts typo
+            end
+          else
+            puts typo_generator.substitute(word)
+          end
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,123 @@
+# 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 'ronin/cli/typo_options'
+
+require 'ronin/support/network/domain'
+
+module Ronin
+  class CLI
+    module Commands
+      #
+      # Finds typo squatted domains.
+      #
+      # ## Usage
+      #
+      #     ronin typosquat [options] DOMAIN
+      #
+      # ## Options
+      #
+      #         --omit-chars                 Toggles whether to omit repeated characters
+      #         --repeat-chars               Toggles whether to repeat single characters
+      #         --swap-chars                 Toggles whether to swap certain common character pairs
+      #         --change-suffix              Toggles whether to change the suffix of words
+      #         -A, --has-addresses          Print typo squat domains with addresses
+      #         -r, --registered             Print typo squat domains that are already registered
+      #         -u, --unregistered           Print typo squat domains that can be registered
+      #     -h, --help                       Print help information
+      #
+      # ## Arguments
+      #
+      #     DOMAIN                           The domain to typo squat
+      #
+      class Typosquat < ValueProcessorCommand
+
+        include TypoOptions
+
+        option :has_addresses, desc: 'Print typo squat domains with addresses'
+
+        option :registered, desc: 'Print typo squat domains that are already registered'
+
+        option :unregistered, desc: 'Print typo squat domains that can be registered'
+
+        argument :domain, required: true,
+                          desc:     'The domain to typo squat'
+
+        description 'Finds typo squatted domains'
+
+        man_page 'ronin-typosquat.1'
+
+        #
+        # Processes each word.
+        #
+        # @param [String] domain
+        #   A word argument to typo.
+        #
+        def run(domain)
+          if options[:has_addresses]
+            each_typo_squat(domain) do |typo_domain|
+              if typo_domain.has_addresses?
+                puts typo_domain
+              end
+            end
+          elsif options[:registered]
+            each_typo_squat(domain) do |typo_domain|
+              if typo_domain.registered?
+                puts typo_domain
+              end
+            end
+          elsif options[:unregistered]
+            each_typo_squat(domain) do |typo_domain|
+              if typo_domain.unregistered?
+                puts typo_domain
+              end
+            end
+          else
+            each_typo_squat(domain) do |typo_domain|
+              puts typo_domain
+            end
+          end
+        end
+
+        #
+        # Enumerates over each typo squate of the domain.
+        #
+        # @param [String] domain
+        #   The domain to typo squat.
+        #
+        # @yield [typo_domain]
+        #   The given block will be passed each new typo squated domain.
+        #
+        # @yieldparam [Ronin::Support::Network::Domain] typo_domain
+        #   A typo squated variation on the input domain.
+        #
+        def each_typo_squat(domain)
+          domain = Support::Network::Domain.new(domain)
+          suffix = domain.suffix
+          name   = domain.name.chomp(suffix)
+
+          typo_generator.each_substitution(name) do |typo|
+            yield Support::Network::Domain.new("#{typo}#{suffix}")
+          end
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,121 @@
+# 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
+      #
+      # Unescapes each escaped character from a variety of encodings.
+      #
+      # ## Usage
+      #
+      #     ronin unescape [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
+      #     -c, --c                          Unescapes the data as a C string
+      #     -X, --hex                        Unescape the data as a hex string (ex: ABC\x01\x02\x03...)
+      #     -H, --html                       HTML unescapes the data
+      #     -u, --uri                        URI unescapes the data
+      #         --http                       HTTP unescapes the data
+      #     -j, --js                         JavaScript unescapes the data
+      #     -S, --shell                      Unescapes the data as a Shell String
+      #     -P, --powershell                 Unescapes the data as a PowerShell String
+      #     -R, --ruby                       Unescapes the data as a Ruby String
+      #     -x, --xml                        XML unescapes the data
+      #     -h, --help                       Print help information
+      #
+      # ## Arguments
+      #
+      #     [FILE ...]                       Optional file(s) to process
+      #
+      class Unescape < StringMethodsCommand
+
+        option :c, short: '-c',
+                   desc: 'Unescapes the data as a C string' do
+                     require 'ronin/support/encoding/c'
+                     @method_calls << :c_unescape
+                   end
+
+        option :hex, short: '-X',
+                     desc: 'Unescape the data as a hex string (ex: ABC\x01\x02\x03...)' do
+                       require 'ronin/support/encoding/hex'
+                       @method_calls << :hex_unescape
+                     end
+
+        option :html, short: '-H',
+                      desc: 'HTML unescapes the data' do
+                        require 'ronin/support/encoding/html'
+                        @method_calls << :html_unescape
+                      end
+
+        option :uri, short: '-u',
+                     desc: 'URI unescapes the data' do
+                       require 'ronin/support/encoding/uri'
+                       @method_calls << :uri_unescape
+                     end
+
+        option :http, desc: 'HTTP unescapes the data' do
+          require 'ronin/support/encoding/http'
+          @method_calls << :http_unescape
+        end
+
+        option :js, short: '-j',
+                    desc: 'JavaScript unescapes the data' do
+                      require 'ronin/support/encoding/js'
+                      @method_calls << :js_unescape
+                    end
+
+        option :shell, short: '-S',
+                       desc: 'Unescapes the data as a Shell String' do
+                         require 'ronin/support/encoding/shell'
+                         @method_calls << :shell_unescape
+                       end
+
+        option :powershell, short: '-P',
+                            desc: 'Unescapes the data as a PowerShell String' do
+                              require 'ronin/support/encoding/powershell'
+                              @method_calls << :powershell_unescape
+                            end
+
+        option :ruby, short: '-R',
+                      desc: 'Unescapes the data as a Ruby String' do
+                        require 'ronin/support/encoding/ruby'
+                        @method_calls << :ruby_unescape
+                      end
+
+        option :xml, short: '-x',
+                     desc: 'XML unescapes the data' do
+                       require 'ronin/support/encoding/xml'
+                       @method_calls << :xml_unescape
+                     end
+
+        description 'Unescapes each escaped character from a variety of encodings'
+
+        man_page 'ronin-unescape.1'
+
+      end
+    end
+  end
+end