openvas-omp 0.0.1

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,21 @@
+= openvas-omp
+
+This library is used for communication with OpenVAS manager over OMP
+You can start, stop, pause and resume scan. Watch progress and status of 
+scan, download report, etc.
+
+== Contributing to openvas-omp
+ 
+* 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,57 @@
+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 = "openvas-omp"
+  gem.homepage = "http://github.com/kost/openvas-omp"
+  gem.license = "MIT"
+  gem.summary = %Q{Communicate with OpenVAS manager through OMP}
+  gem.description = %Q{Communicate with OpenVAS manager through OMP. 
+This library is used for communication with OpenVAS manager over OMP.
+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 = "openvas-omp"
+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 = "openvas-omp #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/lib/openvas-omp.rb

@@ -0,0 +1,899 @@
+#
+# = openvas-omp.rb: communicate with OpenVAS manager over OMP
+#
+# Author:: Vlatko Kosturjak
+#
+# (C) Vlatko Kosturjak, Kost. Distributed under MIT license:
+# http://www.opensource.org/licenses/mit-license.php
+# 
+# == What is this library? 
+# 
+# This library is used for communication with OpenVAS manager over OMP
+# You can start, stop, pause and resume scan. Watch progress and status of 
+# scan, download report, etc.
+#
+# == Requirements
+# 
+# Required libraries are standard Ruby libraries: socket,timeout,openssl,
+# rexml/document, rexml/text, base64
+#
+# == Usage:
+# 
+#  require 'openvas-omp'
+
+require 'socket' 
+require 'timeout'
+require 'openssl'
+require 'rexml/document'
+require 'rexml/text'
+require 'base64'
+
+# OpenVASOMP module
+# 
+# Usage:
+# 
+#  require 'openvas-omp'
+
+module OpenVASOMP
+
+	class OMPError < :: RuntimeError
+		attr_accessor :req, :reason
+		def initialize(req, reason = '')
+			self.req = req
+			self.reason = reason
+		end
+		def to_s
+			"OpenVAS OMP: #{self.reason}"
+		end
+	end
+
+	class OMPResponseError < OMPError
+		def initialize
+			self.reason = "Error in OMP request/response"
+		end
+	end
+
+	class OMPAuthError < OMPError
+		def initialize
+			self.reason = "Authentication failed"
+		end
+	end
+
+	class XMLParsingError < OMPError
+		def initialize
+			self.reason = "XML parsing failed"
+		end
+	end
+
+	# Class which uses standard REXML to parse OpenVAS replies.
+	class OpenVASOMP
+		# initialize object: try to connect to OpenVAS using URL, user and password
+		#
+		# Usage:
+		#
+		# ov=OpenVASOMP.new(user=>'user',password=>'pass') 
+		# # default: host=>'localhost', port=>'9390'
+		# 
+		def initialize(p={})
+			if p.has_key?("host")
+				@host=p["host"]
+			else
+				@host="localhost"
+			end
+			if p.has_key?("port")
+				@port=p["port"]
+			else
+				@port=9390
+			end
+			if p.has_key?("user")
+				@user=p["user"]
+			else
+				@user="openvas"
+			end
+			if p.has_key?("password")
+				@password=p["password"]
+			else
+				@password="openvas"
+			end
+			if p.has_key?("bufsize")
+				@bufsize=p["bufsize"]
+			else
+				@bufsize=16384
+			end
+			if p.has_key?("debug")
+				@debug=p["debug"]
+			else
+				@debug=0
+			end
+				
+			if @debug>3 
+				puts "Host: "+@host
+				puts "Port: "+@port.to_s()
+				puts "User: "+@user
+			end
+			if @debug>99
+				puts "Password: "+@password
+			end
+			@areq=''
+			@read_timeout=3
+			if defined? p["noautoconnect"] and not p["noautoconnect"]
+				connect()
+				if defined? p["noautologin"] and not p["noautologin"]
+					login()
+				end
+			end
+		end
+
+		# Sets debug level
+		# 
+		# Usage:
+		#
+		# ov.debug(3)
+		#
+		def debug (level)
+			@debug=level
+		end
+
+		# Low level method - Connect to SSL socket
+		#
+		# Usage:
+		#
+		# ov.connect()
+		# 
+		def connect
+			@plain_socket=TCPSocket.open(@host, @port)
+			ssl_context = OpenSSL::SSL::SSLContext.new()
+			@socket = OpenSSL::SSL::SSLSocket.new(@plain_socket, ssl_context)
+			@socket.sync_close = true
+			@socket.connect
+		end
+
+		# Low level method - Disconnect SSL socket
+		#
+		# Usage:
+		#
+		# ov.disconnect()
+		# 
+		def disconnect
+			if @socket
+				@socket.close
+			end
+		end
+
+		# Low level method: Send request and receive response - socket
+		#
+		# Usage:
+		#
+		# ov.connect();
+		# puts ov.sendrecv("<get_version/>")
+		# ov.disconnect();
+		# 
+		def sendrecv (tosend)
+			if not @socket
+				connect
+			end
+		
+			if @debug>3 then
+				puts "SENDING: "+tosend
+			end
+			@socket.puts(tosend)
+
+			@rbuf=''
+			size=0
+			begin	
+				begin
+				timeout(@read_timeout) {
+				    a = @socket.sysread(@bufsize)
+				    size=a.length
+				    # puts "sysread #{size} bytes"
+				    @rbuf << a
+				}
+				rescue Timeout::Error
+					size=0
+				rescue EOFError
+					raise OMPResponseError
+				end
+			end while size>=@bufsize
+			response=@rbuf
+			
+			if @debug>3 then
+				puts "RECEIVED: "+response
+			end
+			return response
+		end
+
+		# get OMP version (you don't need to be authenticated)
+		#
+		# Usage:
+		#
+		# ov.version_get()
+		# 
+		def version_get 
+			vreq="<get_version/>"	
+			resp=sendrecv(vreq)	
+			resp = "<X>"+resp+"</X>"
+			begin
+				docxml = REXML::Document.new(resp)
+				version=''
+				version=docxml.root.elements['get_version_response'].elements['version'].text
+				return version
+			rescue
+				raise XMLParsingError 
+			end
+		end
+
+		# produce single XML element with attributes specified as hash
+		# low-level function
+		#
+		# Usage:
+		#
+		# ov.xml_attr()
+		# 
+		def xml_attr(name, opts={})
+			xml = REXML::Element.new(name)
+			opts.keys.each do |k|
+				xml.attributes[k] = opts[k]
+			end
+			return xml
+		end
+
+		# produce multiple XML elements with text specified as hash
+		# low-level function
+		#
+		# Usage:
+		#
+		# ov.xml_ele()
+		# 
+		def xml_ele(name, child={})
+			xml = REXML::Element.new(name)
+			child.keys.each do |k|
+				xml.add_element(k)
+				xml.elements[k].text = child[k]
+			end
+			return xml
+		end
+
+		# produce multiple XML elements with text specified as hash
+		# also produce multiple XML elements with attributes
+		# low-level function
+		#
+		# Usage:
+		#
+		# ov.xml_mix()
+		# 
+		def xml_mix(name, child, attr, elem)
+			xml = REXML::Element.new(name)
+			child.keys.each do |k|
+				xml.add_element(k)
+				xml.elements[k].text = child[k]
+			end
+			elem.keys.each do |k|
+				xml.add_element(k)
+				xml.elements[k].attributes[attr] = elem[k]
+			end
+			return xml
+		end
+
+		# login to OpenVAS server. 
+		# if successful returns authentication XML for further usage
+		# if unsuccessful returns empty string
+		#
+		# Usage:
+		#
+		# ov.login()
+		# 
+		def login 
+			areq="<authenticate>"+xml_ele("credentials", {"username"=>@user, "password"=>@password}).to_s()+"</authenticate>"
+			resp=sendrecv(areq+"<HELP/>")
+			# wrap it inside tags, so rexml does not complain
+			resp = "<X>"+resp+"</X>"
+
+			begin
+				docxml = REXML::Document.new(resp)
+				status=docxml.root.elements['authenticate_response'].attributes['status'].to_i()
+			rescue
+				raise XMLParsingError
+			end
+			if status == 200
+				@areq=areq
+			else
+				raise OMPAuthError	
+			end
+		end
+
+		# check if we're successful logged in
+		# if successful returns true
+		# if unsuccessful returns false
+		#
+		# Usage:
+		#
+		# if ov.logged_in() then
+		# 	puts "logged in"
+		# end
+		#
+		def logged_in
+			if @areq == ''
+				return false
+			else
+				return true
+			end
+		end
+
+		# logout from OpenVAS server. 
+		# it actually just sets internal authentication XML to empty str
+		# (as in OMP you have to send username/password each time)
+		# (i.e. there is no session id)
+		#
+		# Usage:
+		#
+		# ov.logout()
+		# 
+		def logout
+			disconnect()
+			@areq = ''
+		end
+
+		# OMP low level method - Send string request wrapped with 
+		# authentication XML and return response as string
+		#
+		# Usage:
+		#
+		# ov.request_xml("<HELP/")
+		# 
+		def omp_request_raw (request) 
+			resp=sendrecv(@areq+request)
+			return resp
+		end
+
+		# OMP low level method - Send string request wrapped with 
+		# authentication XML and return REXML parsed object
+		#
+		# Usage:
+		#
+		# rexmlobject = ov.request_xml("<HELP/")
+		# 
+		def omp_request_xml (request) 
+			resp=sendrecv(@areq+request)
+			resp = "<X>"+resp+"</X>"
+
+			begin
+				docxml = REXML::Document.new(resp)
+				status=docxml.root.elements['authenticate_response'].attributes['status'].to_i
+				if status<200 and status>299
+					raise OMPAuthError
+				end
+				return docxml.root
+			rescue
+				raise XMLParsingError
+			end
+		end
+
+		# OMP - Create target for scanning
+		#
+		# Usage:
+		#
+		# target_id = ov.target_create("name"=>"localhost",
+		# 	"hosts"=>"127.0.0.1","comment"=>"yes")
+		# 
+		def target_create (p={})
+			xmlreq=xml_ele("create_target", p).to_s()
+
+			begin
+				xr=omp_request_xml(xmlreq)
+				id=xr.elements['create_target_response'].attributes['id']
+			rescue 
+				raise OMPResponseError
+			end
+			return id
+		end
+
+		# OMP - Delete target 
+		#
+		# Usage:
+		#
+		# ov.target_delete(target_id)
+		# 
+		def target_delete (id) 
+			xmlreq=xml_attr("delete_task",{"target_id" => id}).to_s()
+			begin
+				xr=omp_request_xml(xmlreq)
+			rescue 
+				raise OMPResponseError
+			end
+			return xr
+		end
+
+		# OMP - Get target for scanning and returns rexml object
+		#
+		# Usage:
+		# rexmlobject = target_get_raw("target_id"=>target_id)		
+		# 
+		def target_get_raw (p={})
+			xmlreq=xml_attr("get_targets", p).to_s()
+
+			begin
+				xr=omp_request_xml(xmlreq)
+				return xr
+			rescue 
+				raise OMPResponseError
+			end
+		end
+
+		# OMP - Get all targets for scanning and returns array of hashes
+		# with following keys: id,name,comment,hosts,max_hosts,in_use
+		#
+		# Usage:
+		# array_of_hashes = target_get_all()
+		# 
+		def target_get_all (p={})
+			begin
+				xr=target_get_raw(p)
+				list=Array.new
+				xr.elements.each('//get_targets_response/target') do |target|
+					td=Hash.new
+					td["id"]=target.attributes["id"]
+					td["name"]=target.elements["name"].text
+					td["comment"]=target.elements["comment"].text
+					td["hosts"]=target.elements["hosts"].text
+					td["max_hosts"]=target.elements["max_hosts"].text
+					td["in_use"]=target.elements["in_use"].text
+					list.push td
+				end
+				return list
+			rescue 
+				raise OMPResponseError
+			end
+		end
+
+		def target_get_byid (id)
+			begin
+			xr=target_get_raw("target_id"=>id)
+			xr.elements.each('//get_targets_response/target') do |target|
+				td=Hash.new
+				td["id"]=target.attributes["id"]
+				td["name"]=target.elements["name"].text
+				td["comment"]=target.elements["comment"].text
+				td["hosts"]=target.elements["hosts"].text
+				td["max_hosts"]=target.elements["max_hosts"].text
+				td["in_use"]=target.elements["in_use"].text
+				return td
+			end
+			return list
+			rescue 
+				raise OMPResponseError
+			end
+		end
+
+		# OMP - get reports and returns raw rexml object as response
+		#
+		# Usage:
+		#
+		# rexmlobject=ov.report_get_raw("format"=>"PDF")
+		# 
+		# rexmlobject=ov.report_get_raw(
+		#	"report_id" => "",
+		#	"format"=>"PDF")
+		# 
+		def report_get_raw (p={})
+			xmlreq=xml_attr("get_reports",p).to_s()
+			begin
+				xr=omp_request_xml(xmlreq)
+			rescue 
+				raise OMPResponseError
+			end
+			return xr
+		end	
+
+		# OMP - get report by id and format, returns report
+		# (already base64 decoded if needed)
+		#
+		# format can be: HTML, NBE, PDF, ...	
+		#
+		# Usage:
+		#
+		# pdf_content=ov.report_get_byid(id,"PDF")
+		# File.open('report.pdf', 'w') {|f| f.write(pdf_content) }
+		# 
+		def report_get_byid (id,format)
+			decode=Array["HTML","NBE","PDF"]
+			xr=report_get_raw("report_id"=>id,"format"=>format)
+			resp=xr.elements['get_reports_response'].elements['report'].text
+			if decode.include?(format) 
+				resp=Base64.decode64(resp)
+			end
+			return resp
+		end
+
+		# OMP - get report all, returns report
+		#
+		# Usage:
+		#
+		# pdf_content=ov.report_get_all()
+		# 
+		def report_get_all ()
+		begin
+			xr=report_get_raw("format"=>"NBE")
+			list=Array.new
+			xr.elements.each('//get_reports_response/report') do |report|
+				td=Hash.new
+				td["id"]=target.attributes["id"]
+				td["name"]=target.elements["name"].text
+				td["comment"]=target.elements["comment"].text
+				td["hosts"]=target.elements["hosts"].text
+				td["max_hosts"]=target.elements["max_hosts"].text
+				td["in_use"]=target.elements["in_use"].text
+				list.push td
+			end
+			return list
+		rescue 
+			raise OMPResponseError
+		end
+		end
+
+		# OMP - get reports and returns raw rexml object as response
+		#
+		# Usage:
+		#
+		# rexmlobject=ov.result_get_raw("notes"=>0)
+		# 
+		def result_get_raw (p={})
+		begin
+			xmlreq=xml_attr("get_results",p).to_s()
+			xr=omp_request_xml(xmlreq)
+		rescue 
+			raise OMPResponseError
+		end
+		return xr
+		end	
+
+		# OMP - get configs and returns rexml object as response
+		#
+		# Usage:
+		#
+		# rexmldocument=ov.config_get_raw()
+		#
+		def config_get_raw (p={})
+			xmlreq=xml_attr("get_configs",p).to_s()
+			begin
+				xr=omp_request_xml(xmlreq)
+				return xr	
+			rescue 
+				raise OMPResponseError
+			end
+			return false
+		end	
+
+		# OMP - get configs and returns hash as response
+		# hash[config_id]=config_name
+		#
+		# Usage:
+		#
+		# array_of_hashes=ov.config_get_all()
+		# 
+		def config_get_all (p={})
+			begin
+				xr=config_get_raw(p)
+				tc=Array.new
+				xr.elements.each('//get_configs_response/config') do |config|
+					c=Hash.new
+					c["id"]=config.attributes["id"]
+					c["name"]=config.elements["name"].text
+					c["comment"]=config.elements["comment"].text
+					tc.push c
+				end
+				return tc
+			rescue 
+				raise OMPResponseError
+			end
+			return false
+		end	
+
+		# OMP - get configs and returns hash as response
+		# hash[config_id]=config_name
+		#
+		# Usage:
+		#
+		# all_configs_hash=ov.config.get()
+		# 
+		# config_id=ov.config_get().index("Full and fast")
+		# 
+		def config_get (p={})
+			begin
+				xr=config_get_raw(p)
+				list=Hash.new
+				xr.elements.each('//get_configs_response/config') do |config|
+					id=config.attributes["id"]
+					name=config.elements["name"].text
+					list[id]=name
+				end
+				return list	
+			rescue 
+				raise OMPResponseError
+			end
+			return false
+		end	
+
+		# OMP - copy config with new name and returns new id
+		#
+		# Usage:
+		#
+		# new_config_id=config_copy(config_id,"new_name");
+		#
+		def config_copy (config_id,name)
+			xmlreq=xml_attr("create_config",
+			{"copy"=>config_id,"name"=>name}).to_s()
+			begin
+				xr=omp_request_xml(xmlreq)
+				id=xr.elements['create_config_response'].attributes['id']
+				return id	
+			rescue 
+				raise OMPResponseError
+			end
+		end
+
+		# OMP - create config with specified RC file and returns new id
+		# name = name of new config
+		# rcfile = base64 encoded OpenVAS rcfile
+		#
+		# Usage:
+		#
+		# config_id=config_create("name",rcfile);
+		#
+		def config_create (name,rcfile)
+			xmlreq=xml_attr("create_config",
+			{"name"=>name,"rcfile"=>rcfile}).to_s()
+			begin
+				xr=omp_request_xml(xmlreq)
+				id=xr.elements['create_config_response'].attributes['id']
+				return id	
+			rescue 
+				raise OMPResponseError
+			end
+		end
+
+		# OMP - creates task and returns id of created task
+		#
+		# Parameters which usually fit in p hash and i hash:
+		# p = name,comment,rcfile
+		# i = config,target,escalator,schedule
+		#
+		# Usage:
+		#
+		# task_id=ov.task_create_raw()
+		# 
+		def task_create_raw (p={}, i={}) 
+			xmlreq=xml_mix("create_task",p,"id",i).to_s()
+			begin
+				xr=omp_request_xml(xmlreq)
+				id=xr.elements['create_task_response'].attributes['id']
+				return id
+			rescue 
+				raise OMPResponseError
+			end
+		end
+
+		# OMP - creates task and returns id of created task	
+		# 
+		# parameters = name,comment,rcfile,config,target,escalator,
+		#		schedule
+		#
+		# Usage:
+		#
+		# config_id=o.config_get().index("Full and fast")
+		# target_id=o.target_create(
+		# {"name"=>"localtarget", "hosts"=>"127.0.0.1", "comment"=>"t"})
+		# task_id=ov.task_create(
+		# {"name"=>"testlocal","comment"=>"test", "target"=>target_id, 
+		# "config"=>config_id}
+		# 
+		def task_create (p={}) 
+			specials=Array["config","target","escalator","schedule"]	
+			ids = Hash.new
+			specials.each do |spec|
+				if p.has_key?(spec)
+					ids[spec]=p[spec]	
+					p.delete(spec)
+				end	
+			end
+			return task_create_raw(p,ids)
+		end
+
+		# OMP - deletes task specified by task_id
+		# 
+		# Usage:
+		#
+		# ov.task_delete(task_id)
+		# 
+		def task_delete (task_id) 
+			xmlreq=xml_attr("delete_task",{"task_id" => task_id}).to_s()
+			begin
+				xr=omp_request_xml(xmlreq)
+			rescue 
+				raise OMPResponseError
+			end
+			return xr
+		end
+
+		# OMP - get task and returns raw rexml object as response
+		#
+		# Usage:
+		#
+		# rexmlobject=ov.task_get_raw("details"=>"0")
+		# 
+		def task_get_raw (p={}) 
+			xmlreq=xml_attr("get_tasks",p).to_s()
+			begin
+				xr=omp_request_xml(xmlreq)
+				return xr
+			rescue 
+				raise OMPResponseError
+			end
+		end
+
+		# OMP - get all tasks and returns array with hashes with 
+		# following content:
+		# id,name,comment,status,progress,first_report,last_report
+		#
+		# Usage:
+		#
+		# array_of_hashes=ov.task_get_all()
+		# 
+		def task_get_all (p={}) 
+			xr=task_get_raw(p)
+			t=Array.new
+			xr.elements.each('//get_tasks_response/task') do |task|
+				td=Hash.new
+				td["id"]=task.attributes["id"]
+				td["name"]=task.elements["name"].text
+				td["comment"]=task.elements["comment"].text
+				td["status"]=task.elements["status"].text
+				td["progress"]=task.elements["progress"].text
+				if defined? task.elements["first_report"].elements["report"].attributes["id"] then
+				td["firstreport"]=task.elements["first_report"].elements["report"].attributes["id"]
+				else
+					td["firstreport"]=nil
+				end
+				if defined? task.elements["last_report"].elements["report"].attributes["id"] then
+				td["lastreport"]=task.elements["last_report"].elements["report"].attributes["id"] 
+				else
+					td["lastreport"]=nil
+				end
+				t.push td	
+			end
+			return t
+		end
+
+		# OMP - get task specified by task_id and returns hash with 
+		# following content:
+		# id,name,comment,status,progress,first_report,last_report
+		#
+		# Usage:
+		#
+		# hash=ov.task_get_byid(task_id)
+		# 
+		def task_get_byid (id) 
+			xr=task_get_raw("task_id"=>id,"details"=>0)
+			xr.elements.each('//get_tasks_response/task') do |task|
+				td=Hash.new
+				td["id"]=task.attributes["id"]
+				td["name"]=task.elements["name"].text
+				td["comment"]=task.elements["comment"].text
+				td["status"]=task.elements["status"].text
+				td["progress"]=task.elements["progress"].text
+				if defined? task.elements["first_report"].elements["report"].attributes["id"] then
+				td["firstreport"]=task.elements["first_report"].elements["report"].attributes["id"]
+				else
+					td["firstreport"]=nil
+				end
+				if defined? task.elements["last_report"].elements["report"].attributes["id"] then
+				td["lastreport"]=task.elements["last_report"].elements["report"].attributes["id"] 
+				else
+					td["lastreport"]=nil
+				end
+				return (td)
+			end
+		end
+
+		# OMP - check if task specified by task_id is finished 
+		# (it checks if task status is "Done" in OMP)
+		# 
+		# Usage:
+		#
+		# if ov.task_finished(task_id)
+		#	puts "Task finished"
+		# end
+		# 
+		def task_finished (id) 
+			xr=task_get_raw("task_id"=>id,"details"=>0)
+			xr.elements.each('//get_tasks_response/task') do |task|
+				if status=task.elements["status"].text == "Done"
+					return true
+				else
+					return false
+				end
+			end
+		end
+
+		# OMP - check progress of task specified by task_id 
+		# (OMP returns -1 if task is finished, not started, etc)
+		# 
+		# Usage:
+		#
+		# print "Progress: "
+		# puts ov.task_progress(task_id)
+		# 
+		def task_progress (id) 
+			xr=task_get_raw("task_id"=>id,"details"=>0)
+			xr.elements.each('//get_tasks_response/task') do |task|
+				return task.elements["progress"].text.to_i()
+			end
+		end
+
+		# OMP - starts task specified by task_id 
+		# 
+		# Usage:
+		#
+		# ov.task_start(task_id)
+		# 
+		def task_start (task_id) 
+			xmlreq=xml_attr("start_task",{"task_id" => task_id}).to_s()
+			begin
+				xr=omp_request_xml(xmlreq)
+			rescue 
+				raise OMPResponseError
+			end
+			return xr
+		end
+
+		# OMP - stops task specified by task_id 
+		# 
+		# Usage:
+		#
+		# ov.task_stop(task_id)
+		# 
+		def task_stop (task_id) 
+			xmlreq=xml_attr("stop_task",{"task_id" => task_id}).to_s()
+			begin
+				xr=omp_request_xml(xmlreq)
+			rescue 
+				raise OMPResponseError
+			end
+			return xr
+		end
+
+		# OMP - pauses task specified by task_id 
+		# 
+		# Usage:
+		#
+		# ov.task_pause(task_id)
+		# 
+		def task_pause (task_id)
+			xmlreq=xml_attr("pause_task",{"task_id" => task_id}).to_s()
+			begin
+				xr=omp_request_xml(xmlreq)
+			rescue 
+				raise OMPResponseError
+			end
+			return xr
+		end
+
+		# OMP - resumes (or starts) task specified by task_id 
+		# 
+		# Usage:
+		#
+		# ov.task_resume_or_start(task_id)
+		# 
+		def task_resume_or_start (task_id)
+			xmlreq=xml_attr("resume_or_start_task",{"task_id" => task_id}).to_s()
+			begin
+				xr=omp_request_xml(xmlreq)
+			rescue 
+				raise OMPResponseError
+			end
+			return xr
+		end
+
+	end # end of Class
+
+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 'openvas-omp'
+
+class Test::Unit::TestCase
+end

data/test/test_openvas-omp.rb

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

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification 
+name: openvas-omp
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Vlatko Kosturjak
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-12-29 00:00:00 +00:00
+default_executable: 
+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: |-
+  Communicate with OpenVAS manager through OMP. 
+  This library is used for communication with OpenVAS manager over OMP.
+  You can start, stop, pause and resume scan. Watch progress and status of
+  scan, download report, etc.
+email: vlatko.kosturjak@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- .document
+- Gemfile
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/openvas-omp.rb
+- test/helper.rb
+- test/test_openvas-omp.rb
+has_rdoc: true
+homepage: http://github.com/kost/openvas-omp
+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: -538062157
+      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: openvas-omp
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Communicate with OpenVAS manager through OMP
+test_files: 
+- test/helper.rb
+- test/test_openvas-omp.rb