ronin-repos 0.1.0 → 0.2.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 30c76d7743b473b4df8d834209051aa7643aafade9edcc3e3f12e8b344741e7f
-  data.tar.gz: a4c58c0869e1b44a4c5da6589760f86cf261af3dcfe6478a8cff01efe1bab9c1
+  metadata.gz: b43c676948f9c9db4f57ccea422578e0704a9d7fb1514753b7493fa6e199c27f
+  data.tar.gz: 5fb086f975e9f32d318ecffea62277b925637e7cb1ae5a0489bee86be5fcc052
 SHA512:
-  metadata.gz: 92a8b69b652f962de02fd63b9fbc8e71636c669126e0ab96e769e4aa9894aa70689bc275001e6ddfe214606977618b003daf3de8dfb7966c1feff4e96a910221
-  data.tar.gz: fa460921d3bf47e09714d3fdfeb01d392739ef96366df19f2f6262df1c8df4d37f8eef05bc6f7ac56f0815b76fc8e0c6efd37e23111b788c29db4c3fdc5aa651
+  metadata.gz: 6a91bc01c3266d23b53f27270537fafe9d2c71db686f83e13aac733ac8fc5ee23a18c2c5c4b736ca42297baff252fe376ef5560c9eae1f99c6a41a024213f8ea
+  data.tar.gz: 85450d4e6c41a38b7272d440f95d0fad05bb8cd3bad14e7ded9e10f6348f22d789c86abc562febb6b63bc008669debf497c150d16cccc725f65c331f9de4becc

data/.document

@@ -2,4 +2,3 @@ lib/**/*.rb
 - 
 ChangeLog.md
 COPYING.txt
