Module: Brakeman::Util

Overview

This is a mixin containing utility methods.

Constant Summary collapse

QUERY_PARAMETERS =
Sexp.new(:call, Sexp.new(:call, nil, :request), :query_parameters)
PATH_PARAMETERS =
Sexp.new(:call, Sexp.new(:call, nil, :request), :path_parameters)
REQUEST_PARAMETERS =
Sexp.new(:call, Sexp.new(:call, nil, :request), :request_parameters)
REQUEST_PARAMS =
Sexp.new(:call, Sexp.new(:call, nil, :request), :parameters)
REQUEST_ENV =
Sexp.new(:call, Sexp.new(:call, nil, :request), :env)
PARAMETERS =
Sexp.new(:call, nil, :params)
COOKIES =
Sexp.new(:call, nil, :cookies)
SESSION =
Sexp.new(:call, nil, :session)
ALL_PARAMETERS =
Set[PARAMETERS, QUERY_PARAMETERS, PATH_PARAMETERS, REQUEST_PARAMETERS, REQUEST_PARAMS]
PARAMS_SEXP =

These are never modified

Sexp.new(:params)
SESSION_SEXP =
Sexp.new(:session)
COOKIES_SEXP =
Sexp.new(:cookies)

Instance Method Summary collapse

Instance Method Details

#array?(exp) ⇒ Boolean

Check if exp represents an array: s(:array, […])

Returns:

  • (Boolean)

123
124
125
# File 'lib/brakeman/util.rb', line 123

def array? exp
  exp.is_a? Sexp and exp.node_type == :array
end

#block?(exp) ⇒ Boolean

Check if exp represents a block of code

Returns:

  • (Boolean)

176
177
178
179
# File 'lib/brakeman/util.rb', line 176

def block? exp
  exp.is_a? Sexp and (exp.node_type == :block or
                      exp.node_type == :rlist)
end

#call?(exp) ⇒ Boolean

Check if exp represents a method call: s(:call, …)

Returns:

  • (Boolean)

138
139
140
# File 'lib/brakeman/util.rb', line 138

def call? exp
  exp.is_a? Sexp and exp.node_type == :call
end

#camelize(lower_case_and_underscored_word) ⇒ Object

Convert a string from “something_like_this” to “SomethingLikeThis”

Taken from ActiveSupport.


28
29
30
# File 'lib/brakeman/util.rb', line 28

def camelize lower_case_and_underscored_word
  lower_case_and_underscored_word.to_s.gsub(/\/(.?)/) { "::#{$1.upcase}" }.gsub(/(?:^|_)(.)/) { $1.upcase }
end

#contains_class?(exp) ⇒ Boolean

Returns true if the given exp contains a :class node.

Useful for checking if a module is just a module or if it is a namespace.

Returns:

  • (Boolean)

238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
# File 'lib/brakeman/util.rb', line 238

def contains_class? exp
  todo = [exp]

  until todo.empty?
    current = todo.shift

    if node_type? current, :class
      return true
    elsif sexp? current
      todo = current[1..-1].concat todo
    end
  end

  false
end

#context_for(app_tree, warning, tracker = nil) ⇒ Object

Return array of lines surrounding the warning location from the original file.


348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
# File 'lib/brakeman/util.rb', line 348

def context_for app_tree, warning, tracker = nil
  file = file_for warning, tracker
  context = []
  return context unless warning.line and file and @app_tree.path_exists? file

  current_line = 0
  start_line = warning.line - 5
  end_line = warning.line + 5

  start_line = 1 if start_line < 0

  File.open file do |f|
    f.each_line do |line|
      current_line += 1

      next if line.strip == ""

      if current_line > end_line
        break
      end

      if current_line >= start_line
        context << [current_line, line]
      end
    end
  end

  context
end

#cookies?(exp) ⇒ Boolean

Returns:

  • (Boolean)

198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
# File 'lib/brakeman/util.rb', line 198

