ronin-repos 0.1.0.beta1

data/lib/ronin/repos/cache_dir.rb

@@ -0,0 +1,267 @@
+# frozen_string_literal: true
+#
+# Copyright (c) 2021 Hal Brodigan (postmodern.mod3 at gmail.com)
+#
+# ronin-repos 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-repos 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-repos.  If not, see <https://www.gnu.org/licenses/>.
+#
+
+require 'ronin/repos/exceptions'
+require 'ronin/repos/repository'
+require 'ronin/core/home'
+
+require 'set'
+
+module Ronin
+  module Repos
+    #
+    # Manages the `~/.cache/ronin-repos/` directory and the repositories
+    # contained within.
+    #
+    # @api private
+    #
+    class CacheDir
+
+      include Enumerable
+
+      # The ~/.cache/ronin-repos/ directory where all repos are stored.
+      PATH = Core::Home.cache_dir('ronin-repos')
+
+      # The path to the cache directory.
+      #
+      # @return [String]
+      attr_reader :path
+
+      #
+      # Initializes the repository cache.
+      #
+      # @param [String] path
+      #   The path to the repository cache directory.
+      #
+      def initialize(path=PATH)
+        @path = path
+      end
+
+      # 
+      # Accesses a repository from the cache directory.
+      #
+      # @param [String] name
+      #   The name of the repository.
+      #
+      # @return [Repository]
+      #   The repository from the cache.
+      #
+      # @raise [RepositoryNotFound]
+      #   No repository exists with the given name in the cache directory.
+      #
+      def [](name)
+        path = File.join(@path,name.to_s)
+
+        unless File.directory?(path)
+          raise(RepositoryNotFound,"repository not found: #{name.inspect}")
+        end
+
+        return Repository.new(path)
+      end
+
+      #
+      # Enumerates through every repository in the cache directory.
+      #
+      # @yield [repo]
+      #   The given block will be passed each repository.
+      #
+      # @yieldparam [Repository] repo
+      #   A repository from the cache directory.
+      #
+      # @return [Enumerator]
+      #   If no block is given, an Enumerator will be returned.
+      #
+      def each
+        return enum_for unless block_given?
+
+        each_child_directory do |path|
+          yield Repository.new(path)
+        end
+      end
+
+      #
+      # Clones and installs a repository into the cache directory.
+      #
+      # @param [String, URI::HTTPS] uri
+      #   The URI to clone the repository from.
+      #
+      # @param [String, nil] name
+      #   The explicit name of the repository to use. Defaults to the base-name
+      #   of the URI's path, sans any `.git` extension.
+      #
+      # @return [Repository]
+      #   The newly installed repository.
+      #
+      # @raise [CommandFailed]
+      #   One of the `git` commands failed.
+      #
+      # @raise [CommandNotInstalled]
+      #   The `git` command is not installed.
+      #
+      def install(uri,name=nil)
+        uri    = uri.to_s
+        name ||= File.basename(uri,File.extname(uri))
+        path   = File.join(@path,name)
+
+        return Repository.install(uri,path)
+      end
+
+      #
+      # Updates all repositories in the cache directory.
+      #
+      # @raise [CommandNotInstalled]
+      #   The `git` command is not installed.
+      #
+      def update
+        each do |repo|
+          begin
+            repo.update
+          rescue CommandFailed
+          end
+        end
+      end
+
+      #
+      # Removes a repository from the cache directory.
+      #
+      # @param [String] name
+      #   The repository name to find and delete.
+      #
+      # @raise [RepositoryNotFound]
+      #   The repository with the given name does not exist in the cache
+      #   directory.
+      #
+      def remove(name)
+        self[name].delete
+      end
+
+      #
+      # Deletes all repositories in the cache directory.
+      #
+      def purge
+        each(&:delete)
+      end
+
+      #
+      # Finds the first matching file.
+      #
+      # @param [String] path
+      #   The relative path of the file.
+      #
+      # @return [String, nil]
+      #   The absolute path of the matching file or `nil` if no matching file
+      #   could be found.
+      #
+      # @example
+      #   repos.find_file("wordlists/wordlist.txt")
+      #   # => "/home/user/.cache/ronin-repos/foo-repo/wordlists/wordlist.txt"
+      #
+      def find_file(path)
+        each do |repo|
+          if (file = repo.find_file(path))
+            return file
+          end
+        end
+      end
+
+      #
+      # Finds all files in all repos that matches the glob pattern.
+      #
+      # @param [String] pattern
+      #   The file glob pattern to search for.
+      #
+      # @return [Array<String>]
+      #   The absolute paths to the files that match the glob pattern.
+      #
+      # @example
+      #   repos.glob("wordlists/*.txt")
+      #   # => ["/home/user/.cache/ronin-repos/foo-repo/wordlists/cities.txt",
+      #   #     "/home/user/.cache/ronin-repos/foo-repo/wordlists/states.txt",
+      #   #     "/home/user/.cache/ronin-repos/bar-repo/wordlists/bands.txt",
+      #   #     "/home/user/.cache/ronin-repos/bar-repo/wordlists/beers.txt"]
+      #
+      def glob(pattern,&block)
+        return enum_for(__method__,pattern).to_a unless block_given?
+
+        each do |repo|
+          repo.glob(pattern,&block)
+        end
+      end
+
+      #
+      # Lists all files across all repos installed in the cache directory.
+      #
+      # @param [String] pattern
+      #   The optional glob pattern to use to list specific files.
+      #
+      # @return [Set<String>]
+      #   The matching paths within the repository.
+      #
+      # @example
+      #   repos.list_files('exploits/{**/}*.rb')
+      #   # => #<Set: {"exploits/exploit1.rb", "exploits/exploit2.rb"}>
+      #
+      def list_files(pattern='{**/}*.*')
+        each_with_object(Set.new) do |repo,files|
+          files.merge(repo.list_files(pattern))
+        end
+      end
+
+      #
+      # Converts the cache directory to a String.
+      #
+      # @return [String]
+      #   The path to the cache directory.
+      #
+      def to_s
+        @path
+      end
+
+      private
+
+      #
+      # Enumerates over each directory in the cache directory.
+      #
+      # @yield [dir]
+      #   The given block will be passed each repository's directory path.
+      #
+      # @yieldparam [String] dir
+      #   A path to a repository directory within the cache directory.
+      #
+      # @return [Enumerator]
+      #   If no block is given, an Enumerator will be returned.
+      #
+      def each_child_directory
+        return enum_for(__method__) unless block_given?
+
+        if File.directory?(@path)
+          Dir.children(@path).sort.each do |name|
+            path = File.join(@path,name)
+
+            if File.directory?(path)
+              yield path
+            end
+          end
+        end
+
+        return nil
+      end
+
+    end
+  end
+end

