openvas-cli 0.2.8 → 0.2.9

data/Gemfile

@@ -1,9 +1,9 @@
 source "http://rubygems.org"
 # Add dependencies required to use your gem here.
 # Example:
-gem "activesupport", ">= 3.0.5"
-gem 'activerecord', '>= 3.0.5'
-gem 'rails', '>=3.0.5'
+gem "activesupport", "= 3.0.5"
+gem 'activerecord', '= 3.0.5'
+gem 'rails', '=3.0.5'
 gem 'nokogiri', '>= 1.4.4'
 gem 'ipaddress', '>=0.7.0'
 

data/Gemfile.lock

@@ -88,13 +88,13 @@ PLATFORMS
 
 DEPENDENCIES
   ZenTest
-  activerecord (>= 3.0.5)
-  activesupport (>= 3.0.5)
+  activerecord (= 3.0.5)
+  activesupport (= 3.0.5)
   bundler (~> 1.0.0)
   ipaddress (>= 0.7.0)
   jeweler (~> 1.5.2)
   log4r
   nokogiri (>= 1.4.4)
-  rails (>= 3.0.5)
+  rails (= 3.0.5)
   rcov
   rspec (~> 2.3.0)

data/VERSION

@@ -1 +1 @@
-0.2.8
+0.2.9

data/lib/openvas-cli/vas_base.rb

@@ -21,7 +21,14 @@ module OpenvasCli
     
     def initialize(attributes={})
       attributes.each { |key, value|
-        instance_variable_set("@#{key}", value)
+        send("#{key}=".to_sym, value) if public_methods.include?("#{key}=")
+      }
+      reset_changes
+    end
+    
+    def update_attributes(attrs={})
+      attrs.each { |key, value|
+        send("#{key}=".to_sym, value) if public_methods.include?("#{key}=")
       }
     end
     

data/lib/openvas-cli/vas_config.rb

@@ -95,33 +95,31 @@ module OpenvasCli
       end
     end
 
-    def save!
+    def create_or_update
       @previously_changed = changes
-      preferences.each{ |p| p.save! if p.changed? }
-      @changed_attributes.clear
-    end
-    
-    def destroy
       begin
-        destroy!
+        preferences.each{ |p| p.save! if p.changed? }
+        @changed_attributes.clear
         
-        true
+        self
       rescue Exception => e
-  #      logger = OpenvasCli.logger
-  #      logger.error("Could Not Destroy Configuration: (#{e.class})#{e.message}") if logger
-      
-        false
+        errors[:command] << e.message
+        nil
       end
     end
     
-    def destroy!
-      tasks.each { |t| t.destroy! }
-      
+    def delete_record
       req = Nokogiri::XML::Builder.new { |xml|
         xml.delete_config(:config_id => @id)
       }
       
-      VasConfig.connection.send_receive(req.doc)
+      begin
+        VasConfig.connection.send_receive(req.doc)
+        self
+      rescue Exception => e
+        errors[:command] << e.message
+        nil
+      end
     end
   end
 end

data/lib/openvas-cli/vas_preference.rb

@@ -18,6 +18,8 @@ module OpenvasCli
     # NVT id
     attr_accessor :nvt_id
 
+    attr_accessor :nvt_name
+
     validates :name, :presence => true, :length=>{:minimum => 1}
     
     define_attribute_methods [:name, :value]
@@ -98,14 +100,16 @@ module OpenvasCli
     
     # Pulls Vas preferences.
     # === Options:
+    # [:config_id] => [configuration_id]] pulls preferences associated with the provided configuration id
     # [:nvt_oid => [oid]] pulls preferences associated associated with the provided VasNVT.oid
     # [:name => [name]] pulls the preference with the specified name
-    # [:sort_by => [field_name]] filters the results by the provided field name.  Valid symbols are, :name, :value, :config_id.
+    # [:sort_by => [field_name]] filters the results by the provided field name.  Valid symbols are, :name, :nvt_name, :nvt_id.
     def self.get_all(options={})
       manual_filter = false
       params = {}
-      params[:nvt_oid]    = options[:nvt_oid] if options[:nvt_oid]
-      manual_filter       = true              if options[:name]
+      params[:config_id]  = options[:config_id] if options[:config_id]
+      params[:nvt_oid]    = options[:nvt_oid]   if options[:nvt_oid]
+      manual_filter       = true                if options[:name]
       
       req = Nokogiri::XML::Builder.new { |xml|
         if params.empty?
@@ -114,31 +118,35 @@ module OpenvasCli
           xml.get_preferences(params)
         end
       }
-      
-      prefs = connection.send_receive(req.doc)
       ret = []
