openvas-cli 0.1.1 → 0.2.0

data/lib/openvas-cli/vas_task_progress.rb

@@ -0,0 +1,29 @@
+require 'nokogiri'
+require 'xml_addin'
+
+module OpenvasCli
+  class VasTaskProgress
+    include XmlAddin
+    
+    attr_accessor :overall
+    
+    def initialize(params={})
+      @overall = 0
+    end
+    
+    def ip_stats
+      @ip_stats ||= {}
+    end
+    
+    def self.from_xml_node(node)
+      ret = VasTaskProgress.new
+      ret.overall = extract_value_from("progress", node)
+      node.xpath("progress/host_progress").each { |p_node|
+        prg = extract_value_from(".", p_node).to_i
+        hst = extract_value_from("host", p_node)
+        ret.ip_stats[hst] = prg
+      }
+      ret
+    end
+  end
+end

data/lib/openvas-cli/xml_addin.rb

@@ -0,0 +1,34 @@
+module OpenvasCli
+  module XmlAddin
+    def self.included(base)
+      base.send :extend, ClassMethods
+    end
+
+    module ClassMethods
+      # Helper method to extract a value from a Nokogiri::XML::Node object.  If the
+      # xpath provided contains an @, then the method assumes that the value resides
+      # in an attribute, otherwise it pulls the text of the last +text+ node.
+      def extract_value_from(x_str, n)
+        ret = ""
+        if x_str =~ /@/
+          ret = n.at_xpath(x_str).value  if n.at_xpath(x_str)
+        else
+          tn =  n.at_xpath(x_str)
+          if tn
+            if tn.children.count > 0
+              tn.children.each { |tnc|
+                if tnc.text?
+                  ret = tnc.text
+                end
+              }
+            else
+              ret = tn.text
+            end
+          end
+        end
+        
+        ret
+      end
+    end
+  end
+end

data/lib/openvas_cli.rb

@@ -0,0 +1,19 @@
+require File.expand_path(File.join(File.dirname(__FILE__), 'openvas-cli/configuration.rb'))
+
+module OpenvasCli
+  def self.configuration
+    @configuration ||= OpenvasCli::Configuration.new
+  end
+  
+  def self.configure
+    yield configuration if block_given?
+  end
+  
+  def self.logger
+    @logger
+  end
+  
+  def self.logger=(val)
+    @logger = val
+  end
+end

