Module: PWN::Plugins::DefectDojo

Defined in:
lib/pwn/plugins/defect_dojo.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

.authors ⇒ Object

Author(s)

0day Inc. <[email protected]>



684
685
686
687
688
 
# File 'lib/pwn/plugins/defect_dojo.rb', line 684

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

.engagement_create(opts = {}) ⇒ Object

Supported Method Parameters

engagement_create_response = PWN::Plugins::DefectDojo.engagement_create(

dd_obj: 'required - dd_obj returned from #login method',
name: 'required - name of the engagement',
description: 'optional - description of engagement',
engagement_type: 'optional - type of engagement Interactive||CI/CD (defaults to CI/CD)',
status: 'optional - status of the engagement In Progress || On Hold (defaults to In Progress)',
lead_username: 'required - username of lead to tie to engagement',
product_name: 'required - product name in which to create engagement',
test_strategy: 'required - URL of test strategy documentation (e.g. OWASP ASVS URL)',
orchestration_engine: 'optional - name of orchestration engine tied to CI/CD engagement',
build_server: 'optional - name of build server tied to CI/CD engagement',
scm_server: 'optional - name of SCM server tied to CI/CD engagement',
api_test: 'optional - boolean to set an engagement as an api assessment (defaults to false)',
pen_test: 'optional - boolean to set an engagement as a manual penetration test (defaults to false)',
threat_model: 'optional - boolean to set an engagement as a threat model (defaults to false)',
check_list: 'optional - boolean to set an engagement as a checkbox assessment (defaults to false)',
first_contacted: 'optional - date of engagement request e.g. 2018-06-18 (Defaults to current day)',
target_start: 'optional - date to start enagement e.g. 2018-06-19 (Defaults to current day)',
target_end: 'optional - date of engagement completion e.g. 2018-06-20 (Defaults to current day)'

)



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
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
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
 
# File 'lib/pwn/plugins/defect_dojo.rb', line 240

public_class_method def self.engagement_create(opts = {})
  http_body = {}

  dd_obj = opts[:dd_obj]
  api_version = dd_obj[:api_version]

  # HTTP POST body options w/ optional params set to default values
  # Defaults to true
  http_body[:active] = true

  http_body[:name] = opts[:name]

  http_body[:description] = opts[:description]

  opts[:engagment_type] ? (http_body[:engagement_type] = opts[:engagement_type]) : (http_body[:engagement_type] = 'CI/CD')

  status = opts[:status].to_s.strip.chomp.scrub

  case status
  when 'In Progress', 'On Hold', ''
    # Defaults to 'In Progress'
    status == '' ? (http_body[:status] = 'In Progress') : (http_body[:status] = status)
  when 'Completed'
    raise 'Completed status not implemented for #engagement_create - use #engagement_update instead'
  else
    raise "Unknown engagement status: #{opts[:status]}.  Options for this method are 'In Progress' || 'On Hold'"
  end

  # Ok lets determine the resource_uri for the lead username
  lead_username = opts[:lead_username].to_s.strip.chomp.scrub
  user_list = self.user_list(dd_obj: dd_obj)
  if api_version == 'v1'
    user_by_username_object = user_list[:objects].select do |user|
      user[:username] == lead_username
    end
    http_body[:lead] = user_by_username_object.first[:resource_uri]
  end

  if api_version == 'v2'
    user_by_username_object = user_list[:results].select do |user|
      user[:username] == lead_username
    end
    # Should only ever return 1 result so we should be good here
    http_body[:lead] = user_by_username_object.first[:id]
  end

  # Ok lets determine the resource_uri for the product name
  product_name = opts[:product_name].to_s.strip.chomp.scrub
  product_list = self.product_list(dd_obj: dd_obj)

  if api_version == 'v1'
    product_by_name_object = product_list[:objects].select do |prod|
      prod[:name] == product_name
    end
    # Should only ever return 1 result so we should be good here
    http_body[:product] = product_by_name_object.first[:resource_uri]
  end

  if api_version == 'v2'
    product_by_name_object = product_list[:results].select do |prod|
      prod[:name] == product_name
    end
    # Should only ever return 1 result so we should be good here
    http_body[:product] = product_by_name_object.first[:id]
  end

  http_body[:test_strategy] = opts[:test_strategy]

  # Ok lets determine the resource_uri orchestration, build_server, and scm_server
  orchestration_engine = opts[:orchestration_engine].to_s.strip.chomp.scrub
  http_body[:orchestration_engine] = tool_configuration_resource_uri_by_name(
    dd_obj: dd_obj,
    tool_config_name: orchestration_engine
  )

  build_server = opts[:build_server].to_s.strip.chomp.scrub
  http_body[:build_server] = tool_configuration_resource_uri_by_name(
    dd_obj: dd_obj,
    tool_config_name: build_server
  )

  scm_server = opts[:scm_server].to_s.strip.chomp.scrub
  http_body[:source_code_management_server] = tool_configuration_resource_uri_by_name(
    dd_obj: dd_obj,
    tool_config_name: scm_server
  )

  # Defaults to false
  opts[:api_test] ? (http_body[:api_test] = true) : (http_body[:api_test] = false)

  # Defaults to false
  opts[:pen_test] ? (http_body[:pen_test] = true) : (http_body[:pen_test] = false)

  # Defaults to false
  opts[:threat_model] ? (http_body[:threat_model] = true) : (http_body[:threat_model] = false)

  # Defaults to false
  opts[:check_list] ? (http_body[:check_list] = true) : (http_body[:check_list] = false)

  # Defaults to Time.now.strftime('%Y-%m-%d')
  opts[:first_contacted] ? (http_body[:first_contacted] = opts[:first_contacted]) : (http_body[:first_contacted] = Time.now.strftime('%Y-%m-%d'))

  # Defaults to Time.now.strftime('%Y-%m-%d')
  opts[:target_start] ? (http_body[:target_start] = opts[:target_start]) : (http_body[:target_start] = Time.now.strftime('%Y-%m-%d'))

  # Defaults to Time.now.strftime('%Y-%m-%d')
  opts[:target_end] ? (http_body[:target_end] = opts[:target_end]) : (http_body[:target_end] = Time.now.strftime('%Y-%m-%d'))

  # Defaults to false
  http_body[:done_testing] = false

  rest_call(
    dd_obj: dd_obj,
    rest_call: 'engagements/',
    http_method: :post,
    http_body: http_body
  )
