inspec 1.0.0 → 1.1.0

data/docs/resources/users.md.erb

@@ -6,7 +6,7 @@ title: About the users Resource
 
 Use the `users` InSpec audit resource to look up all local users available on the system, and then test specific properties of those users. This resource does not return information about users that may be located on other systems, such as LDAP or Active Directory.
 
-# Syntax
+## Syntax
 
 A `users` resource block declares a user name, and then one (or more) matchers:
 
@@ -33,29 +33,29 @@ or:
       it { should exist }
     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" %>
 
-## exist
+### exist
 
 The `exist` matcher tests if the named user exists:
 
     it { should exist }
 
-## gid
+### gid
 
 The `gid` matcher tests the group identifier:
 
@@ -63,7 +63,7 @@ The `gid` matcher tests the group identifier:
 
 where `1234` represents the user identifier.
 
-## group
+### group
 
 The `group` matcher tests the group to which the user belongs:
 
@@ -71,27 +71,27 @@ The `group` matcher tests the group to which the user belongs:
 
 where `root` represents the group.
 
-## groups
+### groups
 
 The `groups` matcher tests two (or more) groups to which the user belongs:
 
     its('groups') { should eq ['root', 'other']}
 
-## home
+### home
 
 The `home` matcher tests the home directory path for the user:
 
     its('home') { should eq '/root' }
 
-## include
+### include
 
 <%= partial "/shared/matcher_include" %>
 
-## match
+### match
 
 <%= partial "/shared/matcher_match" %>
 
-## maxdays
+### maxdays
 
 The `maxdays` matcher tests the maximum number of days between password changes:
 
@@ -99,7 +99,7 @@ The `maxdays` matcher tests the maximum number of days between password changes:
 
 where `99` represents the maximum number of days.
 
-## mindays
+### mindays
 
 The `mindays` matcher tests the minimum number of days between password changes:
 
@@ -107,13 +107,13 @@ The `mindays` matcher tests the minimum number of days between password changes:
 
 where `0` represents the maximum number of days.
 
-## shell
+### shell
 
 The `shell` matcher tests the path to the default shell for the user:
 
     its('shell') { should eq '/bin/bash' }
 
-## uid
+### uid
 
 The `uid` matcher tests the user identifier:
 
@@ -121,7 +121,7 @@ The `uid` matcher tests the user identifier:
 
 where `1234` represents the user identifier.
 
-## warndays
+### warndays
 
 The `warndays` matcher tests the number of days a user is warned before a password must be changed:
 
@@ -129,11 +129,11 @@ The `warndays` matcher tests the number of days a user is warned before a passwo
 
 where `5` represents the number of days a user is warned.
 
-# Examples
+## Examples
 
 The following examples show how to use this InSpec audit resource.
 
-## Use a regular expression to find users
+### Use a regular expression to find users
 
     describe users.where { uid =~ /S\-1\-5\-21\-\d+\-\d+\-\d+\-500/ } do
       it { should exist }

data/docs/resources/vbscript.md.erb

@@ -6,7 +6,7 @@ title: About the vbscript Resource
 
 Use the `vbscript` InSpec audit resource to test a VBScript on the Windows platform.
 
-# Syntax
+## Syntax
 
 A `vbscript` resource block tests the output of a VBScript on the Windows platform:
 
@@ -20,35 +20,35 @@ where
 * `('output')` is the expected output of the VBScript
 
 
-# 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 VBScript
+### Test a VBScript
 
 A VBScript file similar to:
 

data/docs/resources/windows_feature.md.erb

@@ -6,7 +6,7 @@ title: About the windows_feature Resource
 
 Use the `windows_feature` InSpec audit resource to test features on Windows via the `Get-WindowsFeature` cmdlet.
 
-# Syntax
+## Syntax
 
 A `windows_feature` resource block declares the name of the Windows feature, tests if that feature is installed, and then returns information about that feature:
 
@@ -20,41 +20,41 @@ where
 * `be_installed` is a valid matcher for this resource
 
 
-# Matchers
+## Matchers
 
 This InSpec audit resource has the following matchers:
 
-## be
+### be
 
 <%= partial "/shared/matcher_be" %>
 
-## be_installed
+### be_installed
 
 The `be_installed` matcher tests if the named Windows feature is installed:
 
     it { should be_installed }
 
-## 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 the DHCP Server feature
+### Test the DHCP Server feature
 
     describe windows_feature('DHCP Server') do
       it{ should be_installed }

data/docs/resources/wmi.md.erb

@@ -6,7 +6,7 @@ title: About the wmi Resource
 
 Use the `wmi` InSpec audit resource to test WMI settings on the Windows platform.
 
-# Syntax
+## Syntax
 
 A `wmi` resource block tests WMI settings on the Windows platform:
 
@@ -47,35 +47,35 @@ and the second uses a filter in the Ruby Hash to first identify WinRM, and then
     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 a password expiration policy
