brakeman 0.9.2 → 1.0.rc1

data/lib/{scanner.rb → brakeman/scanner.rb}

@@ -5,7 +5,7 @@ begin
   require 'sass'
   require 'erb'
   require 'erubis'
-  require 'processor'
+  require 'brakeman/processor'
 
   #Load our own version of ruby_parser :(
   original_verbosity = $VERBOSE
@@ -20,23 +20,26 @@ rescue LoadError => e
 end
 
 #Erubis processor which ignores any output which is plain text.
-class ScannerErubis < Erubis::Eruby
+class Brakeman::ScannerErubis < Erubis::Eruby
   include Erubis::NoTextEnhancer
 end
 
-class ErubisEscape < ScannerErubis
+class Brakeman::ErubisEscape < Brakeman::ScannerErubis
   include Erubis::EscapeEnhancer
 end
 
 #Scans the Rails application.
-class Scanner
+class Brakeman::Scanner
+  attr_reader :options
+
   RUBY_1_9 = !!(RUBY_VERSION =~ /^1\.9/)
 
   #Pass in path to the root of the Rails application
-  def initialize path
-    @path = path
-    @app_path = File.join(path, "app")
-    @processor = Processor.new
+  def initialize options
+    @options = options
+    @path = options[:app_path]
+    @app_path = File.join(@path, "app")
+    @processor = Brakeman::Processor.new options
   end
 
   #Returns the Tracker generated from the scan
@@ -62,6 +65,8 @@ class Scanner
     process_models
     warn "Processing controllers..."
     process_controllers
+    warn "Indexing call sites..."
+    index_call_sites
     tracker
   end
 
@@ -69,7 +74,7 @@ class Scanner
   #
   #Stores parsed information in tracker.config
   def process_config
-    if OPTIONS[:rails3]
+    if options[:rails3]
       @processor.process_config(RubyParser.new.parse(File.read("#@path/config/application.rb")))
       @processor.process_config(RubyParser.new.parse(File.read("#@path/config/environments/production.rb")))
     else
@@ -82,7 +87,7 @@ class Scanner
     end
 
     if File.exists? "#@path/vendor/plugins/rails_xss" or 
-      OPTIONS[:rails3] or OPTIONS[:escape_html] or
+      options[:rails3] or options[:escape_html] or
       (File.exists? "#@path/Gemfile" and File.read("#@path/Gemfile").include? "rails_xss")
 
       tracker.config[:escape_html] = true
@@ -120,7 +125,7 @@ class Scanner
   #
   #Adds parsed information to tracker.libs.
   def process_libs
-    if OPTIONS[:skip_libs]
+    if options[:skip_libs]
       warn '[Skipping]'
       return
     end
@@ -146,7 +151,7 @@ class Scanner
       rescue Exception => e
         tracker.error e.exception(e.message + "\nWhile processing routes.rb"), e.backtrace
         warn "[Notice] Error while processing routes - assuming all public controller methods are actions."
-        OPTIONS[:assume_all_routes] = true
+        options[:assume_all_routes] = true
       end
     else
       warn "[Notice] No route information found"
@@ -192,14 +197,14 @@ class Scanner
         if type == :erb
           if tracker.config[:escape_html]
             type = :erubis
-            if OPTIONS[:rails3]
-              src = RailsXSSErubis.new(text).src
+            if options[:rails3]
+              src = Brakeman::RailsXSSErubis.new(text).src
             else
-              src = ErubisEscape.new(text).src
+              src = Brakeman::ErubisEscape.new(text).src
             end
           elsif tracker.config[:erubis]
             type = :erubis
