API_Fuzzer 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4bfb4ac33d3645e0761c280d9f19a840b699915d
+  data.tar.gz: 41324f4fc3abbcbbb473b377588062a13dcdf9c7
+SHA512:
+  metadata.gz: c37f7f1ee1db7c3c5a5e362e30690f13d48d83edafadb36ebc4e792092d6012c48b1903e7ae578d684b54ddc24ea8d48fc49a324be86d7522bdf4cfea23f57af
+  data.tar.gz: 44c7746344cd9ec5746265757444f46c93f514d71721ce16b68ea41ced33fdf5ed8022fdda881d06b205161e514838231cf01f6ca0ee28aec9e1e0c0795161e5

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.byebug_history

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.12.5

data/API_Fuzzer.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'API_Fuzzer/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "API_Fuzzer"
+  spec.version       = APIFuzzer::VERSION
+  spec.authors       = ["Lalith Rallabhandi"]
+  spec.email         = ["lalithr95@gmail.com"]
+
+  spec.summary       = %q{APIFuzzer gem builds api for finding security issues through a fuzzer}
+  spec.description   = %q{APIFuzzer gem builds api for finding security issues through a fuzzer}
+  spec.homepage      = "https://github.com/lalithr95/API-Fuzzer"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'http', '~> 2.0'
+  spec.add_dependency 'activesupport'
+  spec.add_dependency 'rails', '>= 4.2'
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at lalith.rallabhandi@shopify.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,11 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in API_Fuzzer.gemspec
+
+gem 'http'
+gem 'builder'
+
+group :development do
+  gem 'byebug'
+end
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Lalith Rallabhandi
+
+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,91 @@
+# API Fuzzer
+
+`API_Fuzzer` gem accepts a API request as input and returns vulnerabilities possible in the API. Following are the main check involved in API_Fuzzer gem
+
+- Cross-site scripting vulnerability
+- SQL injection
+- Blind SQL injection
+- XML External entity vulnerability
+- IDOR (in specific cases)
+- API Rate Limiting
+- Open redirect vulnerabilities
+- Information Disclosure flaws
+- Info leakage through headers
+- Cross-site request forgery vulnerability
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'API_Fuzzer'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install API_Fuzzer
+
+## Usage
+
+Run `bin/console`
+
+Lets say you have following endpoint
+
+```
+POST /api/v2/credit_cards/123
+
+Host: test.host.com
+User-Agent: Mozilla Firefox
+Auth: Basic Adnjefnef443nr4jh4h
+{ credit_card: '4242424242424242', expiry: '07/17', cvv: '123', name: 'First name' }
+```
+
+API_Fuzzer module comes with static method `scan` and accepts above request
+```ruby
+require 'API_Fuzzer'
+
+options = {
+  url: 'http://test.host.com/api/v2/credit_cards/123',
+  params: {
+    credit_card: '4242424242424242',
+    expiry: '07/17',
+    cvv: '123',
+    name: 'First name'
+  },
+  method: ['POST'],
+  headers: {
+    'Host' => 'test.host.com',
+    'User-Agent' => 'Mozilla Firefox',
+    'Auth' => 'Basic Adnjefnef443nr4jh4h'
+  }
+}
+vulnerabilities = API_Fuzzer.scan(options)
+```
+`vulnerabilites` is an array of vulnerability, each distinguished with impact type, title and description.
+
+
+Above Ruby code can be painful for writing ruby script for each request. [Fuzzapi](https://github.com/lalithr95/Fuzzapi) is a rails application which integrates and bundles API_Fuzzer and brings UI changes to easily scan API endpoints.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+If you have any issue, we would be happy to help. You can create an issue in repository or contact any of following twitter handles
+@abhijeth, @srini0x00, @lalithr95 
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/API_Fuzzer. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+Copyrights [Fuzzdb](https://github.com/fuzzdb-project/fuzzdb) for fuzzing payloads

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/app/controllers/ping_controller.rb

@@ -0,0 +1,22 @@
+class PingController < ActionController::Base
+  def index
+    @scan = Scan.find(params[:id])
+    @scan.vulnerabilities.create!(
+      status: 'HIGH',
+      class_type: 'Vulnerability',
+      description: "Possible XXE vulnerability in #{@scan.url}",
+      value: body
+    ) if @scan
+    render json: { status: :ok }
+  end
+
+  def pong
+    render json: { status: :ok }
+  end
+
+  private
+
+  def body
+    @scan.parameters.gsub(/\>\s*[a-zA-Z0-9]*\s*\<\//, '>&xxe;<')
+  end
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "API_Fuzzer"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/config/routes.rb

@@ -0,0 +1,4 @@
+API_Fuzzer::Engine.routes.draw do
+  get '/ping/:id' => 'ping#index'
+  get '/ping' => 'ping#pong'
+end

data/lib/API_Fuzzer.rb

@@ -0,0 +1,43 @@
+require 'API_Fuzzer/version'
+require 'API_Fuzzer/header_info'
+require 'API_Fuzzer/resource_info'
+require 'API_Fuzzer/sql_check'
+require 'API_Fuzzer/sql_blind_check'
+require 'API_Fuzzer/xss_check'
+require 'API_Fuzzer/request'
+require 'API_Fuzzer/engine'
+require 'API_Fuzzer/xxe_check'
+require 'API_Fuzzer/redirect_check'
+require 'API_Fuzzer/idor_check'
+require 'API_Fuzzer/rate_limit_check'
+require 'API_Fuzzer/csrf_check'
+require 'API_Fuzzer/privilege_escalation_check'
+
+module API_Fuzzer
+  # Scans all the checks
+  def self.scan(options = {})
+    vulnerabilities = []
+    options.freeze
+
+    vulnerabilities << static_analysis(options)
+    vulnerabilities << API_Fuzzer::XssCheck.scan(options)
+    vulnerabilities << API_Fuzzer::SqlCheck.scan(options)
+    vulnerabilities << API_Fuzzer::SqlBlindCheck.scan(options)
+    vulnerabilities << API_Fuzzer::RedirectCheck.scan(options)
+    vulnerabilities << API_Fuzzer::IdorCheck.scan(options)
+    vulnerabilities << API_Fuzzer::RateLimitCheck.scan(options)
+    vulnerabilities << API_Fuzzer::CsrfCheck.scan(options)
+    vulnerabilities << API_Fuzzer::PrivilegeEscalationCheck.scan(options)
+    API_Fuzzer::XxeCheck.scan(options)
+    vulnerabilities.uniq.flatten
+  end
+
+  def self.static_analysis(options = {})
+    response = API_Fuzzer::Request.send_api_request(url: options[:url], cookies: options[:cookies])
+    issues = []
+
+    issues << API_Fuzzer::ResourceInfo.scan(response)
+    issues << API_Fuzzer::HeaderInfo.scan(response)
+    issues
+  end
+end

data/lib/API_Fuzzer/csrf_check.rb

@@ -0,0 +1,41 @@
+require 'API_Fuzzer/vulnerability'
+require 'API_Fuzzer/error'
+require 'API_Fuzzer/request'
+
+module API_Fuzzer
+  class CsrfCheck
+    VALID_CSRF_PARAMS = ['csrf', 'token', 'authenticity_token', 'csrf_token'].map(&:downcase)
+    VALID_CSRF_HEADERS = ['X-CSRF', 'CSRF-Token'].map(&:downcase)
+    class << self
+      def scan(options = {})
+        @url = options[:url] || nil
+        @params = options[:params] || {}
+        @cookies = options[:cookies] || {}
+        @methods = options[:method] || [:get]
+        @headers = options[:headers] || {}
+        @json = options[:json] || false
+        @vulnerabilities = []
+
+        fuzz_csrf
+        @vulnerabilities.uniq { |vuln| vuln.description }
+      rescue Exception => e
+        Rails.logger.info e.message
+      end
+
+      def fuzz_csrf
+        @vulnerabilities << API_Fuzzer::Vulnerability.new(
+          type: 'MEDIUM',
+          value: 'No Cross-site request forgery protection found in API',
+          description: "Cross-site request forgery vulnerability in GET #{@url}"
+        ) if @methods.map(&:downcase).include?(:get)
+      end
+
+      def validate_csrf
+        params = @params
+        headers = request.headers
+        matched_headers = headers.keys.select { |header| VALID_CSRF_HEADERS.any? { |exp| header.match(exp) } }
+        matched_param = params.keys.select { |param| VALID_CSRF_PARAMS.any? { |exp| param.match(exp) } }
+      end
+    end
+  end
+end

data/lib/API_Fuzzer/engine.rb

@@ -0,0 +1,5 @@
+require 'rails'
+
+module API_Fuzzer
+  class Engine < ::Rails::Engine; end
+end

data/lib/API_Fuzzer/error.rb

@@ -0,0 +1,11 @@
+module API_Fuzzer
+  class Error
+    attr_accessor :description, :status, :value
+
+    def initialize(options = {})
+      @description = options.delete(:description) || nil
+      @status = options.delete(:status)
+      @value = options.delete(:value)
+    end
+  end
+end

data/lib/API_Fuzzer/header_info.rb

@@ -0,0 +1,50 @@
+require 'yaml'
+require 'API_Fuzzer/vulnerability'
+
+module API_Fuzzer
+
+  class InvalidResponse < StandardError; end
+
+  class HeaderInfo
+
+    class << self
+      def scan(response)
+        @response = response
+        @headers = @response.headers
+        load_header_rules
+        scan_headers
+        raise InvalidResponse, "Invalid response argument passed" unless @response
+      end
+
+      def scan_headers
+       @vulnerabilities = []
+
+        @rules.each do |rule|
+          name = rule['name']
+          header_keys = @headers.keys.map { |key| key.downcase }
+          if header_keys.include? name
+            unless /#{rule['match']}/.match(@headers[name])
+              @vulnerabilities << API_Fuzzer::Vulnerability.new(
+                description: rule['description'],
+                value: [name, @headers[name]].join(" "),
+                type: 'LOW'
+              )
+            end
+          else
+            @vulnerabilities << API_Fuzzer::Vulnerability.new(
+              description: rule['description'],
+              value: [name, @headers[name]].join(" "),
+              type: 'LOW'
+            )
+          end
+        end
+        @vulnerabilities
+      end
+
+      def load_header_rules
+        info_rules = File.expand_path('../../../rules', __FILE__)
+        @rules = YAML::load_file(File.join(info_rules, "headers.yml"))['rules']
+      end
+    end
+  end
+end