rescue StandardError => e
  raise e
end

.engagement_list(opts = {}) ⇒ Object

Supported Method Parameters

engagement_list = PWN::Plugins::DefectDojo.engagement_list(

dd_obj: 'required dd_obj returned from #login method',
id: 'optional - retrieve single engagement by id, otherwise return all'

)



203
204
205
206
207
208
209
210
211
212
213
214
215
216
 
# File 'lib/pwn/plugins/defect_dojo.rb', line 203

public_class_method def self.engagement_list(opts = {})
  dd_obj = opts[:dd_obj]
  opts[:id] ? (rest_call = "engagements/#{opts[:id].to_i}") : (rest_call = 'engagements')

  response = rest_call(
    dd_obj: dd_obj,
    rest_call: rest_call
  )

  # Return array containing the post-authenticated DefectDojo REST API token
  JSON.parse(response, symbolize_names: true)
rescue StandardError => e
  raise e
end

.finding_list(opts = {}) ⇒ Object

Supported Method Parameters

finding_list = PWN::Plugins::DefectDojo.finding_list(

dd_obj: 'required dd_obj returned from #login method',
id: 'optional - retrieve single finding by id, otherwise return all'

)



611
612
613
614
615
616
617
618
619
620
621
622
623
624
 
# File 'lib/pwn/plugins/defect_dojo.rb', line 611

public_class_method def self.finding_list(opts = {})
  dd_obj = opts[:dd_obj]
  opts[:id] ? (rest_call = "findings/#{opts[:id].to_i}") : (rest_call = 'findings')

  response = rest_call(
    dd_obj: dd_obj,
    rest_call: rest_call
  )

  # Return array containing the post-authenticated DefectDojo REST API token
  JSON.parse(response, symbolize_names: true)
rescue StandardError => e
  raise e
end

.help ⇒ Object

Display Usage for this Module



692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
 
# File 'lib/pwn/plugins/defect_dojo.rb', line 692

