Module: PWN::Plugins::OwaspZap

Defined in:
lib/pwn/plugins/owasp_zap.rb

Overview

This plugin converts images to readable text TODO: Convert all rest requests to POST instead of GET

Constant Summary collapse

@@logger = 
PWN::Plugins::PWNLogger.create

Class Method Summary collapse

Class Method Details

.active_scan(opts = {}) ⇒ Object

Supported Method Parameters

PWN::Plugins::OwaspZap.active_scan(

zap_obj: 'required - zap_obj returned from #open method',
target:  'required - url to scan',
scan_policy: 'optional - scan policy to use (defaults to Default Policy)'

)



238
239
240
241
242
243
244
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
 
# File 'lib/pwn/plugins/owasp_zap.rb', line 238

public_class_method def self.active_scan(opts = {})
  zap_obj = opts[:zap_obj]
  api_key = zap_obj[:api_key].to_s.scrub
  target = opts[:target]
  if opts[:scan_policy].nil?
    scan_policy = 'Default Policy'
  else
    scan_policy = opts[:scan_policy].to_s.scrub.strip.chomp
  end

  # TODO: Implement adding target to scope so that inScopeOnly can be changed to true
  params = {
    apikey: api_key,
    url: target,
    recurse: true,
    inScopeOnly: true,
    scanPolicyName: scan_policy
  }

  response = zap_rest_call(
    zap_obj: zap_obj,
    rest_call: 'JSON/ascan/action/scan/',
    params: params
  )

  active_scan = JSON.parse(response.body, symbolize_names: true)
  active_scan_id = active_scan[:scan].to_i

  loop do
    params = {
      apikey: api_key,
      scanId: active_scan_id
    }

    response = zap_rest_call(
      zap_obj: zap_obj,
      rest_call: 'JSON/ascan/view/status/',
      params: params
    )

    active_scan = JSON.parse(response.body, symbolize_names: true)
    status = active_scan[:status].to_i
    puts "Active Scan ID: #{active_scan_id} => #{status}% Complete"
    break if status == 100
  end
rescue StandardError, SystemExit, Interrupt => e
  stop(zap_obj) unless zap_obj.nil?
  raise e
end

.alerts(opts = {}) ⇒ Object

Supported Method Parameters

PWN::Plugins::OwaspZap.alerts(

zap_obj: 'required - zap_obj returned from #open method',
target: 'required - base url to return alerts'

)



294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
 
# File 'lib/pwn/plugins/owasp_zap.rb', line 294

public_class_method def self.alerts(opts = {})
  zap_obj = opts[:zap_obj]
  api_key = zap_obj[:api_key].to_s.scrub
  target = opts[:target]

  params = {
    apikey: api_key,
    url: target
  }

  response = zap_rest_call(
    zap_obj: zap_obj,
    rest_call: 'JSON/core/view/alerts/',
    params: params
  )

  JSON.parse(response.body, symbolize_names: true)
rescue StandardError, SystemExit, Interrupt => e
  stop(zap_obj) unless zap_obj.nil?
  raise e
end

.authors ⇒ Object

Author(s)

0day Inc. <[email protected]>



483
484
485
486
487
 
# File 'lib/pwn/plugins/owasp_zap.rb', line 483

public_class_method def self.authors
  "AUTHOR(S):
    0day Inc. <[email protected]>
  "
end

.breakpoint(opts = {}) ⇒ Object

Supported Method Parameters

PWN::Plugins::OwaspZap.breakpoint(

zap_obj: 'required - zap_obj returned from #open method',
regex_type: 'required - :url, :request_header, :request_body, :response_header or :response_body',
regex_pattern: 'required - regex pattern to search for respective regex_type',
enabled: 'optional - boolean (defaults to true)'

)



371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
 
# File 'lib/pwn/plugins/owasp_zap.rb', line 371

public_class_method def self.breakpoint(opts = {})
  zap_obj = opts[:zap_obj]
  api_key = zap_obj[:api_key].to_s.scrub

  case opts[:regex_type].to_sym
  when :url, :request_header, :request_body, :response_header, :response_body
    regex_type = opts[:regex_type].to_sym
  else
    raise "Unknown regex_type: #{opts[:regex_type].to_sym}\noptions are :url, :request_header, :request_body, :response_header or :response_body"
  end
  regex_pattern = opts[:regex_pattern]
  enabled = opts[:enabled]

  enabled = true if enabled.nil?
  enabled ? (action = 'addHttpBreakpoint') : (action = 'removeHttpBreakpoint')

  zap_rest_call(
    zap_obj: zap_obj,
    rest_call: "JSON/break/action/#{action}/?zapapiformat=JSON&apikey=#{api_key}&string=#{regex_pattern}&location=#{regex_type}&match=regex&inverse=false&ignorecase=true",
    http_method: :get
  )
