ruby-nessus 0.1.3 → 0.1.4

data/lib/ruby-nessus/xml.rb

@@ -1,6 +1,8 @@
 require 'ruby-nessus/host'
 require 'ruby-nessus/event'
+
 require 'nokogiri'
+require 'enumerator'
 require 'time'
 
 module Nessus
@@ -8,6 +10,8 @@ module Nessus
   attr_reader :file
 
   class XML
+    
+    include Enumerable
 
     # Creates a new .Nessus (XML) object to be parser
     # @param [String] file The Nessus xml results file to parse.
@@ -31,24 +35,20 @@ module Nessus
     #   The Nessus Report Title
     # @example
     #   scan.report_name #=> "My Super Cool Nessus Report"
-    def report_name
+    def title
       @report_name ||= @xml.xpath("//NessusClientData//Report//ReportName").inner_text.split(' - ').last
     end
-    alias name report_name
-    alias title report_name
 
     # Return the nessus report time.
     # @return [String]
     #   The Nessus Report Time
     # @example
     #   scan.report_time #=> "09/11/08 02:21:22 AM"
-    def report_time
+    def time
       #09/11/08 02:21:22 AM
       datetime = @xml.xpath("//NessusClientData//Report//ReportName").inner_text.split(' - ').first
       @report_time ||= DateTime.strptime(datetime, fmt='%y/%m/%d %I:%M:%S %p')
     end
-    alias time report_time
-    alias date report_time
 
     # Return the scan start time.
     # @return [DateTime]
@@ -83,14 +83,14 @@ module Nessus
     # Return the nessus scan policy name. When creating a nessus policy this is usually the title field.
     # @return [String]
     #   The Nessus Scan Policy Name
-    def policy_name
+    def policy_title
       @policy_name ||= @xml.xpath("//NessusClientData//Report//policyName").inner_text
     end
 
     # Return the nessus scan policy comments. This is the description field when creating a new policy with the Nessus GUI client.
     # @return [String]
     #   The Nessus Scan Policy Comments
-    def policy_comments
+    def policy_notes
       @policy_comments ||= @xml.xpath("//NessusClientData//Report//policyComments").inner_text
     end
 
@@ -149,6 +149,13 @@ module Nessus
       hosts
     end
 
+    # Parses the hosts of the scan.
+    # @return [Array<String>]
+    #   The Hosts of the scan.
+    def all_hosts
+      Enumerator.new(self,:hosts).to_a
+    end
+
     # Return the nessus scan host count.
     # @return [Integer]
     #   The Nessus Scan Host Count
@@ -259,33 +266,33 @@ module Nessus
 
     private
 
-    # Calculates an event hash of totals for severity counts.
-    # @return [hash]
-    #   The Event Totals For Severity
-    def count_severity
-      unless @count
-        @count = {}
-        @open_ports = 0
-        @low = 0
-        @medium = 0
-        @high = 0
-
-        @xml.xpath("//ReportHost").each do |s|
-          @open_ports += s.at('num_ports').inner_text.to_i
-          @low += s.at('num_lo').inner_text.to_i
-          @medium += s.at('num_med').inner_text.to_i
-          @high += s.at('num_hi').inner_text.to_i
+      # Calculates an event hash of totals for severity counts.
+      # @return [hash]
+      #   The Event Totals For Severity
+      def count_severity
+        unless @count
+          @count = {}
+          @open_ports = 0
+          @low = 0
+          @medium = 0
+          @high = 0
+
+          @xml.xpath("//ReportHost").each do |s|
+            @open_ports += s.at('num_ports').inner_text.to_i
+            @low += s.at('num_lo').inner_text.to_i
+            @medium += s.at('num_med').inner_text.to_i
+            @high += s.at('num_hi').inner_text.to_i
+          end
+
+          @count = { :open_ports => @open_ports,
+                     :low => @low,
+                     :medium => @medium,
+                     :high => @high,
+                     :all => (@low + @medium + @high) }
         end
 
-        @count = { :open_ports => @open_ports,
-          :low => @low,
-          :medium => @medium,
-          :high => @high,
-        :all => (@low + @medium + @high) }
+        return @count
       end
 
-      return @count
-    end
-
   end
 end

data/spec/event_spec.rb

@@ -0,0 +1,59 @@
+require 'spec_helper'
+require 'helpers/xml'
+
+describe "Event" do
+  
+  before(:all) do
+    @xml = Nessus::XML.new(Helpers::DOT_NESSUS)
+    @host = @xml.all_hosts.first
+    @bad_event = @host.all_events.first
+    @good_event = @host.all_events.last
+  end
+  
+  it "should parse the event name" do
+    @good_event.name.should == "Backported Security Patch Detection (WWW)"
+  end
+  
+  it "should parse the event port" do
+    @good_event.port.to_s.should == "http (80/tcp)"
+  end
+  
+  it "should parse the event port number" do
+    @good_event.port.number.should == "80"
+  end
+  
+  it "should parse the event port service" do
+    @good_event.port.service.should == "http"
+  end
+  
+  it "should parse the event port protocol" do
+    @good_event.port.protocol.should == "tcp"
+  end
+  
+  it "should return true if the event port protocol is tcp" do
+    @good_event.port.tcp?.should == true
+  end
+  
+  it "should return false if the event port protocol is not udp" do
+    @good_event.port.udp?.should == false
+  end
+  
+  it "should parse the event severity" do
+    @good_event.severity.should == 1
+  end
+  
+  it "should return the event severity in words" do
+    @good_event.severity.in_words.should == "Low Severity"
+  end
+  
+  it "should return the event plugin output" do
+    @good_event.data.should_not be_nil
+  end
+  
+  # Bad Event
+  
+  it "should return false if the event name is nil" do
+    @bad_event.name.should == false
+  end
+  
+end