public_class_method def self.help
  puts "USAGE:
    dd_obj = #{self}.login(
      url: 'required - url of DefectDojo Server',
      api_version: 'required - api version to use v1 || v2',
      username: 'required - username to AuthN w/ api v1)',
      api_key: 'optional - defect dojo api key (will prompt if nil)',
      proxy: 'optional - proxy all traffic through MITM proxy (defaults to nil)'
    )

    product_list = #{self}.product_list(
      dd_obj: 'required dd_obj returned from #login_v1 method',
      id: 'optional - retrieve single product by id, otherwise return all'
    )

    engagement_list = #{self}.engagement_list(
      dd_obj: 'required dd_obj returned from #login_v1 method',
      id: 'optional - retrieve single engagement by id, otherwise return all'
    )

    engagement_create_response = #{self}.engagement_create(
      dd_obj: 'required - dd_obj returned from #login_v1 method',
      name: 'required - name of the engagement',
      description: 'optional - description of engagement',
      engagement_type: 'optional - type of engagement Interactive||CI/CD (defaults to CI/CD)',
      status: 'optional - status of the engagement In Progress || On Hold (defaults to In Progress)',
      lead_username: 'required - username of lead to tie to engagement',
      product_name: 'required - product name in which to create engagement',
      test_strategy: 'required - URL of test strategy documentation (e.g. OWASP ASVS URL)',
      orchestration_engine: 'optional - name of orchestration engine tied to CI/CD engagement',
      build_server: 'optional - name of build server tied to CI/CD engagement',
      scm_server: 'optional - name of SCM server tied to CI/CD engagement',
      api_test: 'optional - boolean to set an engagement as an api assessment (defaults to false)',
      pen_test: 'optional - boolean to set an engagement as a manual penetration test (defaults to false)',
      threat_model: 'optional - boolean to set an engagement as a threat model (defaults to false)',
      check_list: 'optional - boolean to set an engagement as a checkbox assessment (defaults to false)',
      first_contacted: 'optional - date of engagement request e.g. 2018-06-18 (Defaults to current day)',
      target_start: 'optional - date to start enagement e.g. 2018-06-19 (Defaults to current day)',
      target_end: 'optional - date of engagement completion e.g. 2018-06-20 (Defaults to current day)'
    )

    test_list = #{self}.test_list(
      dd_obj: 'required dd_obj returned from #login_v1 method',
      id: 'optional - retrieve single test by id, otherwise return all'
    )

    importscan_response = #{self}.importscan(
      dd_obj: 'required - dd_obj returned from #login_v1 method',
      engagement_name: 'required - name of engagement to associate w/ scan',
      scan_type: 'required - type of scan importing (see <DEFECTDOJO_URL>/admin/dojo/test_type/ for listing)',
      file: 'required - path of scan results file',
      lead_username: 'required - username of lead to tie to scan',
      tags: 'optional - comma-delimited list of tag names to tie to scan',
      minimum_severity: 'optional - minimum finding severity Info||Low||Medium||High||Critical (Defaults to Info)',
      scan_date: 'optional - date in which scan was kicked off (defaults to now)',
      verified: 'optional - flag finding as verified by a tester (defaults to false)',
      create_finding_groups: 'optional - flag to create finding groups (defaults to false)',
      close_old_findings_product_scope: 'optional - flag to close old findings from engagement (defaults to false)',
      close_old_findings: 'optional - flag to close old findings, regardless of engagement (defaults to false)',
      push_to_jira: 'optional - flag to push findings to JIRA (defaults to false)'
    )

    reimportscan_response = #{self}.reimportscan(
      dd_obj: 'required - dd_obj returned from #login_v1 method',
      engagement_name: 'required - name of engagement to associate w/ scan',
      scan_type: 'required - type of scan importing (see <DEFECTDOJO_URL>/admin/dojo/test_type/ for listing)',
      file: 'required - path of scan results file',
      tags: 'optional - comma-delimited list of tag names to tie to scan for unique test resource_uri retrival',
      test_resource_uri: 'optional - alternative to tag names to know which test to reimport',
      minimum_severity: 'optional - minimum finding severity Info||Low||Medium||High||Critical (Defaults to Info)',
      scan_date: 'optional - date in which scan was kicked off (defaults to now)',
      verified: 'optional - flag finding as verified by a tester (defaults to false)',
      create_finding_groups: 'optional - flag to create finding groups (defaults to false)',
      close_old_findings_product_scope: 'optional - flag to close old findings from engagement (defaults to false)',
      close_old_findings: 'optional - flag to close old findings, regardless of engagement (defaults to false)',
      push_to_jira: 'optional - flag to push findings to JIRA (defaults to false)'
    )

    finding_list = #{self}.finding_list(
      dd_obj: 'required dd_obj returned from #login_v1 method',
      id: 'optional - retrieve single finding by id, otherwise return all'
    )

    user_list = #{self}.user_list(
      dd_obj: 'required dd_obj returned from #login_v1 method',
      id: 'optional - retrieve single user by id, otherwise return all'
    )

    tool_configuration_list = #{self}.tool_configuration_list(
      dd_obj: 'required dd_obj returned from #login_v1 method',
      id: 'optional - retrieve single test by id, otherwise return all'
    )

    #{self}.logout(
      dd_obj: 'required dd_obj returned from #login_v1 or #login_v2 method'
    )

    #{self}.authors
  "
