ronin-repos 0.1.0 → 0.2.0.rc1

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

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+#
+# 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
+# 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/core/cli/completion_command'
+
+module Ronin
+  module Repos
+    class CLI
+      module Commands
+        #
+        # Manages the shell completion rules for `ronin-repos`.
+        #
+        # ## Usage
+        #
+        #     ronin-repos completion [options]
+        #
+        # ## Options
+        #
+        #         --print                      Prints the shell completion file
+        #         --install                    Installs the shell completion file
+        #         --uninstall                  Uninstalls the shell completion file
+        #     -h, --help                       Print help information
+        #
+        # ## Examples
+        #
+        #     ronin-repos completion --print
+        #     ronin-repos completion --install
+        #     ronin-repos completion --uninstall
+        #
+        # @since 0.2.0
+        #
+        class Completion < Core::CLI::CompletionCommand
+
+          completion_file File.join(ROOT,'data','completions','ronin-repos')
+
+          man_dir File.join(ROOT,'man')
+          man_page 'ronin-repos-completion.1'
+
+          description 'Manages the shell completion rules for ronin-repos'
+
+        end
+      end
+    end
+  end
+end

data/lib/ronin/repos/cli/commands/install.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
@@ -18,6 +18,8 @@
 
 require 'ronin/repos/cli/command'
 
+require 'ronin/core/cli/logging'
+
 module Ronin
   module Repos
     class CLI
@@ -40,6 +42,8 @@ module Ronin
         #
         class Install < Command
 
+          include Core::CLI::Logging
+
           usage '[options] URI'
 
           argument :uri, required: true,
@@ -58,8 +62,8 @@ module Ronin
           #
           def run(uri)
             log_info "Installing repository from #{uri} ..."
-            cache_dir.download(uri)
-          rescue CommandFailed => error
+            cache_dir.install(uri)
+          rescue CommandNotInstalled, CommandFailed => error
             print_error(error.message)
             exit(-1)
           end

data/lib/ronin/repos/cli/commands/list.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
@@ -27,7 +27,7 @@ module Ronin
         #
         # ## Usage
         #
-        #     ronin-repos list [options] [REPO]
+        #     ronin-repos list [options] [NAME]
         #
         # ## Options
         #
@@ -36,15 +36,15 @@ module Ronin
         #
         # ## Arguments
         #
-        #     [REPO]                           Optional repository name to list
+        #     [NAME]                           Optional repository name(s) to list
         #
         class List < Command
 
-          usage '[options] [REPO]'
+          usage '[options] [NAME]'
 
           argument :name, required: false,
-                          usage:    'REPO',
-                          desc:     'Optional repository name to list'
+                          usage:    'NAME',
+                          desc:     'Optional repository name(s) to list'
 
           description 'Lists all repositories in the cache directory'
 
@@ -57,19 +57,16 @@ module Ronin
           #   The optional repo name to list.
           #
           def run(name=nil)
-            if name
-              begin
-                repo = cache_dir[name]
+            repos = if name
+                      cache_dir.select do |repo|
+                        repo.name.include?(name)
+                      end
+                    else
+                      cache_dir.each
+                    end
 
-                puts "  #{repo}"
-              rescue RepositoryNotFound => error
-                print_error(error.message)
-                exit(-1)
-              end
-            else
-              cache_dir.each do |repo|
-                puts "  #{repo}"
-              end
+            repos.each do |repo|
+              puts "  #{repo}"
             end
           end
 

data/lib/ronin/repos/cli/commands/new.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
@@ -54,7 +54,7 @@ module Ronin
 
           description 'Creates a new git repository'
 
-          man_page 'ronin-repos.1'
+          man_page 'ronin-repos-new.1'
 
           #
           # Runs the `ronin-repos new` command.
@@ -63,10 +63,14 @@ module Ronin
           #   The path to the new repo directory to create.
           #
           def run(path)
-            @name = File.basename(path)
+            @name        = File.basename(path)
             @github_user = Core::Git.github_user || ENV['USER']
 
             mkdir path
+            mkdir File.join(path,'exploits')
+            mkdir File.join(path,'payloads')
+            mkdir File.join(path,'recon')
+            mkdir File.join(path,'brute')
             erb 'README.md.erb', File.join(path,'README.md')
 
             Dir.chdir(path) do

data/lib/ronin/repos/cli/commands/purge.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
@@ -22,12 +22,27 @@ module Ronin
   module Repos
     class CLI
       module Commands
+        #
+        # The `ronin-repos purge` command.
+        #
+        # ## Usage
+        #
+        #     ronin-repos purge [options]
+        #
+        # ## Options
+        #
+        #     -C, --cache-dir DIR              Overrides the default cache directory
+        #     -h, --help                       Print help information
+        #
         class Purge < Command
 
           description 'Removes all git repository from the cache directory'
 
-          man_page 'ronin-repos-download.1'
+          man_page 'ronin-repos-purge.1'
 
+          #
+          # Runs the `ronin-repos purge` command.
+          #
           def run
             cache_dir.purge
           end

