ronin 1.5.1 → 2.0.0.beta2

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

data/lib/ronin/cli/string_processor_command.rb

@@ -0,0 +1,185 @@
+# 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'
+
+module Ronin
+  class CLI
+    #
+    # Similar to {FileProcessorCommand}, but also accept raw strings via the
+    # `--string STR` option and files via the `--file FILE` option.
+    #
+    class StringProcessorCommand < FileProcessorCommand
+
+      #
+      # A value object that represents a literal String input value.
+      #
+      class StringValue
+
+        # The literal string value.
+        #
+        # @return [String]
+        attr_reader :string
+
+        #
+        # Initializes the stirng value.
+        #
+        # @param [String] string
+        #   The string value.
+        #
+        def initialize(string)
+          @string = string
+        end
+
+      end
+
+      #
+      # A value object that represents a file to process.
+      #
+      class FileValue
+
+        # The file's path.
+        #
+        # @return [String]
+        attr_reader :file
+
+        #
+        # Initializes the file value.
+        #
+        # @param [String] file
+        #   The path to the file.
+        #
+        def initialize(file)
+          @file = file
+        end
+
+      end
+
+      usage '[options] [FILE ...]'
+
+      option :file, short: '-f',
+                    value: {
+                      type: String,
+                      usage: 'FILE'
+                    },
+                    desc: 'Optional file to process' do |file|
+                      @input_values << FileValue.new(file)
+                    end
+
+      option :string, value: {
+                        type:  String,
+                        usage: 'STRING'
+                      },
+                      desc: 'Optional string to process' do |string|
+                        @input_values << StringValue.new(string)
+                      end
+
+      option :multiline, short: '-M',
+                         desc: 'Process each line separately'
+
+      option :keep_newlines, short: '-n',
+                             desc: 'Preserves newlines at the end of each line'
+
+      argument :file, required: false,
+                      repeats:  true,
+                      desc:     'Optional file(s) to process'
+
+      # The input values to process.
+      #
+      # @return [Array<StringValue, FileValue>]
+      attr_reader :input_values
+
+      #
+      # Initializes the string processor command.
+      #
+      # @param [Hash{Symbol => Object}] kwargs
+      #   Additional keyword arguments.
+      #
+      def initialize(**kwargs)
+        super(**kwargs)
+
+        @input_values = []
+      end
+
+      #
+      # Runs the command.
+      #
+      # @param [Array<String>] files
+      #   Additional files to proceess.
+      #
+      def run(*files)
+        if (files.empty? && @input_values.empty?)
+          process_input(stdin)
+        else
+          @input_values.each do |value|
+            case value
+            when StringValue
+              print_string(process_string(value.string))
+            when FileValue
+              process_file(value.file)
+            end
+          end
+
+          files.each(&method(:process_file))
+        end
+      end
+
+      #
+      # Processes an input stream.
+      #
+      # @param [IO] input
+      #   The input stream to read and process.
+      #
+      def process_input(input)
+        if options[:multiline]
+          input.each_line(chomp: !options[:keep_newlines]) do |line|
+            print_string(process_string(line))
+          end
+        else
+          print_string(process_string(input.read))
+        end
+      end
+
+      #
+      # Prints a string value.
+      #
+      # @param [String] string
+      #   The string value to print.
+      #
+      def print_string(string)
+        puts string
+      end
+
+      #
+      # Processes the string.
+      #
+      # @param [String] string
+      #   The string to process.
+      #
+      # @return [String]
+      #   The end result string.
+      #
+      # @abstract
+      #
+      def process_string(string)
+        raise(NotImplementedError,"#{self.class}##{__method__} method was not implemented")
+      end
+
+    end
+  end
+end

data/lib/ronin/cli/typo_options.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/support/text/typo'
+
+module Ronin
+  class CLI
+    #
+    # Adds options for enabling typo generator rules.
+    #
+    # ## 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
+    #
+    module TypoOptions
+      #
+      # Adds typo options to the command.
+      #
+      # @param [Class<Command>] command
+      #   The command including {TypoOptions}.
+      #
+      def self.included(command)
+        command.option :omit_chars, desc: 'Toggles whether to omit repeated characters' do
+          @typo_kwargs[:emit_chars] = true
+        end
+
+        command.option :repeat_chars, desc: 'Toggles whether to repeat single characters' do
+          @typo_kwargs[:repeat_chars] = true
+        end
+
+        command.option :swap_chars, desc: 'Toggles whether to swap certain common character pairs' do
+          @typo_kwargs[:swap_chars] = true
+        end
+
+        command.option :change_suffix, desc: 'Toggles whether to change the suffix of words' do
+          @typo_kwargs[:change_suffix] = true
+        end
+      end
+
+      #
+      # Initializes the command.
+      #
+      # @param [Hash{Symbol => Object}] kwargs
+      #   Additional keyword arguments.
+      #
+      def initialize(**kwargs)
+        super(**kwargs)
+
+        @typo_kwargs = {}
+      end
+
+      #
+      # The typo generator.
+      #
+      # @return [Ronin::Support::Text::Typo::Generator]
+      #
+      def typo_generator
+        @type_generator ||= Support::Text::Typo.generator(**@typo_kwargs)
+      end
+    end
+  end
+end

