pwn 0.4.601 → 0.4.603

data/bin/pwn_nessus_cloud_scan_crud

@@ -0,0 +1,345 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'pwn'
+require 'optparse'
+require 'yaml'
+
+opts = {}
+OptionParser.new do |options|
+  options.banner = "USAGE:
+    #{$PROGRAM_NAME} [opts]
+  "
+
+  options.on('-cYPATH', '--yaml-config=YPATH', '<Required - YAML Config Containing Access & Secret Keys for Authentication, Including Credential Information for Scan Creation (https://developer.tenable.com/docs/determine-settings-for-credential-type)>') do |c|
+    opts[:yaml_config] = c
+  end
+
+  options.on('-nNAME', '--scan-name=NAME', '<Required - YAML Name of Scan to Create>') do |n|
+    opts[:scan_name] = n
+  end
+
+  options.on('-TTARGETS', '--text-targets=TARGETS', '<Required - Comma-delimited list of targets to scan>') do |t|
+    opts[:text_targets] = t
+  end
+
+  options.on('-dDESC', '--scan-description=DESC', '<Optional - Scan Description (Defaults to nil)>') do |d|
+    opts[:scan_desc] = d
+  end
+
+  options.on('-eEMAILS', '--emails=EMAILS', '<Optional - Comma-delimited list of email addresses that receive the email summary report>') do |e|
+    opts[:emails] = e
+  end
+
+  options.on('-tVALUE', '--scan-template=VALUE', '<Optional - Canned Scan Template to Use for Scan Creation (Defaults to "Basic Network Scan">') do |t|
+    opts[:scan_template_name] = t
+  end
+
+  options.on('-pPOLICY', '--policy-name=POLICY', '<Optional - Policy to Use to Create the Scan>') do |p|
+    opts[:policy_name] = p
+  end
+
+  options.on('-fFOLDER', '--folder-name=FOLDER', '<Optional - Where to Store the Scan (Defaults to "My Scans")>') do |f|
+    opts[:folder_name] = f
+  end
+
+  options.on('-sSCANNER', '--scanner-name=SCANNER', '<Optional - Scanner to Use (Defaults to "AUTO-ROUTED")>') do |s|
+    opts[:scanner_name] = s
+  end
+
+  options.on('-E', '--enable-schedule', '<Optional - If true, the schedule for the scan is enabled (Defaults to false)>') do |e|
+    opts[:enable_schedule] = e
+  end
+
+  options.on('-NTARGET', '--target-network-name=TARGET', '<Optional - If --scanner other than AUTO-ROUTED, Otherwise Required - Network to Scan (Defaults to "Default")>') do |n|
+    opts[:target_network_name] = n
+  end
+
+  options.on('-lWHEN', '--launch=WHEN', '<Optional - When to Launch Scan - ON_DEMAND || DAILY || WEEKLY || MONTHLY || YEARLY (Defaults to "ON_DEMAND")>') do |l|
+    opts[:launch] = l
+  end
+
+  options.on('-wTIMEWINDOW', '--scan-time-window=TIMEWINDOW', '<Optional - Scan Time Window in Minutes (Defaults to 0)>') do |t|
+    opts[:scan_time_window] = t
+  end
+
+  options.on('-STIME', '--start-time=TIME', '<Optional - For One-Time Scans, the Starting Time and Date for the Scan (e.g. "2777-07-07T00:00:00")>') do |t|
+    opts[:starttime] = t
+  end
+
+  options.on('-rRRULES', '--rrules=RRULES', '<Optional - For One-Time Scans, the Starting Time and Date for the Scan (e.g. "FREQ=WEEKLY;INTERVAL=3;BYDAY=MO,WE,FR")>') do |r|
+    opts[:rrules] = r
+  end
+
+  options.on('-xTAGS', '--tag-targets=TAGS', '<Optional - Comma-delimited list of tags to add to targets in scan>') do |x|
+    opts[:tag_targets] = x
+  end
+
+  options.on('-yCATEGORY', '--tag-category-name=CATEGORY', '<Optional - Tag Category Name to Associate with --tag-targets flag>') do |y|
+    opts[:tag_category_name] = y
+  end
+
+  options.on('-zTIMEZONE', '--timezone=TIMEZONE', '<Optional - Timezone of the scheduled start time for the scan (e.g. "US/Eastern")>') do |t|
+    opts[:timezone] = t
+  end
+
+  options.on('-gGROUPS', '--target-groups=GROUPS', '<Optional - Comma-delimited list of target group IDs to scan>') do |g|
+    opts[:target_groups] = g
+  end
+end.parse!
+
+if opts.empty?
+  puts `#{$PROGRAM_NAME} --help`
+  exit 1
+end
+
+begin
+  # Get Options Passed to pwn_nessus_cloud_create_scan
+  # Required Arguments
+  yaml_config = opts[:yaml_config]
+
+  raise "YAML Config Not Found: #{yaml_config}" unless File.exist?(yaml_config)
+
+  yaml = YAML.load_file(
+    yaml_config,
+    symbolize_names: true
+  )
+
+  access_key = yaml[:access_key]
+  secret_key = yaml[:secret_key]
+
+  scan_name = opts[:scan_name]
+
+  text_targets = opts[:text_targets]
+  raise 'ERROR: --text-targets (i.e. List of targets to scan) is required.' unless text_targets
+
+  # Optional Arguments
+  scan_desc = opts[:scan_desc]
+
+  scan_template_name = opts[:scan_template_name]
+  scan_template_name ||= 'Basic Network Scan'
+
+  policy_name = opts[:policy_name]
+  policy_name ||= ''
+
+  folder_name = opts[:folder_name]
+  folder_name ||= 'My Scans'
+
+  scanner_name = opts[:scanner_name]
+  scanner_name ||= 'AUTO-ROUTED'
+
+  target_network_name = opts[:target_network_name]
+  target_network_name ||= 'Default'
+
+  enable_schedule = true if opts[:enable_schedule]
+  enable_schedule ||= false
+
+  launch = opts[:launch]
+  launch ||= 'ON_DEMAND'
+
+  scan_time_window = opts[:scan_time_window].to_i
+  scan_time_window ||= 0
+
+  starttime = opts[:starttime]
+  # starttime ||= Time.now.strftime('%Y%m%dT%H%M%S')
+
+  rrules = opts[:rrules]
+  # rrules ||= 'FREQ=null;INTERVAL=0;BYDAY=null'
+
+  timezone = opts[:timezone]
+  # timezone ||= 'UTC'
+
+  target_groups = opts[:target_groups]
+
+  file_targets = opts[:file_targets]
+
+  tag_targets = opts[:tag_targets]
+  tag_targets_arr = []
+  tag_targets_arr = tag_targets.split(',') if tag_targets
+
+  tag_category_name = opts[:tag_category_name]
+  raise 'ERROR: --tag-category-name Required as --tag-targets is Populated' if tag_targets && !tag_category_name
+
+  agent_group_name = opts[:agent_group_name]
+  agent_group_id_arr = []
+
+  agent_scan_launch_type = opts[:agent_scan_launch_type]
+  agent_scan_launch_type ||= 'triggered'
+
+  triggers_arr = []
+  triggers = {}
+  triggers[:type] = agent_scan_launch_type
+  triggers[:type] ||= 'periodic'
+
+  triggers[:options] = {}
+  case agent_scan_launch_type
+  when 'periodic'
+    triggers[:options][:periodic_hourly_interval] = opts[:periodic_hourly_interval]
+    triggers[:options][:periodic_hourly_interval] ||= 0
+  when 'file-exists'
+    triggers[:options][:filename] = opts[:filename]
+  end
+
+  triggers_arr.push(triggers)
+
+  emails = opts[:emails]
+
+  acls = {}
+  acls[:permissions] = opts[:acl_permissions]
+  acls[:owner] = opts[:acl_owner]
+  acls[:display_name] = opts[:acl_display_name]
+  acls[:name] = opts[:acl_name]
+  acls[:id] = opts[:acl_id]
+  acls[:type] = opts[:acl_type]
+
+  credential_category = opts[:credential_category]
+  credential_type = opts[:credential_type]
+
+  # Begin Here
+  nessus_obj = PWN::Plugins::NessusCloud.login(
+    access_key: access_key,
+    secret_key: secret_key
+  )
+
+  # Requirements to update / create a scan:
+  # Part 1: Populate uuid
+  # Part 2: Populate settings object from options passed to driver
+  # Part 3: Populate credentials object from YAML config (optional)
+  # Part 4: Populate plugins object from YAML config (optional)
+  # Part 5: Update Scan if it exists, or create it.
+
+  # Part 1: Populate uuid
+  # TODO: add --list-canned-scan-templates option
+  scan_template = PWN::Plugins::NessusCloud.get_canned_scan_templates(
+    nessus_obj: nessus_obj,
+    name: scan_template_name
+  )
+  scan_template_uuid = scan_template[:uuid]
+
+  # Part 2: Populate settings object from options passed to driver
+  settings = {}
+  settings[:name] = scan_name
+  settings[:description] = scan_desc if scan_desc
+
+  policy = PWN::Plugins::NessusCloud.get_policies(
+    nessus_obj: nessus_obj,
+    name: policy_name
+  )
+  settings[:policy_id] = policy[:id]
+
+  folder = PWN::Plugins::NessusCloud.get_folders(
+    nessus_obj: nessus_obj,
+    name: folder_name
+  )
+  settings[:folder_id] = folder[:id]
+
+  scanner = PWN::Plugins::NessusCloud.get_scanners(
+    nessus_obj: nessus_obj,
+    name: scanner_name
+  )
+  settings[:scanner_id] = scanner[:id]
+
+  target_network = PWN::Plugins::NessusCloud.get_target_networks(
+    nessus_obj: nessus_obj,
+    name: target_network_name
+  )
+  settings[:target_network_uuid] = target_network[:uuid]
+
+  settings[:enabled] = enable_schedule
+
+  settings[:launch] = launch
+
+  settings[:scan_time_window] = scan_time_window
+
+  settings[:starttime] = starttime
+
+  settings[:rrules] = rrules
+
+  settings[:timezone] = timezone
+
+  settings[:text_targets] = text_targets
+
+  # Example array on https://developer.tenable.com/reference/scans-create is really just a string.
+  settings[:target_groups] = "[#{target_groups}]" if target_groups
+
+  settings[:file_targets] = file_targets if file_targets
+
+  if tag_targets_arr.any?
+    tag_uuids_arr = []
+    tag_targets_arr.each do |tag_name|
+      # Lookup tag and create if does not exist
+      tag = PWN::Plugins::NessusCloud.get_tag_values(
+        nessus_obj: nessus_obj,
+        name: tag_name
+      )
+      tag_uuid = tag[:uuid] if tag.any?
+      tag_uuids_arr.push(tag_uuid) if tag.any?
+      next if tag.any?
+
+      new_tag = PWN::Plugins::NessusCloud.create_tag(
+        nessus_obj: nessus_obj,
+        category: tag_category_name,
+        value: tag_name
+      )
+      tag_uuid = new_tag[:uuid]
+      tag_uuids_arr.push(tag_uuid)
+    end
+
+    tag_assets = PWN::Plugins::NessusCloud.add_tag_to_assets(
+      nessus_obj: nessus_obj,
+      targets: text_targets,
+      tag_uuids: tag_uuids_arr
+    )
+
+    settings[:tag_targets] = tag_uuids_arr
+  end
+
+  settings[:agent_group_id] = agent_group_id_arr if agent_group_id_arr.any?
+
+  settings[:agent_scan_launch_type] = agent_scan_launch_type if agent_scan_launch_type
+
+  settings[:triggers] = triggers_arr if triggers_arr.any?
+
+  settings[:emails] = emails if emails
+
+  # settings[:acls] = acls if acls
+
+  # Part 3: Populate credentials object from YAML config (optional)
+  credentials = yaml[:credentials] if yaml[:credentials]
+
+  # Part 4: Populate plugins object from YAML config (optional)
+  plugins = yaml[:plugins] if yaml[:plugins]
+
+  # Part 5: Update Scan if it exists, or create it.
+  scan = PWN::Plugins::NessusCloud.get_scans(
+    nessus_obj: nessus_obj,
+    name: scan_name
+  )
+  if scan.any?
+    scan_id = scan[:id]
+    update_scan_resp = PWN::Plugins::NessusCloud.update_scan(
+      nessus_obj: nessus_obj,
+      scan_id: scan_id,
+      scan_template_uuid: scan_template_uuid,
+      settings: settings,
+      credentials: credentials,
+      plugins: plugins
+    )
+
+    puts update_scan_resp.inspect
+  else
+    create_scan_resp = PWN::Plugins::NessusCloud.create_scan(
+      nessus_obj: nessus_obj,
+      scan_template_uuid: scan_template_uuid,
+      settings: settings,
+      credentials: credentials,
+      plugins: plugins
+    )
+
+    puts create_scan_resp.inspect
+  end
+rescue Interrupt
+  puts 'CTRL+C detected...goodbye.'
+rescue StandardError => e
+  raise e
+end

