inspec 1.0.0 → 1.1.0

data/docs/resources/group.md.erb

@@ -6,7 +6,7 @@ title: About the group Resource
 
 Use the `group` InSpec audit resource to test groups on the system.
 
-# Syntax
+## 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:
 
@@ -20,53 +20,53 @@ where
 * `'group_name'` must specify the name of a group on the system
 * `exist` and `'gid'` are valid matchers for this resource
 
-# Matchers
+## Matchers
 
 This InSpec audit resource has the following matchers:
 
-## be
+### be
 
 <%= partial "/shared/matcher_be" %>
 
-## be_local
+### be_local
 
 The `be_local` matcher tests if the group is a local group:
 
     it { should be_local }
 
-## cmp
+### cmp
 
 <%= partial "/shared/matcher_cmp" %>
 
-## eq
+### eq
 
 <%= partial "/shared/matcher_eq" %>
 
-## exist
+### exist
 
 The `exist` matcher tests if the named user exists:
 
     it { should exist }
 
-## gid
+### gid
 
 The `gid` matcher tests the named group identifier:
 
     its('gid') { should eq 1234 }
 
-## include
+### include
 
 <%= partial "/shared/matcher_include" %>
 
-## match
+### match
 
 <%= partial "/shared/matcher_match" %>
 
-# Examples
+## Examples
 
 The following examples show how to use this InSpec audit resource.
 
-## Test the group identifier for the root group
+### Test the group identifier for the root group
 
     describe group('root') do
       it { should exist }

data/docs/resources/grub_conf.md.erb

@@ -6,7 +6,7 @@ title: About the grub_conf Resource
 
 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.
 
-# Syntax
+## Syntax
 
 A `grub_conf` resource block declares a list of settings in a `grub.conf` file:
 
@@ -29,35 +29,35 @@ where
 * `'value'` is the value that is expected
 
 
-# Matchers
+## Matchers
 
 This InSpec audit resource has the following matchers:
 
-## be
+### be
 
 <%= partial "/shared/matcher_be" %>
 
-## cmp
+### cmp
 
 <%= partial "/shared/matcher_cmp" %>
 
-## eq
+### eq
 
 <%= partial "/shared/matcher_eq" %>
 
-## include
+### include
 
 <%= partial "/shared/matcher_include" %>
 
-## match
+### match
 
 <%= partial "/shared/matcher_match" %>
 
-# Examples
+## Examples
 
 The following examples show how to use this InSpec audit resource.
 
-## Test a grub.conf file
+### Test a grub.conf file
 
 A Grub configuration file located at `/etc/grub.conf` is similar to the following:
 
@@ -99,7 +99,7 @@ The following test verifies the `ramdisk_size` for the non-deault kernel:
        its('kernel') { should include 'ramdisk_size=400000' }
      end
 
-## Test a configuration file and boot configuration
+### 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' }
@@ -108,7 +108,7 @@ The following test verifies the `ramdisk_size` for the non-deault kernel:
       its('timeout') { should eq '5' }
     end
 
-## Test a specific kernel
+### 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' }

data/docs/resources/host.md.erb

@@ -6,7 +6,7 @@ title: About the host Resource
 
 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.
 
-# Syntax
+## Syntax
 
 A `host` resource block declares a host name, and then (depending on what is to be tested) a port and/or a protocol:
 
@@ -25,59 +25,59 @@ where
 * `be_reachable` is a valid matcher for this resource
 
 
-# Matchers
+## Matchers
 
 This InSpec audit resource has the following matchers:
 
-## be
+### be
 
 <%= partial "/shared/matcher_be" %>
 
-## be_reachable
+### be_reachable
 
 The `be_reachable` matcher tests if the host name is available:
 
     it { should be_reachable }
 
-## be_resolvable
+### be_resolvable
 
 The `be_resolvable` matcher tests for host name resolution, i.e. "resolvable to an IP address":
 
     it { should be_resolvable }
 
-## cmp
+### cmp
 
 <%= partial "/shared/matcher_cmp" %>
 
-## eq
+### eq
 
 <%= partial "/shared/matcher_eq" %>
 
-## include
+### include
 
 <%= partial "/shared/matcher_include" %>
 
-## ipaddress
+### ipaddress
 
 The `ipaddress` matcher tests if a host name is resolvable to a specific IP address:
 
     its('ipaddress') { should include '93.184.216.34' }
 
-## match
+### match
 
 <%= partial "/shared/matcher_match" %>
 
-# Examples
+## Examples
 
 The following examples show how to use this InSpec audit resource.
 
-## Verify host name is reachable over a specific protocol and port number
+### Verify host name is reachable over a specific protocol and port number
 
     describe host('example.com', port: 53, proto: 'udp') do
       it { should be_reachable }
     end
 
-## Verify that a specific IP address can be resolved
+### Verify that a specific IP address can be resolved
 
     describe host('example.com', port: 80, proto: 'tcp') do
       it { should be_resolvable }

data/docs/resources/iis_site.md.erb

@@ -6,7 +6,7 @@ title: About the iis_site Resource
 
 Use the `iis_site` InSpec audit resource to test the state of IIS on Windows Server 2012 (and later).
 
-# Syntax
+## Syntax
 
 An `iis_site` resource block declares details about the named site:
 
@@ -36,35 +36,35 @@ For example:
       it { should have_path('C:\\inetpub\\wwwroot') }
     end
 
-# Matchers
+## Matchers
 
 This InSpec audit resource has the following matchers:
 
