inspec-core 4.3.2 → 4.6.3

data/lib/{resources → inspec/resources}/inetd_conf.rb

@@ -1,14 +1,13 @@
-# encoding: utf-8
 # copyright: 2015, Vulcano Security GmbH
 
-require 'utils/simpleconfig'
-require 'utils/file_reader'
+require "inspec/utils/simpleconfig"
+require "inspec/utils/file_reader"
 
 module Inspec::Resources
   class InetdConf < Inspec.resource(1)
-    name 'inetd_conf'
-    supports platform: 'unix'
-    desc 'Use the inetd_conf InSpec audit resource to test if a service is enabled in the inetd.conf file on Linux and UNIX platforms. inetd---the Internet service daemon---listens on dedicated ports, and then loads the appropriate program based on a request. The inetd.conf file is typically located at /etc/inetd.conf and contains a list of Internet services associated to the ports on which that service will listen. Only enabled services may handle a request; only services that are required by the system should be enabled.'
+    name "inetd_conf"
+    supports platform: "unix"
+    desc "Use the inetd_conf InSpec audit resource to test if a service is enabled in the inetd.conf file on Linux and UNIX platforms. inetd---the Internet service daemon---listens on dedicated ports, and then loads the appropriate program based on a request. The inetd.conf file is typically located at /etc/inetd.conf and contains a list of Internet services associated to the ports on which that service will listen. Only enabled services may handle a request; only services that are required by the system should be enabled."
     example <<~EXAMPLE
       describe inetd_conf do
         its('shell') { should eq nil }
@@ -20,14 +19,14 @@ module Inspec::Resources
     include FileReader
 
     def initialize(path = nil)
-      @conf_path = path || '/etc/inetd.conf'
+      @conf_path = path || "/etc/inetd.conf"
       @content = read_file_content(@conf_path)
     end
 
     # overwrite exec to ensure it works with its
     # TODO: this needs to be fixed in RSpec
     def exec
-      read_params['exec']
+      read_params["exec"]
     end
 
     def method_missing(name)
@@ -42,13 +41,13 @@ module Inspec::Resources
         @content,
         assignment_regex: /^\s*(\S+?)\s+(.*?)\s+(.*?)\s+(.*?)\s+(.*?)\s+(.*?)\s+(.*?)\s*$/,
         key_values: 6,
-        multiple_values: false,
+        multiple_values: false
       )
       @params = conf.params
     end
 
     def to_s
-      'inetd.conf'
+      "inetd.conf"
     end
   end
 end

data/lib/{resources → inspec/resources}/ini.rb

@@ -1,13 +1,12 @@
-# encoding: utf-8
-
-require 'utils/simpleconfig'
+require "inspec/resources/json"
+require "inspec/utils/simpleconfig"
 
 module Inspec::Resources
   class IniConfig < JsonConfig
-    name 'ini'
-    supports platform: 'unix'
-    supports platform: 'windows'
-    desc 'Use the ini InSpec audit resource to test data in a INI file.'
+    name "ini"
+    supports platform: "unix"
+    supports platform: "windows"
+    desc "Use the ini InSpec audit resource to test data in a INI file."
     example <<~EXAMPLE
       descibe ini do
         its('auth_protocol') { should eq 'https' }
@@ -23,7 +22,7 @@ module Inspec::Resources
     # used by JsonConfig to build up a full to_s method
     # based on whether a file path, content, or command was supplied.
     def resource_base_name
-      'INI'
+      "INI"
     end
   end
 end

data/lib/{resources → inspec/resources}/interface.rb

@@ -1,13 +1,13 @@
-# encoding: utf-8
-
-require 'utils/convert'
+require "inspec/resources/command"
+require "inspec/utils/convert"
+require "inspec/utils/simpleconfig"
 
 module Inspec::Resources
   class NetworkInterface < Inspec.resource(1)