data/bin/pwn_nessus_cloud_vulnscan

@@ -0,0 +1,99 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'pwn'
+require 'optparse'
+require 'yaml'
+
+opts = {}
+OptionParser.new do |options|
+  options.banner = "USAGE:
+    #{$PROGRAM_NAME} [opts]
+  "
+
+  options.on('-cYPATH', '--yaml-config=YPATH', '<Required - YAML Config Containing Access & Secret Keys for Authentication>') do |c|
+    opts[:yaml_config] = c
+  end
+
+  options.on('-nVALUE', '--scan-name=VALUE', '<Required - Name of Scan to Launch>') do |n|
+    opts[:scan_name] = n
+  end
+
+  options.on('-rRPATH', '--report-path=RPATH', '<Required - Path / Filename of Report>') do |r|
+    opts[:path_to_export] = r
+  end
+
+  options.on('-fFORMAT', '--report-format=FORMAT', '<Optional - Report Format :csv|:db|:html|:nessus|:pdf (defaults to :csv)>') do |f|
+    opts[:format] = f
+  end
+end.parse!
+
+if opts.empty?
+  puts `#{$PROGRAM_NAME} --help`
+  exit 1
+end
+
+begin
+  yaml_config = opts[:yaml_config]
+
+  raise "YAML Config Not Found: #{yaml_config}" unless File.exist?(yaml_config)
+
+  yaml = YAML.load_file(
+    yaml_config,
+    symbolize_names: true
+  )
+
+  access_key = yaml[:access_key]
+  secret_key = yaml[:secret_key]
+  scan_name = opts[:scan_name]
+  path_to_export = opts[:path_to_export]
+  format = opts[:format]
+
+  nessus_obj = PWN::Plugins::NessusCloud.login(
+    access_key: access_key,
+    secret_key: secret_key
+  )
+
+  scan = PWN::Plugins::NessusCloud.get_scans(
+    nessus_obj: nessus_obj,
+    name: scan_name
+  )
+  scan_id = scan[:id]
+
+  PWN::Plugins::NessusCloud.launch_scan(
+    nessus_obj: nessus_obj,
+    scan_id: scan_id
+  )
+
+  scan_status = 'initializing'
+
+  loop do
+    print '.'
+    sleep 60
+
+    scan_status_resp = PWN::Plugins::NessusCloud.get_scan_status(
+      nessus_obj: nessus_obj,
+      scan_id: scan_id
+    )
+
+    scan_status = scan_status_resp[:status]
+    break if scan_status != 'initializing' && scan_status != 'pending' && scan_status != 'running'
+  end
+
+  raise "Scan status reached an unexpected condition: #{scan_status}.  Re-verify the scan config for, '#{scan_name}' and try again." unless scan_status == 'completed'
+
+  puts 'scan complete.'
+
+  print "Exporting results to #{path_to_export}..."
+  PWN::Plugins::NessusCloud.export_scan_results(
+    nessus_obj: nessus_obj,
+    scan_id: scan_id,
+    path_to_export: path_to_export,
+    format: format
+  )
+  puts 'complete.'
+rescue Interrupt
+  puts 'CTRL+C detected...goodbye.'
+rescue StandardError => e
+  raise e
+end

