inspec 2.1.21 → 2.1.30

data/lib/resources/bridge.rb

@@ -1,122 +1,122 @@
-# encoding: utf-8
-
-# Usage:
-# describe bridge('br0') do
-#   it { should exist }
-#   it { should have_interface 'eth0' }
-# end
-
-module Inspec::Resources
-  class Bridge < Inspec.resource(1)
-    name 'bridge'
-    supports platform: 'unix'
-    desc 'Use the bridge InSpec audit resource to test basic network bridge properties, such as name, if an interface is defined, and the associations for any defined interface.'
-    example "
-      describe bridge 'br0' do
-        it { should exist }
-        it { should have_interface 'eth0' }
-      end
-    "
-
-    def initialize(bridge_name)
-      @bridge_name = bridge_name
-
-      @bridge_provider = nil
-      if inspec.os.linux?
-        @bridge_provider = LinuxBridge.new(inspec)
-      elsif inspec.os.windows?
-        @bridge_provider = WindowsBridge.new(inspec)
-      else
-        return skip_resource 'The `bridge` resource is not supported on your OS yet.'
-      end
-    end
-
-    def exists?
-      !bridge_info.nil? && !bridge_info[:name].nil?
-    end
-
-    def has_interface?(interface)
-      return skip_resource 'The `bridge` resource does not provide interface detection for Windows yet' if inspec.os.windows?
-      bridge_info.nil? ? false : bridge_info[:interfaces].include?(interface)
-    end
-
-    def interfaces
-      bridge_info.nil? ? nil : bridge_info[:interfaces]
-    end
-
-    def to_s
-      "Bridge #{@bridge_name}"
-    end
-
-    private
-
-    def bridge_info
-      return @cache if defined?(@cache)
-      @cache = @bridge_provider.bridge_info(@bridge_name) if !@bridge_provider.nil?
-    end
-  end
-
-  class BridgeDetection
-    attr_reader :inspec
-    def initialize(inspec)
-      @inspec = inspec
-    end
-  end
-
-  # Linux Bridge
-  # If /sys/class/net/{interface}/bridge exists then it must be a bridge
-  # /sys/class/net/{interface}/brif contains the network interfaces
-  # @see http://www.tldp.org/HOWTO/BRIDGE-STP-HOWTO/set-up-the-bridge.html
-  # @see http://unix.stackexchange.com/questions/40560/how-to-know-if-a-network-interface-is-tap-tun-bridge-or-physical
-  class LinuxBridge < BridgeDetection
-    def bridge_info(bridge_name)
-      # read bridge information
-      bridge = inspec.file("/sys/class/net/#{bridge_name}/bridge").directory?
-      return nil unless bridge
-
-      # load interface names
-      interfaces = inspec.command("ls -1 /sys/class/net/#{bridge_name}/brif/")
-      interfaces = interfaces.stdout.chomp.split("\n")
-      {
-        name: bridge_name,
-        interfaces: interfaces,
-      }
-    end
-  end
-
-  # Windows Bridge
-  # select netadapter by adapter binding for windows
-  # Get-NetAdapterBinding -ComponentID ms_bridge | Get-NetAdapter
-  # @see https://technet.microsoft.com/en-us/library/jj130921(v=wps.630).aspx
-  # RegKeys: HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\Class\{4D36E972-E325-11CE-BFC1-08002BE10318}
-  class WindowsBridge < BridgeDetection
-    def bridge_info(bridge_name)
-      # find all bridge adapters
-      cmd = inspec.command('Get-NetAdapterBinding -ComponentID ms_bridge | Get-NetAdapter | Select-Object -Property Name, InterfaceDescription | ConvertTo-Json')
-
-      # filter network interface
-      begin
-        bridges = JSON.parse(cmd.stdout)
-      rescue JSON::ParserError => _e
-        return nil
-      end
-
-      # ensure we have an array of groups
-      bridges = [bridges] if !bridges.is_a?(Array)
-
-      # select the requested interface
-      bridges = bridges.each_with_object([]) do |adapter, adapter_collection|
-        # map object
-        info = {
-          name: adapter['Name'],
-          interfaces: nil,
-        }
-        adapter_collection.push(info) if info[:name].casecmp(bridge_name) == 0
-      end
-
-      return nil if bridges.empty?
-      warn "[Possible Error] detected multiple bridges interfaces with the name #{bridge_name}" if bridges.size > 1
-      bridges[0]
-    end
-  end
-end
+# encoding: utf-8
+
+# Usage:
+# describe bridge('br0') do
+#   it { should exist }
+#   it { should have_interface 'eth0' }
+# end
+
+module Inspec::Resources
+  class Bridge < Inspec.resource(1)
+    name 'bridge'
+    supports platform: 'unix'
+    desc 'Use the bridge InSpec audit resource to test basic network bridge properties, such as name, if an interface is defined, and the associations for any defined interface.'
+    example "
+      describe bridge 'br0' do
+        it { should exist }
+        it { should have_interface 'eth0' }
+      end
+    "
+
+    def initialize(bridge_name)
+      @bridge_name = bridge_name
+
+      @bridge_provider = nil
+      if inspec.os.linux?
+        @bridge_provider = LinuxBridge.new(inspec)
+      elsif inspec.os.windows?
+        @bridge_provider = WindowsBridge.new(inspec)
+      else
+        return skip_resource 'The `bridge` resource is not supported on your OS yet.'
+      end
+    end
+
+    def exists?
+      !bridge_info.nil? && !bridge_info[:name].nil?
+    end
+
+    def has_interface?(interface)
+      return skip_resource 'The `bridge` resource does not provide interface detection for Windows yet' if inspec.os.windows?
+      bridge_info.nil? ? false : bridge_info[:interfaces].include?(interface)
+    end
+
+    def interfaces
+      bridge_info.nil? ? nil : bridge_info[:interfaces]
+    end
+
+    def to_s
+      "Bridge #{@bridge_name}"
+    end
+
+    private
+
+    def bridge_info
+      return @cache if defined?(@cache)
+      @cache = @bridge_provider.bridge_info(@bridge_name) if !@bridge_provider.nil?
+    end
+  end
+
+  class BridgeDetection
+    attr_reader :inspec
+    def initialize(inspec)
+      @inspec = inspec
+    end
+  end
+
+  # Linux Bridge
+  # If /sys/class/net/{interface}/bridge exists then it must be a bridge
+  # /sys/class/net/{interface}/brif contains the network interfaces
+  # @see http://www.tldp.org/HOWTO/BRIDGE-STP-HOWTO/set-up-the-bridge.html
+  # @see http://unix.stackexchange.com/questions/40560/how-to-know-if-a-network-interface-is-tap-tun-bridge-or-physical
+  class LinuxBridge < BridgeDetection
+    def bridge_info(bridge_name)
+      # read bridge information
+      bridge = inspec.file("/sys/class/net/#{bridge_name}/bridge").directory?
+      return nil unless bridge
+
+      # load interface names
+      interfaces = inspec.command("ls -1 /sys/class/net/#{bridge_name}/brif/")
+      interfaces = interfaces.stdout.chomp.split("\n")
+      {
+        name: bridge_name,
+        interfaces: interfaces,
+      }
+    end
+  end
+
+  # Windows Bridge
+  # select netadapter by adapter binding for windows
+  # Get-NetAdapterBinding -ComponentID ms_bridge | Get-NetAdapter
+  # @see https://technet.microsoft.com/en-us/library/jj130921(v=wps.630).aspx
+  # RegKeys: HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\Class\{4D36E972-E325-11CE-BFC1-08002BE10318}
+  class WindowsBridge < BridgeDetection
+    def bridge_info(bridge_name)
+      # find all bridge adapters
+      cmd = inspec.command('Get-NetAdapterBinding -ComponentID ms_bridge | Get-NetAdapter | Select-Object -Property Name, InterfaceDescription | ConvertTo-Json')
+
+      # filter network interface
+      begin
+        bridges = JSON.parse(cmd.stdout)
+      rescue JSON::ParserError => _e
+        return nil
+      end
+
+      # ensure we have an array of groups
+      bridges = [bridges] if !bridges.is_a?(Array)
+
+      # select the requested interface
+      bridges = bridges.each_with_object([]) do |adapter, adapter_collection|
+        # map object
+        info = {
+          name: adapter['Name'],
+          interfaces: nil,
+        }
+        adapter_collection.push(info) if info[:name].casecmp(bridge_name) == 0
+      end
+
+      return nil if bridges.empty?
+      warn "[Possible Error] detected multiple bridges interfaces with the name #{bridge_name}" if bridges.size > 1
+      bridges[0]
+    end
+  end
+end

