Class: Brakeman::Tracker

Inherits:
Object
  • Object
show all
Defined in:
lib/brakeman/tracker.rb

Overview

The Tracker keeps track of all the processed information.

Constant Summary collapse

UNKNOWN_MODEL =

Place holder when there should be a model, but it is not clear what model it will be.

:BrakemanUnresolvedModel

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(app_tree, processor = nil, options = {}) ⇒ Tracker

Creates a new Tracker.

The Processor argument is only used by other Processors that might need to access it.


25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
# File 'lib/brakeman/tracker.rb', line 25

def initialize(app_tree, processor = nil, options = {})
  @app_tree = app_tree
  @processor = processor
  @options = options

  @config = Brakeman::Config.new(self)
  @templates = {}
  @controllers = {}
  #Initialize models with the unknown model so
  #we can match models later without knowing precisely what
  #class they are.
  @models = {}
  @models[UNKNOWN_MODEL] = Brakeman::Model.new(UNKNOWN_MODEL, nil, @app_tree.file_path("NOT_REAL.rb"), nil, self)
  @routes = {}
  @initializers = {}
  @errors = []
  @libs = {}
  @constants = Brakeman::Constants.new
  @checks = nil
  @processed = nil
  @template_cache = Set.new
  @filter_cache = {}
  @call_index = nil
  @start_time = Time.now
  @end_time = nil
  @duration = nil
end

Instance Attribute Details

#app_treeObject

Returns the value of attribute app_tree


12
13
14
# File 'lib/brakeman/tracker.rb', line 12

def app_tree
  @app_tree
end

#checksObject

Returns the value of attribute checks


12
13
14
# File 'lib/brakeman/tracker.rb', line 12

def checks
  @checks
end

#configObject

Returns the value of attribute config


12
13
14
# File 'lib/brakeman/tracker.rb', line 12

def config
  @config
end

#constantsObject

Returns the value of attribute constants


12
13
14
# File 'lib/brakeman/tracker.rb', line 12

def constants
  @constants
end

#controllersObject

Returns the value of attribute controllers


12
13
14
# File 'lib/brakeman/tracker.rb', line 12

def controllers
  @controllers
end

#durationObject

Returns the value of attribute duration


12
13
14
# File 'lib/brakeman/tracker.rb', line 12

def duration
  @duration
end

#end_timeObject

Returns the value of attribute end_time


12
13
14
# File 'lib/brakeman/tracker.rb', line 12

def end_time
  @end_time
end

#errorsObject

Returns the value of attribute errors


12
13
14
# File 'lib/brakeman/tracker.rb', line 12

def errors
  @errors
end

#filter_cacheObject

Returns the value of attribute filter_cache


12
13
14
# File 'lib/brakeman/tracker.rb', line 12

def filter_cache
  @filter_cache
end

#ignored_filterObject

Returns the value of attribute ignored_filter


12
13
14
# File 'lib/brakeman/tracker.rb', line 12

def ignored_filter
  @ignored_filter
end

#initializersObject

Returns the value of attribute initializers


12
13
14
# File 'lib/brakeman/tracker.rb', line 12

def initializers
  @initializers
end

#libsObject

Returns the value of attribute libs


12
13
14
# File 'lib/brakeman/tracker.rb', line 12

def libs
  @libs
end

#modelsObject

Returns the value of attribute models


12
13
14
# File 'lib/brakeman/tracker.rb', line 12

def models
  @models
end

#optionsObject

Returns the value of attribute options


12
13
14
# File 'lib/brakeman/tracker.rb', line 12

def options
  @options
end

#processorObject

Returns the value of attribute processor


12
13
14
# File 'lib/brakeman/tracker.rb', line 12

def processor
  @processor
end

#routesObject

Returns the value of attribute routes


12
13
14
# File 'lib/brakeman/tracker.rb', line 12

def routes
  @routes
end

#start_timeObject

Returns the value of attribute start_time


12
13
14
# File 'lib/brakeman/tracker.rb', line 12

def start_time
  @start_time
end

#template_cacheObject

Returns the value of attribute template_cache


12
13
14
# File 'lib/brakeman/tracker.rb', line 12

def template_cache
  @template_cache
end

#templatesObject

Returns the value of attribute templates


12
13
14
# File 'lib/brakeman/tracker.rb', line 12

def templates
  @templates
end

Instance Method Details

#add_constant(name, value, context = nil) ⇒ Object


197
198
199
# File 'lib/brakeman/tracker.rb', line 197

def add_constant name, value, context = nil
  @constants.add name, value, context unless @options[:disable_constant_tracking]
end

#app_pathObject


81
82
83
# File 'lib/brakeman/tracker.rb', line 81