data/bin/pwn_nexpose

@@ -0,0 +1,52 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'pwn'
+require 'optparse'
+
+opts = {}
+OptionParser.new do |options|
+  options.banner = "USAGE:
+    #{$PROGRAM_NAME} [opts]
+  "
+
+  # Nexpose Flags
+  options.on('-CIP', '--console_ip=IP', '<Required - Nexpose Console IP>') { |c| opts[:console_ip] = c }
+  options.on('-UCUSER', '--console_username=CUSER', '<Required - Nexpose Console Username>') { |cu| opts[:console_username] = cu }
+  options.on('-PCPASS', '--console_password=CPASS', '<Required - Nexpose Console Password>') { |cp| opts[:console_password] = cp }
+  options.on('-SSITE', '--site_name=SITE', '<Required - Nexpose Site Name>') { |s| opts[:site_name] = s }
+  options.on('-RREPORTS', '--report_names=REPORTS', '<Required - Comma Delimited String of Report Names>') { |r| opts[:report_names] = r }
+end.parse!
+
+if opts.empty?
+  puts `#{$PROGRAM_NAME} --help`
+  exit 1
+end
+
+# Nexpose
+console_ip = opts[:console_ip].to_s.scrub
+console_username = opts[:console_username].to_s.scrub
+console_password = opts[:console_password] # Prompt if console_password.nil? (For Demos)
+site_name = opts[:site_name].to_s.scrub
+report_names = opts[:report_names].to_s.scrub
+
+#-----------------
+# Login to Nexpose
+site_id = nil
+nsc_obj = PWN::Plugins::NexposeVulnScan.login(
+  console_ip: console_ip,
+  username: console_username,
+  password: console_password
+)
+
+nsc_obj = PWN::Plugins::NexposeVulnScan.scan_site_by_name(
+  nsc_obj: nsc_obj,
+  site_name: site_name
+)
+
+nsc_obj = PWN::Plugins::NexposeVulnScan.download_recurring_report(
+  nsc_obj: nsc_obj,
+  report_names: report_names
+)
+
+PWN::Plugins::NexposeVulnScan.logout(nsc_obj: nsc_obj)