rescue StandardError, SystemExit, Interrupt => e
  stop(zap_obj) unless zap_obj.nil?
  raise e
end

.generate_report(opts = {}) ⇒ Object

Supported Method Parameters

report_path = PWN::Plugins::OwaspZap.generate_report(

zap_obj: 'required - zap_obj returned from #open method',
output_dir: 'required - directory to save report',
report_type: 'required - <html|markdown|xml>'

)



323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
 
# File 'lib/pwn/plugins/owasp_zap.rb', line 323

public_class_method def self.generate_report(opts = {})
  zap_obj = opts[:zap_obj]
  api_key = zap_obj[:api_key].to_s.scrub
  output_dir = opts[:output_dir] if Dir.exist?(opts[:output_dir])
  report_type = opts[:report_type].to_s.strip.chomp.scrub.to_sym

  params = {
    apikey: api_key
  }

  case report_type
  when :html
    report_path = "#{output_dir}/OWASP_Zap_Results.html"
    rest_call = 'OTHER/core/other/htmlreport/'
  when :markdown
    report_path = "#{output_dir}/OWASP_Zap_Results.md"
    rest_call = 'OTHER/core/other/mdreport/'
  when :xml
    report_path = "#{output_dir}/OWASP_Zap_Results.xml"
    rest_call = 'OTHER/core/other/xmlreport/'
  else
    raise @@logger.error("ERROR: Unsupported report type: #{report_type}\nValid report types are <html|markdown|xml>")
  end

  response = zap_rest_call(
    zap_obj: zap_obj,
    rest_call: rest_call,
    params: params
  )

  File.open(report_path, 'w') do |f|
    f.puts response.body
  end

  report_path
rescue StandardError, SystemExit, Interrupt => e
  stop(zap_obj) unless zap_obj.nil?
  raise e
end

.help ⇒ Object

Display Usage for this Module



491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
 
# File 'lib/pwn/plugins/owasp_zap.rb', line 491

public_class_method def self.help
  puts "USAGE:
    zap_obj = #{self}.start(
      api_key: 'required - api key for API authorization',
      zap_bin_path: 'optional - path to zap.sh file',
      headless: 'optional - run zap headless if set to true',
      proxy: 'optional - change local zap proxy listener (defaults to http://127.0.0.1:<Random 1024-65535>)'
    )
    puts zap_obj.public_methods

    #{self}.spider(
      zap_obj: 'required - zap_obj returned from #open method',
      target: 'required - url to spider'
    )

    #{self}.active_scan(
      zap_obj: 'required - zap_obj returned from #open method'
      target: 'required - url to scan',
      scan_policy: 'optional - scan policy to use (defaults to Default Policy)'
    )

    json_alerts = #{self}.alerts(
      zap_obj: 'required - zap_obj returned from #open method'
      target: 'required - base url to return alerts'
    )

    report_path = #{self}.generate_report(
      zap_obj: 'required - zap_obj returned from #open method',
      output_dir: 'required - directory to save report',
      report_type: 'required - <html|markdown|xml>'
    )

    #{self}.breakpoint(
      zap_obj: 'required - zap_obj returned from #open method',
      regex_type: 'required - :url, :request_header, :request_body, :response_header or :response_body',
      regex_pattern: 'required - regex pattern to search for respective regex_type',
      enabled: 'optional - boolean (defaults to true)'
    )

    watir_resp = #{self}.request(
      zap_obj: 'required - zap_obj returned from #open method',
      browser_obj: 'required - browser_obj w/ browser_type: :firefox||:headless returned from #open method',
      instruction: 'required - watir instruction to make (e.g. button(text: \"Google Search\").click)'
    )

    #{self}.stop(
      zap_obj: 'required - zap_obj returned from #start method'
    )

    #{self}.authors
  "
end

.request(opts = {}) ⇒ Object

Supported Method Parameters

watir_resp = PWN::Plugins::OwaspZap.request(

zap_obj: 'required - zap_obj returned from #open method',
browser_obj: 'required - browser_obj w/ browser_type: :firefox||:headless returned from #open method',
instruction: 'required - watir instruction to make (e.g. button(text: "Google Search").click)'

)



436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
 
# File 'lib/pwn/plugins/owasp_zap.rb', line 436

