inspec 1.31.0 → 1.45.9

data/docs/resources/iptables.md.erb

@@ -6,6 +6,8 @@ title: About the iptables Resource
 
 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.
 
+<br>
+
 ## Syntax
 
 A `iptables` resource block declares tests for rules in IP tables:
@@ -22,35 +24,7 @@ where
 * `chain: 'name'` is the name of a user-defined chain or one of `ACCEPT`, `DROP`, `QUEUE`, or `RETURN`
 * `have_rule('RULE')` tests that rule in the iptables list. This must match the entire line taken from `iptables -S CHAIN`.
 
-## Matchers
-
-This InSpec audit resource has the following matchers:
-
-### be
-
-<%= partial "/shared/matcher_be" %>
-
-### cmp
-
-<%= partial "/shared/matcher_cmp" %>
-
-### eq
-
-<%= partial "/shared/matcher_eq" %>
-
-### have_rule
-
-The `have_rule` matcher tests the named rule against the information in the `iptables` file:
-
-    it { should have_rule('RULE') }
-
-### include
-
-<%= partial "/shared/matcher_include" %>
-
-### match
-
-<%= partial "/shared/matcher_match" %>
+<br>
 
 ## Examples
 
@@ -75,3 +49,15 @@ The following examples show how to use this InSpec audit resource.
     end
 
 Note that the rule specification must exactly match what's in the output of `iptables -S INPUT`, which will depend on how you've built your rules.
+
+<br>
+
+## Matchers
+
+This InSpec audit resource has the following matchers. For a full list of available matchers please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/).
+
+### have_rule
+
+The `have_rule` matcher tests the named rule against the information in the `iptables` file:
+
+    it { should have_rule('RULE') }

data/docs/resources/json.md.erb

@@ -6,6 +6,8 @@ title: About the json Resource
 
 Use the `json` InSpec audit resource to test data in a JSON file.
 
+<br>
+
 ## Syntax
 
 A `json` resource block declares the data to be tested. Assume the following JSON file:
@@ -34,43 +36,26 @@ where
 * `name` is a configuration setting in a JSON file
 * `should eq 'foo'` tests a value of `name` as read from a JSON file versus the value declared in the test
 
+<br>
 
-## Matchers
-
-This InSpec audit resource has the following matchers:
-
-### be
-
-<%= partial "/shared/matcher_be" %>
-
-### cmp
-
-<%= partial "/shared/matcher_cmp" %>
+## Examples
 
-### eq
+The following examples show how to use this InSpec audit resource.
 
-<%= partial "/shared/matcher_eq" %>
+### Test a cookbook version in a policyfile.lock.json file
 
-### include
+    describe json('policyfile.lock.json') do
+      its(['cookbook_locks', 'omnibus', 'version']) { should eq('2.2.0') }
+    end
 
-<%= partial "/shared/matcher_include" %>
+<br>
 
-### match
+## Matchers
 
-<%= partial "/shared/matcher_match" %>
+This InSpec audit resource has the following matchers. For a full list of available matchers please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/).
 
 ### name
 
 The `name` matcher tests the value of `name` as read from a JSON file versus the value declared in the test:
 
     its('name') { should eq 'foo' }
-
-## Examples
-
-The following examples show how to use this InSpec audit resource.
-
-### Test a cookbook version in a policyfile.lock.json file
-
-    describe json('policyfile.lock.json') do
-      its(['cookbook_locks', 'omnibus', 'version']) { should eq('2.2.0') }
-    end

data/docs/resources/kernel_module.md.erb

@@ -12,6 +12,8 @@ The `kernel_module` resource can also verify if a kernel module is `blacklisted`
 or if a module is disabled via a fake install using the `bin_true` or `bin_false`
 method.
 
+<br>
+
 ## Syntax
 
 A `kernel_module` resource block declares a module name, and then tests if that
@@ -32,90 +34,74 @@ where
 * `{ should be_blacklisted }` tests if the module is blacklisted or if the module is disabled via a fake install using /bin/false or /bin/true
 * `{ should be_disabled }` tests if the module is disabled via a fake install using /bin/false or /bin/true
 
-## Matchers
-
-This InSpec audit resource has the following matchers:
+<br>
 
-### be
-
-<%= partial "/shared/matcher_be" %>
+## Examples
 
-### be_loaded
+The following examples show how to use this InSpec audit resource.
 
-The `be_loaded` matcher tests if the module is a loadable kernel module:
+  ### Test a modules 'version'
 
+  describe kernel_module('bridge') do
     it { should be_loaded }
+    its(:version) { should cmp >= '2.2.2' }
+  end
 
