inspec-core 5.17.4 → 5.18.14

data/lib/inspec/resources/nginx_conf.rb

@@ -50,6 +50,10 @@ module Inspec::Resources
 
     def_delegators :http, :servers, :locations
 
+    def resource_id
+      @conf_path || "nginx_conf"
+    end
+
     def to_s
       "nginx_conf #{@conf_path}"
     end

data/lib/inspec/resources/noop.rb

@@ -2,6 +2,10 @@ module Inspec::Resources
   class Noop < Inspec.resource(1)
     name "noop"
 
+    def resource_id
+      "No-op"
+    end
+
     def to_s
       "No-op"
     end

data/lib/inspec/resources/npm.rb

@@ -61,6 +61,10 @@ module Inspec::Resources
       info[:version]
     end
 
+    def resource_id
+      @package_name || "npm"
+    end
+
     def to_s
       "Npm Package #{@package_name}"
     end

data/lib/inspec/resources/ntp_conf.rb

@@ -30,6 +30,10 @@ module Inspec::Resources
       param
     end
 
+    def resource_id
+      @conf_path || "ntp_conf"
+    end
+
     def to_s
       "ntp.conf"
     end

data/lib/inspec/resources/oneget.rb

@@ -64,6 +64,10 @@ module Inspec::Resources
       info[:version]
     end
 
+    def resource_id
+      @package_name || "oneget"
+    end
+
     def to_s
       "OneGet Package #{@package_name}"
     end

data/lib/inspec/resources/opa_api.rb

@@ -6,6 +6,12 @@ module Inspec::Resources
     supports platform: "unix"
     supports platform: "windows"
 
+    example <<~EXAMPLE
+      describe opa_api(url: "localhost:8181/v1/data/example/violation", data: "input.json") do
+        its(["result"]) { should eq 'value' }
+      end
+    EXAMPLE
+
     def initialize(opts = {})
       @url = opts[:url] || nil
       @data = opts[:data] || nil
@@ -18,6 +24,10 @@ module Inspec::Resources
       @content["result"]
     end
 
+    def resource_id
+      @url || "opa_api"
+    end
+
     def to_s
       "OPA api"
     end

data/lib/inspec/resources/opa_cli.rb

@@ -6,6 +6,12 @@ module Inspec::Resources
     supports platform: "unix"
     supports platform: "windows"
 
+    example <<~EXAMPLE
+      describe opa_cli(policy: "example.rego", data: "input.json", query: "data.example.allow") do
+        its(["result"]) { should eq "value" }
+      end
+    EXAMPLE
+
     def initialize(opts = {})
       @opa_executable_path = opts[:opa_executable_path] || "opa" # if this path is not provided then we will assume that it's been set in the ENV PATH
       @policy = opts[:policy] || nil
@@ -22,6 +28,14 @@ module Inspec::Resources
       @content["result"][0]["expressions"][0]["value"] if @content["result"][0]["expressions"][0]["text"].include?("allow")
     end
 
+    def resource_id
+      if @policy.nil? && @query.nil?
+        "opa_cli"
+      else
+        "#{@policy}:#{@query}"
+      end
+    end
+
     def to_s
       "OPA cli"
     end

data/lib/inspec/resources/oracledb_conf.rb

@@ -17,6 +17,7 @@ module Inspec::Resources
 
     def initialize(opts = {})
       @oracledb_session = inspec.oracledb_session(opts)
+      @opts = opts
     end
 
     def method_missing(name)
@@ -28,6 +29,10 @@ module Inspec::Resources
       "Oracle DB Configuration"
     end
 
+    def resource_id
+      @opts[:user] || ""
+    end
+
     private
 
     def determine_database_setting(setting)

data/lib/inspec/resources/oracledb_listener_conf.rb

@@ -73,6 +73,10 @@ module Inspec::Resources
       "Oracle Listener Configuration"
     end
 
+    def resource_id
+      @conf_path
+    end
+
     private
 
     def read_content

data/lib/inspec/resources/oracledb_session.rb

@@ -76,6 +76,16 @@ module Inspec::Resources
       "Oracle Session"
     end
 