data/lib/ronin/repos/cli/commands/remove.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

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

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+#
+# 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
+# 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 'command_kit/printing/fields'
+require 'command_kit/printing/lists'
+
+module Ronin
+  module Repos
+    class CLI
+      module Commands
+        #
+        # Prints information about a specific repository in the cache directory.
+        #
+        # ## Usage
+        #
+        #     ronin-repos show [options] REPO
+        #
+        # ## Options
+        #
+        #     -C, --cache-dir DIR              Overrides the default cache directory
+        #     -h, --help                       Print help information
+        #
+        # ## Arguments
+        #
+        #     REPO                             The repository to display
+        #
+        # @since 0.2.0
+        #
+        class Show < Command
+
+          include CommandKit::Printing::Fields
+          include CommandKit::Printing::Lists
+
+          usage '[options] [REPO]'
+
+          argument :name, required: true,
+                          usage:    'REPO',
+                          desc:     'The repository to display'
+
+          description 'Prints information about a repository in the cache directory'
+
+          man_page 'ronin-repos-show.1'
+
+          #
+          # Runs the `ronin-repos show` command.
+          #
+          # @param [String] name
+          #   The repo name to display.
+          #
+          def run(name=nil)
+            repo = cache_dir[name]
+
+            puts "[ #{repo} ]"
+            puts
+
+            indent do
+              print_fields(
+                'Name'  => repo.name,
+                'URI'   => repo.url,
+                'Files' => nil
+              )
+
+              indent do
+                print_list(repo.list_files)
+              end
+            end
+          rescue RepositoryNotFound => error
+            print_error(error.message)
+            exit(-1)
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/ronin/repos/cli/commands/update.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
@@ -77,7 +77,7 @@ module Ronin
 
                 begin
                   repo.update
-                rescue CommandFailed => error
+                rescue CommandNotInstalled, CommandFailed => error
                   log_error("failed to update repository #{repo}: #{error.message}")
                 end
               end

data/lib/ronin/repos/cli.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
@@ -41,9 +41,10 @@ module Ronin
       command_name 'ronin-repos'
       version Ronin::Repos::VERSION
 
-      command_aliases['ls'] = 'list'
-      command_aliases['up'] = 'update'
-      command_aliases['rm'] = 'remove'
+      command_aliases['ls']   = 'list'
+      command_aliases['up']   = 'update'
+      command_aliases['rm']   = 'remove'
+      command_aliases['info'] = 'show'
 
     end
   end

data/lib/ronin/repos/exceptions.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
@@ -21,13 +21,13 @@ module Ronin
     class Exception < RuntimeError
     end
 
-    class RepositoryNotFound < Exception
+    class RepositoryNotFound < Repos::Exception
     end
 
-    class CommandNotInstalled < Exception
+    class CommandNotInstalled < Repos::Exception
     end
 
-    class CommandFailed < Exception
+    class CommandFailed < Repos::Exception
     end
   end
 end

data/lib/ronin/repos/repository.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
@@ -19,6 +19,7 @@
 require 'ronin/repos/exceptions'
 
 require 'fileutils'
+require 'time'
 
 module Ronin
   module Repos
@@ -66,7 +67,7 @@ module Ronin
       # Clones a repository.
       #
       # @param [String, URI::HTTPS] uri
-      #   The `https://` or `git@HOST:PATH` SSH URI 
+      #   The `https://` or `git@HOST:PATH` SSH URI
       #
       # @param [String] path
       #   The path to where the repository will be cloned to.
@@ -109,7 +110,7 @@ module Ronin
       # path.
       #
       # @param [String, URI::HTTPS] uri
-      #   The `https://` or `git@HOST:PATH` SSH URI 
+      #   The `https://` or `git@HOST:PATH` SSH URI
       #
       # @param [String] path
       #   The path to where the repository will be cloned to.
@@ -138,6 +139,34 @@ module Ronin
         return repo
       end
 
+      #
+      # The git URL of the repository.
+      #
+      # @return [String]
+      #   The `git:` or `https://` URL for the repository.
+      #
+      # @since 0.2.0
+      #
+      def url
+        Dir.chdir(@path) do
+          `git remote get-url origin`.chomp
+        end
+      end
+
+      #
+      # Determines when the repository was last updated.
+      #
+      # @return [Time]
+      #   The timestamp of the last commit will be returned.
+      #
+      # @since 0.2.0
+      #
+      def last_updated_at
+        Dir.chdir(@path) do
+          Time.parse(`git log --date=iso8601 --pretty="%cd" -1`)
+        end
+      end
+
       #
       # Pulls down new git commits.
       #
@@ -304,7 +333,7 @@ module Ronin
       #
       def glob(pattern,&block)
         path    = join(pattern)
-        matches = Dir.glob(path).sort
+        matches = Dir.glob(path)
 
         if block then matches.each(&block)
         else          matches

data/lib/ronin/repos/root.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

