nexpose 0.8.18 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 24b07c5aa9671577da0a19a249babd2c0fce5ff6
-  data.tar.gz: 30f364953ab62ff807f82deffb848b2ceef80636
+  metadata.gz: b26ec57d92c374454b5be75b30201eddfcf23e99
+  data.tar.gz: 621fad61669205dbf85052ee210019f00578fb50
 SHA512:
-  metadata.gz: fca1a54493ded6d695c2668c53c3ced413c7c82b181367bf3af666cf9cab10ad7209c1a7e6a67f059e6ba7b03f03ba5a783d9aa7ed0706754e7413e847e89d20
-  data.tar.gz: 9f30a2887a5b7f7064b1bf8c5dd7482e7762cb0b7b25e5d91a22dadab2e6577590bc374f76323372394bda48db48526a4663058ae7a356a8148bcec10f1e6764
+  metadata.gz: 27b3f31b2baa7db3637a65f5b9c2bfbdf9af2f8f0918ad7cf1af724c285a219b9e4e0faaf85a8a89b51c8a53ab079327f7d6029decf39dda1e489852271edd5a
+  data.tar.gz: 1fd837247c8a92f57d138712d8e7de1585f695353dc75fdaa14b16d5aac9ce4720dbbb480911867f6e2cede17dec9b3460621dd0d84bff06063669894b28b9de

data/lib/nexpose.rb

@@ -66,8 +66,9 @@ require 'nexpose/api'
 require 'nexpose/api_request'
 require 'nexpose/common'
 require 'nexpose/console'
-require 'nexpose/creds'
-require 'nexpose/shared_cred'
+require 'nexpose/credential'
+require 'nexpose/site_credential'
+require 'nexpose/shared_credential'
 require 'nexpose/data_table'
 require 'nexpose/device'
 require 'nexpose/discovery'

data/lib/nexpose/ajax.rb

@@ -156,6 +156,8 @@ module Nexpose
         response.body
       when Net::HTTPCreated
         response.body
+      when Net::HTTPForbidden
+        raise Nexpose::PermissionError.new(response)
       when Net::HTTPUnauthorized
         raise Nexpose::PermissionError.new(response) 
       else

data/lib/nexpose/api.rb

@@ -25,12 +25,13 @@ module Nexpose
         next if k == :url  # Do not store self-referential URL.
         # Store resource URLs separately and create lazy accessors.
         if v.is_a?(Hash) && v.key?(:url)
-          instance_variable_set("@#{k}_url", v[:url].gsub(/.*\/api/, '/api'))
-          self.class.send(:define_method, k, proc { |conn = nsc| load_resource(conn, k, instance_variable_get("@#{k}_url")) })
+          self.class.send(:define_method, k, proc { |conn = nsc| load_resource(conn, k, v[:url].gsub(/.*\/api/, '/api')) })
         else
           # Convert timestamps.
           if v.is_a?(String) && v.match(/^\d{8}T\d{6}\.\d{3}/)
             instance_variable_set("@#{k}", ISO8601.to_time(v))
+          elsif v.is_a?(Array) && k == :attributes
+            instance_variable_set("@#{k}", v.map { |h| { h[:key] => h[:value] } })
           else
             instance_variable_set("@#{k}", v)
           end
@@ -54,7 +55,13 @@ module Nexpose
       obj = class_from_string(k)
       resp = AJAX.get(nsc, url, AJAX::CONTENT_TYPE::JSON)
       hash = JSON.parse(resp, symbolize_names: true)
-      resources = hash[:resources].map { |e| obj.method(:new).call.object_from_hash(nsc, e) }
+      if hash.is_a?(Array)
+        resources = hash.map { |e| obj.method(:new).call.object_from_hash(nsc, e) }
+      elsif hash.key?(:resources)
+        resources = hash[:resources].map { |e| obj.method(:new).call.object_from_hash(nsc, e) }
+      else
+        resources = obj.method(:new).call.object_from_hash(nsc, hash)
+      end
       instance_variable_set("@#{k}", resources)
       self.class.send(:define_method, k, proc { instance_variable_get("@#{k}") })
       resources
@@ -70,6 +77,7 @@ module Nexpose
     #
     def class_from_string(field)
       str = field.to_s.split('_').map(&:capitalize!).join
