nexpose 7.2.1 → 7.3.0

data/lib/eso/step_configuration.rb

@@ -0,0 +1,73 @@
+module Eso
+  class StepConfiguration
+    attr_accessor :typeName, :previousTypeName, :configurationParams, :workflowID
+
+    module ConfigParamProperties
+      DISCOVERY_CONFIG_ID = 'discoveryConfigID'
+      EXCLUDE_ASSETS_WITH_TAGS= 'excludeAssetsWithTags'
+      IMPORT_TAGS = 'importTags'
+      ONLY_IMPORT_THESE_TAGS = 'onlyImportTheseTags'
+      SITE_ID = 'siteID'
+      TAG_ID = 'tagID'
+    end
+
+    module ConfigParamPropertyTypes
+      BOOLEAN = [ConfigParamProperties::IMPORT_TAGS]
+      INTEGER = [ConfigParamProperties::DISCOVERY_CONFIG_ID,
+                 ConfigParamProperties::SITE_ID,
+                 ConfigParamProperties::TAG_ID]
+      STRING = [ConfigParamProperties::EXCLUDE_ASSETS_WITH_TAGS,
+                ConfigParamProperties::ONLY_IMPORT_THESE_TAGS]
+    end
+
+    def initialize (typeName, previousTypeName, configurationParams=nil, workflowID=nil)
+      @typeName = typeName
+      @previousTypeName = previousTypeName
+      @configurationParams = configurationParams ? configurationParams : {
+          :valueClass => Values::OBJECT,
+          :objectType => 'params',
+          :properties => {}}
+      @workflowID = workflowID if workflowID
+    end
+
+    # This adds the specified property to this StepConfiguration.configurationParams.properties Hash
+    #
+    # @param [String] name The name of the property to add, which should be one of ConfigParamProperties
+    # @param [Object] value The value of the property to add, which should already be in the appropriate format (Eso::Values)
+    # @return [StepConfiguration] Returns this object for chaining.
+    def add_property(name, value)
+      @configurationParams[:properties][name] =
+          case name
+            when *ConfigParamPropertyTypes::BOOLEAN
+              {
+                  valueClass: Values::BOOLEAN,
+                  value: value
+              }
+            when *ConfigParamPropertyTypes::INTEGER
+              {
+                  valueClass: Values::INTEGER,
+                  value: value
+              }
+            when *ConfigParamPropertyTypes::STRING
+              {
+                  valueClass: Values::STRING,
+                  value: value
+              }
+            else
+              raise ArgumentError, "Invalid StepConfiguration ConfigurationParameter Property name: #{name}. " +
+                  'Should be one of StepConfiguration::ConfigParamProperties'
+          end
+      self
+    end
+
+    def to_h
+      hash = {
+          :typeName => @typeName,
+          :previousTypeName => @previousTypeName,
+          :configurationParams => @configurationParams
+      }
+      hash['workflowID'] = @workflowID if @workflowID
+      hash
+    end
+  end
+end

data/lib/eso/workflow.rb

