ruby-feroxbuster 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 93982d828d9029176f21dc60dc00bcc6d58ee980a4c52d37afa18cea4fd2fe3e
+  data.tar.gz: b1225c989137297136368816c9547dca26a38412e166d7f675794ccf91475c3a
+SHA512:
+  metadata.gz: d7d98099731b1aa773f378f676bd24a5b09618d6cdd30cbbf324ea9641d04b866e418ab3d1c1daed00208f24341e15b3e3ffb204c63b820955cb2077c877085d
+  data.tar.gz: febaa1f1c1011743478b626e4395a3f6a212185f4e6712ab053f06834a8b86eb04a316d1832393d162088779c4bd84614e19fb07c2a4783b62c22a8c73deffb2

data/.document

@@ -0,0 +1,3 @@
+-
+ChangeLog.md
+LICENSE.txt

data/.github/workflows/ruby.yml

@@ -0,0 +1,27 @@
+name: CI
+
+on: [ push, pull_request ]
+
+jobs:
+  tests:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby:
+          - 2.6
+          - 2.7
+          - 3.0
+          - jruby
+          - truffleruby
+    name: Ruby ${{ matrix.ruby }}
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+      - name: Install dependencies
+        run: bundle install --jobs 4 --retry 3
+      - name: Run tests
+        run: bundle exec rake test

data/.gitignore

@@ -0,0 +1,12 @@
+/Gemfile.lock
+/coverage
+/doc
+/pkg
+/.yardoc
+.DS_Store
+*.db
+*.log
+*.swp
+*~
+*.gem
+*.state

data/.rspec

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

data/.yardopts

@@ -0,0 +1 @@
+--markup markdown --title 'Ruby Feroxbuster Documentation' --protected

data/ChangeLog.md

@@ -0,0 +1,10 @@
+### 0.1.0 / 2021-04-22
+
+* Initial release:
+  * Added {Feroxbuster::Command}.
+  * Added {Feroxbuster::OutputFile}.
+  * Added {Feroxbuster::Parsers::JSON}.
+  * Added {Feroxbuster::Parsers::TXT}.
+  * Added {Feroxbuster::Response}.
+  * Added {Feroxbuster::Statistics}.
+

data/Gemfile