data/bin/pwn_openvas_vulnscan

@@ -0,0 +1,102 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'pwn'
+require 'optparse'
+
+opts = {}
+OptionParser.new do |options|
+  options.banner = "USAGE:
+    #{$PROGRAM_NAME} [opts]
+  "
+
+  options.on('-tTASK_NAME', '--task-name=TASK_NAME', '<Required - Task Name to Start>') do |t|
+    opts[:task_name] = t
+  end
+
+  options.on('-sDIR', '--save-report-to-dir=DIR', '<Required - Directory to Save Report>') do |d|
+    opts[:report_dir] = d
+  end
+
+  options.on('-uUSERNAME', '--username=USERNAME', '<Required - Username to AuthN>') do |u|
+    opts[:username] = u
+  end
+
+  options.on('-pPASSWORD', '--password=PASSWORD', '<Optional - Password to AuthN (Will Prompt if nil)>') do |p|
+    opts[:password] = p
+  end
+end.parse!
+
+if opts.empty?
+  puts `#{$PROGRAM_NAME} --help`
+  exit 1
+end
+
+task_name = opts[:task_name]
+
+report_dir = opts[:report_dir].to_s.scrub
+raise "#{report_dir} Does Not Exist." unless Dir.exist?(
+  report_dir
+)
+
+username = opts[:username]
+password = if opts[:password].nil?
+             PWN::Plugins::AuthenticationHelper.mask_password
+           else
+             opts[:password].to_s.scrub
+           end
+
+begin
+  start_time = Time.now
+  puts "Started: #{start_time}"
+  PWN::Plugins::OpenVAS.start_task(
+    task_name: task_name,
+    username: username,
+    password: password
+  )
+
+  loop do
+    if PWN::Plugins::OpenVAS.get_task_status(
+      task_name: task_name,
+      username: username,
+      password: password
+    ).downcase == 'done'
+
+      end_time = Time.now
+      puts "\nCompleted: #{end_time}"
+      break
+    end
+
+    print '.'
+    sleep 30
+  end
+
+  end_time = Time.now
+  duration_mins = format(
+    '%0.2f',
+    (end_time - start_time) / 60
+  )
+
+  last_report_id = PWN::Plugins::OpenVAS.last_report_id(
+    task_name: task_name,
+    username: username,
+    password: password
+  )
+  puts "\nLast Report ID Generated by #{task_name}: #{last_report_id}"
+
+  print "Saving report in #{report_dir}..."
+  PWN::Plugins::OpenVAS.save_report(
+    report_type: :csv,
+    report_id: last_report_id,
+    report_dir: report_dir,
+    username: username,
+    password: password
+  )
+  puts 'complete.'
+
+  puts "Task Duration (Minutes): #{duration_mins}"
+rescue Interrupt
+  puts 'CTRL+C detected...goodbye.'
+rescue StandardError => e
+  raise e
+end