Nessus6 0.1.8 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c3aba5750c8d57f4ebc153f048b939b66c133a79
-  data.tar.gz: 6d3eedfd62b45e77531f081c56da11990a13d01f
+  metadata.gz: f946afee24ef43e6b6628db34f17781d12d4ee9c
+  data.tar.gz: d143fca91c08c8cf0180f51410dc6e7fce95ffcf
 SHA512:
-  metadata.gz: 928cc8afbaa5b4d6600980101c9cf376160b025891df37dca292a1222cb84738243b86d03633e5ea6ee5d64960d8fd208ca5fe120120aa59f9b619b97b3c2ddf
-  data.tar.gz: c7eb4bfad5059da1892f34076cb8cc1c1f40bb62c7f7e6a0a5bacc4e179b3028bfe81b9b049983e23d765209f7ab9fab37fc2da53fc8573aac8056855ec52036
+  metadata.gz: f79d967ef973421555e7bb5b6a0ca06bf342480f44de6a3c5b8c8943076f90f96aeacc143ba59599d094cf1387455b6b60cf7bc3b6f9ce0161e0b4ce12b90630
+  data.tar.gz: 517c90f4d10b8b2fabc6050143b36c8a9acb974e58ccca8c604c79a25da353599758eda73355a6df880544da35350ba28e5064ddcbd065278ee16e7e05d647a6

data/.travis.yml

@@ -14,6 +14,7 @@ rvm:
   - jruby-head
 
 before_install:
+  - gem install bundler -v 1.10.6
   - gem update --system
   - gem --version
 

data/bin/launch_incoming_scans

@@ -0,0 +1,54 @@
+#!/usr/bin/env ruby
+
+require 'Nessus6'
+require 'fileutils'
+require 'logger'
+
+# Global variables for the script / binary
+@base_directory = '/opt/scanner'
+@temp_directory = "#{@base_directory}/temp#{Process.pid}"
+@incoming_directory = "#{@base_directory}/targets/incoming"
+@results_directory = "#{@base_directory}/results"
+@send_mail = '/usr/lib/sendmail -t'
+
+credentials = {
+  access_key: 'eeb88394142b4b328332c2448e0f04846161493a50feaa454cbb2fa5083919f9',
+  secret_key: 'b0d69c23612754367a84d168f2e7d6769aff1342cb25aa345481cb537164e092'
+}
+
+nessus_location = {
+  ip: 'localhost',
+  port: '8834'
+}
+
+@append_results = "x-scanner|#{nessus_location[:ip]}"
+
+# Prep work
+FileUtils.mkdir_p @temp_directory
+@logger = Logger.new(STDOUT)
+@logger.level = Logger::INFO
+
+# Begin the main portion of the app
+@logger.debug 'Creating Nessus API Client'
+@client = Nessus6::Client.new credentials, nessus_location
+
+Dir.foreach(@incoming_directory) do |file|
+  @logger.debug "Processing #{@incoming_directory}/#{file}"
+  next if file == '.' || file == '..' # skip current / parent directory opts
+
+  @logger.info "Archiving #{@incoming_directory}/#{file} to " \
+               "#{@base_directory}/targets/archive/#{file}."
+#   FileUtils.copy "#{@incoming_directory}/#{file}",
+#                  "#{@base_directory}/targets/archive/#{file}"
+
+  @logger.info "Moving #{@incoming_directory}/#{file} to " \
+               "#{@temp_directory}/#{file}"
+#   FileUtils.move "#{@incoming_directory}/#{file}",
+#                  "#{@temp_directory}/#{file}"
+
+  @logger.info 'Finding the request ID in the file.'
+  request_id = File.readlines("#{@incoming_directory}/#{file}").select do |line|
+    line =~ /^requestid.*$/
+  end
+  puts request_id
+end

data/bin/launch_incoming_scans.sh