def cookies? exp
  if exp.is_a? Sexp
    return true if exp.node_type == :cookies or exp == COOKIES

    if exp.node_type == :call
      if cookies? exp[1]
        return true
      elsif exp[2] == :[]
        return cookies? exp[1]
      end
    end
  end

  false
end

#false?(exp) ⇒ Boolean

Check if exp represents a :false or :nil node

Returns:

  • (Boolean)

170
171
172
173
# File 'lib/brakeman/util.rb', line 170

def false? exp
  exp.is_a? Sexp and (exp.node_type == :false or
                      exp.node_type == :nil)
end

#file_by_name(name, type, tracker = nil) ⇒ Object

Attempt to determine path to context file based on the reported name in the warning.

For example,

file_by_name FileController #=> "/rails/root/app/controllers/file_controller.rb

302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
# File 'lib/brakeman/util.rb', line 302

def file_by_name name, type, tracker = nil
  return nil unless name
  string_name = name.to_s
  name = name.to_sym

  unless type
    if string_name =~ /Controller$/
      type = :controller
    elsif camelize(string_name) == string_name # This is not always true
      type = :model
    else
      type = :template
    end
  end

  path = tracker.app_path

  case type
  when :controller
    if tracker.controllers[name] and tracker.controllers[name][:files]
      path = tracker.controllers[name][:files].first
    else
      path += "/app/controllers/#{underscore(string_name)}.rb"
    end
  when :model
    if tracker.models[name] and tracker.models[name][:files]
      path = tracker.models[name][:files].first
    else
      path += "/app/models/#{underscore(string_name)}.rb"
    end
  when :template
    if tracker.templates[name] and tracker.templates[name][:file]
      path = tracker.templates[name][:file]
    elsif string_name.include? " "
      name = string_name.split[0].to_sym
      path = file_for tracker, name, :template
    else
      path = nil
    end
  end

  path
end

#file_for(warning, tracker = nil) ⇒ Object

Return file name related to given warning. Uses warning.file if it exists


271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
# File 'lib/brakeman/util.rb', line 271

def file_for warning, tracker = nil
  if tracker.nil?
    tracker = @tracker || self.tracker
  end

  if warning.file
    File.expand_path warning.file, tracker.app_path
  elsif warning.template.is_a? Hash and warning.template[:file]
    warning.template[:file]
  else
    case warning.warning_set
    when :controller
      file_by_name warning.controller, :controller, tracker
    when :template
      file_by_name warning.template[:name], :template, tracker
    when :model
      file_by_name warning.model, :model, tracker
    when :warning
      file_by_name warning.class, nil, tracker
    else
      nil
    end
  end
end

#github_url(file, line = nil) ⇒ Object


395
396
397
398
399
400
401
402
# File 'lib/brakeman/util.rb', line 395

def github_url file, line=nil
  if repo_url = @tracker.options[:github_url] and file and not file.empty? and file.start_with? '/'
    url = "#{repo_url}/#{relative_path(file)}"
    url << "#L#{line}" if line
  else
    nil
  end
end

#hash?(exp) ⇒ Boolean

Check if exp represents a hash: s(:hash, …) This also includes pseudo hashes params, session, and cookies.

Returns:

  • (Boolean)

115
116
117
118
119
120
# File 'lib/brakeman/util.rb', line 115

def hash? exp
  exp.is_a? Sexp and (exp.node_type == :hash or
                      exp.node_type == :params or
                      exp.node_type == :session or
                      exp.node_type == :cookies)
end

#hash_access(hash, key) ⇒ Object

Get value from hash using key.

If key is a Symbol, it will be converted to a Sexp(:lit, key).


88
89
90
91
92
93
94
95
96
97
98
# File 'lib/brakeman/util.rb', line 88

def hash_access hash, key
  if key.is_a? Symbol
    key = Sexp.new(:lit, key)
  end

  if index = hash.find_index(key) and index > 0
    return hash[index + 1]
  end

  nil
end

#hash_insert(hash, key, value) ⇒ Object

Insert value into Hash Sexp


70
71
72
73
74
75
76
77
78
79
80
81
82
83
# File 'lib/brakeman/util.rb', line 70

