Class: Brakeman::Scanner

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

Overview

Scans the Rails application.

Direct Known Subclasses

Rescanner

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options, processor = nil) ⇒ Scanner

Pass in path to the root of the Rails application



21
22
23
24
25
26
27
28
29
30
 
# File 'lib/brakeman/scanner.rb', line 21

def initialize options, processor = nil
  @options = options
  @app_tree = Brakeman::AppTree.from_options(options)

  if (!@app_tree.root || !@app_tree.exists?("app")) && !options[:force_scan]
    raise Brakeman::NoApplication, "Please supply the path to a Rails application (looking in #{@app_tree.root})."
  end

  @processor = processor || Brakeman::Processor.new(@app_tree, options)
end

Instance Attribute Details

#options ⇒ Object (readonly)

Returns the value of attribute options.



18
19
20
 
# File 'lib/brakeman/scanner.rb', line 18

def options
  @options
end

Instance Method Details

#guess_rails_version ⇒ Object

Set :rails3/:rails4 option if version was not determined from Gemfile



164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
 
# File 'lib/brakeman/scanner.rb', line 164

def guess_rails_version
  unless tracker.options[:rails3] or tracker.options[:rails4]
    if @app_tree.exists?("script/rails")
      tracker.options[:rails3] = true
      Brakeman.notify "[Notice] Detected Rails 3 application"
    elsif @app_tree.exists?("app/channels")
      tracker.options[:rails3] = true
      tracker.options[:rails4] = true
      tracker.options[:rails5] = true
      Brakeman.notify "[Notice] Detected Rails 5 application"
    elsif not @app_tree.exists?("script")
      tracker.options[:rails3] = true
      tracker.options[:rails4] = true
      Brakeman.notify "[Notice] Detected Rails 4 application"
    end
  end
end

#index_call_sites ⇒ Object 



320
321
322
 
# File 'lib/brakeman/scanner.rb', line 320

def index_call_sites
  tracker.index_call_sites
end

#parse_files ⇒ Object 



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/brakeman/scanner.rb', line 67

def parse_files
  fp = Brakeman::FileParser.new tracker

  files = {
    :initializers => @app_tree.initializer_paths,
    :controllers => @app_tree.controller_paths,
    :models => @app_tree.model_paths
  }

  unless options[:skip_libs]
    files[:libs] = @app_tree.lib_paths
  end

  files.each do |name, paths|
    fp.parse_files paths, name
  end

  template_parser = Brakeman::TemplateParser.new(tracker, fp)

  fp.read_files(@app_tree.template_paths, :templates) do |path, contents|
    template_parser.parse_template path, contents
  end

  @file_list = fp.file_list
end

#parse_ruby_file(file) ⇒ Object 



324
325
326
327
 
# File 'lib/brakeman/scanner.rb', line 324

def parse_ruby_file file
  fp = Brakeman::FileParser.new(self.tracker)
  fp.parse_ruby(file.read, file)
end

#process ⇒ Object

Process everything in the Rails application



38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/brakeman/scanner.rb', line 38

def process
  Brakeman.notify "Processing gems..."
  process_gems
  guess_rails_version
  Brakeman.notify "Processing configuration..."
  process_config
  Brakeman.notify "Parsing files..."
  parse_files
  Brakeman.notify "Processing initializers..."
  process_initializers
  Brakeman.notify "Processing libs..."
  process_libs
  Brakeman.notify "Processing routes...          "
  process_routes
  Brakeman.notify "Processing templates...       "
  process_templates
  Brakeman.notify "Processing data flow in templates..."
  process_template_data_flows
  Brakeman.notify "Processing models...          "
  process_models
  Brakeman.notify "Processing controllers...     "
  process_controllers
  Brakeman.notify "Processing data flow in controllers..."
  process_controller_data_flows
  Brakeman.notify "Indexing call sites...        "
  index_call_sites
  tracker
end

#process_config ⇒ Object

Process config/environment.rb and config/gems.rb

Stores parsed information in tracker.config



96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'lib/brakeman/scanner.rb', line 96

def process_config
  if options[:rails3] or options[:rails4] or options[:rails5] or options[:rails6]
    process_config_file "application.rb"
    process_config_file "environments/production.rb"
  else
    process_config_file "environment.rb"
    process_config_file "gems.rb"
  end

  if @app_tree.exists?("vendor/plugins/rails_xss") or
    options[:rails3] or options[:escape_html]

    tracker.config.escape_html = true
    Brakeman.notify "[Notice] Escaping HTML by default"
  end

  if @app_tree.exists? ".ruby-version"
    tracker.config.set_ruby_version @app_tree.file_path(".ruby-version").read
  end
end

#process_controller(astfile) ⇒ Object 



258
259
260
261
262
263
264
 
# File 'lib/brakeman/scanner.rb', line 258

def process_controller astfile
  begin
    @processor.process_controller(astfile.ast, astfile.path)
  rescue => e
    tracker.error e.exception(e.message + "\nWhile processing #{astfile.path}"), e.backtrace
  end
end

#process_controller_data_flows ⇒ Object 



244
245
246
247
248
249
250
251
252
253
254
255
256
 
# File 'lib/brakeman/scanner.rb', line 244

def process_controller_data_flows
  controllers = tracker.controllers.sort_by { |name, _| name.to_s }

  track_progress controllers, "controllers" do |name, controller|
    Brakeman.debug "Processing #{name}"
    controller.src.each do |file, src|
      @processor.process_controller_alias name, src, nil, file
    end
  end

  #No longer need these processed filter methods
  tracker.filter_cache.clear
end

#process_controllers ⇒ Object

Process all .rb files in controllers/

Adds processed controllers to tracker.controllers



237
238
239
240
241
242
 