+      str = 'Vulnerability' if str == 'Vulnerabilities'
       str.chop! if str.end_with?('s')
       Object.const_get('Nexpose').const_get(str)
     end

data/lib/nexpose/api_request.rb

@@ -47,34 +47,45 @@ module Nexpose
         @http.read_timeout = options[:timeout] if options.key? :timeout
         @raw_response = @http.post(@uri.path, @req, @headers)
         @raw_response_data = @raw_response.read_body
-        @res = parse_xml(@raw_response_data)
 
-        unless @res.root
-          @error = 'Nexpose service returned invalid XML.'
-          return @sid
-        end
+        # Allow the :raw keyword to bypass XML parsing.
+        if options[:raw]
+          if raw_response_data =~ /success="1"/
+            @success = true
+          else
+            @success = false
+            @error = "User requested raw XML response. Not parsing failures."
+          end
+        else
+          @res = parse_xml(@raw_response_data)
 
-        @sid = attributes['session-id']
+          unless @res.root
+            @error = 'Nexpose service returned invalid XML.'
+            return @sid
+          end
 
-        if (attributes['success'] and attributes['success'].to_i == 1)
-          @success = true
-        elsif @api_version =~ /1.2/ and @res and (@res.get_elements '//Exception').count < 1
-          @success = true
-        else
-          @success = false
-          if @api_version =~ /1.2/
-            @res.elements.each('//Exception/Message') do |message|
+          @sid = attributes['session-id']
+
+          if (attributes['success'] and attributes['success'].to_i == 1)
+            @success = true
+          elsif @api_version =~ /1.2/ and @res and (@res.get_elements '//Exception').count < 1
+            @success = true
+          else
+            @success = false
+            if @api_version =~ /1.2/
+              @res.elements.each('//Exception/Message') do |message|
               @error = message.text.sub(/.*Exception: */, '')
-            end
+              end
             @res.elements.each('//Exception/Stacktrace') do |stacktrace|
               @trace = stacktrace.text
             end
-          else
-            @res.elements.each('//message') do |message|
-              @error = message.text.sub(/.*Exception: */, '')
-            end
-            @res.elements.each('//stacktrace') do |stacktrace|
-              @trace = stacktrace.text
+            else
+              @res.elements.each('//message') do |message|
+                @error = message.text.sub(/.*Exception: */, '')
+              end
+              @res.elements.each('//stacktrace') do |stacktrace|
+                @trace = stacktrace.text
+              end
             end
           end
         end

data/lib/nexpose/connection.rb

@@ -108,7 +108,7 @@ module Nexpose
       resp = http.get(uri.to_s, headers)
 
       if file_name
-        File.open(file_name, 'wb') { |file| file.write(resp.body) }
+        ::File.open(file_name, 'wb') { |file| file.write(resp.body) }
       else
         resp.body
       end

data/lib/nexpose/credential.rb