-    name 'interface'
-    supports platform: 'unix'
-    supports platform: 'windows'
-    desc 'Use the interface InSpec audit resource to test basic network adapter properties, such as name, status, and link speed (in MB/sec).'
+    name "interface"
+    supports platform: "unix"
+    supports platform: "windows"
+    desc "Use the interface InSpec audit resource to test basic network adapter properties, such as name, status, and link speed (in MB/sec)."
     example <<~EXAMPLE
       describe interface('eth0') do
         it { should exist }
@@ -26,7 +26,7 @@ module Inspec::Resources
       elsif inspec.os.windows?
         @interface_provider = WindowsInterface.new(inspec)
       else
-        return skip_resource 'The `interface` resource is not supported on your OS yet.'
+        return skip_resource "The `interface` resource is not supported on your OS yet."
       end
     end
 
@@ -52,15 +52,15 @@ module Inspec::Resources
     end
 
     def ipv4_addresses
-      ipv4_cidrs.map { |i| i.split('/')[0] }
+      ipv4_cidrs.map { |i| i.split("/")[0] }
     end
 
     def ipv6_addresses
-      ipv6_cidrs.map { |i| i.split('/')[0] }
+      ipv6_cidrs.map { |i| i.split("/")[0] }
     end
 
     def ipv4_addresses_netmask
-      ipv4_cidrs.map { |i| i.split('/') }.map do |addr, netlen|
+      ipv4_cidrs.map { |i| i.split("/") }.map do |addr, netlen|
         binmask = "#{'1' * netlen.to_i}#{'0' * (32 - netlen.to_i)}".to_i(2)
         netmask = []
         (1..4).each do |_byte|
@@ -113,15 +113,15 @@ module Inspec::Resources
 
       # parse state
       state = false
-      if params.key?('operstate')
-        operstate, _value = params['operstate'].first
-        state = operstate == 'up'
+      if params.key?("operstate")
+        operstate, _value = params["operstate"].first
+        state = operstate == "up"
       end
 
       # parse speed
       speed = nil
-      if params.key?('speed')
-        speed, _value = params['speed'].first
+      if params.key?("speed")
+        speed, _value = params["speed"].first
         speed = convert_to_i(speed)
       end
 
@@ -130,19 +130,19 @@ module Inspec::Resources
         name: iface,
         up: state,
         speed: speed,
-        ipv4_addresses: family_addresses['inet'],
-        ipv6_addresses: family_addresses['inet6'],
+        ipv4_addresses: family_addresses["inet"],
+        ipv6_addresses: family_addresses["inet6"],
       }
     end
 
     private
 
     def addresses(iface)
-      addrs_by_family = { 'inet6' => [], 'inet' => [] }
+      addrs_by_family = { "inet6" => [], "inet" => [] }
       [4, 6].each do |v|
         cmd = inspec.command("/sbin/ip -br -#{v} address show dev #{iface}")
         next unless cmd.exit_status.to_i == 0
-        family = v == 6 ? 'inet6' : 'inet'
+        family = v == 6 ? "inet6" : "inet"
 
         cmd.stdout.each_line do |line|
           _dev, _state, *addrs = line.split(/\s+/)
@@ -156,11 +156,11 @@ module Inspec::Resources
   class WindowsInterface < InterfaceInfo
     def interface_info(iface)
       # gather all network interfaces
-      cmd = inspec.command('Get-NetAdapter | Select-Object -Property Name, InterfaceDescription, Status, State, ' \
-                           'MacAddress, LinkSpeed, ReceiveLinkSpeed, TransmitLinkSpeed, Virtual | ConvertTo-Json')
+      cmd = inspec.command("Get-NetAdapter | Select-Object -Property Name, InterfaceDescription, Status, State, " \
+                           "MacAddress, LinkSpeed, ReceiveLinkSpeed, TransmitLinkSpeed, Virtual | ConvertTo-Json")
 