data/lib/ronin/repos/class_dir.rb

@@ -0,0 +1,150 @@
+# frozen_string_literal: true
+#
+# Copyright (c) 2021 Hal Brodigan (postmodern.mod3 at gmail.com)
+#
+# ronin-repos 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-repos 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-repos.  If not, see <https://www.gnu.org/licenses/>.
+#
+
+require 'ronin/repos'
+require 'ronin/core/class_registry'
+
+require 'set'
+
+module Ronin
+  module Repos
+    #
+    # Adds the ability to load classes from directories within installed
+    # repositories.
+    #
+    # ## Example
+    #
+    # `lib/ronin/exploits.rb`:
+    #
+    #     require 'ronin/core/module_registry'
+    #     require 'ronin/repos/class_dir'
+    #     
+    #     module Ronin
+    #       module Exploits
+    #         include Ronin::Core::ClassRegistry
+    #         include Ronin::Repos::ClassDir
+    #     
+    #         class_dir "#{__dir__}/classes"
+    #         repo_class_dir "exploits"
+    #       end
+    #     end
+    #
+    # `lib/ronin/exploits/exploit.rb`:
+    #
+    #     module Ronin
+    #       module Exploits
+    #         class Exploit
+    #     
+    #           def self.register(name)
+    #             Exploits.register(name,self)
+    #           end
+    #     
+    #         end
+    #       end
+    #     end
+    #
+    # `~/.cache/ronin-repos/repo1/exploits/my_exploit.rb`:
+    #
+    #     require 'ronin/exploits/exploit'
+    #     
+    #     module Ronin
+    #       module Exploits
+    #         class MyExploit < Exploit
+    #     
+    #           register 'my_exploit'
+    #     
+    #         end
+    #       end
+    #     end
+    #
+    # @api semipublic
+    #
+    module ClassDir
+      #
+      # Includes `Ronin::Core::ClassRegistry` and adds {ClassMethods}.
+      #
+      # @param [Module] namespace
+      #   The module that is including {ClassDir}.
+      #
+      # @api private
+      #
+      def self.included(namespace)
+        namespace.send :include, Core::ClassRegistry
+        namespace.extend ClassMethods
+      end
+
+      module ClassMethods
+        #
+        # Gets or sets the repository module directory name.
+        #
+        # @param [String, nil] new_dir
+        #   The new module directory path.
+        #
+        # @return [String]
+        #   The repository module directory name.
+        # 
+        # @raise [NotImplementedError]
+        #   The `repo_class_dir` method was not defined in the module.
+        #
+        # @example
+        #   repo_class_dir "exploits"
+        #
+        def repo_class_dir(new_dir=nil)
+          if new_dir
+            @repo_class_dir = new_dir
+          else
+            @repo_class_dir || raise(NotImplementedError,"#{self} did not define a repo_class_dir")
+          end
+        end
+
+        #
+        # List the module names within the `class_dir` and within
+        # {#repo_class_dir} across all installed repositories.
+        #
+        # @return [Array<String>]
+        # 
+        def list_files
+          modules = Set.new(super)
+          pattern = File.join(repo_class_dir,"{**/}*.rb") 
+
+          Repos.list_files(pattern).each do |path|
+            modules << path.chomp('.rb')
+          end
+
+          return modules.to_a
+        end
+
+        #
+        # Finds a module within `class_dir` or within `repo_class_dir`
+        # in one of the installed repositories.
+        #
+        # @param [String] name
+        #   The module name to lookup.
+        #
+        # @return [String, nil]
+        #   The path to the module or `nil` if the module could not be found
+        #   in `class_dir` or any of the installed repositories.
+        #
+        def path_for(name)
+          super(name) ||
+            Repos.find_file(File.join(repo_class_dir,"#{name}.rb"))
+        end
+      end
+    end
+  end
+end

