ronin-fuzzer 0.1.0.beta1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9564e6b05be69b5d8ca409a2a8c95f831727c3319f71303c477b2f60080b4592
-  data.tar.gz: de9f24233b6435549ea06c5ec7db4211c432fe77313af905482edd444ce09764
+  metadata.gz: b75ddebfc52f82912471833f168b9e8813af985b9443cb1c6b88a27b1c730a3b
+  data.tar.gz: 7a0454d2ece994db0151eb7ed1df4ce0edf6ab2e05d48d12f13621930d66cd8d
 SHA512:
-  metadata.gz: 7350b4af7a680571e4dd1674cdd7e064248a6028e3aac0836077cc8730ceb52feb7f065d39c2b0654dcf951b5773a8f237823ec7a94fe58c36ef3707ea4369d3
-  data.tar.gz: 23488e361a02a84dd0bcb332289cbf7b0c94949b6dfa6698a23771bb507c361c790e5f6c0aa079291c74b7ecb91eb738c5f4077cd12f4359f46923117c6c02e9
+  metadata.gz: 508b1ede3b5ec7e9be7d1a9bccfab1add955ce60f028559d444613f6e485195ef52f95f293acab505a9493222b2ba31337901df3038a8bd2fee0a3b8668c8a43
+  data.tar.gz: 65fdbda74f4b756e3378e1fbdc5ac533612a6aad873eff7b8b17bc0a0f1a94726bdb15525668f974f18b2a5d50feb2853077d8a8ba00040c64ed88b5a3352a3f

data/.github/workflows/ruby.yml

@@ -21,6 +21,7 @@ jobs:
         uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
       - name: Install libsqlite3
         run: |
           sudo apt update -y && \

data/README.md

