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.



24
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
 
# File 'lib/brakeman/tracker.rb', line 24

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, nil, nil, self)
  @routes = {}
  @initializers = {}
  @errors = []
  @libs = {}
  @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

#checks ⇒ Object

Returns the value of attribute checks.



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

def checks
  @checks
end

#config ⇒ Object

Returns the value of attribute config.



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

def config
  @config
end

#controllers ⇒ Object

Returns the value of attribute controllers.



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

def controllers
  @controllers
end

#duration ⇒ Object

Returns the value of attribute duration.



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

def duration
  @duration
end

#end_time ⇒ Object

Returns the value of attribute end_time.



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

def end_time
  @end_time
end

#errors ⇒ Object

Returns the value of attribute errors.



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

def errors
  @errors
end

#filter_cache ⇒ Object

Returns the value of attribute filter_cache.



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

def filter_cache
  @filter_cache
end

#ignored_filter ⇒ Object

Returns the value of attribute ignored_filter.



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

def ignored_filter
  @ignored_filter
end

#initializers ⇒ Object

Returns the value of attribute initializers.



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

def initializers
  @initializers
end

#libs ⇒ Object

Returns the value of attribute libs.



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

def libs
  @libs
end

#models ⇒ Object

Returns the value of attribute models.



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

def models
  @models
end

#options ⇒ Object

Returns the value of attribute options.



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

def options
  @options
end

#processor ⇒ Object

Returns the value of attribute processor.



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

def processor
  @processor
end

#routes ⇒ Object

Returns the value of attribute routes.



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

def routes
  @routes
end

#start_time ⇒ Object

Returns the value of attribute start_time.



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

def start_time
  @start_time
end

#template_cache ⇒ Object

Returns the value of attribute template_cache.



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

def template_cache
  @template_cache
end

#templates ⇒ Object

Returns the value of attribute templates.



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

def templates
  @templates
end

Instance Method Details

#app_path ⇒ Object 



75
76
77
 
# File 'lib/brakeman/tracker.rb', line 75

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

#check_initializers(target, method) ⇒ Object

Searches the initializers for a method call



145
146
147
148
149
150
151
152
153
 
# File 'lib/brakeman/tracker.rb', line 145

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

#each_method ⇒ Object

Iterate over all methods in controllers and models.



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/brakeman/tracker.rb', line 80

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]
        if src.node_type == :defs
          method_name = "#{src[1]}.#{method_name}"
        end

        yield src, set_name, method_name, definition[:file]

      end
    end
  end
end

#each_template ⇒ Object

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



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

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.



53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/brakeman/tracker.rb', line 53

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

  Brakeman.debug exception
  Brakeman.debug backtrace

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

#filtered_warnings ⇒ Object 



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

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(...)



139
140
141
142
 
# File 'lib/brakeman/tracker.rb', line 139

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

#index_call_sites ⇒ Object 



174
175
176
177
178
179
180
181
182
183
184
185
186
 
# File 'lib/brakeman/tracker.rb', line 174

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_template do |name, template|
    finder.process_source template.src, :template => template, :file => template.file
  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



194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
 
# File 'lib/brakeman/tracker.rb', line 194

def reindex_call_sites locations
  #If reindexing templates, models, and 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

  @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]
        if src.node_type == :defs
          method_name = "#{src[1]}.#{method_name}"
        end

        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

  @call_index.index_calls finder.calls
end

#report ⇒ Object

Returns a Report with this Tracker’s information



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

def report
  Brakeman::Report.new(@app_tree, self)
end

#reset_controller(path) ⇒ Object 



297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
 
# File 'lib/brakeman/tracker.rb', line 297

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_lib(path) ⇒ Object

Clear information related to model



284
285
286
287
288
289
290
291
292
293
294
295
 
# File 'lib/brakeman/tracker.rb', line 284

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



270
271
272
273
274
275
276
277
278
279
280
281
 
# File 'lib/brakeman/tracker.rb', line 270

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_routes ⇒ Object

Clear information about routes



322
323
324
 
# File 'lib/brakeman/tracker.rb', line 322

def reset_routes
  @routes = {}
end

#reset_template(name) ⇒ Object

Clear information related to template



261
262
263
264
265
266
267
 
# File 'lib/brakeman/tracker.rb', line 261

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)



247
248
249
250
251
252
253
254
255
256
257
258
 
# File 'lib/brakeman/tracker.rb', line 247

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_checks ⇒ Object

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



67
68
69
70
71
72
73
 
# File 'lib/brakeman/tracker.rb', line 67

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

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

#warnings ⇒ Object 



160
161
162
 
# File 'lib/brakeman/tracker.rb', line 160

def warnings
  self.checks.all_warnings
end