inspec 2.1.0 → 2.1.10

data/lib/resources/npm.rb

@@ -1,48 +1,48 @@
-# encoding: utf-8
-
-module Inspec::Resources
-  class NpmPackage < Inspec.resource(1)
-    name 'npm'
-    supports platform: 'unix'
-    supports platform: 'windows'
-    desc 'Use the npm InSpec audit resource to test if a global npm package is installed. npm is the the package manager for Nodejs packages, such as bower and StatsD.'
-    example "
-      describe npm('bower') do
-        it { should be_installed }
-      end
-    "
-
-    def initialize(package_name)
-      @package_name = package_name
-      @cache = nil
-    end
-
-    def info
-      return @info if defined?(@info)
-
-      cmd = inspec.command("npm ls -g --json #{@package_name}")
-      @info = {
-        name: @package_name,
-        type: 'npm',
-        installed: cmd.exit_status == 0,
-      }
-      return @info unless @info[:installed]
-
-      pkgs = JSON.parse(cmd.stdout)
-      @info[:version] = pkgs['dependencies'][@package_name]['version']
-      @info
-    end
-
-    def installed?
-      info[:installed] == true
-    end
-
-    def version
-      info[:version]
-    end
-
-    def to_s
-      "Npm Package #{@package_name}"
-    end
-  end
-end
+# encoding: utf-8
+
+module Inspec::Resources
+  class NpmPackage < Inspec.resource(1)
+    name 'npm'
+    supports platform: 'unix'
+    supports platform: 'windows'
+    desc 'Use the npm InSpec audit resource to test if a global npm package is installed. npm is the the package manager for Nodejs packages, such as bower and StatsD.'
+    example "
+      describe npm('bower') do
+        it { should be_installed }
+      end
+    "
+
+    def initialize(package_name)
+      @package_name = package_name
+      @cache = nil
+    end
+
+    def info
+      return @info if defined?(@info)
+
+      cmd = inspec.command("npm ls -g --json #{@package_name}")
+      @info = {
+        name: @package_name,
+        type: 'npm',
+        installed: cmd.exit_status == 0,
+      }
+      return @info unless @info[:installed]
+
+      pkgs = JSON.parse(cmd.stdout)
+      @info[:version] = pkgs['dependencies'][@package_name]['version']
+      @info
+    end
+
+    def installed?
+      info[:installed] == true
+    end
+
+    def version
+      info[:version]
+    end
+
+    def to_s
+      "Npm Package #{@package_name}"
+    end
+  end
+end

data/lib/resources/ntp_conf.rb