-## be
+### be
 
 <%= partial "/shared/matcher_be" %>
 
-## be_running
+### be_running
 
 The `be_running` matcher tests if the site is running:
 
     it { should be_running }
 
-## cmp
+### cmp
 
 <%= partial "/shared/matcher_cmp" %>
 
-## eq
+### eq
 
 <%= partial "/shared/matcher_eq" %>
 
-## exist
+### exist
 
 The `exist` matcher tests if the site exists:
 
     it { should exist }
 
-## have_app_pool
+### have_app_pool
 
 The `have_app_pool` matcher tests if the named application pool exists for the site:
 
@@ -74,7 +74,7 @@ For example, testing if a site's application pool inherits the settings of the p
 
     it { should have_app_pool('/') }
 
-## have_binding
+### have_binding
 
 The `have_binding` matcher tests if the specified binding exists for the site:
 
@@ -86,7 +86,7 @@ or:
 
 A site may have multiple bindings; use a `have_binding` matcher for each unique site binding to be tested.
 
-### Binding Attributes
+##### Binding Attributes
 
 The `have_binding` matcher can also test attributes that are defined for a site binding. For example, the `sslFlags` attribute defines if SSL is enabled, and (when enabled) what level of SSL is applied to the site.
 
@@ -106,25 +106,25 @@ Testing a site with 128-bit SSL enabled:
 
     it { should have_binding('https :443:www.contoso.com sslFlags=Ssl128') }
 
-## have_path
+### have_path
 
 The `have_path` matcher tests if the named path is defined for the site:
 
     it { should have_path('C:\\inetpub\\wwwroot') }
 
-## include
+### include
 
 <%= partial "/shared/matcher_include" %>
 
-## match
+### match
 
 <%= partial "/shared/matcher_match" %>
 
-# Examples
+## Examples
 
 The following examples show how to use this InSpec audit resource.
 
-## Test a default IIS site
+### Test a default IIS site
 
     describe iis_site('Default Web Site') do
       it { should exist }
@@ -134,7 +134,7 @@ The following examples show how to use this InSpec audit resource.
       it { should have_path('%SystemDrive%\\inetpub\\wwwroot\\') }
     end
 
-## Test if IIS service is running
+### Test if IIS service is running
 
     describe service('W3SVC') do
       it { should be_installed }

data/docs/resources/inetd_conf.md.erb

@@ -6,7 +6,7 @@ title: About the inetd_conf Resource
 
 Use the `inetd_conf` InSpec audit resource to test if a service is listed in the `inetd.conf` file on Linux and Unix platforms. inetd---the Internet service daemon---listens on dedicated ports, and then loads the appropriate program based on a request. The `inetd.conf` file is typically located at `/etc/inetd.conf` and contains a list of Internet services associated to the ports on which that service will listen. Only enabled services may handle a request; only services that are required by the system should be enabled.`
 
-# Syntax
+## Syntax
 
 An `inetd_conf` resource block declares the list of services that are enabled in the `inetd.conf` file:
 
@@ -21,7 +21,7 @@ where
 * `should eq 'value'` is the value that is expected
 
 
-# Matchers
+## Matchers
 
 This resource matches any service that is listed in the `inetd.conf` file. You may want to ensure that specific services do not listen via `inetd.conf`:
 
@@ -43,31 +43,31 @@ For example:
       its('exec') { should eq nil }
     end
 
-## be
+### be
 
 <%= partial "/shared/matcher_be" %>
 
-## cmp
+### cmp
 
 <%= partial "/shared/matcher_cmp" %>
 
-## eq
+### eq
 
 <%= partial "/shared/matcher_eq" %>
 
-## include
+### include
 
 <%= partial "/shared/matcher_include" %>
 
-## match
+### match
 
 <%= partial "/shared/matcher_match" %>
 
-# Examples
+## Examples
 
 The following examples show how to use this InSpec audit resource.
 
-## Verify that FTP is disabled
+### Verify that FTP is disabled
 
 The contents if the `inetd.conf` file contain the following:
 
@@ -88,7 +88,7 @@ Because both the `ftp` and `telnet` Internet services are commented out (`#`), b
 
 then the same test will return `false` for `ftp` and the entire test will fail.
 
-## Test if telnet is installed
+### Test if telnet is installed
 
     describe package('telnetd') do
       it { should_not be_installed }

data/docs/resources/ini.md.erb

@@ -6,7 +6,7 @@ title: About the ini Resource
 
 Use the `ini` InSpec audit resource to test settings in an INI file.
 
-# Syntax
+## Syntax
 
 An `ini` resource block declares the configuration settings to be tested:
 
@@ -27,35 +27,35 @@ For example:
       its('server') { should eq '192.0.2.62' }
     end
 
-# Matchers
+## Matchers
 
 This InSpec audit resource has the following matchers:
 
-## be
+### be
 
 <%= partial "/shared/matcher_be" %>
 
-## cmp
+### cmp
 
 <%= partial "/shared/matcher_cmp" %>
 
-## eq
+### eq
 
 <%= partial "/shared/matcher_eq" %>
 
-## include
+### include
 
 <%= partial "/shared/matcher_include" %>
 
-## match
+### match
 
 <%= partial "/shared/matcher_match" %>
 
-# Examples
+## Examples
 
 The following examples show how to use this InSpec audit resource.
 
-## Test SMTP settings in a PHP INI file
+### Test SMTP settings in a PHP INI file
 
 For example, a PHP INI file located at contains the following settings: