inspec 1.51.25 → 2.0.16

data/lib/resources/npm.rb

@@ -1,10 +1,10 @@
 # encoding: utf-8
-# author: Christoph Hartmann
-# author: Dominik Richter
 
 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

data/lib/resources/ntp_conf.rb

@@ -1,13 +1,12 @@
 # encoding: utf-8
 # copyright: 2015, Vulcano Security GmbH
-# author: Christoph Hartmann
-# author: Dominik Richter
 
 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

data/lib/resources/oneget.rb

@@ -1,6 +1,4 @@
 # encoding: utf-8
-# author: Christoph Hartmann
-# author: Dominik Richter
 
 # This resource talks with OneGet (https://github.com/OneGet/oneget)
 # Its part of Windows Management Framework 5.0 and part of Windows 10
@@ -12,6 +10,7 @@
 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

data/lib/resources/oracledb_session.rb

@@ -1,7 +1,4 @@
 # encoding: utf-8
-# author: Nolan Davidson
-# author: Christoph Hartmann
-# author: Dominik Richter
 
 require 'hashie/mash'
 require 'utils/database_helpers'
@@ -15,6 +12,8 @@ module Inspec::Resources
   #
   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')

data/lib/resources/os.rb

@@ -1,12 +1,12 @@
 # encoding: utf-8
-# author: Dominik Richter
-# author: Christoph Hartmann
 
 require 'resources/platform'
 
 module Inspec::Resources
   class OSResource < PlatformResource
     name 'os'
+    supports platform: 'unix'
+    supports platform: 'windows'
     desc 'Use the os InSpec audit resource to test the platform on which the system is running.'
     example "
       describe os[:family] do
@@ -29,16 +29,6 @@ module Inspec::Resources
       end
     end
 
-    # helper to collect a hash object easily
-    def params
-      {
-        name: name,
-        family: @platform[:family],
-        release: @platform[:release],
-        arch: @platform[:arch],
-      }
-    end
-
     def to_s
       'Operating System Detection'
     end

data/lib/resources/os_env.rb

@@ -1,7 +1,5 @@
 # encoding: utf-8
 # copyright: 2015, Vulcano Security GmbH
-# author: Christoph Hartmann
-# author: Dominik Richter
 
 # Usage:
 #
@@ -15,6 +13,8 @@ require 'utils/simpleconfig'
 module Inspec::Resources
   class OsEnv < Inspec.resource(1)
     name 'os_env'
+    supports platform: 'unix'
+    supports platform: 'windows'
     desc 'Use the os_env InSpec audit resource to test the environment variables for the platform on which the system is running.'
     example "
       describe os_env('VARIABLE') do

data/lib/resources/package.rb

@@ -1,6 +1,4 @@
 # encoding: utf-8
-# author: Christoph Hartmann
-# author: Dominik Richter
 
 # Resource to determine package information
 #
@@ -11,6 +9,8 @@
 module Inspec::Resources
   class Package < Inspec.resource(1)
     name 'package'
+    supports platform: 'unix'
+    supports platform: 'windows'
     desc 'Use the package InSpec audit resource to test if the named package and/or package version is installed on the system.'
     example "
       describe package('nginx') do

data/lib/resources/packages.rb

@@ -1,13 +1,12 @@
 # encoding: utf-8
 # copyright: 2017, Chef Software, Inc. <legal@chef.io>
-# author: Joshua Timberman
-# author: Alex Pop
 
 require 'utils/filter'
 
 module Inspec::Resources
   class Packages < Inspec.resource(1)
     name 'packages'
+    supports platform: 'unix'
     desc 'Use the packages InSpec audit resource to test properties for multiple packages installed on the system'
     example "
       describe packages(/xserver-xorg.*/) do

data/lib/resources/parse_config.rb

@@ -1,7 +1,5 @@
 # encoding: utf-8
 # copyright: 2015, Vulcano Security GmbH
-# author: Dominik Richter
-# author: Christoph Hartmann
 
 # Usage example:
 #
@@ -15,6 +13,8 @@
 module Inspec::Resources
   class PConfig < Inspec.resource(1)
     name 'parse_config'
+    supports platform: 'unix'
+    supports platform: 'windows'
     desc 'Use the parse_config InSpec audit resource to test arbitrary configuration files.'
     example "
       output = command('some-command').stdout

data/lib/resources/passwd.rb

@@ -1,7 +1,5 @@
 # encoding: utf-8
 # copyright: 2015, Vulcano Security GmbH
-# author: Christoph Hartmann
-# author: Dominik Richter
 
 # The file format consists of
 # - username
@@ -18,6 +16,7 @@ require 'utils/filter'
 module Inspec::Resources
   class Passwd < Inspec.resource(1)
     name 'passwd'
