inspec 2.1.0 → 2.1.10

data/docs/resources/kernel_module.md.erb

@@ -1,120 +1,120 @@
----
-title: About the kernel_module Resource
-platform: linux
----
-
-# kernel_module
-
-Use the `kernel_module` InSpec audit resource to test kernel modules on Linux
-platforms. These parameters are located under `/lib/modules`. Any submodule may
-be tested using this resource.
-
-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
-module is a loaded kernel module, if it is enabled, disabled or if it is
-blacklisted:
-
-    describe kernel_module('module_name') do
-      it { should be_loaded }
-      it { should_not be_disabled }
-      it { should_not be_blacklisted }
-    end
-
-where
-
-* `'module_name'` must specify a kernel module, such as `'bridge'`
-* `{ should be_loaded }` tests if the module is a loaded kernel module
-* `{ 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
-
-<br>
-
-## Examples
-
-The following examples show how to use this InSpec audit resource.
-
-### version
-
-The `version` property tests if the kernel module on the system has the correct version:
-
-    its('version') { should eq '3.2.2' }
-
-### Test a kernel module's 'version'
-
-      describe kernel_module('bridge') do
-        it { should be_loaded }
-        its('version') { should cmp >= '2.2.2' }
-      end
-
-### Test if a kernel module is loaded, not disabled, and not blacklisted
-
-      describe kernel_module('video') do
-        it { should be_loaded }
-        it { should_not be_disabled }
-        it { should_not be_blacklisted }
-      end
-
-### Check if a kernel module is blacklisted
-
-      describe kernel_module('floppy') do
-        it { should be_blacklisted }
-      end
-
-### Check if  a kernel module is *not* blacklisted and is loaded
-
-      describe kernel_module('video') do
-        it { should_not be_blacklisted }
-        it { should be_loaded }
-      end
-
-### Check if  a kernel module is disabled via 'bin_false'
-
-      describe kernel_module('sstfb') do
-        it { should_not be_loaded }
-        it { should be_disabled }
-      end
-
-### Check if  a kernel module is 'blacklisted'/'disabled' via 'bin_true'
-
-      describe kernel_module('nvidiafb') do
-        it { should_not be_loaded }
-        it { should be_blacklisted }
-      end
-
-### Check if  a kernel module is not loaded
-
-      describe kernel_module('dhcp') do
-        it { should_not be_loaded }
-      end
-
-<br>
-
-## Matchers
-
-For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/).
-
-
-### be_blacklisted
-
-The `be_blacklisted` matcher tests if the kernel module is a blacklisted module:
-
-    it { should be_blacklisted }
-
-### be_disabled
-
-The `be_disabled` matcher tests if the kernel module is disabled:
-
-    it { should be_disabled }
-
-### be_loaded
-
-The `be_loaded` matcher tests if the kernel module is loaded:
-
-    it { should be_loaded }
+---
+title: About the kernel_module Resource
+platform: linux
+---
+
+# kernel_module
+
+Use the `kernel_module` InSpec audit resource to test kernel modules on Linux
+platforms. These parameters are located under `/lib/modules`. Any submodule may
+be tested using this resource.
+
+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
+module is a loaded kernel module, if it is enabled, disabled or if it is
+blacklisted:
+
+    describe kernel_module('module_name') do
+      it { should be_loaded }
+      it { should_not be_disabled }
+      it { should_not be_blacklisted }
+    end
+
+where
+
+* `'module_name'` must specify a kernel module, such as `'bridge'`
+* `{ should be_loaded }` tests if the module is a loaded kernel module
+* `{ 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
+
+<br>
+
+## Examples
+
+The following examples show how to use this InSpec audit resource.
+
+### version
+
+The `version` property tests if the kernel module on the system has the correct version:
+
+    its('version') { should eq '3.2.2' }
+
+### Test a kernel module's 'version'
+
+      describe kernel_module('bridge') do
+        it { should be_loaded }
+        its('version') { should cmp >= '2.2.2' }
+      end
+
+### Test if a kernel module is loaded, not disabled, and not blacklisted
+
+      describe kernel_module('video') do
+        it { should be_loaded }
+        it { should_not be_disabled }
+        it { should_not be_blacklisted }
+      end
+
+### Check if a kernel module is blacklisted
+
+      describe kernel_module('floppy') do
+        it { should be_blacklisted }
+      end
+
+### Check if  a kernel module is *not* blacklisted and is loaded
+
+      describe kernel_module('video') do
+        it { should_not be_blacklisted }
+        it { should be_loaded }
+      end
+
+### Check if  a kernel module is disabled via 'bin_false'
+
+      describe kernel_module('sstfb') do
+        it { should_not be_loaded }
+        it { should be_disabled }
+      end
+
+### Check if  a kernel module is 'blacklisted'/'disabled' via 'bin_true'
+
+      describe kernel_module('nvidiafb') do
+        it { should_not be_loaded }
+        it { should be_blacklisted }
+      end
+
+### Check if  a kernel module is not loaded
+
+      describe kernel_module('dhcp') do
+        it { should_not be_loaded }
+      end
+
+<br>
+
+## Matchers
+
+For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/).
+
+
+### be_blacklisted
+
+The `be_blacklisted` matcher tests if the kernel module is a blacklisted module:
+
+    it { should be_blacklisted }
+
+### be_disabled
+
+The `be_disabled` matcher tests if the kernel module is disabled:
+
+    it { should be_disabled }
+
+### be_loaded
+
+The `be_loaded` matcher tests if the kernel module is loaded:
+
+    it { should be_loaded }