@@ -0,0 +1,108 @@
+module Nexpose
+
+  # Contains the shared methods for the SiteCredential and SharedCredential Objects.
+  # See Nexpose::SiteCredential or Nexpose::SharedCredential for additional info.
+  class Credential
+
+    # Mapping of Common Ports.
+    DEFAULT_PORTS = { 'cvs'              => 2401,
+                      'ftp'              => 21,
+                      'http'             => 80,
+                      'as400'            => 449,
+                      'notes'            => 1352,
+                      'tds'              => 1433,
+                      'sybase'           => 5000,
+                      'cifs'             => 445,
+                      'cifshash'         => 445,
+                      'oracle'           => 1521,
+                      'pop'              => 110,
+                      'postgresql'       => 5432,
+                      'remote execution' => 512,
+                      'snmp'             => 161,
+                      'snmpv3'           => 161,
+                      'ssh'              => 22,
+                      'ssh-key'          => 22,
+                      'telnet'           => 23,
+                      'mysql'            => 3306,
+                      'db2'              => 50000 }
+
+
+    # Credential Service/Type Options.
+    module Service
+      CVS              = 'cvs'              # Concurrent Versioning System (CVS)
+      FTP              = 'ftp'              # File Transfer Protocol (FTP)
+      HTTP             = 'http'             # Web Site HTTP Authentication
+      AS400            = 'as400'            # IBM AS/400
+      NOTES            = 'notes'            # Lotus Notes/Domino
+      TDS              = 'tds'              # Microsoft SQL Server
+      SYBASE           = 'sybase'           # Sybase SQL Server
+      CIFS             = 'cifs'             # Microsoft Windows/Samba (SMB/CIFS)
+      CIFSHASH         = 'cifshash'         # Microsoft Windows/Samba LM/NTLM Hash (SMB/CIFS)
+      ORACLE           = 'oracle'           # Oracle
+      POP              = 'pop'              # Post Office Protocol (POP)
+      POSTGRESQL       = 'postgresql'       # PostgreSQL
+      REMOTE_EXECUTION = 'remote execution' # Remote Execution
+      SNMP             = 'snmp'             # Simple Network Management Protocol
+      SNMPV3           = 'snmpv3'           # Simple Network Management Protocol v3
+      SSH              = 'ssh'              # Secure Shell (SSH)
+      SSH_KEY          = 'ssh-key'          # Secure Shell (SSH) Public Key
+      TELNET           = 'telnet'           # TELNET
+      MYSQL            = 'mysql'            # MySQL Server
+      DB2              = 'db2'              # DB2
+    end
+
+
+    # Permission Elevation / Privilege Escalation Types.
+    module ElevationType
+      NONE   = 'NONE'
+      SUDO   = 'SUDO'
+      SUDOSU = 'SUDOSU'
+      SU     = 'SU'
+      PBRUN  = 'PBRUN'
+    end
+
+
+    # Test this credential against a target where the credentials should apply.
+    # Only works for a newly created credential. Loading an existing credential
+    # will likely fail.
+    #
+    # @param [Connection] nsc An active connection to the security console.
+    # @param [String] target Target host to check credentials against.
+    # @param [Fixnum] engine_id ID of the engine to use for testing credentials.
+    #   Will default to the local engine if none is provided.
+    #
+    def test(nsc, target, engine_id = nil, siteid = -1)
+      unless engine_id
+        engine_id = nsc.engines.find { |e| e.name == 'Local scan engine' }.id
+      end
+      @port = Credential::DEFAULT_PORTS[@service] if @port.nil?
+      parameters = _to_param(target, engine_id, @port, siteid)
+      xml = AJAX.form_post(nsc, '/ajax/test_admin_credentials.txml', parameters)
+      result = REXML::XPath.first(REXML::Document.new(xml), 'TestAdminCredentialsResult')
+      result.attributes['success'].to_i == 1
+    end
+
+
+    def _to_param(target, engine_id, port, siteid)
+      { engineid: engine_id,
+        sc_creds_dev: target,
+        sc_creds_svc: @service,
+        sc_creds_database: @database,
+        sc_creds_domain: @domain,
+        sc_creds_uname: @username,
+        sc_creds_password: @password,
+        sc_creds_pemkey: @pem_key,
+        sc_creds_port: port,
+        sc_creds_privilegeelevationusername: @privilege_username,
+        sc_creds_privilegeelevationpassword: @privilege_password,
+        sc_creds_privilegeelevationtype: @privilege_type,
+        sc_creds_snmpv3authtype: @auth_type,
+        sc_creds_snmpv3privtype: @privacy_type,
+        sc_creds_snmpv3privpassword: @privacy_password,
+        siteid: siteid }
+    end
+
+  end
+
+
+end

data/lib/nexpose/dag.rb

@@ -54,7 +54,7 @@ module Nexpose
     end
 
     def _to_entity_details