end

.importscan(opts = {}) ⇒ Object

Supported Method Parameters

importscan_response = PWN::Plugins::DefectDojo.importscan(

dd_obj: 'required - dd_obj returned from #login method',
engagement_name: 'required - name of engagement to associate w/ scan',
scan_type: 'required - type of scan importing (see <DEFECTDOJO_URL>/admin/dojo/test_type/ for listing)',
file: 'required - path of scan results file',
lead_username: 'required - username of lead to tie to scan',
tags: 'optional - comma-delimited list of tag names to tie to scan',
minimum_severity: 'optional - minimum finding severity Info||Low||Medium||High||Critical (Defaults to Info)',
scan_date: 'optional - date in which scan was kicked off (defaults to now)',
verified: 'optional - flag finding as verified by a tester (defaults to false)',
create_finding_groups: 'optional - flag to create finding groups (defaults to false)'
close_old_findings_product_scope: 'optional - flag to close old findings from engagement (defaults to false)',
close_old_findings: 'optional - flag to close old findings, regardless of engagement (defaults to false)',
push_to_jira: 'optional - flag to push findings to JIRA (defaults to false)'

)



399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
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
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
 
# File 'lib/pwn/plugins/defect_dojo.rb', line 399

public_class_method def self.importscan(opts = {})
  http_body = {}

  dd_obj = opts[:dd_obj]
  api_version = dd_obj[:api_version]

  # HTTP POST body options w/ optional params set to default values
  # Defaults to true
  http_body[:active] = true

  # Ok lets determine the resource_uri for the engagement name
  engagement_name = opts[:engagement_name].to_s.strip.chomp.scrub
  engagement_list = self.engagement_list(dd_obj: dd_obj)

  if api_version == 'v1'
    engagement_by_name_object = engagement_list[:objects].select do |engagement|
      engagement[:name] == engagement_name
    end
    # Should only ever return 1 result so we should be good here
    http_body[:engagement] = engagement_by_name_object.first[:resource_uri]
  end

  if api_version == 'v2'
    engagement_by_name_object = engagement_list[:results].select do |engagement|
      engagement[:name] == engagement_name
    end
    # Should only ever return 1 result so we should be good here
    http_body[:engagement] = engagement_by_name_object.first[:id]
  end

  http_body[:scan_type] = opts[:scan_type].to_s.strip.chomp.scrub

  # Necessary to upload file to remote host
  http_body[:multipart] = true
  http_body[:file] = File.new(opts[:file].to_s.strip.chomp.scrub, 'rb') if File.exist?(opts[:file].to_s.strip.chomp.scrub)

  # Ok lets determine the resource_uri for the lead username
  lead_username = opts[:lead_username].to_s.strip.chomp.scrub
  user_list = self.user_list(dd_obj: dd_obj)

  if api_version == 'v1'
    user_by_username_object = user_list[:objects].select do |user|
      user[:username] == lead_username
    end
    # Should only ever return 1 result so we should be good here
    http_body[:lead] = user_by_username_object.first[:resource_uri]
  end

  if api_version == 'v2'
    user_by_username_object = user_list[:results].select do |user|
      user[:username] == lead_username
    end
    # Should only ever return 1 result so we should be good here
    http_body[:lead] = user_by_username_object.first[:id]
  end

  http_body[:tags] = opts[:tags].to_s.strip.chomp.scrub.delete("\s").split(',') if opts[:tags]

  minimum_severity = opts[:minimum_severity].to_s.strip.chomp.scrub.downcase.capitalize
  case minimum_severity
  when '', 'Info', 'Low', 'Medium', 'High', 'Critical'
    # Defaults to 'Info'
    minimum_severity == '' ? (http_body[:minimum_severity] = 'Info') : (http_body[:minimum_severity] = minimum_severity)
  else
    raise "Unknown minimum severity: #{opts[:minimum_severity]}.  Options are Info||Low||Medium||High||Critical'"
  end

  # Defaults to Time.now.strftime('%Y-%m-%d')
  opts[:scan_date] ? (http_body[:scan_date] = opts[:scan_date]) : (http_body[:scan_date] = Time.now.strftime('%Y-%m-%d'))

  # Defaults to false
  opts[:verified] ? (http_body[:verified] = true) : (http_body[:verified] = false)

  opts[:create_finding_groups] ? (http_body[:create_finding_groups_for_all_findings] = true) : (http_body[:create_finding_groups_for_all_findings] = false)

  opts[:close_old_findings_product_scope] ? (http_body[:close_old_findings_product_scope] = true) : (http_body[:close_old_findings_product_scope] = false)

  opts[:close_old_findings] = true if opts[:close_old_findings_product_scope]

  opts[:close_old_findings] ? (http_body[:close_old_findings] = true) : (http_body[:close_old_findings] = false)

  opts[:push_to_jira] ? (http_body[:push_to_jira] = true) : (http_body[:push_to_jira] = false)

  api_path = 'import-scan/'
  api_path = 'importscan/' if api_version == 'v1'

  rest_call(
    dd_obj: dd_obj,
    rest_call: api_path,
    http_method: :post,
    http_body: http_body
  )