@@ -0,0 +1,17 @@
+source 'https://rubygems.org'
+
+gemspec
+
+# gem 'command_mapper', '~> 0.2', github: 'postmodern/command_mapper.rb'
+
+group :development do
+  gem 'rake'
+  gem 'rubygems-tasks', '~> 0.2'
+  gem 'rspec',          '~> 3.0'
+  gem 'simplecov',      '~> 0.7'
+
+  gem 'kramdown'
+  gem 'redcarpet',       platform: :mri
+  gem 'yard',           '~> 0.9'
+  gem 'yard-spellcheck', require: false
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2022 Hal Brodigan
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,87 @@
+# ruby-feroxbuster
+
+[![CI](https://github.com/postmodern/ruby-feroxbuster/actions/workflows/ruby.yml/badge.svg)](https://github.com/postmodern/ruby-gobuster/actions/workflows/ruby.yml)
+[![Gem Version](https://badge.fury.io/rb/ruby-feroxbuster.svg)](https://badge.fury.io/rb/ruby-gobuster)
+
+* [Source](https://github.com/postmodern/ruby-feroxbuster/)
+* [Issues](https://github.com/postmodern/ruby-feroxbuster/issues)
+* [Documentation](http://rubydoc.info/gems/ruby-feroxbuster/frames)
+
+## Description
+
+A Ruby interface to [feroxbuster], a simple, fast, recursive content discovery
+tool written in Rust.
+
+## Features
+
+* Provides a [Ruby interface][Feroxbuster::Command] for running the
+  `feroxbuster` command.
+* Supports [parsing][Feroxbuster::OutputFile] `feroxbuster` `.txt` and `.json`
+  output files.
+
+[Feroxbuster::Command]: https://rubydoc.info/gems/ruby-feroxbuster/Feroxbuster/Command
+[Feroxbuster::OutputFile]: https://rubydoc.info/gems/ruby-amass/Feroxbuster/OutputFile
+
+## Examples
+
+Run `feroxbuster --wordlist /path/to/wordlist.txt --url https://example.com` from Ruby:
+
+```ruby
+require 'feroxbuster/command'
+
+Feroxbuster::Command.run(wordlist: '/path/to/wordlist.txt', url: 'https://example.com')
+```
+
+Parser an `feroxbuster` JSON file:
+
+```ruby
+require 'feroxbuster/output_file'
+
+output_file = Feroxbuster::OutputFile.new('/path/to/feroxbuster.json')
+output_file.each do |object|
+  p object
+end
+```
+
+```
+#<Feroxbuster::Response:0x000056472fab3390 @url="https://github.com/test", @original_url="https://github.com", @path="/test", @wildcard=false, @status=200, @method="GET", @content_length=0, @line_count=2010, @word_count=11253, @headers={"permissions-policy"=>"interest-cohort=()", "accept-ranges"=>"bytes", "referrer-policy"=>"origin-when-cross-origin, strict-origin-when-cross-origin", "x-content-type-options"=>"nosniff", "cache-control"=>"max-age=0, private, must-revalidate", "expect-ct"=>"max-age=2592000, report-uri=\"https://api.github.com/_private/browser/errors\"", "server"=>"GitHub.com", "x-github-request-id"=>"85A8:0E10:20B03E:27719A:6260B1D5", "transfer-encoding"=>"chunked", "date"=>"Thu, 21 Apr 2022 01:22:16 GMT", "strict-transport-security"=>"max-age=31536000; includeSubdomains; preload", "etag"=>"W/\"7c98cb0440eb94eddcfd360497fae419\"", "x-frame-options"=>"deny", "content-security-policy"=>"default-src 'none'; base-uri 'self'; block-all-mixed-content; child-src github.com/assets-cdn/worker/ gist.github.com/assets-cdn/worker/; connect-src 'self' uploads.github.com objects-origin.githubusercontent.com www.githubstatus.com collector.github.com raw.githubusercontent.com api.github.com github-cloud.s3.amazonaws.com github-production-repository-file-5c1aeb.s3.amazonaws.com github-production-upload-manifest-file-7fdce7.s3.amazonaws.com github-production-user-asset-6210df.s3.amazonaws.com cdn.optimizely.com logx.optimizely.com/v1/events translator.github.com *.actions.githubusercontent.com wss://*.actions.githubusercontent.com online.visualstudio.com/api/v1/locations github-production-repository-image-32fea6.s3.amazonaws.com github-production-release-asset-2e65be.s3.amazonaws.com insights.github.com wss://alive.github.com; font-src github.githubassets.com; form-action 'self' github.com gist.github.com objects-origin.githubusercontent.com; frame-ancestors 'none'; frame-src render.githubusercontent.com viewscreen.githubusercontent.com notebooks.githubusercontent.com; img-src 'self' data: github.githubassets.com identicons.github.com github-cloud.s3.amazonaws.com secured-user-images.githubusercontent.com/ *.githubusercontent.com; manifest-src 'self'; media-src github.com user-images.githubusercontent.com/; script-src github.githubassets.com; style-src 'unsafe-inline' github.githubassets.com; worker-src github.com/assets-cdn/worker/ gist.github.com/assets-cdn/worker/", "x-xss-protection"=>"0", "set-cookie"=>"logged_in=no; Path=/; Domain=github.com; Expires=Fri, 21 Apr 2023 01:22:29 GMT; HttpOnly; Secure; SameSite=Lax", "vary"=>"X-Requested-With, X-PJAX-Container, Accept-Encoding, Accept, X-Requested-With", "content-type"=>"text/html; charset=utf-8"}, @extension="">
+#<Feroxbuster::Response:0x000056472fab20f8 @url="https://github.com/dev", @original_url="https://github.com", @path="/dev", @wildcard=false, @status=200, @method="GET", @content_length=0, @line_count=2067, @word_count=11308, @headers={"date"=>"Thu, 21 Apr 2022 01:22:17 GMT", "cache-control"=>"max-age=0, private, must-revalidate", "content-security-policy"=>"default-src 'none'; base-uri 'self'; block-all-mixed-content; child-src github.com/assets-cdn/worker/ gist.github.com/assets-cdn/worker/; connect-src 'self' uploads.github.com objects-origin.githubusercontent.com www.githubstatus.com collector.github.com raw.githubusercontent.com api.github.com github-cloud.s3.amazonaws.com github-production-repository-file-5c1aeb.s3.amazonaws.com github-production-upload-manifest-file-7fdce7.s3.amazonaws.com github-production-user-asset-6210df.s3.amazonaws.com cdn.optimizely.com logx.optimizely.com/v1/events translator.github.com *.actions.githubusercontent.com wss://*.actions.githubusercontent.com online.visualstudio.com/api/v1/locations github-production-repository-image-32fea6.s3.amazonaws.com github-production-release-asset-2e65be.s3.amazonaws.com insights.github.com wss://alive.github.com; font-src github.githubassets.com; form-action 'self' github.com gist.github.com objects-origin.githubusercontent.com; frame-ancestors 'none'; frame-src render.githubusercontent.com viewscreen.githubusercontent.com notebooks.githubusercontent.com; img-src 'self' data: github.githubassets.com identicons.github.com github-cloud.s3.amazonaws.com secured-user-images.githubusercontent.com/ *.githubusercontent.com; manifest-src 'self'; media-src github.com user-images.githubusercontent.com/; script-src github.githubassets.com; style-src 'unsafe-inline' github.githubassets.com; worker-src github.com/assets-cdn/worker/ gist.github.com/assets-cdn/worker/", "set-cookie"=>"logged_in=no; Path=/; Domain=github.com; Expires=Fri, 21 Apr 2023 01:22:29 GMT; HttpOnly; Secure; SameSite=Lax", "permissions-policy"=>"interest-cohort=()", "x-frame-options"=>"deny", "server"=>"GitHub.com", "accept-ranges"=>"bytes", "etag"=>"W/\"3ca853f280bb864544f7842cdaa124e5\"", "vary"=>"X-Requested-With, X-PJAX-Container, Accept-Encoding, Accept, X-Requested-With", "referrer-policy"=>"origin-when-cross-origin, strict-origin-when-cross-origin", "x-github-request-id"=>"85AC:2947:2319C4:29E4C8:6260B1D5", "transfer-encoding"=>"chunked", "expect-ct"=>"max-age=2592000, report-uri=\"https://api.github.com/_private/browser/errors\"", "x-content-type-options"=>"nosniff", "content-type"=>"text/html; charset=utf-8", "x-xss-protection"=>"0", "strict-transport-security"=>"max-age=31536000; includeSubdomains; preload"}, @extension="">
+#<Feroxbuster::Response:0x000056472fab0f28 @url="https://github.com/www", @original_url="https://github.com", @path="/www", @wildcard=false, @status=200, @method="GET", @content_length=0, @line_count=1813, @word_count=10399, @headers={"content-type"=>"text/html; charset=utf-8", "accept-ranges"=>"bytes", "date"=>"Thu, 21 Apr 2022 01:22:16 GMT", "transfer-encoding"=>"chunked", "vary"=>"X-Requested-With, X-PJAX-Container, Accept-Encoding, Accept, X-Requested-With", "x-xss-protection"=>"0", "x-github-request-id"=>"85B4:4678:28A012:2F9830:6260B1D5", "content-security-policy"=>"default-src 'none'; base-uri 'self'; block-all-mixed-content; child-src github.com/assets-cdn/worker/ gist.github.com/assets-cdn/worker/; connect-src 'self' uploads.github.com objects-origin.githubusercontent.com www.githubstatus.com collector.github.com raw.githubusercontent.com api.github.com github-cloud.s3.amazonaws.com github-production-repository-file-5c1aeb.s3.amazonaws.com github-production-upload-manifest-file-7fdce7.s3.amazonaws.com github-production-user-asset-6210df.s3.amazonaws.com cdn.optimizely.com logx.optimizely.com/v1/events translator.github.com *.actions.githubusercontent.com wss://*.actions.githubusercontent.com online.visualstudio.com/api/v1/locations github-production-repository-image-32fea6.s3.amazonaws.com github-production-release-asset-2e65be.s3.amazonaws.com insights.github.com wss://alive.github.com; font-src github.githubassets.com; form-action 'self' github.com gist.github.com objects-origin.githubusercontent.com; frame-ancestors 'none'; frame-src render.githubusercontent.com viewscreen.githubusercontent.com notebooks.githubusercontent.com; img-src 'self' data: github.githubassets.com identicons.github.com github-cloud.s3.amazonaws.com secured-user-images.githubusercontent.com/ *.githubusercontent.com; manifest-src 'self'; media-src github.com user-images.githubusercontent.com/; script-src github.githubassets.com; style-src 'unsafe-inline' github.githubassets.com; worker-src github.com/assets-cdn/worker/ gist.github.com/assets-cdn/worker/", "referrer-policy"=>"origin-when-cross-origin, strict-origin-when-cross-origin", "etag"=>"W/\"e03d055bf6b701eb6ecf1fa7c1a137f0\"", "permissions-policy"=>"interest-cohort=()", "strict-transport-security"=>"max-age=31536000; includeSubdomains; preload", "x-frame-options"=>"deny", "set-cookie"=>"logged_in=no; Path=/; Domain=github.com; Expires=Fri, 21 Apr 2023 01:22:29 GMT; HttpOnly; Secure; SameSite=Lax", "expect-ct"=>"max-age=2592000, report-uri=\"https://api.github.com/_private/browser/errors\"", "server"=>"GitHub.com", "cache-control"=>"max-age=0, private, must-revalidate", "x-content-type-options"=>"nosniff"}, @extension="">
+#<Feroxbuster::Response:0x000056472fabbcc0 @url="https://github.com/", @original_url="https://github.com", @path="/", @wildcard=false, @status=200, @method="GET", @content_length=0, @line_count=2596, @word_count=13002, @headers={"cache-control"=>"max-age=0, private, must-revalidate", "server"=>"GitHub.com", "set-cookie"=>"logged_in=no; Path=/; Domain=github.com; Expires=Fri, 21 Apr 2023 01:22:29 GMT; HttpOnly; Secure; SameSite=Lax", "permissions-policy"=>"interest-cohort=()", "vary"=>"X-PJAX, X-PJAX-Container, Accept-Language, Accept-Encoding, Accept, X-Requested-With", "content-security-policy"=>"default-src 'none'; base-uri 'self'; block-all-mixed-content; child-src github.com/assets-cdn/worker/ gist.github.com/assets-cdn/worker/; connect-src 'self' uploads.github.com objects-origin.githubusercontent.com www.githubstatus.com collector.github.com raw.githubusercontent.com api.github.com github-cloud.s3.amazonaws.com github-production-repository-file-5c1aeb.s3.amazonaws.com github-production-upload-manifest-file-7fdce7.s3.amazonaws.com github-production-user-asset-6210df.s3.amazonaws.com cdn.optimizely.com logx.optimizely.com/v1/events translator.github.com *.actions.githubusercontent.com wss://*.actions.githubusercontent.com online.visualstudio.com/api/v1/locations github-production-repository-image-32fea6.s3.amazonaws.com github-production-release-asset-2e65be.s3.amazonaws.com insights.github.com wss://alive.github.com github.githubassets.com; font-src github.githubassets.com; form-action 'self' github.com gist.github.com objects-origin.githubusercontent.com; frame-ancestors 'none'; frame-src render.githubusercontent.com viewscreen.githubusercontent.com notebooks.githubusercontent.com; img-src 'self' data: github.githubassets.com identicons.github.com github-cloud.s3.amazonaws.com secured-user-images.githubusercontent.com/ *.githubusercontent.com customer-stories-feed.github.com spotlights-feed.github.com; manifest-src 'self'; media-src github.com user-images.githubusercontent.com/ github.githubassets.com; script-src github.githubassets.com; style-src 'unsafe-inline' github.githubassets.com; worker-src github.com/assets-cdn/worker/ gist.github.com/assets-cdn/worker/", "x-xss-protection"=>"0", "expect-ct"=>"max-age=2592000, report-uri=\"https://api.github.com/_private/browser/errors\"", "x-github-request-id"=>"85B2:4670:5B88C:BE8AA:6260B1D5", "date"=>"Thu, 21 Apr 2022 01:22:22 GMT", "strict-transport-security"=>"max-age=31536000; includeSubdomains; preload", "transfer-encoding"=>"chunked", "x-content-type-options"=>"nosniff", "etag"=>"W/\"b1bb181559a6360603ad7f0ed22c198c\"", "accept-ranges"=>"bytes", "x-frame-options"=>"deny", "referrer-policy"=>"origin-when-cross-origin, strict-origin-when-cross-origin", "content-type"=>"text/html; charset=utf-8", "content-language"=>"en-US"}, @extension="">
+#<Feroxbuster::Statistics:0x000056472fabacd0 @timeouts=0, @requests=18, @expected_per_scan=6, @total_expected=12, @errors=0, @successes=12, @redirects=0, @client_errors=6, @server_errors=0, @total_scans=2, @initial_targets=0, @links_extracted=0, @extensions_collected=0, @status_200s=12, @status_301s=0, @status_302s=0, @status_401s=0, @status_403s=0, @status_429s=0, @status_500s=0, @status_503s=0, @status_504s=0, @status_508s=0, @wildcards_filtered=0, @responses_filtered=0, @resources_discovered=4, @url_format_errors=0, @redirection_errors=0, @connection_errors=0, @request_errors=0, @directory_scan_times=[0.434531853, 0.434228035], @total_runtime=[1.6527268240000001]>
+```
+
+## Requirements
+
+* [ruby] >= 2.0.0
+* [feroxbuster] >= 2.7.0
+* [command_mapper] ~> 0.2, >= 0.2.1
+
+[ruby]: https://www.ruby-lang.org/
+[command_mapper]: https://github.com/postmodern/command_mapper.rb#readme
+
+## Install
+
+```shell
+$ gem install ruby-feroxbuster
+```
+
+### gemspec
+
+```ruby
+gemspec.add_dependency 'ruby-feroxbuster', '~> 0.1'
+```
+
+### Gemfile
+
+```ruby
+gem 'ruby-feroxbuster', '~> 0.1'
+```
+
+## License
+
+Copyright (c) 2022 Hal Brodigan
+
+See {file:LICENSE.txt} for license information.
+
+[feroxbuster]: https://github.com/epi052/feroxbuster#readme

data/Rakefile

@@ -0,0 +1,23 @@
+# encoding: utf-8
+
+require 'rubygems'
+
+begin
+  require 'bundler/setup'
+rescue LoadError => e
+  warn e.message
+  warn "Run `gem install bundler` to install Bundler"
+  exit -1
+end
+
+require 'rubygems/tasks'
+Gem::Tasks.new
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new
+task :test    => :spec
+task :default => :spec
+
+require 'yard'
+YARD::Rake::YardocTask.new
+task :doc => :yard

data/gemspec.yml

@@ -0,0 +1,28 @@
+name: ruby-feroxbuster
+summary: A Ruby interface to feroxbuster.
+description:
+  A Ruby interface to feroxbuster, a simple, fast, recursive content discovery
+  tool written in Rust.
+
+license: MIT
+authors: Postmodern
+email: postmodern.mod3@gmail.com
+homepage: https://github.com/postmodern/ruby-feroxbuster#readme
+has_yard: true
+
+metadata:
+  documentation_uri: https://rubydoc.info/gems/ruby-feroxbuster
+  source_code_uri:   https://github.com/postmodern/ruby-feroxbuster
+  bug_tracker_uri:   https://github.com/postmodern/ruby-feroxbuster/issues
+  changelog_uri:     https://github.com/postmodern/ruby-feroxbuster/blob/master/ChangeLog.md
+  rubygems_mfa_required: 'true'
+
+required_ruby_version: ">= 2.0.0"
+
+requirements: feroxbuster >= 2.7.0
+
+dependencies:
+  command_mapper: ~> 0.2, >= 0.2.1
+
+development_dependencies:
+  bundler: ~> 2.0

data/lib/feroxbuster/command.rb

@@ -0,0 +1,134 @@
+require 'command_mapper/command'
+
+module Feroxbuster
+  class Command < CommandMapper::Command
+
+    #
+    # Represents the type for the `--time-limit` option.
+    #
+    # @api private
+    #
+    class TimeSpec < CommandMapper::Types::Str
+
+      #
+      # Validates the given value.
+      #
+      # @param [Object] value
+      #   The given value to validate.
+      #
+      # @return [true, (false, String)]
+      #   Returns true if the value is considered valid, or false and a
+      #   validation message if the value is not valid.
+      #
+      def validate(value)
+        valid, message = super(value)
+
+        unless valid
+          return [valid, message]
+        end
+
+        value = value.to_s
+
+        unless value =~ /\A\d+(?:m|s|ms|ns)\z/
+          return [false, "must be a number and end with 'm', 's', 'ms', or 'ns'"]
+        end
+
+        return true
+      end
+
+    end
+
+    #
+    # Represents an HTTP status code (100 - 599).
+    #
+    # @api private
+    #
+    class StatusCode < CommandMapper::Types::Num
+
+      def initialize
+        super(range: 100..599)
+      end
+
+    end
+
+    command 'feroxbuster' do
+      option '--help'
+      option '--version'
+
+      # Target selection:
+      option '--resume-from', value: {type: InputFile.new}
+      option '--stdin'
+      option '--url', value: true
+
+      # Composite settings:
+      option '--burp'
+      option '--burp-replay'
+      option '--smart'
+      option '--thorough'
+
+      # Proxy settings:
+      option '--proxy', value: true
+      option '--replay-proxy', value: true
+      option '--replay-codes', value: {type: StatusCode.new}, repeats: true
+
+      # Request settings:
+      option '--user-agent', value: true
+      option '--random-agent'
+      option '--cookies', value: true, repeats: true
+      option '--data', value: true
+      option '--add-slash'
+      option '--headers', value: true, repeats: true
+      option '--methods', name: :http_methods, value: true, repeats: true
+      option '--query', value: true, repeats: true
+
+      # Request filters:
+      option '--dont-scan', value: true, repeats: true
+
+      # Response filters:
+      option '--filter-status', value: {type: StatusCode.new}, repeats: true
+      option '--filter-similar-to', value: true, repeats: true
+      option '--filter-lines', value: true, repeats: true
+      option '--status-codes', value: {type: StatusCode.new},
+                               repeats: true
+      option '--filter-size', value: {type: Num.new}, repeats: true
+      option '--filter-words', value: {type: Num.new}, repeats: true
+      option '--filter-regex', value: true, repeats: true
+
+      # Client settings:
+      option '--insecure'
+      option '--redirects'
+      option '--timeout', value: {type: Num.new}
+
+      # Scan settings:
+      option '--auto-bail'
+      option '--auto-tune'
+      option '--depth', value: {type: Num.new}
+      option '--dont-filter'
+      option '--extract-links'
+      option '--force-recursion'
+      option '--scan-list', value: {type: Num.new}
+      option '--no-recursion'
+      option '--parallel', value: {type: Num.new}
+      option '--rate-limit', value: {type: Num.new}
+      option '--threads', value: {type: Num.new}
+      option '--time-limit', value: {type: TimeSpec.new}
+      option '--wordlist', value: {type: InputFile.new}
+
+      # Dynamic collection settings:
+      option '--collect-backups'
+      option '--collect-extensions'
+      option '--collect-words'
+      option '--dont-collect', value: true, repeats: true
+
+      # Output settings:
+      option '--debug-log', value: true
+      option '--json'
+      option '--no-state'
+      option '--output', value: true
+      option '--quiet'
+      option '--silent'
+      option '--verbosity'
+    end
+
+  end
+end

data/lib/feroxbuster/output_file.rb

@@ -0,0 +1,124 @@
+require 'feroxbuster/parsers/json'
+require 'feroxbuster/parsers/txt'
+
+module Feroxbuster
+  #
+  # Represents either a `.json` or `.txt` output file.
+  #
+  # ## Example
+  #
+  #     require 'feroxbuster/output_file'
+  #     
+  #     output_file = Feroxbuster::OutputFile.new('/path/to/feroxbuster.json')
+  #     output_file.each do |response|
+  #       p response
+  #     end
+  #
+  # @api public
+  #
+  class OutputFile
+
+    # Mapping of formats to parsers.
+    #
+    # @api semipublic
+    PARSERS = {
+      json: Parsers::JSON,
+      txt:  Parsers::TXT
+    }
+
+    # The path to the output file.
+    #
+    # @return [String]
+    attr_reader :path
+
+    # The format of the output file.
+    #
+    # @return [:json, :txt]
+    attr_reader :format
+
+    # The parser for the output file format.
+    #
+    # @return [Parsers::JSON, Parsers::TXT]
+    #
+    # @api private
+    attr_reader :parser
+
+    #
+    # Initializes the output file.
+    #
+    # @param [String] path
+    #   The path to the output file.
+    #
+    # @param [:json, :txt] format
+    #   The optional format of the output file. If not given, it will be
+    #   inferred by the path's file extension.
+    #
+    def initialize(path, format: self.class.infer_format(path))
+      @path   = File.expand_path(path)
+      @format = format
+
+      @parser = PARSERS.fetch(format) do
+        raise(ArgumentError,"unrecognized file type: #{@path.inspect}")
+      end
+    end
+
+    # Mapping of file extensions to formats
+    #
+    # @api semipublic
+    FILE_FORMATS = {
+      '.json' => :json,
+      '.txt'  => :txt
+    }
+
+    #
+    # Infers the format from the output file's extension name.
+    #
+    # @param [String] path
+    #   The path to the output file.
+    #
+    # @return [:json, :txt]
+    #   The output format inferred from the file's extension name.
+    #
+    # @raise [ArgumentError]
+    #   The output format could not be inferred from the file's name.
+    #
+    # @api semipublic
+    #
+    def self.infer_format(path)
+      FILE_FORMATS.fetch(File.extname(path)) do
+        raise(ArgumentError,"could not infer format of #{path}")
+      end
+    end
+
+    #
+    # Parses the contents of the output file.
+    #
+    # @yield [hostname]
+    #   The given block will be passed each parsed hostname.
+    #
+    # @yieldparam [Hostname] hostname
+    #   A parsed hostname from the output file.
+    #
+    # @return [Enumerator]
+    #   If no block is given, an Enumerator object will be returned.
+    #
+    def each(&block)
+      return enum_for(__method__) unless block
+
+      File.open(@path) do |file|
+        @parser.parse(file,&block)
+      end
+    end
+
+    #
+    # Converts the output file to a String.
+    #
+    # @return [String]
+    #   The path to the output file.
+    #
+    def to_s
+      @path
+    end
+
+  end
+end

data/lib/feroxbuster/parsers/json.rb

@@ -0,0 +1,121 @@
+require 'feroxbuster/response'
+require 'feroxbuster/statistics'
+
+require 'json'
+
+module Feroxbuster
+  module Parsers
+    #
+    # Parses single-line JSON hashes.
+    #
+    # @api semipublic
+    #
+    module JSON
+      #
+      # Parses a single-line of JSON.
+      #
+      # @param [IO] io
+      #   The IO stream to parse.
+      #
+      # @yield [data]
+      #   The given block will be passed each parsed data.
+      #
+      # @yieldparam [Response, Statistics] data
+      #   The parsed data. {Statistics} will be yielded last.
+      #
+      # @return [Enumerator]
+      #   If no block is given, an Enumerator will be returned.
+      #
+      def self.parse(io)
+        return enum_for(__method__,io) unless block_given?
+
+        io.each_line do |line|
+          line.chomp!
+          json = ::JSON.parse(line)
+
+          case json["type"]
+          when "response"
+            yield map_response(json)
+          when "statistics"
+            yield map_statistics(json)
+          else
+            raise(NotImplementedError,"unsupported JSON type: #{json['type']}")
+          end
+        end
+      end
+
+      private
+
+      #
+      # Maps a response type JSON Hash to a {Response} object.
+      #
+      # @param [Hash{Symbol => Object}] json
+      #   The parsed JSON Hash.
+      #
+      # @return [Respnse]
+      #   The resulting response object.
+      #
+      def self.map_response(json)
+        Response.new(
+          url:            json['url'],
+          original_url:   json['original_url'],
+          path:           json['path'],
+          wildcard:       json['wildcard'],
+          status:         json['status'],
+          method:         json['method'],
+          content_length: json['content_length'],
+          line_count:     json['line_count'],
+          word_count:     json['word_count'],
+          headers:        json['headers'],
+          extension:      json['extension']
+        )
+      end
+
+      #
+      # Maps a statistics type JSON Hash to a {Statistics} object.
+      #
+      # @param [Hash{Symbol => Object}] json
+      #   The parsed JSON Hash.
+      #
+      # @return [Statistics]
+      #   The resulting statistics object.
+      #
+      def self.map_statistics(json)
+        Statistics.new(
+          timeouts:             json['timeouts'],
+          requests:             json['requests'],
+          expected_per_scan:    json['expected_per_scan'],
+          total_expected:       json['total_expected'],
+          errors:               json['errors'],
+          successes:            json['successes'],
+          redirects:            json['redirects'],
+          client_errors:        json['client_errors'],
+          server_errors:        json['server_errors'],
+          total_scans:          json['total_scans'],
+          initial_targets:      json['initial_targets'],
+          links_extracted:      json['links_extracted'],
+          extensions_collected: json['extensions_collected'],
+          status_200s:          json['status_200s'],
+          status_301s:          json['status_301s'],
+          status_302s:          json['status_302s'],
+          status_401s:          json['status_401s'],
+          status_403s:          json['status_403s'],
+          status_429s:          json['status_429s'],
+          status_500s:          json['status_500s'],
+          status_503s:          json['status_503s'],
+          status_504s:          json['status_504s'],
+          status_508s:          json['status_508s'],
+          wildcards_filtered:   json['wildcards_filtered'],
+          responses_filtered:   json['responses_filtered'],
+          resources_discovered: json['resources_discovered'],
+          url_format_errors:    json['url_format_errors'],
+          redirection_errors:   json['redirection_errors'],
+          connection_errors:    json['connection_errors'],
+          request_errors:       json['request_errors'],
+          directory_scan_times: json['directory_scan_times'],
+          total_runtime:        json['total_runtime']
+        )
+      end
+    end
+  end
+end