inspec 2.1.0 → 2.1.10

data/lib/resources/inetd_conf.rb

@@ -1,62 +1,54 @@
-# encoding: utf-8
-# copyright: 2015, Vulcano Security GmbH
-
-require 'utils/simpleconfig'
-
-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.'
-    example "
-      describe inetd_conf do
-        its('shell') { should eq nil }
-        its('login') { should eq nil }
-        its('exec') { should eq nil }
-      end
-    "
-
-    def initialize(path = nil)
-      @conf_path = path || '/etc/inetd.conf'
-    end
-
-    # overwrite exec to ensure it works with its
-    # TODO: this needs to be fixed in RSpec
-    def exec
-      read_params['exec']
-    end
-
-    def method_missing(name)
-      read_params[name.to_s]
-    end
-
-    def read_params
-      return @params if defined?(@params)
-
-      # read the file
-      file = inspec.file(@conf_path)
-      if !file.file?
-        skip_resource "Can't find file \"#{@conf_path}\""
-        return @params = {}
-      end
-
-      content = file.content
-      if content.empty? && !file.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+(.*?)\s+(.*?)\s+(.*?)\s+(.*?)\s+(.*?)\s*$/,
-        key_values: 6,
-        multiple_values: false,
-      )
-      @params = conf.params
-    end
-
-    def to_s
-      'inetd.conf'
-    end
-  end
-end
+# encoding: utf-8
+# copyright: 2015, Vulcano Security GmbH
+
+require 'utils/simpleconfig'
+require '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.'
+    example "
+      describe inetd_conf do
+        its('shell') { should eq nil }
+        its('login') { should eq nil }
+        its('exec') { should eq nil }
+      end
+    "
+
+    include FileReader
+
+    def initialize(path = nil)
+      @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']
+    end
+
+    def method_missing(name)
+      read_params[name.to_s]
+    end
+
+    def read_params
+      return @params if defined?(@params)
+
+      # parse the file
+      conf = SimpleConfig.new(
+        @content,
+        assignment_regex: /^\s*(\S+?)\s+(.*?)\s+(.*?)\s+(.*?)\s+(.*?)\s+(.*?)\s+(.*?)\s*$/,
+        key_values: 6,
+        multiple_values: false,
+      )
+      @params = conf.params
+    end
+
+    def to_s
+      'inetd.conf'
+    end
+  end
+end

data/lib/resources/ini.rb

@@ -1,29 +1,29 @@
-# encoding: utf-8
-
-require '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.'
-    example "
-      descibe ini do
-        its('auth_protocol') { should eq 'https' }
-      end
-    "
-    # override file load and parse hash with simple config
-    def parse(content)
-      SimpleConfig.new(content).params
-    end
-
-    private
-
-    # 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'
-    end
-  end
-end
+# encoding: utf-8
+
+require '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.'
+    example "
+      descibe ini do
+        its('auth_protocol') { should eq 'https' }
+      end
+    "
+    # override file load and parse hash with simple config
+    def parse(content)
+      SimpleConfig.new(content).params
+    end
+
+    private
+
+    # 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'
+    end
+  end
+end

data/lib/resources/interface.rb