+    supports platform: 'unix'
     desc 'Use the passwd InSpec audit resource to test the contents of /etc/passwd, which contains the following information for users that may log into the system and/or as users that own running processes.'
     example "
       describe passwd do
@@ -26,7 +25,6 @@ module Inspec::Resources
 
       describe passwd.uids(0) do
         its('users') { should cmp 'root' }
-        its('count') { should eq 1 }
       end
 
       describe passwd.shells(/nologin/) do
@@ -60,21 +58,6 @@ module Inspec::Resources
           .add(:homes,     field: 'home')
           .add(:shells,    field: 'shell')
 
-    filter.add(:count) { |t, _|
-      warn '[DEPRECATION] `passwd.count` is deprecated. Please use `passwd.entries.length` instead. It will be removed in the next major version.'
-      t.entries.length
-    }
-
-    filter.add(:usernames) { |t, x|
-      warn '[DEPRECATION] `passwd.usernames` is deprecated. Please use `passwd.users` instead. It will be removed in the next major version.'
-      t.users(x)
-    }
-
-    filter.add(:username) { |t, x|
-      warn '[DEPRECATION] `passwd.username` is deprecated. Please use `passwd.users` instead. It will be removed in the next major version.'
-      t.users(x)[0]
-    }
-
     # rebuild the passwd line from raw content
     filter.add(:content) { |t, _|
       t.entries.map do |e|
@@ -82,11 +65,6 @@ module Inspec::Resources
       end.join("\n")
     }
 
-    def uid(x)
-      warn '[DEPRECATION] `passwd.uid(arg)` is deprecated. Please use `passwd.uids(arg)` instead. It will be removed in the next major version.'
-      uids(x)
-    end
-
     filter.connect(self, :params)
 
     def to_s

data/lib/resources/pip.rb

@@ -1,6 +1,4 @@
 # encoding: utf-8
-# author: Christoph Hartmann
-# author: Dominik Richter
 
 # Usage:
 # describe pip('Jinja2') do
@@ -11,6 +9,8 @@
 module Inspec::Resources
   class PipPackage < Inspec.resource(1)
     name 'pip'
+    supports platform: 'unix'
+    supports platform: 'windows'
     desc 'Use the pip InSpec audit resource to test packages that are installed using the pip installer.'
     example "
       describe pip('Jinja2') do

data/lib/resources/platform.rb

@@ -15,32 +15,22 @@ module Inspec::Resources
     "
 
     def initialize
-      @platform = inspec.backend.os
+      @platform = inspec.backend.platform
     end
 
     # add helper methods for easy access of properties
     %w{family release arch}.each do |property|
       define_method(property.to_sym) do
-        @platform.send(property)
+        @platform[property]
       end
     end
 
-    # This is a string override for platform.name.
-    # TODO: removed in inspec 2.0
-    class NameCleaned < String
-      def ==(other)
-        if other =~ /[A-Z ]/
-          cleaned = other.downcase.tr(' ', '_')
-          Inspec::Log.warn "[DEPRECATED] Platform names will become lowercase in InSpec 2.0. Please match on '#{cleaned}' instead of '#{other}'"
-          super(cleaned)
-        else
-          super(other)
-        end
-      end
+    def families
+      @platform.family_hierarchy
     end
 
     def name
-      NameCleaned.new(@platform.name)
+      @platform.name
     end
 
     def [](key)
@@ -60,8 +50,19 @@ module Inspec::Resources
       @platform.family_hierarchy.include?(family)
     end
 
-    def families
-      @platform.family_hierarchy
+    def params
+      h = {
+        name: name,
+        families: families,
+        release: release,
+      }
+
+      # Avoid adding Arch for APIs (not applicable)
+      unless in_family?('api')
+        h[:arch] = arch
+      end
+
+      h
     end
 
     def supported?(supports)
@@ -70,11 +71,7 @@ module Inspec::Resources
       status = true
       supports.each do |s|
         s.each do |k, v|
-          # ignore the inspec check for supports
-          # TODO: remove in inspec 2.0
-          if k == :inspec
-            next
-          elsif %i(os_family os-family platform_family platform-family).include?(k)
+          if %i(os_family os-family platform_family platform-family).include?(k)
             status = in_family?(v)
           elsif %i(os platform).include?(k)
             status = platform?(v)

data/lib/resources/port.rb

@@ -1,6 +1,4 @@
 # encoding: utf-8
-# author: Christoph Hartmann
-# author: Dominik Richter
 
 require 'utils/parser'
 require 'utils/filter'
@@ -11,6 +9,8 @@ require 'ipaddr'
 module Inspec::Resources
   class Port < Inspec.resource(1)
     name 'port'
+    supports platform: 'unix'
+    supports platform: 'windows'
     desc "Use the port InSpec audit resource to test basic port properties, such as port, process, if it's listening."
     example "
       describe port(80) do

data/lib/resources/postgres.rb