-### cmp
-
-<%= partial "/shared/matcher_cmp" %>
-
-### eq
-
-<%= partial "/shared/matcher_eq" %>
+  ### Test if a module is loaded, not disabled and not blacklisted
 
-### include
+  describe kernel_module('video') do
+    it { should be_loaded }
+    it { should_not be_disabled }
+    it { should_not be_blacklisted }
+  end
 
-<%= partial "/shared/matcher_include" %>
+  ### Check if a module is blacklisted
 
-### match
+  describe kernel_module('floppy') do
+    it { should be_blacklisted }
+  end
 
-<%= partial "/shared/matcher_match" %>
+  ### Ensure a module is *not* blacklisted and it is loaded
 
-### version
+  describe kernel_module('video') do
+    it { should_not be_blacklisted }
+    it { should be_loaded }
+  end
 
-The `version` matcher tests if the named module version is on the system:
+  ### Ensure a module is disabled via 'bin_false'
 
-    its(:version) { should eq '3.2.2' }
+  describe kernel_module('sstfb') do
+    it { should_not be_loaded }
+    it { should be_disabled }
+  end
 
-## Examples
+  ### Ensure a module is 'blacklisted'/'disabled' via 'bin_true'
 
-The following examples show how to use this InSpec audit resource.
+  describe kernel_module('nvidiafb') do
+    it { should_not be_loaded }
+    it { should be_blacklisted }
+  end
 
-    ### Test a modules 'version'
+  ### Ensure a module is not loaded
 
-    describe kernel_module('bridge') do
-      it { should be_loaded }
-      its(:version) { should cmp >= '2.2.2' }
-    end
+  describe kernel_module('dhcp') do
+    it { should_not be_loaded }
+  end
 
-    ### Test if a module is loaded, not disabled and not blacklisted
+<br>
 
-    describe kernel_module('video') do
-      it { should be_loaded }
-      it { should_not be_disabled }
-      it { should_not be_blacklisted }
-    end
-
-    ### Check if a module is blacklisted
-
-    describe kernel_module('floppy') do
-      it { should be_blacklisted }
-    end
-
-    ### Ensure a module is *not* blacklisted and it is loaded
+## Matchers
 
-    describe kernel_module('video') do
-      it { should_not be_blacklisted }
-      it { should be_loaded }
-    end
+This InSpec audit resource has the following matchers. For a full list of available matchers please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/).
 
-    ### Ensure a module is disabled via 'bin_false'
+### be_loaded
 
-    describe kernel_module('sstfb') do
-      it { should_not be_loaded }
-      it { should be_disabled }
-    end
+The `be_loaded` matcher tests if the module is a loadable kernel module:
 
-    ### Ensure a module is 'blacklisted'/'disabled' via 'bin_true'
+    it { should be_loaded }
 
-    describe kernel_module('nvidiafb') do
-      it { should_not be_loaded }
-      it { should be_blacklisted }
-    end
+### version
 
-    ### Ensure a module is not loaded
+The `version` matcher tests if the named module version is on the system:
 
-    describe kernel_module('dhcp') do
-      it { should_not be_loaded }
-    end
+    its(:version) { should eq '3.2.2' }

data/docs/resources/kernel_parameter.md.erb

@@ -6,6 +6,8 @@ title: About the kernel_parameter Resource
 
 Use the `kernel_parameter` InSpec audit resource to test kernel parameters on Linux platforms.
 
+<br>
+
 ## Syntax
 
 A `kernel_parameter` resource block declares a parameter and then a value to be tested:
@@ -19,35 +21,7 @@ where
 * `'kernel.parameter'` must specify a kernel parameter, such as `'net.ipv4.conf.all.forwarding'`
 * `{ should eq 0 }` states the value to be tested
 
-## Matchers
-
-This InSpec audit resource has the following matchers:
-
-### be
-
-<%= partial "/shared/matcher_be" %>
-
-### cmp
-
-<%= partial "/shared/matcher_cmp" %>
-
-### eq
-
-<%= partial "/shared/matcher_eq" %>
-
-### include
-
-<%= partial "/shared/matcher_include" %>
-
-### match
-
-<%= partial "/shared/matcher_match" %>
-
-### value
-
-The `value` matcher tests the value assigned to the named IP address versus the value declared in the test:
-
-    its('value') { should eq 0 }
+<br>
 
 ## Examples
 
@@ -70,3 +44,15 @@ The following examples show how to use this InSpec audit resource.
     describe kernel_parameter('net.ipv6.conf.interface.accept_redirects') do
       its('value') { should eq 'true' }
     end
+
+<br>
+
+## Matchers
+
+This InSpec audit resource has the following matchers. For a full list of available matchers please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/).
+
+### value
+
+The `value` matcher tests the value assigned to the named IP address versus the value declared in the test:
+
+    its('value') { should eq 0 }

