ronin-wordlists 0.1.0.rc1

data/lib/ronin/wordlists/cli/commands/download.rb

@@ -0,0 +1,109 @@
+# frozen_string_literal: true
+#
+# ronin-wordlists - A library and tool for managing wordlists.
+#
+# Copyright (c) 2023-2024 Hal Brodigan (postmodern.mod3@gmail.com)
+#
+# ronin-wordlists 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-wordlists 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-wordlists.  If not, see <https://www.gnu.org/licenses/>.
+#
+
+require 'ronin/wordlists/cli/command'
+require 'ronin/wordlists/cli/wordlist_dir_option'
+require 'ronin/wordlists/cli/wordlist_index'
+
+require 'ronin/core/cli/logging'
+
+module Ronin
+  module Wordlists
+    class CLI
+      module Commands
+        #
+        # Downloads a wordlist.
+        #
+        # ## Usage
+        #
+        #     ronin-wordlists download [options] {NAME | URL}
+        #
+        # ## Options
+        #
+        #     -d, --wordlist-dir DIR           The wordlist directory
+        #     -h, --help                       Print help information
+        #
+        # ## Arguments
+        #
+        #     NAME | URL                       The wordlist name or URL to download
+        #
+        class Download < Command
+
+          include WordlistDirOption
+          include Core::CLI::Logging
+
+          usage '[options] {NAME | URL}'
+
+          argument :name_or_url, required: true,
+                                 usage: 'NAME | URL',
+                                 desc:  'The wordlist name or URL to download'
+
+          description 'Downloads a wordlist'
+
+          man_page 'ronin-wordlists-download.1'
+
+          #
+          # Runs the `ronin-wordlists download` command.
+          #
+          # @param [String] name_or_url
+          #   The wordlist name or URL to download.
+          #
+          def run(name_or_url)
+            if name_or_url =~ %r{\A(?:git|http|https)://}
+              url = name_or_url
+
+              download(url)
+            else
+              index = WordlistIndex.load
+              name  = name_or_url
+
+              if (entry = index[name])
+                download(entry.url)
+              else
+                print_error "unknown wordlist: #{name}"
+                exit(1)
+              end
+            end
+          end
+
+          #
+          # Downloads a wordlist from the URL.
+          #
+          # @param [String] url
+          #   The URL to download from.
+          #
+          def download(url)
+            log_info "Downloading wordlist #{url} ..."
+
+            begin
+              downloaded_wordlist = wordlist_dir.download(url)
+
+              log_info "Wordlist #{downloaded_wordlist.name} downloaded"
+            rescue DownloadFailed => error
+              log_error error.message
+              exit(2)
+            end
+          end
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+#
+# ronin-wordlists - A library and tool for managing wordlists.
+#
+# Copyright (c) 2023-2024 Hal Brodigan (postmodern.mod3@gmail.com)
+#
+# ronin-wordlists 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-wordlists 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-wordlists.  If not, see <https://www.gnu.org/licenses/>.
+#
+
+require 'ronin/wordlists/cli/command'
+require 'ronin/wordlists/cli/wordlist_dir_option'
+require 'ronin/wordlists'
+
+module Ronin
+  module Wordlists
+    class CLI
+      module Commands
+        #
+        # Lists installed wordlists on the system.
+        #
+        # ## Usage
+        #
+        #     ronin-wordlists list [options] [NAME]
+        #
+        # ## Options
+        #
+        #     -d, --wordlist-dir DIR           The wordlist directory
+        #     -h, --help                       Print help information
+        #
+        # ## Arguments
+        #
+        #     [NAME]                           Optional wordlist name to search for
+        #
+        class List < Command
+
+          include WordlistDirOption
+
+          usage '[options] [NAME]'
+
+          argument :name, required: false,
+                          usage:    'NAME',
+                          desc:     'Optional wordlist name to search for'
+
+          description 'Lists installed wordlists on the system'
+
+          man_page 'ronin-wordlists-list.1'
+
+          #
+          # Runs the `ronin-wordlists list` command.
+          #
+          # @param [String, nil] name
+          #   The optional wordlist name.
+          #
+          def run(name=nil)
+            wordlists = if name then wordlist_dir.list(name)
+                        else         wordlist_dir.list
+                        end
+
+            wordlists.each do |wordlist|
+              puts "  #{wordlist}"
+            end
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/ronin/wordlists/cli/commands/purge.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+#
+# ronin-wordlists - A library and tool for managing wordlists.
+#
+# Copyright (c) 2023-2024 Hal Brodigan (postmodern.mod3@gmail.com)
+#
+# ronin-wordlists 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-wordlists 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-wordlists.  If not, see <https://www.gnu.org/licenses/>.
+#
+
+require 'ronin/wordlists/cli/command'
+require 'ronin/wordlists/cli/wordlist_dir_option'
+
+module Ronin
+  module Wordlists
+    class CLI
+      module Commands
+        #
+        # Purges all cached wordlists.
+        #
+        # ## Usage
+        #
+        #     ronin-wordlists purge [options]
+        #
+        # ## Options
+        #
+        #     -d, --wordlist-dir DIR           The wordlist directory
+        #     -h, --help                       Print help information
+        #
+        class Purge < Command
+
+          include WordlistDirOption
+
+          description 'Purges all downloaded wordlists'
+
+          man_page 'ronin-wordlists-purge.1'
+
+          #
+          # Runs the `ronin-wordlists purge` command.
+          #
+          def run
+            cache_dir = CacheDir.new
+            cache_dir.purge
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/ronin/wordlists/cli/commands/remove.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+#
+# ronin-wordlists - A library and tool for managing wordlists.
+#
+# Copyright (c) 2023-2024 Hal Brodigan (postmodern.mod3@gmail.com)
+#
+# ronin-wordlists 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-wordlists 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-wordlists.  If not, see <https://www.gnu.org/licenses/>.
+#
+
+require 'ronin/wordlists/cli/command'
+require 'ronin/wordlists/cli/wordlist_dir_option'
+
+require 'ronin/core/cli/logging'
+
+module Ronin
+  module Wordlists
+    class CLI
+      module Commands
+        #
+        # Removes a wordlist from the cache directory.
+        #
+        # ## Usage
+        #
+        #     ronin-wordlists remove [options] NAME
+        #
+        # ## Options
+        #
+        #     -d, --wordlist-dir DIR           The wordlist directory
+        #     -h, --help                       Print help information
+        #
+        # ## Arguments
+        #
+        #     NAME                             The wordlist to remove
+        #
+        class Remove < Command
+
+          include WordlistDirOption
+          include Core::CLI::Logging
+
+          usage '[options] NAME'
+
+          argument :name, required: true,
+                          desc:     'The wordlist to remove'
+
+          description 'Deletes a wordlist from the cache directory'
+
+          man_page 'ronin-wordlists-remove.1'
+
+          #
+          # Runs the `ronin-wordlists remove` command.
+          #
+          def run(name)
+            wordlist_dir.remove(name)
+          rescue WordlistNotFound
+            print_error "no such wordlist: #{name}"
+            exit(1)
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/ronin/wordlists/cli/commands/search.rb

@@ -0,0 +1,145 @@
+# frozen_string_literal: true
+#
+# ronin-wordlists - A library and tool for managing wordlists.
+#
+# Copyright (c) 2023-2024 Hal Brodigan (postmodern.mod3@gmail.com)
+#
+# ronin-wordlists 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-wordlists 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-wordlists.  If not, see <https://www.gnu.org/licenses/>.
+#
+
+require 'ronin/wordlists/cli/command'
+require 'ronin/wordlists/cli/wordlist_index'
+
+require 'set'
+
+module Ronin
+  module Wordlists
+    class CLI
+      module Commands
+        #
+        # Lists wordlists available for download or installation.
+        #
+        # ## Usage
+        #
+        #     ronin-wordlists search [options]
+        #
+        # ## Options
+        #
+        #     -c, --category NAME              Filters wordlists by a specific category
+        #     -h, --help                       Print help information
+        #
+        # Arguments:
+        #     [KEYWORD]                        Optional search keyword
+        #
+        class Search < Command
+
+          usage '[options] [KEYWORD]'
+
+          option :category, short: '-c',
+                            value: {
+                              type:  String,
+                              usage: 'NAME'
+                            },
+                            desc: 'Filters wordlists by a specific category' do |category|
+                              @categories << category
+                            end
+
+          argument :keyword, required: false,
+                             desc:     'Optional search keyword'
+
+          description 'Lists wordlists available for download or installation'
+
+          man_page 'ronin-wordlists-search.1'
+
+          # Wordlist categories to filter by.
+          #
+          # @return [Set<String>]
+          attr_reader :categories
+
+          #
+          # Initializes the `ronin-wordlists search` command.
+          #
+          # @param [Hash{Symbol => Object}] kwargs
+          #   Additional keyword arguments for the command.
+          #
+          def initialize(**kwargs)
+            super(**kwargs)
+
+            @categories = Set.new
+          end
+
+          #
+          # Runs the `ronin-wordlists search` command.
+          #
+          # @param [String, nil] keyword
+          #   The optional search keyword.
+          #
+          def run(keyword=nil)
+            search(keyword, categories: @categories).each do |entry|
+              print_entry(entry)
+            end
+          end
+
+          #
+          # Searches for matching entries in the wordlist index file.
+          #
+          # @param [String, nil] keyword
+          #   The optional search keyword.
+          #
+          # @param [Set<String>, nil] categories
+          #   The optional set of categories to filter by.
+          #
+          # @return [Enumerator::Lazy]
+          #   The filtered wordlist index entries.
+          #
+          def search(keyword=nil, categories: Set.new)
+            entries = WordlistIndex.load.lazy
+
+            unless categories.empty?
+              entries = entries.filter do |entry|
+                categories.subset?(entry.categories)
+              end
+            end
+
+            if keyword
+              entries = entries.filter do |entry|
+                entry.name.include?(keyword)      ||
+                  entry.summary.include?(keyword) ||
+                  entry.categories.include?(keyword)
+              end
+            end
+
+            return entries
+          end
+
+          #
+          # Prints an entry from the wordlist index file.
+          #
+          # @param [WordlistIndex::Entry] entry
+          #   An entry from the wordlist index file.
+          #
+          def print_entry(entry)
+            puts "[ #{entry.name} ]"
+            puts
+            puts "  * URL: #{entry.url}"
+            puts "  * Categories: #{entry.categories.join(', ')}"
+            puts "  * Summary: #{entry.summary}"
+            puts
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/ronin/wordlists/cli/commands/update.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+#
+# ronin-wordlists - A library and tool for managing wordlists.
+#
+# Copyright (c) 2023-2024 Hal Brodigan (postmodern.mod3@gmail.com)
+#
+# ronin-wordlists 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-wordlists 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-wordlists.  If not, see <https://www.gnu.org/licenses/>.
+#
+
+require 'ronin/wordlists/cli/command'
+require 'ronin/wordlists/cache_dir'
+
+require 'ronin/core/cli/logging'
+
+module Ronin
+  module Wordlists
+    class CLI
+      module Commands
+        #
+        # Updates a wordlist or all wordlists.
+        #
+        # ## Usage
+        #
+        #     ronin-wordlists update [options] [WORDLISt]
+        #
+        # ## Options
+        #
+        #     -h, --help                       Print help information
+        #
+        # ## Arguments
+        #
+        #     [WORDLIST]                       The optional wordlist to update
+        #
+        class Update < Command
+
+          include Core::CLI::Logging
+
+          usage '[options] [WORDLISt]'
+
+          argument :wordlist, required: false,
+                              desc:     'The optional wordlist to update'
+
+          description 'Updates a wordlist or all wordlists'
+
+          man_page 'ronin-wordlists-update.1'
+
+          #
+          # Runs the `ronin-wordlists update` command.
+          #
+          # @param [String, nil] name
+          #   The optional wordlist name to update.
+          #
+          def run(name=nil)
+            cache_dir = CacheDir.new
+
+            if name
+              begin
+                update(cache_dir[name])
+              rescue WordlistNotFound
+                print_error "no such wordlist: #{name}"
+                exit(1)
+              end
+            else
+              cache_dir.each(&method(:update))
+            end
+          end
+
+          #
+          # Updates a wordlist.
+          #
+          # @param [WordlistFile, WordlistRepo] wordlist
+          #   The wordlist file or git repository to update.
+          #
+          def update(wordlist)
+            log_info "Updating wordlist #{wordlist.name} from #{wordlist.url} ..."
+            begin
+              wordlist.update
+            rescue DownloadFailed => error
+              log_error error.message
+            end
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/ronin/wordlists/cli/wordlist_dir_option.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+#
+# ronin-wordlists - A library and tool for managing wordlists.
+#
+# Copyright (c) 2023-2024 Hal Brodigan (postmodern.mod3@gmail.com)
+#
+# ronin-wordlists 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-wordlists 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-wordlists.  If not, see <https://www.gnu.org/licenses/>.
+#
+
+require 'ronin/wordlists/cache_dir'
+require 'ronin/wordlists/wordlist_dir'
+
+module Ronin
+  module Wordlists
+    class CLI
+      #
+      # Adds the `--wordlist-dir DIR` option to a command.
+      #
+      module WordlistDirOption
+        #
+        # Adds the `--wordlist-dir DIR` option to the command including
+        # {WordlistDirOption}.
+        #
+        # @param [Class<Command>] command
+        #   The command class including {WordlistDirOption}.
+        #
+        def self.included(command)
+          command.option :wordlist_dir, short: '-d',
+                                        value: {
+                                          type: String,
+                                          usage: 'DIR'
+                                        },
+                                        desc: 'The wordlist directory'
+        end
+
+        #
+        # The wordlist directory.
+        #
+        # @return [CacheDir, WordlistDir]
+        #   The {WordlistDir} if the `--wordlist-dir` option was specified or
+        #   {CacheDir}.
+        #
+        def wordlist_dir
+          @wordlist_dir ||= if options[:wordlist_dir]
+                              WordlistDir.new(options[:wordlist_dir])
+                            else
+                              CacheDir.new
+                            end
+        end
+      end
+    end
+  end
+end