ronin-wordlists 0.1.0.rc1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 55aa1d06ac34a5ac5bf0a7f414a3432463558bdb678a4dbe679e74b33dc93e40
+  data.tar.gz: 82ce199f4649d16d7382fc0d099fe62f32d6dd3af0e7bde376068a40de7cafb5
+SHA512:
+  metadata.gz: 2377377f8f9e3c53b3a32484134eb18431c73bc06a25840b9b5455f46862de5dc13396cea237b00aff90bd9322c22ccb808523d9b06cc31119ef0ed562f6d79e
+  data.tar.gz: fec942e72678ab0ec0c42a9a58c5953fbd490d1f18ec41c16da51ef2736cb8fb0a59fc6e1c890de2cdbfa518d379ed493c6b7933ba2e818507ca9f2d3fc88ed4

data/.document

@@ -0,0 +1,4 @@
+lib/**/*.rb
+- 
+ChangeLog.md
+COPYING.txt

data/.github/workflows/ruby.yml

@@ -0,0 +1,43 @@
+name: CI
+
+on: [ push, pull_request ]
+
+jobs:
+  tests:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby:
+          - '3.0'
+          - '3.1'
+          - '3.2'
+          - '3.3'
+          - jruby
+          # - truffleruby
+    name: Ruby ${{ matrix.ruby }}
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - name: Install dependencies
+        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