+    def resource_id
+      if @user
+        "#{@host}-#{@port}-#{@user}"
+      elsif @su_user
+        "#{@host}-#{@port}-#{@su_user}"
+      else
+        ""
+      end
+    end
+
     private
 
     # 3 commands

data/lib/inspec/resources/os.rb

@@ -27,6 +27,10 @@ module Inspec::Resources
       end
     end
 
+    def resource_id
+      @platform.name || "OS"
+    end
+
     def to_s
       "Operating System Detection"
     end

data/lib/inspec/resources/os_env.rb

@@ -47,6 +47,10 @@ module Inspec::Resources
       @content = value_for(@osenv, @target) unless @osenv.nil?
     end
 
+    def resource_id
+      @osenv || ""
+    end
+
     def to_s
       if @osenv.nil?
         "Environment variables"

data/lib/inspec/resources/package.rb

@@ -96,6 +96,10 @@ module Inspec::Resources
       @latest_version ||= ( @pkgman.latest_version(@package_name) || info[:latest_version] )
     end
 
+    def resource_id
+      @package_name || "System Package"
+    end
+
     def to_s
       "System Package #{@package_name}"
     end

data/lib/inspec/resources/parse_config.rb

@@ -68,6 +68,10 @@ module Inspec::Resources
       end
     end
 
+    def resource_id
+      @content || "parse_config"
+    end
+
     def to_s
       "Parse Config #{@conf_path}"
     end
@@ -104,8 +108,13 @@ module Inspec::Resources
     EXAMPLE
 
     def initialize(path, opts = nil)
+      @path = path
       super(nil, opts)
-      parse_file(path)
+      parse_file(@path)
+    end
+
+    def resource_id
+      @path || "parse_config_file"
     end
 
     def to_s

data/lib/inspec/resources/pip.rb

@@ -56,6 +56,10 @@ module Inspec::Resources
       info[:version]
     end
 
+    def resource_id
+      @package_name || "pip"
+    end
+
     def to_s
       "Pip Package #{@package_name}"
     end

data/lib/inspec/resources/platform.rb

@@ -93,6 +93,10 @@ module Inspec::Resources
       key.to_s.tr("-", "_").to_sym
     end
 
+    def resource_id
+      @platform.name || "platform"
+    end
+
     def to_s
       "Platform Detection"
     end

data/lib/inspec/resources/postfix_conf.rb

@@ -22,6 +22,10 @@ module Inspec::Resources
       SimpleConfig.new(content).params
     end
 
+    def resource_id
+      "Postfix Conf"
+    end
+
     def to_s
       "Postfix Mail Transfer Agent"
     end

data/lib/inspec/resources/postgres_conf.rb

@@ -64,6 +64,10 @@ module Inspec::Resources
       param
     end
 
+    def resource_id
+      @conf_path || "postgres_conf"
+    end
+
     def to_s
       "PostgreSQL Configuration"
     end

data/lib/inspec/resources/postgres_session.rb

@@ -4,9 +4,9 @@ require "shellwords" unless defined?(Shellwords)
 
 module Inspec::Resources
   class Lines
-    attr_reader :output
+    attr_reader :output, :exit_status
 
-    def initialize(raw, desc)
+    def initialize(raw, desc, exit_status)
       @output = raw
       @desc = desc
     end
@@ -58,12 +58,16 @@ module Inspec::Resources
       if cmd.exit_status != 0 && ( out =~ /could not connect to/ || out =~ /password authentication failed/ ) && out.downcase =~ /error:/
         raise Inspec::Exceptions::ResourceFailed, "PostgreSQL connection error: #{out}"
       elsif cmd.exit_status != 0 && out.downcase =~ /error:/
-        Lines.new(out, "PostgreSQL query with error: #{query}")
+        Lines.new(out, "PostgreSQL query with error: #{query}", cmd.exit_status)
       else
-        Lines.new(cmd.stdout.strip, "PostgreSQL query: #{query}")
+        Lines.new(cmd.stdout.strip, "PostgreSQL query: #{query}", cmd.exit_status)
       end
     end
 
+    def resource_id
+      "postgress_session:User:#{@user}:Host:#{@host}"
+    end
+
     private
 
     def escaped_query(query)

data/lib/inspec/resources/powershell.rb

@@ -49,6 +49,10 @@ module Inspec::Resources
     def to_s
       "Powershell"
     end