rescue StandardError => e
  raise e
end

.login(opts = {}) ⇒ Object

Supported Method Parameters

dd_obj = PWN::Plugins::DefectDojo.login(

url: 'required - url of DefectDojo Server',
api_version: 'required - api version to use v1 || v2',
username: 'required - username to AuthN w/ api v1)',
api_key: 'optional - defect dojo api key (will prompt if nil)',
proxy: 'optional - proxy all traffic through MITM proxy (defaults to nil)'

)



22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
 
# File 'lib/pwn/plugins/defect_dojo.rb', line 22

public_class_method def self.(opts = {})
  url = opts[:url]
  opts[:api_version] ? (api_version = opts[:api_version]) : (api_version = 'v2')
  username = opts[:username].to_s.scrub

  api_key = opts[:api_key].to_s.scrub
  api_key = PWN::Plugins::AuthenticationHelper.mask_password(prompt: 'API Key') if opts[:api_key].nil?

  proxy = opts[:proxy]

  dd_obj = {}
  dd_obj[:url] = url
  dd_obj[:authz_header] = "Token #{api_key}"
  dd_obj[:authz_header] = "ApiKey #{username}:#{api_key}" if api_version == 'v1'
  dd_obj[:proxy] = proxy
  dd_obj[:api_version] = api_version
  dd_obj[:api_version] = 'v1' if api_version == 'v1'

  dd_obj
rescue StandardError => e
  raise e
end

.logout(opts = {}) ⇒ Object

Supported Method Parameters

PWN::Plugins::DefectDojo.logout(

dd_obj: 'required dd_obj returned from #login method'

)



673
674
675
676
677
678
679
680
 
# File 'lib/pwn/plugins/defect_dojo.rb', line 673

public_class_method def self.logout(opts = {})
  dd_obj = opts[:dd_obj]
  @@logger.info('Logging out...')
  # TODO: Terminate Session if Possible via API Call
  dd_obj = nil
rescue StandardError => e
  raise e
end

.product_list(opts = {}) ⇒ Object

Supported Method Parameters

product_list = PWN::Plugins::DefectDojo.product_list(

dd_obj: 'required dd_obj returned from #login method',
id: 'optional - retrieve single product by id, otherwise return all'

)