data/lib/ronin/repos/cli/command.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+#
+# Copyright (c) 2021 Hal Brodigan (postmodern.mod3 at gmail.com)
+#
+# ronin-repos 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-repos 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-repos.  If not, see <https://www.gnu.org/licenses/>.
+#
+
+require 'ronin/repos/root'
+require 'ronin/repos/cache_dir'
+
+require 'ronin/core/cli/command'
+
+module Ronin
+  module Repos
+    class CLI
+      class Command < Core::CLI::Command
+
+        man_dir File.join(ROOT,'man')
+
+        bug_report_url 'https://github.com/ronin-rb/ronin-repos/issues/new'
+
+        option :cache_dir, short: '-C',
+                           value: {
+                             type:  String,
+                             usage: 'DIR'
+                           },
+                           desc: 'Overrides the default cache directory' do |dir|
+                             @cache_dir = CacheDir.new(dir)
+                           end
+
+
+        # The ronin-repos cache directory.
+        #
+        # @return [CacheDir]
+        attr_reader :cache_dir
+
+        #
+        # Initializes the command.
+        #
+        # @param [Hash{Symbol => Object}] kwargs
+        #   Additional keyword arguments for `initialize`.
+        #
+        def initialize(**kwargs)
+          super(**kwargs)
+
+          @cache_dir = CacheDir.new
+        end
+
+      end
+    end
+  end
+end

