ronin-core 0.1.0.beta1

data/lib/ronin/core/cli/generator/options/summary.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 Generator
+        module Options
+          #
+          # Adds the `-S,--summary TEXT` option to the generator command.
+          #
+          module Summary
+            #
+            # Defines the `-S,--summary TEXT` option.
+            #
+            # @param [Class<Comand>] command
+            #   The command class including {Summary}.
+            #
+            def self.included(command)
+              command.option :summary, short: '-S',
+                                       value: {
+                                         type: String,
+                                         usage: 'TEXT'
+                                       },
+                                       desc: 'One sentence summary' do |text|
+                                         @summary = text
+                                       end
+            end
+
+            # The summary text to output.
+            #
+            # @return [String, nil]
+            attr_reader :summary
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,238 @@
+# 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/cli/command'
+
+require 'command_kit/colors'
+require 'fileutils'
+require 'erb'
+
+module Ronin
+  module Core
+    module CLI
+      #
+      # Adds generator methods to a command.
+      #
+      # ## Example
+      #
+      #   class Gen < Command
+      #   
+      #     include Core::Generator
+      #   
+      #     template_dir File.join(ROOT,'data','templates')
+      #   
+      #     argument :path, desc: 'The path of the script to genereate'
+      #   
+      #     def run(path)
+      #       erb 'script.rb.erb', path
+      #     end
+      #   
+      #   end
+      #
+      module Generator
+        include CommandKit::Colors
+
+        #
+        # Adds {ClassMethods} to the class.
+        #
+        # @param [Class] command
+        #   The command class which is including {Generator}.
+        #
+        # @api private
+        #
+        def self.included(command)
+          command.extend ClassMethods
+        end
+
+        module ClassMethods
+          #
+          # Gets or sets the template directory.
+          #
+          # @param [String, nil] path
+          #   If a path is given, the template directory will be set.
+          #
+          # @return [String]
+          #   The set template directory.
+          #
+          # @raise [NotImplementedError]
+          #   The class did not set {template_dir}.
+          #
+          # @example
+          #   template_dir File.join(__dir__,'..','..','..','..','data','templates','thing')
+          #
+          def template_dir(path=nil)
+            if path
+              @template_dir = File.expand_path(path)
+            else
+              @template_dir || (superclass.template_dir if superclass.kind_of?(ClassMethods))
+            end
+          end
+        end
+
+        # The directory to read files from.
+        #
+        # @return [String]
+        attr_reader :template_dir
+
+        #
+        # Initializes the command.
+        #
+        # @param [Hash{Symbol => Object}] kwargs
+        #   Additional keyword arguments for `initialize`.
+        #
+        # @raise [NotImplementedError]
+        #   The class did not set the {template_dir} path.
+        #
+        def initialize(**kwargs)
+          super(**kwargs)
+
+          unless (@template_dir = self.class.template_dir)
+            raise(NotImplementedError,"#{self.class} did not define template_dir")
+          end
+        end
+
+        #
+        # Prints an generator action to STDOUT.
+        #
+        # @param [Symbol] command
+        #   The command that represents the generator action.
+        #
+        # @param [String] source
+        #   The optional source file being copied or rendered.
+        #
+        # @param [String] dest
+        #   The file or directory path being created or modified.
+        #
+        def print_action(command,source=nil,dest)
+          line = String.new
+          line << "\t" << colors.bold(colors.green(command))
+          line << "\t" << colors.green(source) if source
+          line << "\t" << colors.green(dest)   if dest
+
+          puts(line)
+        end
+
+        #
+        # Creates an empty directory.
+        #
+        # @param [String] path
+        #   The relative path of the directory to be created.
+        #
+        def mkdir(path)
+          print_action 'mkdir', path
+          FileUtils.mkdir_p(path)
+        end
+
+        #
+        # Creates an empty file.
+        #
+        # @param [String] path
+        #   The relative path of the empty file to be created.
+        #
+        def touch(path)
+          print_action 'touch', path
+          FileUtils.touch(path)
+        end
+
+        #
+        # Changes the permissions of a file or directory.
+        #
+        # @param [String, Integer] mode
+        #   The chmod String (ex: `"+x"`) or octal mask.
+        #
+        # @param [String] path
+        #   The path to the file or directory.
+        #
+        def chmod(mode,path)
+          print_action "chmod", path
+          FileUtils.chmod(mode,path)
+        end
+
+        #
+        # Copies a file in.
+        #
+        # @param [String] source
+        #   The file within the {template_dir} to copy in.
+        #
+        # @param [String] dest
+        #   The destination path to copy the file to.
+        #
+        def cp(source,dest)
+          print_action 'cp', source, dest
+
+          FileUtils.cp(File.join(@template_dir,source),dest)
+        end
+
+        #
+        # Copies a directory in.
+        #
+        # @param [String] source
+        #   The relative path to the directory within the {template_dir}.
+        #
+        # @param [String] dest
+        #   The destination path to copy the directory to.
+        #
+        def cp_r(source,dest)
+          print_action "cp -r", source, dest
+
+          FileUtils.cp_r(File.join(@template_dir,source),dest)
+        end
+
+        #
+        # Renders a file using an `.erb` template in the {template_dir}.
+        #
+        # @param [String] source
+        #   The relative path to the file. The `.erb` template will be derived
+        #   from the file path by appending the `.erb` file extension.
+        #
+        # @param [String, nil] dest
+        #   The destination path to write the rendered file to.
+        #   If no destination path is given, the result of the rendered `.erb`
+        #   template will be returned.
+        #
+        def erb(source,dest=nil)
+          if dest
+            print_action 'erb', source, dest
+          end
+
+          source_path = File.join(@template_dir,source)
+
+          return super(source_path,dest)
+        end
+
+        #
+        # Runs a command.
+        #
+        # @param [String] command
+        #   The command name to execute.
+        #
+        # @param [Array<String>] arguments
+        #   Additional arguments for the command.
+        #
+        # @return [Boolean, nil]
+        #   Indicates whether the command successfully executed or not.
+        #
+        def sh(command,*arguments)
+          print_action "run", [command, *arguments].join(' ')
+
+          system(command,*arguments)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,59 @@
+# 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'
+
+module Ronin
+  module Core
+    module CLI
+      module Logging
+        include CommandKit::Colors
+
+        #
+        # Prints an info message to STDOUT.
+        #
+        # @param [String] message
+        #   The message to print.
+        #
+        def log_info(message)
+          puts("#{colors.bold(colors.bright_green('>>>'))} #{colors.bold(colors.white(message))}")
+        end
+
+        #
+        # Prints a warning message to STDOUT.
+        #
+        # @param [String] message
+        #   The message to print.
+        #
+        def log_warn(message)
+          puts("#{colors.bold(colors.bright_yellow('***'))} #{colors.bold(colors.white(message))}")
+        end
+
+        #
+        # Prints an error message to STDERR.
+        #
+        # @param [String] message
+        #   The message to print.
+        #
+        def log_error(message)
+          stderr.puts("#{colors(stderr).bold(colors(stderr).bright_red('!!!'))} #{colors(stderr).bold(colors(stderr).white(message))}")
+        end
+      end
+    end
+  end
+end

