ronin-rb / ronin-wordlists Goto Github PK

View Code? Open in Web Editor NEW

[WIP] A library and tool for managing wordlists.

License: GNU Lesser General Public License v3.0

Ruby 100.00%

ronin-wordlists's Introduction

ronin-wordlists

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:

$ 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:

ronin-wordlists download rockyou

Download a wordlist from a URL:

ronin-wordlists download https://example.com/path/to/wordlist.gz

Update all downloaded wordlists:

ronin-wordlists update

Update a specific wordlist:

ronin-wordlists update SecLists

Examples

Open a wordlist by name:

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:

Ronin::Wordlists.download('https://...')

List installed wordlists:

Ronin::Wordlists.list
# =>  #<Set: {"alexa-top-1000.txt", "rockyou.txt", ...}>

Requirements

Ruby >= 3.0.0
wordlist ~> 1.1
ronin-core ~> 0.2

Install

gem install ronin-wordlists

Gemfile

gem 'ronin-wordlists', '~> 0.1'

gemspec

gem.add_dependency 'ronin-wordlists', '~> 0.1'

Development

Fork It!
Clone It!
cd ronin-wordlists/
bundle install
git checkout -b my_feature
Code It!
bundle exec rake spec
git push origin my_feature

License

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/.

ronin-wordlists's People

Contributors

Stargazers

Watchers

ronin-wordlists's Issues

Add more wordlists to `data/wordlists.yml` from awesome-wordlists list

Add more wordlists from the awesome-wordlists curated list.

Add tarraschk/richelieu to `data/wordlists.yml`

Add this repository and it's individual wordlists of common French passwords: https://github.com/tarraschk/richelieu

Import any missing wordlists from `wordlistctl`

wordlistctl contains its own list of known wordlists that it can install. Go through the list and add any wordlists which are missing from data/wordlists.yml.

Add the `ronin-wordlists available` command to replace `ronin-wordlists list --available`

Extract the ronin-wordlists list --available logic into the ronin-wordlists available command.

Add shell completions

Add command_kit-completion for generating the shell completion file.
Add a ronin-wordlists completion command.

Add sublazerwlst wordlist repo to `data/wordlists.yml`

https://github.com/sharsi1/sublazerwlst

Add commonspeak2-wordlists to `data/wordlists.yml`

https://github.com/assetnote/commonspeak2-wordlists

Add `Ronin::Wordlists::Mixin`

Add a mixin module which defines instance methods for the Ronin::Wordlists class-methods.

Add a language attribute to `data/wordlists.yml`

Add a language: attribute to data/wordlists.yml. This will be used to filter available wordlists by language.

Add `categories:` attributes to `data/wordlists.yml`

Annotate the categories that the wordlist belongs to.

Add a `-a,--available` option to the `ronin-wordlists list` command

Add an option for listing the available wordlists in data/wordlists.yml.

Add a `--lang` option to the `ronin-wordlists search` command

Add a --lang option to the ronin-wordlists search command to allow filtering the wordlist index by a specific language.

Update to kramdown-man 1.0.0

Update the kramdown-man dependency to 1.0.0. Also update the man pages to use the new kramdown-man syntax (definition lists for arguments/options definitions and [ronin-foo](ronin-foo.1.md) man page links).

Add a `WordlistIndex` or `IndexFile` class to represent `data/wordlists.yml`

It's kind of a code smell / anti-pattern to directly parse the data/wordlists.yml YAML file in the CLI commands. Instead, there should be a class (ideally part of the private API) which handles parsing and accessing it's contents.

Add a `Ronin::Wordlists::CLI::WordlistOption` mixin

Add a Ronin::Wordlists::CLI::WordlistOption mixin for other libraries, which adds a -W,--wordlist {NAME | PATH} option to the command which includes it.

Allow `WordlistFile.download` to follow redirects

Currently WordlistFile.download does not follow 302 redirects. This prevents it from downloading GitHub release files, such as the rockyou.txt wordlist.

Add missing man pages

Need to add man pages for the commands.

Add tests

Need to add missing RSpec tests.

Add `summary:` attributes to `data/wordlists.yml`

Add summary: attributes with a single sentence describing each wordlist.

Rename `ronin-wordlists available` command to `search`

Rename the available command to search. It should support performing full-text search of the data/wordlists.yml metadata (name, summary, categories).