inspec 1.51.25 → 2.0.16

data/lib/resources/azure/azure_virtual_machine_data_disk.rb

@@ -0,0 +1,136 @@
+# encoding: utf-8
+
+require 'resources/azure/azure_backend'
+require 'uri'
+
+module Inspec::Resources
+  class AzureVirtualMachineDataDisk < AzureResourceBase
+    name 'azure_virtual_machine_data_disk'
+
+    desc '
+      Inspec Resource to ensure that the data disks attached to a machine are correct
+    '
+
+    supports platform: 'azure'
+
+    # Create a filter table so that tests on the disk can be performed
+    filter = FilterTable.create
+    filter.add_accessor(:where)
+          .add_accessor(:entries)
+          .add_accessor(:has_data_disks?)
+          .add_accessor(:count)
+          .add(:exists?) { |x| !x.entries.empty? }
+          .add(:disk, field: :disk)
+          .add(:number, field: :number)
+          .add(:name, field: :name)
+          .add(:size, field: :size)
+          .add(:vhd_uri, field: :vhd_uri)
+          .add(:storage_account_name, field: :storage_account_name)
+          .add(:lun, field: :lun)
+          .add(:caching, field: :caching)
+          .add(:create_option, field: :create_option)
+          .add(:is_managed_disk?, field: :is_managed_disk?)
+          .add(:storage_account_type, field: :storage_account_type)
+          .add(:subscription_id, field: :subscription_id)
+          .add(:resource_group, field: :resource_group)
+    filter.connect(self, :datadisk_details)
+
+    # Constructor for the resource. This calls the parent constructor to
+    # get the generic resource for the specified machine. This will provide
+    # static methods that are documented
+    #
+    # @author Russell Seymour
+    def initialize(opts = {})
+      # The generic resource needs to pass back a Microsoft.Compute/virtualMachines object so force it
+      opts[:type] = 'Microsoft.Compute/virtualMachines'
+      super(opts)
+
+      # Get the data disks
+      resources
+    end
+
+    # Return information about the disks and add to the filter table so that
+    # assertions can be performed
+    #
+    # @author Russell Seymour
+    def datadisk_details
+      return if failed_resource?
+      # Iterate around the data disks on the machine
+      properties.storageProfile.dataDisks.each_with_index.map do |datadisk, index|
+        # Call function to parse the data disks and return an object based on the parameters
+        parse_datadisk(datadisk, index)
+      end
+    end
+
+    # Return boolean to denote if the machine has data disks attached or not
+    def has_data_disks?
+      !entries.empty?
+    end
+
+    # Return an integer stating how many data disks are attached to the machine
+    def count
+      entries.count
+    end
+
+    # Return boolean to state if the machine is using managed disks for data disks
+    def has_managed_disks?
+      # iterate around the entries
+      result = entries.each.select { |e| e[:is_managed_disk?] }
+      result.empty? ? false : true
+    end
+
+    private
+
+    # Parse the data disk to determine if these are managed disks or in a storage account
+    # for example. The disk index, name and size will be returned
+    #
+    # params object disk Object containing the details of the disk
+    # params integer index Index denoting which disk number this is on the machine
+    #
+    # return hashtable
+    def parse_datadisk(disk, index)
+      # Configure parsed hashtable to hold the information
+      # Initialise this with common attributes from the different types of disk
+      parsed = {
+        disk: index,
+        number: index + 1,
+        lun: disk.lun,
+        name: disk.name,
+        size: disk.diskSizeGB,
+        caching: disk.caching,
+        create_option: disk.createOption,
+      }
+
+      # Determine if the current disk is a managed disk or not
+      if defined?(disk.vhd)
+        # As this is in a storage account this is not a managed disk
+        parsed[:is_managed_disk?] = false
+
+        # Set information about the disk
+        # Parse the uri of the disk URI so that the storage account can be retrieved
+        uri = URI.parse(disk.vhd.uri)
+        parsed[:vhd_uri] = disk.vhd.uri
+        parsed[:storage_account_name] = uri.host.split('.').first
+
+      elsif defined?(disk.managedDisk)
+        # State that this is a managed disk
+        parsed[:is_managed_disk?] = true
+
+        # Get information about the managed disk
+        parsed[:storage_account_type] = disk.managedDisk.storageAccountType
+        parsed[:id] = disk.managedDisk.id
+
+        # Break up the ID string so that the following information can get retreived
+        # - subscription_id
+        # - resource_group
+        id_parts = parsed[:id].split(%r{/}).reject(&:empty?)
+
+        parsed[:subscription_id] = id_parts[1]
+        parsed[:resource_group] = id_parts[3]
+      end
+
+      # return the parsed object
+      parsed
+    end
+  end
+end

data/lib/resources/bash.rb

@@ -1,6 +1,4 @@
 # encoding: utf-8
-# author: Dominik Richter
-# author: Christoph Hartmann
 
 require 'utils/command_wrapper'
 require 'resources/command'
