ronin-fuzzer 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b75ddebfc52f82912471833f168b9e8813af985b9443cb1c6b88a27b1c730a3b
-  data.tar.gz: 7a0454d2ece994db0151eb7ed1df4ce0edf6ab2e05d48d12f13621930d66cd8d
+  metadata.gz: 0a103561af484214e0b8ab02e4da324be41eda5ebdb2eeee4d6b262125b23d19
+  data.tar.gz: a6db4705f1dff34a3539615feee23e5924a32136c2d0fe1b0af26c5f8dc2732f
 SHA512:
-  metadata.gz: 508b1ede3b5ec7e9be7d1a9bccfab1add955ce60f028559d444613f6e485195ef52f95f293acab505a9493222b2ba31337901df3038a8bd2fee0a3b8668c8a43
-  data.tar.gz: 65fdbda74f4b756e3378e1fbdc5ac533612a6aad873eff7b8b17bc0a0f1a94726bdb15525668f974f18b2a5d50feb2853077d8a8ba00040c64ed88b5a3352a3f
+  metadata.gz: 2da48ce9d52caa355992e4acaa196dbfe2b9d7f90dff7371939c154f884779f0fe612a4180faa92fcc6dc2d9a06f08093cd8efbf2ec81e53d6d37ef6a7e5f65a
+  data.tar.gz: b74295333b7749c2a7cfcde845ebcf3f19383e06a8aefe04337cd3a2761f2cf961120e980ad9b58ad26ab89716e03fd798fe658fb40d5052bffae1331e5e9d2f

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:

data/.gitignore

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

data/.ruby-version

@@ -1 +1 @@
-ruby-3.1
+ruby-3.3

data/ChangeLog.md

@@ -1,4 +1,11 @@
-### 0.1.0 / 2023-XX-XX
+### 0.2.0 / 2024-07-22
+
+#### CLI
+
+* Added the `ronin-fuzzer completion` command to install shell completion files
+  for all `ronin-fuzzer` commands for Bash and Zsh shells.
+
+### 0.1.0 / 2023-02-01
 
 * Initial release:
   * Require `ruby` >= 3.0.0.

data/Gemfile

@@ -16,7 +16,7 @@ end
 # Ronin dependencies
 # gem 'ronin-support',  '~> 1.0', github: "ronin-rb/ronin-support",
 #                                 branch: 'main'
-# gem 'ronin-core',     '~> 0.1', github: "ronin-rb/ronin-core",
+# gem 'ronin-core',     '~> 0.2', github: "ronin-rb/ronin-core",
 #                                 branch: 'main'
 
 group :development do
@@ -28,7 +28,7 @@ group :development do
 
   gem 'kramdown',        '~> 2.0'
   gem 'redcarpet',       platform: :mri
-  gem 'kramdown-man',    '~> 0.1'
+  gem 'kramdown-man',    '~> 1.0'
 
   gem 'yard',            '~> 0.9'
   gem 'yard-spellcheck', require: false
@@ -36,4 +36,6 @@ group :development do
   gem 'dead_end',        require: false
   gem 'sord',            require: false, platform: :mri
   gem 'stackprof',       require: false, platform: :mri
+
+  gem 'command_kit-completion', '~> 0.2', require: false
 end

data/README.md

