Contents

require 'brakeman/checks/base_check'

class Brakeman::CheckSecrets < Brakeman::BaseCheck
  Brakeman::Checks.add_optional self

  @description = "Checks for secrets stored in source code"

  def run_check
    check_constants
  end

  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
        end
      end
    end
  end

  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
end

Version data entries

99 entries across 85 versions & 4 rubygems

Version	Path
brakeman-5.2.3	lib/brakeman/checks/check_secrets.rb
brakeman-lib-5.2.3	lib/brakeman/checks/check_secrets.rb
brakeman-min-5.2.3	lib/brakeman/checks/check_secrets.rb
brakeman-5.2.2	lib/brakeman/checks/check_secrets.rb
brakeman-lib-5.2.2	lib/brakeman/checks/check_secrets.rb
brakeman-min-5.2.2	lib/brakeman/checks/check_secrets.rb
brakeman-5.2.1	lib/brakeman/checks/check_secrets.rb
brakeman-lib-5.2.1	lib/brakeman/checks/check_secrets.rb
brakeman-min-5.2.1	lib/brakeman/checks/check_secrets.rb
brakeman-5.2.0	lib/brakeman/checks/check_secrets.rb
brakeman-lib-5.2.0	lib/brakeman/checks/check_secrets.rb
brakeman-min-5.2.0	lib/brakeman/checks/check_secrets.rb
brakeman-5.1.2	lib/brakeman/checks/check_secrets.rb
brakeman-lib-5.1.2	lib/brakeman/checks/check_secrets.rb
brakeman-min-5.1.2	lib/brakeman/checks/check_secrets.rb
brakeman-5.1.1	lib/brakeman/checks/check_secrets.rb
brakeman-lib-5.1.1	lib/brakeman/checks/check_secrets.rb
brakeman-min-5.1.1	lib/brakeman/checks/check_secrets.rb
brakeman-5.1.0	lib/brakeman/checks/check_secrets.rb
brakeman-lib-5.1.0	lib/brakeman/checks/check_secrets.rb