@@ -1,12 +1,10 @@
 # encoding: utf-8
 # copyright: 2015, Vulcano Security GmbH
-# author: Dominik Richter
-# author: Christoph Hartmann
-# author: Aaron Lippold
 
 module Inspec::Resources
   class Postgres < Inspec.resource(1)
     name 'postgres'
+    supports platform: 'unix'
 
     attr_reader :service, :data_dir, :conf_dir, :conf_path, :version, :cluster
     def initialize

data/lib/resources/postgres_conf.rb

@@ -1,8 +1,5 @@
 # encoding: utf-8
 # copyright: 2015, Vulcano Security GmbH
-# author: Dominik Richter
-# author: Christoph Hartmann
-# author: Aaron Lippold
 
 require 'utils/simpleconfig'
 require 'utils/find_files'
@@ -11,6 +8,8 @@ require 'resources/postgres'
 module Inspec::Resources
   class PostgresConf < Inspec.resource(1)
     name 'postgres_conf'
+    supports platform: 'unix'
+    supports platform: 'windows'
     desc 'Use the postgres_conf InSpec audit resource to test the contents of the configuration file for PostgreSQL, typically located at /etc/postgresql/<version>/main/postgresql.conf or /var/lib/postgres/data/postgresql.conf, depending on the platform.'
     example "
       describe postgres_conf do

data/lib/resources/postgres_hba_conf.rb

@@ -1,12 +1,11 @@
 # encoding: utf-8
-# author: Rony Xavier,rx294@nyu.edu
-# author: Aaron Lippold, lippold@gmail.com
 
 require 'resources/postgres'
 
 module Inspec::Resources
   class PostgresHbaConf < Inspec.resource(1)
     name 'postgres_hba_conf'
+    supports platform: 'unix'
     desc 'Use the `postgres_hba_conf` InSpec audit resource to test the client
           authentication data defined in the pg_hba.conf file.'
     example "

data/lib/resources/postgres_ident_conf.rb

@@ -1,12 +1,11 @@
 # encoding: utf-8
-# author: Rony Xavier,  rx294@nyu.edu
-# author: Aaron Lippold, lippold@gmail.com
 
 require 'resources/postgres'
 
 module Inspec::Resources
   class PostgresIdentConf < Inspec.resource(1)
     name 'postgres_ident_conf'
+    supports platform: 'unix'
     desc 'Use the postgres_ident_conf InSpec audit resource to test the client
           authentication data is controlled by a pg_ident.conf file.'
     example "

data/lib/resources/postgres_session.rb

@@ -1,8 +1,5 @@
 # encoding: utf-8
 # copyright: 2015, Vulcano Security GmbH
-# author: Dominik Richter
-# author: Christoph Hartmann
-# author: Aaron Lippold
 
 require 'shellwords'
 
@@ -26,6 +23,8 @@ module Inspec::Resources
 
   class PostgresSession < Inspec.resource(1)
     name 'postgres_session'
+    supports platform: 'unix'
+    supports platform: 'windows'
     desc 'Use the postgres_session InSpec audit resource to test SQL commands run against a PostgreSQL database.'
     example "
       sql = postgres_session('username', 'password', 'host')

data/lib/resources/powershell.rb

@@ -1,11 +1,10 @@
 # encoding: utf-8
 # copyright: 2015, Vulcano Security GmbH
-# author: Christoph Hartmann
-# author: Dominik Richter
 
 module Inspec::Resources
   class PowershellScript < Cmd
     name 'powershell'
+    supports platform: 'windows'
     desc 'Use the powershell InSpec audit resource to test a Windows PowerShell script on the Microsoft Windows platform.'
     example "
       script = <<-EOH

data/lib/resources/processes.rb

@@ -1,7 +1,5 @@
 # encoding: utf-8
 # copyright: 2015, Vulcano Security GmbH
-# author: Dominik Richter
-# author: Christoph Hartmann
 
 require 'utils/filter'
 require 'ostruct'
@@ -9,6 +7,8 @@ require 'ostruct'
 module Inspec::Resources
   class Processes < Inspec.resource(1)
     name 'processes'
+    supports platform: 'unix'
+    supports platform: 'windows'
     desc 'Use the processes InSpec audit resource to test properties for programs that are running on the system.'
     example "
       describe processes('mysqld') do

data/lib/resources/rabbitmq_conf.rb

@@ -1,12 +1,11 @@
 # encoding: utf-8
-# author: Dominik Richter
-# author: Christoph Hartmann
 
 require 'utils/erlang_parser'
 
 module Inspec::Resources
   class RabbitmqConf < Inspec.resource(1)
     name 'rabbitmq_config'
+    supports platform: 'unix'
     desc 'Use the rabbitmq_config InSpec resource to test configuration data '\
          'for the RabbitMQ service located in /etc/rabbitmq/rabbitmq.config on '\
          'Linux and UNIX platforms.'