@@ -9,7 +9,6 @@
 * [Issues](https://github.com/ronin-rb/ronin-fuzzer/issues)
 * [Documentation](https://ronin-rb.dev/docs/ronin-fuzzer/frames)
 * [Discord](https://discord.gg/6WAb3PsVX9) |
-  [Twitter](https://twitter.com/ronin_rb) |
   [Mastodon](https://infosec.exchange/@ronin_rb)
 
 ## Description
@@ -33,12 +32,26 @@ Fuzzes an input file and generates output bad files for testing:
 $ ronin-fuzzer fuzz -i http_request.txt -o bad.txt -r unix_path:bad_strings
 ```
 
+## Examples
+
+Replace every `e`, `i`, `o`, `u` with `(`, 100 `A`s and a `\0`:
+
+```ruby
+require 'ronin/fuzzing'
+
+"the quick brown fox".fuzz(/[eiou]/ => ['(', ('A' * 100), "\0"]) do |str|
+  p str
+end
+```
+
+For more examples, please see the [API documentation](https://ronin-rb.dev/docs/ronin-fuzzer/String.html).
+
 ## Requirements
 
 * [Ruby] >= 3.0.0
 * [combinatorics] ~> 0.4
 * [ronin-support] ~> 1.0
-* [ronin-core] ~> 0.1
+* [ronin-core] ~> 0.2
 
 ## Install
 
@@ -63,7 +76,7 @@ gem.add_dependency 'ronin-fuzzer', '~> 0.1'
 1. [Fork It!](https://github.com/ronin-rb/ronin-fuzzer/fork)
 2. Clone It!
 3. `cd ronin-fuzzer/`
-4. `bundle install`
+4. `./scripts/setup`
 5. `git checkout -b my_feature`
 6. Code It!
 7. `bundle exec rake spec`
@@ -71,7 +84,7 @@ gem.add_dependency 'ronin-fuzzer', '~> 0.1'
 
 ## License
 
-Copyright (c) 2006-2023 Hal Brodigan (postmodern.mod3@gmail.com)
+Copyright (c) 2006-2024 Hal Brodigan (postmodern.mod3@gmail.com)
 
 This file is part of ronin-fuzzer.
 

data/Rakefile

@@ -32,3 +32,12 @@ task :docs => :yard
 
 require 'kramdown/man/task'
 Kramdown::Man::Task.new
+
+require 'command_kit/completion/task'
+CommandKit::Completion::Task.new(
+  class_file:  'ronin/fuzzer/cli',
+  class_name:  'Ronin::Fuzzer::CLI',
+  output_file: 'data/completions/ronin-fuzzer'
+)
+
+task :setup => %w[man command_kit:completion]

data/data/completions/ronin-fuzzer

@@ -0,0 +1,55 @@
+# ronin-fuzzer completion                                  -*- shell-script -*-
+
+# This bash completions script was generated by
+# completely (https://github.com/dannyben/completely)
+# Modifying it manually is not recommended
+
+_ronin-fuzzer_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-fuzzer_completions() {
+  local cur=${COMP_WORDS[COMP_CWORD]}
+  local compwords=("${COMP_WORDS[@]:1:$COMP_CWORD-1}")
+  local compline="${compwords[*]}"
+
+  case "$compline" in
+    'fuzz'*'--input')
+      while read -r; do COMPREPLY+=("$REPLY"); done < <(compgen -A file -- "$cur")
+      ;;
+
+    'completion'*)
+      while read -r; do COMPREPLY+=("$REPLY"); done < <(compgen -W "$(_ronin-fuzzer_completions_filter "--print --install --uninstall")" -- "$cur")
+      ;;
+
+    'fuzz'*'-i')
+      while read -r; do COMPREPLY+=("$REPLY"); done < <(compgen -A file -- "$cur")
+      ;;
+
+    'fuzz'*)
+      while read -r; do COMPREPLY+=("$REPLY"); done < <(compgen -W "$(_ronin-fuzzer_completions_filter "--input -i --rules -r --output -o --command -c --tcp -t --udp -u --pause -p")" -- "$cur")
+      ;;
+
+    *)
+      while read -r; do COMPREPLY+=("$REPLY"); done < <(compgen -W "$(_ronin-fuzzer_completions_filter "--version -V help completion fuzz")" -- "$cur")
+      ;;
+
+  esac
+} &&
+  complete -F _ronin-fuzzer_completions ronin-fuzzer
+
+# ex: filetype=sh

data/gemspec.yml

@@ -18,6 +18,8 @@ metadata:
   rubygems_mfa_required: 'true'
 
 generated_files:
+ - data/completions/ronin-fuzzer
+ - man/ronin-fuzzer-completion.1
  - man/ronin-fuzzer-fuzz.1
 
 required_ruby_version: ">= 3.0.0"
@@ -26,7 +28,7 @@ dependencies:
   combinatorics: ~> 0.4
   # Ronin dependencies:
   ronin-support: ~> 1.0
-  ronin-core: ~> 0.1
+  ronin-core: ~> 0.2
 
 development_dependencies:
   bundler: ~> 2.0

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

@@ -1,7 +1,7 @@
 #
 # ronin-fuzzer - A Ruby library for generating, mutating, and fuzzing data.
 #
-# Copyright (c) 2006-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2006-2024 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
 # This file is part of ronin-fuzzer.
 #

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

@@ -0,0 +1,64 @@
+#
+# ronin-fuzzer - A Ruby library for generating, mutating, and fuzzing data.
+#
+# Copyright (c) 2006-2024 Hal Brodigan (postmodern.mod3 at gmail.com)
+#
+# This file is part of ronin-fuzzer.
+#
+# ronin-fuzzer 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-fuzzer 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-fuzzer.  If not, see <https://www.gnu.org/licenses/>.
+#
+
+require 'ronin/fuzzer/root'
+require 'ronin/core/cli/completion_command'
+
+module Ronin
+  module Fuzzer
+    class CLI
+      module Commands
+        #
+        # Manages the shell completion rules for `ronin-fuzzer`.
+        #
+        # ## Usage
+        #
+        #     ronin-fuzzer 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-fuzzer completion --print
+        #     ronin-fuzzer completion --install
+        #     ronin-fuzzer completion --uninstall
+        #
+        # @since 0.2.0
+        #
+        class Completion < Core::CLI::CompletionCommand
+
+          completion_file File.join(ROOT,'data','completions','ronin-fuzzer')
+
+          man_dir File.join(ROOT,'man')
+          man_page 'ronin-fuzzer-completion.1'
+
+          description 'Manages the shell completion rules for ronin-fuzzer'
+
+        end
+      end
+    end
+  end
+end

data/lib/ronin/fuzzer/cli/commands/fuzz.rb

@@ -1,7 +1,7 @@
 #
 # ronin-fuzzer - A Ruby library for generating, mutating, and fuzzing data.
 #
-# Copyright (c) 2006-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2006-2024 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
 # This file is part of ronin-fuzzer.
 #

data/lib/ronin/fuzzer/cli.rb

@@ -1,7 +1,7 @@
 #
 # ronin-fuzzer - A Ruby library for generating, mutating, and fuzzing data.
 #
-# Copyright (c) 2006-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2006-2024 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
 # This file is part of ronin-fuzzer.
 #
@@ -21,6 +21,10 @@
 
 require 'command_kit/commands'
 require 'command_kit/commands/auto_load'
+require 'command_kit/options/version'
+
+require 'ronin/core/cli/command'
+require 'ronin/core/cli/help/banner'
 
 module Ronin
   module Fuzzer
@@ -31,8 +35,11 @@ module Ronin
         dir:       "#{__dir__}/cli/commands",
         namespace: "#{self}::Commands"
       )
+      include CommandKit::Options::Version
+      include Core::CLI::Help::Banner
 
       command_name 'ronin-fuzzer'
+      version Ronin::Fuzzer::VERSION
 
     end
   end

data/lib/ronin/fuzzer/root.rb

@@ -1,7 +1,7 @@
 #
 # ronin-fuzzer - A Ruby library for generating, mutating, and fuzzing data.
 #
-# Copyright (c) 2006-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2006-2024 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
 # This file is part of ronin-fuzzer.
 #

data/lib/ronin/fuzzer/version.rb

@@ -1,7 +1,7 @@
 #
 # ronin-fuzzer - A Ruby library for generating, mutating, and fuzzing data.
 #
-# Copyright (c) 2006-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2006-2024 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
 # This file is part of ronin-fuzzer.
 #
@@ -22,6 +22,6 @@
 module Ronin
   module Fuzzer
     # ronin-fuzzer version
-    VERSION = '0.1.0'
+    VERSION = '0.2.0'
   end
 end

data/lib/ronin/fuzzing/core_ext/string.rb

@@ -1,7 +1,7 @@
 #
 # ronin-fuzzer - A Ruby library for generating, mutating, and fuzzing data.
 #
-# Copyright (c) 2006-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2006-2024 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
 # This file is part of ronin-fuzzer.
 #
@@ -33,7 +33,8 @@ class String
   #
   # @param [Array(<String,Symbol,Enumerable>, <Integer,Array,Range>)] fields
   #   The fields which defines the string or character sets which will
-  #   make up parts of the String.
+  #   make up parts of the String. Symbols corresponds to
+  #   [Chars method names](https://rubydoc.info/gems/chars/Chars).
   #
   # @yield [string]
   #   The given block will be passed each unique String.
@@ -51,8 +52,6 @@ class String
   #   A given string set was not a String, Symbol or Enumerable.
   #   A given string set length was not an Integer or Enumerable.
   #
-  # @example Generate Strings with ranges of repeating sub-strings:
-  #
   # @example Generate Strings with three alpha chars and one numeric chars:
   #   String.generate([:alpha, 3], :numeric) do |password|
   #     puts password
@@ -140,7 +139,9 @@ class String
   # Incrementally fuzzes the String.
   #
   # @param [Hash{Regexp,String,Symbol => Enumerable,Symbol}] substitutions
-  #   Patterns and their substitutions.
+  #   Patterns and their substitutions. Symbols are resolved to
+  #   [Ronin::Support::Text::Patterns](https://ronin-rb.dev/docs/ronin-support/Ronin/Support/Text/Patterns.html)
+  #   constants.
   #
   # @yield [fuzz]
   #   The given block will be passed every fuzzed String.
@@ -162,7 +163,7 @@ class String
   #   end
   #
   # @example Replace a `Regexp::UNIX_PATH` with {Ronin::Fuzzing#format_strings}:
-  #   "GET /downloads/".fuzz(unix_path: :format_string)
+  #   "GET /downloads/".fuzz(unix_path: :format_strings)
   #
   # @api public
   #

data/lib/ronin/fuzzing/core_ext.rb

@@ -1,7 +1,7 @@
 #
 # ronin-fuzzer - A Ruby library for generating, mutating, and fuzzing data.
 #
-# Copyright (c) 2006-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2006-2024 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
 # This file is part of ronin-fuzzer.
 #

data/lib/ronin/fuzzing/fuzzer.rb

@@ -1,7 +1,7 @@
 #
 # ronin-fuzzer - A Ruby library for generating, mutating, and fuzzing data.
 #
-# Copyright (c) 2006-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2006-2024 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
 # This file is part of ronin-fuzzer.
 #

data/lib/ronin/fuzzing/mutator.rb

@@ -1,7 +1,7 @@
 #
 # ronin-fuzzer - A Ruby library for generating, mutating, and fuzzing data.
 #
-# Copyright (c) 2006-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2006-2024 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
 # This file is part of ronin-fuzzer.
 #

data/lib/ronin/fuzzing/repeater.rb

@@ -1,7 +1,7 @@
 #
 # ronin-fuzzer - A Ruby library for generating, mutating, and fuzzing data.
 #
-# Copyright (c) 2006-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2006-2024 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
 # This file is part of ronin-fuzzer.
 #

data/lib/ronin/fuzzing/template.rb

@@ -1,7 +1,7 @@
 #
 # ronin-fuzzer - A Ruby library for generating, mutating, and fuzzing data.
 #
-# Copyright (c) 2006-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2006-2024 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
 # This file is part of ronin-fuzzer.
 #

data/lib/ronin/fuzzing.rb

@@ -1,7 +1,7 @@
 #
 # ronin-fuzzer - A Ruby library for generating, mutating, and fuzzing data.
 #
-# Copyright (c) 2006-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2006-2024 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
 # This file is part of ronin-fuzzer.
 #

data/man/ronin-fuzzer-completion.1

@@ -0,0 +1,76 @@
+.\" Generated by kramdown-man 1.0.1
+.\" https://github.com/postmodern/kramdown-man#readme
+.TH ronin-fuzzer-completion 1 "2024-01-01" Ronin Fuzzer "User Manuals"
+.SH NAME
+.PP
+ronin\-fuzzer\-completion \- Manages shell completion rules for \fBronin\-fuzzer\fR
+.SH SYNOPSIS
+.PP
+\fBronin\-fuzzer completion\fR \[lB]\fIoptions\fP\[rB]
+.SH DESCRIPTION
+.PP
+The \fBronin\-fuzzer completion\fR command can print, install, or uninstall shell
+completion rules for the \fBronin\-fuzzer\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\-fuzzer\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\-fuzzer completion \-\-print\fR
+Prints the shell completion rules instead of installing them\.
+.TP
+\fBronin\-fuzzer completion \-\-install\fR
+Installs the shell completion rules for \fBronin\-fuzzer\fR\.
+.TP
+\fBronin\-fuzzer completion \-\-uninstall\fR
+Uninstalls the shell completion rules for \fBronin\-fuzzer\fR\.
+.SH AUTHOR
+.PP
+Postmodern 
+.MT postmodern\.mod3\[at]gmail\.com
+.ME

data/man/ronin-fuzzer-completion.1.md

@@ -0,0 +1,78 @@
+# ronin-fuzzer-completion 1 "2024-01-01" Ronin Fuzzer "User Manuals"
+
+## NAME
+
+ronin-fuzzer-completion - Manages shell completion rules for `ronin-fuzzer`
+
+## SYNOPSIS
+
+`ronin-fuzzer completion` [*options*]
+
+## DESCRIPTION
+
+The `ronin-fuzzer completion` command can print, install, or uninstall shell
+completion rules for the `ronin-fuzzer` command.
+
+Supports installing completion rules for Bash or Zsh shells.
+Completion rules for the Fish shell is currently not supported.
+
+### ZSH SUPPORT
+
+Zsh users will have to add the following lines to their `~/.zshrc` file in
+order to enable Zsh's Bash completion compatibility layer:
+
+    autoload -Uz +X compinit && compinit
+    autoload -Uz +X bashcompinit && bashcompinit
+
+## OPTIONS
+
+`--print`
+: Prints the shell completion file.
+
+`--install`
+: Installs the shell completion file.
+
+`--uninstall`
+: Uninstalls the shell completion file.
+
+`-h`, `--help`
+: Prints help information.
+
+## ENVIRONMENT
+
+*PREFIX*
+: Specifies the root prefix for the file system.
+
+*HOME*
+: Specifies the home directory of the user. Ronin will search for the
+  `~/.cache/ronin-fuzzer` cache directory within the home directory.
+
+*XDG_DATA_HOME*
+: Specifies the data directory to use. Defaults to `$HOME/.local/share`.
+
+## FILES
+
+`~/.local/share/bash-completion/completions/`
+: The user-local installation directory for Bash completion files.
+
+`/usr/local/share/bash-completion/completions/`
+: The system-wide installation directory for Bash completions files.
+
+`/usr/local/share/zsh/site-functions/`
+: The installation directory for Zsh completion files.
+
+## EXAMPLES
+
+`ronin-fuzzer completion --print`
+: Prints the shell completion rules instead of installing them.
+
+`ronin-fuzzer completion --install`
+: Installs the shell completion rules for `ronin-fuzzer`.
+
+`ronin-fuzzer completion --uninstall`
+: Uninstalls the shell completion rules for `ronin-fuzzer`.
+
+## AUTHOR
+
+Postmodern <postmodern.mod3@gmail.com>
+

data/man/ronin-fuzzer-fuzz.1

@@ -1,95 +1,80 @@
-.\" Generated by kramdown-man 0.1.8
+.\" Generated by kramdown-man 1.0.1
 .\" https://github.com/postmodern/kramdown-man#readme
 .TH ronin-fuzzer-fuzz 1 "2022-01-01" Ronin Fuzzer "User Manuals"
-.LP
+.SH NAME
+.PP
+ronin\-fuzzer\-fuzz \- Performs basic fuzzing of files
 .SH SYNOPSIS
-.LP
-.HP
-\fBronin-fuzzer fuzz\fR \[lB]\fIoptions\fP\[rB] \[lB]\fITEMPLATE\fP\[rB]
-.LP
+.PP
+\fBronin\-fuzzer fuzz\fR \[lB]\fIoptions\fP\[rB] \[lB]\fITEMPLATE\fP\[rB]
 .SH DESCRIPTION
-.LP
 .PP
 Fuzzes data read from a \fIFILE\fP or from \fBSTDIN\fR\. The fuzzed data can be written
 to output files, run in commands or sent to TCP\[sl]UDP services\.
-.LP
 .SH OPTIONS
-.LP
 .TP
-\fB-v\fR, \fB--[no-]verbose\fR
+\fB\-v\fR, \fB\-\-\[lB]no\-\[rB]verbose\fR
 Enable verbose output\.
-.LP
 .TP
-\fB-q\fR, \fB--[no-]quiet\fR
+\fB\-q\fR, \fB\-\-\[lB]no\-\[rB]quiet\fR
 Disable verbose output\.
-.LP
 .TP
-\fB--[no-]silent\fR
+\fB\-\-\[lB]no\-\[rB]silent\fR
 Silence all output\.
-.LP
 .TP
-\fB-i\fR, \fB--input\fR \fIFILE\fP
+\fB\-i\fR, \fB\-\-input\fR \fIFILE\fP
 The input text FILE to parse\. Data will be read from \fBSTDIN\fR by default\.
-.LP
-.HP
-\fB-r\fR, \fB--rule\fR \[lB]\fIPATTERN\fP\[or]\fI\[sl]REGEXP\[sl]\fP\[or]STRING\[rB]:\[lB]\fIMETHOD\fP\[or]\fISTRING\fP\fI*N\fP\[lB]\-\fIM\fP\[rB]\[rB]
-The rule to apply to the \fIINPUT\fP\. Fuzzer rules consist of a pattern and 
+.TP
+\fB\-r\fR, \fB\-\-rule\fR \[lB]\fIPATTERN\fP\[or]\fI\[sl]REGEXP\[sl]\fP\[or]STRING\[rB]:\[lB]\fIMETHOD\fP\[or]\fISTRING\fP\fI*N\fP\[lB]\-\fIM\fP\[rB]\[rB]
+The rule to apply to the \fIINPUT\fP\. Fuzzer rules consist of a pattern and
 substitution\. Patterns may be one of the following:
-.LP
-.nf
-* A name of a Ronin Regular Expression (ex: \`unix\[ru]path\`)
-* A custom Regular Expression (ex: \`\[sl]\ed\[pl]\[sl]\`)
-* A plain String (ex: \`example\.com\`)\.
-
-  Substitutions may be one of the following:
-
-* A method from \`Ronin::Fuzzer\` (ex: \`bad\[ru]strings\`)
-* A *STRING*, repeated *N* or *M* times (ex: \`A*100\-200\`)\.
-.fi
-.LP
+.RS
+.RS
+.IP \(bu 2
+A name of a Ronin Regular Expression (ex: \fBunix\[ru]path\fR)
+.IP \(bu 2
+A custom Regular Expression (ex: \fB\[sl]\ed\[pl]\[sl]\fR)
+.IP \(bu 2
+A plain String (ex: \fBexample\.com\fR)\.
+.IP \( 2
+Substitutions may be one of the following:
+.IP \(bu 2
+A method from \fBRonin::Fuzzer\fR (ex: \fBbad\[ru]strings\fR)
+.IP \(bu 2
+A \fISTRING\fP, repeated \fIN\fP or \fIM\fP times (ex: \fBA*100\-200\fR)\.
+.RE
+.RE
 .TP
-\fB-o\fR, \fB--output\fR \fIPATH\fP
+\fB\-o\fR, \fB\-\-output\fR \fIPATH\fP
 The output PATH to write the fuzzer to\.
-.LP
 .TP
-\fB-c\fR, \fB--command\fR \fICOMMAND\fP
-The command to run with the fuzzed data\. All occurrences of \fB#string#\fR
-will be replaced with the fuzzed data, and occurrences of \fB#path#\fR will
+\fB\-c\fR, \fB\-\-command\fR \fICOMMAND\fP
+The command to run with the fuzzed data\. All occurrences of \fB\[sh]string\[sh]\fR
+will be replaced with the fuzzed data, and occurrences of \fB\[sh]path\[sh]\fR will
 be replaced with the path to the fuzzed data\.
-.LP
 .TP
-\fB-t\fR, \fB--tcp\fR \fIHOST\fP:\fIPORT\fP
+\fB\-t\fR, \fB\-\-tcp\fR \fIHOST\fP:\fIPORT\fP
 The TCP service to send the fuzzed data to\.
-.LP
 .TP
-\fB-u\fR, \fB--udp\fR \fIHOST\fP:\fIPORT\fP
+\fB\-u\fR, \fB\-\-udp\fR \fIHOST\fP:\fIPORT\fP
 The UDP service to send the fuzzed data to\.
-.LP
 .TP
-\fB-p\fR, \fB--pause\fR \fISECONDS\fP
+\fB\-p\fR, \fB\-\-pause\fR \fISECONDS\fP
 Pause in between mutations\.
-.LP
 .SH EXAMPLES
-.LP
 .TP
-\fBronin-fuzzer fuzz -i http_request.txt -o bad.txt -r unix_path:bad_strings\fR
+\fBronin\-fuzzer fuzz \-i http\[ru]request\.txt \-o bad\.txt \-r unix\[ru]path:bad\[ru]strings\fR
 Fuzzes a HTTP request, replacing every occurrence of a UNIX path, with
-strings from the \fBbad_strings\fR method\.
-.LP
+strings from the \fBbad\[ru]strings\fR method\.
 .SH LINKS
-.LP
-.PP
+.TP
 Ronin Regular Expressions
 https:\[sl]\[sl]ronin\-rb\.dev\[sl]docs\[sl]ronin\-support\[sl]Regexp\.html
-.LP
 .TP
 \fBRonin::Fuzzer\fR
 https:\[sl]\[sl]ronin\-rb\.dev\[sl]docs\[sl]ronin\-fuzzer\[sl]Ronin\[sl]Fuzzer\.html
-.LP
 .SH AUTHOR
-.LP
 .PP
 Postmodern 
 .MT postmodern\.mod3\[at]gmail\.com
 .ME
-.LP

data/man/ronin-fuzzer-fuzz.1.md

@@ -1,5 +1,9 @@
 # ronin-fuzzer-fuzz 1 "2022-01-01" Ronin Fuzzer "User Manuals"
 
+## NAME
+
+ronin-fuzzer-fuzz - Performs basic fuzzing of files
+
 ## SYNOPSIS
 
 `ronin-fuzzer fuzz` [*options*] [*TEMPLATE*]
@@ -12,20 +16,20 @@ to output files, run in commands or sent to TCP/UDP services.
 ## OPTIONS
 
 `-v`, `--[no-]verbose`
-	Enable verbose output.
+: Enable verbose output.
 
 `-q`, `--[no-]quiet`
-	Disable verbose output.
+: Disable verbose output.
 
 `--[no-]silent`
-	Silence all output.
+: Silence all output.
 
 `-i`, `--input` *FILE*
-	The input text FILE to parse. Data will be read from `STDIN` by default.
+: The input text FILE to parse. Data will be read from `STDIN` by default.
 
 `-r`, `--rule` [*PATTERN*|*/REGEXP/*|STRING]:[*METHOD*|*STRING***N*[-*M*]]
-	The rule to apply to the *INPUT*. Fuzzer rules consist of a pattern and 
-	substitution. Patterns may be one of the following:
+: The rule to apply to the *INPUT*. Fuzzer rules consist of a pattern and
+  substitution. Patterns may be one of the following:
 
 	* A name of a Ronin Regular Expression (ex: `unix_path`)
 	* A custom Regular Expression (ex: `/\d+/`)
@@ -37,35 +41,35 @@ to output files, run in commands or sent to TCP/UDP services.
 	* A *STRING*, repeated *N* or *M* times (ex: `A*100-200`).
 
 `-o`, `--output` *PATH*
-	The output PATH to write the fuzzer to.
+: The output PATH to write the fuzzer to.
 
 `-c`, `--command` *COMMAND*
-	The command to run with the fuzzed data. All occurrences of `#string#`
-	will be replaced with the fuzzed data, and occurrences of `#path#` will
-	be replaced with the path to the fuzzed data.
+: The command to run with the fuzzed data. All occurrences of `#string#`
+  will be replaced with the fuzzed data, and occurrences of `#path#` will
+  be replaced with the path to the fuzzed data.
 
 `-t`, `--tcp` *HOST*:*PORT*
-	The TCP service to send the fuzzed data to.
+: The TCP service to send the fuzzed data to.
 
 `-u`, `--udp` *HOST*:*PORT*
-	The UDP service to send the fuzzed data to.
+: The UDP service to send the fuzzed data to.
 
 `-p`, `--pause` *SECONDS*
-  Pause in between mutations.
+: Pause in between mutations.
 
 ## EXAMPLES
 
 `ronin-fuzzer fuzz -i http_request.txt -o bad.txt -r unix_path:bad_strings`
-	Fuzzes a HTTP request, replacing every occurrence of a UNIX path, with
-	strings from the `bad_strings` method.
+: Fuzzes a HTTP request, replacing every occurrence of a UNIX path, with
+  strings from the `bad_strings` method.
 
 ## LINKS
 
 Ronin Regular Expressions
-	https://ronin-rb.dev/docs/ronin-support/Regexp.html
+: https://ronin-rb.dev/docs/ronin-support/Regexp.html
 
 `Ronin::Fuzzer`
-	https://ronin-rb.dev/docs/ronin-fuzzer/Ronin/Fuzzer.html
+: https://ronin-rb.dev/docs/ronin-fuzzer/Ronin/Fuzzer.html
 
 ## AUTHOR
 

data/scripts/setup

@@ -0,0 +1,58 @@
+#!/usr/bin/env bash
+
+#
+# Prints a log message.
+#
+function log()
+{
+	if [[ -t 1 ]]; then
+		echo -e "\x1b[1m\x1b[32m>>>\x1b[0m \x1b[1m$1\x1b[0m"
+	else
+		echo ">>> $1"
+	fi
+}
+
+#
+# Prints a warn message.
+#
+function warn()
+{
+	if [[ -t 1 ]]; then
+		echo -e "\x1b[1m\x1b[33m***\x1b[0m \x1b[1m$1\x1b[0m" >&2
+	else
+		echo "*** $1" >&2
+	fi
+}
+
+#
+# Prints an error message.
+#
+function error()
+{
+	if [[ -t 1 ]]; then
+		echo -e "\x1b[1m\x1b[31m!!!\x1b[0m \x1b[1m$1\x1b[0m" >&2
+	else
+		echo "!!! $1" >&2
+	fi
+}
+
+#
+# Prints an error message and exists with -1.
+#
+function fail()
+{
+	error "$@"
+	exit -1
+}
+
+# default to installing gems into vendor/bundle
+if [[ ! -f .bundle/config ]]; then
+	bundle config set --local path vendor/bundle >/dev/null || \
+	  fail "Failed to run 'bundle config'"
+fi
+
+log "Installing gems ..."
+bundle install || fail "Failed to run 'bundle install'!"
+
+log "Setting up the project ..."
+bundle exec rake setup || "Failed to run 'rake setup'!"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ronin-fuzzer
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Postmodern
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-02-01 00:00:00.000000000 Z
+date: 2024-07-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: combinatorics
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0.2'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -90,9 +90,11 @@ files:
 - README.md
 - Rakefile
 - bin/ronin-fuzzer
+- data/completions/ronin-fuzzer
 - gemspec.yml
 - lib/ronin/fuzzer/cli.rb
 - lib/ronin/fuzzer/cli/command.rb
+- lib/ronin/fuzzer/cli/commands/completion.rb
 - lib/ronin/fuzzer/cli/commands/fuzz.rb
 - lib/ronin/fuzzer/root.rb
 - lib/ronin/fuzzer/version.rb
@@ -103,9 +105,12 @@ files:
 - lib/ronin/fuzzing/mutator.rb
 - lib/ronin/fuzzing/repeater.rb
 - lib/ronin/fuzzing/template.rb
+- man/ronin-fuzzer-completion.1
+- man/ronin-fuzzer-completion.1.md
 - man/ronin-fuzzer-fuzz.1
 - man/ronin-fuzzer-fuzz.1.md
 - ronin-fuzzer.gemspec
+- scripts/setup
 homepage: https://ronin-rb.dev/
 licenses:
 - LGPL-3.0
@@ -130,7 +135,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.26
+rubygems_version: 3.5.11
 signing_key:
 specification_version: 4
 summary: A highly configurable fuzzing library and CLI for Ruby.