+
+    def resource_id
+      "Powershell"
+    end
   end
 
   PowershellScript = Powershell

data/lib/inspec/resources/processes.rb

@@ -43,7 +43,7 @@ module Inspec::Resources
 
       all_cmds = ps_axo
       @list = all_cmds.find_all do |hm|
-        hm[:command] =~ grep
+        hm[:command] =~ grep || hm[:process_name] =~ grep
       end
     end
 
@@ -84,6 +84,7 @@ module Inspec::Resources
       .register_column(:time,     field: "time")
       .register_column(:users,    field: "user")
       .register_column(:commands, field: "command")
+      .register_column(:process_name, field: "process_name")
       .install_filter_methods_on_resource(self, :filtered_processes)
 
     private
@@ -98,9 +99,9 @@ module Inspec::Resources
       if os.linux?
         command, regex, field_map = ps_configuration_for_linux
       elsif os.windows?
-        command = '$Proc = Get-Process -IncludeUserName | Where-Object {$_.Path -ne $null } | Select-Object PriorityClass,Id,CPU,PM,VirtualMemorySize,NPM,SessionId,Responding,StartTime,TotalProcessorTime,UserName,Path | ConvertTo-Csv -NoTypeInformation;$Proc.Replace("""","").Replace("`r`n","`n")'
+        command = '$Proc = Get-Process -IncludeUserName | Select-Object PriorityClass,Id,CPU,PM,VirtualMemorySize,NPM,SessionId,Responding,StartTime,TotalProcessorTime,UserName,Path,ProcessName | ConvertTo-Csv -NoTypeInformation;$Proc.Replace("""","").Replace("`r`n","`n")'
         # Wanted to use /(?:^|,)([^,]*)/; works on rubular.com not sure why here?
-        regex = /^(.+),(.+),(.+),(.+),(.+),(.+),(.+),(.+),(.+),(.+),(.+),(.+)$/
+        regex = /^(.*),(.*),(.*),(.*),(.*),(.*),(.*),(.*),(.*),(.*),(.*),(.*),(.*)$/
         field_map = {
           pid: 2,
           cpu: 3,
@@ -113,6 +114,7 @@ module Inspec::Resources
           time: 10,
           user: 11,
           command: 12,
+          process_name: 13,
         }
       else
         command = "ps axo pid,pcpu,pmem,vsz,rss,tty,stat,start,time,user,command"
@@ -204,7 +206,7 @@ module Inspec::Resources
 
         # build a hash of process data that we'll turn into a struct for FilterTable
         process_data = {}
-        %i{label pid cpu mem vsz rss tty stat start time user command}.each do |param|
+        %i{label pid cpu mem vsz rss tty stat start time user command process_name}.each do |param|
           # not all operating systems support all fields, so skip the field if we don't have it
           process_data[param] = line[field_map[param]] if field_map.key?(param)
         end

data/lib/inspec/resources/rabbitmq_config.rb

@@ -32,6 +32,10 @@ module Inspec::Resources
       "rabbitmq_config #{@conf_path}"
     end
 
+    def resource_id
+      @conf_path
+    end
+
     private
 
     def read_content

data/lib/inspec/resources/registry_key.rb

@@ -140,6 +140,10 @@ module Inspec::Resources
       "Registry Key #{@options[:name]}"
     end
 
+    def resource_id
+      @options[:path]
+    end
+
     private
 
     def prep_prop(property)

data/lib/inspec/resources/security_identifier.rb

@@ -51,6 +51,10 @@ module Inspec::Resources
       "Security Identifier"
     end
 
+    def resource_id
+      @name
+    end
+
     private
 
     def fetch_sids

data/lib/inspec/resources/security_policy.rb

@@ -112,6 +112,10 @@ module Inspec::Resources
       "Security Policy"
     end
 
+    def resource_id
+      "Security Policy"
+    end
+
     private
 
     def read_content

data/lib/inspec/resources/service.rb

@@ -297,6 +297,10 @@ module Inspec::Resources
       current_monitoring_tool.is_service_monitored?
     end
 
+    def resource_id
+      @service_name || "Service"
+    end
+
     def to_s
       "Service #{@service_name}"
     end

data/lib/inspec/resources/ssh_config.rb

