nexpose 0.6.3 → 0.6.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a7bb33f6e513e5e433ca6ce6595e2e5c57362605
-  data.tar.gz: bb1e25e94229c4079e9ad18f3acaf84cf584c697
+  metadata.gz: 4397794b70770fea503a7f1613d55350ecdb34e4
+  data.tar.gz: 94ca3aff891805148565fe6b868ea2c22f847038
 SHA512:
-  metadata.gz: a1987527f194e406880839a82c6486d7cf1866cc0bb275506a8ca7aff75bb9a6b971af01c343979de2f395713e857904b5408bfaccadf1f0399bbca6d06f816e
-  data.tar.gz: 275e2fdb7bed01c80d6d97f297235f0ca4ee36a23e4aa003b85156c8b46ce1010e3908af2a4eeccfcf8c7efc8a29740d89dbcc40aecba2de9ab84f870a9301c9
+  metadata.gz: 2c274049ae4574d6201fe233221c729aa23ab9a5df81397cfda75601f3f3cd59ce830bd8fd43573879b29ea6f74f7e18bca3fe6ce8da9f2e549c9efb0dbb7e15
+  data.tar.gz: c2113f68a3c3c06e6c3f070ed9114f8351b7b01948dfa540e12558b6157d2e5eb17a85f2e9276314f7dfb64147ec5b7f7e8651dbc85180b69cf18c84d4524381

data/lib/nexpose.rb

@@ -61,6 +61,7 @@ require 'nexpose/alert'
 require 'nexpose/ajax'
 require 'nexpose/api_request'
 require 'nexpose/common'
+require 'nexpose/console'
 require 'nexpose/creds'
 require 'nexpose/shared_cred'
 require 'nexpose/data_table'

data/lib/nexpose/console.rb

@@ -0,0 +1,71 @@
+module Nexpose
+
+  # Nexpose console configuration class.
+  #
+  # Changes to this object are not persisted until the #save method is called.
+  #
+  # Example usage:
+  #   config = Nexpose::Console.load(nsc)
+  #   config.session_timeout = 600
+  #   config.save(nsc)
+  #
+  class Console
+
+    # Session timeout for the Nexpose web server (in seconds).
+    # The web interface enforces a value from 60 to 604,800 [1 minute to 7 days].
+    attr_accessor :session_timeout
+
+    # Impose a limit on the number of scan threads which an individual scan can use.
+    attr_accessor :scan_threads_limit
+
+    # Whether to retrieve incremental scan results from distributed engines.
+    attr_accessor :incremental_scan_results
+
+    # XML document representing the entire configuration.
+    attr_accessor :xml
+
+    # Construct a new Nexpose Security Console configuration object.
+    # Not meant to be called publicly.
+    # @see #load
+    #
+    # @param [REXML::Document] xml Parsed XML representation of the configuration.
+    #
+    def initialize(xml)
+      @xml = xml
+
+      nsc = REXML::XPath.first(@xml, 'NeXposeSecurityConsole')
+      @scan_threads_limit = nsc.attributes['scanThreadsLimit'].to_i
+      @incremental_scan_results = nsc.attributes['realtimeIntegration'] == '1'
+
+      web_server = REXML::XPath.first(nsc, 'WebServer')
+      @session_timeout = web_server.attributes['sessionTimeout'].to_i
+    end
+
+    # Load existing Nexpose security console configuration.
+    #
+    # @param [Connection] connection Nexpose connection.
+    #
+    def self.load(connection)
+      xml = REXML::Document.new(Nexpose::AJAX.get(connection, '/ajax/nsc_config.txml'))
+      new(xml)
+    end
+
+    # Save modifications to the Nexpose security console.
+    #
+    # @param [Connection] connection Nexpose connection.
+    # @return [Boolean] true if configuration successfully saved.
+    #
+    def save(connection)
+      nsc = REXML::XPath.first(@xml, 'NeXposeSecurityConsole')
+      nsc.attributes['scanThreadsLimit'] = @scan_threads_limit.to_i
+      nsc.attributes['realtimeIntegration'] = @incremental_scan_results ? '1' : '0'
+
+      web_server = REXML::XPath.first(nsc, 'WebServer')
+      web_server.attributes['sessionTimeout'] = @session_timeout.to_i
+
+      response = REXML::Document.new(Nexpose::AJAX.post(connection, '/ajax/save_nsc_config.txml', @xml))
+      saved = REXML::XPath.first(response, 'SaveConfig')
+      saved.attributes['success'] == '1'
+    end
+  end
+end

data/lib/nexpose/creds.rb

@@ -9,6 +9,26 @@ module Nexpose
   class 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,