@@ -8,6 +6,7 @@ require 'resources/command'
 module Inspec::Resources
   class Bash < Cmd
     name 'bash'
+    supports platform: 'unix'
     desc 'Run a command or script in BASH.'
     example "
       describe bash('ls -al /') do

data/lib/resources/bond.rb

@@ -1,12 +1,11 @@
 # encoding: utf-8
-# author: Christoph Hartmann
-# author: Dominik Richter
 
 require 'resources/file'
 
 module Inspec::Resources
   class Bond < FileResource
     name 'bond'
+    supports platform: 'unix'
     desc 'Use the bond InSpec audit resource to test a logical, bonded network interface (i.e. "two or more network interfaces aggregated into a single, logical network interface"). On Linux platforms, any value in the /proc/net/bonding directory may be tested.'
     example "
       describe bond('bond0') do

data/lib/resources/bridge.rb

@@ -1,6 +1,4 @@
 # encoding: utf-8
-# author: Christoph Hartmann
-# author: Dominik Richter
 
 # Usage:
 # describe bridge('br0') do
@@ -11,6 +9,7 @@
 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

data/lib/resources/command.rb

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

data/lib/resources/cpan.rb

@@ -1,7 +1,4 @@
 # encoding: utf-8
-# author: Christoph Hartmann
-# author: Dominik Richter
-# author: Markus Grobelin
 
 # Usage:
 # describe cpan('DBD::Pg') do
@@ -12,6 +9,7 @@
 module Inspec::Resources
   class CpanPackage < Inspec.resource(1)
     name 'cpan'
+    supports platform: 'unix'
     desc 'Use the `cpan` InSpec audit resource to test Perl modules that are installed by system packages or the CPAN installer.'
     example "
       describe cpan('DBD::Pg') do

data/lib/resources/cran.rb

@@ -1,7 +1,4 @@
 # encoding: utf-8
-# author: Christoph Hartmann
-# author: Dominik Richter
-# author: Markus Grobelin
 
 # Usage:
 # describe cran('DBI') do
@@ -12,6 +9,7 @@
 module Inspec::Resources
   class CranPackage < Inspec.resource(1)
     name 'cran'
+    supports platform: 'unix'
     desc 'Use the `cran` InSpec audit resource to test R modules that are installed from CRAN package repository.'
     example "
       describe cran('DBI') do

data/lib/resources/crontab.rb

@@ -6,6 +6,7 @@ require 'utils/filter'
 module Inspec::Resources
   class Crontab < Inspec.resource(1)
     name 'crontab'
+    supports platform: 'unix'
     desc 'Use the crontab InSpec audit resource to test the contents of the crontab for a given user which contains information about scheduled tasks owned by that user.'
     example "
       describe crontab(user: 'root') do

data/lib/resources/csv.rb

@@ -1,6 +1,4 @@
 # encoding: utf-8
-# author: Christoph Hartmann
-# author: Dominik Richter
 
 # Parses a csv document
 # This implementation was inspired by a blog post
@@ -8,6 +6,10 @@
 module Inspec::Resources
   class CsvConfig < JsonConfig
     name 'csv'
+    supports platform: 'unix'
+    supports platform: 'windows'
+    supports platform: 'esx'
+    supports platform: 'cisco'
     desc 'Use the csv InSpec audit resource to test configuration data in a CSV file.'
     example "
       describe csv('example.csv') do

data/lib/resources/dh_params.rb

@@ -1,11 +1,10 @@
 # encoding: utf-8
-# author: Doc Walker
 
 require 'openssl'
 
 class DhParams < Inspec.resource(1)
   name 'dh_params'
-
+  supports platform: 'unix'
   desc '
     Use the `dh_params` InSpec audit resource to test Diffie-Hellman (DH)
     parameters.

data/lib/resources/directory.rb

@@ -1,12 +1,12 @@
 # encoding: utf-8
-# author: Dominik Richter
-# author: Christoph Hartmann
 
 require 'resources/file'
 
 module Inspec::Resources
   class Directory < FileResource
     name 'directory'
+    supports platform: 'unix'
+    supports platform: 'windows'
     desc 'Use the directory InSpec audit resource to test if the file type is a directory. This is equivalent to using the file InSpec audit resource and the be_directory matcher, but provides a simpler and more direct way to test directories. All of the matchers available to file may be used with directory.'
     example "
       describe directory('path') do

data/lib/resources/docker.rb

@@ -2,9 +2,6 @@
 #
 # Copyright 2017, Christoph Hartmann
 #
-# author: Christoph Hartmann
-# author: Patrick Muench
-# author: Dominik Richter
 
 require 'utils/filter'
 require 'hashie/mash'
@@ -84,7 +81,7 @@ module Inspec::Resources
   # - docker_image
   class Docker < Inspec.resource(1)
     name 'docker'
-
+    supports platform: 'unix'
     desc "
       A resource to retrieve information about docker
     "

data/lib/resources/docker_container.rb

@@ -1,10 +1,6 @@
 # encoding: utf-8
 #
 # Copyright 2017, Christoph Hartmann