def hash_insert hash, key, value
  index = 1
  hash_iterate hash.dup do |k,v|
    if k == key
      hash[index + 1] = value
      return hash
    end
    index += 2
  end

  hash << key << value

  hash
end

#hash_iterate(hash) ⇒ Object

Takes an Sexp like (:hash, (:lit, :key), (:str, “value”)) and yields the key and value pairs to the given block.

For example:

h = Sexp.new(:hash, (:lit, :name), (:str, “bob”), (:lit, :name), (:str, “jane”)) names = [] hash_iterate(h) do |key, value|

if symbol? key and key[1] == :name
  names << value[1]
end

end names #[“bob”]


63
64
65
66
67
# File 'lib/brakeman/util.rb', line 63

def hash_iterate hash
  1.step(hash.length - 1, 2) do |i|
    yield hash[i], hash[i + 1]
  end
end

#integer?(exp) ⇒ Boolean

Check if exp represents an Integer: s(:lit, …)

Returns:

  • (Boolean)

148
149
150
# File 'lib/brakeman/util.rb', line 148

def integer? exp
  exp.is_a? Sexp and exp.node_type == :lit and exp[1].is_a? Integer
end

#make_call(target, method, *args) ⇒ Object


254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
# File 'lib/brakeman/util.rb', line 254

def make_call target, method, *args
  call = Sexp.new(:call, target, method)

  if args.empty? or args.first.empty?
    #nothing to do
  elsif node_type? args.first, :arglist
    call.concat args.first[1..-1]
  elsif args.first.node_type.is_a? Sexp #just a list of args
    call.concat args.first
  else
    call.concat args
  end

  call
end

#node_type?(exp, *types) ⇒ Boolean

Check if exp is a Sexp and the node type matches one of the given types.

Returns:

  • (Boolean)

231
232
233
# File 'lib/brakeman/util.rb', line 231

def node_type? exp, *types
  exp.is_a? Sexp and types.include? exp.node_type
end

#number?(exp) ⇒ Boolean

Check if exp represents a number: s(:lit, …)

Returns:

  • (Boolean)

153
154
155
# File 'lib/brakeman/util.rb', line 153

def number? exp
  exp.is_a? Sexp and exp.node_type == :lit and exp[1].is_a? Numeric
end

#params?(exp) ⇒ Boolean

Check if exp is a params hash

Returns:

  • (Boolean)

182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
# File 'lib/brakeman/util.rb', line 182

def params? exp
  if exp.is_a? Sexp
    return true if exp.node_type == :params or ALL_PARAMETERS.include? exp

    if exp.node_type == :call
      if params? exp[1]
        return true
      elsif exp[2] == :[]
        return params? exp[1]
      end
    end
  end

  false
end

#pluralize(word) ⇒ Object

stupid simple, used to delegate to ActiveSupport


44
45
46
# File 'lib/brakeman/util.rb', line 44

def pluralize word
  word + "s"
end

#regexp?(exp) ⇒ Boolean

Check if exp represents a Regexp: s(:lit, /…/)

Returns:

  • (Boolean)

143
144
145
# File 'lib/brakeman/util.rb', line 143

def regexp? exp
  exp.is_a? Sexp and exp.node_type == :lit and exp[1].is_a? Regexp
end

#relative_path(file) ⇒ Object


378
379
380
381
382
383
384
# File 'lib/brakeman/util.rb', line 378

def relative_path file
  if file and not file.empty? and file.start_with? '/'
    Pathname.new(file).relative_path_from(Pathname.new(@tracker.app_path)).to_s
  else
    file
  end
end

#request_env?(exp) ⇒ Boolean

Returns:

  • (Boolean)

214
215
216
# File 'lib/brakeman/util.rb', line 214

def request_env? exp
  call? exp and (exp == REQUEST_ENV or exp[1] == REQUEST_ENV)
end

#request_value?(exp) ⇒ Boolean

Check if exp is params, cookies, or request_env

Returns:

  • (Boolean)