@@ -1,129 +1,129 @@
-# encoding: utf-8
-
-require 'utils/convert'
-
-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).'
-    example "
-      describe interface('eth0') do
-        it { should exist }
-        it { should be_up }
-        its('speed') { should eq 1000 }
-      end
-    "
-    def initialize(iface)
-      @iface = iface
-
-      @interface_provider = nil
-      if inspec.os.linux?
-        @interface_provider = LinuxInterface.new(inspec)
-      elsif inspec.os.windows?
-        @interface_provider = WindowsInterface.new(inspec)
-      else
-        return skip_resource 'The `interface` resource is not supported on your OS yet.'
-      end
-    end
-
-    def exists?
-      !interface_info.nil? && !interface_info[:name].nil?
-    end
-
-    def up?
-      interface_info.nil? ? false : interface_info[:up]
-    end
-
-    # returns link speed in Mbits/sec
-    def speed
-      interface_info.nil? ? nil : interface_info[:speed]
-    end
-
-    def to_s
-      "Interface #{@iface}"
-    end
-
-    private
-
-    def interface_info
-      return @cache if defined?(@cache)
-      @cache = @interface_provider.interface_info(@iface) if !@interface_provider.nil?
-    end
-  end
-
-  class InterfaceInfo
-    include Converter
-    attr_reader :inspec
-    def initialize(inspec)
-      @inspec = inspec
-    end
-  end
-
-  class LinuxInterface < InterfaceInfo
-    def interface_info(iface)
-      # will return "[mtu]\n1500\n[type]\n1"
-      cmd = inspec.command("find /sys/class/net/#{iface}/ -maxdepth 1 -type f -exec sh -c 'echo \"[$(basename {})]\"; cat {} || echo -n' \\;")
-      return nil if cmd.exit_status.to_i != 0
-
-      # parse values, we only recieve values, therefore we threat them as keys
-      params = SimpleConfig.new(cmd.stdout.chomp).params
-
-      # abort if we got an empty result-set
-      return nil if params.empty?
-
-      # parse state
-      state = false
-      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
-        speed = convert_to_i(speed)
-      end
-
-      {
-        name: iface,
-        up: state,
-        speed: speed,
-      }
-    end
-  end
-
-  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')
-
-      # filter network interface
-      begin
-        net_adapter = JSON.parse(cmd.stdout)
-      rescue JSON::ParserError => _e
-        return nil
-      end
-
-      # ensure we have an array of groups
-      net_adapter = [net_adapter] if !net_adapter.is_a?(Array)
-
-      # select the requested interface
-      adapters = net_adapter.each_with_object([]) do |adapter, adapter_collection|
-        # map object
-        info = {
-          name: adapter['Name'],
-          up: adapter['State'] == 2,
-          speed: adapter['ReceiveLinkSpeed'] / 1000,
-        }
-        adapter_collection.push(info) if info[:name].casecmp(iface) == 0
-      end
-
-      return nil if adapters.empty?
-      warn "[Possible Error] detected multiple network interfaces with the name #{iface}" if adapters.size > 1
-      adapters[0]
-    end
-  end
-end
+# encoding: utf-8
+
+require 'utils/convert'
+
+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).'
+    example "
+      describe interface('eth0') do
+        it { should exist }
+        it { should be_up }
+        its('speed') { should eq 1000 }
+      end
+    "
+    def initialize(iface)
+      @iface = iface
+
+      @interface_provider = nil
+      if inspec.os.linux?
+        @interface_provider = LinuxInterface.new(inspec)
+      elsif inspec.os.windows?
+        @interface_provider = WindowsInterface.new(inspec)
+      else
+        return skip_resource 'The `interface` resource is not supported on your OS yet.'
+      end
+    end
+
+    def exists?
+      !interface_info.nil? && !interface_info[:name].nil?
+    end
+
+    def up?
+      interface_info.nil? ? false : interface_info[:up]
+    end
+
+    # returns link speed in Mbits/sec
+    def speed
+      interface_info.nil? ? nil : interface_info[:speed]
+    end
+
+    def to_s
+      "Interface #{@iface}"
+    end
+
+    private
+
+    def interface_info
+      return @cache if defined?(@cache)
+      @cache = @interface_provider.interface_info(@iface) if !@interface_provider.nil?
+    end
+  end
+
+  class InterfaceInfo
+    include Converter
+    attr_reader :inspec
+    def initialize(inspec)
+      @inspec = inspec
+    end
+  end
+
+  class LinuxInterface < InterfaceInfo
+    def interface_info(iface)
+      # will return "[mtu]\n1500\n[type]\n1"
+      cmd = inspec.command("find /sys/class/net/#{iface}/ -maxdepth 1 -type f -exec sh -c 'echo \"[$(basename {})]\"; cat {} || echo -n' \\;")
+      return nil if cmd.exit_status.to_i != 0
+
+      # parse values, we only recieve values, therefore we threat them as keys
+      params = SimpleConfig.new(cmd.stdout.chomp).params
+
+      # abort if we got an empty result-set
+      return nil if params.empty?
+
+      # parse state
+      state = false
+      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
+        speed = convert_to_i(speed)
+      end
+
+      {
+        name: iface,
+        up: state,
+        speed: speed,
+      }
+    end
+  end
+
+  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')
+
+      # filter network interface
+      begin
+        net_adapter = JSON.parse(cmd.stdout)
+      rescue JSON::ParserError => _e
+        return nil
+      end
+
+      # ensure we have an array of groups
+      net_adapter = [net_adapter] if !net_adapter.is_a?(Array)
+
+      # select the requested interface
+      adapters = net_adapter.each_with_object([]) do |adapter, adapter_collection|
+        # map object
+        info = {
+          name: adapter['Name'],
+          up: adapter['State'] == 2,
+          speed: adapter['ReceiveLinkSpeed'] / 1000,
+        }
+        adapter_collection.push(info) if info[:name].casecmp(iface) == 0
+      end
+
+      return nil if adapters.empty?
+      warn "[Possible Error] detected multiple network interfaces with the name #{iface}" if adapters.size > 1
+      adapters[0]
+    end
+  end
+end