-      obj = { 'searchCriteria' => @criteria.to_map,
+      obj = { 'searchCriteria' => @criteria.to_hash,
               'name' => @name,
               'tag' => @description.nil? ? '' : @description,
               'dynamic' => true,

data/lib/nexpose/filter.rb

@@ -283,11 +283,12 @@ module Nexpose
 
     # Convert this object into the map format expected by Nexpose.
     #
-    def to_map
+    def to_hash
       { 'metadata' => { 'fieldName' => field },
         'operator' => operator,
         'values' => Array(value) }
     end
+    alias_method :to_map, :to_hash
 
     def self.parse(json)
       Criterion.new(json['metadata']['fieldName'],
@@ -310,15 +311,16 @@ module Nexpose
       @match = match.upcase
     end
 
-    def to_map
+    def to_hash
       { 'operator' => @match,
-        'criteria' => @criteria.map { |c| c.to_map } }
+        'criteria' => @criteria.map { |c| c.to_hash } }
     end
+    alias_method :to_map, :to_hash
 
     # Convert this object into the format expected by Nexpose.
     #
     def to_json
-      JSON.generate(to_map)
+      JSON.generate(to_hash)
     end
 
     # Generate the payload needed for a POST request for Asset Filter.

data/lib/nexpose/report.rb

@@ -222,23 +222,23 @@ module Nexpose
       xml << '</AdhocReportConfig>'
     end
 
-    include XMLUtils
-    include HTMLUtils
-
     # Generate a report once using a simple configuration.
     #
-    # For XML-based reports, only the raw report is returned and not any images.
+    # For XML-based reports, only the textual report is returned and not any images.
     #
     # @param [Connection] connection Nexpose connection.
     # @param [Fixnum] timeout How long, in seconds, to wait for the report to
     #   generate. Larger reports can take a significant amount of time.
+    # @param [Boolean] raw Whether to bypass response parsing an use the raw
+    #   response. If this option is used, error will only be exposed by
+    #   examining Connection#response_xml.
     # @return Report in text format except for PDF, which returns binary data.
     #
-    def generate(connection, timeout = 300)
+    def generate(connection, timeout = 300, raw = false)
       xml = %(<ReportAdhocGenerateRequest session-id="#{connection.session_id}">)
       xml << to_xml
       xml << '</ReportAdhocGenerateRequest>'
-      response = connection.execute(xml, '1.1', timeout: timeout)
+      response = connection.execute(xml, '1.1', timeout: timeout, raw: raw)
       if response.success
         content_type_response = response.raw_response.header['Content-Type']
         if content_type_response =~ /multipart\/mixed;\s*boundary=([^\s]+)/
@@ -254,9 +254,9 @@ module Nexpose
             if /.*base64.*/ =~ part.header.to_s
               if @format =~ /(?:ht|x)ml/
                 if part.header.to_s =~ %r(text/xml)
-                  return parse_xml(part.content.unpack('m*')[0]).to_s
+                  return part.content.unpack('m*')[0].to_s
                 elsif part.header.to_s =~ %r(text/html)
-                  return parse_html(part.content.unpack('m*')[0]).to_s
+                  return part.content.unpack('m*')[0].to_s
                 end
               else # text|pdf|csv|rtf
                 return part.content.unpack('m*')[0]

data/lib/nexpose/scan.rb

@@ -263,7 +263,7 @@ module Nexpose
       case resp
       when Net::HTTPSuccess
         if zip_file
-          File.open(zip_file, 'wb') { |file| file.write(resp.body) }
+          ::File.open(zip_file, 'wb') { |file| file.write(resp.body) }
         else
           resp.body
         end
@@ -296,7 +296,7 @@ module Nexpose
       data = Rex::MIME::Message.new
       data.add_part(site_id.to_s, nil, nil, 'form-data; name="siteid"')
       data.add_part(session_id, nil, nil, 'form-data; name="nexposeCCSessionID"')
-      scan = File.new(zip_file, 'rb')
+      scan = ::File.new(zip_file, 'rb')
       data.add_part(scan.read, 'application/zip', 'binary',
                     "form-data; name=\"scan\"; filename=\"#{zip_file}\"")
 

data/lib/nexpose/{shared_cred.rb → shared_credential.rb}

@@ -21,14 +21,16 @@ module Nexpose
     alias_method :delete_shared_cred, :delete_shared_credential
   end
 
-  class SharedCredentialSummary
+  class SharedCredentialSummary < Credential
 
     # Unique ID assigned to this credential by Nexpose.
     attr_accessor :id
     # Name to identify this credential.
     attr_accessor :name
-    # The credential type. See Nexpose::Credential::Type.
-    attr_accessor :type
+    # The credential service/type. See Nexpose::Credential::Service.
+    attr_accessor :service
+    alias :type :service
+    alias :type= :service=
     # Domain or realm.
     attr_accessor :domain
     # User name.
@@ -168,49 +170,6 @@ module Nexpose
       as_xml.to_s
     end
 
-    # Test this credential against a target where the credentials should apply.
-    # Only works for a newly created credential. Loading an existing credential
-    # will likely fail.
-    #
-    # @param [Connection] nsc An active connection to the security console.
-    # @param [String] target Target host to check credentials against.
-    # @param [Fixnum] engine_id ID of the engine to use for testing credentials.
-    #   Will default to the local engine if none is provided.
-    #
-    def test(nsc, target, engine_id = nil)
-      unless engine_id
-        local_engine = nsc.engines.find { |e| e.name == 'Local scan engine' }
-        engine_id = local_engine.id
-      end
-
-      parameters = _to_param(target, engine_id)
-      xml = AJAX.form_post(nsc, '/ajax/test_admin_credentials.txml', parameters)
-      result = REXML::XPath.first(REXML::Document.new(xml), 'TestAdminCredentialsResult')
-      result.attributes['success'].to_i == 1
-    end
-
-    def _to_param(target, engine_id)
-      port = @port
-      port = Credential::DEFAULT_PORTS[@type] if port.nil?
-
-      { engineid: engine_id,
-        sc_creds_dev: target,
-        sc_creds_svc: @type,
-        sc_creds_database: @database,
-        sc_creds_domain: @domain,
-        sc_creds_uname: @username,
-        sc_creds_password: @password,
-        sc_creds_pemkey: @pem_key,
-        sc_creds_port: port,
-        sc_creds_privilegeelevationusername: @privilege_username,
-        sc_creds_privilegeelevationpassword: @privilege_password,
-        sc_creds_privilegeelevationtype: @privilege_type,
-        sc_creds_snmpv3authtype: @auth_type,
-        sc_creds_snmpv3privtype: @privacy_type,
-        sc_creds_snmpv3privpassword: @privacy_password,
-        siteid: -1 }
-    end
-
     def self.parse(xml)
       rexml = REXML::Document.new(xml)
       rexml.elements.each('Credential') do |c|

data/lib/nexpose/site.rb

@@ -352,7 +352,7 @@ module Nexpose
                   'tag' => @description.nil? ? '' : @description,
                   'riskFactor' => @risk_factor,
                   # 'vCenter' => @discovery_connection_id,
-                  'searchCriteria' => @criteria.nil? ? { 'operator' => 'AND' } : @criteria.to_map }
+                  'searchCriteria' => @criteria.nil? ? { 'operator' => 'AND' } : @criteria.to_hash }
       json = JSON.generate(details)
 
       response = AJAX.post(nsc, uri, json, AJAX::CONTENT_TYPE::JSON)