# File 'lib/brakeman/scanner.rb', line 237

def process_controllers
  track_progress @file_list[:controllers] do |controller|
    Brakeman.debug "Processing #{controller.path}"
    process_controller controller
  end
end

#process_gems ⇒ Object

Process Gemfile



132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
 
# File 'lib/brakeman/scanner.rb', line 132

def process_gems
  gem_files = {}

  if @app_tree.exists? "Gemfile"
    file = @app_tree.file_path("Gemfile")
    gem_files[:gemfile] = { :src => parse_ruby_file(file), :file => file }
  elsif @app_tree.exists? "gems.rb"
    file = @app_tree.file_path("gems.rb")
    gem_files[:gemfile] = { :src => parse_ruby_file(file), :file => file }
  end

  if @app_tree.exists? "Gemfile.lock"
    file = @app_tree.file_path("Gemfile.lock")
    gem_files[:gemlock] = { :src => file.read, :file => file }
  elsif @app_tree.exists? "gems.locked"
    file = @app_tree.file_path("gems.locked")
    gem_files[:gemlock] = { :src => file.read, :file => file }
  end

  if @app_tree.gemspec
    gem_files[:gemspec] = { :src => parse_ruby_file(@app_tree.gemspec), :file => @app_tree.gemspec }
  end

  if not gem_files.empty?
    @processor.process_gems gem_files
  end
rescue => e
  Brakeman.notify "[Notice] Error while processing Gemfile."
  tracker.error e.exception(e.message + "\nWhile processing Gemfile"), e.backtrace
end

#process_initializer(init) ⇒ Object

Process an initializer



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

def process_initializer init
  @processor.process_initializer(init.path, init.ast)
end

#process_initializers ⇒ Object

Process all the .rb files in config/initializers/

Adds parsed information to tracker.initializers



185
186
187
188
189
190
 
# File 'lib/brakeman/scanner.rb', line 185

def process_initializers
  track_progress @file_list[:initializers] do |init|
    Brakeman.debug "Processing #{init[:path]}"
    process_initializer init
  end
end

#process_lib(lib) ⇒ Object

Process a library



213
214
215
 
# File 'lib/brakeman/scanner.rb', line 213

def process_lib lib
  @processor.process_lib lib.ast, lib.path
end

#process_libs ⇒ Object

Process all .rb in lib/

Adds parsed information to tracker.libs.



200
201
202
203
204
205
206
207
208
209
210
 
# File 'lib/brakeman/scanner.rb', line 200

def process_libs
  if options[:skip_libs]
    Brakeman.notify '[Skipping]'
    return
  end

  track_progress @file_list[:libs] do |lib|
    Brakeman.debug "Processing #{lib.path}"
    process_lib lib
  end
end

#process_model(path, ast) ⇒ Object 



301
302
303
 
# File 'lib/brakeman/scanner.rb', line 301

def process_model path, ast
  @processor.process_model(ast, path)
end

#process_models ⇒ Object

Process all the .rb files in models/

Adds the processed models to tracker.models



294
295
296
297
298
299
 
# File 'lib/brakeman/scanner.rb', line 294

def process_models
  track_progress @file_list[:models] do |model|
    Brakeman.debug "Processing #{model[:path]}"
    process_model model[:path], model[:ast]
  end
end

#process_routes ⇒ Object

Process config/routes.rb

Adds parsed information to tracker.routes



220
221
222
223
224
225
226
227
228
229
230
231
232
 
# File 'lib/brakeman/scanner.rb', line 220

def process_routes
  if @app_tree.exists?("config/routes.rb")
    file = @app_tree.file_path("config/routes.rb")
    if routes_sexp = parse_ruby_file(file)
      @processor.process_routes routes_sexp
    else
      Brakeman.notify "[Notice] Error while processing routes - assuming all public controller methods are actions."
      options[:assume_all_routes] = true
    end
  else
    Brakeman.notify "[Notice] No route information found"
  end
end

#process_template(template) ⇒ Object 



278
279
280
 
# File 'lib/brakeman/scanner.rb', line 278

def process_template template
  @processor.process_template(template.name, template.ast, template.type, nil, template.path)
end

#process_template_data_flows ⇒ Object 



282
283
284
285
286
287
288
289
 
# File 'lib/brakeman/scanner.rb', line 282

def process_template_data_flows
  templates = tracker.templates.sort_by { |name, _| name.to_s }

  track_progress templates, "templates" do |name, template|
    Brakeman.debug "Processing #{name}"
    @processor.process_template_alias template
  end
end

#process_templates ⇒ Object

Process all views and partials in views/

Adds processed views to tracker.views



269
270
271
272
273
274
275
276
 
# File 'lib/brakeman/scanner.rb', line 269

def process_templates
  templates = @file_list[:templates].sort_by { |t| t[:path] }

  track_progress templates, "templates" do |template|
    Brakeman.debug "Processing #{template[:path]}"
    process_template template
  end
end

#report_progress(current, total, type = "files") ⇒ Object 



315
316
317
318
 
# File 'lib/brakeman/scanner.rb', line 315

def report_progress(current, total, type = "files")
  return unless @options[:report_progress]
  $stderr.print " #{current}/#{total} #{type} processed\r"
end

#track_progress(list, type = "files") ⇒ Object 



305
306
307
308
309
310
311
312
313
 
# File 'lib/brakeman/scanner.rb', line 305

def track_progress list, type = "files"
  total = list.length
  current = 0
  list.each do |item|
    report_progress current, total, type
    current += 1
    yield item
  end
end

#tracker ⇒ Object

Returns the Tracker generated from the scan



33
34
35
 
# File 'lib/brakeman/scanner.rb', line 33

def tracker
  @processor.tracked_events
end