-man/*.md

data/.github/workflows/ruby.yml

@@ -12,11 +12,12 @@ jobs:
           - '3.0'
           - '3.1'
           - '3.2'
+          - '3.3'
           - jruby
           - truffleruby
     name: Ruby ${{ matrix.ruby }}
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - name: Set up Ruby
         uses: ruby/setup-ruby@v1
         with:
@@ -26,3 +27,17 @@ jobs:
         run: bundle install --jobs 4 --retry 3
       - name: Run tests
         run: bundle exec rake test
+
+  # rubocop linting
+  rubocop:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 3.0
+      - name: Install dependencies
+        run: bundle install --jobs 4 --retry 3
+      - name: Run rubocop
+        run: bundle exec rubocop --parallel

data/.gitignore

@@ -1,4 +1,5 @@
 /coverage
+/data/completions/ronin-repos
 /doc
 /pkg
 /man/*.[1-9]

data/.rubocop.yml

@@ -0,0 +1,21 @@
+AllCops:
+  NewCops: enable
+  SuggestExtensions: false
+  TargetRubyVersion: 3.1
+
+inherit_gem:
+  rubocop-ronin: rubocop.yml
+
+#
+# ronin-repos specific exceptions
+#
+
+Lint/EmptyFile:
+  Exclude:
+    - 'spec/fixtures/class_dir/file1.rb'
+    - 'spec/fixtures/class_dir/file2.rb'
+    - 'spec/fixtures/class_dir/only_in_class_dir.rb'
+
+Style/MapIntoArray:
+  Exclude:
+    - 'spec/cache_dir_spec.rb'

data/ChangeLog.md

@@ -1,4 +1,31 @@
-### 0.1.0 / 2023-XX-XX
+### 0.2.0 / 2024-XX-XX
+
+* Added {Ronin::Repos::Repository#url}.
+* Added {Ronin::Repos::Repository#last_updated_at}.
+* Added {Ronin::Repos.cache_dir}.
+
+#### CLI
+
+* Added the `ronin-repos show` command.
+* Changed `ronin-repos list` to fuzzy match repo names.
+* Changed `ronin-repos new` to also create empty `exploits/`, `payloads/`,
+  `recon/`, and `brute/`.
+* Added the `ronin-repos completion` command to install shell completion files
+  for all `ronin-repos` commands for Bash and Zsh shells.
+
+### 0.1.1 / 2023-06-09
+
+* Fixed a bug in {Ronin::Repos::ClassDir::ClassMethods#list_files} where the
+  {Ronin::Repos::ClassDir::ClassMethods#repo_class_dir repo_class_dir} was not
+  being removed from paths.
+* Documentation fixes and improvements.
+
+#### CLI
+
+* Multiple bug fixes to the `ronin-repos install` command.
+* Add missing man-page for the `ronin-repos new` command.
+
+### 0.1.0 / 2023-02-01
 
 * Initial release:
   * Supports installing any [Git][git] repository.

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 gemspec
@@ -7,10 +9,10 @@ platform :jruby do
 end
 
 # Ronin dependencies:
-# gem 'ronin-core', '~> 0.1', github: "ronin-rb/ronin-core",
+# gem 'ronin-core', '~> 0.2', github: 'ronin-rb/ronin-core',
 #                             branch: 'main'
 
-# gem 'command_kit', '~> 0.4', github: 'postmodern/command_kit.rb',
+# gem 'command_kit', '~> 0.5', github: 'postmodern/command_kit.rb',
 #                              branch: 'main'
 
 group :development do
@@ -20,13 +22,17 @@ group :development do
   gem 'simplecov',       '~> 0.20'
 
   gem 'kramdown',        '~> 2.0'
-  gem 'kramdown-man',    '~> 0.1'
+  gem 'kramdown-man',    '~> 1.0'
 
   gem 'redcarpet',       platform: :mri
   gem 'yard',            '~> 0.9'
   gem 'yard-spellcheck', require: false
 
   gem 'dead_end',        require: false
-  gem 'sord',            require: false, platforms: :mri
-  gem 'stackprof',       require: false, platforms: :mri
+  gem 'sord',            require: false, platform: :mri
+  gem 'stackprof',       require: false, platform: :mri
+  gem 'rubocop',         require: false, platform: :mri
+  gem 'rubocop-ronin',   require: false, platform: :mri
+
+  gem 'command_kit-completion', '~> 0.2', require: false
 end

data/README.md

@@ -9,13 +9,23 @@
 * [Issues](https://github.com/ronin-rb/ronin-repos/issues)
 * [Documentation](https://ronin-rb.dev/docs/ronin-repos/frames)
 * [Discord](https://discord.gg/6WAb3PsVX9) |
-  [Twitter](https://twitter.com/ronin_rb) |
   [Mastodon](https://infosec.exchange/@ronin_rb)
 
 ## Description
 
 ronin-repos provides a repository system for installing, managing, and accessing
-third-party git repositories, which can contain code or other data.
+third-party git repositories, that can contain additional Ruby code or other
+data.
+
+Third-party git repositories can be used to extend parts of Ronin. Other Ronin
+libraries can then list and load additional third-party Ruby classes from
+specific directories within the installed third-party repos:
+
+* `exploits/` - may contain additional exploits for [ronin-exploits].
+* `payloads/` - may contain additional payloads for [ronin-payloads].
+
+**tl;dr** ronin-repos is essentially a decentralized plugin system for Ronin
+using git repos.
 
 ronin-repos is part of the [ronin-rb] project, a toolkit for security research
 and development.
@@ -40,12 +50,14 @@ Arguments:
     [ARGS ...]                       Additional arguments for the command
 
 Commands:
+    completion
     help
     install
     list, ls
     new
     purge
     remove, rm
+    show, info
     update, up
 ```
 
@@ -111,7 +123,7 @@ Rnnin::Repos.glob("wordlists/*.txt")
 ## Requirements
 
 * [Ruby] >= 3.0.0
-* [ronin-core] ~> 0.1
+* [ronin-core] ~> 0.2
 
 ## Install
 
@@ -130,7 +142,7 @@ gem 'ronin-repos', '~> 0.1'
 1. [Fork It!](https://github.com/ronin-rb/ronin-repos/fork)
 2. Clone It!
 3. `cd ronin-repos`
-4. `bundle install`
+4. `./scripts/server`
 5. `git checkout -b my_feature`
 6. Code It!
 7. `bundle exec rake spec`
@@ -138,7 +150,7 @@ gem 'ronin-repos', '~> 0.1'
 
 ## License
 
-Copyright (c) 2021-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
+Copyright (c) 2021-2024 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
@@ -158,3 +170,5 @@ along with ronin-repos.  If not, see <https://www.gnu.org/licenses/>.
 [Ruby]: https://www.ruby-lang.org
 [git]: https://git-scm.com/
 [ronin-core]: https://github.com/ronin-rb/ronin-core#readme
+[ronin-exploits]: https://github.com/ronin-rb/ronin-exploits#readme
+[ronin-payloads]: https://github.com/ronin-rb/ronin-payloads#readme

data/Rakefile

@@ -1,11 +1,11 @@
-require 'rubygems'
+# frozen_string_literal: true
 
 begin
   require 'bundler'
 rescue LoadError => e
   warn e.message
   warn "Run `gem install bundler` to install Bundler"
-  exit -1
+  exit(-1)
 end
 
 begin
@@ -32,3 +32,13 @@ task :docs => :yard
 
 require 'kramdown/man/task'
 Kramdown::Man::Task.new
+
+require 'command_kit/completion/task'
+CommandKit::Completion::Task.new(
+  class_file:  'ronin/repos/cli',
+  class_name:  'Ronin::Repos::CLI',
+  input_file:  'data/completions/ronin-repos.yml',
+  output_file: 'data/completions/ronin-repos'
+)
+
+task :setup => %w[man command_kit:completion]

data/bin/ronin-repos

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 #
 # Copyright (c) 2021-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
@@ -21,13 +22,11 @@
 root = File.expand_path(File.join(__dir__,'..'))
 if File.file?(File.join(root,'Gemfile.lock'))
   Dir.chdir(root) do
-    begin
-      require 'bundler/setup'
-    rescue LoadError => e
-      warn e.message
-      warn "Run `gem install bundler` to install Bundler"
-      exit -1
-    end
+    require 'bundler/setup'
+  rescue LoadError => e
+    warn e.message
+    warn "Run `gem install bundler` to install Bundler"
+    exit(-1)
   end
 end
 

data/data/completions/ronin-repos

@@ -0,0 +1,139 @@
+# ronin-repos completion                                   -*- shell-script -*-
+
+# This bash completions script was generated by
+# completely (https://github.com/dannyben/completely)
+# Modifying it manually is not recommended
+
+_ronin-repos_completions_filter() {
+  local words="$1"
+  local cur=${COMP_WORDS[COMP_CWORD]}
+  local result=()
+
+  if [[ "${cur:0:1}" == "-" ]]; then
+    echo "$words"
+  
+  else
+    for word in $words; do
+      [[ "${word:0:1}" != "-" ]] && result+=("$word")
+    done
+
+    echo "${result[*]}"
+
+  fi
+}
+
+_ronin-repos_completions() {
+  local cur=${COMP_WORDS[COMP_CWORD]}
+  local compwords=("${COMP_WORDS[@]:1:$COMP_CWORD-1}")
+  local compline="${compwords[*]}"
+
+  case "$compline" in
+    'install'*'--cache-dir')
+      while read -r; do COMPREPLY+=( "$REPLY" ); done < <( compgen -A directory -- "$cur" )
+      ;;
+
+    'remove'*'--cache-dir')
+      while read -r; do COMPREPLY+=( "$REPLY" ); done < <( compgen -A directory -- "$cur" )
+      ;;
+
+    'update'*'--cache-dir')
+      while read -r; do COMPREPLY+=( "$REPLY" ); done < <( compgen -A directory -- "$cur" )
+      ;;
+
+    'purge'*'--cache-dir')
+      while read -r; do COMPREPLY+=( "$REPLY" ); done < <( compgen -A directory -- "$cur" )
+      ;;
+
+    'list'*'--cache-dir')
+      while read -r; do COMPREPLY+=( "$REPLY" ); done < <( compgen -A directory -- "$cur" )
+      ;;
+
+    'show'*'--cache-dir')
+      while read -r; do COMPREPLY+=( "$REPLY" ); done < <( compgen -A directory -- "$cur" )
+      ;;
+
+    'new'*'--cache-dir')
+      while read -r; do COMPREPLY+=( "$REPLY" ); done < <( compgen -A directory -- "$cur" )
+      ;;
+
+    'completion'*)
+      while read -r; do COMPREPLY+=( "$REPLY" ); done < <( compgen -W "$(_ronin-repos_completions_filter "--print --install --uninstall")" -- "$cur" )
+      ;;
+
+    'install'*'-C')
+      while read -r; do COMPREPLY+=( "$REPLY" ); done < <( compgen -A directory -- "$cur" )
+      ;;
+
+    'remove'*'-C')
+      while read -r; do COMPREPLY+=( "$REPLY" ); done < <( compgen -A directory -- "$cur" )
+      ;;
+
+    'update'*'-C')
+      while read -r; do COMPREPLY+=( "$REPLY" ); done < <( compgen -A directory -- "$cur" )
+      ;;
+
+    'purge'*'-C')
+      while read -r; do COMPREPLY+=( "$REPLY" ); done < <( compgen -A directory -- "$cur" )
+      ;;
+
+    'install'*)
+      while read -r; do COMPREPLY+=( "$REPLY" ); done < <( compgen -W "$(_ronin-repos_completions_filter "--cache-dir -C")" -- "$cur" )
+      ;;
+
+    'list'*'-C')
+      while read -r; do COMPREPLY+=( "$REPLY" ); done < <( compgen -A directory -- "$cur" )
+      ;;
+
+    'show'*'-C')
+      while read -r; do COMPREPLY+=( "$REPLY" ); done < <( compgen -A directory -- "$cur" )
+      ;;
+
+    'new'*'-C')
+      while read -r; do COMPREPLY+=( "$REPLY" ); done < <( compgen -A directory -- "$cur" )
+      ;;
+
+    'remove'*)
+      while read -r; do COMPREPLY+=( "$REPLY" ); done < <( compgen -W "$(_ronin-repos_completions_filter "--cache-dir -C $(ronin-repos list)")" -- "$cur" )
+      ;;
+
+    'update'*)
+      while read -r; do COMPREPLY+=( "$REPLY" ); done < <( compgen -W "$(_ronin-repos_completions_filter "--cache-dir -C $(ronin-repos list)")" -- "$cur" )
+      ;;
+
+    'purge'*)
+      while read -r; do COMPREPLY+=( "$REPLY" ); done < <( compgen -W "$(_ronin-repos_completions_filter "--cache-dir -C")" -- "$cur" )
+      ;;
+
+    'list'*)
+      while read -r; do COMPREPLY+=( "$REPLY" ); done < <( compgen -W "$(_ronin-repos_completions_filter "--cache-dir -C")" -- "$cur" )
+      ;;
+
+    'show'*)
+      while read -r; do COMPREPLY+=( "$REPLY" ); done < <( compgen -W "$(_ronin-repos_completions_filter "--cache-dir -C $(ronin-repos list)")" -- "$cur" )
+      ;;
+
+    'info'*)
+      while read -r; do COMPREPLY+=( "$REPLY" ); done < <( compgen -W "$(_ronin-repos_completions_filter "$(ronin-repos list)")" -- "$cur" )
+      ;;
+
+    'new'*)
+      while read -r; do COMPREPLY+=( "$REPLY" ); done < <( compgen -W "$(_ronin-repos_completions_filter "--cache-dir -C")" -- "$cur" )
+      ;;
+
+    'rm'*)
+      while read -r; do COMPREPLY+=( "$REPLY" ); done < <( compgen -W "$(_ronin-repos_completions_filter "$(ronin-repos list)")" -- "$cur" )
+      ;;
+
+    'up'*)
+      while read -r; do COMPREPLY+=( "$REPLY" ); done < <( compgen -W "$(_ronin-repos_completions_filter "$(ronin-repos list)")" -- "$cur" )
+      ;;
+
+    *)
+      while read -r; do COMPREPLY+=( "$REPLY" ); done < <( compgen -W "$(_ronin-repos_completions_filter "--version -V help completion install list new purge remove show update ls up rm info")" -- "$cur" )
+      ;;
+
+  esac
+} &&
+complete -F _ronin-repos_completions ronin-repos
+
+# ex: filetype=sh

data/data/completions/ronin-repos.yml

@@ -0,0 +1,10 @@
+---
+ronin-repos remove: &remove
+  - $(ronin-repos list)
+ronin-repos rm: *remove
+ronin-repos show: &show
+  - $(ronin-repos list)
+ronin-repos info: *show
+ronin-repos update: &update
+  - $(ronin-repos list)
+ronin-repos up: *update

data/data/templates/repo/README.md.erb

@@ -5,7 +5,7 @@
 This git repository can be installed by the [ronin-repos] command:
 
 ```shell
-ronin-repos download https://github.com/<%= @github_user %>/<%= @name %>.git
+ronin-repos install https://github.com/<%= @github_user %>/<%= @name %>.git
 ```
 
 [ronin-repos]: https://github.com/ronin-rb/ronin-repos#readme

data/gemspec.yml

@@ -2,7 +2,13 @@ name: ronin-repos
 summary: Third-party git repository support for ronin.
 description:
   ronin-repos provides a repository system for installing, managing, and
-  accessing third-party git repositories, which can contain code or other data.
+  accessing third-party git repositories, that can contain additional Ruby code 
+  or other data. Other Ronin libraries, such as ronin-exploits or
+  ronin-payloads, can then list and load additional third-party Ruby classes
+  from specific directories within the installed third-party reposs.
+
+  ronin-repos is essentially a decentralized plugin system for Ronin using git
+  repos.
 
 license: LGPL-3.0
 authors: Postmodern
@@ -18,11 +24,14 @@ metadata:
   rubygems_mfa_required: 'true'
 
 generated_files:
+ - data/completions/ronin-repos
  - man/ronin-repos.1
+ - man/ronin-repos-completion.1
  - man/ronin-repos-install.1
  - man/ronin-repos-list.1
  - man/ronin-repos-new.1
  - man/ronin-repos-remove.1
+ - man/ronin-repos-show.1
  - man/ronin-repos-update.1
  - man/ronin-repos-purge.1
 
@@ -30,7 +39,7 @@ required_ruby_version: ">= 3.0.0"
 
 dependencies:
   # Library dependencies:
-  ronin-core: ~> 0.1
+  ronin-core: ~> 0.2.0.rc1
 
 development_dependencies:
   bundler: ~> 2.0

data/lib/ronin/repos/cache_dir.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 #
-# Copyright (c) 2021-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2021-2024 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
@@ -34,7 +34,7 @@ module Ronin
 
       include Enumerable
 
-      # The ~/.cache/ronin-repos/ directory where all repos are stored.
+      # The `~/.cache/ronin-repos/` directory where all repos are stored.
       PATH = Core::Home.cache_dir('ronin-repos')
 
       # The path to the cache directory.
@@ -52,7 +52,7 @@ module Ronin
         @path = path
       end
 
-      # 
+      #
       # Accesses a repository from the cache directory.
       #
       # @param [String] name
@@ -129,10 +129,9 @@ module Ronin
       #
       def update
         each do |repo|
-          begin
-            repo.update
-          rescue CommandFailed
-          end
+          repo.update
+        rescue CommandFailed
+          # ignore any `git` errors when updating
         end
       end
 

data/lib/ronin/repos/class_dir.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 #
-# Copyright (c) 2021-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2021-2024 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
@@ -33,12 +33,12 @@ module Ronin
     #
     #     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
@@ -49,11 +49,11 @@ module Ronin
     #     module Ronin
     #       module Exploits
     #         class Exploit
-    #     
+    #
     #           def self.register(name)
     #             Exploits.register(name,self)
     #           end
-    #     
+    #
     #         end
     #       end
     #     end
@@ -61,13 +61,13 @@ module Ronin
     # `~/.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
@@ -88,6 +88,9 @@ module Ronin
         namespace.extend ClassMethods
       end
 
+      #
+      # Class-methods.
+      #
       module ClassMethods
         #
         # Gets or sets the repository module directory name.
@@ -97,7 +100,7 @@ module Ronin
         #
         # @return [String]
         #   The repository module directory name.
-        # 
+        #
         # @raise [NotImplementedError]
         #   The `repo_class_dir` method was not defined in the module.
         #
@@ -117,16 +120,20 @@ module Ronin
         # {#repo_class_dir} across all installed repositories.
         #
         # @return [Array<String>]
-        # 
+        #
         def list_files
-          modules = Set.new(super)
-          pattern = File.join(repo_class_dir,"{**/}*.rb") 
+          paths   = Set.new(super)
+          pattern = File.join(repo_class_dir,"{**/}*.rb")
+
+          # the String#slice range to remove the repo_class_dir/ and .rb ext
+          slice_range = (repo_class_dir.length + 1)...-3
 
           Repos.list_files(pattern).each do |path|
-            modules << path.chomp('.rb')
+            # NOTE: String#slice is faster than .delete_prefix + delete.suffix
+            paths << path.slice(slice_range)
           end
 
-          return modules.to_a
+          return paths.to_a
         end
 
         #

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 #
-# Copyright (c) 2021-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2021-2024 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
@@ -24,6 +24,9 @@ require 'ronin/core/cli/command'
 module Ronin
   module Repos
     class CLI
+      #
+      # Base command for all `ronin-repos` commands.
+      #
       class Command < Core::CLI::Command
 
         man_dir File.join(ROOT,'man')
@@ -39,8 +42,7 @@ module Ronin
                              @cache_dir = CacheDir.new(dir)
                            end
 
-
-        # The ronin-repos cache directory.
+        # The `ronin-repos` cache directory.
         #
         # @return [CacheDir]
         attr_reader :cache_dir