@@ -0,0 +1,149 @@
+module Eso
+
+  # The following classes have mixed casing (snake and camel) to accommodate for the API.
+  # I guess a TODO would be to write a helper to automatically convert them.
+  class Workflow
+    # The id of the workflow. This will be created upon saving to the server upon creation.
+    attr_accessor :id
+
+    # The name of the workflow. This is required.
+    attr_accessor :name
+
+    # An array of the steps this workflow takes action on.
+    attr_accessor :steps
+
+    # The time the workflow was created in milliseconds since epoch
+    attr_accessor :timeCreated
+
+    # Constructor for the workflow
+    #
+    # @param [String] id ID of the workflow.
+    # @param [String] name Name of the workflow.
+    # @param [Array] steps Array of the steps that this workflow takes.
+    # @param [Fixnum] time_created The time the workflow was created in millis since epoch
+    #
+    def initialize(id: nil, name:, steps: [], time_created: (Time.now.strftime('%s').to_i * 1000))
+      @id = id
+      @name = name
+      @steps = steps
+      @timeCreated = time_created
+    end
+
+    # Load an existing workflow from the API.
+    #
+    # @param [Conductor] conductor The Conductor object governing the workflows
+    # @param [String] id ID of the workflow to load
+    # @return [Workflow] Workflow object that was loaded.
+    #
+    def self.load(conductor, id)
+      uri = "#{conductor.url}workflows/#{id}"
+      resp = conductor.get(url: uri)
+      workflow = self.new(id: resp[:id], name: resp[:name])
+      steps = resp[:steps]
+      steps.each do |step|
+        workflow_step = Step.new(uuid: step[:uuid],
+                                 service_name: step[:serviceName],
+                                 workflow: workflow,
+                                 type_name: step[:stepConfiguration][:typeName],
+                                 previous_type_name: step[:stepConfiguration][:previousTypeName],
+                                 configuration_params: step[:stepConfiguration][:configurationParams])
+        workflow.steps << workflow_step
+      end
+      workflow
+    end
+
+    # Return the relevant step based on the given service name.
+    # For example, if you want the step related to the scan service you would pass 'nexpose-scan-service'.
+    #
+    # @param [String] service_name Service name to be returned.
+    # @return [Step] Step object corresponding to the given service.
+    #
+    def get_step(type_name)
+      @steps.find do |step|
+        step.type_name == type_name
+      end
+    end
+
+    # Return the trigger step of a workflow. The trigger step is defined as a step that monitors for events
+    # that will cause the action to fire.
+    #
+    # Currently triggers do not have a previous-action so that is what this is returning. This behavior could change in ESO's future.
+    #
+    # @return [Step] Step object representation of the trigger step.
+    #
+    def trigger
+      @steps.find do |step|
+        step.stepConfiguration.previousTypeName.nil?
+      end
+    end
+
+    # Return this object and the associated steps in a digestible JSON format.
+    #
+    # @return [String] JSON interpretation of this workflow.
+    #
+    def to_json
+      hash = self.to_hash
+      steps = hash['steps']
+      hashified_steps = []
+      steps.each { |step| hashified_steps << step.to_hash }
+      hash['steps'] = hashified_steps
+      hash.to_json
+    end
+
+    # Return this object as a hash.
+    # The corresponding steps will still be objects.
+    #
+    # @return [Hash{}] Hash interpretation of this workflow.
+    def to_hash
+      hash = {}
+      instance_variables.each { |var| hash[var.to_s.delete('@')] = instance_variable_get(var) }
+      hash
+    end
+
+    # Representation of state of a workflow or integration option. Taken from service-orchestration State.java
+    module State
+      # Workflow or an integration option is configured and ready to accept events
+      READY = 'ready'
+
+      # Workflow or an integration option is processing or has processed events
+      RUNNING = 'running'
+
+      # The workflow or an integration option is running, but is temporarily unsuccessful processing events
+      RETRY = 'retry'
+
+      # Workflow or an integration option is stopped by the user
+      STOPPED = 'stopped'
+
+      # Workflow or an integration option has experienced an error that caused it to stop
+      ERROR = 'error'
+    end
+
+    StateHistory = Struct.new(:message, :state, :startTime)
+
+    class History < Workflow
+      # The current state of the workflow
+      attr_accessor :state
+
+      # The most recent message
+      attr_accessor :message
+
+      # An array of Eso::Workflow::StateHistory
+      attr_accessor :state_histories
+
+      # Constructor for the WorkflowHistory
+      #
+      # @param [String] id ID of the workflow.
+      # @param [String] name Name of the workflow.
+      # @param [Array] steps Array of the steps that this workflow takes.
+      # @param [Fixnum] time_created The time the workflow was created in millis since epoch
+      # @param [Eso::Workflow::State] state The current state of the workflow
+      # @param [String] message The most recent message
+      def initialize(id:, name:, time_created:, steps:, state:, message:, history:)
+        super(id: id, name: name, timeCreated: time_created, steps: steps)
+        @state = state
+        @message = message
+        @state_histories = history
+      end
+    end
+  end
+end

data/lib/nexpose/ajax.rb

@@ -149,6 +149,7 @@ module Nexpose
     def headers(nsc, request)
       request.add_field('nexposeCCSessionID', nsc.session_id)
       request.add_field('Cookie', "nexposeCCSessionID=#{nsc.session_id}")
+      request.add_field('X-Requested-With', 'XMLHttpRequest')
     end
 
     def request(nsc, request, timeout = nil)

data/lib/nexpose/role.rb

@@ -24,6 +24,7 @@ module Nexpose
       ADD_USERS_TO_REPORT         = 'AddUsersToReport'
       MANAGE_POLICIES             = 'ManagePolicies'
       MANAGE_TAGS                 = 'ManageTags'
+      MANAGE_ADVPOLICIES          = 'ManageAdvPolicies'
     end
 
     module Site

data/lib/nexpose/util.rb

@@ -55,7 +55,8 @@ module Nexpose
       IPAddr.new(ips[1]) if ips[1]
       IPRange.new(ips[0], ips[1])
     rescue ArgumentError => e
-      if e.message == 'invalid address'
+      if e.message =~ /invalid address/
+        # Try to parse the the asset as a hostname if the IP address conversion fails
         HostName.new(asset)
       else
         raise "Unable to parse asset: '#{asset}'. #{e.message}"

data/lib/nexpose/version.rb

@@ -1,4 +1,4 @@
 module Nexpose
   # The latest version of the Nexpose gem
-  VERSION = '7.2.1'.freeze
+  VERSION = '7.3.0'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nexpose
 version: !ruby/object:Gem::Version
-  version: 7.2.1
+  version: 7.3.0
 platform: ruby
 authors:
 - HD Moore
@@ -13,22 +13,22 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-01 00:00:00.000000000 Z
+date: 2021-04-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: codeclimate-test-reporter
   requirement: !ruby/object:Gem::Requirement
@@ -176,6 +176,18 @@ files:
 - README.markdown
 - Rakefile
 - lib/README.md
+- lib/eso.rb
+- lib/eso/conductor.rb
+- lib/eso/configuration/configuration.rb
+- lib/eso/configuration/configuration_manager.rb
+- lib/eso/filter.rb
+- lib/eso/integration_option.rb
+- lib/eso/integration_options_manager.rb
+- lib/eso/nexpose.rb
+- lib/eso/service.rb
+- lib/eso/step.rb
+- lib/eso/step_configuration.rb
+- lib/eso/workflow.rb
 - lib/nexpose.rb
 - lib/nexpose/ajax.rb
 - lib/nexpose/alert.rb
@@ -255,8 +267,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.10
+rubygems_version: 3.2.15
 signing_key: 
 specification_version: 4
 summary: Ruby API for Rapid7 Nexpose