nexpose 0.1.9 → 0.1.10

data/lib/nexpose/connection.rb

@@ -19,22 +19,11 @@ module Nexpose
   #
   #   # //Logout
   #   logout_success = nsc.logout
-  #   if (! logout_success)
-  #       puts "Logout Failure" + "<p>" + nsc.error_msg.to_s
-  #   end
   #
   class Connection
     include XMLUtils
     include NexposeAPI
 
-    # true if an error condition exists; false otherwise
-    attr_reader :error
-    # Error message string
-    attr_reader :error_msg
-    # The last XML request sent by this object
-    attr_reader :request_xml
-    # The last XML response received by this object
-    attr_reader :response_xml
     # Session ID of this connection
     attr_reader :session_id
     # The hostname or IP Address of the NSC
@@ -48,6 +37,11 @@ module Nexpose
     # The URL for communication
     attr_reader :url
 
+    # The last XML request sent by this object, useful for debugging.
+    attr_reader :request_xml
+    # The last XML response received by this object, useful for debugging.
+    attr_reader :response_xml
+
     # Constructor for Connection
     def initialize(ip, user, pass, port = 3780, silo_id = nil)
       @host = ip
@@ -56,7 +50,6 @@ module Nexpose
       @password = pass
       @silo_id = silo_id
       @session_id = nil
-      @error = false
       @url = "https://#{@host}:#{@port}/api/API_VERSION/xml"
     end
 
@@ -88,8 +81,11 @@ module Nexpose
 
     # Execute an API request
     def execute(xml, version = '1.1')
+      @request_xml = xml.to_s
       @api_version = version
-      APIRequest.execute(@url, xml.to_s, @api_version)
+      response = APIRequest.execute(@url, @request_xml, @api_version)
+      @response_xml = response.raw_response_data
+      response
     end
 
     # Download a specific URL, typically a report.

data/lib/nexpose/creds.rb

@@ -30,6 +30,12 @@ module Nexpose
     # When using htmlforms, this represents the tho form to pass the
     # authentication request to.
     attr_reader :html_forms
+	# The type of privilege escalation to use (sudo/su)
+	attr_reader :priv_type
+	# The userid to use when escalating privileges (optional)
+	attr_reader :priv_username
+	# The password to use when escalating privileges (optional)
+	attr_reader :priv_password
 
     def initialize(isblob = false)
       @isblob = isblob
@@ -47,7 +53,16 @@ module Nexpose
       @realm = realm
     end
 
-    # TODO: add description
+	# Sets privilege escalation credentials.  Type should be either
+	# sudo/su.
+    def set_privilege_credentials(type, username, password)
+	  @priv_type = type
+	  @priv_username = username
+	  @priv_password = password
+    end
+
+    # The name of the service.  Possible values are outlined in the
+    # Nexpose API docs.
     def set_service(service)
       @service = service
     end
@@ -56,7 +71,9 @@ module Nexpose
       @host = host
     end
 
-    # TODO: add description
+    # Credentials fetched from the API are encrypted into a
+    # securityblob.  If you want to use those credentials on a
+    # different site, copy the blob into the credential.
     def set_blob(securityblob)
       @isblob = true
       @securityblob = securityblob
@@ -85,6 +102,10 @@ module Nexpose
       attributes['host'] = @host
       attributes['port'] = @port
 
+      attributes['privilegeelevationtype'] = @priv_type if @priv_type
+      attributes['privilegeelevationusername'] = @priv_username if @priv_username
+      attributes['privilegeelevationpassword'] = @priv_password if @priv_password
+
       data = isblob ? securityblob : ''
       xml = make_xml('adminCredentials', attributes, data)
       xml.add_element(@headers.to_xml_elem) if @headers

data/lib/nexpose/scan.rb

@@ -55,7 +55,7 @@ module Nexpose
     #   each active scan on the engines.
     #
     def scan_activity
-      r = execute(make_xml('ScanActivityRequest', {}))
+      r = execute(make_xml('ScanActivityRequest'))
       res = []
       if r.success
         r.res.elements.each('//ScanSummary') do |scan|

data/lib/nexpose/site.rb

@@ -172,6 +172,9 @@ module Nexpose
     # @see IPRange
     attr_accessor :assets
 
+    # [Array] Collection of excluded assets. May be IPv4, IPv6, or DNS names.
+    attr_accessor :exclude
+
     # Scan template to use when starting a scan job. Default: full-audit
     attr_accessor :scan_template
 
@@ -221,6 +224,7 @@ module Nexpose
       @schedules = []
       @credentials = []
       @alerts = []
+      @exclude = []
     end
 
     # Returns true when the site is dynamic.
@@ -314,9 +318,8 @@ module Nexpose
 
       response = connection.execute(xml)
       if response.success
-        response.res.elements.each('/SiteScanResponse/Scan/') do |scan|
-          return [scan.attributes['scan-id'].to_i, scan.attributes['engine-id'].to_i]
-        end
+        scan = REXML::XPath.first(response.res, '/SiteScanResponse/Scan/')
+        [scan.attributes['scan-id'].to_i, scan.attributes['engine-id'].to_i]
       end
     end
 
@@ -329,6 +332,10 @@ module Nexpose
       xml << assets.reduce('') { |acc, host| acc << host.to_xml }
       xml << '</Hosts>'
 
+      xml << '<ExcludedHosts>'
+      xml << exclude.reduce('') { |acc, host| acc << host.to_xml }
+      xml << '</ExcludedHosts>'
+
       unless credentials.empty?
         xml << '<Credentials>'
         credentials.each do |c|
@@ -376,6 +383,20 @@ module Nexpose
           site.assets << HostName.new(host.text)
         end
 
+        s.elements.each('ExcludedHosts/range') do |r|
+          site.exclude << IPRange.new(r.attributes['from'], r.attributes['to'])
+        end
+        s.elements.each('ExcludedHosts/host') do |host|
+          site.exclude << HostName.new(host.text)
+        end
+
+        s.elements.each('Credentials/adminCredentials') do |credconf|
+          cred = AdminCredentials.new(true)
+          cred.set_service(credconf.attributes['service'])
+          cred.set_blob(credconf.get_text)
+          site.credentials << cred
+        end
+
         s.elements.each('ScanConfig') do |scan_config|
           site.scan_template_name = scan_config.attributes['name']
           site.scan_template = scan_config.attributes['templateID']
@@ -390,10 +411,6 @@ module Nexpose
           end
         end
 
-        #s.elements.each('Credentials') do |cred|
-        #  # TODO
-        #end
-
         s.elements.each('Alerting/Alert') do |a|
           a.elements.each('smtpAlert') do |smtp|
             smtp_alert = SMTPAlert.new(a.attributes['name'], smtp.attributes['sender'], smtp.attributes['limitText'], a.attributes['enabled'])

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nexpose
 version: !ruby/object:Gem::Version
-  version: 0.1.9
+  version: 0.1.10
   prerelease: 
 platform: ruby
 authors:
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-08 00:00:00.000000000 Z
+date: 2013-03-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: librex