Class: Brakeman::CheckUnscopedFind

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

Overview

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

Instance Method Summary collapse

Instance Method Details

#optional_belongs_to?(exp) ⇒ Boolean

Returns:



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