data/lib/ronin/cli/value_processor_command.rb

@@ -0,0 +1,97 @@
+# 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
+    #
+    # Represents a command which accepts one or more values from the
+    # command-line or a file.
+    #
+    class ValueProcessorCommand < Command
+
+      option :file, short: '-f',
+                    value: {
+                      type:  String,
+                      usage: 'FILE'
+                    },
+                    desc: 'Optional file to read values from' do |path|
+                      @files << path
+                    end
+
+      # The additional files to process.
+      #
+      # @return [Array<String>]
+      attr_reader :files
+
+      # 
+      # Initializes the command.
+      #
+      # @param [Hash{Symbol => Object}] kwargs
+      #   Additional keyword arguments.
+      #
+      def initialize(**kwargs)
+        super(**kwargs)
+
+        @files = []
+      end
+
+      #
+      # Runs the command
+      #
+      # @param [Array<String>] values
+      #   Additional arguments to process.
+      #
+      def run(*values)
+        if (values.empty? && @files.empty?)
+          print_error "must specify one or more arguments, or the --file option"
+          exit(1)
+        end
+
+        @files.each(&method(:process_file))
+        values.each(&method(:process_value))
+      end
+
+      #
+      # Reads and processes each line of the file.
+      #
+      # @param [String] path
+      #   The path to the file.
+      #
+      def process_file(path)
+        File.open(path) do |file|
+          file.each_line(chomp: true, &method(:process_value))
+        end
+      end
+
+      #
+      # Processes an individual value.
+      #
+      # @param [String] value
+      #   The string value to process.
+      #
+      # @abstract
+      #
+      def process_value(value)
+        raise(NotImplementedError,"#{self.class}##{__method__} method was not implemented")
+      end
+
+    end
+  end
+end

data/lib/ronin/cli.rb

@@ -0,0 +1,75 @@
+# 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/version'
+
+require 'command_kit/commands'
+require 'command_kit/commands/auto_load'
+require 'command_kit/options/version'
+
+module Ronin
+  #
+  # The main CLI logic for the `ronin` command.
+  #
+  # @api private
+  #
+  # @since 2.0.0
+  #
+  class CLI
+
+    include CommandKit::Commands
+    include CommandKit::Commands::AutoLoad.new(
+      dir:       "#{__dir__}/cli/commands",
+      namespace: "#{self}::Commands"
+    )
+    include CommandKit::Options::Version
+
+    command_name 'ronin'
+    version Ronin::VERSION
+
+    command_aliases['enc'] = 'encode'
+    command_aliases['dec'] = 'decode'
+    command_aliases['nc']  = 'netcat'
+
+    ADDITIONAL_RONIN_COMMANDS = %w[
+      ronin-repos
+      ronin-db
+      ronin-web
+      ronin-fuzzer
+      ronin-payloads
+      ronin-exploits
+      ronin-vulns
+    ]
+
+    #
+    # Prints the regular `--help` output but also lists other `ronin-*`
+    # commands.
+    #
+    def help
+      super
+
+      puts
+      puts "Additional Ronin Commands:"
+      ADDITIONAL_RONIN_COMMANDS.each do |name|
+        puts "    $ #{name}"
+      end
+      puts
+    end
+
+  end
+end

data/lib/ronin/config.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,7 +16,6 @@
 # along with Ronin.  If not, see <https://www.gnu.org/licenses/>.
 #
 
-require 'data_paths'
 require 'fileutils'
 
 module Ronin
@@ -27,9 +25,6 @@ module Ronin
   # @api semipublic
   #
   module Config
-    include DataPaths
-    extend DataPaths::Finders
-
     # The users home directory
     HOME = Gem.user_home
 
@@ -39,9 +34,6 @@ module Ronin
     # Configuration files directory
     CONFIG_DIR = File.join(PATH,'config')
 
-    # Directory which repositories are installed into
-    REPOS_DIR = File.join(PATH,'repos')
-
     # Temporary file directory
     TMP_DIR = File.join(PATH,'tmp')
 

data/lib/ronin/{database/exceptions/invalid_config.rb → root.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
@@ -18,8 +17,8 @@
 #
 
 module Ronin
-  module Database
-    class InvalidConfig < RuntimeError
-    end
-  end
+  # Path to `ronin` root directory.
+  #
+  # @api private
+  ROOT = File.expand_path(File.join(__dir__,'..','..'))
 end

data/lib/ronin/ui.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,6 +16,7 @@
 # along with Ronin.  If not, see <https://www.gnu.org/licenses/>.
 #
 
-require 'ronin/ui/output'
+require 'ronin/ui/print'
 require 'ronin/ui/console'
 require 'ronin/ui/shell'
+require 'ronin/ui/cli'

data/lib/ronin/version.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
@@ -19,5 +18,5 @@
 
 module Ronin
   # ronin version 
-  VERSION = '1.5.1'
+  VERSION = '2.0.0.beta2'
 end

data/lib/ronin.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
@@ -20,6 +19,11 @@
 #
 # Loads up the full Ronin environment.
 #
-require 'ronin/bootstrap'
-require 'ronin/environment'
+require 'ronin/support/core_ext'
 require 'ronin/version'
+
+require 'open_namespace'
+
+module Ronin
+  include OpenNamespace
+end