-      prefs.xpath("//preference").each { |p|
-        pref       = from_xml_node(p)
-        if manual_filter
-          ret << pref if options[:name] && options[:name] == pref.name
-        else
-          ret << pref
-        end
-      }
-      
-      ret.sort!{ |a,b| a.name <=> b.name }           if params[:sort_by] == :name
-      ret.sort!{ |a,b| a.value <=> b.value }         if params[:sort_by] == :value
-      ret.sort!{ |a,b| a.config_id <=> b.config_id } if params[:sort_by] == :config_id
-      
+      begin
+        prefs = connection.send_receive(req.doc)
+        
+        prefs.xpath("//preference").each { |p|
+          pref       = from_xml_node(p, options[:config_id])
+          if manual_filter
+            ret << pref if options[:name] && options[:name] == pref.name
+          else
+            ret << pref
+          end
+        }
+        
+        ret.sort!{ |a,b| a.name      <=> b.name }      if options[:sort_by] == :name
+        ret.sort!{ |a,b| a.nvt_id    <=> b.nvt_id }    if options[:sort_by] == :nvt_id
+        ret.sort!{ |a,b| a.nvt_name  <=> b.nvt_name }  if options[:sort_by] == :nvt_name
+      rescue VasExceptions::CommandException => e
+      end
       ret    
     end
     
-    def self.from_xml_node(node)
-      pref        = VasPreference.new
-      pref.name   = extract_value_from("name", node)
-      pref.value  = extract_value_from("value", node)
-      pref.nvt_id = extract_value_from("nvt/@oid", node)
+    def self.from_xml_node(node, config_id=nil)
+      pref               = VasPreference.new
+      pref.name          = extract_value_from("name", node)
+      pref.value         = extract_value_from("value", node)
+      pref.nvt_id        = extract_value_from("nvt/@oid", node)
+      pref.nvt_name      = extract_value_from("nvt/name", node)
       pref.val_type_desc = extract_value_from("type", node)
+      pref.config_id     = config_id
       case pref.val_type_desc
         when "checkbox"
           pref.val_type = :boolean

data/lib/openvas-cli/vas_report.rb

@@ -62,7 +62,7 @@ module OpenvasCli
         rep.task_id    = extract_value_from("task/@id", r)
         rep.task_name  = extract_value_from("task/name", r)
         rep.status     = extract_value_from("scan_run_status", r)
-        rep.started_at = extract_value_from("scan_start", r)
+        rep.started_at = Time.parse(extract_value_from("scan_start", r))
         
         rep.result_count[:total]             = extract_value_from("result_count/full", r).to_i
         rep.result_count[:filtered]          = extract_value_from("result_count/filtered", r).to_i

data/lib/openvas-cli/vas_schedule.rb

@@ -120,7 +120,7 @@ module OpenvasCli
       when :next_time
         manual_sort = true
       when :first_time
-        params[:first_time] = 'first_time'
+        params[:sort_field] = 'first_time'
       else
         params[:sort_field] = 'name'
       end

data/lib/openvas-cli/vas_target.rb

@@ -67,6 +67,22 @@ module OpenvasCli
       @credential_keys ||= { :smb => nil, :ssh => nil }
     end
     
+    def smb_credential_id
+      credentials[:smb].id if credentials[:smb]
+    end
+    
+    def smb_credential_id=(val)
+      credentials[:smb] = VasLscCredential.get_by_id(val)
+    end
+    
+    def ssh_credential_id
+      credentials[:ssh].id if credentials[:ssh]
+    end
+    
+    def ssh_credential_id=(val)
+      credentials[:ssh] = VasLscCredential.get_by_id(val)
+    end
+        
     def tasks
       @tasks ||= get_tasks
     end
@@ -86,6 +102,14 @@ module OpenvasCli
       @org_hosts = val.collect { |h| h } if val
     end  
     
+    def hosts_string
+      hosts.join(", ")
+    end
+    
+    def hosts_string=(val)
+      self.hosts = val.split(/, ?/)
+    end
+    
     def create_or_update
       if @id
         return unless destroy