public_class_method def self.request(opts = {})
  zap_obj = opts[:zap_obj]
  api_key = zap_obj[:api_key].to_s.scrub
  this_browser_obj = opts[:browser_obj]
  instruction = opts[:instruction].to_s.strip.chomp.scrub

  raise "\nbrowser_obj.class == #{this_browser_obj.class} browser_obj == #{this_browser_obj}\n#{self}.nonblocking_goto only supports browser_obj.class == Watir::Browser" unless this_browser_obj.is_a?(Watir::Browser)
  raise "\nthis_browser_obj.driver.browser == #{this_browser_obj.driver.browser}\n#{self}.nonblocking_goto only supports this_browser_obj.driver.browser == :firefox" unless this_browser_obj.driver.browser == :firefox

  timeout = 0
  # this_browser_obj.driver.manage.timeouts.implicit_wait = timeout
  this_browser_obj.driver.manage.timeouts.page_load = timeout
  # this_browser_obj.driver.manage.timeouts.script_timeout = timeout

  watir_resp = this_browser_obj.instance_eval(instruction)
rescue Timeout::Error
  sleep 0.9
  request_content = zap_rest_call(
    zap_obj: zap_obj,
    rest_call: "JSON/break/view/httpMessage/?zapapiformat=JSON&apikey=#{api_key}",
    http_method: :get
  ).body

  # Now set all the timeouts back to default:
  # this_browser_obj.driver.manage.timeouts.implicit_wait = b.driver.capabilities[:implicit_timeout]
  this_browser_obj.driver.manage.timeouts.page_load = this_browser_obj.driver.capabilities[:page_load_timeout]
  # this_browser_obj.driver.manage.timeouts.script_timeout = b.driver.capabilities[:script_timeout]

  request_content
rescue StandardError => e
  raise e
end

.spider(opts = {}) ⇒ Object

Supported Method Parameters

PWN::Plugins::OwaspZap.spider(

zap_obj: 'required - zap_obj returned from #open method',
target: 'required - url to spider'

)



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/pwn/plugins/owasp_zap.rb', line 184

public_class_method def self.spider(opts = {})
  zap_obj = opts[:zap_obj]
  target = opts[:target].to_s.scrub
  api_key = zap_obj[:api_key].to_s.scrub

  # target_domain_name = URI.parse(target).host

  params = {
    apikey: api_key,
    url: target,
    maxChildren: 9,
    recurse: 3,
    contextName: '',
    subtreeOnly: target
  }

  response = zap_rest_call(
    zap_obj: zap_obj,
    rest_call: 'JSON/spider/action/scan/',
    params: params
  )

  spider = JSON.parse(response.body, symbolize_names: true)
  spider_id = spider[:scan].to_i

  loop do
    params = {
      apikey: api_key,
      scanId: spider_id
    }

    response = zap_rest_call(
      zap_obj: zap_obj,
      rest_call: 'JSON/spider/view/status/',
      params: params
    )

    spider = JSON.parse(response.body, symbolize_names: true)
    status = spider[:status].to_i
    puts "Spider ID: #{spider_id} => #{status}% Complete"
    break if status == 100
  end
rescue StandardError, SystemExit, Interrupt => e
  stop(zap_obj) unless zap_obj.nil?
  raise e
end

.start(opts = {}) ⇒ Object

Supported Method Parameters

zap_obj = PWN::Plugins::OwaspZap.start(

api_key: 'required - api key for API authorization',
zap_bin_path: 'optional - path to zap.sh file'
headless: 'optional - run zap headless if set to true',
proxy: 'optional - change local zap proxy listener (defaults to http://127.0.0.1:<Random 1024-65535>)',

)



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
 
# File 'lib/pwn/plugins/owasp_zap.rb', line 82