def app_path
  @app_path ||= File.expand_path @options[:app_path]
end

#check_initializers(target, method) ⇒ Object

Searches the initializers for a method call


163
164
165
166
167
168
169
170
171
# File 'lib/brakeman/tracker.rb', line 163

def check_initializers target, method
  finder = Brakeman::FindCall.new target, method, self

  initializers.sort.each do |name, initializer|
    finder.process_source initializer
  end

  finder.matches
end

#constant_lookup(name) ⇒ Object

This method does not return all constants at this time, just ones with “simple” values.


203
204
205
# File 'lib/brakeman/tracker.rb', line 203

def constant_lookup name
  @constants.get_simple_value name unless @options[:disable_constant_tracking]
end

#each_classObject


120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
# File 'lib/brakeman/tracker.rb', line 120

def each_class
  classes = [self.controllers, self.models]

  if @options[:index_libs]
    classes << self.libs
  end

  classes.each do |set|
    set.each do |set_name, collection|
      collection.src.each do |file, src|
        yield src, set_name, file
      end
    end
  end
end

#each_methodObject

Iterate over all methods in controllers and models.


86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
# File 'lib/brakeman/tracker.rb', line 86

def each_method
  classes = [self.controllers, self.models]

  if @options[:index_libs]
    classes << self.libs
  end

  classes.each do |set|
    set.each do |set_name, collection|
      collection.each_method do |method_name, definition|
        src = definition[:src]
        yield src, set_name, method_name, definition[:file]
      end
    end
  end
end

#each_templateObject

Iterates over each template, yielding the name and the template. Prioritizes templates which have been rendered.


105
106
107
108
109
110
111
112
113
114
115
116
117
# File 'lib/brakeman/tracker.rb', line 105

def each_template
  if @processed.nil?
    @processed, @rest = templates.keys.sort_by{|template| template.to_s}.partition { |k| k.to_s.include? "." }
  end

  @processed.each do |k|
    yield k, templates[k]
  end

  @rest.each do |k|
    yield k, templates[k]
  end
end

#error(exception, backtrace = nil) ⇒ Object

Add an error to the list. If no backtrace is given, the one from the exception will be used.


55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
# File 'lib/brakeman/tracker.rb', line 55

def error exception, backtrace = nil
  backtrace ||= exception.backtrace
  unless backtrace.is_a? Array
    backtrace = [ backtrace ]
  end

  Brakeman.debug exception
  Brakeman.debug backtrace

  @errors << {
    :exception => exception,
    :error => exception.to_s.gsub("\n", " "),
    :backtrace => backtrace
  }
end

#filtered_warningsObject


182
183
184
185
186
187
188
189
190
# File 'lib/brakeman/tracker.rb', line 182

def filtered_warnings
  if self.ignored_filter
    self.warnings.reject do |w|
      self.ignored_filter.ignored? w
    end
  else
    self.warnings
  end
end

#find_call(options) ⇒ Object

Find a method call.

Options:

* :target => target name(s)
* :method => method name(s)
* :chained => search in method chains

If :target => false or :target => nil, searches for methods without a target. Targets and methods can be specified as a symbol, an array of symbols, or a regular expression.

If :chained => true, matches target at head of method chain and method at end.

For example:

find_call :target => User, :method => :all, :chained => true

could match

User.human.active.all(...)

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

def find_call options
  index_call_sites unless @call_index
  @call_index.find_calls options
end

#find_class(name) ⇒ Object


207
208
209
210
211
212
213
214
215
# File 'lib/brakeman/tracker.rb', line 207

def find_class name
  [@controllers, @models, @libs].each do |collection|
    if c = collection[name]
      return c
    end
  end

  nil
end

#index_call_sitesObject


217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
# File 'lib/brakeman/tracker.rb', line 217

def index_call_sites
  finder = Brakeman::FindAllCalls.new self

  self.each_method do |definition, set_name, method_name, file|
    finder.process_source definition, :class => set_name, :method => method_name, :file => file
  end

  self.each_class do |definition, set_name, file|
    finder.process_source definition, :class => set_name, :file => file
  end

  self.each_template do |_name, template|
    finder.process_source template.src, :template => template, :file => template.file
  end

  self.initializers.each do |file_name, src|
    finder.process_all_source src, :file => file_name
  end

  @call_index = Brakeman::CallIndex.new finder.calls
end

#reindex_call_sites(locations) ⇒ Object

Reindex call sites

Takes a set of symbols which can include :templates, :models, or :controllers

This will limit reindexing to the given sets


245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
# File 'lib/brakeman/tracker.rb', line 245