+### Test a password expiration policy
 
     describe wmi({
       class: 'RSOP_SecuritySettingNumeric',
@@ -85,7 +85,7 @@ The following examples show how to use this InSpec audit resource.
        its('Setting') { should eq 1 }
     end
 
-## Test if an anonymous user can query the Local Security Authority (LSA)
+### Test if an anonymous user can query the Local Security Authority (LSA)
 
     describe wmi({
       namespace: 'root\rsop\computer',

data/docs/resources/xinetd_conf.md.erb

@@ -6,7 +6,7 @@ title: About the xinetd_conf Resource
 
 Use the `xinetd_conf` InSpec audit resource to test services under `/etc/xinet.d` on Linux and Unix platforms. xinetd---the extended Internet service daemon---listens on all ports, and then loads the appropriate program based on a request. The `xinetd.conf` file is typically located at `/etc/xinetd.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 `xinetd_conf` resource block declares settings found in a `xinetd.conf` file for the named service:
 
@@ -22,29 +22,29 @@ where
 * `should eq 'value'` is the value that is expected
 
 
-# Matchers
+## Matchers
 
 This InSpec audit resource has the following matchers:
 
-## be
+### be
 
 <%= partial "/shared/matcher_be" %>
 
-## be_enabed
+### be_enabed
 
 The `be_enabled` matcher tests if a service listed under `/etc/xinet.d` is enabled:
 
     it { should be_enabled }
 
-## cmp
+### cmp
 
 <%= partial "/shared/matcher_cmp" %>
 
-## eq
+### eq
 
 <%= partial "/shared/matcher_eq" %>
 
-## ids
+### ids
 
 The `ids` matcher tests if the named service is located under `/etc/xinet.d`:
 
@@ -54,21 +54,21 @@ For example:
 
     its('ids') { should include 'chargen-stream chargen-dgram'}
 
-## include
+### include
 
 <%= partial "/shared/matcher_include" %>
 
-## match
+### match
 
 <%= partial "/shared/matcher_match" %>
 
-## services
+### services
 
 The `services` matcher tests if the named service is listed under `/etc/xinet.d`:
 
     its('services') { should include 'service_name' }
 
-## socket_types
+### socket_types
 
 The `socket_types` matcher tests if a service listed under `/etc/xinet.d` is configured to use the named socket type:
 
@@ -86,7 +86,7 @@ For a TCP-based service:
 
     its('socket_types') { should eq 'stream' }
 
-## types
+### types
 
 The `types` matcher tests the service type:
 
@@ -94,7 +94,7 @@ The `types` matcher tests the service type:
 
 where `'TYPE'` is `INTERNAL` (for a service provided by xinetd), `RPC` (for a service based on remote procedure call), or `UNLISTED` (for services not under `/etc/services` or `/etc/rpc`).
 
-## wait
+### wait
 
 The `wait` matcher tests how a service handles incoming connections.
 
@@ -108,11 +108,11 @@ For TCP (`stream`) socket types the `wait` matcher should test for `no`:
     its('socket_types') { should eq 'stream' }
     its('wait') { should eq 'no' }
 
-# Examples
+## Examples
 
 The following examples show how to use this InSpec audit resource.
 
-## Test a socket_type
+### Test a socket_type
 
 The network socket type: `dgram` (a datagram-based service), `raw` (a service that requires direct access to an IP address), `stream` (a stream-based service), or `seqpacket` (a service that requires a sequenced packet).
 
@@ -120,7 +120,7 @@ The network socket type: `dgram` (a datagram-based service), `raw` (a service th
        its('socket_types') { should include 'dgram' }
     end
 
-## Test a service type
+### Test a service type
 
 The type of service: `INTERNAL` (a service provided by xinetd), `RPC` (an RPC-based service), `TCPMUX` (a service that is started on a well-known TPCMUX port), or `UNLISTED` (a service that is not listed in a standard system file location).
 
@@ -128,7 +128,7 @@ The type of service: `INTERNAL` (a service provided by xinetd), `RPC` (an RPC-ba
        its('type') { should include 'RPC' }
     end
 
-## Test the telnet service
+### Test the telnet service
 
 For example, a `telnet` file under `/etc/xinet.d` contains the following settings:
 

data/docs/resources/yaml.md.erb

@@ -6,7 +6,7 @@ title: About the yaml Resource
 
 Use the `yaml` InSpec audit resource to test configuration data in a Yaml file.
 
-# Syntax
+## Syntax
 
 A `yaml` resource block declares the configuration data to be tested. Assume the following Yaml file:
 
@@ -28,41 +28,41 @@ where
 * `should eq 'foo'` tests a value of `name` as read from a Yaml file versus the value declared in the test
 
 
-# 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" %>
 
-## name
+### name
 
 The `name` matcher tests the value of `name` as read from a Yaml file versus the value declared in the test:
 
     its('name') { should eq 'foo' }
 
-# Examples
+## Examples
 
 The following examples show how to use this InSpec audit resource.
 
-## Test a kitchen.yml file driver
+### Test a kitchen.yml file driver
 
     describe yaml('.kitchen.yaml') do
       its('driver.name') { should eq('vagrant') }