data/lib/resources/iptables.rb

@@ -1,80 +1,80 @@
-# encoding: utf-8
-
-# Usage:
-# describe iptables do
-#   it { should have_rule('-P INPUT ACCEPT') }
-# end
-#
-# The following serverspec sytax is not implemented:
-# describe iptables do
-#   it { should have_rule('-P INPUT ACCEPT').with_table('mangle').with_chain('INPUT') }
-# end
-# Please use the new sytax:
-# describe iptables(table:'mangle', chain: 'input') do
-#   it { should have_rule('-P INPUT ACCEPT') }
-# end
-#
-# Note: Docker containers normally do not have iptables installed
-#
-# @see http://ipset.netfilter.org/iptables.man.html
-# @see http://ipset.netfilter.org/iptables.man.html
-# @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.'
-    example "
-      describe iptables do
-        it { should have_rule('-P INPUT ACCEPT') }
-      end
-    "
-
-    def initialize(params = {})
-      @table = params[:table]
-      @chain = params[:chain]
-
-      # we're done if we are on linux
-      return if inspec.os.linux?
-
-      # ensures, all calls are aborted for non-supported os
-      @iptables_cache = []
-      skip_resource 'The `iptables` resource is not supported on your OS yet.'
-    end
-
-    def has_rule?(rule = nil, _table = nil, _chain = nil)
-      # checks if the rule is part of the ruleset
-      # for now, we expect an exact match
-      retrieve_rules.any? { |line| line.casecmp(rule) == 0 }
-    end
-
-    def retrieve_rules
-      return @iptables_cache if defined?(@iptables_cache)
-
-      # 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
-
-      cmd = inspec.command(iptables_cmd)
-      return [] if cmd.exit_status.to_i != 0
-
-      # split rules, returns array or rules
-      @iptables_cache = cmd.stdout.split("\n").map(&:strip)
-    end
-
-    def to_s
-      format('Iptables %s %s', @table && "table: #{@table}", @chain && "chain: #{@chain}").strip
-    end
-
-    private
-
-    def find_iptables_or_error
-      %w{/usr/sbin/iptables /sbin/iptables iptables}.each do |cmd|
-        return cmd if inspec.command(cmd).exist?
-      end
-
-      raise Inspec::Exceptions::ResourceFailed, 'Could not find `iptables`'
-    end
-  end
-end
+# encoding: utf-8
+
+# Usage:
+# describe iptables do
+#   it { should have_rule('-P INPUT ACCEPT') }
+# end
+#
+# The following serverspec sytax is not implemented:
+# describe iptables do
+#   it { should have_rule('-P INPUT ACCEPT').with_table('mangle').with_chain('INPUT') }
+# end
+# Please use the new sytax:
+# describe iptables(table:'mangle', chain: 'input') do
+#   it { should have_rule('-P INPUT ACCEPT') }
+# end
+#
+# Note: Docker containers normally do not have iptables installed
+#
+# @see http://ipset.netfilter.org/iptables.man.html
+# @see http://ipset.netfilter.org/iptables.man.html
+# @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.'
+    example "
+      describe iptables do
+        it { should have_rule('-P INPUT ACCEPT') }
+      end
+    "
+
+    def initialize(params = {})
+      @table = params[:table]
+      @chain = params[:chain]
+
+      # we're done if we are on linux
+      return if inspec.os.linux?
+
+      # ensures, all calls are aborted for non-supported os
+      @iptables_cache = []
+      skip_resource 'The `iptables` resource is not supported on your OS yet.'
+    end
+
+    def has_rule?(rule = nil, _table = nil, _chain = nil)
+      # checks if the rule is part of the ruleset
+      # for now, we expect an exact match
+      retrieve_rules.any? { |line| line.casecmp(rule) == 0 }
+    end
+
+    def retrieve_rules
+      return @iptables_cache if defined?(@iptables_cache)
+
+      # 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
+
+      cmd = inspec.command(iptables_cmd)
+      return [] if cmd.exit_status.to_i != 0
+
+      # split rules, returns array or rules
+      @iptables_cache = cmd.stdout.split("\n").map(&:strip)
+    end
+
+    def to_s
+      format('Iptables %s %s', @table && "table: #{@table}", @chain && "chain: #{@chain}").strip
+    end
+
+    private
+
+    def find_iptables_or_error
+      %w{/usr/sbin/iptables /sbin/iptables iptables}.each do |cmd|
+        return cmd if inspec.command(cmd).exist?
+      end
+
+      raise Inspec::Exceptions::ResourceFailed, 'Could not find `iptables`'
+    end
+  end
+end