data/lib/ronin/core/cli/options/param.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+#
+# Copyright (c) 2021-2022 Hal Brodigan (postmodern.mod3 at gmail.com)
+#
+# This file is part of ronin-core.
+#
+# 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 Options
+        #
+        # Adds a `-p,--param NAME=VALUE` option for setting param values.
+        #
+        module Param
+          #
+          # Adds a `-p,--param NAME=VALUE` option to the command.
+          #
+          # @param [Class<Command>] command
+          #   The command including {Param}.
+          #
+          def self.included(command)
+            command.option :param, short: '-p',
+                                   value: {
+                                     type: /\A[^=]+=.+\z/,
+                                     usage: 'NAME=VALUE',
+                                   },
+                                   desc: 'Sets a param' do |str|
+                                     name, value = str.split('=',2)
+
+                                     @params[name.to_sym] = value
+                                   end
+          end
+
+          # The set params.
+          #
+          # @return [Hash{Symbol => String}]
+          attr_reader :params
+
+          #
+          # Initializes the command and {#params}.
+          #
+          # @param [Hash{Symbol => Object}] kwargs
+          #   Additional keyword arguments.
+          #
+          def initialize(**kwargs)
+            super(**kwargs)
+
+            @params = {}
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ronin/core/cli/options/values/arches.rb