data/lib/ronin/repos/cli/commands/install.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+#
+# Copyright (c) 2021 Hal Brodigan (postmodern.mod3 at gmail.com)
+#
+# ronin-repos 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-repos 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-repos.  If not, see <https://www.gnu.org/licenses/>.
+#
+
+require 'ronin/repos/cli/command'
+
+module Ronin
+  module Repos
+    class CLI
+      module Commands
+        #
+        # Installs a git repository into the cache directory.
+        #
+        # ## Usage
+        #
+        #    ronin-repos install [options] [REPO]
+        #
+        # ## Options
+        #
+        #     -C, --cache-dir DIR              Overrides the default cache directory
+        #     -h, --help                       Print help information
+        #
+        # ## Arguments
+        #
+        #     URI                              URI of the git repository
+        #
+        class Install < Command
+
+          usage '[options] URI'
+
+          argument :uri, required: true,
+                         usage:    'URI',
+                         desc:     'URI of the git repository'
+
+          description 'Installs a git repository into the cache directory'
+
+          man_page 'ronin-repos-install.1'
+
+          #
+          # Runs the `ronin-repos install` command.
+          #
+          # @param [String] uri
+          #   The repository's git URI to install from.
+          #
+          def run(uri)
+            log_info "Installing repository from #{uri} ..."
+            cache_dir.download(uri)
+          rescue CommandFailed => error
+            print_error(error.message)
+            exit(-1)
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/ronin/repos/cli/commands/list.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+#
+# Copyright (c) 2021 Hal Brodigan (postmodern.mod3 at gmail.com)
+#
+# ronin-repos 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-repos 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-repos.  If not, see <https://www.gnu.org/licenses/>.
+#
+
+require 'ronin/repos/cli/command'
+
+module Ronin
+  module Repos
+    class CLI
+      module Commands
+        #
+        # Lists all repositories in the cache directory.
+        #
+        # ## Usage
+        #
+        #     ronin-repos list [options] [REPO]
+        #
+        # ## Options
+        #
+        #     -C, --cache-dir DIR              Overrides the default cache directory
+        #     -h, --help                       Print help information
+        #
+        # ## Arguments
+        #
+        #     [REPO]                           Optional repository name to list
+        #
+        class List < Command
+
+          usage '[options] [REPO]'
+
+          argument :name, required: false,
+                          usage:    'REPO',
+                          desc:     'Optional repository name to list'
+
+          description 'Lists all repositories in the cache directory'
+
+          man_page 'ronin-repos-list.1'
+
+          #
+          # Runs the `ronin-repos list` command.
+          #
+          # @param [String, nil] name
+          #   The optional repo name to list.
+          #
+          def run(name=nil)
+            if name
+              begin
+                repo = cache_dir[name]
+
+                puts "  #{repo}"
+              rescue RepositoryNotFound => error
+                print_error(error.message)
+                exit(-1)
+              end
+            else
+              cache_dir.each do |repo|
+                puts "  #{repo}"
+              end
+            end
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/ronin/repos/cli/commands/new.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+#
+# Copyright (c) 2021 Hal Brodigan (postmodern.mod3 at gmail.com)
+#
+# ronin-repos 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-repos 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-repos.  If not, see <https://www.gnu.org/licenses/>.
+#
+
+require 'ronin/repos/cli/command'
+require 'ronin/repos/root'
+
+require 'ronin/core/cli/generator'
+require 'ronin/core/git'
+
+module Ronin
+  module Repos
+    class CLI
+      module Commands
+        #
+        # Creates a new git repository.
+        #
+        # ## Usage
+        #
+        #     ronin-repos new [options] PATH
+        #
+        # ## Options
+        #
+        #     -C, --cache-dir DIR              Overrides the default cache directory
+        #     -h, --help                       Print help information
+        #
+        # ## Arguments
+        #
+        #     PATH                             The path to the new repository
+        #
+        class New < Command
+
+          include Core::CLI::Generator
+
+          template_dir File.join(ROOT,'data','templates','repo')
+
+          usage '[options] PATH'
+
+          argument :path, desc: 'The path to the new repository'
+
+          description 'Creates a new git repository'
+
+          man_page 'ronin-repos.1'
+
+          #
+          # Runs the `ronin-repos new` command.
+          #
+          # @param [String] path
+          #   The path to the new repo directory to create.
+          #
+          def run(path)
+            @name = File.basename(path)
+            @github_user = Core::Git.github_user || ENV['USER']
+
+            mkdir path
+            erb 'README.md.erb', File.join(path,'README.md')
+
+            Dir.chdir(path) do
+              sh 'git', 'init', '-q', '-b', 'main'
+              sh 'git', 'add', 'README.md'
+              sh 'git', 'commit', '-q', '-m', 'Initial commit.'
+            end
+          end
+
+        end
+      end
+    end
+  end
+end