data/docs/resources/kernel_parameter.md.erb

@@ -1,53 +1,53 @@
----
-title: About the kernel_parameter Resource
-platform: linux
----
-
-# kernel_parameter
-
-Use the `kernel_parameter` InSpec audit resource to test kernel parameters on Linux platforms.
- These parameters are located under `/proc/cmdline`.
-<br>
-
-## Syntax
-
-A `kernel_parameter` resource block declares a parameter and then a value to be tested:
-
-    describe kernel_parameter('path.to.parameter') do
-      its('value') { should eq 0 }
-    end
-
-where
-
-* `'kernel.parameter'` must specify a kernel parameter, such as `'net.ipv4.conf.all.forwarding'`
-* `{ should eq 0 }` states the value to be tested
-
-<br>
-
-## Examples
-
-The following examples show how to use this InSpec audit resource.
-
-### Test if global forwarding is enabled for an IPv4 address
-
-    describe kernel_parameter('net.ipv4.conf.all.forwarding') do
-      its('value') { should eq 1 }
-    end
-
-### Test if global forwarding is disabled for an IPv6 address
-
-    describe kernel_parameter('net.ipv6.conf.all.forwarding') do
-      its('value') { should eq 0 }
-    end
-
-### Test if an IPv6 address accepts redirects
-
-    describe kernel_parameter('net.ipv6.conf.interface.accept_redirects') do
-      its('value') { should cmp 'true' }
-    end
-
-<br>
-
-## Matchers
-
-For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/).
+---
+title: About the kernel_parameter Resource
+platform: linux
+---
+
+# kernel_parameter
+
+Use the `kernel_parameter` InSpec audit resource to test kernel parameters on Linux platforms.
+ These parameters are located under `/proc/cmdline`.
+<br>
+
+## Syntax
+
+A `kernel_parameter` resource block declares a parameter and then a value to be tested:
+
+    describe kernel_parameter('path.to.parameter') do
+      its('value') { should eq 0 }
+    end
+
+where
+
+* `'kernel.parameter'` must specify a kernel parameter, such as `'net.ipv4.conf.all.forwarding'`
+* `{ should eq 0 }` states the value to be tested
+
+<br>
+
+## Examples
+
+The following examples show how to use this InSpec audit resource.
+
+### Test if global forwarding is enabled for an IPv4 address
+
+    describe kernel_parameter('net.ipv4.conf.all.forwarding') do
+      its('value') { should eq 1 }
+    end
+
+### Test if global forwarding is disabled for an IPv6 address
+
+    describe kernel_parameter('net.ipv6.conf.all.forwarding') do
+      its('value') { should eq 0 }
+    end
+
+### Test if an IPv6 address accepts redirects
+
+    describe kernel_parameter('net.ipv6.conf.interface.accept_redirects') do
+      its('value') { should cmp 'true' }
+    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/key_rsa.md.erb