-            src = ScannerErubis.new(text).src
+            src = Brakeman::ScannerErubis.new(text).src
           else
             src = ERB.new(text, nil, "-").src
             src.sub!(/^#.*\n/, '') if RUBY_1_9
@@ -254,10 +259,14 @@ class Scanner
       end
     end
   end
+
+  def index_call_sites
+    tracker.index_call_sites
+  end
 end
 
 #This is from Rails 3 version of the Erubis handler
-class RailsXSSErubis < ::Erubis::Eruby
+class Brakeman::RailsXSSErubis < ::Erubis::Eruby
 
   def add_preamble(src)
     # src << "_buf = ActionView::SafeBuffer.new;\n"

data/lib/{tracker.rb → brakeman/tracker.rb}

@@ -1,14 +1,15 @@
 require 'set'
-require 'checks'
-require 'report'
-require 'processors/lib/find_call'
-require 'processors/lib/find_model_call'
+require 'brakeman/call_index'
+require 'brakeman/checks'
+require 'brakeman/report'
+require 'brakeman/processors/lib/find_call'
+require 'brakeman/processors/lib/find_all_calls'
 
 #The Tracker keeps track of all the processed information.
-class Tracker
+class Brakeman::Tracker
   attr_accessor :controllers, :templates, :models, :errors,
     :checks, :initializers, :config, :routes, :processor, :libs,
-    :template_cache
+    :template_cache, :options
 
   #Place holder when there should be a model, but it is not
   #clear what model it will be.
@@ -18,8 +19,9 @@ class Tracker
   #
   #The Processor argument is only used by other Processors
   #that might need to access it.
-  def initialize processor = nil
+  def initialize processor = nil, options = {}
     @processor = processor
+    @options = options
     @config = {}
     @templates = {}
     @controllers = {}
@@ -40,6 +42,7 @@ class Tracker
     @checks = nil
     @processed = nil
     @template_cache = Set.new
+    @call_index = nil
   end
 
   #Add an error to the list. If no backtrace is given,
@@ -56,7 +59,7 @@ class Tracker
   #Run a set of checks on the current information. Results will be stored
   #in Tracker#checks.
   def run_checks
-    @checks = Checks.run_checks(self)
+    @checks = Brakeman::Checks.run_checks(self)
   end
 
   #Iterate over all methods in controllers and models.
@@ -95,26 +98,48 @@ class Tracker
 
   #Find a method call.
   #
-  #See FindCall for details on arguments.
-  def find_call target, method
-    finder = FindCall.new target, method
+  #Options:
+  #  * :target => target name(s)
+  #  * :method => method name(s)
+  #  * :chained => search in method chains
+  #
+  #If :target => false or :target => nil, searches for methods without a target.
+  #Targets and methods can be specified as a symbol, an array of symbols,
+  #or a regular expression.
+  #
+  #If :chained => true, matches target at head of method chain and method at end.
+  #
+  #For example:
+  #
+  #    find_call :target => User, :method => :all, :chained => true
+  #
+  #could match
+  #
+  #    User.human.active.all(...)
+  #
+  def find_call options
+    index_calls unless @call_index
+    @call_index.find_calls options
+  end
 
-    self.each_method do |definition, set_name, method_name|
-      finder.process_source definition, set_name, method_name
-    end
+  #Similar to Tracker#find_call, but searches the initializers
+  def check_initializers target, method
+    finder = Brakeman::FindCall.new target, method, self
 
-    self.each_template do |name, template|
-      finder.process_source template[:src], nil, nil, template
+    initializers.each do |name, initializer|
+      finder.process_source initializer
     end
 
     finder.matches
   end
 
-  #Finds method call on models.
-  #
-  #See FindCall for details on arguments.
-  def find_model_find target
-    finder = FindModelCall.new target
+  #Returns a Report with this Tracker's information
+  def report
+    Brakeman::Report.new(self)
+  end
+
+  def index_call_sites
+    finder = Brakeman::FindAllCalls.new self
 
     self.each_method do |definition, set_name, method_name|
       finder.process_source definition, set_name, method_name
@@ -124,22 +149,6 @@ class Tracker
       finder.process_source template[:src], nil, nil, template
     end
 
-    finder.matches
-  end
-
-  #Similar to Tracker#find_call, but searches the initializers
-  def check_initializers target, method
-    finder = FindCall.new target, method
-
-    initializers.each do |name, initializer|
-      finder.process_source initializer
-    end
-
-    finder.matches
-  end
-
-  #Returns a Report with this Tracker's information
-  def report
-    Report.new(self)
+    @call_index = Brakeman::CallIndex.new finder.calls
   end
 end

data/lib/{util.rb → brakeman/util.rb}

@@ -3,7 +3,7 @@ require 'set'
 require 'active_support/inflector'
 
 #This is a mixin containing utility methods.
-module Util
+module Brakeman::Util
 
   QUERY_PARAMETERS = Sexp.new(:call, Sexp.new(:call, nil, :request, Sexp.new(:arglist)), :query_parameters, Sexp.new(:arglist))
 
@@ -125,6 +125,11 @@ module Util
     exp.is_a? Sexp and exp.node_type == :lit and exp[1].is_a? Integer
   end
 
+  #Check if _exp_ represents a result: s(:result, ...)
+  def result? exp
+    exp.is_a? Sexp and exp.node_type == :result
+  end
+
   #Check if _exp_ is a params hash
   def params? exp
     if exp.is_a? Sexp
@@ -164,3 +169,13 @@ module Util
     exp.is_a? Sexp
   end
 end
+
+class Sexp
+  def original_line line = nil
+    if line
+      @original_line = line
+    else
+      @original_line
+    end
+  end
+end

data/lib/brakeman/version.rb

@@ -0,0 +1,3 @@
+module Brakeman
+  Version = "1.0.rc1"
+end

data/lib/{warning.rb → brakeman/warning.rb}

@@ -1,11 +1,11 @@
 #The Warning class stores information about warnings
-class Warning
+class Brakeman::Warning
   attr_reader :called_from, :check, :class, :confidence, :controller,
     :line, :method, :model, :template, :warning_set, :warning_type
 
   attr_accessor :code, :context, :file, :message
 
-  #+options[:result]+ can be a result Sexp from FindCall. Otherwise, it can be +nil+.
+  #+options[:result]+ can be a result from Tracker#find_call. Otherwise, it can be +nil+.
   def initialize options = {}
     @view_name = nil
 
@@ -17,13 +17,13 @@ class Warning
 
     result = options[:result]
     if result
-      if result.length == 3 #template result
-        @template ||= result[1]
-        @code ||= result[2]
+      if result[:location][0] == :template #template result
+        @template ||= result[:location][1]
+        @code ||= result[:call]
       else
-        @class ||= result[1]
-        @method ||= result[2]
-        @code ||= result[3]
+        @class ||= result[:location][1]
+        @method ||= result[:location][2]
+        @code ||= result[:call]
       end
     end
 
@@ -58,7 +58,7 @@ class Warning
   #Return String of the code output from the OutputProcessor and
   #stripped of newlines and tabs.
   def format_code
-    OutputProcessor.new.format(self.code).gsub(/(\t|\r|\n)+/, " ")
+    Brakeman::OutputProcessor.new.format(self.code).gsub(/(\t|\r|\n)+/, " ")
   end
 
   #Return formatted warning message

metadata

@@ -1,12 +1,14 @@
 --- !ruby/object:Gem::Specification 
 name: brakeman
 version: !ruby/object:Gem::Version 
-  prerelease: false
+  hash: 447512930
+  prerelease: 4
   segments: 
+  - 1
   - 0
-  - 9
-  - 2
-  version: 0.9.2
+  - rc
+  - 1
+  version: 1.0.rc1
 platform: ruby
 authors: 
 - Justin Collins
@@ -14,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-11-21 00:00:00 -08:00
+date: 2011-12-05 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -25,6 +27,7 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
+        hash: 35040058
         segments: 
         - 2
         - 2
@@ -39,6 +42,7 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
+        hash: 199563509
         segments: 
         - 1
         - 2
@@ -54,6 +58,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 349353174
         segments: 
         - 2
         - 3
@@ -69,6 +74,7 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
+        hash: 443479320
         segments: 
         - 1
         - 6
@@ -84,6 +90,7 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
+        hash: 576733947
         segments: 
         - 2
         - 6
@@ -99,6 +106,7 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
+        hash: 359472903
         segments: 
         - 3
         - 0
@@ -119,68 +127,68 @@ files:
 - WARNING_TYPES
 - FEATURES
 - README.md
-- lib/warning.rb
-- lib/processors/gem_processor.rb
-- lib/processors/params_processor.rb
-- lib/processors/controller_alias_processor.rb
-- lib/processors/base_processor.rb
-- lib/processors/controller_processor.rb
-- lib/processors/library_processor.rb
-- lib/processors/erb_template_processor.rb
-- lib/processors/haml_template_processor.rb
-- lib/processors/template_alias_processor.rb
-- lib/processors/route_processor.rb
-- lib/processors/model_processor.rb
-- lib/processors/lib/find_call.rb
-- lib/processors/lib/processor_helper.rb
-- lib/processors/lib/rails3_route_processor.rb
-- lib/processors/lib/route_helper.rb
-- lib/processors/lib/rails2_config_processor.rb
-- lib/processors/lib/rails2_route_processor.rb
-- lib/processors/lib/find_model_call.rb
-- lib/processors/lib/render_helper.rb
-- lib/processors/lib/rails3_config_processor.rb
-- lib/processors/alias_processor.rb
-- lib/processors/output_processor.rb
-- lib/processors/config_processor.rb
-- lib/processors/erubis_template_processor.rb
-- lib/processors/template_processor.rb
-- lib/checks/check_send_file.rb
-- lib/checks/check_translate_bug.rb
-- lib/checks/check_session_settings.rb
-- lib/checks/check_nested_attributes.rb
-- lib/checks/check_strip_tags.rb
-- lib/checks/check_sql.rb
-- lib/checks/check_without_protection.rb
-- lib/checks/check_mass_assignment.rb
-- lib/checks/check_escape_function.rb
-- lib/checks/check_cross_site_scripting.rb
-- lib/checks/check_model_attributes.rb
-- lib/checks/check_default_routes.rb
-- lib/checks/check_evaluation.rb
-- lib/checks/check_quote_table_name.rb
-- lib/checks/check_validation_regex.rb
-- lib/checks/check_execute.rb
-- lib/checks/check_filter_skipping.rb
-- lib/checks/check_mail_to.rb
-- lib/checks/base_check.rb
-- lib/checks/check_file_access.rb
-- lib/checks/check_response_splitting.rb
-- lib/checks/check_basic_auth.rb
-- lib/checks/check_redirect.rb
-- lib/checks/check_forgery_setting.rb
-- lib/checks/check_render.rb
-- lib/tracker.rb
-- lib/util.rb
-- lib/report.rb
+- lib/brakeman.rb
 - lib/ruby_parser/ruby_lexer.rb
 - lib/ruby_parser/ruby_parser.rb
-- lib/version.rb
-- lib/brakeman.rb
-- lib/scanner.rb
-- lib/checks.rb
-- lib/processor.rb
-- lib/format/style.css
+- lib/brakeman/warning.rb
+- lib/brakeman/tracker.rb
+- lib/brakeman/util.rb
+- lib/brakeman/report.rb
+- lib/brakeman/version.rb
+- lib/brakeman/call_index.rb
+- lib/brakeman/scanner.rb
+- lib/brakeman/checks.rb
+- lib/brakeman/processor.rb
+- lib/brakeman/processors/gem_processor.rb
+- lib/brakeman/processors/params_processor.rb
+- lib/brakeman/processors/controller_alias_processor.rb
+- lib/brakeman/processors/base_processor.rb
+- lib/brakeman/processors/controller_processor.rb
+- lib/brakeman/processors/library_processor.rb
+- lib/brakeman/processors/erb_template_processor.rb
+- lib/brakeman/processors/haml_template_processor.rb
+- lib/brakeman/processors/template_alias_processor.rb
+- lib/brakeman/processors/route_processor.rb
+- lib/brakeman/processors/model_processor.rb
+- lib/brakeman/processors/alias_processor.rb
+- lib/brakeman/processors/output_processor.rb
+- lib/brakeman/processors/config_processor.rb
+- lib/brakeman/processors/erubis_template_processor.rb
+- lib/brakeman/processors/template_processor.rb
+- lib/brakeman/checks/check_send_file.rb
+- lib/brakeman/checks/check_translate_bug.rb
+- lib/brakeman/checks/check_session_settings.rb
+- lib/brakeman/checks/check_nested_attributes.rb
+- lib/brakeman/checks/check_strip_tags.rb
+- lib/brakeman/checks/check_sql.rb
+- lib/brakeman/checks/check_without_protection.rb
+- lib/brakeman/checks/check_mass_assignment.rb
+- lib/brakeman/checks/check_escape_function.rb
+- lib/brakeman/checks/check_cross_site_scripting.rb
+- lib/brakeman/checks/check_model_attributes.rb
+- lib/brakeman/checks/check_default_routes.rb
+- lib/brakeman/checks/check_evaluation.rb
+- lib/brakeman/checks/check_quote_table_name.rb
+- lib/brakeman/checks/check_validation_regex.rb
+- lib/brakeman/checks/check_execute.rb
+- lib/brakeman/checks/check_filter_skipping.rb
+- lib/brakeman/checks/check_mail_to.rb
+- lib/brakeman/checks/base_check.rb
+- lib/brakeman/checks/check_file_access.rb
+- lib/brakeman/checks/check_response_splitting.rb
+- lib/brakeman/checks/check_basic_auth.rb
+- lib/brakeman/checks/check_redirect.rb
+- lib/brakeman/checks/check_forgery_setting.rb
+- lib/brakeman/checks/check_render.rb
+- lib/brakeman/processors/lib/find_all_calls.rb
+- lib/brakeman/processors/lib/find_call.rb
+- lib/brakeman/processors/lib/processor_helper.rb
+- lib/brakeman/processors/lib/rails3_route_processor.rb
+- lib/brakeman/processors/lib/route_helper.rb
+- lib/brakeman/processors/lib/rails2_config_processor.rb
+- lib/brakeman/processors/lib/rails2_route_processor.rb
+- lib/brakeman/processors/lib/render_helper.rb
+- lib/brakeman/processors/lib/rails3_config_processor.rb
 has_rdoc: true
 homepage: http://brakemanscanner.org
 licenses: []
@@ -195,21 +203,25 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 881230260
       segments: 
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version 
+      hash: 357276212
       segments: 
-      - 0
-      version: "0"
+      - 1
+      - 3
+      - 1
+      version: 1.3.1
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.5.2
 signing_key: 
 specification_version: 3
 summary: Security vulnerability scanner for Ruby on Rails.