+                      'ssh' => 22,
+                      'ssh-key' => 22,
+                      'telnet' => 23,
+                      'mysql' => 3306,
+                      'db2' => 50000 }
+
     # Security blob for an existing set of credentials
     attr_accessor :blob
     # The service for these credentials. Can be All.

data/lib/nexpose/device.rb

@@ -62,6 +62,19 @@ module Nexpose
     alias_method :assets, :list_site_devices
     alias_method :list_assets, :list_site_devices
 
+    # Get a list of all assets currently associated with a group.
+    #
+    # @param [Fixnum] dev_id Unique identifier of a device (asset).
+    # @return [Array[Asset]] List of group assets.
+    #
+    def group_assets(group_id)
+      payload = { 'sort' => 'assetName',
+                  'table-id' => 'group-assets',
+                  'groupID' => group_id }
+      results = DataTable._get_json_table(self, '/data/asset/group', payload)
+      results.map { |a| Asset.new(a) }
+    end
+
     # List the vulnerability findings for a given device ID.
     #
     # @param [Fixnum] dev_id Unique identifier of a device (asset).

data/lib/nexpose/filter.rb

@@ -101,6 +101,10 @@ module Nexpose
       # Valid Operators: IN, NOT_IN
       IP_RANGE = 'IP_RANGE'
 
+      # Valid Operators: IS, IS_NOT, IN_RANGE
+      # Valid Values: Integers from 1 to 65535
+      OPEN_PORT = 'OPEN_PORT'
+
       # Valid Operators: CONTAINS, NOT_CONTAINS, IS_EMPTY, IS_NOT_EMPTY
       OS = 'OS'
 
@@ -130,6 +134,10 @@ module Nexpose
       # Valid Operators: CONTAINS, NOT_CONTAINS
       SOFTWARE = 'SOFTWARE'
 
+      # Valid Operators: ARE
+      # Valid Values: PRESENT, NOT_PRESENT
+      VALIDATED_VULNERABILITIES = 'VULNERABILITY_VALIDATED_STATUS'
+
       # Search against vulnerability titles that an asset contains.
       # Valid Operators: CONTAINS, NOT_CONTAINS
       VULNERABILITY = 'VULNERABILITY'
@@ -146,6 +154,7 @@ module Nexpose
       NOT_CONTAINS = 'NOT_CONTAINS'
       IS = 'IS'
       IS_NOT = 'IS_NOT'
+      ARE = 'ARE'
       IN = 'IN'
       NOT_IN = 'NOT_IN'
       IN_RANGE = 'IN_RANGE'
@@ -214,6 +223,11 @@ module Nexpose
         FORMAT = '%m/%d/%Y'
       end
 
+      module ValidatedVulnerability
+        NOT_PRESENT = 1
+        PRESENT = 0
+      end
+
       module VulnerabilityExposure
         MALWARE = 'type:"malware_type", name:"malwarekit"'
         # TODO: A problem in Nexpose causes these values to not be constant.

data/lib/nexpose/scan_template.rb

@@ -146,6 +146,30 @@ module Nexpose
       gen.attributes['disableWebSpider'] = enable ? '0' : '1'
     end
 
+    # Add custom TCP ports to scan for services
+    # @param [Array] ports to scan
+    def tcp_service_ports=(ports)
+      service_ports = REXML::XPath.first(@xml, 'ScanTemplate/ServiceDiscovery/TCPPortScan')
+      service_ports.attributes['mode'] = "custom"
+      service_ports.attributes['method'] = "syn"
+      REXML::XPath.first(service_ports, './portList').text = ports.join(",")
+    end
+
+    # Add custom UDP ports to scan for services
+    # @param [Array] posts to scan
+    def udp_service_ports=(ports)
+      service_ports = REXML::XPath.first(@xml, 'ScanTemplate/ServiceDiscovery/UDPPortScan')
+      service_ports.attributes['mode'] = "custom"
+      REXML::XPath.first(service_ports, './portList').text = ports.join(",")
+    end
+
+    # Disable UDP port scan
+    # @param [Boolean] enable or disable UDP ports
+    def enable_udp_ports=(enable)
+      service_ports = REXML::XPath.first(@xml, 'ScanTemplate/ServiceDiscovery/UDPPortScan')
+      service_ports.attributes['mode'] = 'none' unless enable
+    end
+
     # @return [Boolean] Whether to correlate reliable checks with regular checks.
     def correlate?
       vuln_checks = REXML::XPath.first(@xml, 'ScanTemplate/VulnerabilityChecks')

data/lib/nexpose/shared_cred.rb

@@ -111,46 +111,93 @@ module Nexpose
       !!(response =~ /success="1"/)
     end
 