@@ -1,58 +1,51 @@
-# encoding: utf-8
-# copyright: 2015, Vulcano Security GmbH
-
-require 'utils/simpleconfig'
-
-module Inspec::Resources
-  class NtpConf < Inspec.resource(1)
-    name 'ntp_conf'
-    supports platform: 'unix'
-    desc 'Use the ntp_conf InSpec audit resource to test the synchronization settings defined in the ntp.conf file. This file is typically located at /etc/ntp.conf.'
-    example "
-      describe ntp_conf do
-        its('server') { should_not eq nil }
-        its('restrict') { should include '-4 default kod notrap nomodify nopeer noquery'}
-      end
-    "
-
-    def initialize(path = nil)
-      @conf_path = path || '/etc/ntp.conf'
-    end
-
-    def method_missing(name)
-      param = read_params[name.to_s]
-      # extract first value if we have only one value in array
-      return param[0] if param.is_a?(Array) and param.length == 1
-      param
-    end
-
-    def to_s
-      'ntp.conf'
-    end
-
-    private
-
-    def read_params
-      return @params if defined?(@params)
-
-      if !inspec.file(@conf_path).file?
-        skip_resource "Can't find file \"#{@conf_path}\""
-        return @params = {}
-      end
-
-      content = inspec.file(@conf_path).content
-      if content.empty? && !inspec.file(@conf_path).empty?
-        skip_resource "Can't read file \"#{@conf_path}\""
-        return @params = {}
-      end
-
-      # parse the file
-      conf = SimpleConfig.new(
-        content,
-        assignment_regex: /^\s*(\S+)\s+(.*)\s*$/,
-        multiple_values: true,
-      )
-      @params = conf.params
-    end
-  end
-end
+# encoding: utf-8
+# copyright: 2015, Vulcano Security GmbH
+
+require 'utils/simpleconfig'
+require 'utils/file_reader'
+
+module Inspec::Resources
+  class NtpConf < Inspec.resource(1)
+    name 'ntp_conf'
+    supports platform: 'unix'
+    desc 'Use the ntp_conf InSpec audit resource to test the synchronization settings defined in the ntp.conf file. This file is typically located at /etc/ntp.conf.'
+    example "
+      describe ntp_conf do
+        its('server') { should_not eq nil }
+        its('restrict') { should include '-4 default kod notrap nomodify nopeer noquery'}
+      end
+    "
+
+    include FileReader
+
+    def initialize(path = nil)
+      @conf_path = path || '/etc/ntp.conf'
+      @content = read_file_content(@conf_path)
+    end
+
+    def method_missing(name)
+      param = read_params[name.to_s]
+      # extract first value if we have only one value in array
+      return param[0] if param.is_a?(Array) and param.length == 1
+      param
+    end
+
+    def to_s
+      'ntp.conf'
+    end
+
+    private
+
+    def read_params
+      return @params if defined?(@params)
+
+      # parse the file
+      conf = SimpleConfig.new(
+        @content,
+        assignment_regex: /^\s*(\S+)\s+(.*)\s*$/,
+        multiple_values: true,
+      )
+      @params = conf.params
+    end
+  end
+end

data/lib/resources/oneget.rb

@@ -1,71 +1,71 @@
-# encoding: utf-8
-
-# This resource talks with OneGet (https://github.com/OneGet/oneget)
-# Its part of Windows Management Framework 5.0 and part of Windows 10
-#
-# Usage:
-# describe oneget('zoomit') do
-#   it { should be_installed }
-# end
-module Inspec::Resources
-  class OneGetPackage < Inspec.resource(1)
-    name 'oneget'
-    supports platform: 'windows'
-    desc 'Use the oneget InSpec audit resource to test if the named package and/or package version is installed on the system. This resource uses OneGet, which is part of the Windows Management Framework 5.0 and Windows 10. This resource uses the Get-Package cmdlet to return all of the package names in the OneGet repository.'
-    example "
-      describe oneget('zoomit') do
-        it { should be_installed }
-        its('version') { should eq '1.2.3' }
-      end
-    "
-
-    def initialize(package_name)
-      @package_name = package_name
-
-      # verify that this resource is only supported on Windows
-      return skip_resource 'The `oneget` resource is not supported on your OS.' if !inspec.os.windows?
-    end
-
-    def info
-      return @info if defined?(@info)
-
-      @info = {}
-      @info[:type] = 'oneget'
-      @info[:installed] = false
-
-      cmd = inspec.command("Get-Package -Name '#{@package_name}' | ConvertTo-Json")
-      # cannot rely on exit code for now, successful command returns exit code 1
-      # return nil if cmd.exit_status != 0
-      # try to parse json
-
-      begin
-        pkgs = JSON.parse(cmd.stdout)
-        @info[:installed] = true
-
-        # sometimes we get multiple values
-        if pkgs.is_a?(Array)
-          # select the first entry
-          pkgs = pkgs.first
-        end
-      rescue JSON::ParserError => _e
-        return @info
-      end
-
-      @info[:name] = pkgs['Name'] if pkgs.key?('Name')
-      @info[:version] = pkgs['Version'] if pkgs.key?('Version')
-      @info
-    end
-
-    def installed?
-      info[:installed] == true
-    end
-
-    def version
-      info[:version]
-    end
-
-    def to_s
-      "OneGet Package #{@package_name}"
-    end
-  end
-end
+# encoding: utf-8
+
+# This resource talks with OneGet (https://github.com/OneGet/oneget)
+# Its part of Windows Management Framework 5.0 and part of Windows 10
+#
+# Usage:
+# describe oneget('zoomit') do
+#   it { should be_installed }
+# end
+module Inspec::Resources
+  class OneGetPackage < Inspec.resource(1)
+    name 'oneget'
+    supports platform: 'windows'
+    desc 'Use the oneget InSpec audit resource to test if the named package and/or package version is installed on the system. This resource uses OneGet, which is part of the Windows Management Framework 5.0 and Windows 10. This resource uses the Get-Package cmdlet to return all of the package names in the OneGet repository.'
+    example "
+      describe oneget('zoomit') do
+        it { should be_installed }
+        its('version') { should eq '1.2.3' }
+      end
+    "
+
+    def initialize(package_name)
+      @package_name = package_name
+
+      # verify that this resource is only supported on Windows
+      return skip_resource 'The `oneget` resource is not supported on your OS.' if !inspec.os.windows?
+    end
+
+    def info
+      return @info if defined?(@info)
+
+      @info = {}
+      @info[:type] = 'oneget'
+      @info[:installed] = false
+
+      cmd = inspec.command("Get-Package -Name '#{@package_name}' | ConvertTo-Json")
+      # cannot rely on exit code for now, successful command returns exit code 1
+      # return nil if cmd.exit_status != 0
+      # try to parse json
+
+      begin
+        pkgs = JSON.parse(cmd.stdout)
+        @info[:installed] = true
+
+        # sometimes we get multiple values
+        if pkgs.is_a?(Array)
+          # select the first entry
+          pkgs = pkgs.first
+        end
+      rescue JSON::ParserError => _e
+        return @info
+      end
+
+      @info[:name] = pkgs['Name'] if pkgs.key?('Name')
+      @info[:version] = pkgs['Version'] if pkgs.key?('Version')
+      @info
+    end
+
+    def installed?
+      info[:installed] == true
+    end
+
+    def version
+      info[:version]
+    end
+
+    def to_s
+      "OneGet Package #{@package_name}"
+    end
+  end
+end

