inspec-core 2.1.67

data/docs/resources/filesystem.md.erb

@@ -0,0 +1,41 @@
+---
+title: About the filesystem Resource
+platform: linux
+---
+
+# filesystem
+
+Use the `filesystem` InSpec resource to audit filesystem disk space usage.
+
+<br>
+
+## Syntax
+
+A `filesystem` resource block declares tests for disk space in a partition:
+
+    describe filesystem('/') do
+      its('size') { should be >= 32000 }
+    end
+
+where
+
+* `filesystem('/')` states that the resource will look at the root (/) partition.
+* `size` is measured in kilobytes (KB).
+
+<br>
+
+## Resource Property Examples
+
+The following examples show how to use this InSpec audit resource.
+
+### Test if the root partition is greater than 32000 KB
+
+    describe filesystem('/') do
+      its('size') { should be >= 32000 }
+    end
+
+<br>
+
+## Matchers
+
+For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/).

data/docs/resources/firewalld.md.erb

@@ -0,0 +1,107 @@
+---
+title: About the firewalld Resource
+platform: linux
+---
+
+# firewalld
+
+Use the `firewalld` InSpec audit resource to test that firewalld is configured to allow and deny access to specific hosts, services and ports on a system.
+
+A firewalld has a number of zones that can be configured to allow and deny access to specific hosts, services, and ports.
+
+<br>
+
+## Syntax
+
+    describe firewalld do
+      it { should be_running }
+      its('default_zone') { should eq 'public' }
+      it { should have_service_enabled_in_zone('ssh', 'public') }
+      it { should have_rule_enabled('family=ipv4 source address=192.168.0.14 accept', 'public') }
+    end
+
+Use the where clause to test open interfaces, sources, and services in active zones.
+
+    describe firewalld.where { zone == 'public' } do
+      its('interfaces') { should cmp ['enp0s3', 'eno2'] }
+      its('sources') { should cmp ['192.168.1.0/24', '192.168.1.2'] }
+      its('services') { should cmp ['ssh', 'icmp'] }
+    end
+
+<br>
+
+## Properties
+
+### interfaces
+
+The `interfaces` property is used in conjunction with the where class to display open interfaces in an active zone.
+
+    describe firewalld.where { zone == 'public' } do
+      its('interfaces') { should cmp ['enp0s3', 'eno2'] }
+    end
+
+### sources
+
+The `sources` property is used in conjunction with the where class to display open sources in an active zone.
+
+    describe firewalld.where { zone == 'public' } do
+      its('sources') { should cmp ['192.168.1.0/24', '192.168.1.2'] }
+    end
+
+### services
+
+The `services` property is used in conjunction with the where class to display open services in an active zone.
+
+    describe firewalld.where { zone == 'public' } do
+      its('services') { should cmp ['ssh', 'icmp'] }
+    end
+
+### default_zone
+
+The `default_zone` property displays the default active zone to be used.
+
+    its('default_zone') { should eq 'public' }
+
+<br>
+
+## Matchers
+
+For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/).
+
+### `be_installed`
+
+The `be_installed` matcher tests if the firewalld service is installed:
+
+    it { should be_installed }
+
+### `be_running`
+
+The `be_running` matcher tests if the firewalld service is running:
+
+    it { should be_running }
+
+### have_zone
+
+`have_zone` returns true or false if the zone is set on firewalld. It does not mean the zone is active.
+
+    it { should have_zone('public') }
+
+### `have_service_enabled_in_zone`
+
+`have_service_enabled_in_zone` returns true or false if the service is allowed in the specified zone.
+
+    it { should have_service_enabled_in_zone('ssh', 'public') }
+
+### `have_port_enabled_in_zone`
+
+`have_port_enabled_in_zone` returns true or false if the port is allowed in the specified zone.
+
+    it { should have_port_enabled_in_zone('22/tcp', 'public') }
+
+### `have_rule_enabled`
+
+`have_rule_enabled` returns true or false if the rich-rule has been specified in the zone.
+
+    it { should have_rule_enabled('family=ipv4 source address=192.168.0.14 accept', 'public') }
+
+It is not necessary to add the "rule" string, and you can start with the optional flags that are used in firewalld and end with the action

data/docs/resources/gem.md.erb