182
183
184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/pwn/plugins/defect_dojo.rb', line 182

public_class_method def self.product_list(opts = {})
  dd_obj = opts[:dd_obj]
  opts[:id] ? (rest_call = "products/#{opts[:id].to_i}") : (rest_call = 'products')

  response = rest_call(
    dd_obj: dd_obj,
    rest_call: rest_call
  )

  # Return array containing the post-authenticated DefectDojo REST API token
  JSON.parse(response, symbolize_names: true)
rescue StandardError => e
  raise e
end

.reimportscan(opts = {}) ⇒ Object

Supported Method Parameters

reimportscan_response = PWN::Plugins::DefectDojo.reimportscan(

dd_obj: 'required - dd_obj returned from #login method',
engagement_name: 'required - name of engagement to associate w/ scan',
scan_type: 'required - type of scan importing (see <DEFECTDOJO_URL>/admin/dojo/test_type/ for listing)',
file: 'required - path of scan results file',
tags: 'optional - comma-delimited list of tag names to tie to scan for unique test resource_uri retrival',
test_resource_uri: 'optional - alternative to tag names to know which test to reimport',
minimum_severity: 'optional - minimum finding severity Info||Low||Medium||High||Critical (Defaults to Info)',
scan_date: 'optional - date in which scan was kicked off (defaults to now)',
verified: 'optional - flag finding as verified by a tester (defaults to false)',
create_finding_groups: 'optional - flag to create finding groups (defaults to false)',
close_old_findings_product_scope: 'optional - flag to close old findings from engagement (defaults to false)',
close_old_findings: 'optional - flag to close old findings, regardless of engagement (defaults to false)',
push_to_jira: 'optional - flag to push findings to JIRA (defaults to false)'

)



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
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
 
# File 'lib/pwn/plugins/defect_dojo.rb', line 512

public_class_method def self.reimportscan(opts = {})
  http_body = {}

  dd_obj = opts[:dd_obj]
  api_version = dd_obj[:api_version]

  # HTTP POST body options w/ optional params set to default values
  # Defaults to true
  http_body[:active] = true

  # Ok lets determine the resource_uri for the engagement name
  engagement_name = opts[:engagement_name].to_s.strip.chomp.scrub
  engagement_list = self.engagement_list(dd_obj: dd_obj)
  if api_version == 'v1'
    engagement_by_name_object = engagement_list[:objects].select do |engagement|
      engagement[:name] == engagement_name
    end
    # Should only ever return 1 result so we should be good here
    engagement_resource_uri = engagement_by_name_object.first[:resource_uri]
  end

  if api_version == 'v2'
    engagement_by_name_object = engagement_list[:results].select do |engagement|
      engagement[:name] == engagement_name
    end
    # Should only ever return 1 result so we should be good here
    engagement_resource_uri = engagement_by_name_object.first[:id]
  end

  # TODO: lookup scan_type for test resource_uri since the scan_type should never change
  http_body[:scan_type] = opts[:scan_type].to_s.strip.chomp.scrub

  # Necessary to upload file to remote host
  http_body[:multipart] = true
  http_body[:file] = File.new(opts[:file].to_s.strip.chomp.scrub, 'rb') if File.exist?(opts[:file].to_s.strip.chomp.scrub)

  # Ok lets determine the resource_uri for the test we're looking to remimport
  test_list = self.test_list(dd_obj: dd_obj)

  if api_version == 'v1'
    tests_by_engagement_object = test_list[:objects].select do |test|
      test[:engagement] == engagement_resource_uri
    end
  end

  if api_version == 'v2'
    tests_by_engagement_object = test_list[:results].select do |test|
      test[:engagement] == engagement_resource_uri
    end
  end

  http_body[:tags] = opts[:tags].to_s.strip.chomp.scrub.delete("\s").split(',') if opts[:tags]

  http_body[:test] = opts[:test_resource_uri] if opts[:test_resource_uri]

  minimum_severity = opts[:minimum_severity].to_s.strip.chomp.scrub.downcase.capitalize
  case minimum_severity
  when '', 'Info', 'Low', 'Medium', 'High', 'Critical'
    # Defaults to 'Info'
    minimum_severity == '' ? (http_body[:minimum_severity] = 'Info') : (http_body[:minimum_severity] = minimum_severity)
  else
    raise "Unknown minimum severity: #{opts[:minimum_severity]}.  Options are Info||Low||Medium||High||Critical'"
  end

  # Defaults to Time.now.strftime('%Y-%m-%d')
  opts[:scan_date] ? (http_body[:scan_date] = opts[:scan_date]) : (http_body[:scan_date] = Time.now.strftime('%Y/%m/%d'))

  # Defaults to false
  opts[:verified] ? (http_body[:verified] = true) : (http_body[:verified] = false)

  opts[:create_finding_groups] ? (http_body[:create_finding_groups_for_all_findings] = true) : (http_body[:create_finding_groups_for_all_findings] = false)

  opts[:close_old_findings_product_scope] ? (http_body[:close_old_findings_product_scope] = true) : (http_body[:close_old_findings_product_scope] = false)

  opts[:close_old_findings] = true if opts[:close_old_findings_product_scope]

  opts[:close_old_findings] ? (http_body[:close_old_findings] = true) : (http_body[:close_old_findings] = false)

  opts[:push_to_jira] ? (http_body[:push_to_jira] = true) : (http_body[:push_to_jira] = false)

  api_path = 'reimport-scan/'
  api_path = 'reimportscan/' if api_version == 'v1'

  rest_call(
    dd_obj: dd_obj,
    rest_call: api_path,
    http_method: :post,
    http_body: http_body
  )