@@ -494,7 +494,7 @@ module Nexpose
         end
 
         s.elements.each('Credentials/adminCredentials') do |cred|
-          site.credentials << Credential.parse(cred)
+          site.credentials << SiteCredential.parse(cred)
         end
 
         s.elements.each('ScanConfig') do |scan_config|

data/lib/nexpose/{creds.rb → site_credential.rb}

@@ -6,29 +6,9 @@ module Nexpose
   # be passed back as is during a Site Save operation. This object
   # can only be used to create a new set of credentials.
   #
-  class Credential
+  class SiteCredential < Credential
     include XMLUtils
 
-    DEFAULT_PORTS = { 'cvs' => 2401,
-                      'ftp' => 21,
-                      'http' => 80,
-                      'as400' => 449,
-                      'notes' => 1352,
-                      'tds' => 1433,
-                      'sybase' => 5000,
-                      'cifs' => 445,
-                      'cifshash' => 445,
-                      'oracle' => 1521,
-                      'pop' => 110,
-                      'postgresql' => 5432,
-                      'remote execution' => 512,
-                      'snmp' => 161,
-                      'snmpv3' => 161,
-                      'ssh' => 22,
-                      'ssh-key' => 22,
-                      'telnet' => 23,
-                      'mysql' => 3306,
-                      'db2' => 50000 }
 
     # Security blob for an existing set of credentials
     attr_accessor :blob
@@ -38,8 +18,6 @@ module Nexpose
     attr_accessor :host
     # The port on which to use these credentials.
     attr_accessor :port
-    # The user id or username
-    attr_accessor :userid
     # The password
     attr_accessor :password
     # The realm for these credentials
@@ -63,10 +41,18 @@ module Nexpose
     # The privacy/encryption pass phrase to use with SNMP v3 credentials
     attr_accessor :privacy_password
 