-    def to_xml
-      xml = '<Credential '
-      xml << %( id="#{@id}">)
-
-      xml << %(<Name>#{@name}</Name>)
-      xml << %(<Description>#{@description}</Description>)
-
-      xml << %(<Services><Service type="#{@type}"></Service></Services>)
-
-      xml << '<Account type="nexpose">'
-      xml << %(<Field name="database">#{@database}</Field>)
-      xml << %(<Field name="domain">#{@domain}</Field>)
-      xml << %(<Field name="username">#{@username}</Field>)
-      xml << %(<Field name="ntlmhash">#{@ntlm_hash}</Field>) if @ntlm_hash
-      xml << %(<Field name="password">#{@password}</Field>) if @password
-      xml << %(<Field name="pemkey">#{@pem_key}</Field>) if @pem_key
-      xml << %(<Field name="privilegeelevationusername">#{@privilege_username}</Field>)
-      xml << %(<Field name="privilegeelevationpassword">#{@privilege_password}</Field>) if @privilege_password
-      xml << %(<Field name="privilegeelevationtype">#{@privilege_type}</Field>) if @privilege_type
-      xml << '</Account>'
-
-      xml << '<Restrictions>'
-      xml << %(<Restriction type="host">#{@host}</Restriction>) if @host
-      xml << %(<Restriction type="port">#{@port}</Restriction>) if @port
-      xml << '</Restrictions>'
-
-      xml << %(<Sites all="#{@all_sites ? 1 : 0}">)
-      @sites.each do |site|
-        xml << %(<Site id="#{site}")
-        xml << ' enabled="0"' if @disabled.member? site
-        xml << '></Site>'
+    def as_xml
+      xml = REXML::Element.new('Credential')
+      xml.add_attribute('id', @id)
+
+      name = xml.add_element('Name').add_text(@name)
+
+      desc = xml.add_element('Description').add_text(@description)
+
+      services = xml.add_element('Services')
+      service = services.add_element('Service').add_attribute('type', @type)
+
+      (account = xml.add_element('Account')).add_attribute('type', 'nexpose')
+      account.add_element('Field', { 'name' => 'database' }).add_text(@database)
+
+      account.add_element('Field', { 'name' => 'domain' }).add_text(@domain)
+      account.add_element('Field', { 'name' => 'username' }).add_text(@username)
+      account.add_element('Field', { 'name' => 'ntlmhash' }).add_text(@ntlm_hash) if @ntlm_hash
+      account.add_element('Field', { 'name' => 'password' }).add_text(@password) if @password
+      account.add_element('Field', { 'name' => 'pemkey' }).add_text(@pem_key) if @pem_key
+      account.add_element('Field', { 'name' => 'privilegeelevationusername' }).add_text(@privilege_username)
+      account.add_element('Field', { 'name' => 'privilegeelevationpassword' }).add_text(@privilege_password) if @privilege_password
+      account.add_element('Field', { 'name' => 'privilegeelevationtype' }).add_text(@privilege_type) if @privilege_type
+
+      restrictions = xml.add_element('Restrictions')
+      restrictions.add_element('Restriction', { 'type' => 'host' }).add_text(@host) if @host
+      restrictions.add_element('Restriction', { 'type' => 'port' }).add_text(@port) if @port
+
+      sites = xml.add_element('Sites')
+      sites.add_attribute('all', @all_sites ? 1 : 0)
+      @sites.each do |s|
+        site = sites.add_element('Site')
+        site.add_attribute('id', s)
+        site.add_attribute('enabled', 0) if @disabled.member? s
       end
       if @sites.empty?
-        @disabled.each do |site|
-          xml << %(<Site id="#{site}" enabled="0"></Site>)
+        @disabled.each do |s|
+          site = sites.add_element('Site')
+          site.add_attribute('id', s)
+          site.add_attribute('enabled', 0)
         end
       end
-      xml << '</Sites>'
 
-      xml << '</Credential>'
+      xml
+    end
+
+    def to_xml
+      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,
+        siteid: -1 }
     end
 
     def self.parse(xml)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nexpose
 version: !ruby/object:Gem::Version
-  version: 0.6.3
+  version: 0.6.4
 platform: ruby
 authors:
 - HD Moore
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-25 00:00:00.000000000 Z
+date: 2014-03-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: librex
@@ -72,6 +72,7 @@ files:
 - lib/nexpose/api_request.rb
 - lib/nexpose/common.rb
 - lib/nexpose/connection.rb
+- lib/nexpose/console.rb
 - lib/nexpose/creds.rb
 - lib/nexpose/dag.rb
 - lib/nexpose/data_table.rb
@@ -116,7 +117,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.0
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Ruby API for Rapid7 Nexpose