public_class_method def self.start(opts = {})
  zap_obj = {}
  api_key = opts[:api_key].to_s.scrub.strip.chomp
  zap_obj[:api_key] = api_key

  headless = if opts[:headless]
               true
             else
               false
             end

  if opts[:zap_bin_path]
    zap_bin_path = opts[:zap_bin_path].to_s.scrub.strip.chomp if File.exist?(opts[:zap_bin_path].to_s.scrub.strip.chomp)
  else
    underlying_os = PWN::Plugins::DetectOS.type

    case underlying_os
    when :linux
      zap_bin_path = '/usr/share/zaproxy/zap.sh'
    when :osx
      zap_bin_path = '/Applications/OWASP\ ZAP.app/Contents/Java/zap.sh'
    else
      raise "ERROR: zap.sh not found for #{underlying_os}. Please pass the :zap_bin_path parameter to this method for proper execution"
    end
  end

  zap_bin = File.basename(zap_bin_path)
  zap_dir = File.dirname(zap_bin_path)

  if headless
    owasp_zap_cmd = "cd #{zap_dir} && ./#{zap_bin} -daemon"
  else
    owasp_zap_cmd = "cd #{zap_dir} && ./#{zap_bin}"
  end

  random_port = PWN::Plugins::Sock.get_random_unused_port

  proxy = "http://127.0.0.1:#{random_port}"
  proxy = opts[:proxy].to_s.scrub.strip.chomp if opts[:proxy]

  proxy_uri = URI.parse(proxy)
  owasp_zap_cmd = "#{owasp_zap_cmd} -host #{proxy_uri.host} -port #{proxy_uri.port}"
  zap_obj[:host] = proxy_uri.host.to_s.scrub
  zap_obj[:port] = proxy_uri.port.to_i

  pwn_stdout_log_path = "/tmp/pwn_plugins_owasp-#{SecureRandom.hex}.log"
  pwn_stdout_log = File.new(pwn_stdout_log_path, 'w')
  # Immediately writes all buffered data in IO to disk
  pwn_stdout_log.sync = true
  pwn_stdout_log.fsync

  fork_pid = Process.fork do
    PTY.spawn(owasp_zap_cmd) do |stdout, _stdin, _pid|
      stdout.each do |line|
        puts line
        pwn_stdout_log.puts line
      end
    end
  rescue PTY::ChildExited, SystemExit, Interrupt, Errno::EIO
    puts 'Spawned OWASP Zap PTY exiting...'
    File.unlink(pwn_stdout_log_path)
  rescue StandardError => e
    puts 'Spawned process exiting...'
    File.unlink(pwn_stdout_log_path)
    raise e
  end
  Process.detach(fork_pid)

  zap_obj[:pid] = fork_pid
  zap_obj[:stdout_log] = pwn_stdout_log_path
  # This is how we'll know OWSAP Zap is in a ready state.
  # if headless
  #   return_pattern = '[ZAP-daemon] INFO org.zaproxy.zap.DaemonBootstrap  - ZAP is now listening'
  # else
  #   case underlying_os
  #   when :linux
  #     return_pattern = '[AWT-EventQueue-1] INFO hsqldb.db..ENGINE  - Database closed'
  #   when :osx
  #     return_pattern = '[AWT-EventQueue-0] INFO hsqldb.db..ENGINE  - Database closed'
  #   end
  # end
  return_pattern = 'Started callback service on'

  loop do
    return zap_obj if File.exist?(pwn_stdout_log_path) &&
                      File.read(
                        pwn_stdout_log_path
                      ).include?(return_pattern)

    sleep 3
  end
rescue StandardError, SystemExit, Interrupt => e
  stop(zap_obj) unless zap_obj.nil?
  raise e
end

.stop(opts = {}) ⇒ Object

Supported Method Parameters

PWN::Plugins::OwaspZap.stop(

:zap_obj => 'required - zap_obj returned from #start method'

)



474
475
476
477
478
479
 
# File 'lib/pwn/plugins/owasp_zap.rb', line 474

public_class_method def self.stop(opts = {})
  zap_obj = opts[:zap_obj]
  Process.kill('TERM', zap_obj[:pid]) unless zap_obj.nil?
rescue StandardError => e
  raise e
end

.tamper(opts = {}) ⇒ Object

Supported Method Parameters

PWN::Plugins::OwaspZap.tamper(

zap_obj: 'required - zap_obj returned from #open method',
domain: 'required - FQDN to tamper (e.g. test.domain.local)',
enabled: 'optional - boolean (defaults to true)'

)



404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
 
# File 'lib/pwn/plugins/owasp_zap.rb', line 404

public_class_method def self.tamper(opts = {})
  zap_obj = opts[:zap_obj]
  api_key = zap_obj[:api_key].to_s.scrub
  domain = opts[:domain]
  enabled = opts[:enabled]

  enabled = true if enabled.nil?
  enabled ? (action = 'addHttpBreakpoint') : (action = 'removeHttpBreakpoint')

  zap_rest_call(
    zap_obj: zap_obj,
    rest_call: "JSON/break/action/#{action}/?zapapiformat=JSON&apikey=#{api_key}&string=#{domain}&location=url&match=contains&inverse=false&ignorecase=true",
    http_method: :get
  )

  zap_rest_call(
    zap_obj: zap_obj,
    rest_call: "JSON/break/action/break/?zapapiformat=JSON&apikey=#{api_key}&type=http-request&state=#{enabled}",
    http_method: :get
  )
rescue StandardError, SystemExit, Interrupt => e
  stop(zap_obj) unless zap_obj.nil?
  raise e
end