-#
-# author: Christoph Hartmann
-# author: Patrick Muench
-# author: Dominik Richter
 
 require_relative 'docker_object'
 
@@ -13,6 +9,7 @@ module Inspec::Resources
     include Inspec::Resources::DockerObject
 
     name 'docker_container'
+    supports platform: 'unix'
     desc ''
     example "
       describe docker_container('an-echo-server') do

data/lib/resources/docker_image.rb

@@ -1,10 +1,6 @@
 # encoding: utf-8
 #
 # Copyright 2017, Christoph Hartmann
-#
-# author: Christoph Hartmann
-# author: Patrick Muench
-# author: Dominik Richter
 
 require_relative 'docker_object'
 
@@ -13,6 +9,7 @@ module Inspec::Resources
     include Inspec::Resources::DockerObject
 
     name 'docker_image'
+    supports platform: 'unix'
     desc ''
     example "
       describe docker_image('alpine:latest') do

data/lib/resources/docker_service.rb

@@ -1,11 +1,6 @@
 # encoding: utf-8
 #
 # Copyright 2017, Christoph Hartmann
-#
-# author: Christoph Hartmann
-# author: Patrick Muench
-# author: Dominik Richter
-# author: Matt Kulka
 
 require_relative 'docker_object'
 
@@ -14,6 +9,7 @@ module Inspec::Resources
     include Inspec::Resources::DockerObject
 
     name 'docker_service'
+    supports platform: 'unix'
     desc 'Swarm-mode service'
     example "
       describe docker_service('service1') do

data/lib/resources/elasticsearch.rb

@@ -7,6 +7,7 @@ require 'resources/package'
 module Inspec::Resources
   class Elasticsearch < Inspec.resource(1)
     name 'elasticsearch'
+    supports platform: 'unix'
     desc "Use the Elasticsearch InSpec audit resource to test the status of nodes in
       an Elasticsearch cluster."
 

data/lib/resources/etc_fstab.rb

@@ -1,12 +1,12 @@
 # encoding: utf-8
 # copyright:
-# author: Matthew Dromazos
 
 require 'utils/parser'
 
 module Inspec::Resources
   class EtcFstab < Inspec.resource(1)
     name 'etc_fstab'
+    supports platform: 'unix'
     desc 'Use the etc_fstab InSpec audit resource to check the configuration of the etc/fstab file.'
     example "
       nfs_systems = etc_fstab.nfs_file_systems.entries

data/lib/resources/etc_group.rb

@@ -1,7 +1,5 @@
 # encoding: utf-8
 # copyright: 2015, Vulcano Security GmbH
-# author: Christoph Hartmann
-# author: Dominik Richter
 
 # The file format consists of
 # - group name
@@ -29,6 +27,7 @@ module Inspec::Resources
     include CommentParser
 
     name 'etc_group'
+    supports platform: 'unix'
     desc 'Use the etc_group InSpec audit resource to test groups that are defined on Linux and UNIX platforms. The /etc/group file stores details about each group---group name, password, group identifier, along with a comma-separate list of users that belong to the group.'
     example "
       describe etc_group do

data/lib/resources/etc_hosts.rb

@@ -1,10 +1,10 @@
 # encoding: utf-8
-# author: Matthew Dromazos
 
 require 'utils/parser'
 
 class EtcHosts < Inspec.resource(1)
   name 'etc_hosts'
+  supports platform: 'unix'
   desc 'Use the etc_hosts InSpec audit resource to find an
     ip_address and its associated hosts'
   example "

data/lib/resources/etc_hosts_allow_deny.rb

@@ -1,11 +1,11 @@
 # encoding: utf-8
-# author: Matthew Dromazos
 
 require 'utils/parser'
 
 module Inspec::Resources
   class EtcHostsAllow < Inspec.resource(1)
     name 'etc_hosts_allow'
+    supports platform: 'unix'
     desc 'Use the etc_hosts_allow InSpec audit resource to test the connections
           the client will allow. Controlled by the /etc/hosts.allow file.'
     example "
@@ -101,6 +101,7 @@ module Inspec::Resources
 
   class EtcHostsDeny < EtcHostsAllow
     name 'etc_hosts_deny'
+    supports platform: 'unix'
     desc 'Use the etc_hosts_deny InSpec audit resource to test the connections
           the client will deny. Controlled by the /etc/hosts.deny file.'
     example "

data/lib/resources/file.rb

@@ -1,7 +1,5 @@
 # encoding: utf-8
 # copyright: 2015, Vulcano Security GmbH
-# author: Dominik Richter
-# author: Christoph Hartmann
 
 require 'shellwords'
 
@@ -21,6 +19,8 @@ module Inspec::Resources
     include LinuxMountParser
 
     name 'file'
+    supports platform: 'unix'
+    supports platform: 'windows'
     desc 'Use the file InSpec audit resource to test all system file types, including files, directories, symbolic links, named pipes, sockets, character devices, block devices, and doors.'
     example "
       describe file('path') do