+    # Permission elevation type. See Nexpose::Credential::ElevationType.
+    attr_accessor :privilege_type
+    # The User ID or Username
+    attr_accessor :username
+    alias :userid :username
+    alias :userid= :username=
+
+
     def self.for_service(service, user, password, realm = nil, host = nil, port = nil)
       cred = new
       cred.service = service
-      cred.userid = user
+      cred.username = user
       cred.password = password
       cred.realm = realm
       cred.host = host
@@ -80,7 +66,7 @@ module Nexpose
       @priv_username = username
       @priv_password = password
     end
-    
+
     def add_snmpv3_credentials(auth_type, privacy_type, privacy_password)
       @auth_type = auth_type
       @privacy_type = privacy_type
@@ -102,9 +88,8 @@ module Nexpose
 
     def as_xml
       attributes = {}
-
       attributes['service'] = @service
-      attributes['userid'] = @userid
+      attributes['userid'] = @username
       attributes['password'] = @password
       attributes['realm'] = @realm
       attributes['host'] = @host
@@ -113,7 +98,7 @@ module Nexpose
       attributes['privilegeelevationtype'] = @priv_type if @priv_type
       attributes['privilegeelevationusername'] = @priv_username if @priv_username
       attributes['privilegeelevationpassword'] = @priv_password if @priv_password
-      
+
       attributes['snmpv3authtype'] = @auth_type if @auth_type
       attributes['snmpv3privtype'] = @privacy_type if @privacy_type
       attributes['snmpv3privpassword'] = @privacy_password if @privacy_password
@@ -139,61 +124,6 @@ module Nexpose
       to_xml.hash
     end
 
-    # Credential type options.
-    #
-    module Type
-
-      # Concurrent Versioning System (CVS)
-      CVS = 'cvs'
-      # File Transfer Protocol (FTP)
-      FTP = 'ftp'
-      # Web Site HTTP Authentication
-      HTTP = 'http'
-      # IBM AS/400
-      AS400 = 'as400'
-      # Lotus Notes/Domino
-      NOTES = 'notes'
-      # Microsoft SQL Server
-      TDS = 'tds'
-      # Sybase SQL Server
-      SYBASE = 'sybase'
-      # Microsoft Windows/Samba (SMB/CIFS)
-      CIFS = 'cifs'
-      # Microsoft Windows/Samba LM/NTLM Hash (SMB/CIFS)
-      CIFSHASH = 'cifshash'
-      # Oracle
-      ORACLE = 'oracle'
-      # Post Office Protocol (POP)
-      POP = 'pop'
-      # PostgreSQL
-      POSTGRESQL = 'postgresql'
-      # Remote Execution
-      REMOTE_EXECUTION = 'remote execution'
-      # Simple Network Management Protocol
-      SNMP = 'snmp'
-      # Simple Network Management Protocol v3
-      SNMPV3 = 'snmpv3'
-      # Secure Shell (SSH)
-      SSH = 'ssh'
-      # Secure Shell (SSH) Public Key
-      SSH_KEY = 'ssh-key'
-      # TELNET
-      TELNET = 'telnet'
-      # MySQL Server
-      MYSQL = 'mysql'
-      # DB2
-      DB2 = 'db2'
-    end
-
-    # Permission Elevation Types
-    #
-    module ElevationType
-
-      NONE = 'NONE'
-      SUDO = 'SUDO'
-      SUDOSU = 'SUDOSU'
-      SU = 'SU'
-    end
   end
 
   # Object that represents Header name-value pairs, associated with Web Session Authentication.

data/lib/nexpose/tag.rb

@@ -259,7 +259,7 @@ module Nexpose
           'tag_config' => { 'site_ids' => @site_ids,
                             'tag_associated_asset_ids' => @associated_asset_ids,
                             'asset_group_ids' => @asset_group_ids,
-                            'search_criteria' => @search_criteria ? @search_criteria.to_map : nil
+                            'search_criteria' => @search_criteria ? @search_criteria.to_hash : nil
           }
       }
       if @type == Type::Generic::CUSTOM

data/lib/nexpose/util.rb

@@ -6,12 +6,6 @@ module Nexpose
     end
   end
 