@@ -94,7 +118,7 @@ module OpenvasCli
         xml.create_target {
           xml.name       { xml.text(@name) }
           xml.comment    { xml.text(@comment) } if @comment
-          xml.hosts      { xml.text(@hosts.join(', ')) }
+          xml.hosts      { xml.text(hosts_string) }
           xml.ssh_lsc_credential(:id => credentials[:ssh].id) if credentials[:ssh]
           xml.smb_lsc_credential(:id => credentials[:smb].id) if credentials[:smb]
           xml.port_range { xml.text(@port_range) } if @port_range
@@ -107,7 +131,7 @@ module OpenvasCli
         reset_changes
         
         true
-      rescue VaxExceptions::CommandException => e
+      rescue VasExceptions::CommandException => e
         errors[:command_failure] << e.message
         
         nil
@@ -127,7 +151,7 @@ module OpenvasCli
         @id = nil
         
         true
-      rescue VaxExceptions::CommandException => e
+      rescue VasExceptions::CommandException => e
         errors[:command_failure] << e.message
         
         nil

data/lib/openvas-cli/vas_task.rb

@@ -72,6 +72,10 @@ module OpenvasCli
       target_id = val.id if val
     end
     
+    def reports
+      @reports ||= []
+    end
+    
     def create_or_update
           
       if schedule && schedule.changed?
@@ -107,7 +111,7 @@ module OpenvasCli
         reset_changes
         
         true
-      rescue VaxExceptions::CommandException => e
+      rescue VasExceptions::CommandException => e
         errors[:command_failure] << e.message
         
         nil
@@ -125,7 +129,7 @@ module OpenvasCli
         VasTask.connection.send_receive(req.doc)
         
         true
-      rescue VaxExceptions::CommandException => e
+      rescue VasExceptions::CommandException => e
         errors[:command_failure] << e.message
         
         nil
@@ -208,6 +212,12 @@ module OpenvasCli
       t.last_report_id = extract_value_from("last_report/report/@id", node)
       t.config_id      = extract_value_from("config/@id", node)
       t.target_id      = extract_value_from("target/@id", node)
+      node.xpath("reports/report").each { |xr|
+        t.reports << VasReport.new({
+          :id => extract_value_from("@id", xr),
+          :started_at => extract_value_from("timestamp", xr)
+        })
+      }  
       
       t.reset_changes
       

data/openvas-cli.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{openvas-cli}
-  s.version = "0.2.8"
+  s.version = "0.2.9"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Reed Swenson"]
-  s.date = %q{2011-04-07}
+  s.date = %q{2011-04-13}
   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 = [
@@ -90,9 +90,9 @@ Gem::Specification.new do |s|
     s.specification_version = 3
 
     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<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"])
@@ -102,9 +102,9 @@ Gem::Specification.new do |s|
       s.add_development_dependency(%q<ZenTest>, [">= 0"])
       s.add_development_dependency(%q<log4r>, [">= 0"])
     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<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"])
@@ -115,9 +115,9 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<log4r>, [">= 0"])
     end
   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<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"])

data/spec/openvas-cli/vas_lsc_credential_spec.rb

@@ -62,7 +62,7 @@ module OpenvasCli
       cred.save!
       
       n_cred = VasLscCredential.get_by_id(cred.id)
-      n_cred.login = "NOT_FOOBAR"
+      n_cred.update_attributes(:login => "NOT_FOOBAR")
       n_cred.save!
       
       n_cred.id.should == cred.id

data/spec/openvas-cli/vas_preference_spec.rb

@@ -24,5 +24,60 @@ module OpenvasCli
       o_pref.value.should     == n_pref.value
       o_pref.config_id.should == n_pref.config_id
     end
+    
+    it 'should pull all preferences for a given configuration' do
+      config = VasConfig.get_all.choice
+      
+      all = VasPreference.get_all(:config_id => config.id)
+      all.should_not be_empty
+      all.each { |p| p.config_id.should == config.id }
+    end
+    
+    it 'should have an nvt_name if nvt_id exists' do
+      config = VasConfig.get_all.choice
+      
+      all = VasPreference.get_all(:config_id => config.id)
+      all.should_not be_empty
+      
+      all.each { |p| 
+        if p.nvt_id && !p.nvt_id.empty?
+          p.nvt_name.should_not be nil 
+          p.nvt_name.should_not be_empty
+        end
+      }
+    end
+    
+    it 'should sort by name' do
+      config = VasConfig.get_all.choice
+      
+      all = VasPreference.get_all(:config_id => config.id, :sort_by => :name)
+      all.each { |p|
+        old_name = p.name unless old_name
+        p.name.should >= old_name
+        old_name = p.name
+      }
+    end
+    
+    it 'should sort by nvt_id' do
+      config = VasConfig.get_all.choice
+      
+      all = VasPreference.get_all(:config_id => config.id, :sort_by => :nvt_id)
+      all.each { |p|
+        old_id = p.nvt_id unless old_id
+        p.nvt_id.should >= old_id
+        old_id = p.nvt_id
+      }
+    end
+    
+    it 'should sort by nvt_name' do
+      config = VasConfig.get_all.choice
+      
+      all = VasPreference.get_all(:config_id => config.id, :sort_by => :nvt_name)
+      all.each { |p|
+        old_name = p.nvt_name unless old_name
+        p.nvt_name.should >= old_name
+        old_name = p.nvt_name
+      }
+    end
   end
 end

data/spec/openvas-cli/vas_report_spec.rb

@@ -92,18 +92,18 @@ module OpenvasCli
     it 'should sort by task_name (default :descending)' do
       last_name = nil
       VasReport.get_all(:sort => :task_name).each { |r|
-        last_name = r.started_at unless last_name
-        r.started_at.should <= last_name
-        last_date = r.started_at
+        last_name = r.task_name unless last_name
+        r.task_name.should <= last_name
+        last_date = r.task_name
       }
     end
     
     it 'should sort by :task_name, :ascending' do
       last_name = nil
       VasReport.get_all(:sort => :task_name, :sort_order => :ascending).each { |r|
-        last_name = r.started_at unless last_name
-        r.started_at.should >= last_name
-        last_date = r.started_at
+        last_name = r.task_name unless last_name
+        r.task_name.should >= last_name
+        last_date = r.task_name
       }
     end
   end

data/spec/openvas-cli/vas_result_spec.rb

@@ -2,6 +2,10 @@ require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
 
 module OpenvasCli
   describe VasResult do
+    def get_random_result
+      VasResult.get_all.choice
+    end
+  
     it 'should pull all results' do
       all_results = VasResult.get_all 
       
@@ -114,31 +118,31 @@ module OpenvasCli
     end
     
     it 'should not raise an error on save!' do
-      result = VasResult.get_all(:task_id => VasTask.get_all.choice.id).choice
+      result = get_random_result
       lambda {
         result.save!
       }.should_not raise_error
     end
     
     it 'should return true on save' do
-      result = VasResult.get_all(:task_id => VasTask.get_all.choice.id).choice
+      result = get_random_result
       result.save.should be true
     end
     
     it 'should not raise an error on destroy!' do
-      result = VasResult.get_all(:task_id => VasTask.get_all.choice.id).choice
+      result = get_random_result
       lambda {
         result.destroy!
       }.should_not raise_error
     end
     
     it 'should return true on save' do
-      result = VasResult.get_all(:task_id => VasTask.get_all.choice.id).choice
+      result = get_random_result
       result.destroy.should be true
     end
     
     it 'should return a result by ID' do
-      result = VasResult.get_all(:task_id => VasTask.get_all.choice.id).choice
+      result = get_random_result
       
       nr = VasResult.get_by_id(result.id)
       nr.should_not be nil

data/spec/openvas-cli/vas_target_spec.rb

@@ -146,5 +146,35 @@ module OpenvasCli
                                                  
       t.should be_changed
     end
+    
+    it 'should pull hosts_string' do
+      t = VasTarget.new(valid_params)
+      t.hosts << ['10.10.10.0/24', '192.168.1.0/24']
+      
+      t.hosts_string.should == (VasTarget.get_local_subnets + ['10.10.10.0/24', '192.168.1.0/24']).join(", ")
+    end
+    
+    it 'should parse hosts_string' do
+      my_hosts = ['10.10.10.0/24', '192.168.1.0/24']
+      
+      t = VasTarget.new(valid_params)
+      t.hosts_string = my_hosts.join(", ")
+      
+      t.hosts.each { |h|
+        my_hosts.include?(h).should be true
+      }
+    end
+    
+    it 'update_attributes should update hosts when hosts_string is passed' do
+      t = VasTarget.new(valid_params)
+      org_hosts_string = t.hosts_string
+      new_hosts = ['10.10.10.0/24', '192.168.1.0/24']
+      t.update_attributes({:hosts_string => new_hosts.join(", ")})
+      
+      t.hosts_string.should_not == org_hosts_string
+      t.hosts.each { |h|
+        new_hosts.include?(h).should be true
+      }
+    end
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: openvas-cli
 version: !ruby/object:Gem::Version 
-  hash: 7
+  hash: 5
   prerelease: 
   segments: 
   - 0
   - 2
-  - 8
-  version: 0.2.8
+  - 9
+  version: 0.2.9
 platform: ruby
 authors: 
 - Reed Swenson
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-07 00:00:00 -05:00
+date: 2011-04-13 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -23,7 +23,7 @@ dependencies:
   version_requirements: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - "="
       - !ruby/object:Gem::Version 
         hash: 13
         segments: 
@@ -39,7 +39,7 @@ dependencies:
   version_requirements: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - "="
       - !ruby/object:Gem::Version 
         hash: 13
         segments: 
@@ -55,7 +55,7 @@ dependencies:
   version_requirements: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - "="
       - !ruby/object:Gem::Version 
         hash: 13
         segments: