nexpose 7.0.0 → 7.0.1

data/lib/nexpose/pool.rb

@@ -21,7 +21,7 @@ module Nexpose
       arr
     end
 
-    alias_method :engine_pools, :list_engine_pools
+    alias engine_pools list_engine_pools
   end
 
   # A summary of an engine pool.
@@ -36,8 +36,8 @@ module Nexpose
     attr_reader :scope
 
     def initialize(id, name, scope = 'silo')
-      @id = id.to_i
-      @name = name
+      @id    = id.to_i
+      @name  = name
       @scope = scope
     end
 
@@ -74,7 +74,9 @@ module Nexpose
     attr_accessor :engines
 
     def initialize(name, scope = 'silo', id = -1)
-      @name, @scope, @id = name, scope, id.to_i
+      @name    = name
+      @scope   = scope
+      @id      = id.to_i
       @engines = []
     end
 
@@ -100,7 +102,6 @@ module Nexpose
       xml = %(<EnginePoolDetailsRequest session-id="#{connection.session_id}">)
       xml << %(<EnginePool name="#{name}" scope="#{scope}"/>)
       xml << '</EnginePoolDetailsRequest>'
-
       r = connection.execute(xml, '1.2')
       if r.success
         r.res.elements.each('EnginePoolDetailsResponse/EnginePool') do |pool|

data/lib/nexpose/report.rb

@@ -19,7 +19,7 @@ module Nexpose
       reports
     end
 
-    alias_method :reports, :list_reports
+    alias reports list_reports
 
     # Generate a new report using the specified report definition.
     def generate_report(report_id, wait = false)
@@ -38,7 +38,7 @@ module Nexpose
         return summary unless summary.status == 'Started'
         sleep 5
         so_far += 5
-        if so_far % 60 == 0
+        if (so_far % 60).zero?
           puts "Still waiting. Current status: #{summary.status}"
         end
       end
@@ -101,13 +101,13 @@ module Nexpose
     attr_reader :scope
 
     def initialize(config_id, name, template_id, status, generated_on, uri, scope)
-      @config_id = config_id.to_i
-      @name = name
-      @template_id = template_id
-      @status = status
+      @config_id    = config_id.to_i
+      @name         = name
+      @template_id  = template_id
+      @status       = status
       @generated_on = generated_on
-      @uri = uri
-      @scope = scope
+      @uri          = uri
+      @scope        = scope
     end
 
     def self.parse(xml)
@@ -138,11 +138,11 @@ module Nexpose
     attr_reader :uri
 
     def initialize(id, config_id, status, generated_on, uri)
-      @id = id
-      @config_id = config_id.to_i
-      @status = status
+      @id           = id
+      @config_id    = config_id.to_i
+      @status       = status
       @generated_on = generated_on
-      @uri = uri
+      @uri          = uri
     end
 
     # Delete this report.
@@ -194,11 +194,11 @@ module Nexpose
 
     def initialize(template_id, format, site_id = nil, owner = nil, time_zone = nil)
       @template_id = template_id
-      @format = format
-      @owner = owner
-      @time_zone = time_zone
+      @format      = format
+      @owner       = owner
+      @time_zone   = time_zone
 
-      @filters = []
+      @filters     = []
       @filters << Filter.new('site', site_id) if site_id
     end
 
@@ -289,15 +289,14 @@ module Nexpose
 
     # Construct a basic ReportConfig object.
     def initialize(name, template_id, format, id = -1, owner = nil, time_zone = nil)
-      @name = name
+      @name        = name
       @template_id = template_id
-      @format = format
-      @id = id
-      @owner = owner
-      @time_zone = time_zone
-
-      @filters = []
-      @users = []
+      @format      = format
+      @id          = id
+      @owner       = owner
+      @time_zone   = time_zone
+      @filters     = []
+      @users       = []
     end
 
     # Retrieve the configuration for an existing report definition.
@@ -306,7 +305,7 @@ module Nexpose
       ReportConfig.parse(connection.execute(xml))
     end
 
-    alias_method :get, :load
+    alias get load
 
     # Build and save a report configuration against the specified site using
     # the supplied type and format.
@@ -436,11 +435,8 @@ module Nexpose
       %(<filter id="#{replace_entities(@id)}" type="#{@type}" />)
     end
 
-    def ==(object)
-      object.equal?(self) ||
-      (object.instance_of?(self.class) &&
-       object.type == @type &&
-       object.id == @id)
+    def ==(other)
+      other.equal?(self) || (other.instance_of?(self.class) && other.type == @type && other.id == @id)
     end
 
     def self.parse(xml)