-  module HTMLUtils
-    def parse_html(html)
-      Nokogiri::HTML(html, nil, 'UTF-8')
-    end
-  end
-
   module XMLUtils
 
     def parse_xml(xml)
@@ -116,4 +110,22 @@ module Nexpose
       time.to_time.utc.strftime('%Y%m%dT%H%M%S.%LZ')
     end
   end
+
+  # Functions for handling attributes as understood by the API.
+  # In particular, the API expects a JSON object with the hash defined as:
+  #  { "key": "key-string",
+  #    "value": "value-string" }
+  #
+  module Attributes
+    module_function
+
+    # Convert an array of attributes into a hash consumable by the API.
+    #
+    # @param [Array[Hash]] arr Array of attributes to convert.
+    # @return [Array[Hash]] Array formatted as expected by the API.
+    #
+    def to_hash(arr)
+      arr.map(&:flatten).map { |p| { 'key' => p.first.to_s, 'value' => p.last.to_s } }
+    end
+  end
 end

data/lib/nexpose/version.rb

@@ -1,4 +1,4 @@
 module Nexpose
   # The latest version of the Nexpose gem
-  VERSION = '0.8.18'
+  VERSION = '0.9.0'
 end

data/nexpose.gemspec

@@ -0,0 +1,24 @@
+# encoding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'nexpose/version'
+
+Gem::Specification.new do |s|
+  s.name                  = 'nexpose'
+  s.version               = Nexpose::VERSION
+  s.homepage              = 'https://github.com/rapid7/nexpose-client'
+  s.summary               = 'Ruby API for Rapid7 Nexpose'
+  s.description           = 'This gem provides a Ruby API to the Nexpose vulnerability management product by Rapid7.'
+  s.license               = 'BSD'
+  s.authors               = ['HD Moore', 'Chris Lee', 'Michael Daines', 'Brandon Turner']
+  s.email                 = ['hd_moore@rapid7.com', 'christopher_lee@rapid7.com', 'michael_daines@rapid7.com', 'brandon_turner@rapid7.com' ]
+  s.files                 = Dir['[A-Z]*'] + Dir['lib/**/*']
+  s.require_paths         = ['lib']
+  s.extra_rdoc_files      = ['README.markdown']
+  s.required_ruby_version = '>= 1.9'
+  s.platform              = 'ruby'
+
+  s.add_runtime_dependency('rex', '~> 2.0.5', '>= 2.0.5')
+
+  s.add_development_dependency('bundler', '~> 1.3')
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nexpose
 version: !ruby/object:Gem::Version
-  version: 0.8.18
+  version: 0.9.0
 platform: ruby
 authors:
 - HD Moore
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-15 00:00:00.000000000 Z
+date: 2014-12-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rex
@@ -19,40 +19,20 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.4
+        version: 2.0.5
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.0.4
+        version: 2.0.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.4
+        version: 2.0.5
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.0.4
-- !ruby/object:Gem::Dependency
-  name: nokogiri
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.6'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.6.2
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.6'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.6.2
+        version: 2.0.5
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -92,7 +72,7 @@ files:
 - lib/nexpose/common.rb
 - lib/nexpose/connection.rb
 - lib/nexpose/console.rb
-- lib/nexpose/creds.rb
+- lib/nexpose/credential.rb
 - lib/nexpose/dag.rb
 - lib/nexpose/data_table.rb
 - lib/nexpose/device.rb
@@ -112,10 +92,11 @@ files:
 - lib/nexpose/role.rb
 - lib/nexpose/scan.rb
 - lib/nexpose/scan_template.rb
-- lib/nexpose/shared_cred.rb
+- lib/nexpose/shared_credential.rb
 - lib/nexpose/silo.rb
 - lib/nexpose/silo_profile.rb
 - lib/nexpose/site.rb
+- lib/nexpose/site_credential.rb
 - lib/nexpose/tag.rb
 - lib/nexpose/tag/criteria.rb
 - lib/nexpose/ticket.rb
@@ -124,6 +105,7 @@ files:
 - lib/nexpose/version.rb
 - lib/nexpose/vuln.rb
 - lib/nexpose/vuln_exception.rb
+- nexpose.gemspec
 homepage: https://github.com/rapid7/nexpose-client
 licenses:
 - BSD
@@ -144,7 +126,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.3
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Ruby API for Rapid7 Nexpose