Module: PWN::Plugins::IBMAppscan
- Defined in:
- lib/pwn/plugins/ibm_appscan.rb
Overview
This plugin is used for interacting w/ IBM Appscan Enterprise using the ‘rest’ browser type of PWN::Plugins::TransparentBrowser. The IBM Appscan Spec in which this PWN module is based is located here: www-01.ibm.com/support/knowledgecenter/SSW2NF_9.0.0/com.ibm.ase.help.doc/topics/c_web_services.html?lang=en
Constant Summary collapse
Class Method Summary collapse
-
.authors ⇒ Object
- Author(s)
-
0day Inc.
-
.configure_scan_options(opts = {}) ⇒ Object
- Supported Method Parameters
-
PWN::Plugins::IBMAppscan.configure_scan_options( appscan_obj: ‘required appscan_obj returned from login method’, folder_item_id: ‘required folder item id’, option: ‘required option to change within the scan (folder item)’, value: ‘required option value(s)’ ).
-
.create_scan_based_on_template(opts = {}) ⇒ Object
- Supported Method Parameters
-
PWN::Plugins::IBMAppscan.create_scan_based_on_template( appscan_obj: ‘required appscan_obj returned from login method’ template_id: ‘required template id returned from get_scan_templates method’ scan_name: ‘required name of scan’ scan_desc: ‘required description of scan’ ).
-
.folder_item_scan_action(opts = {}) ⇒ Object
- Supported Method Parameters
-
PWN::Plugins::IBMAppscan.folder_item_scan_action( appscan_obj: ‘required appscan_obj returned from login method’, folder_item_id: ‘required folder item id’, action: ‘required action for scan to follow. Available actions are: :run, :suspend, :cancel, & :end’, poll_interval: ‘optional setting to determine length in seconds to poll for scan state (defaults to 60)’ ).
-
.generate_scan_report(opts = {}) ⇒ Object
- Supported Method Parameters
-
PWN::Plugins::IBMAppscan.generate_scan_report appscan_obj: ‘required appscan_obj returned from login method’ scan_name: ‘required name of scan for which to generate a report’ output_path: ‘required path to save generated report’.
-
.get_a_folders_folder_items(opts = {}) ⇒ Object
- Supported Method Parameters
-
PWN::Plugins::IBMAppscan.get_a_folders_folder_items( appscan_obj: ‘required appscan_obj returned from login method’, folder_id: ‘required folder to retrieve’ ).
-
.get_folder_by_id(opts = {}) ⇒ Object
- Supported Method Parameters
-
PWN::Plugins::IBMAppscan.get_folder_by_id( appscan_obj: ‘required appscan_obj returned from login method’, folder_id: ‘required folder to retrieve’ ).
-
.get_folder_item_by_id(opts = {}) ⇒ Object
- Supported Method Parameters
-
PWN::Plugins::IBMAppscan.get_folder_item_by_id( appscan_obj: ‘required appscan_obj returned from login method’, folder_item_id: ‘required folder item to retrieve’ ).
-
.get_folder_item_options(opts = {}) ⇒ Object
- Supported Method Parameters
-
PWN::Plugins::IBMAppscan.get_folder_item_options( appscan_obj: ‘required appscan_obj returned from login method’, folder_item_id: ‘required folder item to retrieve’ ).
-
.get_folder_items(opts = {}) ⇒ Object
- Supported Method Parameters
-
PWN::Plugins::IBMAppscan.get_folder_items( appscan_obj: ‘required appscan_obj returned from login method’ ).
-
.get_folders(opts = {}) ⇒ Object
- Supported Method Parameters
-
PWN::Plugins::IBMAppscan.get_folders( appscan_obj: ‘required appscan_obj returned from login method’ ).
-
.get_issue_collection(opts = {}) ⇒ Object
- Supported Method Parameters
-
PWN::Plugins::IBMAppscan.get_issue_collection( appscan_obj: ‘required appscan_obj returned from login method’, report_id: ‘required report id’ ).
-
.get_report_collection(opts = {}) ⇒ Object
- Supported Method Parameters
-
PWN::Plugins::IBMAppscan.get_report_collection( appscan_obj: ‘required appscan_obj returned from login method’, report_folder_item_id: ‘required report folder item id’ ).
-
.get_scan_templates(opts = {}) ⇒ Object
- Supported Method Parameters
-
PWN::Plugins::IBMAppscan.get_scan_templates( appscan_obj: ‘required appscan_obj returned from login method’ ).
-
.get_single_report(opts = {}) ⇒ Object
- Supported Method Parameters
-
PWN::Plugins::IBMAppscan.get_single_report( appscan_obj: ‘required appscan_obj returned from login method’, report_id: ‘required report id’ ).
-
.get_single_report_data(opts = {}) ⇒ Object
- Supported Method Parameters
-
PWN::Plugins::IBMAppscan.get_single_report_data( appscan_obj: ‘required appscan_obj returned from login method’, report_id: ‘required report id’ ).
-
.get_single_report_schema(opts = {}) ⇒ Object
- Supported Method Parameters
-
PWN::Plugins::IBMAppscan.get_single_report_schema( appscan_obj: ‘required appscan_obj returned from login method’, report_id: ‘required report id’ ).
-
.get_subfolders_of_folder(opts = {}) ⇒ Object
- Supported Method Parameters
-
PWN::Plugins::IBMAppscan.get_subfolders_of_folder( appscan_obj: ‘required appscan_obj returned from login method’, folder_id: ‘required folder to retrieve’ ).
-
.help ⇒ Object
Display Usage for this Module.
-
.login(opts = {}) ⇒ Object
- Supported Method Parameters
-
PWN::Plugins::IBMAppscan.login( appscan_ip: ‘required host/ip of IBM Appscan Server’, username: ‘required username’, password: ‘optional password (will prompt if nil)’ ).
-
.logout(opts = {}) ⇒ Object
- Supported Method Parameters
-
PWN::Plugins::IBMAppscan.logout( appscan_obj: ‘required appscan_obj returned from login method’ ).
-
.schema(opts = {}) ⇒ Object
- Supported Method Parameters
-
PWN::Plugins::IBMAppscan.schema( appscan_obj: ‘required appscan_obj returned from login method’ ).
-
.version(opts = {}) ⇒ Object
- Supported Method Parameters
-
PWN::Plugins::IBMAppscan.version( appscan_obj: ‘required appscan_obj returned from login method’ ).
Class Method Details
.authors ⇒ Object
- Author(s)
-
0day Inc. <[email protected]>
812 813 814 815 816 |
# File 'lib/pwn/plugins/ibm_appscan.rb', line 812 public_class_method def self. "AUTHOR(S): 0day Inc. <[email protected]> " end |
.configure_scan_options(opts = {}) ⇒ Object
- Supported Method Parameters
-
PWN::Plugins::IBMAppscan.configure_scan_options(
appscan_obj: 'required appscan_obj returned from login method', folder_item_id: 'required folder item id', option: 'required option to change within the scan (folder item)', value: 'required option value(s)'
)
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 |
# File 'lib/pwn/plugins/ibm_appscan.rb', line 430 public_class_method def self.(opts = {}) appscan_obj = opts[:appscan_obj] folder_item_id = opts[:folder_item_id].to_i option = opts[:option].to_s.scrub value = opts[:value] case option.to_sym when :epcsCOTListOfStartingUrls post_body = '' value.to_s.scrub.split(',').each_with_index do |url, index| post_body << '&' unless index.zero? post_body << "value=#{URI.encode_www_form(url.strip.chomp)}" end when :ebCOTHttpAuthentication post_body = if value == false 'value=0' # Don't require authentication else 'value=1' # Require authentication end when :esCOTHttpUser, :esCOTHttpPassword, :elCOTScanLimit post_body = "value=#{value.to_s.scrub}" when :help = '' ( appscan_obj: appscan_obj, folder_item_id: folder_item_id )[:options].each { |url| << "#{File.basename(url)}\n" } return @@logger.info("Valid Options are:\n\n#{}") else = '' ( appscan_obj: appscan_obj, folder_item_id: folder_item_id )[:options].each { |url| << "#{File.basename(url)}\n" } return @@logger.error("Invalid option '#{option}' parameter passed.\nValid Options are:\n\n#{}") end # Always Overwrite Existing Option Values response = appscan_rest_call( appscan_obj: appscan_obj, http_method: :post, rest_call: "folderitems/#{folder_item_id}/options/#{option}?put=1", http_body: post_body.to_s ) scan_config = {} scan_config[:raw_response] = response scan_config[:xml_response] = Nokogiri::XML(response) scan_config[:options] = scan_config[:xml_response].xpath('//xmlns:option/@value') scan_config rescue StandardError => e raise e end |
.create_scan_based_on_template(opts = {}) ⇒ Object
- Supported Method Parameters
-
PWN::Plugins::IBMAppscan.create_scan_based_on_template(
appscan_obj: 'required appscan_obj returned from login method' template_id: 'required template id returned from get_scan_templates method' scan_name: 'required name of scan' scan_desc: 'required description of scan'
)
350 351 352 353 354 355 356 357 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 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 |
# File 'lib/pwn/plugins/ibm_appscan.rb', line 350 public_class_method def self.create_scan_based_on_template(opts = {}) appscan_obj = opts[:appscan_obj] template_id = opts[:template_id].to_i scan_name = opts[:scan_name].to_s.scrub scan_desc = opts[:scan_desc].to_s.scrub response = appscan_rest_call( appscan_obj: appscan_obj, http_method: :post, rest_call: "folderitems?templateId=#{template_id}", http_body: "name=#{scan_name}&description=#{scan_desc}" ) # Return an Easy to Use Data Structure # Instead of Leaving it to the End User # To Parse Out the XML on their own. scan = {} scan[:raw_response] = response scan[:xml_response] = Nokogiri::XML(response) scan[:folder_url] = scan[:xml_response].xpath( '/xmlns:folder-items/xmlns:content-scan-job/@href' ).text scan[:folder_item_id] = scan[:xml_response].xpath( '/xmlns:folder-items/xmlns:content-scan-job/xmlns:id' ).text scan[:scan_name] = scan[:xml_response].xpath( '/xmlns:folder-items/xmlns:content-scan-job/xmlns:name' ).text scan[:scan_desc] = scan[:xml_response].xpath( '/xmlns:folder-items/xmlns:content-scan-job/xmlns:description' ).text scan[:parent_folder_url] = scan[:xml_response].xpath( '/xmlns:folder-items/xmlns:content-scan-job/xmlns:parent/@href' ).text scan[:parent_folder_id] = scan[:xml_response].xpath( '/xmlns:folder-items/xmlns:content-scan-job/xmlns:parent/xmlns:id' ).text scan[:contact] = scan[:xml_response].xpath( '/xmlns:folder-items/xmlns:content-scan-job/xmlns:contact' ).text scan[:state_id] = scan[:xml_response].xpath( '/xmlns:folder-items/xmlns:content-scan-job/xmlns:state/xmlns:id' ).text scan[:state_name] = scan[:xml_response].xpath( '/xmlns:folder-items/xmlns:content-scan-job/xmlns:state/xmlns:name' ).text scan[:action_id] = scan[:xml_response].xpath( '/xmlns:folder-items/xmlns:content-scan-job/xmlns:action/xmlns:id' ).text scan[:action_name] = scan[:xml_response].xpath( '/xmlns:folder-items/xmlns:content-scan-job/xmlns:action/xmlns:name' ).text scan[:options_url] = scan[:xml_response].xpath( '/xmlns:folder-items/xmlns:content-scan-job/xmlns:options/@href' ).text scan[:report_pack_url] = scan[:xml_response].xpath( '/xmlns:folder-items/xmlns:report-pack/@href' ).text scan[:report_pack_id] = scan[:xml_response].xpath( '/xmlns:folder-items/xmlns:report-pack/xmlns:id' ).text scan[:reports_url] = scan[:xml_response].xpath( '/xmlns:folder-items/xmlns:report-pack/xmlns:reports/@href' ).text scan[:reports_count] = scan[:xml_response].xpath( '/xmlns:folder-items/xmlns:report-pack/xmlns:reports/xmlns:count' ).text.to_i scan rescue StandardError => e @@logger.error("Error #{e}:\nREST response returned:\n#{response}") end |
.folder_item_scan_action(opts = {}) ⇒ Object
- Supported Method Parameters
-
PWN::Plugins::IBMAppscan.folder_item_scan_action(
appscan_obj: 'required appscan_obj returned from login method', folder_item_id: 'required folder item id', action: 'required action for scan to follow. Available actions are: :run, :suspend, :cancel, & :end', poll_interval: 'optional setting to determine length in seconds to poll for scan state (defaults to 60)'
)
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 543 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/ibm_appscan.rb', line 495 public_class_method def self.folder_item_scan_action(opts = {}) appscan_obj = opts[:appscan_obj] folder_item_id = opts[:folder_item_id].to_i action = opts[:action].to_s.scrub.to_sym poll_interval = if opts[:poll_interval].nil? 60 else opts[:poll_interval].to_i end case action when :run # Make sure scan is in a Ready state this_folder_item = PWN::Plugins::IBMAppscan.get_folder_item_by_id( appscan_obj: appscan_obj, folder_item_id: folder_item_id ) state = this_folder_item[:state] return @@logger.error("Scan isn't in a Ready state. Current state: #{state}, abort.") if state != 'Ready' @@logger.info("Kicking Off Scan for Folder Item: #{folder_item_id}") response = appscan_rest_call( appscan_obj: appscan_obj, http_method: :post, rest_call: "folderitems/#{folder_item_id}", http_body: 'action=2' ) # Obtain Status to Monitor Scan Completion state = nil until state == 'Ready' sleep poll_interval this_folder_item = PWN::Plugins::IBMAppscan.get_folder_item_by_id( appscan_obj: appscan_obj, folder_item_id: folder_item_id ) state = this_folder_item[:state] @@logger.info("Current Scan State: #{state}...") end @@logger.info("Scan Completed @ #{Time.now.strftime('%Y-%m-%d %H:%M:%S')}") when :suspend response = appscan_rest_call( appscan_obj: appscan_obj, http_method: :post, rest_call: "folderitems/#{folder_item_id}", http_body: 'action=3' ) when :cancel response = appscan_rest_call( appscan_obj: appscan_obj, http_method: :post, rest_call: "folderitems/#{folder_item_id}", http_body: 'action=4' ) when :end response = appscan_rest_call( appscan_obj: appscan_obj, http_method: :post, rest_call: "folderitems/#{folder_item_id}", http_body: 'action=5' ) else return @@logger.error("Invalid action. Valid actions are:\n:run\n:suspend\n:cancel\n:end\n") end scan_action = {} scan_action[:raw_response] = response scan_action[:xml_response] = Nokogiri::XML(response) scan_action rescue StandardError => e raise e end |
.generate_scan_report(opts = {}) ⇒ Object
- Supported Method Parameters
-
PWN::Plugins::IBMAppscan.generate_scan_report
appscan_obj: 'required appscan_obj returned from login method' scan_name: 'required name of scan for which to generate a report' output_path: 'required path to save generated report'
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 |
# File 'lib/pwn/plugins/ibm_appscan.rb', line 732 public_class_method def self.generate_scan_report(opts = {}) appscan_obj = opts[:appscan_obj] scan_name = opts[:scan_name] output_path = opts[:output_path] appscan_ip = appscan_obj[:appscan_ip].to_s.scrub login_uri = "https://#{appscan_ip}:9443/ase/pages/Login.jsp" base_appscan_uri = "https://#{appscan_ip}/ase/FolderExplorer.aspx" logout_uri = "https://#{appscan_ip}/ase/LogOut.aspx" # verify the output path actually exists return @@logger.error("Output directory does not exist: #{output_path}") unless File.directory?(output_path) browser_obj = PWN::Plugins::TransparentBrowser.open( browser_type: :headless, proxy: 'http://127.0.0.1:8080' ) h_browser = browser_obj[:browser] # log into the system h_browser.goto login_uri.to_s.to_s.scrub h_browser.text_field(name: 'j_username').when_present.set(appscan_obj[:username]) h_browser.text_field(name: 'j_password').when_present.set(Base64.decode64(appscan_obj[:password])) h_browser.(name: 'login').when_present.click # head over to the reports page and click on the report link h_browser.goto base_appscan_uri.to_s.to_s.scrub h_browser.link(:text, 'ASE').when_present.click # Search for the report link with a matching name and click it clicked = false h_browser.links.each do |link| next unless (link.text == scan_name.to_s) && link.href =~ /^https:.+XReports.+/ link.when_present.click clicked = true break end return @@logger.error("Could not find matching scan name for name #{scan_name}") unless clicked output_path = "#{output_path}/#{scan_name.gsub(/[^\w.-]/, '_')}/" FileUtils.rm_rf output_path if File.directory?(output_path) FileUtils.mkpath output_path # Download the top level report report_link = "#{h_browser.url}&exportformat=pdf&exportdelivery=download" output_name = "#{output_path}Top_Level.pdf" get_report_data( appscan_obj: appscan_obj, report_link: report_link, output_name: output_name ) rescue StandardError => e @@logger.error("Error retrieving report for '#{scan_name}': #{e}") ensure # make sure we always logout h_browser.goto logout_uri.to_s.to_s.scrub h_browser.close end |
.get_a_folders_folder_items(opts = {}) ⇒ Object
- Supported Method Parameters
-
PWN::Plugins::IBMAppscan.get_a_folders_folder_items(
appscan_obj: 'required appscan_obj returned from login method', folder_id: 'required folder to retrieve'
)
291 292 293 294 295 296 297 298 299 300 301 |
# File 'lib/pwn/plugins/ibm_appscan.rb', line 291 public_class_method def self.get_a_folders_folder_items(opts = {}) appscan_obj = opts[:appscan_obj] folder_id = opts[:folder_item_id].to_i response = appscan_rest_call(appscan_obj: appscan_obj, rest_call: "folders/#{folder_id}/folderitems") a_folders_folder_items = {} a_folders_folder_items[:raw_response] = response a_folders_folder_items[:xml_response] = Nokogiri::XML(response) a_folders_folder_items rescue StandardError => e raise e end |
.get_folder_by_id(opts = {}) ⇒ Object
- Supported Method Parameters
-
PWN::Plugins::IBMAppscan.get_folder_by_id(
appscan_obj: 'required appscan_obj returned from login method', folder_id: 'required folder to retrieve'
)
225 226 227 228 229 230 231 232 233 234 235 |
# File 'lib/pwn/plugins/ibm_appscan.rb', line 225 public_class_method def self.get_folder_by_id(opts = {}) appscan_obj = opts[:appscan_obj] folder_id = opts[:folder_id].to_i response = appscan_rest_call(appscan_obj: appscan_obj, rest_call: "folders/#{folder_id}") folder = {} folder[:raw_response] = response folder[:xml_response] = Nokogiri::XML(response) folder rescue StandardError => e raise e end |
.get_folder_item_by_id(opts = {}) ⇒ Object
- Supported Method Parameters
-
PWN::Plugins::IBMAppscan.get_folder_item_by_id(
appscan_obj: 'required appscan_obj returned from login method', folder_item_id: 'required folder item to retrieve'
)
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 |
# File 'lib/pwn/plugins/ibm_appscan.rb', line 259 public_class_method def self.get_folder_item_by_id(opts = {}) appscan_obj = opts[:appscan_obj] folder_item_id = opts[:folder_item_id].to_i retry_count = 3 response = appscan_rest_call(appscan_obj: appscan_obj, rest_call: "folderitems/#{folder_item_id}") folder_item = {} folder_item[:raw_response] = response folder_item[:xml_response] = Nokogiri::XML(response) # Get Current Status of a Scan # Available states: # READY = 1; # STARTING = 2; # RUNNING = 3; # RESUMING = 6; # CANCELING = 7; # SUSPENDING = 8; # SUSPENDED = 9; # POSTPROCESSING = 10; # ENDING = 12; folder_item[:state] = folder_item[:xml_response].xpath('//xmlns:state/xmlns:name').text folder_item rescue StandardError => e @@logger.error("Error: #{e} | #{e.class}\nResponse Returned: #{folder_item[:raw_response]}") end |
.get_folder_item_options(opts = {}) ⇒ Object
- Supported Method Parameters
-
PWN::Plugins::IBMAppscan.get_folder_item_options(
appscan_obj: 'required appscan_obj returned from login method', folder_item_id: 'required folder item to retrieve'
)
309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 |
# File 'lib/pwn/plugins/ibm_appscan.rb', line 309 public_class_method def self.(opts = {}) appscan_obj = opts[:appscan_obj] folder_item_id = opts[:folder_item_id].to_i # TODO: Discover why not all options are returned # (e.g. esCOTAutoFormFillUserNameValue & esCOTAutoFormFillPasswordValue) response = appscan_rest_call(appscan_obj: appscan_obj, rest_call: "folderitems/#{folder_item_id}/options") = {} [:raw_response] = response [:xml_response] = Nokogiri::XML(response) [:options] = [:xml_response].xpath( '//xmlns:available-option/@href' ) rescue StandardError => e raise e end |
.get_folder_items(opts = {}) ⇒ Object
- Supported Method Parameters
-
PWN::Plugins::IBMAppscan.get_folder_items(
appscan_obj: 'required appscan_obj returned from login method'
)
242 243 244 245 246 247 248 249 250 251 |
# File 'lib/pwn/plugins/ibm_appscan.rb', line 242 public_class_method def self.get_folder_items(opts = {}) appscan_obj = opts[:appscan_obj] response = appscan_rest_call(appscan_obj: appscan_obj, rest_call: 'folderitems') folder_items = {} folder_items[:raw_response] = response folder_items[:xml_response] = Nokogiri::XML(response) folder_items rescue StandardError => e raise e end |
.get_folders(opts = {}) ⇒ Object
- Supported Method Parameters
-
PWN::Plugins::IBMAppscan.get_folders(
appscan_obj: 'required appscan_obj returned from login method'
)
190 191 192 193 194 195 196 197 198 199 |
# File 'lib/pwn/plugins/ibm_appscan.rb', line 190 public_class_method def self.get_folders(opts = {}) appscan_obj = opts[:appscan_obj] response = appscan_rest_call(appscan_obj: appscan_obj, rest_call: 'folders') folders = {} folders[:raw_response] = response folders[:xml_response] = Nokogiri::XML(response) folders rescue StandardError => e raise e end |
.get_issue_collection(opts = {}) ⇒ Object
- Supported Method Parameters
-
PWN::Plugins::IBMAppscan.get_issue_collection(
appscan_obj: 'required appscan_obj returned from login method', report_id: 'required report id'
)
669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 |
# File 'lib/pwn/plugins/ibm_appscan.rb', line 669 public_class_method def self.get_issue_collection(opts = {}) appscan_obj = opts[:appscan_obj] report_id = opts[:report_id].to_i response = appscan_rest_call( appscan_obj: appscan_obj, rest_call: "reports/#{report_id}/issues?mode=all" ) issue_collection = {} issue_collection[:raw_response] = response issue_collection[:xml_response] = Nokogiri::XML(response) @@logger.info("Retrieved Issue Collection for Report ID: #{report_id}") issue_collection rescue StandardError => e raise e end |
.get_report_collection(opts = {}) ⇒ Object
- Supported Method Parameters
-
PWN::Plugins::IBMAppscan.get_report_collection(
appscan_obj: 'required appscan_obj returned from login method', report_folder_item_id: 'required report folder item id'
)
574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 |
# File 'lib/pwn/plugins/ibm_appscan.rb', line 574 public_class_method def self.get_report_collection(opts = {}) appscan_obj = opts[:appscan_obj] report_folder_item_id = opts[:report_folder_item_id].to_i @@logger.info("Retrieving Report Collection ID: #{report_folder_item_id} - Available Report Pack Collection:") response = appscan_rest_call(appscan_obj: appscan_obj, rest_call: "folderitems/#{report_folder_item_id}/reports") report_collection = {} report_collection[:raw_response] = response report_collection[:xml_response] = Nokogiri::XML(response) # Output full report pack collection report_collection[:xml_response].xpath('//xmlns:report').each do |r| @@logger.info(" - #{r.xpath('xmlns:name').text}") end report_collection rescue StandardError => e raise e end |
.get_scan_templates(opts = {}) ⇒ Object
- Supported Method Parameters
-
PWN::Plugins::IBMAppscan.get_scan_templates(
appscan_obj: 'required appscan_obj returned from login method'
)
331 332 333 334 335 336 337 338 339 340 |
# File 'lib/pwn/plugins/ibm_appscan.rb', line 331 public_class_method def self.get_scan_templates(opts = {}) appscan_obj = opts[:appscan_obj] response = appscan_rest_call(appscan_obj: appscan_obj, rest_call: 'templates') templates = {} templates[:raw_response] = response templates[:xml_response] = Nokogiri::XML(response) templates rescue StandardError => e raise e end |
.get_single_report(opts = {}) ⇒ Object
- Supported Method Parameters
-
PWN::Plugins::IBMAppscan.get_single_report(
appscan_obj: 'required appscan_obj returned from login method', report_id: 'required report id'
)
600 601 602 603 604 605 606 607 608 609 610 611 612 613 |
# File 'lib/pwn/plugins/ibm_appscan.rb', line 600 public_class_method def self.get_single_report(opts = {}) appscan_obj = opts[:appscan_obj] report_id = opts[:report_id].to_i response = appscan_rest_call(appscan_obj: appscan_obj, rest_call: "reports/#{report_id}") report = {} report[:raw_response] = response report[:xml_response] = Nokogiri::XML(response) @@logger.info("Retrieved Report ID/Name: #{report_id}/#{report[:xml_response].xpath('//xmlns:report/xmlns:name').text}") report rescue StandardError => e raise e end |
.get_single_report_data(opts = {}) ⇒ Object
- Supported Method Parameters
-
PWN::Plugins::IBMAppscan.get_single_report_data(
appscan_obj: 'required appscan_obj returned from login method', report_id: 'required report id'
)
621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 |
# File 'lib/pwn/plugins/ibm_appscan.rb', line 621 public_class_method def self.get_single_report_data(opts = {}) appscan_obj = opts[:appscan_obj] report_id = opts[:report_id].to_i response = appscan_rest_call( appscan_obj: appscan_obj, rest_call: "reports/#{report_id}/data?mode=all" ) report_data = {} report_data[:raw_response] = response report_data[:xml_response] = Nokogiri::XML(response) @@logger.info("Retrieved Report Data for Report ID: #{report_id}") report_data rescue StandardError => e raise e end |
.get_single_report_schema(opts = {}) ⇒ Object
- Supported Method Parameters
-
PWN::Plugins::IBMAppscan.get_single_report_schema(
appscan_obj: 'required appscan_obj returned from login method', report_id: 'required report id'
)
645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 |
# File 'lib/pwn/plugins/ibm_appscan.rb', line 645 public_class_method def self.get_single_report_schema(opts = {}) appscan_obj = opts[:appscan_obj] report_id = opts[:report_id].to_i response = appscan_rest_call( appscan_obj: appscan_obj, rest_call: "reports/#{report_id}/data?metadata=schema" ) report_schema = {} report_schema[:raw_response] = response report_schema[:xml_response] = Nokogiri::XML(response) @@logger.info("Retrieved Report Schema for Report ID: #{report_id}") report_schema rescue StandardError => e raise e end |
.get_subfolders_of_folder(opts = {}) ⇒ Object
- Supported Method Parameters
-
PWN::Plugins::IBMAppscan.get_subfolders_of_folder(
appscan_obj: 'required appscan_obj returned from login method', folder_id: 'required folder to retrieve'
)
207 208 209 210 211 212 213 214 215 216 217 |
# File 'lib/pwn/plugins/ibm_appscan.rb', line 207 public_class_method def self.get_subfolders_of_folder(opts = {}) appscan_obj = opts[:appscan_obj] folder_id = opts[:folder_id].to_i response = appscan_rest_call(appscan_obj: appscan_obj, rest_call: "folders/#{folder_id}/folders") subfolders = {} subfolders[:raw_response] = response subfolders[:xml_response] = Nokogiri::XML(response) subfolders rescue StandardError => e raise e end |
.help ⇒ Object
Display Usage for this Module
820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 |
# File 'lib/pwn/plugins/ibm_appscan.rb', line 820 public_class_method def self.help puts "USAGE: appscan_obj = #{self}.login( appscan_ip: 'required host/ip of Nexpose Console (server)', username: 'required username', password: 'optional password (will prompt if nil)' ) schema = #{self}.schema( appscan_obj: 'required appscan_obj returned from login method' ) version = #{self}.version( appscan_obj: 'required appscan_obj returned from login method' ) folders = #{self}.get_folders( appscan_obj: 'required appscan_obj returned from login method' ) subfolders = #{self}.get_subfolders_of_folder( appscan_obj: 'required appscan_obj returned from login method', folder_id: 'required folder to retrieve' ) folder = #{self}.get_folder_by_id( appscan_obj: 'required appscan_obj returned from login method', folder_id: 'required folder to retrieve' ) folder_items = #{self}.get_folder_items( appscan_obj: 'required appscan_obj returned from login method' ) folder_item = #{self}.get_folder_item_by_id( appscan_obj: 'required appscan_obj returned from login method', folder_item_id: 'required folder item to retrieve' ) a_folders_folder_items = #{self}.get_a_folders_folder_items( appscan_obj: 'required appscan_obj returned from login method', folder_id: 'required folder to retrieve' ) folder_item_options = #{self}.get_folder_item_options( appscan_obj: 'required appscan_obj returned from login method', folder_item_id: 'required folder item to retrieve' ) scan = #{self}.create_scan_based_on_template( appscan_obj: 'required appscan_obj returned from login method' template_id: 'required template id returned from get_scan_templates method' scan_name: 'required name of scan' scan_desc: 'required description of scan' ) templates = #{self}.get_scan_templates( appscan_obj: 'required appscan_obj returned from login method' ) scan_config = #{self}.configure_scan_options( appscan_obj: 'required appscan_obj returned from login method', folder_item_id: 'required folder item id', option: 'required option to change within the scan (folder item). Pass :help for a list of options.', value: 'required option value(s)' ) scan_action = #{self}.folder_item_scan_action( appscan_obj: 'required appscan_obj returned from login method', folder_item_id: 'required folder item id', action: 'required action for scan to follow. Available actions are: :run, :suspend, :cancel, & :end', poll_interval: 'optional setting to determine length in seconds to poll for scan state (defaults to 60)' ) report_collection = #{self}.get_report_collection( appscan_obj: 'required appscan_obj returned from login method', report_folder_item_id: 'required report folder item id' ) report = #{self}.get_single_report( appscan_obj: 'required appscan_obj returned from login method', report_id: 'required report id' ) report_data = #{self}.get_single_report_data( appscan_obj: 'required appscan_obj returned from login method', report_id: 'required report id' ) report_schema = #{self}.get_single_report_schema( appscan_obj: 'required appscan_obj returned from login method', report_id: 'required report id' ) issue_collection = #{self}.get_issue_collection( appscan_obj: 'required appscan_obj returned from login method', report_id: 'required report id' ) #{self}.generate_scan_report( appscan_obj: 'required appscan_obj returned from login', scan_name: 'required name of scan for which to generate a report', output_path: 'required path to save generated report' ) #{self}.logout( appscan_obj: 'required appscan_obj returned from login method' ) #{self}.authors " end |
.login(opts = {}) ⇒ Object
- Supported Method Parameters
-
PWN::Plugins::IBMAppscan.login(
appscan_ip: 'required host/ip of IBM Appscan Server', username: 'required username', password: 'optional password (will prompt if nil)'
)
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 |
# File 'lib/pwn/plugins/ibm_appscan.rb', line 24 public_class_method def self.login(opts = {}) appscan_ip = opts[:appscan_ip] username = opts[:username].to_s.scrub base_appscan_api_uri = "https://#{appscan_ip}/ase/services".to_s.scrub password = if opts[:password].nil? PWN::Plugins::AuthenticationHelper.mask_password else opts[:password].to_s.scrub end @@logger.info("Logging into IBM Appscan Enterprise Server: #{appscan_ip}") browser_obj = PWN::Plugins::TransparentBrowser.open(browser_type: :rest) rest_client = browser_obj[:browser]::Request response = rest_client.execute( method: :post, url: "#{base_appscan_api_uri}/login", payload: "userid=#{username}&password=#{password}", verify_ssl: false ) # Return array containing the Appscan Server host/ip & post-authenticated Appscan REST cookie appscan_ip = URI.parse(response.args[:url]).host = "asc_session_id=#{response.['asc_session_id']}; ASP.NET_SessionId=#{response.['ASP.NET_SessionId']}" appscan_obj = {} appscan_obj[:appscan_ip] = appscan_ip appscan_obj[:cookie] = appscan_obj[:raw_response] = response appscan_obj[:xml_response] = Nokogiri::XML(response) appscan_obj[:build] = appscan_obj[:xml_response].xpath( '/xmlns:version/xmlns:build' ).text appscan_obj[:dbversion] = appscan_obj[:xml_response].xpath( '/xmlns:version/xmlns:dbversion' ).text appscan_obj[:rules_version] = appscan_obj[:xml_response].xpath( '/xmlns:version/xmlns:rules-version' ).text appscan_obj[:username] = appscan_obj[:xml_response].xpath( '/xmlns:version/xmlns:user-name' ).text appscan_obj[:password] = Base64.strict_encode64(password) appscan_obj[:logged_in] = true appscan_obj rescue StandardError => e raise e end |
.logout(opts = {}) ⇒ Object
- Supported Method Parameters
-
PWN::Plugins::IBMAppscan.logout(
appscan_obj: 'required appscan_obj returned from login method'
)
796 797 798 799 800 801 802 803 804 805 806 807 808 |
# File 'lib/pwn/plugins/ibm_appscan.rb', line 796 public_class_method def self.logout(opts = {}) appscan_obj = opts[:appscan_obj] @@logger.info('Logging out...') response = appscan_rest_call(appscan_obj: appscan_obj, rest_call: 'logout') if response == '' appscan_obj[:logged_in] = false 'logout successful' else response end rescue StandardError => e raise e end |
.schema(opts = {}) ⇒ Object
- Supported Method Parameters
-
PWN::Plugins::IBMAppscan.schema(
appscan_obj: 'required appscan_obj returned from login method'
)
146 147 148 149 150 151 152 153 154 155 |
# File 'lib/pwn/plugins/ibm_appscan.rb', line 146 public_class_method def self.schema(opts = {}) appscan_obj = opts[:appscan_obj] response = appscan_rest_call(appscan_obj: appscan_obj, rest_call: 'schema') schema = {} schema[:raw_response] = response schema[:xml_response] = Nokogiri::XML(response) schema rescue StandardError => e raise e end |
.version(opts = {}) ⇒ Object
- Supported Method Parameters
-
PWN::Plugins::IBMAppscan.version(
appscan_obj: 'required appscan_obj returned from login method'
)
162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 |
# File 'lib/pwn/plugins/ibm_appscan.rb', line 162 public_class_method def self.version(opts = {}) appscan_obj = opts[:appscan_obj] response = appscan_rest_call(appscan_obj: appscan_obj, rest_call: 'version') version = {} version[:raw_response] = response version[:xml_response] = Nokogiri::XML(response) version[:build] = version[:xml_response].xpath( '/xmlns:version/xmlns:build' ).text version[:dbversion] = version[:xml_response].xpath( '/xmlns:version/xmlns:dbversion' ).text version[:rules_version] = version[:xml_response].xpath( '/xmlns:version/xmlns:rules-version' ).text version[:username] = version[:xml_response].xpath( '/xmlns:version/xmlns:user-name' ).text version rescue StandardError => e raise e end |