-      addr_cmd = inspec.command('Get-NetIPAddress | Select-Object -Property IPv6Address, IPv4Address, InterfaceAlias,' \
-                                ' PrefixLength | ConvertTo-Json')
+      addr_cmd = inspec.command("Get-NetIPAddress | Select-Object -Property IPv6Address, IPv4Address, InterfaceAlias," \
+                                " PrefixLength | ConvertTo-Json")
 
       # filter network interface
       begin
@@ -178,11 +178,11 @@ module Inspec::Resources
       adapters = net_adapter.each_with_object([]) do |adapter, adapter_collection|
         # map object
         info = {
-          name: adapter['Name'],
-          up: adapter['State'] == 2,
-          speed: adapter['ReceiveLinkSpeed'] / 1000,
-          ipv4_addresses: addresses_for_proto(addresses, adapter['Name'], 'IPv4'),
-          ipv6_addresses: addresses_for_proto(addresses, adapter['Name'], 'IPv6'),
+          name: adapter["Name"],
+          up: adapter["State"] == 2,
+          speed: adapter["ReceiveLinkSpeed"] / 1000,
+          ipv4_addresses: addresses_for_proto(addresses, adapter["Name"], "IPv4"),
+          ipv6_addresses: addresses_for_proto(addresses, adapter["Name"], "IPv6"),
         }
         adapter_collection.push(info) if info[:name].casecmp(iface) == 0
       end
@@ -195,7 +195,7 @@ module Inspec::Resources
     private
 
     def addresses_for_proto(all_addresses, iface, proto)