def reindex_call_sites locations
  #If reindexing templates, models, controllers,
  #just redo everything.
  if locations.length == 3
    return index_call_sites
  end

  if locations.include? :templates
    @call_index.remove_template_indexes
  end

  classes_to_reindex = Set.new
  method_sets = []

  if locations.include? :models
    classes_to_reindex.merge self.models.keys
    method_sets << self.models
  end

  if locations.include? :controllers
    classes_to_reindex.merge self.controllers.keys
    method_sets << self.controllers
  end

  if locations.include? :initializers
    self.initializers.each do |file_name, src|
      @call_index.remove_indexes_by_file file_name
    end
  end

  @call_index.remove_indexes_by_class classes_to_reindex

  finder = Brakeman::FindAllCalls.new self

  method_sets.each do |set|
    set.each do |set_name, info|
      info.each_method do |method_name, definition|
        src = definition[:src]
        finder.process_source src, :class => set_name, :method => method_name, :file => definition[:file]
      end
    end
  end

  if locations.include? :templates
    self.each_template do |_name, template|
      finder.process_source template.src, :template => template, :file => template.file
    end
  end

  if locations.include? :initializers
    self.initializers.each do |file_name, src|
      finder.process_all_source src, :file => file_name
    end
  end

  @call_index.index_calls finder.calls
end

#reportObject

Returns a Report with this Tracker's information


174
175
176
# File 'lib/brakeman/tracker.rb', line 174

def report
  Brakeman::Report.new(self)
end

#reset_controller(path) ⇒ Object


356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
# File 'lib/brakeman/tracker.rb', line 356

def reset_controller path
  controller_name = nil

  #Remove from controller
  @controllers.each do |name, controller|
    if controller.files.include?(path)
      controller_name = name

      #Remove templates rendered from this controller
      @templates.each do |template_name, template|
        if template.render_path and template.render_path.include_controller? name
          reset_template template_name
          @call_index.remove_template_indexes template_name
        end
      end

      #Remove calls indexed from this controller
      @call_index.remove_indexes_by_class [name]
      break
    end
  end
  @controllers.delete controller_name
end

#reset_initializer(path) ⇒ Object


385
386
387
388
389
390
391
# File 'lib/brakeman/tracker.rb', line 385

def reset_initializer path
  @initializers.delete_if do |file, src|
    path.relative.include? file
  end

  @call_index.remove_indexes_by_file path
end

#reset_lib(path) ⇒ Object

Clear information related to model


343
344
345
346
347
348
349
350
351
352
353
354
# File 'lib/brakeman/tracker.rb', line 343

def reset_lib path
  lib_name = nil

  @libs.each do |name, lib|
    if lib.files.include?(path)
      lib_name = name
      break
    end
  end

  @libs.delete lib_name
end

#reset_model(path) ⇒ Object

Clear information related to model


329
330
331
332
333
334
335
336
337
338
339
340
# File 'lib/brakeman/tracker.rb', line 329

def reset_model path
  model_name = nil

  @models.each do |name, model|
    if model.files.include?(path)
      model_name = name
      break
    end
  end

  @models.delete model_name
end

#reset_routesObject

Clear information about routes


381
382
383
# File 'lib/brakeman/tracker.rb', line 381

def reset_routes
  @routes = {}
end

#reset_template(name) ⇒ Object

Clear information related to template


320
321
322
323
324
325
326
# File 'lib/brakeman/tracker.rb', line 320

def reset_template name
  name = name.to_sym
  @templates.delete name
  @processed = nil
  @rest = nil
  @template_cache.clear
end

#reset_templates(options = { :only_rendered => false }) ⇒ Object

Clear information related to templates. If :only_rendered => true, will delete templates rendered from controllers (but not those rendered from other templates)


306
307
308
309
310
311
312
313
314
315
316
317
# File 'lib/brakeman/tracker.rb', line 306

def reset_templates options = { :only_rendered => false }
  if options[:only_rendered]
    @templates.delete_if do |_name, template|
      template.rendered_from_controller?
    end
  else
    @templates = {}
  end
  @processed = nil
  @rest = nil
  @template_cache.clear
end

#run_checksObject

Run a set of checks on the current information. Results will be stored in Tracker#checks.


73
74
75
76
77
78
79
# File 'lib/brakeman/tracker.rb', line 73

def run_checks
  @checks = Brakeman::Checks.run_checks(self)

  @end_time = Time.now
  @duration = @end_time - @start_time
  @checks
end

#unused_fingerprintsObject


192
193
194
195
# File 'lib/brakeman/tracker.rb', line 192

def unused_fingerprints
  return [] unless self.ignored_filter
  self.ignored_filter.obsolete_fingerprints
end

#warningsObject


178
179
180
# File 'lib/brakeman/tracker.rb', line 178

def warnings
  self.checks.all_warnings
end