@@ -466,8 +462,8 @@ module Nexpose
 
     def initialize(after_scan, scheduled, schedule = nil)
       @after_scan = after_scan
-      @scheduled = scheduled
-      @schedule = schedule
+      @scheduled  = scheduled
+      @schedule   = schedule
     end
 
     def to_xml
@@ -610,9 +606,9 @@ module Nexpose
       xml.elements.each('//credentials') do |creds|
         credential = ExportCredential.new(creds.text)
         # The following attributes may not exist.
-        credential.user_id = creds.attributes['userid']
+        credential.user_id  = creds.attributes['userid']
         credential.password = creds.attributes['password']
-        credential.realm = creds.attributes['realm']
+        credential.realm    = creds.attributes['realm']
         return credential
       end
       nil

data/lib/nexpose/report_template.rb

@@ -19,7 +19,7 @@ module Nexpose
       templates
     end
 
-    alias_method :report_templates, :list_report_templates
+    alias report_templates list_report_templates
 
     # Deletes an existing, custom report template.
     # Cannot delete built-in templates.
@@ -53,11 +53,11 @@ module Nexpose
     attr_reader :description
 
     def initialize(id, name, type, scope, built_in, description)
-      @id = id
-      @name = name
-      @type = type
-      @scope = scope
-      @built_in = built_in
+      @id          = id
+      @name        = name
+      @type        = type
+      @scope       = scope
+      @built_in    = built_in
       @description = description
     end
 
@@ -109,19 +109,18 @@ module Nexpose
     attr_accessor :attributes
     # Display asset names with IPs.
     attr_accessor :show_asset_names
-    alias :show_device_names :show_asset_names
-    alias :show_device_names= :show_asset_names=
+    alias show_device_names show_asset_names
+    alias show_device_names= show_asset_names=
 
     def initialize(name, type = 'document', id = -1, scope = 'silo', built_in = false)
-      @name = name
-      @type = type
-      @id = id
-      @scope = scope
-      @built_in = built_in
-
-      @sections = []
-      @properties = {}
-      @attributes = []
+      @name             = name
+      @type             = type
+      @id               = id
+      @scope            = scope
+      @built_in         = built_in
+      @sections         = []
+      @properties       = {}
+      @attributes       = []
       @show_asset_names = false
     end
 
@@ -219,7 +218,7 @@ module Nexpose
     attr_accessor :properties
 
     def initialize(name)
-      @name = name
+      @name       = name
       @properties = {}
     end
 

data/lib/nexpose/role.rb

@@ -4,44 +4,44 @@ module Nexpose
   module Privilege
 
     module Global
-      CREATE_REPORTS = 'CreateReports'
-      CONFIGURE_GLOBAL_SETTINGS = 'ConfigureGlobalSettings'
-      MANAGE_SITES = 'ManageSites'
-      MANAGE_ASSET_GROUPS = 'ManageAssetGroups'
+      CREATE_REPORTS              = 'CreateReports'
+      CONFIGURE_GLOBAL_SETTINGS   = 'ConfigureGlobalSettings'
+      MANAGE_SITES                = 'ManageSites'
+      MANAGE_ASSET_GROUPS         = 'ManageAssetGroups'
       MANAGE_DYNAMIC_ASSET_GROUPS = 'ManageDynamicAssetGroups'
-      MANAGE_SCAN_TEMPLATES = 'ManageScanTemplates'
-      MANAGE_REPORT_TEMPLATES = 'ManageReportTemplates'
+      MANAGE_SCAN_TEMPLATES       = 'ManageScanTemplates'
+      MANAGE_REPORT_TEMPLATES     = 'ManageReportTemplates'
       GENERATE_RESTRICTED_REPORTS = 'GenerateRestrictedReports'