-      all_addresses.select { |i| i['InterfaceAlias'] == iface }
+      all_addresses.select { |i| i["InterfaceAlias"] == iface }
                    .map { |i| "#{i["#{proto}Address"]}/#{i['PrefixLength']}" unless i["#{proto}Address"].nil? }
                    .compact
     end

data/lib/{resources → inspec/resources}/iptables.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+require "inspec/resources/command"
 
 # Usage:
 # describe iptables do
@@ -21,9 +21,9 @@
 # @see https://www.frozentux.net/iptables-tutorial/iptables-tutorial.html
 module Inspec::Resources
   class IpTables < Inspec.resource(1)
-    name 'iptables'
-    supports platform: 'linux'
-    desc 'Use the iptables InSpec audit resource to test rules that are defined in iptables, which maintains tables of IP packet filtering rules. There may be more than one table. Each table contains one (or more) chains (both built-in and custom). A chain is a list of rules that match packets. When the rule matches, the rule defines what target to assign to the packet.'
+    name "iptables"
+    supports platform: "linux"
+    desc "Use the iptables InSpec audit resource to test rules that are defined in iptables, which maintains tables of IP packet filtering rules. There may be more than one table. Each table contains one (or more) chains (both built-in and custom). A chain is a list of rules that match packets. When the rule matches, the rule defines what target to assign to the packet."
     example <<~EXAMPLE
       describe iptables do
         it { should have_rule('-P INPUT ACCEPT') }
@@ -39,7 +39,7 @@ module Inspec::Resources
 
       # ensures, all calls are aborted for non-supported os
       @iptables_cache = []
-      skip_resource 'The `iptables` resource is not supported on your OS yet.'
+      skip_resource "The `iptables` resource is not supported on your OS yet."
     end
 
     def has_rule?(rule = nil, _table = nil, _chain = nil)
@@ -54,7 +54,7 @@ module Inspec::Resources
       # construct iptables command to read all rules
       bin = find_iptables_or_error
       table_cmd = "-t #{@table}" if @table
-      iptables_cmd = format('%s %s -S %s', bin, table_cmd, @chain).strip
+      iptables_cmd = format("%s %s -S %s", bin, table_cmd, @chain).strip
 
       cmd = inspec.command(iptables_cmd)
       return [] if cmd.exit_status.to_i != 0
@@ -64,7 +64,7 @@ module Inspec::Resources
     end
 
     def to_s
-      format('Iptables %s %s', @table && "table: #{@table}", @chain && "chain: #{@chain}").strip
+      format("Iptables %s %s", @table && "table: #{@table}", @chain && "chain: #{@chain}").strip
     end
 
     private
@@ -74,7 +74,7 @@ module Inspec::Resources
         return cmd if inspec.command(cmd).exist?
       end
 
-      raise Inspec::Exceptions::ResourceFailed, 'Could not find `iptables`'
+      raise Inspec::Exceptions::ResourceFailed, "Could not find `iptables`"
     end
   end
 end

data/lib/{resources → inspec/resources}/json.rb

@@ -1,13 +1,11 @@
-# encoding: utf-8
-
-require 'utils/object_traversal'
-require 'utils/enumerable_delegation'
-require 'utils/file_reader'
+require "inspec/utils/object_traversal"
+require "inspec/utils/enumerable_delegation"
+require "inspec/utils/file_reader"
 
 module Inspec::Resources
   class JsonConfig < Inspec.resource(1)
-    name 'json'
-    desc 'Use the json InSpec audit resource to test data in a JSON file.'
+    name "json"
+    desc "Use the json InSpec audit resource to test data in a JSON file."
     example <<~EXAMPLE
       describe json('policyfile.lock.json') do
         its(['cookbook_locks','omnibus','version']) { should eq('2.2.0') }
@@ -67,7 +65,7 @@ module Inspec::Resources
     private
 
     def parse(content)
-      require 'json'
+      require "json"
       JSON.parse(content)
     rescue => e
       raise Inspec::Exceptions::ResourceFailed, "Unable to parse JSON: #{e.message}"
@@ -86,7 +84,7 @@ module Inspec::Resources
       elsif opts.key?(:content)
         opts[:content]
       else
-        raise Inspec::Exceptions::ResourceFailed, 'No JSON content; must specify a file, command, or raw JSON content'
+        raise Inspec::Exceptions::ResourceFailed, "No JSON content; must specify a file, command, or raw JSON content"
       end
     end
 
@@ -104,7 +102,7 @@ module Inspec::Resources
     # for resources the subclass JsonConfig, this allows specification of the resource
     # base name in each subclass so we can build a good to_s method
     def resource_base_name
-      'JSON'
+      "JSON"
     end
   end
 end

data/lib/{resources → inspec/resources}/kernel_module.rb

@@ -1,9 +1,9 @@
-# encoding: utf-8
+require "inspec/resources/command"
 
 module Inspec::Resources
   class KernelModule < Inspec.resource(1)
-    name 'kernel_module'
-    supports platform: 'unix'
+    name "kernel_module"
+    supports platform: "unix"
     desc 'Use the kernel_module InSpec audit resource to test kernel modules on
     Linux platforms. These parameters are located under /lib/modules. Any submodule
     may be tested using this resource.
@@ -36,14 +36,14 @@ module Inspec::Resources
     def initialize(modulename = nil)
       @module = modulename
       # this resource is only supported on Linux
-      return skip_resource 'The `kernel_parameter` resource is not supported on your OS.' if !inspec.os.linux?
+      return skip_resource "The `kernel_parameter` resource is not supported on your OS." if !inspec.os.linux?
     end
 
     def loaded?
-      if inspec.os.redhat? || inspec.os.name == 'fedora'
-        lsmod_cmd = '/sbin/lsmod'
+      if inspec.os.redhat? || inspec.os.name == "fedora"
+        lsmod_cmd = "/sbin/lsmod"
       else
-        lsmod_cmd = 'lsmod'
+        lsmod_cmd = "lsmod"
       end
 
       # get list of all modules
@@ -51,7 +51,7 @@ module Inspec::Resources
       return false if cmd.exit_status != 0
 
       # check if module is loaded
-      re = Regexp.new('^'+Regexp.quote(@module)+'\s')
+      re = Regexp.new("^" + Regexp.quote(@module) + '\s')
       found = cmd.stdout.match(re)
       !found.nil?
     end
@@ -66,7 +66,7 @@ module Inspec::Resources
 
     def version
       cmd = inspec.command("#{modinfo_cmd_for_os} -F version #{@module}")
-      cmd.exit_status.zero? ? cmd.stdout.delete("\n") : nil
+      cmd.exit_status == 0 ? cmd.stdout.delete("\n") : nil
     end
 
     def to_s
@@ -80,18 +80,18 @@ module Inspec::Resources
     end
 
     def modinfo_cmd_for_os
-      if inspec.os.redhat? || inspec.os.name == 'fedora'
-        '/sbin/modinfo'
+      if inspec.os.redhat? || inspec.os.name == "fedora"
+        "/sbin/modinfo"
       else
-        'modinfo'
+        "modinfo"
       end
     end
 
     def modprobe_cmd_for_os
-      if inspec.os.redhat? || inspec.os.name == 'fedora'
-        '/sbin/modprobe'
+      if inspec.os.redhat? || inspec.os.name == "fedora"
+        "/sbin/modprobe"
       else
-        'modprobe'
+        "modprobe"
       end
     end
 

data/lib/{resources → inspec/resources}/kernel_parameter.rb

@@ -1,10 +1,10 @@
-# encoding: utf-8
+require "inspec/resources/command"
 
 module Inspec::Resources
   class KernelParameter < Inspec.resource(1)
-    name 'kernel_parameter'
-    supports platform: 'unix'
-    desc 'Use the kernel_parameter InSpec audit resource to test kernel parameters on Linux platforms.'
+    name "kernel_parameter"
+    supports platform: "unix"
+    desc "Use the kernel_parameter InSpec audit resource to test kernel parameters on Linux platforms."
     example <<~EXAMPLE
       describe kernel_parameter('net.ipv4.conf.all.forwarding') do
         its('value') { should eq 0 }
@@ -15,7 +15,7 @@ module Inspec::Resources
       @parameter = parameter
 
       # this resource is only supported on Linux
-      return skip_resource 'The `kernel_parameter` resource is not supported on your OS.' if !inspec.os.linux?
+      return skip_resource "The `kernel_parameter` resource is not supported on your OS." if !inspec.os.linux?
     end
 
     def value
@@ -34,15 +34,15 @@ module Inspec::Resources
   end
 
   class LinuxKernelParameter < KernelParameter
-    name 'linux_kernel_parameter'
+    name "linux_kernel_parameter"
 
     def initialize(parameter)
-      Inspec.deprecate(:resource_linux_kernel_parameter, 'The `linux_kernel_parameter` resource is deprecated. Please use `kernel_parameter`')
+      Inspec.deprecate(:resource_linux_kernel_parameter, "The `linux_kernel_parameter` resource is deprecated. Please use `kernel_parameter`")
       super(parameter)
     end
 
     def value
-      Inspec.deprecate(:resource_linux_kernel_parameter, 'The `linux_kernel_parameter` resource is deprecated. Please use `kernel_parameter`')
+      Inspec.deprecate(:resource_linux_kernel_parameter, "The `linux_kernel_parameter` resource is deprecated. Please use `kernel_parameter`")
       super()
     end
 

data/lib/{resources → inspec/resources}/key_rsa.rb

@@ -1,16 +1,14 @@
-# encoding: utf-8
-
-require 'openssl'
-require 'hashie/mash'
-require 'utils/file_reader'
-require 'utils/pkey_reader'
+require "openssl"
+require "hashie/mash"
+require "inspec/utils/file_reader"
+require "inspec/utils/pkey_reader"
 
 module Inspec::Resources
   class RsaKey < Inspec.resource(1)
-    name 'key_rsa'
-    supports platform: 'unix'
-    supports platform: 'windows'
-    desc 'public/private RSA key pair test'
+    name "key_rsa"
+    supports platform: "unix"
+    supports platform: "windows"
+    desc "public/private RSA key pair test"
     example <<~EXAMPLE
       describe key_rsa('/etc/pki/www.mywebsite.com.key') do
         its('public_key') { should match /BEGIN RSA PUBLIC KEY/ }