rescue StandardError => e
  raise e
end

.test_list(opts = {}) ⇒ Object

Supported Method Parameters

test_list = PWN::Plugins::DefectDojo.test_list(

dd_obj: 'required dd_obj returned from #login method',
id: 'optional - retrieve single test by id, otherwise return all'

)



367
368
369
370
371
372
373
374
375
376
377
378
379
380
 
# File 'lib/pwn/plugins/defect_dojo.rb', line 367

public_class_method def self.test_list(opts = {})
  dd_obj = opts[:dd_obj]
  opts[:id] ? (rest_call = "tests/#{opts[:id].to_i}") : (rest_call = 'tests')

  response = rest_call(
    dd_obj: dd_obj,
    rest_call: rest_call
  )

  # Return array containing the post-authenticated DefectDojo REST API token
  JSON.parse(response, symbolize_names: true)
rescue StandardError => e
  raise e
end

.tool_configuration_list(opts = {}) ⇒ Object

Supported Method Parameters

tool_configuration_list = PWN::Plugins::DefectDojo.tool_configuration_list(

dd_obj: 'required dd_obj returned from #login method',
id: 'optional - retrieve single test by id, otherwise return all'

)



653
654
655
656
657
658
659
660
661
662
663
664
665
666
 
# File 'lib/pwn/plugins/defect_dojo.rb', line 653

public_class_method def self.tool_configuration_list(opts = {})
  dd_obj = opts[:dd_obj]
  opts[:id] ? (rest_call = "tool_configurations/#{opts[:id].to_i}") : (rest_call = 'tool_configurations')

  response = rest_call(
    dd_obj: dd_obj,
    rest_call: rest_call
  )

  # Return array containing the post-authenticated DefectDojo REST API token
  JSON.parse(response, symbolize_names: true)
rescue StandardError => e
  raise e
end

.user_list(opts = {}) ⇒ Object

Supported Method Parameters

user_list = PWN::Plugins::DefectDojo.user_list(

dd_obj: 'required dd_obj returned from #login method',
id: 'optional - retrieve single user by id, otherwise return all'

)



632
633
634
635
636
637
638
639
640
641
642
643
644
645
 
# File 'lib/pwn/plugins/defect_dojo.rb', line 632

public_class_method def self.user_list(opts = {})
  dd_obj = opts[:dd_obj]
  opts[:id] ? (rest_call = "users/#{opts[:id].to_i}") : (rest_call = 'users')

  response = rest_call(
    dd_obj: dd_obj,
    rest_call: rest_call
  )

  # Return array containing the post-authenticated DefectDojo REST API token
  JSON.parse(response, symbolize_names: true)
rescue StandardError => e
  raise e
end