emasser 1.0.0 → 1.0.6

data/lib/emasser/help/cloudresource_post_mapper.md

@@ -0,0 +1,62 @@
+Add cloud resource and scan results in the assets module for a system
+
+Endpoint request parameters/fields
+
+Field                   Data Type  Details
+-------------------------------------------------------------------------------------------------
+systemId                 Integer   [Required] Unique eMASS identifier. Will need to provide correct number.
+provider                 String    [Required] Cloud service provider name.
+resourceId               String    [Required] Unique identifier/resource namespace for policy compliance result.
+resourceName             String    [Required] Friendly name of Cloud resource.
+resourceType             String    [Required] Type of Cloud resource.
+
+initiatedBy              String    [Optional] Email of POC.
+cspAccountId             String    [Optional] System/owner's CSP account ID/number.
+cspRegion                String    [Optional] CSP region of system.
+isBaseline               Boolean   [Optional] True/false flag for providing results as baseline.
+                                              If true, all existing compliance results for the resourceId will be replaced by results in the current call.
+
+tags                     Object    [Optional] Informational tags associated to results for other metadata
+  text                   String    [Optional] Tag metadata information
+
+complianceResults        Object    [Required] Compliance result information
+  cspPolicyDefinitionId    String  [Required] Unique identifier/compliance namespace for CSP/Resource’s
+                                            policy definition/compliance check.
+  policyDefinitionTitle    String  [Required] Friendly policy/compliance check title. Recommend short title
+  isCompliant              Boolean [Required] Compliance status of the policy for the identified cloud resource.
+
+  complianceCheckTimestamp Date    [Optional] Unix date format
+  control                  String  [Optional] Comma separated correlation to Security Control
+                                             (e.g. exact NIST Control acronym).
+  assessmentProcedure      String  [Optional] Comma separated correlation to Assessment Procedure
+                                              (i.e. CCI number for DoD Control Set).
+  complianceReason         String  [Optional] Reason/comments for compliance result
+  policyDeploymentName     String  [Optional] Name of policy deployment
+  policyDeploymentVersion  String  [Optional] Version of policy deployment.
+  severity                 String  [Optional] Values include the following: (Low, Medium, High, Critical)
+
+
+  The following Cloud Resource parameters/fields have the following character limitations:
+- Fields that can not exceed 50 characters:
+  - Policy Deployment Version (`policyDeploymentVersion`)
+- Fields that can not exceed 100 characters:
+  - Assessment Procedure      (`assessmentProcedure`)
+  - Security Control Acronym  (`control`)
+  - CSP Account ID            (`cspAccountId`)
+  - CSP Region                (`cspRegion`)
+  - Email of POC              (`initiatedBy`)
+  - Cloud Service Provider    (`provider`)
+  - Type of Cloud resource    (`resourceType`)
+- Fields that can not exceed 500 characters:
+  - CSP/Resource’s Policy ID  (`cspPolicyDefinitionId`)
+  - Policy Deployment Name    (`policyDeploymentName`)
+  - Policy Compliance ID      (`resourceId`)
+  - Cloud Resource Name       (`resourceName`)
+- Fields that can not exceed 1000 characters:
+  - Reason for Compliance (`complianceReason`)
+- Fields that can not exceed 2000 characters:
+  - Policy Short Title    (`policyDefinitionTitle`)
+
+Example:
+
+bundle exec exe/emasser post cloud_resource add --systemId [value] --provider [value] --resourceId [value] --resourceName [value] --resourceType [value] --cspPolicyDefinitionId [value] --isCompliant or --is-not-Compliant --policyDefinitionTitle [value] --test [value]

data/lib/emasser/help/container_post_mapper.md

@@ -0,0 +1,44 @@
+Add cloud resource and scan results in the assets module for a system
+
+Endpoint request parameters/fields
+
+Field                   Data Type  Details
+-------------------------------------------------------------------------------------------------
+systemId                 Integer   [Required] Unique eMASS identifier. Will need to provide correct number.
+containerId              String    [Required] Unique identifier of the container.
+containerName            String    [Required] Friendly name of the container.
+time                     Date      [Required] Datetime of scan/result. Unix date format.
+
+podName                  String    [Optional] Name of pod (e.g. Kubernetes pod).
+podIp                    String    [Optional] IP address of pod.
+namespace                String    [Optional] Namespace of container in container orchestration (e.g. Kubernetes namespace).
+
+tags                     Object    [Optional] Informational tags associated to results for other metadata.
+  text                   String    [Optional] Tag metadata information.
+
+benchmarks               Object
+  benchmark              String    [Required] Identifier of the benchmark/grouping of compliance results. 
+                                   (e.g. for STIG results, provide the benchmark id for the STIG technology).
+  isBaseline             Boolean   [Optional] True/false flag for providing results as baseline. If true, all existing
+                                   compliance results for the provided benchmark within the container will be replaced
+                                   by results in the current call.
+  results                Object                                 
+    ruleId               String    [Required] Identifier for the compliance result, vulnerability, etc.
+    status               String    [Required] Benchmark result status
+    lastSeen             Date      [Required] Date last seen, Unix date format
+    message              String    [Optional] Comments for the result
+
+The following Container parameters/fields have the following character limitations:
+- Fields that can not exceed 100 characters:
+  - STIG Benchmark ID      (`benchmark`)
+  - Container Namespace    (`namespace`)
+  - Kubernetes assigned IP (`podIp`)
+  - Kubernetes Pod Name)   (`podName`)
+- Fields that can not exceed 500 characters:
+  - Container ID              (`containerId`)
+  - Friendly Container Name   (`containerName`)
+- Fields that can not exceed 1000 characters:
+  - Result Comments (`message`)
+
+Example:
+bundle exec ruby exe/emasser post container add --systemId [value] --containerId [value] --containerName [value] --time [value] --benchmark [value] --lastSeen [value] --ruleId [value] --status [value]