data/openvas-cli.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{openvas-cli}
-  s.version = "0.1.1"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Reed Swenson"]
-  s.date = %q{2011-03-11}
+  s.date = %q{2011-03-25}
   s.description = %q{A full ruby implementation of the OpenVAS OMP (version 2.0) protocol.}
   s.email = %q{fleureed@gmail.com}
   s.extra_rdoc_files = [
@@ -28,24 +28,37 @@ Gem::Specification.new do |s|
     "features/openvas-cli.feature",
     "features/step_definitions/openvas-cli_steps.rb",
     "features/support/env.rb",
+    "lib/openvas-cli/configuration.rb",
+    "lib/openvas-cli/conn_addin.rb",
+    "lib/openvas-cli/immutable_children_validator.rb",
     "lib/openvas-cli/oid_validator.rb",
-    "lib/openvas-cli/openvas-cli.rb",
     "lib/openvas-cli/uuid_validator.rb",
+    "lib/openvas-cli/vas_administrator.rb",
     "lib/openvas-cli/vas_base.rb",
+    "lib/openvas-cli/vas_config.rb",
+    "lib/openvas-cli/vas_connection.rb",
     "lib/openvas-cli/vas_exceptions.rb",
+    "lib/openvas-cli/vas_lsc_credential.rb",
     "lib/openvas-cli/vas_nvt.rb",
     "lib/openvas-cli/vas_nvt_family.rb",
     "lib/openvas-cli/vas_override.rb",
+    "lib/openvas-cli/vas_period.rb",
     "lib/openvas-cli/vas_preference.rb",
     "lib/openvas-cli/vas_report.rb",
     "lib/openvas-cli/vas_result.rb",
     "lib/openvas-cli/vas_schedule.rb",
     "lib/openvas-cli/vas_target.rb",
     "lib/openvas-cli/vas_task.rb",
+    "lib/openvas-cli/vas_task_progress.rb",
+    "lib/openvas-cli/xml_addin.rb",
+    "lib/openvas_cli.rb",
     "openvas-cli.gemspec",
-    "spec/openvas-cli/openvas-cli_spec.rb",
+    "spec/openvas-cli/vas_administrator_spec.rb",
+    "spec/openvas-cli/vas_config_spec.rb",
+    "spec/openvas-cli/vas_lsc_credential_spec.rb",
     "spec/openvas-cli/vas_nvt_family_spec.rb",
     "spec/openvas-cli/vas_nvt_spec.rb",
+    "spec/openvas-cli/vas_period_spec.rb",
     "spec/openvas-cli/vas_preference_spec.rb",
     "spec/openvas-cli/vas_report_spec.rb",
     "spec/openvas-cli/vas_result_spec.rb",
@@ -57,12 +70,15 @@ Gem::Specification.new do |s|
   s.homepage = %q{http://reedswenson.github.com/openvas-cli/}
   s.licenses = ["MIT"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.6.0}
+  s.rubygems_version = %q{1.6.2}
   s.summary = %q{A full ruby implementation of the OpenVAS OMP (version 2.0) protocol.}
   s.test_files = [
-    "spec/openvas-cli/openvas-cli_spec.rb",
+    "spec/openvas-cli/vas_administrator_spec.rb",
+    "spec/openvas-cli/vas_config_spec.rb",
+    "spec/openvas-cli/vas_lsc_credential_spec.rb",
     "spec/openvas-cli/vas_nvt_family_spec.rb",
     "spec/openvas-cli/vas_nvt_spec.rb",
+    "spec/openvas-cli/vas_period_spec.rb",
     "spec/openvas-cli/vas_preference_spec.rb",
     "spec/openvas-cli/vas_report_spec.rb",
     "spec/openvas-cli/vas_result_spec.rb",
@@ -78,7 +94,9 @@ Gem::Specification.new do |s|
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<activesupport>, [">= 3.0.5"])
       s.add_runtime_dependency(%q<activerecord>, [">= 3.0.5"])
+      s.add_runtime_dependency(%q<rails>, [">= 3.0.5"])
       s.add_runtime_dependency(%q<nokogiri>, [">= 1.4.4"])
+      s.add_runtime_dependency(%q<ipaddress>, [">= 0.7.0"])
       s.add_development_dependency(%q<rspec>, ["~> 2.3.0"])
       s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
       s.add_development_dependency(%q<jeweler>, ["~> 1.5.2"])
@@ -88,7 +106,9 @@ Gem::Specification.new do |s|
     else
       s.add_dependency(%q<activesupport>, [">= 3.0.5"])
       s.add_dependency(%q<activerecord>, [">= 3.0.5"])
+      s.add_dependency(%q<rails>, [">= 3.0.5"])
       s.add_dependency(%q<nokogiri>, [">= 1.4.4"])
+      s.add_dependency(%q<ipaddress>, [">= 0.7.0"])
       s.add_dependency(%q<rspec>, ["~> 2.3.0"])
       s.add_dependency(%q<bundler>, ["~> 1.0.0"])
       s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
@@ -99,7 +119,9 @@ Gem::Specification.new do |s|
   else
     s.add_dependency(%q<activesupport>, [">= 3.0.5"])
     s.add_dependency(%q<activerecord>, [">= 3.0.5"])
+    s.add_dependency(%q<rails>, [">= 3.0.5"])
     s.add_dependency(%q<nokogiri>, [">= 1.4.4"])
+    s.add_dependency(%q<ipaddress>, [">= 0.7.0"])
     s.add_dependency(%q<rspec>, ["~> 2.3.0"])
     s.add_dependency(%q<bundler>, ["~> 1.0.0"])
     s.add_dependency(%q<jeweler>, ["~> 1.5.2"])

data/spec/openvas-cli/vas_administrator_spec.rb

@@ -0,0 +1,6 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+module OpenvasCli
+  describe VasAdministrator do
+    pending "Write some tests or destroy me!" 
+  end
+end

data/spec/openvas-cli/vas_config_spec.rb

@@ -0,0 +1,81 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+module OpenvasCli
+  describe VasConfig do
+    after(:each) do
+      cfgs = VasConfig.get_all
+      
+      cfgs.each { |c|
+        c.destroy! if c.name =~ /Test_.*/i
+      }
+    end
+
+    it 'should get all configurations' do
+      cfgs = VasConfig.get_all
+      
+      cfgs.should_not be nil
+      cfgs.length.should be > 0
+      
+      old_name = ""
+      cfgs.each { |c| 
+        c.should be_valid 
+        c.name.should >= old_name
+        old_name = c.name
+      }
+    end
+    
+    it 'should get all configurations with details' do
+      cfgs = VasConfig.get_all(:show_details => true)
+      cfgs.should_not be nil
+      cfgs.length.should be > 0
+      
+      cfgs.each { |c|
+        c.should have_at_least(1).family unless c.name =~ /empty/i
+        c.should have_at_least(1).preference
+      }
+    end
+    
+    it 'be able to copy a configuration' do
+      cfg = VasConfig.get_all[0]
+      
+      new_cfg = VasConfig.copy_config(cfg.id, "Test_#{Time.now.strftime('%Y-%m-%d_%H:%M:%S')}")
+      
+      new_cfg.should_not be nil
+      new_cfg.id.should_not be cfg.id
+      
+      new_cfg.destroy!
+    end
+    
+    it 'should save a preference if it has been assigned a new value' do
+      cfg = VasConfig.get_all[0]
+      
+      new_cfg = VasConfig.copy_config(cfg.id, "Test_#{Time.now.strftime('%Y-%m-%d_%H:%M:%S')}")
+      
+      new_cfg.should_not be nil
+      new_cfg.id.should_not be cfg.id
+      
+      pref = new_cfg.preferences.choice
+      pref.should_not be nil
+
+      case pref.val_type
+      when :text
+        pref.value = "NEW VALUE"
+      when :boolean
+        pref.value = pref.value ? false : true
+      when :choice
+        pref.value = pref.val_choices[rand(pref.val_choices.count - 1) + 1]
+      end
+      
+      pref.should be_changed
+      
+      new_cfg.save!
+      
+      new_cfg = VasConfig.get_all(:id => new_cfg.id, :show_details => true)[0]
+      i = new_cfg.preferences.index { |p| p.name == pref.name && p.nvt_id == pref.nvt_id }
+      i.should_not be nil
+     
+      n_pref = new_cfg.preferences[i]
+      n_pref.value.should == pref.value
+    end
+  end
+end

data/spec/openvas-cli/vas_lsc_credential_spec.rb

@@ -0,0 +1,72 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+module OpenvasCli
+  describe VasLscCredential do
+    after(:each) do
+      all = VasLscCredential.get_all
+      
+      all.each { |c|
+        c.destroy! if c.name =~ /Test_.*/i
+      }
+    end
+
+    def next_test_name
+      "Test_#{Time.now.strftime('%Y-%m-%d_%H:%M:%S')}"
+    end
+    
+    def valid_params
+      {
+        :name => next_test_name, 
+        :login => "FOOBAR", 
+        :comment => "Yet another test credential", 
+        :password => "thisCanTr3@llyBe1"
+      }
+    end
+
+    it 'should pull all available credentials' do
+      all = VasLscCredential.get_all
+      all.should_not be nil
+      all.each { |c| c.should be_valid }
+    end
+    
+    it 'should create a new lsc_credential' do
+      cred = VasLscCredential.new(valid_params)
+      cred.save!
+      
+      cred.id.should_not be nil
+      cred.id.should_not be_empty
+      
+      n_cred = VasLscCredential.get_all(:id => cred.id)[0]
+      n_cred.should_not be nil
+      n_cred.id.should == cred.id
+      n_cred.name.should == cred.name
+      n_cred.login.should == cred.login
+      n_cred.comment.should == cred.comment
+    end
+    
+    it 'should be able to alter a credential' do
+      cred = VasLscCredential.new(valid_params)
+      cred.save!
+      
+      n_cred = VasLscCredential.get_all(:id => cred.id)[0]
+      n_cred.login = "NOT_FOOBAR"
+      n_cred.save!
+      
+      n_cred.id.should == cred.id
+      
+      n_cred = VasLscCredential.get_all(:id => cred.id)[0]
+      n_cred.login.should == "NOT_FOOBAR"
+    end
+    
+    it 'should be able to take an SMB style login name' do
+      cred = VasLscCredential.new(valid_params.merge!({:login=>'FOO\\BAR'}))
+      cred.save!
+      cred.id.should_not be nil
+      cred.id.should_not be_empty
+      
+      n_cred = VasLscCredential.get_all(:id => cred.id)[0]
+      n_cred.should_not be nil
+      n_cred.login.should == 'FOO\\BAR'
+    end
+  end
+end

data/spec/openvas-cli/vas_nvt_family_spec.rb

@@ -1,9 +1,11 @@
 require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
 
-describe VasNVTFamily do
-  it 'should pull all nvt families' do
-    fams = VasNVTFamily.get_all
-    fams.should_not be nil
-    fams.each{ |f| f.should be_valid }
+module OpenvasCli
+  describe VasNVTFamily do
+    it 'should pull all nvt families' do
+      fams = VasNVTFamily.get_all
+      fams.should_not be nil
+      fams.each{ |f| f.should be_valid }
+    end
   end
 end

data/spec/openvas-cli/vas_nvt_spec.rb

@@ -1,32 +1,36 @@
 require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
 
-describe VasNVT do
-  it 'should pull NVT`s', :slow => true do
-    rules = VasNVT.get_all
-    rules.should_not be nil
-    rules.count.should > 0
-    rules.each{ |r| r.should be_valid }
-  end
-  
-  it 'should pull an NVT by OID' do
-    rule = VasNVT.get_all(:oid => '1.3.6.1.4.1.25623.1.0.902230')
-    rule.should_not be nil
-    rule.count.should == 1
+module OpenvasCli
+  describe VasNVT do
+    it 'should pull NVT`s', :slow => true do
+      rules = VasNVT.get_all
+      rules.should_not be nil
+      rules.count.should > 0
+      rules.each{ |r| r.should be_valid }
+    end
     
-    rule[0].should be_valid
-  end
-  
-  it 'should pull an NVT by Family' do
-    fams = VasNVTFamily.get_all
+    it 'should pull an NVT by OID', :slow => true do
+      id = VasNVT.get_all.choice.id
     
-    my_fam = fams[rand(fams.count)]
+      rule = VasNVT.get_all(:id => id)
+      rule.should_not be nil
+      rule.count.should == 1
+      
+      rule[0].should be_valid
+    end
     
-    rules = VasNVT.get_all(:family => my_fam.name)
-    rules.should_not be nil
-    rules.count.should == my_fam.nvt_count
-    rules.each { |r|
-      r.should be_valid
-      r.family.should == my_fam.name
-    }
-  end 
+    it 'should pull an NVT by Family' do
+      fams = VasNVTFamily.get_all
+      
+      my_fam = fams[rand(fams.count)]
+      
+      rules = VasNVT.get_all(:family => my_fam.name)
+      rules.should_not be nil
+      rules.count.should == my_fam.nvt_count
+      rules.each { |r|
+        r.should be_valid
+        r.family.should == my_fam.name
+      }
+    end 
+  end
 end

data/spec/openvas-cli/vas_period_spec.rb

@@ -0,0 +1,7 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+module OpenvasCli
+  describe VasPeriod do
+    pending "Write some tests or destroy me!" 
+  end
+end

data/spec/openvas-cli/vas_preference_spec.rb

@@ -1,26 +1,28 @@
 require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
 
-describe VasPreference do
-  it 'should pull all preferences' do
-    preferences = VasPreference.get_all
-    preferences.should_not be nil
+module OpenvasCli
+  describe VasPreference do
+    it 'should pull all preferences' do
+      preferences = VasPreference.get_all
+      preferences.should_not be nil
+      
+      preferences.each { |p|
+        p.should be_valid
+      }
+    end
     
-    preferences.each { |p|
-      p.should be_valid
-    }
-  end
-  
-  it 'should pull a single preference by name' do
-    all = VasPreference.get_all
-    
-    o_pref = all[rand(all.count)]
-    o_pref.should_not be nil
-    
-    n_pref = VasPreference.get_all(:name=>o_pref.name)[0]
-    n_pref.should_not be nil
-    
-    o_pref.name.should      == n_pref.name
-    o_pref.value.should     == n_pref.value
-    o_pref.config_id.should == n_pref.config_id
+    it 'should pull a single preference by name' do
+      all = VasPreference.get_all
+      
+      o_pref = all[rand(all.count)]
+      o_pref.should_not be nil
+      
+      n_pref = VasPreference.get_all(:name=>o_pref.name)[0]
+      n_pref.should_not be nil
+      
+      o_pref.name.should      == n_pref.name
+      o_pref.value.should     == n_pref.value
+      o_pref.config_id.should == n_pref.config_id
+    end
   end
 end