ronin-core 0.1.0.beta1

data/lib/ronin/core/cli/printing/os.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+#
+# Copyright (c) 2021-2022 Hal Brodigan (postmodern.mod3 at gmail.com)
+#
+# ronin-core is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published
+# by the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+# 
+# ronin-core 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 Lesser General Public License for more details.
+# 
+# You should have received a copy of the GNU Lesser General Public License
+# along with ronin-core.  If not, see <https://www.gnu.org/licenses/>.
+#
+
+module Ronin
+  module Core
+    module CLI
+      module Printing
+        module OS
+          # Mapping of Operating System (OS) IDs to printable names.
+          OS_NAMES = {
+            unix:  'UNIX',
+
+            bsd:     'BSD',
+            freebsd: 'FreeBSD',
+            openbsd: 'OpenBSD',
+            netbsd:  'NetBSD',
+
+            linux:   'Linux',
+            macos:   'macOS',
+            windows: 'Windows'
+          }
+
+          #
+          # Converts the Operating System (OS) ID to a printable name.
+          #
+          # @param [Symbol] os
+          #   The OS ID.
+          #
+          # @return [String]
+          #   The display name for the OS ID.
+          #
+          def os_name(os)
+            OS_NAMES.fetch(os,&:to_s)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ronin/core/cli/printing/params.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+#
+# Copyright (c) 2021-2022 Hal Brodigan (postmodern.mod3 at gmail.com)
+#
+# ronin-core is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published
+# by the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+# 
+# ronin-core 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 Lesser General Public License for more details.
+# 
+# You should have received a copy of the GNU Lesser General Public License
+# along with ronin-core.  If not, see <https://www.gnu.org/licenses/>.
+#
+
+require 'ronin/core/params/types'
+
+require 'command_kit/printing/tables'
+
+module Ronin
+  module Core
+    module CLI
+      module Printing
+        #
+        # Handles printing {Core::Params::Mixin params} defined on a class.
+        #
+        module Params
+          include CommandKit::Printing::Tables
+
+          # The params table header.
+          PARAM_TABLE_HEADER = %w[Name Type Required Default Description]
+
+          #
+          # Prints the params defined in the given class.
+          #
+          # @param [Class<Core::Params::Mixin>] klass
+          #   The class which contains the params.
+          #
+          def print_params(klass)
+            return if klass.params.empty?
+
+            rows = []
+
+            klass.params.each do |name,param|
+              param_type = param.type.class.name.split('::').last
+              required   = if param.required? then 'Yes'
+                           else                    'No'
+                           end
+              default     = param.default_value
+              description = param.desc
+
+              rows << [name, param_type, required, default, description]
+            end
+
+            puts "Params:"
+            puts
+
+            indent do
+              print_table(rows,header: PARAM_TABLE_HEADER, border: :line)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ronin/core/cli/ruby_shell.rb

@@ -0,0 +1,131 @@
+# frozen_string_literal: true
+#
+# Copyright (c) 2021-2022 Hal Brodigan (postmodern.mod3 at gmail.com)
+#
+# ronin-core is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published
+# by the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+# 
+# ronin-core 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 Lesser General Public License for more details.
+# 
+# You should have received a copy of the GNU Lesser General Public License
+# along with ronin-core.  If not, see <https://www.gnu.org/licenses/>.
+#
+
+require 'command_kit/colors'
+
+require 'irb'
+
+module Ronin
+  module Core
+    module CLI
+      #
+      # Starts a customized Interactive Ruby console.
+      #
+      # @api semipublic
+      #
+      class RubyShell
+
+        include CommandKit::Colors
+
+        # The console name.
+        #
+        # @return [String]
+        attr_reader :name
+
+        # The optional context to spawn the console inside of.
+        #
+        # @return [Object, nil]
+        attr_reader :context
+
+        #
+        # Initializes the console.
+        #
+        # @param [String] name
+        #   The name of the IRB console.
+        #
+        # @param [Object] context
+        #   Custom context to launch IRB from within.
+        #
+        # @param [Hash{Symbol => Object}] kwargs
+        #   Additional keyword arguments for `initialize`.
+        #
+        def initialize(name: 'ronin', context: nil, **kwargs)
+          super(**kwargs)
+
+          @name    = name
+          @context = context
+        end
+
+        #
+        # Starts a customized [irb] console.
+        # [irb]: https://github.com/ruby/irb#readme
+        #
+        # @param [Hash{Symbol => Object}] kwargs
+        #   Additional keyword arguments for {#initialize}.
+        #
+        # @option kwargs [String] :name
+        #   The name of the IRB console.
+        #
+        # @option kwargs [Object] :context
+        #   Custom context to launch IRB from within.
+        #
+        def self.start(**kwargs)
+          new(**kwargs).start
+        end
+
+        #
+        # Configures IRB.
+        #
+        def configure
+          IRB.setup(nil, argv: [])
+          IRB.conf[:IRB_NAME] = @name
+
+          set_prompt
+        end
+
+        #
+        # Starts a customized [irb] console.
+        # [irb]: https://github.com/ruby/irb#readme
+        #
+        def start
+          configure
+
+          workspace = if @context then IRB::WorkSpace.new(@context)
+                      else             IRB::WorkSpace.new
+                      end
+
+          irb = IRB::Irb.new(workspace)
+          irb.run
+        end
+
+        private
+
+        #
+        # Sets the IRB prompts for ronin.
+        #
+        def set_prompt
+          colors(STDOUT).tap do |c|
+            left_paren    = c.bold(c.bright_red('('))
+            right_paren   = c.bold(c.bright_red(')'))
+            prompt_prefix = "#{c.red('irb')}#{left_paren}#{c.red('%N')}#{right_paren}"
+
+            IRB.conf[:PROMPT][:RONIN] = {
+              AUTO_INDENT: true,
+              PROMPT_I: "#{prompt_prefix}#{c.bold(c.bright_red('>'))} ",
+              PROMPT_S: "#{prompt_prefix}%l ",
+              PROMPT_C: "#{prompt_prefix}* ",
+              RETURN:   "=> %s#{$/}"
+            }
+            IRB.conf[:PROMPT_MODE] = :RONIN
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/ronin/core/cli/shell.rb

