Class: Brakeman::CheckRegexDoS

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

Overview

This check looks for regexes that include user input.

Constant Summary collapse

ESCAPES =
{
  s(:const, :Regexp) => [
    :escape,
    :quote
  ]
}

Constants inherited from BaseCheck

BaseCheck::CONFIDENCE

Constants included from Util

Util::ALL_PARAMETERS, Util::COOKIES, Util::COOKIES_SEXP, Util::PARAMETERS, Util::PARAMS_SEXP, Util::PATH_PARAMETERS, Util::QUERY_PARAMETERS, Util::REQUEST_ENV, Util::REQUEST_PARAMETERS, Util::REQUEST_PARAMS, Util::SESSION, Util::SESSION_SEXP

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_cookies, #process_default, #process_if, #process_params, #process_string_interp

Methods included from Util

#array?, #block?, #call?, #camelize, #contains_class?, #context_for, #cookies?, #false?, #file_by_name, #file_for, #github_url, #hash?, #hash_access, #hash_insert, #hash_iterate, #integer?, #make_call, #node_type?, #number?, #params?, #pluralize, #regexp?, #relative_path, #request_env?, #request_value?, #result?, #set_env_defaults, #sexp?, #string?, #symbol?, #table_to_csv, #template_path_to_name, #true?, #truncate_table, #underscore

Methods included from ProcessorHelper

#class_name, #process_all, #process_all!, #process_call_args, #process_class, #process_module

Methods inherited from SexpProcessor

#error_handler, #in_context, #initialize, #process, #process_dummy, #scope

Constructor Details

This class inherits a constructor from Brakeman::BaseCheck

Instance Method Details

#process_call(exp) ⇒ Object


60
61
62
63
64
65
66
67
68
# File 'lib/brakeman/checks/check_regex_dos.rb', line 60

def process_call(exp)
  if escape_methods = ESCAPES[exp.target]
    if escape_methods.include? exp.method
      return exp
    end
  end

  super
end

#process_result(result) ⇒ Object

Warns if regex includes user input


28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
# File 'lib/brakeman/checks/check_regex_dos.rb', line 28

def process_result result
  return if duplicate? result
  add_result result

  call = result[:call]
  components = call[1..-1]

  components.any? do |component|
    next unless sexp? component

    if match = has_immediate_user_input?(component)
      confidence = CONFIDENCE[:high]
    elsif match = has_immediate_model?(component)
      match = Match.new(:model, match)
      confidence = CONFIDENCE[:med]
    elsif match = include_user_input?(component)
      confidence = CONFIDENCE[:low]
    end

    if match
      message = "#{friendly_type_of(match).capitalize} used in regex"

      warn :result => result,
        :warning_type => "Denial of Service",
        :warning_code => :regex_dos,
        :message => message,
        :confidence => confidence,
        :user_input => match.match
    end
  end
end

#run_checkObject

Process calls


17
18
19
20
21
22
23
24
25
# File 'lib/brakeman/checks/check_regex_dos.rb', line 17

def run_check
  Brakeman.debug "Finding dynamic regexes"
  calls = tracker.find_call :method => [:brakeman_regex_interp]

  Brakeman.debug "Processing dynamic regexes"
  calls.each do |call|
    process_result call
  end
end