openvas-omp 0.0.2 → 0.0.4

data/README.rdoc

@@ -4,6 +4,29 @@ 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.
 
+== Usage example
+
+require 'openvas-omp'
+
+ov=OpenVASOMP::OpenVASOMP.new("user"=>'openvas',"password"=>'openvas')
+config=ov.config_get().index("Full and fast")
+target=ov.target_create({"name"=>"t", "hosts"=>"127.0.0.1", "comment"=>"t"})
+taskid=ov.task_create({"name"=>"t","comment"=>"t", "target"=>target, "config"=>config})
+ov.task_start(taskid)
+while not ov.task_finished(taskid) do
+        stat=ov.task_get_byid(taskid)
+        puts "Status: #{stat['status']}, Progress: #{stat['progress']}"
+        sleep 10
+end
+stat=ov.task_get_byid(taskid)
+content=ov.report_get_byid(stat["lastreport"],'HTML')
+File.open('report.html', 'w') {|f| f.write(content) }
+
+== Note
+
+Note that if you're using gem and Ruby 1.8, you should require 'rubygems' as 
+well.
+
 == 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

data/TODO

@@ -0,0 +1,2 @@
+* add not-so frequently used OMP functions
+

data/VERSION

@@ -1 +1 @@
-0.0.2
+0.0.4

data/examples/basic-scan.rb

@@ -0,0 +1,21 @@
+#!/usr/bin/env ruby
+# Basic example of openvas-omp usage
+
+# in case you're using Ruby 1.8 and using gem, you should uncomment line below
+# require 'rubygems'
+require 'openvas-omp'
+
+ov=OpenVASOMP::OpenVASOMP.new("user"=>'openvas',"password"=>'openvas')
+config=ov.config_get().index("Full and fast")
+target=ov.target_create({"name"=>"t", "hosts"=>"127.0.0.1", "comment"=>"t"})
+taskid=ov.task_create({"name"=>"t","comment"=>"t", "target"=>target, "config"=>config})
+ov.task_start(taskid)
+while not ov.task_finished(taskid) do
+        stat=ov.task_get_byid(taskid)
+        puts "Status: #{stat['status']}, Progress: #{stat['progress']} %"
+        sleep 10
+end
+stat=ov.task_get_byid(taskid)
+content=ov.report_get_byid(stat["lastreport"],'HTML')
+File.open('report.html', 'w') {|f| f.write(content) }
+

data/lib/openvas-omp.rb

@@ -20,6 +20,20 @@
 # == Usage:
 # 
 #  require 'openvas-omp'
+#
+#  ov=OpenVASOMP::OpenVASOMP.new("user"=>'openvas',"password"=>'openvas')
+#  config=ov.config_get().index("Full and fast")
+#  target=ov.target_create({"name"=>"t", "hosts"=>"127.0.0.1", "comment"=>"t"})
+#  taskid=ov.task_create({"name"=>"t","comment"=>"t", "target"=>target, "config"=>config})
+#  ov.task_start(taskid)
+#  while not ov.task_finished(taskid) do
+#         stat=ov.task_get_byid(taskid)
+#         puts "Status: #{stat['status']}, Progress: #{stat['progress']} %"
+#         sleep 10
+#  end
+#  stat=ov.task_get_byid(taskid)
+#  content=ov.report_get_byid(stat["lastreport"],'HTML')
+#  File.open('report.html', 'w') {|f| f.write(content) }
 
 require 'socket' 
 require 'timeout'
@@ -33,6 +47,8 @@ require 'base64'
 # Usage:
 # 
 #  require 'openvas-omp'
+# 
+#  ov=OpenVASOMP::OpenVASOMP.new("user"=>'openvas',"password"=>'openvas')
 
 module OpenVASOMP
 
@@ -65,14 +81,14 @@ module OpenVASOMP
 		end
 	end
 
-	# Class which uses standard REXML to parse OpenVAS replies.
+	# Core class for OMP communication protocol 
 	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'
+		#  ov=OpenVASOMP.new(user=>'user',password=>'pass') 
+		#  # default: host=>'localhost', port=>'9390'
 		# 
 		def initialize(p={})
 			if p.has_key?("host")

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 2
-  version: 0.0.2
+  - 4
+  version: 0.0.4
 platform: ruby
 authors: 
 - Vlatko Kosturjak
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-30 00:00:00 +00:00
+date: 2011-01-10 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -86,13 +86,16 @@ extensions: []
 extra_rdoc_files: 
 - LICENSE.txt
 - README.rdoc
+- TODO
 files: 
 - .document
 - Gemfile
 - LICENSE.txt
 - README.rdoc
 - Rakefile
+- TODO
 - VERSION
+- examples/basic-scan.rb
 - lib/openvas-omp.rb
 - test/helper.rb
 - test/test_openvas-omp.rb
@@ -110,7 +113,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: -890019011
+      hash: -646625681
       segments: 
       - 0
       version: "0"
@@ -130,5 +133,6 @@ signing_key:
 specification_version: 3
 summary: Communicate with OpenVAS manager through OMP
 test_files: 
+- examples/basic-scan.rb
 - test/helper.rb
 - test/test_openvas-omp.rb