data/docs/resources/key_rsa.md.erb

@@ -8,6 +8,7 @@ Use the `key_rsa` InSpec audit resource to test RSA public/private keypairs.
 
 This resource is mainly useful when used in conjunction with the x509_certificate resource but it can also be used for checking SSH keys.
 
+<br>
 
 ## Syntax
 
@@ -26,6 +27,8 @@ You can use an optional passphrase with `key_rsa`
       it { should be_private }
     end
 
+<br>
+
 ## Supported Properties
 
 ### public?

data/docs/resources/launchd_service.md.erb

@@ -6,6 +6,8 @@ title: About the launchd_service Resource
 
 Use the ``launchd_service`` InSpec audit resource to test a service using Launchd.
 
+<br>
+
 ## Syntax
 
 A ``launchd_service`` resource block declares the name of a service and then one (or more) matchers to test the state of the service:
@@ -29,13 +31,11 @@ The path to the service manager's control may be specified for situations where
       it { should be_running }
     end
 
-## Matchers
-
-This InSpec audit resource has the following matchers:
+<br>
 
-### be
+## Matchers
 
-<%= partial "/shared/matcher_be" %>
+This InSpec audit resource has the following matchers. For a full list of available matchers please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/).
 
 ### be_enabled
 
@@ -54,23 +54,3 @@ The `be_installed` matcher tests if the named service is installed:
 The `be_running` matcher tests if the named service is running:
 
     it { should be_running }
-
-### cmp
-
-<%= partial "/shared/matcher_cmp" %>
-
-### eq
-
-<%= partial "/shared/matcher_eq" %>
-
-### include
-
-<%= partial "/shared/matcher_include" %>
-
-### match
-
-<%= partial "/shared/matcher_match" %>
-
-## Examples
-
-None.

data/docs/resources/limits_conf.md.erb

@@ -17,6 +17,8 @@ Entries in the `limits.conf` file are similar to:
     ^^^^^^^^^   ^^^^   ^^^^^^   ^^^^^
     domain      type    item    value
 
+<br>
+
 ## Syntax
 
 A `limits_conf` resource block declares a domain to be tested, along with associated type, item, and value:
@@ -34,17 +36,24 @@ where
 * `'item'` is the item for which limits are defined, such as `core`, `nofile`, `stack`, `nproc`, `priority`, or `maxlogins`
 * `'value'` is the value associated with the `item`
 
-## Matchers
+<br>
 
-This InSpec audit resource has the following matchers:
+## Examples
 
-### be
+The following examples show how to use this InSpec audit resource.
 
-<%= partial "/shared/matcher_be" %>
+### Test limits
 
-### cmp
+    describe limits_conf('path') do
+      its('*') { should include ['soft', 'core', '0'], ['hard', 'rss', '10000'] }
+      its('ftp') { should eq ['hard', 'nproc', '0'] }
+    end
+
+<br>
+
+## Matchers
 
-<%= partial "/shared/matcher_cmp" %>
+This InSpec audit resource has the following matchers. For a full list of available matchers please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/).
 
 ### domain
 
@@ -55,26 +64,3 @@ The `domain` matcher tests the domain in the `limits.conf` file, along with asso
 For example:
 
     its('grantmc') { should include ['hard', 'nofile', '63536'] }
-
-### eq
-
-<%= partial "/shared/matcher_eq" %>
-
-### include
-
-<%= partial "/shared/matcher_include" %>
-
-### match
-
-<%= partial "/shared/matcher_match" %>
-
-## Examples
-
-The following examples show how to use this InSpec audit resource.
-
-### Test limits
-
-    describe limits_conf('path') do
-      its('*') { should include ['soft', 'core', '0'], ['hard', 'rss', '10000'] }
-      its('ftp') { should eq ['hard', 'nproc', '0'] }
-    end

data/docs/resources/login_def.md.erb

@@ -6,6 +6,8 @@ title: About the login_defs Resource
 
 Use the `login_defs` InSpec audit resource to test configuration settings in the `/etc/login.defs` file. The `logins.defs` file defines site-specific configuration for the shadow password suite on Linux and Unix platforms, such as password expiration ranges, minimum/maximum values for automatic selection of user and group identifiers, or the method with which passwords are encrypted.
 
+<br>
+
 ## Syntax
 
 A `login_defs` resource block declares the `login.defs` configuration data to be tested:
@@ -19,36 +21,7 @@ where
 * `name` is a configuration setting in `login.defs`
 * `{ should include('foo') }` tests the value of `name` as read from `login.defs` versus the value declared in the test
 