@@ -1,85 +1,85 @@
----
-title: The key_rsa Resource
-platform: os
----
-
-# key_rsa
-
-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
-
-An `key_rsa` resource block declares a `key file` to be tested.
-
-    describe key_rsa('mycertificate.key') do
-      it { should be_private }
-      it { should be_public }
-      its('public_key') { should match "-----BEGIN PUBLIC KEY-----\n3597459df9f3982" }
-      its('key_length') { should eq 2048 }
-    end
-
-You can use an optional passphrase with `key_rsa`
-
-    describe key_rsa('mycertificate.key', 'passphrase') do
-      it { should be_private }
-    end
-
-<br>
-
-## Properties
-
-  * `public_key`, `private_key`, `key_length`
-
-<br>
-
-## Property Examples
-
-### public_key (String)
-
-The `public_key` property returns the public part of the RSA key pair
-
-    describe key_rsa('/etc/pki/www.mywebsite.com.key') do
-      its('public_key') { should match "-----BEGIN PUBLIC KEY-----\n3597459df9f3982......" }
-    end
-
-### private_key (String)
-
-The `private_key` property returns the private key or the RSA key pair.
-
-    describe key_rsa('/etc/pki/www.mywebsite.com.key') do
-      its('private_key') { should match "-----BEGIN RSA PRIVATE KEY-----\nMIIJJwIBAAK......" }
-    end
-
-### key_length
-
-The `key_length` property allows testing the number of bits in the key pair.
-
-    describe key_rsa('/etc/pki/www.mywebsite.com.key') do
-      its('key_length') { should eq 2048 }
-    end
-
-<br>
-
-## Matchers
-
-For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/).
-
-### public?
-
-To verify if a key is public use the following:
-
-    describe key_rsa('/etc/pki/www.mywebsite.com.key') do
-      it { should be_public }
-    end
-
-### private?
-
-This property verifies that the key includes a private key:
-
-    describe key_rsa('/etc/pki/www.mywebsite.com.key') do
-      it { should be_private }
-    end
+---
+title: The key_rsa Resource
+platform: os
+---
+
+# key_rsa
+
+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
+
+An `key_rsa` resource block declares a `key file` to be tested.
+
+    describe key_rsa('mycertificate.key') do
+      it { should be_private }
+      it { should be_public }
+      its('public_key') { should match "-----BEGIN PUBLIC KEY-----\n3597459df9f3982" }
+      its('key_length') { should eq 2048 }
+    end
+
+You can use an optional passphrase with `key_rsa`
+
+    describe key_rsa('mycertificate.key', 'passphrase') do
+      it { should be_private }
+    end
+
+<br>
+
+## Properties
+
+  * `public_key`, `private_key`, `key_length`
+
+<br>
+
+## Property Examples
+
+### public_key (String)
+
+The `public_key` property returns the public part of the RSA key pair
+
+    describe key_rsa('/etc/pki/www.mywebsite.com.key') do
+      its('public_key') { should match "-----BEGIN PUBLIC KEY-----\n3597459df9f3982......" }
+    end
+
+### private_key (String)
+
+The `private_key` property returns the private key or the RSA key pair.
+
+    describe key_rsa('/etc/pki/www.mywebsite.com.key') do
+      its('private_key') { should match "-----BEGIN RSA PRIVATE KEY-----\nMIIJJwIBAAK......" }
+    end
+
+### key_length
+
+The `key_length` property allows testing the number of bits in the key pair.
+
+    describe key_rsa('/etc/pki/www.mywebsite.com.key') do
+      its('key_length') { should eq 2048 }
+    end
+
+<br>
+
+## Matchers
+
+For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/).
+
+### public?
+
+To verify if a key is public use the following:
+
+    describe key_rsa('/etc/pki/www.mywebsite.com.key') do
+      it { should be_public }
+    end
+
+### private?
+
+This property verifies that the key includes a private key:
+
+    describe key_rsa('/etc/pki/www.mywebsite.com.key') do
+      it { should be_private }
+    end