Module: Brakeman::Options

Defined in:
lib/brakeman/options.rb

Overview

Parses command line arguments for Brakeman

Class Method Summary collapse

Class Method Details

.get_options(args, destructive = false) ⇒ Object

Return hash of options and the parser



20
21
22
23
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
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
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
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
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
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
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
 
# File 'lib/brakeman/options.rb', line 20

def get_options args, destructive = false
  options = {}

  parser = OptionParser.new do |opts|
    opts.banner = "Usage: brakeman [options] rails/root/path"

    opts.on "-n", "--no-threads", "Run checks sequentially" do
      options[:parallel_checks] = false
    end

    opts.on "--[no-]progress", "Show progress reports" do |progress|
      options[:report_progress] = progress
    end

    opts.on "-p", "--path PATH", "Specify path to Rails application" do |path|
      options[:app_path] = File.expand_path path
    end

    opts.on "-q", "--[no-]quiet", "Suppress informational messages" do |quiet|
      options[:quiet] = quiet
    end

    opts.on( "-z", "--exit-on-warn", "Exit code is non-zero if warnings found") do
      options[:exit_on_warn] = true
    end

    opts.on "-3", "--rails3", "Force Rails 3 mode" do
      options[:rails3] = true
    end

    opts.separator ""
    opts.separator "Scanning options:"

    opts.on "-a", "--assume-routes", "Assume all controller methods are actions" do
      options[:assume_all_routes] = true
    end

    opts.on "-e", "--escape-html", "Escape HTML by default" do
      options[:escape_html] = true
    end

    opts.on "--faster", "Faster, but less accurate scan" do
      options[:ignore_ifs] = true
      options[:skip_libs] = true
    end

    opts.on "--ignore-model-output", "Consider model attributes XSS-safe" do
      options[:ignore_model_output] = true
    end

    opts.on "--ignore-protected", "Consider models with attr_protected safe" do
      options[:ignore_attr_protected] = true
    end

    opts.on "--no-branching", "Disable flow sensitivity on conditionals" do
      options[:ignore_ifs] = true
    end

    opts.on "-r", "--report-direct", "Only report direct use of untrusted data" do |option|
      options[:check_arguments] = !option
    end

    opts.on "-s", "--safe-methods meth1,meth2,etc", Array, "Consider the specified methods safe" do |methods|
      options[:safe_methods] ||= Set.new
      options[:safe_methods].merge methods.map {|e| e.to_sym }
    end

    opts.on "--url-safe-methods method1,method2,etc", Array, "Do not warn of XSS if the link_to href parameter is wrapped in a safe method" do |methods|
      options[:url_safe_methods] ||= Set.new
      options[:url_safe_methods].merge methods.map {|e| e.to_sym }
    end        

    opts.on "--skip-files file1,file2,etc", Array, "Skip processing of these files" do |files|
      options[:skip_files] ||= Set.new
      options[:skip_files].merge files
    end

    opts.on "--skip-libs", "Skip processing lib directory" do
      options[:skip_libs] = true
    end

    opts.on "-t", "--test Check1,Check2,etc", Array, "Only run the specified checks" do |checks|
      checks.each_with_index do |s, index|
        if s[0,5] != "Check"
          checks[index] = "Check" << s
        end
      end

      options[:run_checks] ||= Set.new
      options[:run_checks].merge checks
    end

    opts.on "-x", "--except Check1,Check2,etc", Array, "Skip the specified checks" do |skip|
      skip.each do |s|
        if s[0,5] != "Check"
          s = "Check" << s
        end

        options[:skip_checks] ||= Set.new
        options[:skip_checks] << s
      end
    end

    opts.separator ""
    opts.separator "Output options:"

    opts.on "-d", "--debug", "Lots of output" do
      options[:debug] = true 
    end

    opts.on "-f", 
      "--format TYPE", 
      [:pdf, :text, :html, :csv, :tabs, :json],
      "Specify output formats. Default is text" do |type|

      type = "s" if type == :text
      options[:output_format] = ("to_" << type.to_s).to_sym
      end

    opts.on "--css-file CSSFile", "Specify CSS to use for HTML output" do |file|
      options[:html_style] = File.expand_path file
    end

    opts.on "-l", "--[no-]combine-locations", "Combine warning locations (Default)" do |combine|
      options[:combine_locations] = combine
    end

    opts.on "--[no-]highlights", "Highlight user input in report" do |highlight|
      options[:highlight_user_input] = highlight
    end

    opts.on "-m", "--routes", "Report controller information" do
      options[:report_routes] = true
    end

    opts.on "--message-limit LENGTH", "Limit message length in HTML report" do |limit|
      options[:message_limit] = limit.to_i
    end

    opts.on "-o", "--output FILE", "Specify files for output. Defaults to stdout. Multiple '-o's allowed" do |file|
      options[:output_files] ||= []
      options[:output_files].push(file)
    end

    opts.on "--separate-models", "Warn on each model without attr_accessible" do
      options[:collapse_mass_assignment] = false
    end

    opts.on "--summary", "Only output summary of warnings" do
      options[:summary_only] = true
    end

    opts.on "--relative-paths", "Output relative file paths in reports" do
      options[:relative_paths] = true
    end

    opts.on "-w", 
      "--confidence-level LEVEL", 
      ["1", "2", "3"], 
      "Set minimal confidence level (1 - 3)" do |level|

      options[:min_confidence] =  3 - level.to_i
    end

    opts.on "--compare FILE", "Compare the results of a previous brakeman scan (only JSON is supported)" do |file|
      options[:previous_results_json] = File.expand_path(file)
    end

    opts.separator ""
    opts.separator "Configuration files:"

    opts.on "-c", "--config-file FILE", "Use specified configuration file" do |file|
      options[:config_file] = File.expand_path(file)
    end

    opts.on "-C", "--create-config [FILE]", "Output configuration file based on options" do |file|
      if file
        options[:create_config] = file
      else
        options[:create_config] = true
      end
    end

    opts.separator ""

    opts.on "-k", "--checks", "List all available vulnerability checks" do
      options[:list_checks] = true
    end

    opts.on "--rake", "Create rake task to run Brakeman" do
      options[:install_rake_task] = true
    end

    opts.on "-v", "--version", "Show Brakeman version" do
      options[:show_version] = true
    end

    opts.on_tail "-h", "--help", "Display this message" do
      options[:show_help] = true
    end
  end

  if destructive
    parser.parse! args
  else
    parser.parse args
  end

  return options, parser
end

.parse(args) ⇒ Object

Parse argument array



10
11
12
 
# File 'lib/brakeman/options.rb', line 10

def parse args
  get_options args
end

.parse!(args) ⇒ Object

Parse arguments and remove them from the array as they are matched



15
16
17
 
# File 'lib/brakeman/options.rb', line 15

def parse! args
  get_options args, true
end