@@ -0,0 +1,14 @@
+/coverage
+/data/completions/ronin-wordlists
+/doc
+/pkg
+/man/*.[1-9]
+/vendor/bundle
+/Gemfile.lock
+/.bundle
+/.yardoc
+.DS_Store
+*.db
+*.log
+*.swp
+*~

data/.rspec

@@ -0,0 +1 @@
+--colour --format documentation

data/.rubocop.yml

@@ -0,0 +1,18 @@
+AllCops:
+  NewCops: enable
+  SuggestExtensions: false
+  TargetRubyVersion: 3.1
+
+inherit_gem:
+  rubocop-ronin: rubocop.yml
+
+#
+# ronin-wordlists specific exceptions
+#
+
+# make an exception for when we need to test the #each method directly
+Style/MapIntoArray:
+  Exclude:
+    - 'spec/cache_dir_spec.rb'
+    - 'spec/search_paths_spec.rb'
+    - 'spec/wordlist_dir_spec.rb'

data/.ruby-version

@@ -0,0 +1 @@
+ruby-3.1

data/.yardopts

@@ -0,0 +1 @@
+--markup markdown --title 'Ronin::Wordlists Documentation' --protected

data/COPYING.txt

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

data/ChangeLog.md

@@ -0,0 +1,10 @@
+### 0.1.0 / 2024-XX-XX
+
+* Initial release:
+  * Installs, updates, and manages wordlist files and Git repositories.
+  * Contains a curated list of popular wordlists and their download URLs.
+  * Allows looking wordlists up by name, instead of explicit path.
+  * Supports searching for wordlists in `/usr/share/wordlists` (Kali Linux),
+    `/usr/local/wordlists`, and `~/.cache/ronin-wordlists/wordlists`
+    directories.
+

data/Gemfile

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+source 'https://rubygems.org'
+
+gemspec
+
+platform :jruby do
+  gem 'jruby-openssl', '~> 0.7'
+end
+
+# gem 'wordlist', '~> 1.1', github: 'postmodern/wordlist.rb'
+
+# Ronin dependencies
+# gem 'ronin-core', '~> 0.2', github: "ronin-rb/ronin-core",
+#                             branch: 'main'
+
+group :development do
+  gem 'rake'
+  gem 'rubygems-tasks',   '~> 0.2'
+
+  gem 'rspec',            '~> 3.0'
+  gem 'simplecov',        '~> 0.20'
+
+  gem 'kramdown',         '~> 2.0'
+  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, 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

@@ -0,0 +1,180 @@
+# ronin-wordlists
+
+[![CI](https://github.com/ronin-rb/ronin-wordlists/actions/workflows/ruby.yml/badge.svg)](https://github.com/ronin-rb/ronin-wordlists/actions/workflows/ruby.yml)
+[![Code Climate](https://codeclimate.com/github/ronin-rb/ronin-wordlists.svg)](https://codeclimate.com/github/ronin-rb/ronin-wordlists)
+
+* [Website](https://ronin-rb.dev/)
+* [Source](https://github.com/ronin-rb/ronin-wordlists)
+* [Issues](https://github.com/ronin-rb/ronin-wordlists/issues)
+* [Documentation](https://ronin-rb.dev/docs/ronin-wordlists/frames)
+* [Discord](https://discord.gg/6WAb3PsVX9) |
+  [Mastodon](https://infosec.exchange/@ronin_rb)
+
+## Description
+
+ronin-wordlists is a library and tool for managing wordlists. ronin-wordlists
+can install and update wordlists, and contains a curated list of popular
+wordlists and their download URLs.
+
+## Features
+
+* Installs, updates, and manages wordlist files and Git repositories.
+* Contains a curated list of popular wordlists and their download URLs.
+* Allows looking wordlists up by name, instead of explicit path.
+* Supports searching for wordlists in `/usr/share/wordlists` (Kali Linux),
+  `/usr/local/wordlists`, and `~/.cache/ronin-wordlists/wordlists` directories.
+
+## Synopsis
+
+```
+$ ronin-wordlists
+Usage: ronin-wordlists [options]
+
+Options:
+    -V, --version                    Prints the version and exits
+    -h, --help                       Print help information
+
+Arguments:
+    [COMMAND]                        The command name to run
+    [ARGS ...]                       Additional arguments for the command
+
+Commands:
+    completion
+    download, install
+    help
+    list, ls
+    purge
+    remove, rm
+    search
+    update, up
+```
+
+List popular wordlists available for download or installation:
+
+```shell
+$ ronin-wordlists search
+[ alexa-top-1000 ]
+
+  * URL: https://github.com/urbanadventurer/WhatWeb/blob/master/plugin-development/alexa-top-1000.txt
+  * Categories: dns, domains
+  * Summary: The Alexa Top 1000 domain names.
+
+[ subdomains ]
+
+  * URL: https://raw.githubusercontent.com/rbsec/dnscan/master/subdomains.txt
+  * Categories: dns, subdomains
+  * Summary: List of common subdomain names used by the dnscan util.
+
+...
+```
+
+Download a known wordlist:
+
+```shell
+ronin-wordlists download rockyou
+```
+
+Download a wordlist from a URL:
+
+```shell
+ronin-wordlists download https://example.com/path/to/wordlist.gz
+```
+
+Update all downloaded wordlists:
+
+```shell
+ronin-wordlists update
+```
+
+Update a specific wordlist:
+
+```shell
+ronin-wordlists update SecLists
+```
+
+## Examples
+
+Open a wordlist by name:
+
+```ruby
+require 'ronin/wordlists'
+
+wordlist = Ronin::Wordlists.open('alexa-top-1000')
+# =>
+# #<Wordlist::File:0x00007f7b548bf840                     
+#  @format=:txt,                                          
+#  @path="/home/ronin/.cache/ronin-wordlists/wordlists/alexa-top-1000.txt">
+
+wordlist.each do |word|
+  # ...
+end
+```
+
+Download a custom wordlist into `~/.cache/ronin-wordlists/wordlists`:
+
+```ruby
+Ronin::Wordlists.download('https://...')
+```
+
+List installed wordlists:
+
+```ruby
+Ronin::Wordlists.list
+# =>  #<Set: {"alexa-top-1000.txt", "rockyou.txt", ...}>
+```
+
+## Requirements
+
+* [Ruby] >= 3.0.0
+* [wordlist] ~> 1.1
+* [ronin-core] ~> 0.2
+
+## Install
+
+```shell
+gem install ronin-wordlists
+```
+
+### Gemfile
+
+```ruby
+gem 'ronin-wordlists', '~> 0.1'
+```
+
+### gemspec
+
+```ruby
+gem.add_dependency 'ronin-wordlists', '~> 0.1'
+```
+
+## Development
+
+1. [Fork It!](https://github.com/ronin-rb/ronin-wordlists/fork)
+2. Clone It!
+3. `cd ronin-wordlists/`
+4. `./scripts/setup`
+5. `git checkout -b my_feature`
+6. Code It!
+7. `bundle exec rake spec`
+8. `git push origin my_feature`
+
+## License
+
+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/>.
+
+[Ruby]: https://www.ruby-lang.org
+[wordlist]: https://github.com/postmodern/wordlist.rb#readme
+[ronin-core]: https://github.com/ronin-rb/ronin-core#readme

data/Rakefile

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+require 'rubygems'
+
+begin
+  require 'bundler'
+rescue LoadError => e
+  warn e.message
+  warn "Run `gem install bundler` to install Bundler"
+  exit(-1)
+end
+
+begin
+  Bundler.setup(:development)
+rescue Bundler::BundlerError => e
+  warn e.message
+  warn "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+
+require 'rake'
+
+require 'rubygems/tasks'
+Gem::Tasks.new(sign: {checksum: true, pgp: true})
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new
+task :test    => :spec
+task :default => :spec
+
+require 'yard'
+YARD::Rake::YardocTask.new
+task :docs => :yard
+
+require 'kramdown/man/task'
+Kramdown::Man::Task.new
+
+require 'command_kit/completion/task'
+CommandKit::Completion::Task.new(
+  class_file:  'ronin/wordlists/cli',
+  class_name:  'Ronin::Wordlists::CLI',
+  input_file:  'data/completions/ronin-wordlists.yml',
+  output_file: 'data/completions/ronin-wordlists'
+)
+
+task :setup => %w[man command_kit:completion]

data/bin/ronin-wordlists

@@ -0,0 +1,34 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+#
+# ronin-wordlists - A library for managing wordlists.
+#
+# Copyright (c) 2023 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/>.
+#
+
+root = File.expand_path(File.join(__dir__,'..'))
+if File.file?(File.join(root,'Gemfile.lock'))
+  Dir.chdir(root) do
+    require 'bundler/setup'
+  rescue LoadError => e
+    warn e.message
+    warn "Run `gem install bundler` to install Bundler"
+    exit(-1)
+  end
+end
+
+require 'ronin/wordlists/cli'
+Ronin::Wordlists::CLI.start

data/data/completions/ronin-wordlists

@@ -0,0 +1,107 @@
+# ronin-wordlists completion                               -*- shell-script -*-
+
+# This bash completions script was generated by
+# completely (https://github.com/dannyben/completely)
+# Modifying it manually is not recommended
+
+_ronin-wordlists_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-wordlists_completions() {
+  local cur=${COMP_WORDS[COMP_CWORD]}
+  local compwords=("${COMP_WORDS[@]:1:$COMP_CWORD-1}")
+  local compline="${compwords[*]}"
+
+  case "$compline" in
+    'download'*'--wordlist-dir')
+      while read -r; do COMPREPLY+=( "$REPLY" ); done < <( compgen -A directory -- "$cur" )
+      ;;
+
+    'remove'*'--wordlist-dir')
+      while read -r; do COMPREPLY+=( "$REPLY" ); done < <( compgen -A directory -- "$cur" )
+      ;;
+
+    'purge'*'--wordlist-dir')
+      while read -r; do COMPREPLY+=( "$REPLY" ); done < <( compgen -A directory -- "$cur" )
+      ;;
+
+    'list'*'--wordlist-dir')
+      while read -r; do COMPREPLY+=( "$REPLY" ); done < <( compgen -A directory -- "$cur" )
+      ;;
+
+    'download'*'-d')
+      while read -r; do COMPREPLY+=( "$REPLY" ); done < <( compgen -A directory -- "$cur" )
+      ;;
+
+    'completion'*)
+      while read -r; do COMPREPLY+=( "$REPLY" ); done < <( compgen -W "$(_ronin-wordlists_completions_filter "--print --install --uninstall")" -- "$cur" )
+      ;;
+
+    'remove'*'-d')
+      while read -r; do COMPREPLY+=( "$REPLY" ); done < <( compgen -A directory -- "$cur" )
+      ;;
+
+    'download'*)
+      while read -r; do COMPREPLY+=( "$REPLY" ); done < <( compgen -W "$(_ronin-wordlists_completions_filter "--wordlist-dir -d")" -- "$cur" )
+      ;;
+
+    'purge'*'-d')
+      while read -r; do COMPREPLY+=( "$REPLY" ); done < <( compgen -A directory -- "$cur" )
+      ;;
+
+    'list'*'-d')
+      while read -r; do COMPREPLY+=( "$REPLY" ); done < <( compgen -A directory -- "$cur" )
+      ;;
+
+    'remove'*)
+      while read -r; do COMPREPLY+=( "$REPLY" ); done < <( compgen -W "$(_ronin-wordlists_completions_filter "--wordlist-dir -d $(ronin-wordlists list)")" -- "$cur" )
+      ;;
+
+    'search'*)
+      while read -r; do COMPREPLY+=( "$REPLY" ); done < <( compgen -W "$(_ronin-wordlists_completions_filter "--category -c")" -- "$cur" )
+      ;;
+
+    'update'*)
+      while read -r; do COMPREPLY+=( "$REPLY" ); done < <( compgen -W "$(_ronin-wordlists_completions_filter "$(ronin-wordlists list)")" -- "$cur" )
+      ;;
+
+    'purge'*)
+      while read -r; do COMPREPLY+=( "$REPLY" ); done < <( compgen -W "$(_ronin-wordlists_completions_filter "--wordlist-dir -d")" -- "$cur" )
+      ;;
+
+    'list'*)
+      while read -r; do COMPREPLY+=( "$REPLY" ); done < <( compgen -W "$(_ronin-wordlists_completions_filter "--wordlist-dir -d")" -- "$cur" )
+      ;;
+
+    'rm'*)
+      while read -r; do COMPREPLY+=( "$REPLY" ); done < <( compgen -W "$(_ronin-wordlists_completions_filter "$(ronin-wordlists list)")" -- "$cur" )
+      ;;
+
+    'up'*)
+      while read -r; do COMPREPLY+=( "$REPLY" ); done < <( compgen -W "$(_ronin-wordlists_completions_filter "$(ronin-wordlists list)")" -- "$cur" )
+      ;;
+
+    *)
+      while read -r; do COMPREPLY+=( "$REPLY" ); done < <( compgen -W "$(_ronin-wordlists_completions_filter "--version -V help completion download list purge remove search update install ls up rm")" -- "$cur" )
+      ;;
+
+  esac
+} &&
+complete -F _ronin-wordlists_completions ronin-wordlists
+
+# ex: filetype=sh