@@ -0,0 +1,90 @@
+#!/bin/sh
+
+#
+# Script looks for target files in incoming directory, and launches Nessus
+#
+
+BASEDIR=/opt/scanner
+TEMPDIR=${BASEDIR}/temp$$
+INCOMINGDIR=${BASEDIR}/targets/incoming
+RESULTSDIR=${BASEDIR}/results
+SENDMAIL="/usr/lib/sendmail -t"
+
+NESSUSBIN=/opt/nessus/bin/nessus
+NESSUSUSER=scripts
+NESSUSPASSWORD=XXXXXXXXXXXXXXX
+
+IPADDR="153.39.86.90"
+APPENDRESULTS="x-scanner|${IPADDR}"
+
+mkdir -p ${TEMPDIR}
+
+#
+# Grab one file in incoming directory
+#
+FILES=`cd ${INCOMINGDIR}; ls -r -1 *.txt | tail -n 1`
+for file in $FILES
+do
+  echo "Moving ${INCOMINGDIR}/${file} to ${TEMPDIR}/${file}..."
+  cp ${INCOMINGDIR}/${file} ${BASEDIR}/targets/archive/${file}
+  mv ${INCOMINGDIR}/${file} ${TEMPDIR}/${file}
+  if [ $? -eq 0 ]
+  then
+    #
+    # Find request id
+    #
+    REQUESTID=`cat ${TEMPDIR}/${file} | grep "requestid" | awk '{ print $2 }'`
+    if [ -z ${REQUESTID} ]
+    then
+      REQUESTID=`date -u +%s`
+    else
+      APPENDRESULTS="${APPENDRESULTS}
+x-requestid|${REQUESTID}"
+    fi
+
+    #
+    # Find scanning method and nessusrc
+    #
+    METHOD=`cat ${TEMPDIR}/${file} | grep "method" | awk '{ print $2 }'`
+    if [ -z ${METHOD} ]
+    then
+      METHOD="default"
+    fi
+
+    #    NESSUSRC="${NESSUSRC}.${METHOD}"
+    NESSUSRC="${BASEDIR}/${METHOD}.nessusrc"
+
+    #
+    # Create target file
+    #
+    TARGETFILE=${TEMPDIR}/tmp_target_${IPADDR}_${REQUESTID}.txt
+    RESULTSFILE=${TEMPDIR}/results_${IPADDR}_${REQUESTID}_$$.nbe
+    echo "Creating ${TARGETFILE}..."
+    cat ${TEMPDIR}/${file} | grep "\/" > ${TARGETFILE}
+
+    #
+    # Launch Nessus
+    #
+    echo "Launching Nessus..."
+    ${NESSUSBIN} -x -q -c ${NESSUSRC} 127.0.0.1 1241 ${NESSUSUSER} ${NESSUSPASSWORD} ${TARGETFILE} ${RESULTSFILE}
+    if [ $? -eq 0 ] && [ -s ${RESULTSFILE} ]
+    then
+      echo "${APPENDRESULTS}" >> ${RESULTSFILE}
+    else
+      # Nessus failed, move target file back to incoming dir
+      mv ${TEMPDIR}/${file} ${INCOMINGDIR}/${file}
+      rm -rf ${TEMPDIR}
+      exit 1
+    fi
+
+    echo "Moving ${RESULTSFILE} to ${RESULTSDIR}..."
+
+    # copy results to results dir
+    cp ${RESULTSFILE} ${BASEDIR}/archive
+    mv ${RESULTSFILE} ${RESULTSDIR}/
+    echo "Cleaning up ${TEMPDIR}..."
+    rm ${TARGETFILE} ${TEMPDIR}/${file}
+  fi
+done
+
+rmdir --ignore-fail-on-non-empty ${TEMPDIR}

data/lib/Nessus6/scan.rb

@@ -11,6 +11,18 @@ module Nessus6
       @client = client
     end
 