@@ -0,0 +1,186 @@
+# frozen_string_literal: true
+#
+# Copyright (c) 2021-2022 Hal Brodigan (postmodern.mod3 at gmail.com)
+#
+# ronin-core is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published
+# by the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+# 
+# ronin-core 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 Lesser General Public License for more details.
+# 
+# You should have received a copy of the GNU Lesser General Public License
+# along with ronin-core.  If not, see <https://www.gnu.org/licenses/>.
+#
+
+require 'command_kit/printing'
+require 'command_kit/colors'
+require 'reline'
+
+module Ronin
+  module Core
+    module CLI
+      class Shell
+
+        include CommandKit::Printing
+        include CommandKit::Colors
+
+        #
+        # The default shell prompt name.
+        #
+        # @param [String, nil] new_name
+        #   The optional new shell prompt name to set.
+        #
+        # @return [String]
+        #   The shell prompt name.
+        #
+        def self.shell_name(new_name=nil)
+          if new_name
+            @shell_name = new_name
+          else
+            @shell_name ||= if superclass < Shell
+                              superclass.shell_name
+                            end
+          end
+        end
+
+        #
+        # The default prompt sigil.
+        #
+        # @param [String, nil] new_sigil
+        #   The optional new prompt sigil to use.
+        #
+        # @return [String]
+        #   The prompt sigil.
+        #
+        def self.prompt_sigil(new_sigil=nil)
+          if new_sigil
+            @prompt_sigil = new_sigil
+          else
+            @prompt_sigil ||= if superclass <= Shell
+                              superclass.prompt_sigil
+                              end
+          end
+        end
+
+        prompt_sigil '>'
+
+        #
+        # Starts the shell and processes each line of input.
+        #
+        # @param [Array<Object>] arguments
+        #   Additional arguments for `initialize`.
+        #
+        # @param [Hash{Symbol => Object}] kwargs
+        #   Additional keyword arguments for `initialize`.
+        #
+        # @note
+        #   The shell will exit if `Ctrl^C` or `Ctrl^D` is pressed.
+        #
+        def self.start(*arguments,**kwargs)
+          shell = new(*arguments,**kwargs)
+
+          Reline.completion_proc = shell.method(:complete)
+          use_history = true
+
+          begin
+            loop do
+              line = Reline.readline("#{shell.prompt} ", use_history)
+
+              if line.nil? # Ctrl^D
+                puts
+                break
+              end
+
+              line.chomp!
+
+              unless line.empty?
+                begin
+                  shell.exec(line)
+                rescue SystemExit
+                  break
+                rescue => error
+                  shell.print_exception(error)
+                end
+              end
+            end
+          rescue Interrupt # catch Ctrl^C
+          end
+        end
+
+        #
+        # The partially input being tab completed.
+        #
+        # @param [String] word
+        #   The partial input being tab completed.
+        #
+        # @param [String] preposing
+        #   The optional command name that preceeds the argument that's being
+        #   tab completed.
+        #
+        # @return [Array<String>, nil]
+        #   The possible completion values.
+        #
+        # @abstract
+        #
+        def complete(word,preposing)
+        end
+
+        # The shell's name.
+        #
+        # @return [String, nil]
+        attr_reader :shell_name
+
+        # The prompt sigil character (ex: `>`).
+        #
+        # @return [String]
+        attr_reader :prompt_sigil
+
+        #
+        # Initializes the shell instance.
+        #
+        # @param [String, nil] shell_name
+        #   The optional shell name to override {shell_name}.
+        #
+        # @param [String] prompt_sigil
+        #   The optional prompt sigil to override {prompt_sigil}.
+        #
+        def initialize(shell_name:   self.class.shell_name,
+                       prompt_sigil: self.class.prompt_sigil,
+                       **kwargs)
+          super(**kwargs)
+
+          @shell_name   = shell_name
+          @prompt_sigil = prompt_sigil
+        end
+
+        #
+        # The shell prompt.
+        #
+        # @return [String]
+        #
+        def prompt
+          c = colors(stdout)
+
+          "#{c.red(shell_name)}#{c.bold(c.bright_red(prompt_sigil))}"
+        end
+
+        #
+        # Executes a command.
+        #
+        # @param [String] line
+        #   The command to execute.
+        #
+        # @abstract
+        #
+        def exec(line)
+          raise(NotImplementedError,"#{self.class}##{__method__} was not implemented")
+        end
+
+      end
+    end
+  end
+end

