inspec 1.51.6 → 1.51.15

data/docs/resources/grub_conf.md.erb

@@ -1,100 +1,101 @@
----
-title: About the grub_conf Resource
----
-
-# 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 that you do not have 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-deault 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/).
+---
+title: About the grub_conf Resource
+os: "Unix/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-deault 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

@@ -1,77 +1,77 @@
----
-title: About the host Resource
----
-
-# 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>
-
-## Examples
-
-The following examples show how to use this InSpec audit resource.
-
-### 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 '192.168.1.1' }
-    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
-
-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 }
-
-### ipaddress
-
-The `ipaddress` matcher tests if a host name is resolvable to a specific IP address:
-
-    its('ipaddress') { should include '93.184.216.34' }
+---
+title: About the host Resource
+---
+
+# 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>
+
+## Examples
+
+The following examples show how to use this InSpec audit resource.
+
+### 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 '192.168.1.1' }
+    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
+
+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 }
+
+### ipaddress
+
+The `ipaddress` matcher tests if a host name is resolvable to a specific IP address:
+
+    its('ipaddress') { should include '93.184.216.34' }

data/docs/resources/http.md.erb

@@ -1,98 +1,104 @@
----
-title: About the http Resource
----
-
-# http
-
-Use the `http` InSpec audit resource to test an http endpoint.
-
-<p class="warning">In InSpec 1.40 and earlier, this resource always executes on the host on which <code>inspec exec</code> is run, even if you use the <code>--target</code> option to remotely scan a different host.<br>
-<br>
-Beginning with InSpec 1.41, you can enable the ability to have the HTTP test execute on the remote target, provided <code>curl</code> is available. See the "Local vs. Remote" section below.<br>
-<br>
-Executing the HTTP test on the remote target will be the default behavior in InSpec 2.0.
-</p>
-
-<br>
-
-## Syntax
-
-An `http` resource block declares the configuration settings to be tested:
-
-    describe http('url', auth: {user: 'user', pass: 'test'}, params: {params}, method: 'method', headers: {headers}, data: data, open_timeout: 60, read_timeout: 60, ssl_verify: true) do
-      its('status') { should eq number }
-      its('body') { should eq 'body' }
-      its('headers.name') { should eq 'header' }
-    end
-
-where
-
-* `('url')` is the url to test
-* `auth: { user: 'user', pass: 'test' }` may be specified for basic auth request
-* `{params}` may be specified for http request parameters
-* `'method'` may be specified for http request method (default to 'GET')
-* `{headers}` may be specified for http request headers
-* `data` may be specified for http request body
-* `open_timeout` may be specified for a timeout for opening connections (default to 60)
-* `read_timeout` may be specified for a timeout for reading connections (default to 60)
-* `ssl_verify` may be specified to enable or disable verification of SSL certificates (default to `true`)
-
-<br>
-## Local vs. Remote
-
-Beginning with InSpec 1.41, you can enable the ability to have the HTTP test execute on the remote target:
-
-    describe http('http://www.example.com', enable_remote_worker: true) do
-      its('body') { should cmp 'awesome' }
-    end
-
-In InSpec 2.0, the HTTP test will automatically execute remotely whenever InSpec is testing a remote node.
-
-## Examples
-
-The following examples show how to use this InSpec audit resource.
-
-### Simple http test
-
-For example, a service is listening on default http port can be tested like this:
-
-    describe http('http://localhost') do
-      its('status') { should cmp 200 }
-    end
-
-### Complex http test
-
-    describe http('http://localhost:8080/ping',
-                  auth: {user: 'user', pass: 'test'},
-                  params: {format: 'html'},
-                  method: 'POST',
-                  headers: {'Content-Type' => 'application/json'},
-                  data: '{"data":{"a":"1","b":"five"}}') do
-      its('status') { should cmp 200 }
-      its('body') { should cmp 'pong' }
-      its('headers.Content-Type') { should cmp 'text/html' }
-    end
-
-<br>
-
-### body
-
-The `body` matcher tests body content of http response:
-
-   its('body') { should eq 'hello\n' }
-
-### headers
-
-The `headers` matcher returns an hash of all http headers:
-
-    its('headers') { should eq {} }
-
-Individual headers can be tested via:
-
-    its('headers.Content-Type') { should cmp 'text/html' }
-
-### status
-
-The `status` matcher tests status of the http response:
-
-    its('status') { should eq 200 }
+---
+title: About the http Resource
+---
+
+# http
+
+Use the `http` InSpec audit resource to test an http endpoint.
+
+<p class="warning">In InSpec 1.40 and earlier, this resource always executes on the host on which <code>inspec exec</code> is run, even if you use the <code>--target</code> option to remotely scan a different host.<br>
+<br>
+Beginning with InSpec 1.41, you can enable remote targeting for the HTTP test, provided <code>curl</code> is available. See the "Local vs. Remote" section below.<br>
+<br>
+Executing the HTTP test on the remote target will be the default behavior in InSpec 2.0.
+</p>
+
+<br>
+
+## Syntax
+
+An `http` resource block declares the configuration settings to be tested:
+
+    describe http('url', auth: {user: 'user', pass: 'test'}, params: {params}, method: 'method', headers: {headers}, data: data, open_timeout: 60, read_timeout: 60, ssl_verify: true) do
+      its('status') { should eq number }
+      its('body') { should eq 'body' }
+      its('headers.name') { should eq 'header' }
+    end
+
+where
+
+* `('url')` is the url to test
+* `auth: { user: 'user', pass: 'test' }` may be specified for basic auth request
+* `{params}` may be specified for http request parameters
+* `'method'` may be specified for http request method (default to 'GET')
+* `{headers}` may be specified for http request headers
+* `data` may be specified for http request body
+* `open_timeout` may be specified for a timeout for opening connections (default to 60)
+* `read_timeout` may be specified for a timeout for reading connections (default to 60)
+* `ssl_verify` may be specified to enable or disable verification of SSL certificates (default to `true`)
+
+<br>
+## Local vs. Remote
+
+Beginning with InSpec 1.41, you can enable the ability to have the HTTP test execute on the remote target:
+
+    describe http('http://www.example.com', enable_remote_worker: true) do
+      its('body') { should cmp 'awesome' }
+    end
+
+In InSpec 2.0, the HTTP test will automatically execute remotely whenever InSpec is testing a remote node.
+
+<br>
+## Supported Resource Properties
+
+body, headers, http_method, status,
+
+<br>
+## Property Examples
+
+The following examples show how to use this InSpec audit resource.
+
+### Simple http test
+
+For example, a service is listening on default http port can be tested like this:
+
+    describe http('http://localhost') do
+      its('status') { should cmp 200 }
+    end
+
+### Complex http test
+
+    describe http('http://localhost:8080/ping',
+                  auth: {user: 'user', pass: 'test'},
+                  params: {format: 'html'},
+                  method: 'POST',
+                  headers: {'Content-Type' => 'application/json'},
+                  data: '{"data":{"a":"1","b":"five"}}') do
+      its('status') { should cmp 200 }
+      its('body') { should cmp 'pong' }
+      its('headers.Content-Type') { should cmp 'text/html' }
+    end
+
+<br>
+
+### body
+
+The `body` matcher tests body content of http response:
+
+   its('body') { should eq 'hello\n' }
+
+### headers
+
+The `headers` matcher returns an hash of all http headers:
+
+    its('headers') { should eq {} }
+
+Individual headers can be tested via:
+
+    its('headers.Content-Type') { should cmp 'text/html' }
+
+### status
+
+The `status` matcher tests status of the http response:
+
+    its('status') { should eq 200 }