nessus-xmlrpc 0.4.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,13 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "shoulda", ">= 0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.2"
+  gem "rcov", ">= 0"
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Vlatko Kosturjak
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,84 @@
+= nessus-xmlrpc
+
+Nessus XML RPC library and Nessus Command Line interface to XML RPC
+
+(C) Vlatko Kosturjak, Kost. Distributed under MIT.
+
+Requirements
+============
+Requirements are quite standard Ruby libraries for HTTPS and XML
+parsing:
+require 'uri'
+require 'net/https'
+require 'rexml/document'
+
+nessus-cli.rb
+=============
+Nessus command line interface for XML-RPC.
+
+Type ./nessus-cli.rb --help for command line options.
+
+Examples:
+---------
+
+./nessus-cli.rb --user john --password doe --scan scan-localhost --wait --output report.xml --target localhost
+
+./nessus-cli.rb --user user --password pass --scan localhost-scan --wait 5 -D --output report-localhost.xml --target localhost --verbose 
+
+./nessus-cli.rb --user user --password pass --scan localhost-scan --wait 5 -D --output report-localhost.xml --target 127.0.0.1 --verbose --policy mypolicy --url https://localhost:8834
+
+Or if you want to have detached scans:
+--------------------------------------
+
+./nessus-cli.rb --user user --password pass --scan localhost-scan --target 127.0.0.1 --policy mypolicy
+
+./nessus-cli.rb --user user --password pass --list-scans 
+
+./nessus-cli.rb --user user --password pass --pause 5329fae9-fb1d-0c67-a401-a0db12637c0d5bcd67900d34e00e
+
+./nessus-cli.rb --user user --password pass --resume 5329fae9-fb1d-0c67-a401-a0db12637c0d5bcd67900d34e00e
+
+./nessus-cli.rb --user user --password pass --stop 5329fae9-fb1d-0c67-a401-a0db12637c0d5bcd67900d34e00e
+
+./nessus-cli.rb --user user --password pass --stop-all
+
+./nessus-cli.rb --user user --password pass --report 5329fae9-fb1d-0c67-a401-a0db12637c0d5bcd67900d34e00e --output report.xml
+
+nessus-xmlrpc.rb
+================
+communicate with Nessus(4.2+) over XML RPC interface
+
+Simple example:
+
+require 'nessus-xmlrpc'
+n=NessusXMLRPC::NessusXMLRPC.new('https://localhost:8834','user','pass');
+# n=NessusXMLRPC::NessusXMLRPC.new('','user','pass'); # it's same
+if n.logged_in
+      id,name = n.policy_get_first
+      puts "using policy ID: " + id + " with name: " + name
+      uid=n.scan_new(id,"textxmlrpc","127.0.0.1")
+      puts "status: " + n.scan_status(uid)
+      while not n.scan_finished(uid)
+	      sleep 10
+      end
+      content=n.report_file_download(uid)
+      File.open('report.xml', 'w') {|f| f.write(content) }
+end
+
+Take a look at nessus-cli.rb for more advanced examples.
+
+== Contributing to nessus-xmlrpc
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2010 Vlatko Kosturjak. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,54 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "nessus-xmlrpc"
+  gem.homepage = "http://nessus-xmlrpc.rubyforge.org/"
+  gem.license = "MIT"
+  gem.summary = %Q{Nessus XML RPC library and Nessus Command Line interface to XML RPC}
+  gem.description = %Q{Ruby library for Nessus XMLRPC interface and Nessus command line example of using Ruby library. This library is used for communication with Nessus over XML RPC interface. You can start, stop, pause and resume scan. Watch progress and status of scan, download report, etc. }
+  gem.email = "vlatko.kosturjak@gmail.com"
+  gem.authors = ["Vlatko Kosturjak"]
+  # Include your dependencies below. Runtime dependencies are required when using your gem,
+  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
+  #  gem.add_runtime_dependency 'jabber4r', '> 0.1'
+  #  gem.add_development_dependency 'rspec', '> 1.2.3'
+  gem.rubyforge_project = "nessus-xmlrpc"
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "nessus-xmlrpc #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/TODO

@@ -0,0 +1 @@
+- Error handling, no puts

data/VERSION

@@ -0,0 +1 @@
+0.4.0

data/bin/nessus-cli.rb

