bscan 1.4.4

data/CONFIG.rdoc

@@ -0,0 +1,131 @@
+
+== CONVENTIONS
+Config file contains options for Burb, BScan and external BScan modules. 
+All bscan properties start with 'bscan.' prefix.
+All modules properties have the following prefix:
+
+	bscan.<module_name>[.<module_instance_id>].  
+
+Module <module_instance_id> is optional and is needed when the same
+module is run several times with different parameters.
+bscan.modules property contains a list of all modules to run separated by ',' 
+
+	bscan.modules=<module_path>[:<module_instance_id>], ...
+
+If <module_path> is realtive, the 'SEARCH PATH RULES' will be used  
+If static_request property is set to true, the modules will not be called 
+from the Burp's spider, a static request should be provided in a config
+file instead, e.g.
+
+	bscan.injector.three.file=../config/injector.txt
+	bscan.injector.three.check_replay=true
+
+injector.txt file should contain a valid request in the example above.
+
+== SEARCH PATH RULES
+The following path will be used to search a config file or any relative
+path that configs refers to:
+
+.:./lib:~/.bscan:/etc/bscan:<jruby_system_path_defined_by_$:>
+
+see BscannerHelper#search_path for details
+
+== BScan Specific Parameters
+* bscan.modules - see 'CONVENTIONS' for details
+* bscan.inactivity_to - inactivity is sec that triggers exit
+* bscan.issues=issues - output directory for findings/issues
+* scan.modules_only - if true, only modules with static requests 
+  will run (no spider)
+* bscan.url - URL to spider, multiple entries are OK. Have no effect 
+  if scan.modules_only=true
+
+== Modules Included to the Package
+* injector.rb - injects malicious patterns provided in a file (e.g. Google's
+  fuzzdb) to URL or body parameters. It can also inject to pattern marked
+  by special separators (see inject_instead_of param below)
+* many_threads.rb - runs a static query in multiple threads. Can repeat
+  patterns multiple times to increase impact on a server
+
+== injector.rb Module Parameters
+* bscan.injector.file - file with malicious patterns (e.g. Google's fuzzdb)
+* bscan.injector.inject_to_body - if true injects to body params, otherwise 
+  to URL params only
+* bscan.injector.check_rsp_max_time=n - log an issue if response time > n sec
+* bscan.injector.check_status - log an issue if a status code >= 500
+* bscan.injector.check_replay - log XSS issue if input is replayed in a
+  response
+* bscan.injector.inject_instead_of=<sep>:<request>:<protocol> - replaces
+  <sep>(.*)<sep> occurences with injections provided in 'file'
+  <request> - a request file with <sep>(.*)<sep> patterns
+  <protocol> - either http or https 
+* bscan.injector.static_request if true, won't be called from spider
+
+== many_threads.rb Module Parameters
+* bscan.many_threads.request=<request>:<protocol>:<rep-pat>
+  <request> - a file with a request
+  <protocol> - http or https
+  <rep-pat> - <rep-pat>(.*)<rep-pat>N patterns will be replaced
+  with (.*) repeated N times. Useful if you want to generate
+  huge requests using small input files.    
+* bscan.many_threads.threads=n - number of threads
+* bscan.many_threads.static_request=true won't be called from spider
+  It actually should be true for this module 
+
+== slowloris.rb Module Parameters
+It's important not to exceed the maximum file number on your
+client, otherwise it might not work. It's also important to 
+set up a correct timeout (sleep_time) that should not be 
+bigger than server's read timeout.  
+
+* bscan.slowloris.hostport=<host>:<port>
+  no defaults, must provide both
+* bscan.slowloris.protocol=<http protocol>
+  https or http, default - http
+* bscan.slowloris.method=<http method>
+  POST or GET, default - GET
+* bscan.slowloris.threads=n 
+  Thread number, default - 20
+* bscan.slowloris.con_nbr_per_thread=n 
+  Number of connections per thread, default - 50
+* bscan.slowloris.pack_per_con=n 
+  Max number of data packets to be sent in each connection 
+  default - 5 (duration of test: pack_per_con*sleep_time)
+* bscan.slowloris.response_time_factor=n
+  Normal response time will be multipled by this number to determine
+  when report an issue, e.g. if normal reposne time is 2 sec then if 
+  a response time under attack is bigger than 2*n, it will
+  be logged as an issue. Default - 5 
+* bscan.slowloris.sleep_time=n 
+  number of seconds to sleep
+  after beginning of a request has been send, default 100
+* bscan.slowloris.static_request=true
+  Must be always set to 'true' for this module
+
+== kill_apache.rb Module Parameters
+Similar to slowloris a monitoring thread will be checking
+a response time and log an issue if a threshold is reached
+(see 'response_time_factor' for details)
+
+* bscan.kill_apache.hostport=<host>:<port>
+  no defaults, must provide both
+* bscan.kill_apache.protocol=<http protocol>
+  https or http, default - http
+* bscan.kill_apache.threads=n 
+  Thread number, default - 500
+* bscan.kill_apache.req_per_thread=n 
+  Number of requests per thread, default - 1
+* bscan.kill_apache.response_time_factor=n
+  Normal response time will be multipled by this number to determine
+  when report an issue, e.g. if normal reposne time is 2 sec then if 
+  a response time under attack is bigger than 2*n, it will
+  be logged as an issue. Default - 10 
+* bscan.kill_apache.read_timeout=n 
+  client's read timeout, default - 10
+* bscan.kill_apache.static_request=true
+  Must be always set to 'true' for this module
+* bscan.kill_apache.range_nbr=n
+  Number of elements in 'Range' header, default - 500
+
+== Burp Parameters
+To get a list of all Burp parameters, set log level (--loglevel to 2 or 3)
+and you'll see all of them in a log file.

data/README.rdoc

@@ -0,0 +1,140 @@
+
+== DESCRIPTION:
+BScan is a configurable and extendable command line application security scanner. 
+It's built on top of arguably the most popular commercial security testing tool 
+Burp Suite from PortSwigger and Buby from Eric Monti and Timur Duehr
+
+== USE CASES:
+* Run security scans offline from a command line headless (without UI).
+
+* Change the type of scanning easily by changing configuration parameters.
+
+* Extend the BScan's functionality by adding external modules.
+
+* Utilize Burp's default spidering, active and passing scanning features.
+
+* Integrate scan with different sources of known injections (e.g. Google's fuzzdb: http://code.google.com/p/fuzzdb/).
+
+* Create comprehensive security regression tests suites from artifacts provided by security auditors and run them periodically from a command line.
+
+* Log found issues to a plain text file. 
+
+== DOCS, CODE, etc.:
+* Documentation: http://gryb.info/bscan
+* Git repo: git://git.code.sf.net/p/b-scan/trunk
+* Sourceforge: http://sf.net/projects/b-scan/
+* Gem package: http://gemcutter.org (see 'BUILD/INSTALL')
+
+== REQUIREMENTS:
+* JRuby - http://jruby.org
+* Burp pro if you want to use default Burp's scanners 
+* Burp free if you want to run BScan's modules only 
+* Buby 1.3.1 (see http://emonti.github.com/buby/)
+
+== BUILD/INSTALL:
+
+=== Gem
+
+  sudo jruby -S gem install buby -d --source=http://gemcutter.org
+  sudo jruby -S gem install bscan --source=http://gemcutter.org
+  
+  After Buby and BScan are installed, you'll need to link BScan to Burp's JAR (see below)
+
+=== Building Manually from Git
+
+	git git://git.code.sf.net/p/b-scan/trunk <src_dir>
+	cd <src_dir>
+	jruby -S gem build bscan.gemspec
+	jruby -S gem install -d --local bscan-*.gem
+	bscan --help
+	bscan --help config
+
+==== Linking BScan and Buby to Burp's JAR. 
+
+After Buby and BScan are installed (either manually or by gem) 
+you'll need to link them to a Burp's JAR.
+
+The easiest way of doing that is to find the directory where buby.jar is located
+and then create a link from that directory to a Burp's jar:
+
+	cd <dir_where_buby.jar_is_located>
+	ln -s <path_to_burp*.jar> <dir_where_buby.jar_is_located>/burp.jar
+
+To find where buby.jar is located you can print JRuby's search path using:
+    
+  jruby -e 'puts $:'
+
+and then run 'find' command for each dirctory in the search path:
+  
+  find <dir> -name buby.jar
+
+== TEST AND USAGE EXAMPLE:
+
+To get help run: 
+  
+  bscan --help 
+
+To get help for config layout run:
+  
+  bscan --help config
+
+== DOCUMENTATION, SAMPLES, RUNNING HEADLESSLY
+* Rdoc generated files: http://gryb.info/bscan/
+* After installing BScan's gem find the location of 'samples' dir:
+	jgem contents bscan | grep samples 
+* Check 'config' sub-dir in samples to see examples of config files
+  and static requests
+* samples/bscan_headless file show how to run bscan headlesly:
+	#!/bin/sh
+	jruby -J-Xmx1024M -J-Djava.awt.headless=true -S bscan -c ../config/conf -L 2 -l bscan.log
+   
+
+
+== CREDITS:
+* Burp and Burp Suite are trademarks of PortSwigger(ltd) 
+  Copyright 2012 PortSwigger Ltd. All rights reserved.
+  See http://portswigger.net for license terms.
+
+* Buby library and the accompanying BurpExtender.java implementation are 
+  written by Eric Monti @ Matasano Security. Matasano Security claims no 
+  professional or legal affiliation with PortSwigger LTD.
+
+* This BScan tools and library written by Oleg Gryb who claims no professional or
+  legal affiliation with PortSwigger LTD or Matasano Security. 
+
+* The ideas for slowloris attack have been borrowed from slowloris.pl 
+  written by RSnake and John Kinsella
+
+* The ideas for apache killer attack were borrowed from killap.pl written by Kingcope 
+
+== LICENSE:
+
+* Burp and Burp Suite are trademarks of PortSwigger Ltd.
+  Copyright 2012 PortSwigger Ltd. All rights reserved.
+  See http://portswigger.net for license terms.
+
+* The Buby library and its accompanying BurpExtender implementation are
+  both freely available under the terms of the MIT public license:
+
+(The MIT License)
+
+Copyright (C) 2009 Eric Monti, Matasano Security
+
+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. 
+
+* The BScan tools and library are freely available under the terms of the MIT public license:
+
+(The MIT License)
+
+Copyright (C) 2012 Oleg Gryb
+
+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/Rakefile

@@ -0,0 +1,54 @@
+require 'rubygems'
+require 'rake'
+require 'rake/clean'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.add_dependency('buby', '>= 1.3.1')
+    gem.name = "bscan"
+    gem.summary = %q{BScan is an extendable and configurable command line web application security scanner}
+    gem.description = %q{BScan is a configurable and extendable web application security scanner that can be run from a command line headless (without UI). It's built on top of arguably the most popular commercial security testing tool Burp Suite from PortSwigger and Buby from Eric Monti and Timur Duehr}
+    gem.email = "oleg@gryb.info"
+    gem.homepage = "http://sf.net/projects/b-scan/"
+    gem.authors = ["Oleg Gryb (ogryb)"]
+    #gem.platform = "java"
+    gem.test_files = ["test/bscan_test.rb"]
+#    gem.require_paths << 'config'
+    gem.rdoc_options = ["--main", "README.rdoc"]
+    gem.extra_rdoc_files = ["release_notes.txt", "README.rdoc", "CONFIG.rdoc", "bin/bscan"]
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo jruby -S gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION')
+    version = File.read('VERSION')
+  else
+    version = ""
+  end
+ 
+  rdoc.main = "README.rdoc"
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "BScan #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('CONFIG*')
+  rdoc.rdoc_files.include('release_notes.txt')
+  rdoc.rdoc_files.include('bin/bscan')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/VERSION

@@ -0,0 +1 @@
+1.4.4

data/bin/bscan

@@ -0,0 +1,79 @@
+#!/usr/bin/env jruby
+
+#require File.expand_path(File.join(File.dirname(__FILE__), %w[.. lib bscan]))
+$: << File.expand_path(File.join(File.dirname(__FILE__), %w[.. lib]))
+
+require 'buby'
+require 'getoptlong'
+require 'bscan'
+require 'bscan/utils/bscan_helper'
+
+include BscanHelper
+
+def usage
+
+  puts %q{
+USAGE: jruby [-J-Xmx<nnn>M] [-J-Djava.awt.headless=true] -S bscan --config path_to_file \ 
+             [--help [config]] [--loglevel n] [--logfile file] [--version]
+
+	-J-Xmx<nnn>M tells JVM to set maximum heap size to <nnn> MB 
+	-J-Djava.awt.headless=true tells JVM to run it headless (no UI)
+	-S tells jruby to search for bscan in a PATH
+	--config -c path_to_file path to config (see 'CONFIG' section in rdoc)
+	--help -h   this help
+	--help config config help
+	--loglevel -L 0 errors, 1 - warning, 2 - info, 3 - debug
+	--logfile -l path to a log file
+	--version -v version  
+}	 
+  exit(1)
+end  
+
+def get_cmd_params
+  params = {}
+  
+  opts = GetoptLong.new(
+    [ '--help',     '-h', GetoptLong::OPTIONAL_ARGUMENT ],
+    [ '--version',  '-v', GetoptLong::NO_ARGUMENT ],
+    [ '--config',   '-c', GetoptLong::REQUIRED_ARGUMENT ],
+    [ '--loglevel', '-L', GetoptLong::REQUIRED_ARGUMENT ],
+    [ '--logfile', '-l', GetoptLong::REQUIRED_ARGUMENT ]
+  )
+  usage if ARGV.size < 1
+    
+  opts.each do |opt,arg|
+    case opt
+      when '--help'
+        usage if not arg or arg != 'config'
+	    file=::File.expand_path(File.join(::File.dirname(__FILE__), "../CONFIG.rdoc"))
+		if ::File.file?(file)
+			puts File.read(file)
+		else    
+			puts "ERROR: Can't find file #{file} "
+		end
+		exit(1)
+      when '--config'
+        params['burp_config'], params['bscan_config'] = read_config(arg) 
+      when '--loglevel'
+        params['loglevel'] = arg
+      when '--logfile'
+        params['logfile'] = arg
+      when '--version'
+       file=::File.expand_path(File.join(::File.dirname(__FILE__), "../VERSION"))
+	   if ::File.file?(file)
+	      puts File.read(file).chomp
+	   else    
+	      puts "ERROR: Can't find file #{file} "
+	      exit(1)
+	   end
+	   exit(0)
+	  else
+	   usage 
+    end
+  end
+  params  
+end
+
+$burp = Buby.new()
+$burp.extend(BScan)
+$burp.start_burp([get_cmd_params.to_json])

data/bscan.gemspec

@@ -0,0 +1,63 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "bscan"
+  s.version = "1.4.4"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Oleg Gryb (ogryb)"]
+  s.date = "2012-08-13"
+  s.description = "BScan is a configurable and extendable web application security scanner that can be run from a command line headless (without UI). It's built on top of arguably the most popular commercial security testing tool Burp Suite from PortSwigger and Buby from Eric Monti and Timur Duehr"
+  s.email = "oleg@gryb.info"
+  s.executables = ["bscan"]
+  s.extra_rdoc_files = [
+    "CONFIG.rdoc",
+    "README.rdoc",
+    "bin/bscan",
+    "release_notes.txt"
+  ]
+  s.files = [
+    "CONFIG.rdoc",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "bin/bscan",
+    "bscan.gemspec",
+    "lib/bscan.rb",
+    "lib/bscan/modules/injector.rb",
+    "lib/bscan/modules/kill_apache.rb",
+    "lib/bscan/modules/many_threads.rb",
+    "lib/bscan/modules/slowloris.rb",
+    "lib/bscan/utils/bscan_helper.rb",
+    "release_notes.txt",
+    "samples/config/big_request.txt",
+    "samples/config/conf",
+    "samples/config/injector.txt",
+    "samples/config/request.txt",
+    "samples/headless-bscan.sh",
+    "test.sh",
+    "test/bscan_test.rb"
+  ]
+  s.homepage = "http://sf.net/projects/b-scan/"
+  s.rdoc_options = ["--main", "README.rdoc"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.24"
+  s.summary = "BScan is an extendable and configurable command line web application security scanner"
+  s.test_files = ["test/bscan_test.rb"]
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<buby>, [">= 1.3.1"])
+    else
+      s.add_dependency(%q<buby>, [">= 1.3.1"])
+    end
+  else
+    s.add_dependency(%q<buby>, [">= 1.3.1"])
+  end
+end
+