Class: Brakeman::CheckSimpleFormat

Inherits:
CheckCrossSiteScripting show all
Defined in:
lib/brakeman/checks/check_simple_format.rb

Constant Summary

Constants inherited from CheckCrossSiteScripting

Brakeman::CheckCrossSiteScripting::CGI, Brakeman::CheckCrossSiteScripting::FORM_BUILDER, Brakeman::CheckCrossSiteScripting::HAML_HELPERS, Brakeman::CheckCrossSiteScripting::IGNORE_LIKE, Brakeman::CheckCrossSiteScripting::IGNORE_MODEL_METHODS, Brakeman::CheckCrossSiteScripting::MODEL_METHODS, Brakeman::CheckCrossSiteScripting::URI, Brakeman::CheckCrossSiteScripting::XML_HELPER

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

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 CheckCrossSiteScripting

#actually_process_call, #cgi_escaped?, #check_for_immediate_xss, #form_builder_method?, #haml_escaped?, #html_safe_call?, #ignore_call?, #ignored_method?, #ignored_model_method?, #likely_model_attribute?, #process_case, #process_cookies, #process_dstr, #process_escaped_output, #process_format, #process_format_escaped, #process_if, #process_output, #process_params, #process_render, #raw_call?, #safe_input_attribute?, #setup, #xml_escaped?

Methods inherited from BaseCheck

#add_result, inherited, #process_array, #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

#array?, #block?, #call?, #camelize, #class_name, #constant?, #contains_class?, #cookies?, #dir_glob?, #false?, #hash?, #hash_access, #hash_insert, #hash_iterate, #integer?, #kwsplat?, #literal?, #make_call, #node_type?, #number?, #params?, #pluralize, #rails_version, #regexp?, #remove_kwsplat, #request_env?, #request_value?, #result?, #safe_literal, #safe_literal?, #safe_literal_target?, #set_env_defaults, #sexp?, #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, #process, processors, #scope

Constructor Details

#initialize(*args) ⇒ CheckSimpleFormat

Returns a new instance of CheckSimpleFormat.


8
9
10
11
# File 'lib/brakeman/checks/check_simple_format.rb', line 8

def initialize *args
  super
  @found_any = false
end

Instance Method Details

#check_simple_format_usageObject


34
35
36
37
38
39
40
41
42
# File 'lib/brakeman/checks/check_simple_format.rb', line 34

def check_simple_format_usage
  tracker.find_call(:target => false, :method => :simple_format).each do |result|
    @matched = false
    process_call result[:call]
    if @matched
      warn_on_simple_format result, @matched
    end
  end
end

#generic_warningObject


23
24
25
26
27
28
29
30
31
32
# File 'lib/brakeman/checks/check_simple_format.rb', line 23

def generic_warning
  message = msg(msg_version(rails_version), " has a vulnerability in ", msg_code("simple_format"), " ", msg_cve("CVE-2013-6416"), ". Upgrade to ", msg_version("4.0.2"))

  warn :warning_type => "Cross-Site Scripting",
    :warning_code => :CVE_2013_6416,
    :message => message,
    :confidence => :medium,
    :gem_info => gemfile_or_environment,
    :link_path => "https://groups.google.com/d/msg/ruby-security-ann/5ZI1-H5OoIM/ZNq4FoR2GnIJ"
end

#process_call(exp) ⇒ Object


44
45
46
47
48
# File 'lib/brakeman/checks/check_simple_format.rb', line 44

def process_call exp
  @mark = true
  actually_process_call exp
  exp
end

#run_checkObject


13
14
15
16
17
18
19
20
21
# File 'lib/brakeman/checks/check_simple_format.rb', line 13

def run_check
  if version_between? "4.0.0", "4.0.1"
    @inspect_arguments = true
    @ignore_methods = Set[:h, :escapeHTML]

    check_simple_format_usage
    generic_warning unless @found_any
  end
end

#warn_on_simple_format(result, match) ⇒ Object


50
51
52
53
54
55
56
57
58
59
60
61
62
# File 'lib/brakeman/checks/check_simple_format.rb', line 50

def warn_on_simple_format result, match
  return unless original? result

  @found_any = true

  warn :result => result,
    :warning_type => "Cross-Site Scripting",
    :warning_code => :CVE_2013_6416_call,
    :message => msg("Values passed to ", msg_code("simple_format"), " are not safe in ", msg_version(rails_version)),
    :confidence => :high,
    :link_path => "https://groups.google.com/d/msg/ruby-security-ann/5ZI1-H5OoIM/ZNq4FoR2GnIJ",
    :user_input => match
end