@@ -0,0 +1,382 @@
+#!/usr/bin/env ruby
+# = nessus-cli.rb:  Nessus command line interface for XML-RPC
+# Author:: Vlatko Kosturjak
+# 
+# (C) Vlatko Kosturjak, Kost. Distributed under GPL and BSD (dual licensed).
+
+require 'nessus-xmlrpc'
+require 'getoptlong'
+
+verbose = 0
+debug = 0
+operation = ''
+targets = ''
+deletereport = false
+user = ''
+password = ''
+scanname = ''
+output = ''
+output1 = ''
+wait = ''
+policy = ''
+url = ''
+
+def intro 
+	$stderr.print $0 + ": Nessus command line interface for XML-RPC\n"
+	$stderr.print "(C) Vlatko Kosturjak, Kost. Distributed under GPL.\n"
+	$stderr.print "\n"
+end
+
+intro
+
+def give_help
+	puts <<-EOF
+--user <user>	user for login to Nessus server
+--password <p>	password for login to Nessus server
+--scan <name>	start scan with name
+--target <ip>	specify list of targets, separated by comma
+--policy <pol>	specify policy to use (name of policy)
+--url <url>	url of Nessus server (default: localhost:8834)
+--wait [t]	wait scan to finish (ask in regular periods of <t> for status)
+--output <f>	output report XML to file <f>
+--output1 <f>	output report XML v1 to file <f>
+--reportdelete	delete report after finish or delete report by id (if alone)
+--stop <id>	stop scan identified by <id>
+--stop-all	stop all scans
+--pause <id>	pause scan identified by <id>
+--pause-all	pause all scans
+--resume <id>	resume scan identified by <id>
+--resume-all	resume all scans
+--report <id>	download report identified by <id>
+--list-scans	list scans
+--list-policy	list policies
+--status <id>	get status of scan by <id>
+--verbose	be verbose
+--debug		be even more verbose
+--help		this help
+
+Examples: 
+#{$0} --user john --password doe --scan scan-localhost --wait --output report.xml --target localhost
+EOF
+	exit 0
+end
+
+if ARGV.length < 1
+	give_help
+end
+
+opt = GetoptLong.new(
+	["--help", "-h", GetoptLong::NO_ARGUMENT],
+	["--verbose", "-v", GetoptLong::OPTIONAL_ARGUMENT],
+	["--target", "-t", GetoptLong::REQUIRED_ARGUMENT],
+	["--user", "-u", GetoptLong::REQUIRED_ARGUMENT],
+	["--password", "-p", GetoptLong::REQUIRED_ARGUMENT],
+	["--policy", "-P", GetoptLong::REQUIRED_ARGUMENT],
+	["--url", "-U", GetoptLong::REQUIRED_ARGUMENT],
+	["--deletereport", "-D", GetoptLong::OPTIONAL_ARGUMENT],
+	["--wait", "-w", GetoptLong::OPTIONAL_ARGUMENT],
+	["--scan", "-s", GetoptLong::REQUIRED_ARGUMENT],
+	["--list-scans", "-l", GetoptLong::NO_ARGUMENT],
+	["--list-policy", "-L", GetoptLong::NO_ARGUMENT],
+	["--status", "-W", GetoptLong::REQUIRED_ARGUMENT],
+	["--stop", "-S", GetoptLong::REQUIRED_ARGUMENT],
+	["--stop-all", "-a", GetoptLong::NO_ARGUMENT],
+	["--pause", "-q", GetoptLong::REQUIRED_ARGUMENT],
+	["--pause-all", "-Q", GetoptLong::NO_ARGUMENT],
+	["--resume", "-e", GetoptLong::REQUIRED_ARGUMENT],
+	["--resume-all", "-E", GetoptLong::NO_ARGUMENT],
+	["--report", "-r", GetoptLong::REQUIRED_ARGUMENT],
+	["--output", "-o", GetoptLong::REQUIRED_ARGUMENT],
+	["--output1", "-1", GetoptLong::REQUIRED_ARGUMENT]
+)
+
+def give_error
+	$stderr.print "You used incompatible options, probably you mixed --scan with --stop"
+	$stderr.print "or something similar."
+	exit 0
+end
+
+opt.each do |opt,arg|
+	case opt
+		when	'--help'
+			give_help
+		when	'--user'
+			user = arg
+		when	'--password'
+			password = arg
+		when 	'--stop'
+			if operation == ''
+				operation = "stop"
+				scanname = arg
+			else
+				give_error
+			end
+		when 	'--pause'
+			if operation == ''
+				operation = "pause"
+				scanname = arg
+			else
+				give_error
+			end
+		when 	'--resume'
+			if operation == ''
+				operation = "resume"
+				scanname = arg
+			else
+				give_error
+			end
+		when 	'--stop-all'
+			if operation == ''
+				operation = "stop-all"
+			else
+				give_error
+			end
+		when 	'--pause-all'
+			if operation == ''
+				operation = "pause-all"
+			else
+				give_error
+			end
+		when 	'--resume-all'
+			if operation == ''
+				operation = "resume-all"
+			else
+				give_error
+			end
+		when 	'--report'
+			if operation == ''
+				operation = "report"
+				scanname = arg
+			else
+				give_error
+			end
+		when 	'--scan'
+			if operation == ''
+				operation = "scan"
+				scanname = arg
+			else
+				give_error
+			end
+		when	'--target'
+			if arg[0..6] == 'file://'
+				f = File.open(arg[7..-1], "r")
+				f.each_line do |line|
+					line=line.chomp
+					line=line.strip
+					unless line == '' or line == nil
+						if targets == ''
+							targets = line
+						else
+							targets = targets + "," + line
+						end
+					end
+				end
+				f.close
+			else
+				# if there's multiple target options, add comma
+				if targets == ''
+					targets = arg
+					
+				else
+					targets = targets + "," + arg
+				end
+			end
+		when	'--wait'
+			if arg == ''
+				wait = 15
+			else
+				wait = arg.to_i
+			end
+		when	'--reportdelete'
+			if arg = ''
+				deletereport=true
+			else
+				operation = "reportdelete"
+				scanname = arg
+			end
+
+		when	'--output'
+			output = arg
+		when	'--output1'
+			output1 = arg
+		when	'--policy'
+			policy = arg
+		when	'--status'
+			if operation == ''
+				operation = "status"
+				scanname = arg
+			else
+				give_error
+			end
+		when	'--url'
+			url = arg
+		when 	'--verbose'
+			if arg == ''
+				verbose += 1
+			else
+				verbose = arg.to_i
+			end
+		when 	'--debug'
+			if arg == ''
+				debug += 1
+			else
+				debug = arg.to_i
+			end
+		when	'--list-scans'
+			if operation == ''
+				operation = "list-scans"
+				scanname = arg
+			else
+				give_error
+			end
+		when	'--list-policy'
+			if operation == ''
+				operation = "list-policy"
+				scanname = arg
+			else
+				give_error
+			end
+	end
+end
+
+if (user == '') or (password == '')
+	$stderr.print "User and password is required to login to Nessus server"
+	$stderr.print "Try --help!"
+	exit 1
+end 
+
+$stderr.print "[i] Targets: " + targets +"\n" if verbose > 0 
+$stderr.print "[i] Connecting to nessus server: " if verbose > 0 
+n=NessusXMLRPC::NessusXMLRPC.new(url,user,password) 
+if n.logged_in 
+	$stderr.print "OK!\n" if verbose > 0
+else
+	$stderr.print "[e] Error connecting/logging to the server!\n" 
+	exit 2
+end
+
+case operation
+	when "scan"
+		if policy == ''
+			$stderr.print "[w] Policy not defined, using first served from the server\n"
+			pid,name = n.policy_get_first
+			$stderr.print "[w] using policy id " + pid + " with name " + name + "\n"
+		else
+			pid=n.policy_get_id(policy)
+			if pid == ''
+				$stderr.print "[e] policy doesn't exit: " + policy + "\n"
+				exit 3
+			end
+		end	
+		if targets == ''
+			$stderr.print "[w] Targets not defined, using localhost as target\n"
+			targets = '127.0.0.1'
+		end
+		$stderr.print "[i] Initiating scan with targets: "+targets+': ' if verbose > 0
+		uid=n.scan_new(pid,scanname,targets)
+		$stderr.print "done\n" if verbose > 0
+		unless wait == ''
+			while not n.scan_finished(uid)
+				$stderr.print "[v] Sleeping for " + wait.to_s() + ": " if verbose > 1			
+				sleep wait
+				$stderr.print "done\n" if verbose > 1
+				stat = n.scan_status(uid)
+				print "\r" + stat if verbose > 0
+			end	
+		else
+			puts uid
+			exit 0
+		end	
+		unless output == ''
+			$stderr.print "[i] Output XML report to file: "+output if verbose > 0
+			content=n.report_file_download(uid)	
+			File.open(output, 'w') {|f| f.write(content) }	
+			$stderr.print ": done\n" if verbose > 0
+		end
+		unless output1 == ''
+			$stderr.print "[i] Output XML1 report to file: "+output1 if verbose > 0
+			content=n.report_file1_download(uid)	
+			File.open(output, 'w') {|f| f.write(content) }	
+			$stderr.print ": done\n" if verbose > 0
+		end
+		if deletereport
+			$stderr.print "[i] Deleting report: " if verbose > 0
+			n.report_delete(uid)
+			$stderr.print "done\n" if verbose > 0
+		end
+	when "report"
+		uid=scanname
+		if (output == '') and (output1 == '') 
+			$stderr.print "[e] You want report, but specify filename with --output or output1\n"
+		end
+		unless output == ''
+			$stderr.print "[i] Output XML report to file: "+output if verbose > 0
+			content=n.report_file_download(uid)	
+			File.open(output, 'w') {|f| f.write(content) }	
+			$stderr.print ": done\n" if verbose > 0
+		end
+		unless output1 == ''
+			$stderr.print "[i] Output XML1 report to file: "+output1 if verbose > 0
+			content=n.report1_file_download(uid)	
+			File.open(output, 'w') {|f| f.write(content) }	
+			$stderr.print ": done\n" if verbose > 0
+		end
+		if deletereport
+			$stderr.print "[i] Deleting report: " if verbose > 0
+			n.report_delete(uid)
+			$stderr.print "done\n" if verbose > 0
+		end
+	when "stop"
+		$stderr.print "[i] Stopping scan: " + scanname if verbose > 0
+		n.scan_stop(scanname)
+		$stderr.print "done\n" if verbose > 0
+	when "stop-all"
+		$stderr.print "[i] Stopping all scans: " if verbose > 0	
+		list=n.scan_stop_all
+		$stderr.print "done\n" if verbose > 0
+		if verbose > 1
+			list.each {|uuid| puts "[v] Stop all: " + uuid }
+		end
+	when "pause"
+		$stderr.print "[i] Pausing scan: " + scanname if verbose > 0
+		n.scan_pause(scanname)
+		$stderr.print "done\n" if verbose > 0
+	when "pause-all"
+		$stderr.print "[i] Pausing all scans: " if verbose > 0	
+		list=n.scan_pause_all
+		$stderr.print "done\n" if verbose > 0
+		if verbose > 1
+			list.each {|uuid| puts "[v] Pause all: " + uuid }
+		end
+	when "resume"
+		$stderr.print "[i] Resuming scan: " + scanname if verbose > 0
+		n.scan_resume(scanname)
+		$stderr.print "done\n" if verbose > 0
+	when "resume-all"
+		$stderr.print "[i] Resuming all scans: " if verbose > 0	
+		list=n.scan_resume_all
+		$stderr.print "done\n" if verbose > 0
+		if verbose > 1
+			list.each {|uuid| puts "[v] Resume all: " + uuid }
+		end
+	when "reportdelete"
+		$stderr.print "[i] Deleting report: " + scanname if verbose > 0
+		n.report_delete(scanname)
+		$stderr.print "done\n" if verbose > 0
+	when "status"
+		puts "status: " + n.scan_status(scanname)	
+	when "list-scans"
+		list=n.scan_list_hash
+		list.each {|scan| 
+			puts scan['id']+":"+scan['name']+":"+ \
+				scan['current']+"/"+scan['total']
+		}
+	when "list-policy"
+		list=n.policy_list_names
+		list.each {|policy| 
+			puts policy 
+		}
+		
+end
+
+$stderr.print "[v] End reached.\n" if verbose > 1