219
220
221
222
223
# File 'lib/brakeman/util.rb', line 219

def request_value? exp
  params? exp or
  cookies? exp or
  request_env? exp
end

#result?(exp) ⇒ Boolean

Check if exp represents a result: s(:result, …)

Returns:

  • (Boolean)

158
159
160
# File 'lib/brakeman/util.rb', line 158

def result? exp
  exp.is_a? Sexp and exp.node_type == :result
end

#set_env_defaultsObject

Adds params, session, and cookies to environment so they can be replaced by their respective Sexps.


107
108
109
110
111
# File 'lib/brakeman/util.rb', line 107

def set_env_defaults
  @env[PARAMETERS] = PARAMS_SEXP
  @env[SESSION] = SESSION_SEXP
  @env[COOKIES] = COOKIES_SEXP
end

#sexp?(exp) ⇒ Boolean

Check if exp is a Sexp.

Returns:

  • (Boolean)

226
227
228
# File 'lib/brakeman/util.rb', line 226

def sexp? exp
  exp.is_a? Sexp
end

#string?(exp) ⇒ Boolean

Check if exp represents a String: s(:str, “…”)

Returns:

  • (Boolean)

128
129
130
# File 'lib/brakeman/util.rb', line 128

def string? exp
  exp.is_a? Sexp and exp.node_type == :str
end

#symbol?(exp) ⇒ Boolean

Check if exp represents a Symbol: s(:lit, :…)

Returns:

  • (Boolean)

133
134
135
# File 'lib/brakeman/util.rb', line 133

def symbol? exp
  exp.is_a? Sexp and exp.node_type == :lit and exp[1].is_a? Symbol
end

#table_to_csv(table) ⇒ Object

rely on Terminal::Table to build the structure, extract the data out in CSV format


425
426
427
428
429
430
431
432
433
434
# File 'lib/brakeman/util.rb', line 425

def table_to_csv table
  return "" unless table

  Brakeman.load_brakeman_dependency 'terminal-table'
  output = CSV.generate_line(table.headings.cells.map{|cell| cell.to_s.strip})
  table.rows.each do |row|
    output << CSV.generate_line(row.cells.map{|cell| cell.to_s.strip})
  end
  output
end

#template_path_to_name(path) ⇒ Object

Convert path/filename to view name

views/test/something.html.erb -> test/something


389
390
391
392
393
# File 'lib/brakeman/util.rb', line 389

def template_path_to_name path
  names = path.split("/")
  names.last.gsub!(/(\.(html|js)\..*|\.rhtml)$/, '')
  names[(names.index("views") + 1)..-1].join("/").to_sym
end

#true?(exp) ⇒ Boolean

Check if exp represents a :true, :lit, or :string node

Returns:

  • (Boolean)

163
164
165
166
167
# File 'lib/brakeman/util.rb', line 163

def true? exp
  exp.is_a? Sexp and (exp.node_type == :true or
                      exp.node_type == :lit or
                      exp.node_type == :string)
end

#truncate_table(str) ⇒ Object


404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
# File 'lib/brakeman/util.rb', line 404

def truncate_table str
  @terminal_width ||= if @tracker.options[:table_width]
                        @tracker.options[:table_width]
                      elsif $stdin && $stdin.tty?
                        Brakeman.load_brakeman_dependency 'highline'
                        ::HighLine.new.terminal_size[0]
                      else
                        80
                      end
  lines = str.lines

  lines.map do |line|
    if line.chomp.length > @terminal_width
      line[0..(@terminal_width - 3)] + ">>\n"
    else
      line
    end
  end.join
end

#underscore(camel_cased_word) ⇒ Object

Convert a string from “Something::LikeThis” to “something/like_this”

Taken from ActiveSupport.


35
36
37
38
39
40
41
# File 'lib/brakeman/util.rb', line 35

def underscore camel_cased_word
  camel_cased_word.to_s.gsub(/::/, '/').
    gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
    gsub(/([a-z\d])([A-Z])/,'\1_\2').
    tr("-", "_").
    downcase
end