Module: PWN::Plugins::NessusCloud
- Defined in:
- lib/pwn/plugins/nessus_cloud.rb
Overview
This plugin is used for interacting w/ the Tenable.io REST API (i.e. Nessus Cloud)
Constant Summary collapse
Class Method Summary collapse
-
.authors ⇒ Object
- Author(s)
-
0day Inc.
-
.create_scan(opts = {}) ⇒ Object
- Supported Method Parameters
-
PWN::Plugins::NessusCloud.create_scan( nessus_obj: ‘required - nessus_obj returned from #login method’, scan_template_uuid: ‘required - the UUID for the Tenable-provided scan template to use. Run #get_canned_scan_templates for a list of UUIDs’, settings: ‘required - settings object as defined by developer.tenable.com/reference/scans-create’, credentials: ‘required - credentials object as defined by developer.tenable.com/reference/scans-create’, plugins: ‘optional - plugins object as defined by developer.tenable.com/reference/scans-create (Defaults to {})’ ).
-
.create_tag(opts = {}) ⇒ Object
- Supported Method Parameters
-
PWN::Plugins::NessusCloud.create_tag( nessus_obj: ‘required - nessus_obj returned from #login method’, category: ‘required - category name to create or use’, value: ‘required - tag value name to create or use’, desc: ‘optional - tag value description’ ).
-
.export_scan_results(opts = {}) ⇒ Object
- Supported Method Parameters
-
PWN::Plugins::NessusCloud.export_scan_results( nessus_obj: ‘required - nessus_obj returned from #login method’, scan_id: ‘required - scan uuid to export’, path_to_export: ‘required - filename to export results’, history_id: ‘optional - defaults to last scan’, format: ‘optional - :csv|:db|:html|:nessus|:pdf (defaults to :csv’) ).
-
.get_canned_scan_templates(opts = {}) ⇒ Object
- Supported Method Parameters
-
PWN::Plugins::NessusCloud.get_canned_scan_templates( nessus_obj: ‘required - nessus_obj returned from #login method’, name: ‘optional - name of scan template’ ).
-
.get_credential_types(opts = {}) ⇒ Object
- Supported Method Parameters
-
PWN::Plugins::NessusCloud.get_credential_types( nessus_obj: ‘required - nessus_obj returned from #login method’, category: ‘optional - category of credential type (Defaults to “Host”)’, name: ‘optional - name of credential type (Defaults to “SSH”)’ ) ).
-
.get_folders(opts = {}) ⇒ Object
- Supported Method Parameters
-
PWN::Plugins::NessusCloud.get_folders( nessus_obj: ‘required - nessus_obj returned from #login method’, name: ‘optional - name of folder’ ).
-
.get_policies(opts = {}) ⇒ Object
- Supported Method Parameters
-
PWN::Plugins::NessusCloud.get_policies( nessus_obj: ‘required - nessus_obj returned from #login method’, name: ‘optional - name of policy (i.e. user-defined template)’ ).
-
.get_scan_history(opts = {}) ⇒ Object
- Supported Method Parameters
-
PWN::Plugins::NessusCloud.get_scan_history( nessus_obj: ‘required - nessus_obj returned from #login method’ scan_id: ‘required - scan uuid to launch’ ).
-
.get_scan_status(opts = {}) ⇒ Object
- Supported Method Parameters
-
PWN::Plugins::NessusCloud.get_scan_status( nessus_obj: ‘required - nessus_obj returned from #login method’, scan_id: ‘required - scan uuid to retrieve status’ ).
-
.get_scanners(opts = {}) ⇒ Object
- Supported Method Parameters
-
PWN::Plugins::NessusCloud.get_scanners( nessus_obj: ‘required - nessus_obj returned from #login method’, name: ‘optional - name of scanner’ ).
-
.get_scans(opts = {}) ⇒ Object
- Supported Method Parameters
-
PWN::Plugins::NessusCloud.get_scans( nessus_obj: ‘required - nessus_obj returned from #login method’ ).
-
.get_tag_values(opts = {}) ⇒ Object
- Supported Method Parameters
-
PWN::Plugins::NessusCloud.get_tag_values( nessus_obj: ‘required - nessus_obj returned from #login method’, name: ‘optional - name of tag value’ ) ).
-
.get_target_groups(opts = {}) ⇒ Object
- Supported Method Parameters
-
PWN::Plugins::NessusCloud.get_target_groups( nessus_obj: ‘required - nessus_obj returned from #login method’, name: ‘optional - name of target group’ ) ).
-
.get_target_networks(opts = {}) ⇒ Object
- Supported Method Parameters
-
PWN::Plugins::NessusCloud.get_target_networks( nessus_obj: ‘required - nessus_obj returned from #login method’, name: ‘optional - name of target network’ ).
-
.get_timezones(opts = {}) ⇒ Object
- Supported Method Parameters
-
PWN::Plugins::NessusCloud.get_timezones( nessus_obj: ‘required - nessus_obj returned from #login method’, name: ‘optional - name of timezone’ ).
-
.help ⇒ Object
Display Usage for this Module.
-
.launch_scan(opts = {}) ⇒ Object
- Supported Method Parameters
-
PWN::Plugins::NessusCloud.launch_scan( nessus_obj: ‘required - nessus_obj returned from #login method’, scan_id: ‘required - scan uuid to launch’ ).
-
.login(opts = {}) ⇒ Object
- Supported Method Parameters
-
PWN::Plugins::NessusCloud.login( access_key: ‘required - API access key (will prompt if blank)’, secret_key: ‘required - API secret key (will prompt if blank)’ ).
-
.update_scan(opts = {}) ⇒ Object
- Supported Method Parameters
-
PWN::Plugins::NessusCloud.update_scan( nessus_obj: ‘required - nessus_obj returned from #login method’, scan_id: ‘required - the scan id to update. Run #get_scans for a list’, scan_template_uuid: ‘required - the UUID for the Tenable-provided scan template to use. Run #get_canned_scan_templates for a list of UUIDs’, settings: ‘required - settings object as defined by developer.tenable.com/reference/scans-create’, credentials: ‘required - credentials object as defined by developer.tenable.com/reference/scans-create’, plugins: ‘optional - plugins object as defined by developer.tenable.com/reference/scans-create (Defaults to {})’ ).
Class Method Details
.authors ⇒ Object
- Author(s)
-
0day Inc. <[email protected]>
654 655 656 657 658 |
# File 'lib/pwn/plugins/nessus_cloud.rb', line 654 public_class_method def self. "AUTHOR(S): 0day Inc. <[email protected]> " end |
.create_scan(opts = {}) ⇒ Object
- Supported Method Parameters
-
PWN::Plugins::NessusCloud.create_scan(
nessus_obj: 'required - nessus_obj returned from #login method', scan_template_uuid: 'required - the UUID for the Tenable-provided scan template to use. Run #get_canned_scan_templates for a list of UUIDs', settings: 'required - settings object as defined by https://developer.tenable.com/reference/scans-create', credentials: 'required - credentials object as defined by https://developer.tenable.com/reference/scans-create', plugins: 'optional - plugins object as defined by https://developer.tenable.com/reference/scans-create (Defaults to {})')
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 |
# File 'lib/pwn/plugins/nessus_cloud.rb', line 432 public_class_method def self.create_scan(opts = {}) nessus_obj = opts[:nessus_obj] scan_template_uuid = opts[:scan_template_uuid] settings = opts[:settings] credentials = opts[:credentials] plugins = opts[:plugins] http_body = { uuid: scan_template_uuid, settings: settings, credentials: credentials, plugins: plugins }.to_json create_scan_resp = nessus_cloud_rest_call( http_method: :post, nessus_obj: nessus_obj, rest_call: 'scans', http_body: http_body ).body JSON.parse(create_scan_resp, symbolize_names: true) rescue StandardError, SystemExit, Interrupt => e raise e end |
.create_tag(opts = {}) ⇒ Object
- Supported Method Parameters
-
PWN::Plugins::NessusCloud.create_tag(
nessus_obj: 'required - nessus_obj returned from #login method', category: 'required - category name to create or use', value: 'required - tag value name to create or use', desc: 'optional - tag value description')
544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 |
# File 'lib/pwn/plugins/nessus_cloud.rb', line 544 public_class_method def self.create_tag(opts = {}) nessus_obj = opts[:nessus_obj] category = opts[:category] value = opts[:value] desc = opts[:desc] http_body = { category_name: category, value: value, description: desc }.to_json tag_resp = nessus_cloud_rest_call( http_method: :post, nessus_obj: nessus_obj, rest_call: 'tags/values', http_body: http_body ).body JSON.parse(tag_resp, symbolize_names: true) rescue StandardError, SystemExit, Interrupt => e raise e end |
.export_scan_results(opts = {}) ⇒ Object
- Supported Method Parameters
-
PWN::Plugins::NessusCloud.export_scan_results(
nessus_obj: 'required - nessus_obj returned from #login method', scan_id: 'required - scan uuid to export', path_to_export: 'required - filename to export results', history_id: 'optional - defaults to last scan', format: 'optional - :csv|:db|:html|:nessus|:pdf (defaults to :csv'))
597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 |
# File 'lib/pwn/plugins/nessus_cloud.rb', line 597 public_class_method def self.export_scan_results(opts = {}) nessus_obj = opts[:nessus_obj] scan_id = opts[:scan_id] path_to_export = opts[:path_to_export] if opts[:history_id] history_id = opts[:history_id] else scan_history_resp = get_scan_history( nessus_obj: nessus_obj, scan_id: scan_id ) if scan_history_resp[:history].empty? puts 'No scan history found.' raise 'Has at least one scan completed?' else history_id = scan_history_resp[:history].last[:id] end end format = :csv format = opts[:format].to_s.to_sym if opts[:format] http_body = { scan_id: scan_id, history_id: history_id, format: format }.to_json export_scan_resp = nessus_cloud_rest_call( http_method: :post, nessus_obj: nessus_obj, rest_call: "scans/#{scan_id}/export", http_body: http_body ).body file_id = JSON.parse( export_scan_resp, symbolize_names: true )[:file] download_export_resp = nessus_cloud_rest_call( nessus_obj: nessus_obj, rest_call: "scans/#{scan_id}/export/#{file_id}/download" ).body File.open(path_to_export, 'wb') do |f| f.puts download_export_resp end path_to_export rescue StandardError, SystemExit, Interrupt => e raise e end |
.get_canned_scan_templates(opts = {}) ⇒ Object
- Supported Method Parameters
-
PWN::Plugins::NessusCloud.get_canned_scan_templates(
nessus_obj: 'required - nessus_obj returned from #login method', name: 'optional - name of scan template')
114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 |
# File 'lib/pwn/plugins/nessus_cloud.rb', line 114 public_class_method def self.get_canned_scan_templates(opts = {}) nessus_obj = opts[:nessus_obj] name = opts[:name] scan_templates_resp = nessus_cloud_rest_call( nessus_obj: nessus_obj, rest_call: 'editor/scan/templates' ).body scan_templates = JSON.parse(scan_templates_resp, symbolize_names: true) if name selected_scan_template = scan_templates[:templates].select do |sc| sc[:title] == name end scan_templates = selected_scan_template.first scan_templates ||= {} end scan_templates rescue StandardError, SystemExit, Interrupt => e raise e end |
.get_credential_types(opts = {}) ⇒ Object
- Supported Method Parameters
-
PWN::Plugins::NessusCloud.get_credential_types(
nessus_obj: 'required - nessus_obj returned from #login method', category: 'optional - category of credential type (Defaults to "Host")', name: 'optional - name of credential type (Defaults to "SSH")') )
358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 |
# File 'lib/pwn/plugins/nessus_cloud.rb', line 358 public_class_method def self.get_credential_types(opts = {}) nessus_obj = opts[:nessus_obj] category = opts[:category].to_s.downcase name = opts[:name].to_s.downcase raise 'ERROR: name parameter requires category parameter.' if category.empty? && !name.empty? credential_types_resp = nessus_cloud_rest_call( nessus_obj: nessus_obj, rest_call: 'credentials/types' ).body credential_types = JSON.parse(credential_types_resp, symbolize_names: true) if category selected_credential_category = credential_types[:credentials].select do |cc| cc[:category].downcase == category end credential_types = selected_credential_category.first credential_types ||= {} if name selected_credential_type = credential_types[:types].select do |ct| ct[:name].downcase == name end credential_types = selected_credential_type.first credential_types ||= {} end end credential_types rescue StandardError, SystemExit, Interrupt => e raise e end |
.get_folders(opts = {}) ⇒ Object
- Supported Method Parameters
-
PWN::Plugins::NessusCloud.get_folders(
nessus_obj: 'required - nessus_obj returned from #login method', name: 'optional - name of folder')
174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 |
# File 'lib/pwn/plugins/nessus_cloud.rb', line 174 public_class_method def self.get_folders(opts = {}) nessus_obj = opts[:nessus_obj] name = opts[:name] folders_resp = nessus_cloud_rest_call( nessus_obj: nessus_obj, rest_call: 'folders' ).body folders = JSON.parse(folders_resp, symbolize_names: true) if name selected_folder = folders[:folders].select do |f| f[:name] == name end folders = selected_folder.first folders ||= {} end folders rescue StandardError, SystemExit, Interrupt => e raise e end |
.get_policies(opts = {}) ⇒ Object
- Supported Method Parameters
-
PWN::Plugins::NessusCloud.get_policies(
nessus_obj: 'required - nessus_obj returned from #login method', name: 'optional - name of policy (i.e. user-defined template)')
144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 |
# File 'lib/pwn/plugins/nessus_cloud.rb', line 144 public_class_method def self.get_policies(opts = {}) nessus_obj = opts[:nessus_obj] name = opts[:name] policies_resp = nessus_cloud_rest_call( nessus_obj: nessus_obj, rest_call: 'policies' ).body policies = JSON.parse(policies_resp, symbolize_names: true) if name selected_policy = policies[:policies].select do |p| p[:name] == name end policies = selected_policy.first policies ||= {} end policies rescue StandardError, SystemExit, Interrupt => e raise e end |
.get_scan_history(opts = {}) ⇒ Object
- Supported Method Parameters
-
PWN::Plugins::NessusCloud.get_scan_history(
nessus_obj: 'required - nessus_obj returned from #login method' scan_id: 'required - scan uuid to launch')
574 575 576 577 578 579 580 581 582 583 584 585 586 |
# File 'lib/pwn/plugins/nessus_cloud.rb', line 574 public_class_method def self.get_scan_history(opts = {}) nessus_obj = opts[:nessus_obj] scan_id = opts[:scan_id] scan_hist_resp = nessus_cloud_rest_call( nessus_obj: nessus_obj, rest_call: "scans/#{scan_id}/history" ).body JSON.parse(scan_hist_resp, symbolize_names: true) rescue StandardError, SystemExit, Interrupt => e raise e end |
.get_scan_status(opts = {}) ⇒ Object
- Supported Method Parameters
-
PWN::Plugins::NessusCloud.get_scan_status(
nessus_obj: 'required - nessus_obj returned from #login method', scan_id: 'required - scan uuid to retrieve status')
522 523 524 525 526 527 528 529 530 531 532 533 534 |
# File 'lib/pwn/plugins/nessus_cloud.rb', line 522 public_class_method def self.get_scan_status(opts = {}) nessus_obj = opts[:nessus_obj] scan_id = opts[:scan_id] scan_status_resp = nessus_cloud_rest_call( nessus_obj: nessus_obj, rest_call: "scans/#{scan_id}/latest-status" ).body JSON.parse(scan_status_resp, symbolize_names: true) rescue StandardError, SystemExit, Interrupt => e raise e end |
.get_scanners(opts = {}) ⇒ Object
- Supported Method Parameters
-
PWN::Plugins::NessusCloud.get_scanners(
nessus_obj: 'required - nessus_obj returned from #login method', name: 'optional - name of scanner')
204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 |
# File 'lib/pwn/plugins/nessus_cloud.rb', line 204 public_class_method def self.get_scanners(opts = {}) nessus_obj = opts[:nessus_obj] name = opts[:name] scanners_resp = nessus_cloud_rest_call( nessus_obj: nessus_obj, rest_call: 'scanners' ).body scanners = JSON.parse(scanners_resp, symbolize_names: true) if name selected_scanner = scanners[:scanners].select do |s| s[:name] == name end scanners = selected_scanner.first scanners ||= {} end scanners rescue StandardError, SystemExit, Interrupt => e raise e end |
.get_scans(opts = {}) ⇒ Object
- Supported Method Parameters
-
PWN::Plugins::NessusCloud.get_scans(
nessus_obj: 'required - nessus_obj returned from #login method')
399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 |
# File 'lib/pwn/plugins/nessus_cloud.rb', line 399 public_class_method def self.get_scans(opts = {}) nessus_obj = opts[:nessus_obj] name = opts[:name] scans_resp = nessus_cloud_rest_call( nessus_obj: nessus_obj, rest_call: 'scans' ).body scans = JSON.parse(scans_resp, symbolize_names: true) if name selected_scan = scans[:scans].select do |s| s[:name] == name end scans = selected_scan.first scans ||= {} end scans rescue StandardError, SystemExit, Interrupt => e raise e end |
.get_tag_values(opts = {}) ⇒ Object
- Supported Method Parameters
-
PWN::Plugins::NessusCloud.get_tag_values(
nessus_obj: 'required - nessus_obj returned from #login method', name: 'optional - name of tag value') )
326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 |
# File 'lib/pwn/plugins/nessus_cloud.rb', line 326 public_class_method def self.get_tag_values(opts = {}) nessus_obj = opts[:nessus_obj] name = opts[:name] tag_values_resp = nessus_cloud_rest_call( nessus_obj: nessus_obj, rest_call: 'tags/values' ).body tag_values = JSON.parse(tag_values_resp, symbolize_names: true) if name selected_tag = tag_values[:values].select do |tag| tag[:value] == name end tag_values = selected_tag.first tag_values ||= {} end tag_values rescue StandardError, SystemExit, Interrupt => e raise e end |
.get_target_groups(opts = {}) ⇒ Object
- Supported Method Parameters
-
PWN::Plugins::NessusCloud.get_target_groups(
nessus_obj: 'required - nessus_obj returned from #login method', name: 'optional - name of target group') )
295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 |
# File 'lib/pwn/plugins/nessus_cloud.rb', line 295 public_class_method def self.get_target_groups(opts = {}) nessus_obj = opts[:nessus_obj] name = opts[:name] target_groups_resp = nessus_cloud_rest_call( nessus_obj: nessus_obj, rest_call: 'target-groups' ).body target_groups = JSON.parse(target_groups_resp, symbolize_names: true) if name selected_target_group = target_groups[:target_groups].select do |tg| tg[:name] == name end target_groups = selected_target_group.first target_groups ||= {} end target_groups rescue StandardError, SystemExit, Interrupt => e raise e end |
.get_target_networks(opts = {}) ⇒ Object
- Supported Method Parameters
-
PWN::Plugins::NessusCloud.get_target_networks(
nessus_obj: 'required - nessus_obj returned from #login method', name: 'optional - name of target network')
234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 |
# File 'lib/pwn/plugins/nessus_cloud.rb', line 234 public_class_method def self.get_target_networks(opts = {}) nessus_obj = opts[:nessus_obj] name = opts[:name] target_networks_resp = nessus_cloud_rest_call( nessus_obj: nessus_obj, rest_call: 'networks' ).body target_networks = JSON.parse(target_networks_resp, symbolize_names: true) if name selected_network = target_networks[:networks].select do |tn| tn[:name] == name end target_networks = selected_network.first target_networks ||= {} end target_networks rescue StandardError, SystemExit, Interrupt => e raise e end |
.get_timezones(opts = {}) ⇒ Object
- Supported Method Parameters
-
PWN::Plugins::NessusCloud.get_timezones(
nessus_obj: 'required - nessus_obj returned from #login method', name: 'optional - name of timezone')
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/nessus_cloud.rb', line 264 public_class_method def self.get_timezones(opts = {}) nessus_obj = opts[:nessus_obj] name = opts[:name] timezones_resp = nessus_cloud_rest_call( nessus_obj: nessus_obj, rest_call: 'scans/timezones' ).body timezones = JSON.parse(timezones_resp, symbolize_names: true) if name selected_timezone = timezones[:networks].select do |tz| tz[:name] == name end timezones = selected_timezone.first timezones ||= {} end timezones rescue StandardError, SystemExit, Interrupt => e raise e end |
.help ⇒ Object
Display Usage for this Module
662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 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 |
# File 'lib/pwn/plugins/nessus_cloud.rb', line 662 public_class_method def self.help puts "USAGE: nessus_obj = #{self}.login( access_key: 'required - API access key (will prompt if blank)', secret_key: 'required - API secret key (will prompt if blank)' ) #{self}.get_canned_scan_templates( nessus_obj: 'required - nessus_obj returned from #login method', name: 'optional - name of scan template' ) #{self}.get_policies( nessus_obj: 'required - nessus_obj returned from #login method', name: 'optional - name of policy (i.e. user-defined template)' ) #{self}.get_folders( nessus_obj: 'required - nessus_obj returned from #login method', name: 'optional - name of folder' ) #{self}.get_scanners( nessus_obj: 'required - nessus_obj returned from #login method', name: 'optional - name of scanner' ) #{self}.get_target_networks( nessus_obj: 'required - nessus_obj returned from #login method', name: 'optional - name of target network' ) #{self}.get_timezones( nessus_obj: 'required - nessus_obj returned from #login method', name: 'optional - name of timezone' ) #{self}.get_target_groups( nessus_obj: 'required - nessus_obj returned from #login method', name: 'optional - name of target group' ) #{self}.get_tag_values( nessus_obj: 'required - nessus_obj returned from #login method', name: 'optional - name of tag value' ) #{self}.get_scans( nessus_obj: 'required - nessus_obj returned from #login method' ) #{self}.create_scan( nessus_obj: 'required - nessus_obj returned from #login method', scan_template_uuid: 'required - the UUID for the Tenable-provided scan template to use. Run #get_canned_scan_templates for a list of UUIDs', settings: 'required - settings object as defined by https://developer.tenable.com/reference/scans-create', credentials: 'required - credentials object as defined by https://developer.tenable.com/reference/scans-create', plugins: 'optional - plugins object as defined by https://developer.tenable.com/reference/scans-create (Defaults to {})' ) #{self}.update_scan( nessus_obj: 'required - nessus_obj returned from #login method', scan_id: 'required - the scan id to update. Run #get_scans for a list', scan_template_uuid: 'required - the UUID for the Tenable-provided scan template to use. Run #get_canned_scan_templates for a list of UUIDs', settings: 'required - settings object as defined by https://developer.tenable.com/reference/scans-create', credentials: 'required - credentials object as defined by https://developer.tenable.com/reference/scans-create', plugins: 'optional - plugins object as defined by https://developer.tenable.com/reference/scans-create (Defaults to {})' ) #{self}.launch_scan( nessus_obj: 'required - nessus_obj returned from #login method', scan_id: 'required - scan uuid to launch' ) #{self}.get_scan_status( nessus_obj: 'required - nessus_obj returned from #login method', scan_id: 'required - scan uuid to retrieve status' ) #{self}.create_tag( nessus_obj: 'required - nessus_obj returned from #login method', category: 'required - category name to create or use', value: 'required - tag value name to create or use', desc: 'optional - tag value description' ) #{self}.get_scan_history( nessus_obj: 'required - nessus_obj returned from #login method' scan_id: 'required - scan uuid to launch' ) #{self}.export_scan_results( nessus_obj: 'required - nessus_obj returned from #login method', scan_id: 'required - scan uuid to export', path_to_export: 'required - filename to export results', history_id: 'optional - defaults to last scan', format: 'optional - :csv|:db|:html|:nessus|:pdf (defaults to :csv') ) #{self}.authors " end |
.launch_scan(opts = {}) ⇒ Object
- Supported Method Parameters
-
PWN::Plugins::NessusCloud.launch_scan(
nessus_obj: 'required - nessus_obj returned from #login method', scan_id: 'required - scan uuid to launch')
501 502 503 504 505 506 507 508 509 510 511 512 513 514 |
# File 'lib/pwn/plugins/nessus_cloud.rb', line 501 public_class_method def self.launch_scan(opts = {}) nessus_obj = opts[:nessus_obj] scan_id = opts[:scan_id] launch_scan_resp = nessus_cloud_rest_call( http_method: :post, nessus_obj: nessus_obj, rest_call: "scans/#{scan_id}/launch" ).body JSON.parse(launch_scan_resp, symbolize_names: true) rescue StandardError, SystemExit, Interrupt => e raise e end |
.login(opts = {}) ⇒ Object
- Supported Method Parameters
-
PWN::Plugins::NessusCloud.login(
access_key: 'required - API access key (will prompt if blank)', secret_key: 'required - API secret key (will prompt if blank)')
92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 |
# File 'lib/pwn/plugins/nessus_cloud.rb', line 92 public_class_method def self.login(opts = {}) access_key = opts[:access_key] access_key = PWN::Plugins::AuthenticationHelper.mask_password(prompt: 'Access Key') if opts[:access_key].nil? secret_key = opts[:secret_key] secret_key = PWN::Plugins::AuthenticationHelper.mask_password(prompt: 'Secret Key') if opts[:secret_key].nil? nessus_obj = {} nessus_obj[:access_key] = access_key nessus_obj[:secret_key] = secret_key nessus_obj rescue StandardError, SystemExit, Interrupt => e raise e end |
.update_scan(opts = {}) ⇒ Object
- Supported Method Parameters
-
PWN::Plugins::NessusCloud.update_scan(
nessus_obj: 'required - nessus_obj returned from #login method', scan_id: 'required - the scan id to update. Run #get_scans for a list', scan_template_uuid: 'required - the UUID for the Tenable-provided scan template to use. Run #get_canned_scan_templates for a list of UUIDs', settings: 'required - settings object as defined by https://developer.tenable.com/reference/scans-create', credentials: 'required - credentials object as defined by https://developer.tenable.com/reference/scans-create', plugins: 'optional - plugins object as defined by https://developer.tenable.com/reference/scans-create (Defaults to {})')
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/nessus_cloud.rb', line 468 public_class_method def self.update_scan(opts = {}) nessus_obj = opts[:nessus_obj] scan_id = opts[:scan_id] scan_template_uuid = opts[:scan_template_uuid] settings = opts[:settings] credentials = opts[:credentials] plugins = opts[:plugins] http_body = { uuid: scan_template_uuid, settings: settings, credentials: credentials, plugins: plugins }.to_json update_scan_resp = nessus_cloud_rest_call( http_method: :put, nessus_obj: nessus_obj, rest_call: "scans/#{scan_id}", http_body: http_body ).body JSON.parse(update_scan_resp, symbolize_names: true) rescue StandardError, SystemExit, Interrupt => e raise e end |