@@ -2,6 +2,7 @@
 
 [![CI](https://github.com/ronin-rb/ronin-fuzzer/actions/workflows/ruby.yml/badge.svg)](https://github.com/ronin-rb/ronin-fuzzer/actions/workflows/ruby.yml)
 [![Code Climate](https://codeclimate.com/github/ronin-rb/ronin-fuzzer.svg)](https://codeclimate.com/github/ronin-rb/ronin-fuzzer)
+[![Gem Version](https://badge.fury.io/rb/ronin-fuzzer.svg)](https://badge.fury.io/rb/ronin-fuzzer)
 
 * [Website](https://ronin-rb.dev/)
 * [Source](https://github.com/ronin-rb/ronin-fuzzer)
@@ -13,7 +14,9 @@
 
 ## Description
 
-ronin-fuzzer is a Ruby library for generating, mutating, and fuzzing data.
+ronin-fuzzer is a Ruby library and CLI for generating, mutating, and fuzzing
+data. The goal of ronin-fuzzer is to be both easy to use and highly
+customizable.
 
 ## Features
 
@@ -68,7 +71,7 @@ gem.add_dependency 'ronin-fuzzer', '~> 0.1'
 
 ## License
 
-Copyright (c) 2006-2022 Hal Brodigan (postmodern.mod3@gmail.com)
+Copyright (c) 2006-2023 Hal Brodigan (postmodern.mod3@gmail.com)
 
 This file is part of ronin-fuzzer.
 

data/bin/ronin-fuzzer

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

data/gemspec.yml

@@ -1,7 +1,8 @@
 name: ronin-fuzzer
-summary: generate, mutate, and fuzz data
+summary: A highly configurable fuzzing library and CLI for Ruby.
 description: |
-  A Ruby library for generating, mutating, and fuzzing data.
+  A Ruby library and CLI for generating, mutating, and fuzzing data.
+  The goal of ronin-fuzzer is to be both easy to use and highly customizable.
 
 license: LGPL-3.0
 authors: Postmodern
@@ -10,10 +11,11 @@ homepage: https://ronin-rb.dev/
 has_yard: true
 
 metadata:
-  documentation_uri: https://rubydoc.info/gems/ronin-fuzzer
+  documentation_uri: https://ronin-rb.dev/docs/ronin-fuzzer
   source_code_uri:   https://github.com/ronin-rb/ronin-fuzzer
   bug_tracker_uri:   https://github.com/ronin-rb/ronin-fuzzer/issues
-  changelog_uri:     https://github.com/ronin-rb/ronin-fuzzer/blob/master/ChangeLog.md
+  changelog_uri:     https://github.com/ronin-rb/ronin-fuzzer/blob/main/ChangeLog.md
+  rubygems_mfa_required: 'true'
 
 generated_files:
  - man/ronin-fuzzer-fuzz.1
@@ -23,8 +25,8 @@ required_ruby_version: ">= 3.0.0"
 dependencies:
   combinatorics: ~> 0.4
   # Ronin dependencies:
-  ronin-support: ~> 1.0.0.beta1
-  ronin-core: ~> 0.1.0.beta1
+  ronin-support: ~> 1.0
+  ronin-core: ~> 0.1
 
 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-2022 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2006-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
 # This file is part of ronin-fuzzer.
 #

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-2022 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2006-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
 # This file is part of ronin-fuzzer.
 #
@@ -20,8 +20,12 @@
 #
 
 require 'ronin/fuzzer/cli/command'
-require 'ronin/fuzzer/repeater'
-require 'ronin/fuzzer/fuzzer'
+require 'ronin/core/cli/logging'
+
+require 'ronin/support/text/patterns'
+require 'ronin/fuzzing/repeater'
+require 'ronin/fuzzing/fuzzer'
+require 'ronin/fuzzing'
 
 require 'shellwords'
 require 'tempfile'
@@ -44,7 +48,7 @@ module Ronin
         #     -q, --[no-]quiet                 Disable verbose output.
         #         --[no-]silent                Silence all output.
         #     -r [[PATTERN|/REGEXP/]:[METHOD|STRING*N[-M]]],
-        #         --rule                       Fuzzing rules.
+        #         --rule                       Adds a fuzzing rule.
         #     -i, --input [FILE]               Input file to fuzz.
         #     -o, --output [FILE]              Output file path.
         #     -c [PROGRAM [OPTIONS|#string#|#path#] ...],
@@ -59,6 +63,8 @@ module Ronin
         #
         class Fuzz < Command
 
+          include Core::CLI::Logging
+
           option :input, short: '-i',
                          value: {
                            type:  String,
@@ -68,45 +74,66 @@ module Ronin
 
           option :rules, short: '-r',
                          value: {
-                           type:  Hash[String => String],
+                           type:  String,
                            usage: '[PATTERN|/REGEXP/|STRING]:[METHOD|STRING*N[-M]]'
                          },
-                         desc: 'Fuzzing rules'
+                         desc: 'Adds a fuzzing rule' do |value|
+                           @rules << parse_rule(value)
+                         end
 
           option :output, short: '-o',
                           value: {
                             type:  String,
                             usage: 'PATH'
                           },
-                          desc: 'Output file path'
+                          desc: 'Output file path' do |value|
+                            @mode = :output
+
+                            @output      = value
+                            @output_ext  = File.extname(@output)
+                            @output_name = @output.chomp(@output_ext)
+                          end
 
           option :command, short: '-c',
                            value: {
                              type:  String,
                              usage: '"PROGRAM [OPTIONS|#string#|#path#] ..."'
                            },
-                           desc: 'Template command to run'
+                           desc: 'Template command to run' do |value|
+                             @mode    = :command
+                             @command = Shellwords.shellescape(value)
+                           end
 
           option :tcp, short: '-t',
                        value: {
                          type:  String,
                          usage: 'HOST:PORT'
                        },
-                       desc: 'TCP service to fuzz'
+                       desc: 'TCP service to fuzz' do |value|
+                         @mode = :tcp
+
+                         @host, @port = parse_host_port(value)
+                       end
 
           option :udp, short: '-u',
                        value: {
                          type:  String,
                          usage: 'HOST:PORT'
                        },
-                       desc: 'UDP service to fuzz'
+                       desc: 'UDP service to fuzz' do |value|
+                         @mode = :udp
+
+                         @host, @port = parse_host_port(value)
+                       end
 
           option :pause, short: '-p',
                          value: {
                            type:  Float,
                            usage: 'SECONDS'
                          },
-                         desc: 'Pause in between mutations'
+                         desc: 'Pause in between mutations' do |value|
+                           @pause = value
+                         end
 
           description 'Performs basic fuzzing of files'
 
@@ -116,58 +143,99 @@ module Ronin
 
           man_page 'ronin-fuzzer-fuzz.1'
 
+          # The execution mode to run the fuzzer in.
+          #
+          # @return [:output, :command, :tcp, :udp]
+          attr_reader :mode
+
+          # The output file template.
           #
-          # Sets up the fuzz command.
+          # @return [String, nil]
+          attr_reader :output
+
+          # The output file extension.
+          #
+          # @return [String, nil]
+          attr_reader :output_ext
+
+          # The output file name.
+          #
+          # @return [String, nil]
+          attr_reader :output_name
+
+          # The command template to execute.
+          #
+          # @return [String, nil]
+          attr_reader :command
+
+          # The host name to send fuzzing data to.
+          #
+          # @return [String, nil]
+          attr_reader :host
+
+          # The port to send fuzzing data to.
+          #
+          # @return [Integer, nil]
+          attr_reader :port
+
+          # The fuzzing rules.
+          #
+          # @return [Array<(Regexp, Enumerator)>]
+          attr_reader :rules
+
+          #
+          # Initializes the `ronin-fuzzer fuzz` command.
+          #
+          # @param [Hash{Symbol => Object}] kwargs
+          #   Additional keyword arguments.
+          #
+          def initialize(**kwargs)
+            super(**kwargs)
+
+            @rules = []
+          end
+
+          #
+          # Runs the `ronin-fuzzer fuzz` command.
           #
           def run
-            unless options[:rules]
+            if @rules.empty?
               print_error "Must specify at least one fuzzing rule"
-              exit -1
+              exit(-1)
             end
 
-            rules = Hash[options[:rules].map { |pattern,substitution|
-              [parse_pattern(pattern), parse_substitution(substitution)]
-            }]
-
-            if options[:output]
-              @file_ext  = File.extname(options[:output])
-              @file_name = @output.chomp(@file_ext)
-            elsif options[:command]
-              @command = shellwords(options[:command])
-            elsif (options[:tcp] || options[:udp])
-              @socket_class = if    options[:tcp] then TCPSocket
-                              elsif options[:udp] then UDPSocket
-                              end
-
-              @host, @port = (options[:tcp] || options[:udp]).split(':',2)
-              @port = @port.to_i
-            end
+            data = if options[:input] then File.read(options[:input])
+                   else                    $stdin.read
+                   end
 
-            data   = if options[:input] then File.read(options[:input])
-                     else                    $stdin.read
+            method = case @mode
+                     when :output    then method(:fuzz_file)
+                     when :command   then method(:fuzz_command)
+                     when :tcp, :udp then method(:fuzz_network)
+                     else                 method(:print_fuzz)
                      end
 
-            method = if options[:output]
-                       method(:fuzz_file)
-                     elsif options[:command]
-                       method(:fuzz_command)
-                     elsif (options[:tcp] || options[:udp])
-                       method(:fuzz_network)
-                     else
-                       method(:print_fuzz)
-                     end
+            fuzzer = Fuzzing::Fuzzer.new(@rules)
 
-            fuzzer = Fuzzer::Fuzzer.new(rules)
             fuzzer.each(data).each_with_index do |string,index|
               method.call(string,index + 1)
 
-              sleep(pause) if pause?
+              sleep(@pause) if @pause
             end
           end
 
-          private
-
-          include Shellwords
+          #
+          # Creates a new output path for the given index.
+          #
+          # @param [Integer] index
+          #   The index number of the fuzzing iteration.
+          #
+          # @return [String]
+          #   The new output path.
+          #
+          def output_path(index)
+            "#{@output_name}-#{index}#{@output_ext}"
+          end
 
           #
           # Writes the fuzzed string to a file.
@@ -176,12 +244,12 @@ module Ronin
           #   The fuzzed string.
           #
           # @param [Integer] index
-          #   The iteration number.
+          #   The fuzzing iteration number.
           #
           def fuzz_file(string,index)
-            path = "#{@file_name}-#{index}#{@file_ext}"
+            path = output_path(index)
 
-            print_info "Creating file ##{index}: #{path} ..."
+            log_info "Creating file ##{index}: #{path} ..."
 
             File.open(path,'wb') do |file|
               file.write string
@@ -212,7 +280,7 @@ module Ronin
                 end
               end
 
-              print_info "Running command #{index}: #{arguments.join(' ')} ..."
+              log_info "Running command #{index}: #{arguments.join(' ')} ..."
 
               # run the command as it's own process
               unless system(*arguments)
@@ -220,10 +288,10 @@ module Ronin
 
                 if status.coredump?
                   # jack pot!
-                  print_error "Process ##{status.pid} coredumped!"
+                  log_error "Process ##{status.pid} coredumped!"
                 else
                   # process errored out
-                  print_warning "Process ##{status.pid} exited with status #{status.exitstatus}"
+                  log_warning "Process ##{status.pid} exited with status #{status.exitstatus}"
                 end
               end
             end
@@ -239,14 +307,18 @@ module Ronin
           #   The iteration number.
           #
           def fuzz_network(string,index)
-            print_debug "Connecting to #{@host}:#{@port} ..."
-            socket = @socket_class.new(@host,@port)
+            log_debug "Connecting to #{@host}:#{@port} ..."
 
-            print_info "Sending message ##{index}: #{string.inspect} ..."
+            socket = case @mode
+                     when :tcp then TCPSocket.new(@host,@port)
+                     when :udp then UDPSocket.new(@host,@port)
+                     end
+
+            log_info "Sending message ##{index}: #{string.inspect} ..."
             socket.write(string)
             socket.flush
 
-            print_debug "Disconnecting from #{@host}:#{@port} ..."
+            log_debug "Disconnecting from #{@host}:#{@port} ..."
             socket.close
           end
 
@@ -260,11 +332,57 @@ module Ronin
           #   The iteration number.
           #
           def print_fuzz(string,index)
-            print_debug "String ##{index} ..."
+            log_debug "String ##{index} ..."
 
             puts string
           end
 
+          #
+          # Parses the host and port from the value.
+          #
+          # @param [String] value
+          #   The value to parse.
+          #
+          # @return [(String, Integer)]
+          #   The parsed host and port.
+          #
+          def parse_host_port(value)
+            host, port = value.split(':',2)
+
+            return host, port.to_i
+          end
+
+          #
+          # Parses a fuzzing rule.
+          #
+          # @param [String] value
+          #   The fuzzing rule.
+          #
+          # @return [(Regexp, Enumerator)]
+          #   The fuzzing pattern and list of substitutions.
+          #
+          def parse_rule(value)
+            if value.start_with?('/')
+              unless (index = value.rindex('/:'))
+                raise(OptionParser::InvalidArgument,"argument must be of the form /REGEXP/:REPLACE, but was: #{value}")
+              end
+
+              regexp       = parse_pattern(value[1...index])
+              substitution = parse_substitution(value[index+2..])
+
+              return [regexp, substitution]
+            else
+              unless (index = value.rindex(':'))
+                raise(OptionParser::InvalidArgument,"argument must be of the form STRING:STYLE but was: #{value}")
+              end
+
+              pattern      = parse_pattern(value[0...index])
+              substitution = parse_substitution(value[index+1..])
+
+              return [pattern, substitution]
+            end
+          end
+
           #
           # Parses a fuzz pattern.
           #
@@ -281,9 +399,8 @@ module Ronin
             when /^[a-z][a-z_]+$/
               const = string.upcase
 
-              if (Regexp.const_defined?(const) &&
-                  Regexp.const_get(const).kind_of?(Regexp))
-                Regexp.const_get(const)
+              if Support::Text::Patterns.const_defined?(const,false)
+                Support::Text::Patterns.const_get(const,false)
               else
                 string
               end
@@ -313,9 +430,9 @@ module Ronin
                           lengths.to_i
                         end
 
-              Fuzzer::Repeater.new(lengths).each(string)
+              Fuzzing::Repeater.new(lengths).each(string)
             else
-              Fuzzer[string]
+              Fuzzing[string]
             end
           end
 

data/lib/ronin/fuzzer/cli.rb

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

data/lib/ronin/fuzzer/root.rb

@@ -1,7 +1,7 @@
 #
 # ronin-fuzzer - A Ruby library for generating, mutating, and fuzzing data.
 #
-# Copyright (c) 2006-2022 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2006-2023 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-2022 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2006-2023 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.beta1'
+    VERSION = '0.1.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-2022 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2006-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
 # This file is part of ronin-fuzzer.
 #

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-2022 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2006-2023 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-2022 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2006-2023 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-2022 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2006-2023 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-2022 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2006-2023 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-2022 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2006-2023 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-2022 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2006-2023 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
 # This file is part of ronin-fuzzer.
 #

data/man/ronin-fuzzer-fuzz.1

@@ -53,8 +53,8 @@ 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 ocurrences of \fB#string#\fR
-will be replaced with the fuzzed data, and ocurrences of \fB#path#\fR will
+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
 be replaced with the path to the fuzzed data\.
 .LP
 .TP

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

@@ -40,8 +40,8 @@ to output files, run in commands or sent to TCP/UDP services.
 	The output PATH to write the fuzzer to.
 
 `-c`, `--command` *COMMAND*
-	The command to run with the fuzzed data. All ocurrences of `#string#`
-	will be replaced with the fuzzed data, and ocurrences of `#path#` will
+	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*

data/ronin-fuzzer.gemspec

@@ -27,13 +27,14 @@ Gem::Specification.new do |gem|
   gem.files  = `git ls-files`.split($/)
   gem.files  = glob[gemspec['files']] if gemspec['files']
   gem.files += Array(gemspec['generated_files'])
+  # exclude test files from the packages gem
+  gem.files -= glob[gemspec['test_files'] || 'spec/{**/}*']
 
   gem.executables = gemspec.fetch('executables') do
     glob['bin/*'].map { |path| File.basename(path) }
   end
 
   gem.extensions       = glob[gemspec['extensions'] || 'ext/**/extconf.rb']
-  gem.test_files       = glob[gemspec['test_files'] || 'spec/{**/}*_spec.rb']
   gem.extra_rdoc_files = glob[gemspec['extra_doc_files'] || '*.{txt,md}']
 
   gem.require_paths = Array(gemspec.fetch('require_paths') {

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ronin-fuzzer
 version: !ruby/object:Gem::Version
-  version: 0.1.0.beta1
+  version: 0.1.0
 platform: ruby
 authors:
 - Postmodern
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-01-01 00:00:00.000000000 Z
+date: 2023-02-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: combinatorics
@@ -30,28 +30,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0.beta1
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0.beta1
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: ronin-core
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.0.beta1
+        version: '0.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.0.beta1
+        version: '0.1'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -66,9 +66,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
-description: 'A Ruby library for generating, mutating, and fuzzing data.
-
-  '
+description: |
+  A Ruby library and CLI for generating, mutating, and fuzzing data.
+  The goal of ronin-fuzzer is to be both easy to use and highly customizable.
 email: postmodern.mod3@gmail.com
 executables:
 - ronin-fuzzer
@@ -106,21 +106,15 @@ files:
 - man/ronin-fuzzer-fuzz.1
 - man/ronin-fuzzer-fuzz.1.md
 - ronin-fuzzer.gemspec
-- spec/core_ext/string_spec.rb
-- spec/fuzzer_spec.rb
-- spec/fuzzing_spec.rb
-- spec/mutator_spec.rb
-- spec/repeater_spec.rb
-- spec/spec_helper.rb
-- spec/template_spec.rb
 homepage: https://ronin-rb.dev/
 licenses:
 - LGPL-3.0
 metadata:
-  documentation_uri: https://rubydoc.info/gems/ronin-fuzzer
+  documentation_uri: https://ronin-rb.dev/docs/ronin-fuzzer
   source_code_uri: https://github.com/ronin-rb/ronin-fuzzer
   bug_tracker_uri: https://github.com/ronin-rb/ronin-fuzzer/issues
-  changelog_uri: https://github.com/ronin-rb/ronin-fuzzer/blob/master/ChangeLog.md
+  changelog_uri: https://github.com/ronin-rb/ronin-fuzzer/blob/main/ChangeLog.md
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -139,11 +133,5 @@ requirements: []
 rubygems_version: 3.3.26
 signing_key:
 specification_version: 4
-summary: generate, mutate, and fuzz data
-test_files:
-- spec/core_ext/string_spec.rb
-- spec/fuzzer_spec.rb
-- spec/fuzzing_spec.rb
-- spec/mutator_spec.rb
-- spec/repeater_spec.rb
-- spec/template_spec.rb
+summary: A highly configurable fuzzing library and CLI for Ruby.
+test_files: []

data/spec/core_ext/string_spec.rb

@@ -1,87 +0,0 @@
-require 'spec_helper'
-require 'ronin/fuzzing/core_ext/string'
-
-describe String do
-  it "should provide String.generate" do
-    expect(described_class).to respond_to(:generate)
-  end
-
-  it "should provide String#repeating" do
-    expect(subject).to respond_to(:repeating)
-  end
-
-  it "should provide String#fuzz" do
-    expect(subject).to respond_to(:fuzz)
-  end
-
-  it "should provide String#mutate" do
-    expect(subject).to respond_to(:mutate)
-  end
-
-  describe "generate" do
-    subject { described_class }
-
-    it "should generate Strings from a template" do
-      strings = subject.generate([:numeric, 2]).to_a
-
-      expect(strings.grep(/^[0-9]{2}$/)).to eq(strings)
-    end
-  end
-
-  describe "#repeating" do
-    subject { 'A' }
-
-    context "when n is an Integer" do
-      let(:n) { 100 }
-
-      it "should multiply the String by n" do
-        expect(subject.repeating(n)).to eq(subject * n)
-      end
-    end
-
-    context "when n is Enumerable" do
-      let(:n) { [128, 512, 1024] }
-
-      it "should repeat the String by each length" do
-        strings = subject.repeating(n).to_a
-
-        expect(strings).to eq(n.map { |length| subject * length })
-      end
-    end
-  end
-
-  describe "#fuzz" do
-    subject { "foo bar" }
-
-    it "should apply each fuzzing rule individually" do
-      strings = subject.fuzz(/o/ => ['O', '0'], /a/ => ['A', '@']).to_a
-      
-      expect(strings).to match_array([
-        "fOo bar",
-        "f0o bar",
-        "foO bar",
-        "fo0 bar",
-        "foo bAr",
-        "foo b@r"
-      ])
-    end
-  end
-
-  describe "#mutate" do
-    subject { "foo bar" }
-
-    it "should apply every combination of mutation rules" do
-      strings = subject.mutate(/o/ => ['0'], /a/ => ['@']).to_a
-
-      expect(strings).to match_array([
-        "f0o bar",
-        "fo0 bar",
-        "f00 bar",
-        "foo b@r",
-        "f0o b@r",
-        "fo0 b@r",
-        "f00 b@r"
-      ])
-    end
-  end
-end

data/spec/fuzzer_spec.rb

@@ -1,109 +0,0 @@
-require 'spec_helper'
-require 'ronin/fuzzing/fuzzer'
-
-describe Ronin::Fuzzing::Fuzzer do
-  let(:string) { 'GET /one/two/three' }
-
-  describe "#initialize" do
-    subject { described_class }
-
-    context "patterns" do
-      let(:substitutions) { ['bar'] }
-
-      it "should accept Regexps" do
-        fuzzer = subject.new(/foo/ => substitutions)
-
-        expect(fuzzer.rules).to have_key(/foo/)
-      end
-
-      context "when given Strings" do
-        subject { described_class.new('foo' => substitutions) }
-
-        it "should convert to Regexp" do
-          expect(subject.rules).to have_key(/foo/)
-        end
-      end
-
-      context "when given Symbols" do
-        subject { described_class.new(:word => substitutions) }
-
-        it "should lookup the Ronin::Support::Text::Patterns constant" do
-          expect(subject.rules).to have_key(Ronin::Support::Text::Patterns::WORD)
-        end
-      end
-
-      context "otherwise" do
-        it "should raise a TypeError" do
-          expect {
-            subject.new(Object.new => substitutions)
-          }.to raise_error(TypeError)
-        end
-      end
-    end
-
-    context "substitutions" do
-      let(:pattern) { /foo/ }
-
-      it "should accept Enumerable values" do
-        fuzzer = subject.new(pattern => ['bar'])
-
-        expect(fuzzer.rules[pattern]).to eq(['bar'])
-      end
-
-      context "when given Symbols" do
-        subject { described_class.new(pattern => :bad_strings) }
-
-        it "should map to an Enumerator for a Fuzzing method" do
-          expect(subject.rules[pattern]).to be_kind_of(Enumerable)
-        end
-      end
-
-      context "otherwise" do
-        it "should raise a TypeError" do
-          expect {
-            subject.new(pattern => Object.new)
-          }.to raise_error(TypeError)
-        end
-      end
-    end
-  end
-
-  describe "#each" do
-    let(:string) { "foo bar" }
-
-    subject { described_class.new(/o/ => ['O', '0'], /a/ => ['A', '@']) }
-
-    it "should apply each fuzzing rule individually" do
-      expect(subject.each(string).to_a).to match_array([
-        "fOo bar",
-        "f0o bar",
-        "foO bar",
-        "fo0 bar",
-        "foo bAr",
-        "foo b@r"
-      ])
-    end
-
-    context "when mutations contain Integers" do
-      subject { described_class.new(/o/ => [48]) }
-
-      it "should convert them to characters" do
-        expect(subject.each(string).to_a).to match_array([
-          "f0o bar",
-          "fo0 bar"
-        ])
-      end
-    end
-
-    context "when mutations contain Procs" do
-      subject { described_class.new(/o/ => [lambda { |str| str.upcase }]) }
-
-      it "should call them with the matched String" do
-        expect(subject.each(string).to_a).to match_array([
-          "fOo bar",
-          "foO bar"
-        ])
-      end
-    end
-  end
-end

data/spec/fuzzing_spec.rb

@@ -1,24 +0,0 @@
-require 'spec_helper'
-require 'ronin/fuzzing'
-
-describe Ronin::Fuzzing do
-  describe "[]" do
-    let(:method) { :bad_strings }
-
-    it "should return Enumerators for fuzzing methods" do
-      expect(subject[method]).to be_kind_of(Enumerable)
-    end
-
-    it "should raise NoMethodError for unknown methods" do
-      expect {
-        subject[:foo]
-      }.to raise_error(NoMethodError)
-    end
-
-    it "should not allow accessing inherited methods" do
-      expect {
-        subject[:instance_eval]
-      }.to raise_error(NoMethodError)
-    end
-  end
-end

data/spec/mutator_spec.rb

@@ -1,112 +0,0 @@
-require 'spec_helper'
-require 'ronin/fuzzing/mutator'
-
-describe Ronin::Fuzzing::Mutator do
-  let(:string) { 'GET /one/two/three' }
-
-  describe "#initialize" do
-    subject { described_class }
-
-    context "patterns" do
-      let(:substitutions) { ['bar'] }
-
-      it "should accept Regexps" do
-        fuzzer = subject.new(/foo/ => substitutions)
-
-        expect(fuzzer.rules).to have_key(/foo/)
-      end
-
-      context "when given Strings" do
-        subject { described_class.new('foo' => substitutions) }
-
-        it "should convert to Regexp" do
-          expect(subject.rules).to have_key(/foo/)
-        end
-      end
-
-      context "when given Symbols" do
-        subject { described_class.new(:word => substitutions) }
-
-        it "should lookup the Ronin::Support::Text::Patterns constant" do
-          expect(subject.rules).to have_key(Ronin::Support::Text::Patterns::WORD)
-        end
-      end
-
-      context "otherwise" do
-        it "should raise a TypeError" do
-          expect {
-            subject.new(Object.new => substitutions)
-          }.to raise_error(TypeError)
-        end
-      end
-    end
-
-    context "mutations" do
-      let(:pattern) { /foo/ }
-
-      it "should accept Enumerable values" do
-        fuzzer = subject.new(pattern => ['bar'])
-
-        expect(fuzzer.rules[pattern]).to eq(['bar'])
-      end
-
-      context "when given Symbols" do
-        subject { described_class.new(pattern => :bad_strings) }
-
-        it "should map to an Enumerator for a Fuzzing method" do
-          expect(subject.rules[pattern]).to be_kind_of(Enumerable)
-        end
-      end
-
-      context "otherwise" do
-        it "should raise a TypeError" do
-          expect {
-            subject.new(pattern => Object.new)
-          }.to raise_error(TypeError)
-        end
-      end
-    end
-  end
-
-  describe "#each" do
-    let(:string) { "foo bar" }
-
-    subject { described_class.new(/o/ => ['0'], /a/ => ['@']) }
-
-    it "should apply every combination of mutation rules" do
-      expect(subject.each(string).to_a).to match_array([
-        "f0o bar",
-        "fo0 bar",
-        "f00 bar",
-        "foo b@r",
-        "f0o b@r",
-        "fo0 b@r",
-        "f00 b@r"
-      ])
-    end
-
-    context "when mutations contain Integers" do
-      subject { described_class.new(/o/ => [48]) }
-
-      it "should convert them to characters" do
-        expect(subject.each(string).to_a).to match_array([
-          "f0o bar",
-          "fo0 bar",
-          "f00 bar"
-        ])
-      end
-    end
-
-    context "when mutations contain Procs" do
-      subject { described_class.new(/o/ => [lambda { |str| str.upcase }]) }
-
-      it "should call them with the matched String" do
-        expect(subject.each(string).to_a).to match_array([
-          "fOo bar",
-          "foO bar",
-          "fOO bar"
-        ])
-      end
-    end
-  end
-end

data/spec/repeater_spec.rb

@@ -1,57 +0,0 @@
-require 'spec_helper'
-require 'ronin/fuzzing/repeater'
-
-describe Ronin::Fuzzing::Repeater do
-  describe "#initialize" do
-    subject { described_class }
-
-    context "when lengths is an Integer" do
-      it "should coerce lengths to an Enumerable" do
-        repeator = subject.new(10)
-
-        expect(repeator.lengths).to be_kind_of(Enumerable)
-      end
-    end
-
-    context "when lengths is not Enumerable or an Integer" do
-      it "should raise a TypeError" do
-        expect {
-          subject.new(Object.new)
-        }.to raise_error(TypeError)
-      end
-    end
-  end
-
-  describe "#each" do
-    let(:repeatable) { 'A' }
-
-    context "when lengths was an Integer" do
-      let(:length) { 10 }
-
-      subject { described_class.new(length) }
-
-      it "should yield one repeated value" do
-        values = subject.each(repeatable).to_a
-        
-        expect(values).to eq([repeatable * length])
-      end
-    end
-
-    context "when lengths was Enumerable" do
-      let(:lengths) { (1..4) }
-
-      subject { described_class.new(lengths) }
-
-      it "should yield repeated values for each length" do
-        values = subject.each(repeatable).to_a
-
-        expect(values).to eq([
-          repeatable * 1,
-          repeatable * 2,
-          repeatable * 3,
-          repeatable * 4
-        ])
-      end
-    end
-  end
-end

data/spec/spec_helper.rb

@@ -1,4 +0,0 @@
-require 'rspec'
-require 'simplecov'
-
-SimpleCov.start

data/spec/template_spec.rb

@@ -1,54 +0,0 @@
-require 'spec_helper'
-require 'ronin/fuzzing/template'
-
-describe Ronin::Fuzzing::Template do
-  subject { described_class }
-
-  it "should generate Strings from CharSets" do
-    strings = subject.new([:lowercase_hexadecimal, :numeric]).to_a
-
-    expect(strings.grep(/^[0-9a-f][0-9]$/)).to eq(strings)
-  end
-
-  it "should generate Strings from lengths of CharSets" do
-    strings = subject.new([[:numeric, 2]]).to_a
-
-    expect(strings.grep(/^[0-9]{2}$/)).to eq(strings)
-  end
-
-  it "should generate Strings from varying lengths of CharSets" do
-    strings = subject.new([[:numeric, 1..2]]).to_a
-
-    expect(strings.grep(/^[0-9]{1,2}$/)).to eq(strings)
-  end
-
-  it "should generate Strings from custom CharSets" do
-    strings = subject.new([[%w[a b c], 2]]).to_a
-
-    expect(strings.grep(/^[abc]{2}$/)).to eq(strings)
-  end
-
-  it "should generate Strings containing known Strings" do
-    strings = subject.new(['foo', [%w[a b c], 2]]).to_a
-
-    expect(strings.grep(/^foo[abc]{2}$/)).to eq(strings)
-  end
-
-  it "should raise a TypeError for non String, Symbol, Enumerable CharSets" do
-    expect {
-      subject.new([[Object.new, 2]]).to_a
-    }.to raise_error(TypeError)
-  end
-
-  it "should raise an ArgumentError for unknown CharSets" do
-    expect {
-      subject.new([[:foo_bar, 2]]).to_a
-    }.to raise_error(ArgumentError)
-  end
-
-  it "should raise a TypeError for non Integer,Array,Range lengths" do
-    expect {
-      subject.new([[:numeric, 'foo']]).to_a
-    }.to raise_error(TypeError)
-  end
-end