Class: Brakeman::CheckSecrets

Inherits:
BaseCheck show all
Defined in:
lib/brakeman/checks/check_secrets.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_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

#check_constants ⇒ Object 



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

def check_constants
  @warned = Set.new

  @tracker.constants.each do |constant|
    name = constant.name_array.last
    value = constant.value

    if string? value and not value.value.empty? and looks_like_secret? name
      match = [name, value, value.line]

      unless @warned.include? match
        @warned << match

        warn :warning_code => :secret_in_source,
          :warning_type => "Authentication",
          :message => msg("Hardcoded value for ", msg_code(name), " in source code"),
          :confidence => :medium,
          :file => constant.file,
          :line => constant.line,
          :cwe_id => [798]
      end
    end
  end
end

#looks_like_secret?(name) ⇒ Boolean

Returns:

  • (Boolean) 


37
38
39
40
 
# File 'lib/brakeman/checks/check_secrets.rb', line 37

def looks_like_secret? name
  # REST_AUTH_SITE_KEY is the pepper in Devise
  name.match(/password|secret|(rest_auth_site|api)_key$/i)
end

#run_check ⇒ Object 



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

def run_check
  check_constants
end