Class: Brakeman::CheckVerbConfusion

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

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_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_env?, #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

#process_if(exp) ⇒ Object 



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

def process_if exp
  if exp.condition == @matched_call
    # Found `if request.get?`

    # Do not warn if there is an `elsif` clause
    if node_type? exp.else_clause, :if
      return exp
    end

    warn_about_result @current_result, exp
  end

  exp
end

#process_result(result) ⇒ Object 



17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
 
# File 'lib/brakeman/checks/check_verb_confusion.rb', line 17

def process_result result
  @current_result = result
  @matched_call = result[:call]
  klass = tracker.find_class(result[:location][:class])

  # TODO: abstract into tracker.find_location ?
  if klass.nil?
    Brakeman.debug "No class found: #{result[:location][:class]}"
    return
  end

  method = klass.get_method(result[:location][:method])

  if method.nil?
    Brakeman.debug "No method found: #{result[:location][:method]}"
    return
  end

  process method.src
end

#run_check ⇒ Object

Process calls



9
10
11
12
13
14
15
 
# File 'lib/brakeman/checks/check_verb_confusion.rb', line 9

def run_check
  calls = tracker.find_call(target: :request, methods: [:get?])

  calls.each do |call|
    process_result call
  end
end

#warn_about_result(result, code) ⇒ Object 



53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/brakeman/checks/check_verb_confusion.rb', line 53

def warn_about_result result, code
  return unless original? result

  confidence = :weak
  message = msg('Potential HTTP verb confusion. ',
                msg_code('HEAD'),
                ' is routed like ',
                msg_code('GET'),
                ' but ',
                msg_code('request.get?'),
                ' will return ',
                msg_code('false')
               )

  warn :result => result,
    :warning_type => "HTTP Verb Confusion",
    :warning_code => :http_verb_confusion,
    :message => message,
    :code => code,
    :user_input => result[:call],
    :confidence => confidence
end