data/lib/nessus-xmlrpc.rb

@@ -0,0 +1,580 @@
+#
+# = nessus-xmlrpc.rb: communicate with Nessus(4.2+) over XML RPC interface
+#
+# Author:: Vlatko Kosturjak
+#
+# (C) Vlatko Kosturjak, Kost. Distributed under GPL and BSD license (dual).
+# 
+# == What is this library? 
+# 
+# This library is used for communication with Nessus over XML RPC interface. 
+# You can start, stop, pause and resume scan. Watch progress and status of scan, 
+# download report, etc.
+#
+# == Requirements
+# 
+# Required libraries are standard Ruby libraries: uri, net/https and rexml/document. 
+#
+# == Optional
+# 
+# Library is able to use nokogiri if available, but nokogiri is not required.
+# 
+# == Usage:
+# 
+#  require 'nessus-xmlrpc'
+#  n=NessusXMLRPC::NessusXMLRPC.new('https://localhost:8834','user','pass');
+#  if n.logged_in
+# 	id,name = n.policy_get_first
+# 	puts "using policy ID: " + id + " with name: " + name
+# 	uid=n.scan_new(id,"textxmlrpc","127.0.0.1")
+#	puts "status: " + n.scan_status(uid)
+# 	while not n.scan_finished(uid)
+# 		sleep 10
+# 	end
+#	content=n.report_file_download(uid)
+# 	File.open('report.xml', 'w') {|f| f.write(content) }
+#  end
+
+require 'uri'
+require 'net/https'
+require 'rexml/document'
+
+# NessusXMLRPC module
+# 
+# Usage:
+# 
+#  require 'nessus-xmlrpc'
+#  n=NessusXMLRPC::NessusXMLRPC.new('https://localhost:8834','user','pass');
+#  if n.logged_in
+# 	id,name = n.policy_get_first
+# 	uid=n.scan_new(id,"textxmlrpc","127.0.0.1")
+#	puts "status: " + n.scan_status(uid)
+#  end
+#
+# Check NessusXMLRPCrexml for description of methods implemented 
+# (for both NessusXMLRPCnokogiri and NessusXMLRPCrexml).
+
+module NessusXMLRPC 
+
+# Class which uses standard REXML to parse nessus XML RPC replies. 
+# It is adviseable to use NessusXMLRPC class, not this class directly.
+# As NessusXMLRPC class will use nokogiri or rexml, depending on availability.
+class NessusXMLRPCrexml
+	# initialize object: try to connect to Nessus Scanner using URL, user and password
+	#
+	# Usage: 
+	# 
+	#  n=NessusXMLRPC::NessusXMLRPC.new('https://localhost:8834','user','pass');
+	def initialize(url,user,password)
+		if url == ''
+			@nurl="https://localhost:8834/"
+		else
+			if url =~ /\/$/
+				@nurl=url
+			else
+				@nurl=url + "/"
+			end
+		end
+		@token=''
+		login(user,password)
+	end
+
+	# checks if we're logged in correctly
+	#
+	# returns: true if logged in, false if not
+	#
+	# Usage: 
+	# 
+	#  n=NessusXMLRPC::NessusXMLRPC.new('https://localhost:8834','user','pass');
+	#  if n.logged_in
+	#	puts "Logged in"
+	#  else
+	#	puts "Error"
+	#  end
+	def logged_in
+		if @token == ''
+			return false
+		else
+			return true
+		end
+	end	
+
+	# send standard Nessus XML request and check
+	# 
+	# returns: rexml/document root
+	def nessus_request(uri, post_data) 
+		body=nessus_http_request(uri, post_data)
+		# puts response.body
+		docxml = REXML::Document.new(body)
+		begin 
+		status = docxml.root.elements['status'].text
+		rescue
+			puts "[e] error in XML parsing"
+		end
+		if status == "OK"
+			return docxml 
+		else 
+			return ''
+		end
+	end
+
+	# send standard Nessus HTTP request and check
+	#
+	# returns: body of response
+	def nessus_http_request(uri, post_data) 
+		url = URI.parse(@nurl + uri) 
+		request = Net::HTTP::Post.new( url.path )
+		request.set_form_data( post_data )
+		if not defined? @https	
+			@https = Net::HTTP.new( url.host, url.port )
+			@https.use_ssl = true
+			@https.verify_mode = OpenSSL::SSL::VERIFY_NONE
+		end
+		# puts request
+		begin
+			response = @https.request( request )
+		rescue 
+			puts "[e] error connecting to server: "+ @nurl + " with URI: " + uri
+
+			exit
+		end
+		# puts response.body
+		return response.body
+	end
+	
+	# login with user & password and sets object-wide @token, @name and @admin
+	def login(user, password)
+		post = { "login" => user, "password" => password }
+		docxml=nessus_request('login', post)
+		if docxml == '' 
+			@token=''
+		else
+			@token = docxml.root.elements['contents'].elements['token'].text
+			@name = docxml.root.elements['contents'].elements['user'].elements['name'].text
+			@admin = docxml.root.elements['contents'].elements['user'].elements['admin'].text
+			# puts "Got token:" + @token
+		end
+			
+	end
+	
+	# initiate new scan with policy id, descriptive name and list of targets
+	# 
+	# returns: uuid of scan
+	# 
+	# Usage: 
+	# 
+	#  n=NessusXMLRPC::NessusXMLRPC.new('https://localhost:8834','user','pass');
+	#  if n.logged_in
+	# 	id,name = n.policy_get_first
+	# 	puts "using policy ID: " + id + " with name: " + name
+	# 	uid=n.scan_new(id,"textxmlrpc","127.0.0.1")
+	#  end
+	def scan_new(policy_id,scan_name,target)
+		post= { "token" => @token, "policy_id" => policy_id, "scan_name" => scan_name, "target" => target } 
+		docxml=nessus_request('scan/new', post)
+		if docxml == '' 
+			return ''
+		else
+			uuid=docxml.root.elements['contents'].elements['scan'].elements['uuid'].text
+			return uuid
+		end	
+	end
+
+	# get uids of scans
+	#
+	# returns: array of uids of active scans
+	def scan_list_uids
+		post= { "token" => @token } 
+		docxml=nessus_request('scan/list', post)
+		uuids=Array.new
+		docxml.root.elements['contents'].elements['scans'].elements['scanList'].each_element('//scan') {|scan| uuids.push(scan.elements['uuid'].text) }
+		return uuids
+	end
+
+	# get hash of active scan data
+	# 
+	# returns: array of hash of active scans
+	def scan_list_hash
+		post= { "token" => @token } 
+		docxml=nessus_request('scan/list', post)
+		scans=Array.new
+		docxml.root.elements['contents'].elements['scans'].elements['scanList'].each_element('//scan') {|scan| 
+			entry=Hash.new
+			entry['id']=scan.elements['uuid'].text
+			entry['name']=scan.elements['readableName'].text
+			entry['current']=scan.elements['completion_current'].text;
+			entry['total']=scan.elements['completion_total'].text;		
+			scans.push(entry) 
+		}
+		return scans
+	end
+
+	# get policy by textname and return policyID
+	# 
+	# returns: policyID
+	def policy_get_id(textname) 
+		post= { "token" => @token } 
+		docxml=nessus_request('policy/list', post)
+		docxml.root.elements['contents'].elements['policies'].each_element('//policy') {|policy|
+			if policy.elements['policyName'].text == textname
+				return policy.elements['policyID'].text 
+			end
+		}
+		return ''
+	end	
+
+	# get first policy from server and returns: policyID, policyName
+	#
+	# returns: policyID, policyName
+	def policy_get_first
+		post= { "token" => @token } 
+		docxml=nessus_request('policy/list', post)
+		docxml.root.elements['contents'].elements['policies'].each_element('//policy') {|policy|
+				return policy.elements['policyID'].text, policy.elements['policyName'].text
+		}
+	end	
+
+	# get list of policy IDs
+	#
+	# returns: array of all policy uids
+	def policy_list_uids
+		post= { "token" => @token } 
+		docxml=nessus_request('policy/list', post)
+		pids=Array.new
+		docxml.root.elements['contents'].elements['policies'].each_element('//policy') { |policy| 
+			pids.push(policy.elements['policyID'].text) }
+		return pids
+	end
+
+	# stop scan identified by scan_uuid
+	def scan_stop(uuid)
+		post= { "token" => @token, "scan_uuid" => uuid } 
+		docxml=nessus_request('scan/stop', post)
+		return docxml
+	end
+	# stop all active scans 
+	# 
+	# Usage: 
+	# 
+	#  n=NessusXMLRPC::NessusXMLRPC.new('https://localhost:8834','user','pass');
+	#  if n.logged_in
+	#	n.scan_stop_all
+	#  end
+	def scan_stop_all
+		b=scan_list_uids
+		b.each {|uuid|
+			scan_stop(uuid)
+		}
+		return b
+	end
+	# pause scan identified by scan_uuid
+	def scan_pause(uuid)
+		post= { "token" => @token, "scan_uuid" => uuid } 
+		docxml=nessus_request('scan/pause', post)
+		return docxml
+	end
+	# pause all active scans 
+	# 
+	# Usage: 
+	# 
+	#  n=NessusXMLRPC::NessusXMLRPC.new('https://localhost:8834','user','pass');
+	#  if n.logged_in
+	#	n.scan_pause_all
+	#  end
+	def scan_pause_all
+		b=scan_list_uids
+		b.each {|uuid|
+			scan_pause(uuid)
+		}
+		return b
+	end
+	# remove scan identified by uuid
+	def scan_resume(uuid)
+		post= { "token" => @token, "scan_uuid" => uuid } 
+		docxml=nessus_request('scan/resume', post)
+		return docxml
+	end
+	# resume all active scans 
+	# 
+	# Usage: 
+	# 
+	#  n=NessusXMLRPC::NessusXMLRPC.new('https://localhost:8834','user','pass');
+	#  if n.logged_in
+	#	n.scan_resume_all
+	#  end
+	def scan_resume_all
+		b=scan_list_uids
+		b.each {|uuid|
+			scan_resume(uuid)
+		}
+		return b
+	end
+
+	# check status of scan identified by uuid
+	def scan_status(uuid)
+		post= { "token" => @token, "report" => uuid } 
+		docxml=nessus_request('report/list', post)
+		docxml.root.elements['contents'].elements['reports'].each_element('//report') { |report|
+			if report.elements['name'].text == uuid
+				return (report.elements['status'].text)
+			end
+		}
+		return ''
+	end
+
+	# check if scan is finished (completed to be exact) identified by uuid
+	def scan_finished(uuid)
+		status=scan_status(uuid)
+		if status == "completed"
+			return true
+		else
+			return false
+		end
+	end
+	
+	# get report by reportID and return XML file
+	# 
+	# returns: XML file of report (nessus v2 format)
+	def report_file_download(report)
+		post= { "token" => @token, "report" => report } 
+		file=nessus_http_request('file/report/download', post)
+		return file
+	end
+
+	# get report by reportID and return XML file (version 1)
+	# 
+	# returns: XML file of report (nessus v1 format)
+	def report_file1_download(report)
+		post= { "token" => @token, "report" => report, "v1" => "true" } 
+		file=nessus_http_request('file/report/download', post)
+		return file
+	end
+	
+	# delete report by report ID
+	def report_delete(id)
+		post= { "token" => @token, "report" => id } 
+		docxml=nessus_request('report/delete', post)
+		return docxml
+	end
+
+	# get list of names of policies
+	#
+	# returns: array of names
+	def policy_list_names
+		post= { "token" => @token } 
+		docxml=nessus_request('policy/list', post)
+		list = Array.new
+		docxml.root.elements['contents'].elements['policies'].each_element('//policy') {|policy|
+				list.push policy.elements['policyName'].text
+		}
+		return list
+	end
+
+	# get hosts for particular report
+	#
+	# returns: array of hosts
+	def report_hosts(report_id)
+		post= { "token" => @token, "report" => report_id } 
+		docxml=nessus_request('report/hosts', post)
+		list = Array.new
+		docxml.root.elements['contents'].elements['hostList'].each_element('//host') { |host| 
+			list.push host.elements['hostname'].text
+		}
+		return list
+	end
+
+	# get host details for particular host identified by report id
+	#
+	# returns: severity, current, total
+	def report_get_host(report_id,host)
+		post= { "token" => @token, "report" => report_id } 
+		docxml=nessus_request('report/hosts', post)
+		docxml.root.elements['contents'].elements['hostList'].each_element('//host') { |host| 
+			if host.elements['hostname'].text == host
+				retval={}
+				retval["severity"] = host.elements['severity'].text
+				retval["current"] = host.elements['scanProgressCurrent'].text
+				retval["total"] = host.elements['scanProgressTotal'].text
+				return retval
+			end
+		}
+	end
+	#-- ToDo items
+	def plugins_list
+		post= { "token" => @token } 
+		docxml=nessus_request('plugins/list', post)
+		return docxml
+	end
+	def users_list
+		post= { "token" => @token } 
+		docxml=nessus_request('users/list', post)
+		return docxml
+	end
+end # end of NessusXMLRPC::Class
+
+# use nokogiri if available (it's faster!)
+nokogiri=true
+begin
+	require 'nokogiri'
+rescue LoadError
+	nokogiri=false
+end
+
+# if found nokogiri
+if nokogiri
+# Class which uses nokogiri to parse nessus XML RPC replies. 
+# It is adviseable to use NessusXMLRPC class, not this class directly.
+# As NessusXMLRPC class will use nokogiri or rexml, depending on availability.
+# 
+# Documentation for this class documents only differences from NessusXMLRPCrexml.
+# <b> So, check NessusXMLRPCrexml for method documentation </b>
+class NessusXMLRPCnokogiri < NessusXMLRPCrexml
+	# send standard Nessus XML request and check
+	#
+	# return: nokogiri XML file
+	def nessus_request(uri, post_data) 
+		body=nessus_http_request(uri, post_data)
+		docxml = Nokogiri::XML.parse(body)
+		begin 
+		status = docxml.xpath("/reply/status").collect(&:text)[0]
+		rescue
+			puts "[e] error in XML parsing"
+		end
+		if status == "OK"
+			return docxml 
+		else 
+			return ''
+		end
+	end
+
+	def login(user, password)
+		post = { "login" => user, "password" => password }
+		docxml=nessus_request('login', post)
+		if docxml == '' 
+			@token=''
+		else
+			@token = docxml.xpath("/reply/contents/token").collect(&:text)[0]
+			@name = docxml.xpath("/reply/contents/user/name").collect(&:text)[0]
+			@admin = docxml.xpath("/reply/contents/user/admin").collect(&:text)[0]
+		end
+			
+	end
+
+	def scan_new(policy_id,scan_name,target)
+		post= { "token" => @token, "policy_id" => policy_id, "scan_name" => scan_name, "target" => target } 
+		docxml=nessus_request('scan/new', post)
+		if docxml == '' 
+			return ''
+		else
+			uuid=docxml.xpath("/reply/contents/scan/uuid").collect(&:text)[0]
+			return uuid
+		end	
+	end
+
+	def scan_status(uuid)
+		post= { "token" => @token, "report" => uuid } 
+		docxml=nessus_request('report/list', post)
+		return docxml.xpath("/reply/contents/reports/report/name[text()='"+uuid+"']/../status").collect(&:text)[0]
+	end
+
+	def scan_list_uids
+		post= { "token" => @token } 
+		docxml=nessus_request('scan/list', post)
+		return docxml.xpath("/reply/contents/scans/scanList/scan/uuid").collect(&:text)
+	end
+
+	def scan_list_hash
+		post= { "token" => @token } 
+		docxml=nessus_request('scan/list', post)
+		items = docxml.xpath("/reply/contents/scans/scanList/scan")
+		retval = items.collect do |item|
+			tmpitem = {}
+			[
+				[:id, 'uuid'],
+				[:name, 'readableName'],
+				[:current, 'completion_current'],
+				[:total, 'completion_total']
+			].collect do |key, xpath|
+			tmpitem[key] = item.at_xpath(xpath).content
+			end
+			tmpitem
+		end
+		return retval
+	end
+
+	def policy_get_id(textname) 
+		post= { "token" => @token } 
+		docxml=nessus_request('policy/list', post)
+		return docxml.xpath("/reply/contents/policies/policy/policyName[text()='"+textname+"']/..policyID").collect(&:text)[0]
+	end	
+
+	def policy_list_uids
+		post= { "token" => @token } 
+		docxml=nessus_request('policy/list', post)
+		return docxml.xpath("/reply/contents/policies/policy/policyID").collect(&:text)
+	end
+
+	def policy_get_first
+		post= { "token" => @token } 
+		docxml=nessus_request('policy/list', post)
+		id=docxml.xpath("/reply/contents/policies/policy/policyID").collect(&:text)[0]
+		name=docxml.xpath("/reply/contents/policies/policy/policyName").collect(&:text)[0]
+		return id, name
+	end	
+
+	def policy_list_names
+		post= { "token" => @token } 
+		docxml=nessus_request('policy/list', post)
+		return docxml.xpath("/reply/contents/policies/policy/policyName").collect(&:text)
+	end
+
+	def report_hosts(report_id)
+		post= { "token" => @token, "report" => report_id } 
+		docxml=nessus_request('report/hosts', post)
+		return docxml.xpath("/reply/contents/hostList/host/hostname").collect(&:text)
+	end
+
+	def report_get_host(report_id,host)
+		post= { "token" => @token, "report" => report_id } 
+		docxml=nessus_request('report/hosts', post)
+		items = docxml.xpath("/reply/contents/hostList/host/hostname[text()='"+host+"']")
+		retval = items.collect do |item|
+			tmpitem = {}
+			[
+				[:severity, 'severity'],
+				[:current, 'scanProgressCurrent'],
+				[:total, 'scanProgressTotal']
+			].collect do |key, xpath|
+			tmpitem[key] = item.at_xpath(xpath).content
+			end
+			tmpitem
+		end
+		return retval
+	end
+		
+end # end of NessusXMLRPCnokogiri::Class
+	# Main class which controls Nessus using XMLRPC. 
+	# It is adviseable to use this NessusXMLRPC class, and not NessusXMLRPCnokogiri or NessusXMLRPCrexml,
+	# As NessusXMLRPC class will use nokogiri or rexml, depending on availability. 
+	# Of course, choosing nokogiri first because of speed.
+	# 
+	# Example:
+	# 
+	#  n=NessusXMLRPC::NessusXMLRPC.new('https://localhost:8834','user','pass');
+	#  if n.logged_in
+	# 	id,name = n.policy_get_first
+	# 	uid=n.scan_new(id,"textxmlrpc","127.0.0.1")
+	#	puts "status: " + n.scan_status(uid)
+	#  end
+	# 
+	# Check NessusXMLRPCrexml for description of methods implemented 
+	# (for both NessusXMLRPCnokogiri and NessusXMLRPCrexml).
+	class NessusXMLRPC < NessusXMLRPCnokogiri
+	end
+else # nokogiri not found, use REXML
+	class NessusXMLRPC < NessusXMLRPCrexml
+	end
+end # if nokogiri
+
+end # of Module
+