data/lib/emasser/output_converters.rb

@@ -1,14 +1,111 @@
 # frozen_string_literal: true
 
 module OutputConverters
+  # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity, Style/TernaryParentheses
+  # rubocop:disable Style/IfWithBooleanLiteralBranches, Style/RescueStandardError, Metrics/BlockNesting
   def to_output_hash(obj)
+    diplay_nulls = (ENV.fetch('EMASSER_CLI_DISPLAY_NULL', 'true').eql? 'true') ? true : false
+    diplay_datetime = (ENV.fetch('EMASSER_EPOCH_TO_DATETIME', 'false').eql? 'true') ? true : false
+
     if obj.to_s.include? 'Error message'
-      obj
+      begin
+        index = obj.to_s.index('Response body')+14
+        arr_obj = obj.to_s[index, obj.to_s.size - index]
+        JSON.pretty_generate(JSON.parse(arr_obj))
+      rescue
+        obj
+      end
     else
-      hash = obj.instance_variables.each_with_object({}) do |var, h|
-        h[var.to_s.delete('@')] = obj.instance_variable_get(var)
+      obj = obj.to_body if obj.respond_to?(:to_body)
+      if !diplay_nulls
+        clean_obj = {}
+        data_obj = {}
+        obj.each do |key, value|
+          if key.to_s.include?('meta')
+            obj_entry = {}
+            obj_entry[:meta] = value
+            clean_obj.merge!(obj_entry)
+          elsif key.to_s.include?('data')
+            if value.is_a?(Array)
+              hash_array = []
+              value.each do |elements|
+                hash_array << elements.compact
+              end
+              data_obj['data'] = hash_array
+            else
+              data_obj['data'] = value.nil? ? value : value.compact
+            end
+          elsif key.to_s.include?('pagination')
+            pg_obj = {}
+            pg_obj[:pagination] = value
+            data_obj.merge!(pg_obj)
+          end
+          clean_obj.merge!(data_obj)
+        end
+        obj = clean_obj
+      end
+
+      if diplay_datetime
+        clean_obj = {}
+        data_obj = {}
+        obj.each do |key, value|
+          if key.to_s.include?('meta')
+            obj_entry = {}
+            obj_entry[:meta] = value
+            clean_obj.merge!(obj_entry)
+          elsif key.to_s.include?('data')
+            if value.is_a?(Array)
+              hash_array = []
+              value.each do |element|
+                datetime_obj = change_to_datetime(element)
+                hash_array << datetime_obj
+              end
+              data_obj['data'] = hash_array
+            else
+              data_obj['data'] = change_to_datetime(value)
+            end
+          elsif key.to_s.include?('pagination')
+            pg_obj = {}
+            pg_obj[:pagination] = value
+            data_obj.merge!(pg_obj)
+          end
+          clean_obj.merge!(data_obj)
+        end
+        obj = clean_obj
+      end
+      JSON.pretty_generate(obj)
+    end
+  end
+  # rubocop:enable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity, Style/TernaryParentheses
+  # rubocop:enable Style/IfWithBooleanLiteralBranches, Style/RescueStandardError, Metrics/BlockNesting
+
+  # rubocop:disable Style/IdenticalConditionalBranches, Performance/RedundantMatch, Performance/RegexpMatch
+  def change_to_datetime(obj)
+    if obj.nil?
+      return obj
+    end
+
+    data_obj = {}
+    obj.each do |key, value|
+      obj_entry = {}
+      if value.is_a?(Array)
+        hash_array = []
+        value.each do |element|
+          hash_array << change_to_datetime(element)
+        end
+        obj_entry[key] = hash_array
+        data_obj.merge!(obj_entry)
+      else
+        if /\w(date|Date)/.match(key.to_s)
+          value = value.nil? ? value : Time.at(value)
+        end
+        obj_entry[key] = value
+        data_obj.merge!(obj_entry)
       end
-      JSON.pretty_generate(hash)
     end
+    # rubocop:disable Style/RedundantReturn
+    return data_obj
+    # rubocop:enable Style/RedundantReturn
   end
+  # rubocop:enable Style/IdenticalConditionalBranches, Performance/RedundantMatch, Performance/RegexpMatch
 end