data/lib/resources/oracledb_session.rb

@@ -1,139 +1,139 @@
-# encoding: utf-8
-
-require 'hashie/mash'
-require 'utils/database_helpers'
-require 'htmlentities'
-require 'rexml/document'
-require 'csv'
-
-module Inspec::Resources
-  # STABILITY: Experimental
-  # This resource needs further testing and refinement
-  #
-  class OracledbSession < Inspec.resource(1)
-    name 'oracledb_session'
-    supports platform: 'unix'
-    supports platform: 'windows'
-    desc 'Use the oracledb_session InSpec resource to test commands against an Oracle database'
-    example "
-      sql = oracledb_session(user: 'my_user', pass: 'password')
-      describe sql.query(\"SELECT UPPER(VALUE) AS VALUE FROM V$PARAMETER WHERE UPPER(NAME)='AUDIT_SYS_OPERATIONS'\").row(0).column('value') do
-        its('value') { should eq 'TRUE' }
-      end
-    "
-
-    attr_reader :user, :password, :host, :service
-    def initialize(opts = {})
-      @user = opts[:user]
-      @password = opts[:password] || opts[:pass]
-      if opts[:pass]
-        warn '[DEPRECATED] use `password` option to supply password instead of `pass`'
-      end
-
-      @host = opts[:host] || 'localhost'
-      @port = opts[:port] || '1521'
-      @service = opts[:service]
-
-      # we prefer sqlci although it is way slower than sqlplus, but it understands csv properly
-      @sqlcl_bin = 'sql'
-      @sqlplus_bin = opts[:sqlplus_bin] || 'sqlplus'
-
-      return skip_resource "Can't run Oracle checks without authentication" if @user.nil? || @password.nil?
-      return skip_resource 'You must provide a service name for the session' if @service.nil?
-    end
-
-    def query(q)
-      escaped_query = q.gsub(/\\/, '\\\\').gsub(/"/, '\\"')
-      # escape tables with $
-      escaped_query = escaped_query.gsub('$', '\\$')
-
-      p = nil
-      # use sqlplus if sqlcl is not available
-      if inspec.command(@sqlcl_bin).exist?
-        bin = @sqlcl_bin
-        opts = "set sqlformat csv\nSET FEEDBACK OFF"
-        p = :parse_csv_result
-      else
-        bin = @sqlplus_bin
-        opts = "SET MARKUP HTML ON\nSET FEEDBACK OFF"
-        p = :parse_html_result
-      end
-
-      query = verify_query(escaped_query)
-      query += ';' unless query.end_with?(';')
-      command = %{echo "#{opts}\n#{query}\nEXIT" | #{bin} "#{@user}"/"#{@password}"@#{@host}:#{@port}/#{@service}}
-      cmd = inspec.command(command)
-
-      out = cmd.stdout + "\n" + cmd.stderr
-      if out.downcase =~ /^error/
-        # TODO: we need to throw an exception here
-        # change once https://github.com/chef/inspec/issues/1205 is in
-        warn "Could not execute the sql query #{out}"
-        DatabaseHelper::SQLQueryResult.new(cmd, Hashie::Mash.new({}))
-      end
-      DatabaseHelper::SQLQueryResult.new(cmd, send(p, cmd.stdout))
-    end
-
-    def to_s
-      'Oracle Session'
-    end
-
-    private
-
-    def verify_query(query)
-      # ensure we have a ; at the end
-      query + ';' if !query.strip.end_with?(';')
-      query
-    end
-
-    def parse_csv_result(stdout)
-      output = stdout.delete(/\r/)
-      table = CSV.parse(output, { headers: true })
-
-      # convert to hash
-      headers = table.headers
-
-      results = table.map { |row|
-        res = {}
-        headers.each { |header|
-          res[header.downcase] = row[header]
-        }
-        Hashie::Mash.new(res)
-      }
-      results
-    end
-
-    def parse_html_result(stdout) # rubocop:disable Metrics/AbcSize
-      result = stdout
-      # make oracle html valid html by removing the p tag, it does not include a closing tag
-      result = result.gsub('<p>', '').gsub('</p>', '').gsub('<br>', '')
-      doc = REXML::Document.new result
-      table = doc.elements['table']
-      hash = []
-      if !table.nil?
-        rows = table.elements.to_a
-        headers = rows[0].elements.to_a('th').map { |entry| entry.text.strip }
-        rows.delete_at(0)
-
-        # iterate over each row, first row is header
-        hash = []
-        if !rows.nil? && !rows.empty?
-          hash = rows.map { |row|
-            res = {}
-            entries = row.elements.to_a('td')
-            # ignore if we have empty entries, oracle is adding th rows in between
-            return nil if entries.empty?
-            headers.each_with_index { |header, index|
-              # we need htmlentities since we do not have nokogiri
-              coder = HTMLEntities.new
-              val = coder.decode(entries[index].text).strip
-              res[header.downcase] = val
-            }
-            Hashie::Mash.new(res)
-          }.compact
-        end
-      end
-      hash
-    end
-  end
-end
+# encoding: utf-8
+
+require 'hashie/mash'
+require 'utils/database_helpers'
+require 'htmlentities'
+require 'rexml/document'
+require 'csv'
+
+module Inspec::Resources
+  # STABILITY: Experimental
+  # This resource needs further testing and refinement
+  #
+  class OracledbSession < Inspec.resource(1)
+    name 'oracledb_session'
+    supports platform: 'unix'
+    supports platform: 'windows'
+    desc 'Use the oracledb_session InSpec resource to test commands against an Oracle database'
+    example "
+      sql = oracledb_session(user: 'my_user', pass: 'password')
+      describe sql.query(\"SELECT UPPER(VALUE) AS VALUE FROM V$PARAMETER WHERE UPPER(NAME)='AUDIT_SYS_OPERATIONS'\").row(0).column('value') do
+        its('value') { should eq 'TRUE' }
+      end
+    "
+
+    attr_reader :user, :password, :host, :service
+    def initialize(opts = {})
+      @user = opts[:user]
+      @password = opts[:password] || opts[:pass]
+      if opts[:pass]
+        warn '[DEPRECATED] use `password` option to supply password instead of `pass`'
+      end
+
+      @host = opts[:host] || 'localhost'
+      @port = opts[:port] || '1521'
+      @service = opts[:service]
+
+      # we prefer sqlci although it is way slower than sqlplus, but it understands csv properly
+      @sqlcl_bin = 'sql'
+      @sqlplus_bin = opts[:sqlplus_bin] || 'sqlplus'
+
+      return skip_resource "Can't run Oracle checks without authentication" if @user.nil? || @password.nil?
+      return skip_resource 'You must provide a service name for the session' if @service.nil?
+    end
+
+    def query(q)
+      escaped_query = q.gsub(/\\/, '\\\\').gsub(/"/, '\\"')
+      # escape tables with $
+      escaped_query = escaped_query.gsub('$', '\\$')
+
+      p = nil
+      # use sqlplus if sqlcl is not available
+      if inspec.command(@sqlcl_bin).exist?
+        bin = @sqlcl_bin
+        opts = "set sqlformat csv\nSET FEEDBACK OFF"
+        p = :parse_csv_result
+      else
+        bin = @sqlplus_bin
+        opts = "SET MARKUP HTML ON\nSET FEEDBACK OFF"
+        p = :parse_html_result
+      end
+
+      query = verify_query(escaped_query)
+      query += ';' unless query.end_with?(';')
+      command = %{echo "#{opts}\n#{query}\nEXIT" | #{bin} "#{@user}"/"#{@password}"@#{@host}:#{@port}/#{@service}}
+      cmd = inspec.command(command)
+
+      out = cmd.stdout + "\n" + cmd.stderr
+      if out.downcase =~ /^error/
+        # TODO: we need to throw an exception here
+        # change once https://github.com/chef/inspec/issues/1205 is in
+        warn "Could not execute the sql query #{out}"
+        DatabaseHelper::SQLQueryResult.new(cmd, Hashie::Mash.new({}))
+      end
+      DatabaseHelper::SQLQueryResult.new(cmd, send(p, cmd.stdout))
+    end
+
+    def to_s
+      'Oracle Session'
+    end
+
+    private
+
+    def verify_query(query)
+      # ensure we have a ; at the end
+      query + ';' if !query.strip.end_with?(';')
+      query
+    end
+
+    def parse_csv_result(stdout)
+      output = stdout.delete(/\r/)
+      table = CSV.parse(output, { headers: true })
+
+      # convert to hash
+      headers = table.headers
+
+      results = table.map { |row|
+        res = {}
+        headers.each { |header|
+          res[header.downcase] = row[header]
+        }
+        Hashie::Mash.new(res)
+      }
+      results
+    end
+
+    def parse_html_result(stdout) # rubocop:disable Metrics/AbcSize
+      result = stdout
+      # make oracle html valid html by removing the p tag, it does not include a closing tag
+      result = result.gsub('<p>', '').gsub('</p>', '').gsub('<br>', '')
+      doc = REXML::Document.new result
+      table = doc.elements['table']
+      hash = []
+      if !table.nil?
+        rows = table.elements.to_a
+        headers = rows[0].elements.to_a('th').map { |entry| entry.text.strip }
+        rows.delete_at(0)
+
+        # iterate over each row, first row is header
+        hash = []
+        if !rows.nil? && !rows.empty?
+          hash = rows.map { |row|
+            res = {}
+            entries = row.elements.to_a('td')
+            # ignore if we have empty entries, oracle is adding th rows in between
+            return nil if entries.empty?
+            headers.each_with_index { |header, index|
+              # we need htmlentities since we do not have nokogiri
+              coder = HTMLEntities.new
+              val = coder.decode(entries[index].text).strip
+              res[header.downcase] = val
+            }
+            Hashie::Mash.new(res)
+          }.compact
+        end
+      end
+      hash
+    end
+  end
+end