data/test/helper.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'nessus-xmlrpc'
+
+class Test::Unit::TestCase
+end

data/test/test_nessus-xmlrpc.rb

@@ -0,0 +1,6 @@
+require 'helper'
+
+class TestNessusXmlrpc < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+  end
+end

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification 
+name: nessus-xmlrpc
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 4
+  - 0
+  version: 0.4.0
+platform: ruby
+authors: 
+- Vlatko Kosturjak
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-12-29 00:00:00 +00:00
+default_executable: nessus-cli.rb
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 5
+        - 2
+        version: 1.5.2
+  type: :development
+  prerelease: false
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rcov
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id004
+description: "Ruby library for Nessus XMLRPC interface and Nessus command line example of using Ruby library. This library is used for communication with Nessus over XML RPC interface. You can start, stop, pause and resume scan. Watch progress and status of scan, download report, etc. "
+email: vlatko.kosturjak@gmail.com
+executables: 
+- nessus-cli.rb
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+- TODO
+files: 
+- .document
+- Gemfile
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- TODO
+- VERSION
+- bin/nessus-cli.rb
+- lib/nessus-xmlrpc.rb
+- test/helper.rb
+- test/test_nessus-xmlrpc.rb
+has_rdoc: true
+homepage: http://nessus-xmlrpc.rubyforge.org/
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 1047249299
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: nessus-xmlrpc
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Nessus XML RPC library and Nessus Command Line interface to XML RPC
+test_files: 
+- test/helper.rb
+- test/test_nessus-xmlrpc.rb