data/lib/resources/chocolatey_package.rb

@@ -0,0 +1,78 @@
+# encoding: utf-8
+# frozen_string_literal: true
+
+# Check for Chocolatey packages to be installed
+module Inspec::Resources
+  class ChocoPkg < Inspec.resource(1)
+    name 'chocolatey_package'
+    supports platform: 'windows'
+    desc 'Use the chocolatey_package Inspec audit resource to test if the named package and/or package version is installed on the system.'
+    example <<-EOH
+      describe chocolatey_package('git') do
+        it { should be_installed }
+        its('version') { should eq '2.15.1' }
+      end
+    EOH
+
+    attr_reader :package_name
+
+    def initialize(package_name, _opts = {})
+      raise 'Chocolatey is not installed' unless inspec.command('choco').exist?
+      @package_name = package_name
+      @cache = base_data.update(generate_cache)
+    end
+
+    def installed?
+      @cache[:installed]
+    end
+
+    def info
+      @cache.dup
+    end
+
+    def respond_to_missing?(method_name, *)
+      @cache.key?(method_name) || super
+    end
+
+    def method_missing(method_name, *args, &block)
+      if @cache.key?(method_name)
+        @cache.fetch(method_name)
+      else
+        super
+      end
+    end
+
+    def to_s
+      "Chocolatey package #{package_name}"
+    end
+
+    private
+
+    def base_data
+      {
+        name: package_name,
+        version: nil,
+        installed: false,
+        type: 'chocolatey',
+      }
+    end
+
+    def generate_cache
+      command = <<-EOH
+      (choco list --local-only --exact --include-programs --limit-output '#{package_name.gsub("'", "\`'")}') -Replace "\\|", "=" | ConvertFrom-StringData | ConvertTo-JSON
+      EOH
+
+      cmd = inspec.powershell(command.strip)
+
+      return {} if cmd.exit_status != 0 || cmd.stdout.strip.empty?
+      out = JSON.parse(cmd.stdout)
+
+      return {
+        version: out.fetch(package_name),
+        installed: true,
+      }
+    rescue JSON::ParserError, KeyError
+      return {}
+    end
+  end
+end

data/lib/resources/command.rb

@@ -1,73 +1,73 @@
-# encoding: utf-8
-# copyright: 2015, Vulcano Security GmbH
-
-module Inspec::Resources
-  class Cmd < Inspec.resource(1)
-    name 'command'
-    supports platform: 'unix'
-    supports platform: 'windows'
-    desc 'Use the command InSpec audit resource to test an arbitrary command that is run on the system.'
-    example "
-      describe command('ls -al /') do
-        its('stdout') { should match /bin/ }
-        its('stderr') { should eq '' }
-        its('exit_status') { should eq 0 }
-      end
-
-      command('ls -al /').exist? will return false. Existence of command should be checked this way.
-      describe command('ls') do
-        it { should exist }
-      end
-    "
-
-    attr_reader :command
-
-    def initialize(cmd)
-      if cmd.nil?
-        raise 'InSpec `command` was called with `nil` as the argument. This is not supported. Please provide a valid command instead.'
-      end
-      @command = cmd
-    end
-
-    def result
-      @result ||= inspec.backend.run_command(@command)
-    end
-
-    def stdout
-      result.stdout
-    end
-
-    def stderr
-      result.stderr
-    end
-
-    def exit_status
-      result.exit_status.to_i
-    end
-
-    def exist? # rubocop:disable Metrics/AbcSize
-      # silent for mock resources
-      return false if inspec.os.name.nil? || inspec.os.name == 'mock'
-
-      if inspec.os.linux?
-        res = if inspec.platform.name == 'alpine'
-                inspec.backend.run_command("which \"#{@command}\"")
-              else
-                inspec.backend.run_command("bash -c 'type \"#{@command}\"'")
-              end
-      elsif inspec.os.windows?
-        res = inspec.backend.run_command("Get-Command \"#{@command}\"")
-      elsif inspec.os.unix?
-        res = inspec.backend.run_command("type \"#{@command}\"")
-      else
-        warn "`command(#{@command}).exist?` is not supported on your OS: #{inspec.os[:name]}"
-        return false
-      end
-      res.exit_status.to_i == 0
-    end
-
-    def to_s
-      "Command #{@command}"
-    end
-  end
-end
+# encoding: utf-8
+# copyright: 2015, Vulcano Security GmbH
+
+module Inspec::Resources
+  class Cmd < Inspec.resource(1)
+    name 'command'
+    supports platform: 'unix'
+    supports platform: 'windows'
+    desc 'Use the command InSpec audit resource to test an arbitrary command that is run on the system.'
+    example "
+      describe command('ls -al /') do
+        its('stdout') { should match /bin/ }
+        its('stderr') { should eq '' }
+        its('exit_status') { should eq 0 }
+      end
+
+      command('ls -al /').exist? will return false. Existence of command should be checked this way.
+      describe command('ls') do
+        it { should exist }
+      end
+    "
+
+    attr_reader :command
+
+    def initialize(cmd)
+      if cmd.nil?
+        raise 'InSpec `command` was called with `nil` as the argument. This is not supported. Please provide a valid command instead.'
+      end
+      @command = cmd
+    end
+
+    def result
+      @result ||= inspec.backend.run_command(@command)
+    end
+
+    def stdout
+      result.stdout
+    end
+
+    def stderr
+      result.stderr
+    end
+
+    def exit_status
+      result.exit_status.to_i
+    end
+
+    def exist? # rubocop:disable Metrics/AbcSize
+      # silent for mock resources
+      return false if inspec.os.name.nil? || inspec.os.name == 'mock'
+
+      if inspec.os.linux?
+        res = if inspec.platform.name == 'alpine'
+                inspec.backend.run_command("which \"#{@command}\"")
+              else
+                inspec.backend.run_command("bash -c 'type \"#{@command}\"'")
+              end
+      elsif inspec.os.windows?
+        res = inspec.backend.run_command("Get-Command \"#{@command}\"")
+      elsif inspec.os.unix?
+        res = inspec.backend.run_command("type \"#{@command}\"")
+      else
+        warn "`command(#{@command}).exist?` is not supported on your OS: #{inspec.os[:name]}"
+        return false
+      end
+      res.exit_status.to_i == 0
+    end
+
+    def to_s
+      "Command #{@command}"
+    end
+  end
+end