@@ -57,6 +57,10 @@ module Inspec::Resources
       "SSH Configuration"
     end
 
+    def resource_id
+      @conf_path || "SSH Configuration"
+    end
+
     private
 
     def read_content

data/lib/inspec/resources/sybase_conf.rb

@@ -29,6 +29,10 @@ module Inspec::Resources
       sql_query.row(0).column("Config Value").value
     end
 
+    def resource_id
+      conf_param || "Sybase config settings"
+    end
+
     def to_s
       "Sybase Conf #{conf_param}"
     end

data/lib/inspec/resources/sybase_session.rb

@@ -64,6 +64,10 @@ module Inspec::Resources
       DatabaseHelper::SQLQueryResult.new(isql_cmd, parse_csv_result(isql_cmd.stdout))
     end
 
+    def resource_id
+      @database || "Sybase Session"
+    end
+
     def to_s
       "Sybase Session"
     end

data/lib/inspec/resources/sys_info.rb

@@ -112,6 +112,10 @@ module Inspec::Resources
       end
     end
 
+    def resource_id
+      "sys_info"
+    end
+
     def to_s
       "System Information"
     end

data/lib/inspec/resources/timezone.rb

@@ -52,6 +52,10 @@ module Inspec::Resources
       @output["time_offset"]
     end
 
+    def resource_id
+      "timezone"
+    end
+
     def to_s
       "Time Zone resource"
     end

data/lib/inspec/resources/users.rb

@@ -307,6 +307,10 @@ module Inspec::Resources
       shadow_information[1]
     end
 
+    def resource_id
+      @username || "User"
+    end
+
     def to_s
       "User #{@username}"
     end

data/lib/inspec/resources/vbscript.rb

@@ -51,6 +51,11 @@ module Inspec::Resources
       @result ||= parse_stdout
     end
 
+    # vbscript can be of multiple lines so that can't be used as UUID so using the hardcoded string.
+    def resource_id
+      "Windows VBScript"
+    end
+
     def to_s
       "Windows VBScript"
     end

data/lib/inspec/resources/virtualization.rb

@@ -59,6 +59,10 @@ module Inspec::Resources
       collect_data_linux
     end
 
+    def resource_id
+      @virtualization_data[:system] || "virtualization"
+    end
+
     def to_s
       "Virtualization Detection"
     end

data/lib/inspec/resources/windows_feature.rb

@@ -59,8 +59,12 @@ module Inspec::Resources
       @cache
     end
 
+    def resource_id
+      @feature
+    end
+
     def to_s
-      "Windows Feature '#{@feature}'"
+      @feature || "windows_feature"
     end
 
     private

data/lib/inspec/resources/windows_firewall.rb

@@ -21,6 +21,10 @@ module Inspec::Resources
       @state = JSON.load(cmd.stdout) unless cmd.stdout.empty?
     end
 
+    def resource_id
+      @profile || "windows_firewall"
+    end
+
     def to_s
       "Windows Firewall (Profile #{@profile})"
     end

data/lib/inspec/resources/windows_firewall_rule.rb

@@ -23,6 +23,10 @@ module Inspec::Resources
       @state = JSON.load(cmd.stdout) unless cmd.stdout.empty?
     end
 
+    def resource_id
+      @name || "windows_firewall_rule"
+    end
+
     def to_s
       "Windows Firewall Rule #{@name}"
     end

data/lib/inspec/resources/windows_hotfix.rb

@@ -24,6 +24,10 @@ module Inspec::Resources
       @content = cmd.stdout
     end
 
+    def resource_id
+      @id || "windows_hotfix"
+    end
+
     def to_s
       "Windows Hotfix #{@id}"
     end

data/lib/inspec/resources/windows_task.rb

@@ -105,6 +105,10 @@ module Inspec::Resources
       }
     end
 
+    def resource_id
+      @taskuri || "windows_task"
+    end
+
     def to_s
       "Windows Task '#{@taskuri}'"
     end

data/lib/inspec/resources/wmi.rb

@@ -95,6 +95,10 @@ module Inspec::Resources
       @content
     end
 
+    def resource_id
+      @options[:class] || "WMI"
+    end
+
     def to_s
       "WMI with #{@options}"
     end