-
-## Matchers
-
-This InSpec audit resource has the following matchers:
-
-### be
-
-<%= partial "/shared/matcher_be" %>
-
-### cmp
-
-<%= partial "/shared/matcher_cmp" %>
-
-### eq
-
-<%= partial "/shared/matcher_eq" %>
-
-### include
-
-<%= partial "/shared/matcher_include" %>
-
-### match
-
-<%= partial "/shared/matcher_match" %>
-
-### name
-
-The `name` matcher tests the value of `name` as read from `login.defs` versus the value declared in the test:
-
-    its('name') { should eq 'foo' }
+<br>
 
 ## Examples
 
@@ -75,3 +48,15 @@ The following examples show how to use this InSpec audit resource.
       its('UMASK') { should eq '077' }
       its('PASS_MAX_DAYS') { should eq '90' }
     end
+
+<br>
+
+## Matchers
+
+This InSpec audit resource has the following matchers. For a full list of available matchers please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/).
+
+### name
+
+The `name` matcher tests the value of `name` as read from `login.defs` versus the value declared in the test:
+
+    its('name') { should eq 'foo' }

data/docs/resources/mount.md.erb

@@ -6,6 +6,8 @@ title: About the mount Resource
 
 Use the `mount` InSpec audit resource to test the mount points on FreeBSD and Linux systems.
 
+<br>
+
 ## Syntax
 
 An `mount` resource block declares the synchronization settings that should be tested:
@@ -20,14 +22,26 @@ where
 * `MATCHER` is a valid matcher for this resource
 * `'value'` is the value to be tested
 
+<br>
 
-## Matchers
+## Examples
+
+The following examples show how to use this InSpec audit resource.
+
+### Test a the mount point on '/'
+
+    describe mount('/') do
+      it { should be_mounted }
+      its('device') { should eq  '/dev/mapper/VolGroup-lv_root' }
+      its('type') { should eq  'ext4' }
+      its('options') { should eq ['rw', 'mode=620'] }
+    end
 
-This InSpec audit resource has the following matchers:
+<br>
 
-### be
+## Matchers
 
-<%= partial "/shared/matcher_be" %>
+This InSpec audit resource has the following matchers. For a full list of available matchers please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/).
 
 ### be_mounted
 
@@ -35,28 +49,12 @@ The `be_mounted` matcher tests if the file is accessible from the file system:
 
     it { should be_mounted }
 
-### cmp
-
-<%= partial "/shared/matcher_cmp" %>
-
 ### device
 
 The `device` matcher tests the device from the `fstab` table:
 
     its('device') { should eq  '/dev/mapper/VolGroup-lv_root' }
 
-### eq
-
-<%= partial "/shared/matcher_eq" %>
-
-### include
-
-<%= partial "/shared/matcher_include" %>
-
-### match
-
-<%= partial "/shared/matcher_match" %>
-
 ### options
 
 The `options` matcher tests the mount options for the file system from the `fstab` table:
@@ -68,16 +66,3 @@ The `options` matcher tests the mount options for the file system from the `fsta
 The `type` matcher tests the file system type:
 
     its('type') { should eq  'ext4' }
-
-## Examples
-
-The following examples show how to use this InSpec audit resource.
-
-### Test a the mount point on '/'
-
-    describe mount('/') do
-      it { should be_mounted }
-      its('device') { should eq  '/dev/mapper/VolGroup-lv_root' }
-      its('type') { should eq  'ext4' }
-      its('options') { should eq ['rw', 'mode=620'] }
-    end

data/docs/resources/mssql_session.md.erb

@@ -6,6 +6,8 @@ title: About the mssql_session Resource
 
 Use the `mssql_session` InSpec audit resource to test SQL commands run against a Microsoft SQL database.
 
+<br>
+
 ## Syntax
 
 A `mssql_session` resource block declares the username and password to use for the session, and then the command to be run:
@@ -20,18 +22,7 @@ where
 * `query('QUERY')` contains the query to be run
 * `its('value') { should eq('') }` compares the results of the query against the expected result in the test
 
-## Matchers
-
-This InSpec audit resource has the following matchers:
-
-### cmp
-
-<%= partial "/shared/matcher_cmp" %>
-
-### eq
-
-<%= partial "/shared/matcher_eq" %>
-
+<br>
 
 ## Examples
 
@@ -60,3 +51,9 @@ The following examples show how to use this InSpec audit resource.
     describe sql.query("SELECT SERVERPROPERTY('ProductVersion') as result").row(0).column('result') do
       its("value") { should cmp > '12.00.4457' }
     end
+
+<br>
+
+## Matchers
+
+For a full list of available matchers please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/).