Class: Brakeman::CheckUnscopedFind

Inherits:
BaseCheck show all
Defined in:
lib/brakeman/checks/check_unscoped_find.rb

Overview

Checks for unscoped calls to models’ #find and #find_by_id methods.

Constant Summary

Constants inherited from BaseCheck

BaseCheck::CONFIDENCE

Constants included from Util

Util::ALL_COOKIES, Util::ALL_PARAMETERS, Util::COOKIES, Util::COOKIES_SEXP, Util::DIR_CONST, Util::LITERALS, Util::PARAMETERS, Util::PARAMS_SEXP, Util::PATH_PARAMETERS, Util::QUERY_PARAMETERS, Util::REQUEST_COOKIES, Util::REQUEST_ENV, Util::REQUEST_PARAMETERS, Util::REQUEST_PARAMS, Util::REQUEST_REQUEST_PARAMETERS, Util::SAFE_LITERAL, Util::SESSION, Util::SESSION_SEXP, Util::SIMPLE_LITERALS

Constants inherited from SexpProcessor

SexpProcessor::VERSION

Instance Attribute Summary

Attributes inherited from BaseCheck

#tracker, #warnings

Attributes inherited from SexpProcessor

#context, #env, #expected

Instance Method Summary collapse

Methods inherited from BaseCheck

#add_result, inherited, #initialize, #process_array, #process_call, #process_cookies, #process_default, #process_dstr, #process_if, #process_params

Methods included from Messages

#msg, #msg_code, #msg_cve, #msg_file, #msg_input, #msg_lit, #msg_plain, #msg_version

Methods included from Util

#all_literals?, #array?, #block?, #call?, #camelize, #class_name, #constant?, #contains_class?, #cookies?, #dir_glob?, #false?, #hash?, #hash_access, #hash_insert, #hash_iterate, #hash_values, #integer?, #kwsplat?, #literal?, #make_call, #node_type?, #number?, #params?, #pluralize, #rails_version, #recurse_check?, #regexp?, #remove_kwsplat, #request_headers?, #request_value?, #result?, #safe_literal, #safe_literal?, #safe_literal_target?, #set_env_defaults, #sexp?, #simple_literal?, #string?, #string_interp?, #symbol?, #template_path_to_name, #true?, #underscore

Methods included from ProcessorHelper

#current_file, #process_all, #process_all!, #process_call_args, #process_call_defn?, #process_class, #process_module

Methods inherited from SexpProcessor

#in_context, #initialize, #process, processors, #scope

Constructor Details

This class inherits a constructor from Brakeman::BaseCheck

Instance Method Details

#optional_belongs_to?(exp) ⇒ Boolean

Returns:

  • (Boolean) 


55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/brakeman/checks/check_unscoped_find.rb', line 55

def optional_belongs_to? exp
  return false unless exp.is_a? Array

  exp.each do |e|
    if hash? e and true? hash_access(e, :optional)
      return true
    end
  end

  false
end

#process_result(result) ⇒ Object 



36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
 
# File 'lib/brakeman/checks/check_unscoped_find.rb', line 36

def process_result result
  return if duplicate? result or result[:call].original_line

  # Not interested unless argument is user controlled.
  inputs = result[:call].args.map { |arg| include_user_input?(arg) }
  return unless input = inputs.compact.first

  add_result result

  warn :result => result,
    :warning_type => "Unscoped Find",
    :warning_code => :unscoped_find,
    :message      => msg("Unscoped call to ", msg_code("#{result[:target]}##{result[:method]}")),
    :code         => result[:call],
    :confidence   => :weak,
    :user_input   => input,
    :cwe_id => [285]
end

#run_check ⇒ Object 



9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
 
# File 'lib/brakeman/checks/check_unscoped_find.rb', line 9

def run_check
  Brakeman.debug("Finding instances of #find on models with associations")

  associated_model_names = active_record_models.keys.select do |name|
    if belongs_to = active_record_models[name].associations[:belongs_to]
      not optional_belongs_to? belongs_to
    else
      false
    end
  end

  calls = tracker.find_call :method => [:find, :find_by_id, :find_by_id!],
                            :targets => associated_model_names

  calls.each do |call|
    process_result call
  end

  tracker.find_call(:methods => [:find_by, :find_by!], :targets => associated_model_names).each do |result|
    arg = result[:call].first_arg

    if hash? arg and hash_access(arg, :id)
      process_result result
    end
  end
end