-      MANAGE_SCAN_ENGINES = 'ManageScanEngines'
-      SUBMIT_VULN_EXCEPTIONS = 'SubmitVulnExceptions'
-      APPROVE_VULN_EXCEPTIONS = 'ApproveVulnExceptions'
-      DELETE_VULN_EXCEPTIONS = 'DeleteVulnExceptions'
-      CREATE_TICKETS = 'CreateTickets'
-      CLOSE_TICKETS = 'CloseTickets'
-      TICKET_ASSIGNEE = 'TicketAssignee'
-      ADD_USERS_TO_SITE = 'AddUsersToSite'
-      ADD_USERS_TO_GROUP = 'AddUsersToGroup'
-      ADD_USERS_TO_REPORT = 'AddUsersToReport'
-      MANAGE_POLICIES = 'ManagePolicies'
-      MANAGE_TAGS = 'ManageTags'
+      MANAGE_SCAN_ENGINES         = 'ManageScanEngines'
+      SUBMIT_VULN_EXCEPTIONS      = 'SubmitVulnExceptions'
+      APPROVE_VULN_EXCEPTIONS     = 'ApproveVulnExceptions'
+      DELETE_VULN_EXCEPTIONS      = 'DeleteVulnExceptions'
+      CREATE_TICKETS              = 'CreateTickets'
+      CLOSE_TICKETS               = 'CloseTickets'
+      TICKET_ASSIGNEE             = 'TicketAssignee'
+      ADD_USERS_TO_SITE           = 'AddUsersToSite'
+      ADD_USERS_TO_GROUP          = 'AddUsersToGroup'
+      ADD_USERS_TO_REPORT         = 'AddUsersToReport'
+      MANAGE_POLICIES             = 'ManagePolicies'
+      MANAGE_TAGS                 = 'ManageTags'
     end
 
     module Site
-      VIEW_ASSET_DATA = 'ViewAssetData'  # NOTE Duplicated between Site and AssetGroup
-      CONFIGURE_ALERTS = 'ConfigureAlerts'
-      CONFIGURE_CREDENTIALS = 'ConfigureCredentials'
-      CONFIGURE_ENGINES = 'ConfigureEngines'
+      VIEW_ASSET_DATA          = 'ViewAssetData' # NOTE Duplicated between Site and AssetGroup
+      CONFIGURE_ALERTS         = 'ConfigureAlerts'
+      CONFIGURE_CREDENTIALS    = 'ConfigureCredentials'
+      CONFIGURE_ENGINES        = 'ConfigureEngines'
       CONFIGURE_SCAN_TEMPLATES = 'ConfigureScanTemplates'
       CONFIGURE_SCHEDULE_SCANS = 'ConfigureScheduleScans'
-      CONFIGURE_SITE_SETTINGS = 'ConfigureSiteSettings'
-      CONFIGURE_TARGETS = 'ConfigureTargets'
-      MANUAL_SCANS = 'ManualScans'
-      PURGE_DATA = 'PurgeData'
+      CONFIGURE_SITE_SETTINGS  = 'ConfigureSiteSettings'
+      CONFIGURE_TARGETS        = 'ConfigureTargets'
+      MANUAL_SCANS             = 'ManualScans'
+      PURGE_DATA               = 'PurgeData'
     end
 
     module AssetGroup
       CONFIGURE_ASSETS = 'ConfigureAssets'
-      VIEW_ASSET_DATA = 'ViewAssetData'  # NOTE Duplicated between Site and AssetGroup
+      VIEW_ASSET_DATA  = 'ViewAssetData' # NOTE Duplicated between Site and AssetGroup
     end
   end
 
@@ -51,27 +51,27 @@ module Nexpose
     # Returns a summary list of all roles.
     #
     def role_listing
-      xml = make_xml('RoleListingRequest')
-      r = execute(xml, '1.2')
+      xml   = make_xml('RoleListingRequest')
+      r     = execute(xml, '1.2')
       roles = []
       if r.success
         r.res.elements.each('RoleListingResponse/RoleSummary') do |summary|
-          roles << RoleSummary::parse(summary)
+          roles << RoleSummary.parse(summary)
         end
       end
       roles
     end
 
-    alias_method :roles, :role_listing
+    alias roles role_listing
 
     def role_delete(role, scope = Scope::SILO)
       xml = make_xml('RoleDeleteRequest')
-      xml.add_element('Role', {'name' => role, 'scope' => scope})
+      xml.add_element('Role', { 'name' => role, 'scope' => scope })
       response = execute(xml, '1.2')
       response.success
     end
 
-    alias_method :delete_role, :role_delete
+    alias delete_role role_delete
   end
 
   # Role summary object encapsulating information about a role.
@@ -98,7 +98,12 @@ module Nexpose
     attr_accessor :scope
 
     def initialize(name, full_name, id, description, enabled = true, scope = Scope::SILO)
-      @name, @full_name, @id, @description, @enabled, @scope = name, full_name, id.to_i, description, enabled, scope
+      @name        = name
+      @full_name   = full_name
+      @id          = id.to_i
+      @description = description
+      @enabled     = enabled
+      @scope       = scope
     end
 
     def self.parse(xml)
@@ -116,12 +121,12 @@ module Nexpose
 
     # Constants, mapping UI terms to role names expected by API.
 