@@ -0,0 +1,79 @@
+---
+title: About the gem Resource
+platform: os
+---
+
+# gem
+
+Use the `gem` InSpec audit resource to test if a global Gem package is installed.
+
+<br>
+
+## Syntax
+
+A `gem` resource block declares a package and (optionally) a package version:
+
+    describe gem('gem_package_name', 'gem_binary') do
+      it { should be_installed }
+    end
+
+where
+
+* `('gem_package_name')` must specify a Gem package, such as `'rubocop'`
+* `('gem_binary')` can specify the path to a non-default gem binary, defaults to `'gem'`
+* `be_installed` is a valid matcher for this resource
+
+<br>
+
+## Resource Property Examples
+
+The following examples show how to use this InSpec audit resource.
+
+### Verify that a gem package is installed, with a specific version
+
+    describe gem('rubocop') do
+      it { should be_installed }
+      its('version') { should eq '0.33.0' }
+    end
+
+### Verify that a gem package is not installed
+
+    describe gem('rubocop') do
+      it { should_not be_installed }
+    end
+
+### Verify that a gem package is installed in an omnibus environment
+
+    describe gem('pry', '/opt/ruby-2.3.1/embedded/bin/gem') do
+      it { should be_installed }
+    end
+
+### Verify that a gem package is installed in a chef omnibus environment
+
+    describe gem('chef-sugar', :chef) do
+      it { should be_installed }
+    end
+
+### Verify that a gem package is installed in a chef-server omnibus environment
+
+    describe gem('knife-backup', :chef_server) do
+      it { should be_installed }
+    end
+
+<br>
+
+## Matchers
+
+For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/).
+
+### be_installed
+
+The `be_installed` matcher tests if the named Gem package is installed:
+
+    it { should be_installed }
+
+### version
+
+The `version` matcher tests if the named package version is on the system:
+
+    its('version') { should eq '0.33.0' }

data/docs/resources/group.md.erb

@@ -0,0 +1,61 @@
+---
+title: About the group Resource
+platform: os
+---
+
+# group
+
+Use the `group` InSpec audit resource to test groups on the system.
+
+<br>
+
+## Syntax
+
+A `group` resource block declares a group, and then the details to be tested, such as if the group is a local group, the group identifier, or if the group exists:
+
+    describe group('group_name') do
+      it { should exist }
+      its('gid') { should eq 0 }
+    end
+
+where
+
+* `'group_name'` must specify the name of a group on the system
+* `exist` and `'gid'` are valid matchers for this resource
+
+<br>
+
+## Examples
+
+The following examples show how to use this InSpec audit resource.
+
+### Test the group identifier for the root group
+
+    describe group('root') do
+      it { should exist }
+      its('gid') { should eq 0 }
+    end
+
+<br>
+
+## Matchers
+
+For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/).
+
+### be_local
+
+The `be_local` matcher tests if the group is a local group:
+
+    it { should be_local }
+
+### exist
+
+The `exist` matcher tests if the named user exists:
+
+    it { should exist }
+
+### gid
+
+The `gid` matcher tests the named group identifier:
+
+    its('gid') { should eq 1234 }

data/docs/resources/grub_conf.md.erb