+    # Changes the schedule or policy parameters of a scan
+    #
+    # @param scan_id [String, Fixnum] The id of the scan to change.
+    # @param opts [Hash]
+    # @return [Hash] Returns information about the scan in question.
+    def configure(scan_id, opts)
+      response = client.put "scans/#{scan_id}", opts
+      verify response,
+             not_found: 'Scan does not exist.',
+             internal_server_error: 'Error occurred while saving the configuration'
+    end
+
     # Copies the given scan. Requires can configure scan permissions
     #
     # @param scan_id [String, Fixnum] The id of the scan to export.
@@ -28,10 +40,21 @@ module Nessus6
       end
 
       verify response,
-             not_found: 'Scan does not exist.',
+             not_found: "Scan with Scan ID of #{scan_id} does not exist.",
              internal_server_error: 'An error occurred while copying.'
     end
 
+    # Creates a scan.
+    # This request requires standard user permissions.
+    #
+    # @param opts [Hash] The parameters hash required for creating a scan.
+    # @return [Hash]
+    def create(opts)
+      response = @client.post 'scans', opts
+      verify response,
+             internal_server_error: 'An error occurred while saving the scan.'
+    end
+
     # Deletes a scan. NOTE: Scans in running, paused or stopping states can not
     # be deleted. This request requires can configure scan permissions
     #
@@ -54,7 +77,7 @@ module Nessus6
     def delete_history(scan_id, query_params = nil)
       response = @client.delete "scans/#{scan_id}"
       verify response,
-             not_found: 'Results were not found.',
+             not_found: "Results were not found for scan #{scan_id}.",
              internal_server_error: 'Failed to delete the results.'
     end
 
@@ -74,6 +97,33 @@ module Nessus6
       JSON.parse response.body
     end
 
+    # Downloads an exported scan
+    # This request requires can view scan permissions
+    #
+    # @param scan_id [String, Fixnum] The id of the scan to export
+    # @param file_id [String, Fixnum] The id of the file to download (included in response from /scans/{scan_id}/export)
+    def download(scan_id, file_id, write_path = nil)
+      response = @client.get "scans/#{scan_id}/export/#{file_id}/download"
+      hash_response = verify response,
+                      not_found: 'The scan or file does not exist.'
+
+      File.open(write_path, 'w+') { |file| file.write response } unless write_path.nil?
+      hash_response
+    end
+
+    # Export the given scan
+    # This request requires can view scan permissions
+    #
+    # @param scan_id [String, Fixnum] The id of the scan to export
+    # @param opts [Hash] The hash of query parameters
+    def export(scan_id, params)
+      response = @client.post "scans/#{scan_id}/export", params
+      verify response,
+             bad_request: 'Missing required parameters: Scan ID or File Format'\
+                          ' (:format) are required.',
+             not_found: "Scan ID #{scan_id} could not be found. Please try again"
+    end
+
     # Launches a scan.
     #
     # @param scan_id [String, Fixnum] The id of the scan to launch.

data/lib/Nessus6/user.rb

@@ -94,7 +94,7 @@ module Nessus6
     # @return [Hash] The user list
     def list
       response = @client.get('users')
-      verif response,
+      verify response,
             forbidden: 'You do not have permission to view the list'
     end
 

data/lib/Nessus6/version.rb

@@ -1,5 +1,5 @@
 # The Nessus6 module is used to interact with Nessus version 6 servers.
 module Nessus6
   # VERSION is the current version of the Nessus6 gem
-  VERSION = '0.1.8'
+  VERSION = '0.2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: Nessus6
 version: !ruby/object:Gem::Version
-  version: 0.1.8
+  version: 0.2.0
 platform: ruby
 authors:
 - Kevin Kirsche
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-09-30 00:00:00.000000000 Z
+date: 2015-10-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -110,6 +110,8 @@ files:
 - README.md
 - Rakefile
 - bin/console
+- bin/launch_incoming_scans
+- bin/launch_incoming_scans.sh
 - bin/setup
 - lib/Nessus6.rb
 - lib/Nessus6/editor.rb