-    GLOBAL_ADMINISTRATOR = 'global-admin'
-    ASSET_OWNER = 'system-admin'
+    GLOBAL_ADMINISTRATOR  = 'global-admin'
+    ASSET_OWNER           = 'system-admin'
     CONTROLS_INSIGHT_ONLY = 'controls-insight-only'
-    SECURITY_MANAGER = 'security-manager'
-    SITE_OWNER = 'site-admin'
-    USER = 'user'
+    SECURITY_MANAGER      = 'security-manager'
+    SITE_OWNER            = 'site-admin'
+    USER                  = 'user'
 
     # Array of all privileges which are enabled for this role.
     # Note: Although the underlying XML has different requirements, this only checks for presence.
@@ -133,7 +138,11 @@ module Nexpose
     attr_accessor :existing
 
     def initialize(name, full_name, id = -1, enabled = true, scope = Scope::SILO)
-      @name, @full_name, @id, @enabled, @scope = name, full_name, id.to_i, enabled, scope
+      @name       = name
+      @full_name  = full_name
+      @id         = id.to_i
+      @enabled    = enabled
+      @scope      = scope
       @privileges = []
     end
 
@@ -147,7 +156,7 @@ module Nexpose
     #
     def self.load(nsc, name, scope = Scope::SILO)
       xml = nsc.make_xml('RoleDetailsRequest')
-      xml.add_element('Role', {'name' => name, 'scope' => scope})
+      xml.add_element('Role', { 'name' => name, 'scope' => scope })
       response = APIRequest.execute(nsc.url, xml, '1.2')
 
       if response.success
@@ -156,7 +165,7 @@ module Nexpose
       end
     end
 
-    alias_method :get, :load
+    alias get load
 
     # Create or save a Role to the Nexpose console.
     #
@@ -170,9 +179,9 @@ module Nexpose
       end
       xml.add_element(as_xml)
 
-      response = APIRequest.execute(nsc.url, xml, '1.2')
-      xml = REXML::XPath.first(response.res, 'RoleCreateResponse')
-      @id = xml.attributes['id'].to_i unless @existing
+      response  = APIRequest.execute(nsc.url, xml, '1.2')
+      xml       = REXML::XPath.first(response.res, 'RoleCreateResponse')
+      @id       = xml.attributes['id'].to_i unless @existing
       @existing = true
       response.success
     end
@@ -186,9 +195,9 @@ module Nexpose
     # @return [Role] requested role.
     #
     def self.copy(nsc, name, scope = Scope::SILO)
-      role = load(nsc, name, scope)
-      role.name = role.full_name = nil
-      role.id = -1
+      role          = load(nsc, name, scope)
+      role.name     = role.full_name = nil
+      role.id       = -1
       role.existing = false
       role
     end
@@ -230,29 +239,29 @@ module Nexpose
 
     def as_xml
       xml = REXML::Element.new('Role')
-      xml.add_attributes({'name' => @name, 'full-name' => @full_name, 'enabled' => enabled , 'scope' => @scope})
+      xml.add_attributes({ 'name' => @name, 'full-name' => @full_name, 'enabled' => enabled, 'scope' => @scope })
       xml.add_attribute('id', @id) if @id > 0
       xml.add_element('Description').text = @description
 
       site_privileges = xml.add_element('SitePrivileges')
-      Privilege::Site::constants.each do |field|
+      Privilege::Site.constants.each do |field|
         as_s = Privilege::Site.const_get(field)
         enabled = privileges.member? as_s
-        site_privileges.add_element( as_s, {'enabled' => enabled})
+        site_privileges.add_element(as_s, { 'enabled' => enabled })
       end
 
       asset_group_privileges = xml.add_element('AssetGroupPrivileges')
-      Privilege::AssetGroup::constants.each do |field|
+      Privilege::AssetGroup.constants.each do |field|
         as_s = Privilege::AssetGroup.const_get(field)
         enabled = privileges.member? as_s
-        asset_group_privileges.add_element( as_s, {'enabled' => enabled})
+        asset_group_privileges.add_element(as_s, { 'enabled' => enabled })
       end
 
       global_privileges = xml.add_element('GlobalPrivileges')
-      Privilege::Global::constants.each do |field|
+      Privilege::Global.constants.each do |field|
         as_s = Privilege::Global.const_get(field)
         enabled = privileges.member? as_s
-        global_privileges.add_element( as_s, {'enabled' => enabled})
+        global_privileges.add_element(as_s, { 'enabled' => enabled })
       end
 
       xml