data/lib/ronin/core/git.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+#
+# Copyright (c) 2021-2022 Hal Brodigan (postmodern.mod3 at gmail.com)
+#
+# ronin-core is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published
+# by the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+# 
+# ronin-core 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 Lesser General Public License for more details.
+# 
+# You should have received a copy of the GNU Lesser General Public License
+# along with ronin-core.  If not, see <https://www.gnu.org/licenses/>.
+#
+
+module Ronin
+  module Core
+    #
+    # @api semipublic
+    #
+    module Git
+      #
+      # Queries the git `user.name` variable from `~/.gitconfig`.
+      #
+      # @return [String, nil]
+      #   The value of `user.name` or `nil` if it was not set.
+      #
+      def self.user_name
+        config_value('user.name')
+      end
+
+      #
+      # Queries the git `user.email` variable from `~/.gitconfig`.
+      #
+      # @return [String, nil]
+      #   The value of `user.email` or `nil` if it was not set.
+      #
+      def self.user_email
+        config_value('user.email')
+      end
+
+      #
+      # Queries the git `github.user` variable from `~/.gitconfig`.
+      #
+      # @return [String, nil]
+      #   The value of `github.user` or `nil` if it was not set.
+      #
+      def self.github_user
+        config_value('github.user')
+      end
+
+      #
+      # Queries a git configuration value.
+      #
+      # @param [String] name
+      #   The configuration name.
+      #
+      # @return [string, nil]
+      #   The configuration value or `nil` if nothing was returned.
+      #
+      def self.config_value(name)
+        output = `git config #{name}`.chomp
+
+        if output.empty? then nil
+        else                  output
+        end
+      end
+    end
+  end
+end

data/lib/ronin/core/home.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+#
+# Copyright (c) 2021-2022 Hal Brodigan (postmodern.mod3 at gmail.com)
+#
+# ronin-core is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published
+# by the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+# 
+# ronin-core 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 Lesser General Public License for more details.
+# 
+# You should have received a copy of the GNU Lesser General Public License
+# along with ronin-core.  If not, see <https://www.gnu.org/licenses/>.
+#
+
+module Ronin
+  module Core
+    #
+    # Home directory constants and methods.
+    #
+    # @api semipublic
+    #
+    module Home
+      # Path to the user's home directory.
+      DIR = Gem.user_home
+
+      # Path to the user's `~/.cache/` directory.
+      CACHE_DIR = ENV.fetch('XDG_CACHE_HOME') do
+        File.join(DIR,'.cache')
+      end
+
+      #
+      # Returns the path to the sub-directory within the `~/.cache/` directory.
+      #
+      # @param [String] subdir
+      #   The sub-directory.
+      #
+      # @return [String]
+      #   The path to the `~/.cache/<subdir>` directory.
+      #
+      def self.cache_dir(subdir)
+        File.join(CACHE_DIR,subdir)
+      end
+
+      # Path to the user's `~/.config/` directory.
+      CONFIG_DIR = ENV.fetch('XDG_CONFIG_HOME') do
+        File.join(DIR,'.config')
+      end
+
+      #
+      # Returns the path to the sub-directory within the `~/.config/` directory.
+      #
+      # @param [String] subdir
+      #   The sub-directory.
+      #
+      # @return [String]
+      #   The path to the `~/.config/<subdir>` directory.
+      #
+      def self.config_dir(subdir)
+        File.join(CONFIG_DIR,subdir)
+      end
+
+      # Path to the user's `~/.local/share` directory.
+      LOCAL_SHARE_DIR = ENV.fetch('XDG_DATA_HOME') do
+        File.join(DIR,'.local','share')
+      end
+
+      #
+      # Returns the path to the sub-directory within the `~/.local/share/`
+      # directory.
+      #
+      # @param [String] subdir
+      #   The sub-directory.
+      #
+      # @return [String]
+      #   The path to the `~/.local/share/<subdir>` directory.
+      #
+      def self.local_share_dir(subdir)
+        File.join(LOCAL_SHARE_DIR,subdir)
+      end
+    end
+  end
+end