data/lib/ronin/repos/version.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
@@ -19,6 +19,6 @@
 module Ronin
   module Repos
     # ronin-repos version
-    VERSION = '0.1.0'
+    VERSION = '0.2.0.rc1'
   end
 end

data/lib/ronin/repos.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
@@ -25,7 +25,21 @@ module Ronin
   # @api public
   #
   module Repos
-    @@cache_dir = CacheDir.new
+    #
+    # The global repositories cache directory.
+    #
+    # @return [CacheDir]
+    #   The global repositories cache directory (`~/.cache/ronin-repos`).
+    #
+    # @note This method lazy initializes {CacheDir} when first called.
+    #
+    # @api private
+    #
+    # @since 0.2.0
+    #
+    def self.cache_dir
+      @cache_dir ||= CacheDir.new
+    end
 
     #
     # Finds the first matching file.
@@ -42,7 +56,7 @@ module Ronin
     #   # => "/home/user/.cache/ronin-repos/foo-repo/wordlists/wordlist.txt"
     #
     def self.find_file(path)
-      @@cache_dir.find_file(path)
+      cache_dir.find_file(path)
     end
 
     #
@@ -62,7 +76,7 @@ module Ronin
     #   #     "/home/user/.cache/ronin-repos/bar-repo/wordlists/beers.txt"]
     #
     def self.glob(pattern,&block)
-      @@cache_dir.glob(pattern,&block)
+      cache_dir.glob(pattern,&block)
     end
 
     #
@@ -75,7 +89,7 @@ module Ronin
     #   The matching files within all repositories.
     #
     def self.list_files(pattern='{**/}*.*')
-      @@cache_dir.list_files(pattern)
+      cache_dir.list_files(pattern)
     end
   end
 end

data/man/ronin-repos-completion.1

@@ -0,0 +1,76 @@
+.\" Generated by kramdown-man 1.0.1
+.\" https://github.com/postmodern/kramdown-man#readme
+.TH ronin-repos-completion 1 "2024-01-01" Ronin Repos "User Manuals"
+.SH NAME
+.PP
+ronin\-repos\-completion \- Manages shell completion rules for \fBronin\-repos\fR
+.SH SYNOPSIS
+.PP
+\fBronin\-repos completion\fR \[lB]\fIoptions\fP\[rB]
+.SH DESCRIPTION
+.PP
+The \fBronin\-repos completion\fR command can print, install, or uninstall shell
+completion rules for the \fBronin\-repos\fR command\.
+.PP
+Supports installing completion rules for Bash or Zsh shells\.
+Completion rules for the Fish shell is currently not supported\.
+.SS ZSH SUPPORT
+.PP
+Zsh users will have to add the following lines to their \fB\[ti]\[sl]\.zshrc\fR file in
+order to enable Zsh\[cq]s Bash completion compatibility layer:
+.PP
+.RS 4
+.EX
+autoload \-Uz \[pl]X compinit && compinit
+autoload \-Uz \[pl]X bashcompinit && bashcompinit
+.EE
+.RE
+.SH OPTIONS
+.TP
+\fB\-\-print\fR
+Prints the shell completion file\.
+.TP
+\fB\-\-install\fR
+Installs the shell completion file\.
+.TP
+\fB\-\-uninstall\fR
+Uninstalls the shell completion file\.
+.TP
+\fB\-h\fR, \fB\-\-help\fR
+Prints help information\.
+.SH ENVIRONMENT
+.TP
+\fIPREFIX\fP
+Specifies the root prefix for the file system\.
+.TP
+\fIHOME\fP
+Specifies the home directory of the user\. Ronin will search for the
+\fB\[ti]\[sl]\.cache\[sl]ronin\-repos\fR cache directory within the home directory\.
+.TP
+\fIXDG\[ru]DATA\[ru]HOME\fP
+Specifies the data directory to use\. Defaults to \fB\[Do]HOME\[sl]\.local\[sl]share\fR\.
+.SH FILES
+.TP
+\fB\[ti]\[sl]\.local\[sl]share\[sl]bash\-completion\[sl]completions\[sl]\fR
+The user\-local installation directory for Bash completion files\.
+.TP
+\fB\[sl]usr\[sl]local\[sl]share\[sl]bash\-completion\[sl]completions\[sl]\fR
+The system\-wide installation directory for Bash completions files\.
+.TP
+\fB\[sl]usr\[sl]local\[sl]share\[sl]zsh\[sl]site\-functions\[sl]\fR
+The installation directory for Zsh completion files\.
+.SH EXAMPLES
+.TP
+\fBronin\-repos completion \-\-print\fR
+Prints the shell completion rules instead of installing them\.
+.TP
+\fBronin\-repos completion \-\-install\fR
+Installs the shell completion rules for \fBronin\-repos\fR\.
+.TP
+\fBronin\-repos completion \-\-uninstall\fR
+Uninstalls the shell completion rules for \fBronin\-repos\fR\.
+.SH AUTHOR
+.PP
+Postmodern 
+.MT postmodern\.mod3\[at]gmail\.com
+.ME