@@ -0,0 +1,45 @@
+# 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 Options
+        module Values
+          # Supported architecture names and their Symbol equivalents
+          ARCHES = {
+            'x86'      => :x86,
+            'x86-64'   => :x86_64,
+            'amd64'    => :x86_64,
+            'ia64'     => :ia64,
+            'ppc'      => :ppc,
+            'ppc64'    => :ppc64,
+            'arm'      => :arm,
+            'armbe'    => :arm_be,
+            'arm64'    => :arm64,
+            'arm64be'  => :arm64_be,
+            'mips'     => :mips,
+            'mipsle'   => :mips_le,
+            'mips64'   => :mips64,
+            'mips64le' => :mips64_le
+          }
+        end
+      end
+    end
+  end
+end

data/lib/ronin/core/cli/options/values/oses.rb

@@ -0,0 +1,32 @@
+# 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 Options
+        module Values
+          # Supported Operating Systems (OS)
+          OSES = [
+            :linux, :macos, :windows, :freebsd, :openbsd, :netbsd
+          ]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,71 @@
+# 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
+        #
+        # Command methods for printing arch IDs.
+        #
+        module Arch
+          # Mapping of architecture IDs to printable names.
+          ARCH_NAMES = {
+            x86: 'x86',
+
+            x86_64: 'x86-64',
+            ia64:   'IA64',
+            amd64:  'x86-64',
+
+            ppc:   'PPC',
+            ppc64: 'PPC64',
+
+            mips:    'MIPS',
+            mips_le: 'MIPS (LE)',
+            mips_be: 'MIPS',
+
+            mips64:    'MIPS64',
+            mips64_le: 'MIPS64 (LE)',
+            mips64_be: 'MIPS64',
+
+            arm:      'ARM',
+            arm_le:   'ARM',
+            arm_be:   'ARM (BE)',
+
+            arm64:    'ARM64',
+            arm64_le: 'ARM64',
+            arm64_be: 'ARM64 (BE)'
+          }
+
+          #
+          # Converts the architecture ID to a printable name.
+          #
+          # @param [Symbol] arch
+          #   The arch ID.
+          #
+          # @return [String]
+          #   The arch display name.
+          #
+          def arch_name(arch)
+            ARCH_NAMES.fetch(arch,&:to_s)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,113 @@
+# 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/options/verbose'
+require 'command_kit/printing/indent'
+require 'command_kit/printing/lists'
+
+module Ronin
+  module Core
+    module CLI
+      module Printing
+        #
+        # Common methods for printing {Core::Metadata} data.
+        #
+        module Metadata
+          include CommandKit::Printing::Indent
+          include CommandKit::Printing::Lists
+
+          #
+          # Addss a `-v,--verbose` option to the command class.
+          #
+          # @param [Class<Command>] command
+          #   The command class including {Metadata}.
+          #
+          def self.included(command)
+            command.include CommandKit::Options::Verbose
+          end
+
+          #
+          # The class which defines the authors.
+          #
+          # @param [Class<Core::Metadata::Authors>] klass
+          #
+          def print_authors(klass)
+            unless klass.authors.empty?
+              puts "Authors:"
+              puts
+
+              if verbose?
+                indent do
+                  klass.authors.each do |author|
+                    puts "* #{author}"
+                    puts "  * PGP: #{author.pgp}"             if author.pgp?
+                    puts "  * Website: #{author.website}"     if author.website?
+                    puts "  * Blog: #{author.blog}"           if author.blog?
+                    puts "  * GitHub: #{author.github_url}"   if author.github?
+                    puts "  * GitLab: #{author.gitlab_url}"   if author.gitlab?
+                    puts "  * Twitter: #{author.twitter_url}" if author.twitter?
+                    puts "  * Discord: #{author.discord}"     if author.discord?
+                  end
+                end
+              else
+                indent { print_list(klass.authors) }
+              end
+
+              puts
+            end
+          end
+
+          #
+          # The class which defines a description.
+          #
+          # @param [Class<Core::Metadata::Description>] klass
+          #
+          def print_description(klass)
+            if klass.description
+              puts 'Description:'
+              puts
+
+              indent do
+                klass.description.each_line do |line|
+                  puts line
+                end
+              end
+
+              puts
+            end
+          end
+
+          #
+          # The class that defines references.
+          #
+          # @param [Class<Core::Metadata::References>] klass
+          #
+          def print_references(klass)
+            unless klass.references.empty?
+              puts "References:"
+              puts
+
+              indent { print_list(klass.references) }
+              puts
+            end
+          end
+        end
+      end
+    end
+  end
+end