@@ -0,0 +1,101 @@
+---
+title: About the grub_conf Resource
+platform: linux
+---
+
+# grub_conf
+
+Grub is a boot loader on the Linux platform used to load and then transfer control to an operating system kernel, after which that kernel initializes the rest of the operating system. Use the `grub_conf` InSpec audit resource to test boot loader configuration settings that are defined in the `grub.conf` configuration file.
+
+<br>
+
+## Syntax
+
+A `grub_conf` resource block declares a list of settings in a `grub.conf` file:
+
+    describe grub_conf('path', 'kernel') do
+      its('setting') { should eq 'value' }
+    end
+
+or:
+
+    describe grub_conf('path') do
+      its('default') { should eq '0' } #
+      its('setting') { should eq 'value' }
+    end
+
+where
+
+* `'service_name'` is a service listed in the `grub.conf` file
+* `'path'` is the path to the `grub.conf` file
+* `'kernel'` specifies the default kernel (by using `'default'`) or a specific kernel; `'default'` defines the position in the list of kernels at which the default kernel is defined, i.e. `should eq '0'` for the first kernel listed or `'path', 'default'` to use the default kernel as specified in the `grub.conf` file
+* `'value'` is the value that is expected
+
+<br>
+
+## Examples
+
+The following examples show how to use this InSpec audit resource.
+
+### Test a grub.conf file
+
+A Grub configuration file located at `/etc/grub.conf` is similar to the following:
+
+    # grub.conf generated by anaconda
+    #
+    # Note:  You do not need to rerun grub after making changes to this file
+    # NOTICE:  You have a /boot partition.  This means that
+    #          all kernel and initrd paths are relative to /boot/, eg.
+    #          root (hd0,0)
+    #          kernel /vmlinuz-version ro root=/dev/hda6
+    #          initrd /initrd-version.img
+    #boot=/dev/hda
+    default=0
+    timeout=10
+    splashimage=(hd0,0)/grub/splash.xpm.gz
+    title Red Hat Enterprise Linux ES (2.6.32-573.7.1.el6.x86_64)
+        root (hd0,0)
+        kernel /vmlinuz-2.6.32-573.7.1.el6.x86_64 ro root=/dev/hda6
+        initrd /initrd-2.6.32-573.7.1.el6.x86_64.img
+    title Red Hat Enterprise Linux ES (2.6.32-358.14.1.el6.x86_64)
+        root (hd0,0)
+        kernel /vmlinuz-2.6.32-358.14.1.el6.x86_64 ro root=/dev/hda6 ramdisk_size=400000
+        initrd /initrd-2.6.32-358.14.1.el6.x86_64.img
+
+This file defines two versions of RedHat Enterprise Linux, with version `2.6.32-573.7.1.el6.x86_64` specified as the default.
+
+The following test verifies the kernel, ensures that kernel is the default kernel, its initial RAM disk (`initrd`), and the timeout:
+
+    describe grub_conf('/etc/grub.conf',  'default') do
+      its('kernel') { should include '/vmlinuz-2.6.32-573.7.1.el6.x86_64' }
+      its('initrd') { should include '/initrd-2.6.32-573.7.1.el6.x86_64.img' }
+      its('default') { should_not eq '1' }
+      its('timeout') { should eq '10' }
+    end
+
+The following test verifies the `ramdisk_size` for the non-default kernel:
+
+    describe grub_conf('/etc/grub.conf',  'Red Hat Enterprise Linux ES (2.6.32-358.14.1.el6.x86_64)') do
+       its('kernel') { should include 'ramdisk_size=400000' }
+     end
+
+### Test a configuration file and boot configuration
+
+    describe grub_conf('/etc/grub.conf',  'default') do
+      its('kernel') { should include '/vmlinuz-2.6.32-573.7.1.el6.x86_64' }
+      its('initrd') { should include '/initramfs-2.6.32-573.el6.x86_64.img=1' }
+      its('default') { should_not eq '1' }
+      its('timeout') { should eq '5' }
+    end
+
+### Test a specific kernel
+
+    grub_conf('/etc/grub.conf',  'CentOS (2.6.32-573.12.1.el6.x86_64)') do
+      its('kernel') { should include 'audit=1' }
+    end
+
+<br>
+
+## Matchers
+
+For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/).

data/docs/resources/host.md.erb

@@ -0,0 +1,86 @@
+---
+title: About the host Resource
+platform: os
+---
+
+# host
+
+Use the `host` InSpec audit resource to test the name used to refer to a specific host and its availability, including the Internet protocols and ports over which that host name should be available.
+
+<br>
+
+## Syntax
+
+A `host` resource block declares a host name, and then (depending on what is to be tested) a port and/or a protocol:
+
+    describe host('example.com', port: 80, protocol: 'tcp') do
+      it { should be_reachable }
+      it { should be_resolvable }
+      its('ipaddress') { should include '12.34.56.78' }
+    end
+
+where
+
+* `host()` must specify a host name and may specify a port number and/or a protocol
+* `'example.com'` is the host name
+* `port:` is the port number
+* `protocol: 'name'` is the Internet protocol: TCP (`protocol: 'tcp'`), UDP (`protocol: 'udp'` or  ICMP (`protocol: 'icmp'`))
+
+<br>
+
+## Resource Properties
+
+* `connection`, `ipaddress`, `protocol`, `socket`
+
+<br>
+
+## Resource Examples
+
+The following examples show how to use this InSpec audit resource.
+
+### ipaddress
+
+The `ipaddress` matcher tests if a host name is resolvable to a specific IP address:
+
+    describe host('example.com') do
+      its('ipaddress') { should include '93.184.216.34' }
+    end
+
+### Verify host name is reachable over a specific protocol and port number
+
+    describe host('example.com', port: 80, protocol: 'tcp') do
+      it { should be_reachable }
+    end
+
+### Verify that a specific IP address can be resolved
+
+    describe host('example.com') do
+      it { should be_resolvable }
+      its('ipaddress') { should include '93.184.216.34' }
+    end
+
+### Review the connection setup and socket contents when checking reachability
+
+    describe host('example.com', port: 12345, protocol: 'tcp') do
+      it { should be_reachable }
+      its('connection') { should_not match /connection refused/ }
+      its('socket') { should match /STATUS_OK/ }
+    end
+
+<br>
+
+## Matchers
+
+This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/).
+
+### be_reachable
+
+The `be_reachable` matcher tests if the host name is available:
+
+    it { should be_reachable }
+
+### be_resolvable
+
+The `be_resolvable` matcher tests for host name resolution, i.e. "resolvable to an IP address":
+
+    it { should be_resolvable }