inspec 1.0.0 → 1.1.0

data/docs/resources/pip.md.erb

@@ -6,7 +6,7 @@ title: About the pip Resource
 
 Use the `pip` InSpec audit resource to test packages that are installed using the Python PIP installer.
 
-# Syntax
+## Syntax
 
 A `pip` resource block declares a package and (optionally) a package version:
 
@@ -20,53 +20,53 @@ where
 * `be_installed` tests to see if the `Jinja2` package is installed
 
 
-# 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 package is installed on the system:
 
     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" %>
 
-## version
+### version
 
 The `version` matcher tests if the named package version is on the system:
 
     its('version') { should eq '1.2.3' }
 
-# Examples
+## Examples
 
 The following examples show how to use this InSpec audit resource.
 
-## Test if Jinja2 is installed on the system
+### Test if Jinja2 is installed on the system
 
     describe pip('Jinja2') do
       it { should be_installed }
     end
 
-## Test if Jinja2 2.8 is installed on the system
+### Test if Jinja2 2.8 is installed on the system
 
     describe pip('Jinja2') do
       it { should be_installed }

data/docs/resources/port.md.erb

@@ -6,7 +6,7 @@ title: About the port Resource
 
 Use the `port` InSpec audit resource to test basic port properties, such as port, process, if it's listening.
 
-# Syntax
+## Syntax
 
 A `port` resource block declares a port, and then depending on what needs to be tested, a process, protocol, process identifier, and its state (is it listening?):
 
@@ -35,55 +35,55 @@ For example, to test if the SSH daemon is available on a Linux machine via the d
       its('addresses') { should include '0.0.0.0' }
     end
 
-# Matchers
+## Matchers
 
 This InSpec audit resource has the following matchers:
 
-## address
+### address
 
 The `addresses` matcher tests if the specified address is associated with a port:
 
     its('addresses') { should include '0.0.0.0' }
 
-## be
+### be
 
 <%= partial "/shared/matcher_be" %>
 
-## be_listening
+### be_listening
 
 The `be_listening` matcher tests if the port is listening for traffic:
 
     it { should be_listening }
 
-## cmp
+### cmp
 
 <%= partial "/shared/matcher_cmp" %>
 
-## eq
+### eq
 
 <%= partial "/shared/matcher_eq" %>
 
-## include
+### include
 
 <%= partial "/shared/matcher_include" %>
 
-## match
+### match
 
 <%= partial "/shared/matcher_match" %>
 
-## pids
+### pids
 
 The `pids` matcher tests the process identifiers (PIDs):
 
     its('pids') { should eq ['27808'] }
 
-## processes
+### processes
 
 The `processes` matcher tests if the named process is running on the system:
 
     its('processes') { should eq ['syslog'] }
 
-## protocols
+### protocols
 
 The `protocols` matcher tests the Internet protocol: ICMP (`'icmp'`), TCP (`'tcp'` or `'tcp6'`), or UDP (`'udp'` or `'udp6'`):
 
@@ -93,18 +93,18 @@ or for the IPv6 protocol:
 
     its('protocols') { should include 'tcp6' }
 
-# Examples
+## Examples
 
 The following examples show how to use this InSpec audit resource.
 
-## Test port 80, listening with the TCP protocol
+### Test port 80, listening with the TCP protocol
 
     describe port(80) do
       it { should be_listening }
       its('protocols') {should eq ['tcp']}
     end
 
-## Test port 80, on a specific address
+### Test port 80, on a specific address
 
 A specific port address may be checked using either of the following examples:
 
@@ -119,14 +119,14 @@ or:
       it { should be_listening }
     end
 
-## Test port 80, listening with TCP version IPv6 protocol
+### Test port 80, listening with TCP version IPv6 protocol
 
     describe port(80) do
       it { should be_listening }
       its('protocols') {should eq ['tcp6']}
     end
 
-## Test that only secure ports accept requests
+### Test that only secure ports accept requests
 
     describe port(80) do
       it { should_not be_listening }
@@ -137,7 +137,7 @@ or:
       its('protocols') {should eq ['tcp']}
     end
 
-## Verify port 65432 is not listening
+### Verify port 65432 is not listening
 
     describe port(22) do
       it { should be_listening }

data/docs/resources/postgres_conf.md.erb

@@ -6,7 +6,7 @@ title: About the postgres_conf Resource
 
 Use the `postgres_conf` InSpec audit resource to test the contents of the configuration file for PostgreSQL, typically located at `/etc/postgresql/<version>/main/postgresql.conf` or `/var/lib/postgres/data/postgresql.conf`, depending on the platform.
 
-# Syntax
+## Syntax
 
 A `postgres_conf` resource block declares one (or more) settings in the `postgresql.conf` file, and then compares the setting in the configuration file to the value stated in the test:
 
@@ -20,31 +20,31 @@ where
 * `('path')` is the non-default path to the `postgresql.conf` file (optional)
 * `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" %>
 
-## cmp
+### cmp
 
 <%= partial "/shared/matcher_cmp" %>
 
-## eq
+### eq
 
 <%= partial "/shared/matcher_eq" %>
 
-## include
+### include
 
 <%= partial "/shared/matcher_include" %>
 
-## match
+### match
 
 <%= partial "/shared/matcher_match" %>
 
-## setting
+### setting
 
 The `setting` matcher tests specific, named settings in the `postgresql.conf` file:
 
@@ -52,17 +52,17 @@ The `setting` matcher tests specific, named settings in the `postgresql.conf` fi
 
 Use a `setting` matcher for each setting to be tested.
 
-# Examples
+## Examples
 
 The following examples show how to use this InSpec audit resource.
 
-## Test the maximum number of allowed client connections
+### Test the maximum number of allowed client connections
 
     describe postgres_conf do
       its('max_connections') { should eq '5' }
     end
 
-## Test system logging
+### Test system logging
 
     describe postgres_conf do
       its('logging_collector') { should eq 'on' }
@@ -73,13 +73,13 @@ The following examples show how to use this InSpec audit resource.
       its('log_line_prefix') { should eq '%t %u %d %h' }
     end
 
-## Test the port on which PostgreSQL listens
+### Test the port on which PostgreSQL listens
 
     describe postgres_conf do
       its('port') { should eq '5432' }
     end
 
-## Test the Unix socket settings
+### Test the Unix socket settings
 
     describe postgres_conf do
       its('unix_socket_directories') { should eq '.s.PGSQL.5432' }

data/docs/resources/postgres_session.md.erb

@@ -6,7 +6,7 @@ title: About the postgres_session Resource
 
 Use the `postgres_session` InSpec audit resource to test SQL commands run against a PostgreSQL database.
 
-# Syntax
+## Syntax
 
 A `postgres_session` resource block declares the username and password to use for the session, and then the command to be run:
 
@@ -22,41 +22,41 @@ where
 * `sql.query('')` contains the query to be run
 * `its('output') { should eq('') }` compares the results of the query against the expected result 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" %>
 
-## output
+### output
 
 The `output` matcher tests the results of the query:
 
     its('output') { should eq(/^0/) }
 
-# Examples
+## Examples
 
 The following examples show how to use this InSpec audit resource.
 
-## Test the PostgreSQL shadow password
+### Test the PostgreSQL shadow password
 
     sql = postgres_session('my_user', 'password')
 
@@ -64,7 +64,7 @@ The following examples show how to use this InSpec audit resource.
       its('output') { should eq('') }
     end
 
-## Test for risky database entries
+### Test for risky database entries
 
     describe postgres_session('my_user', 'password').query('SELECT count (*)
                   FROM pg_language

data/docs/resources/powershell.md.erb

@@ -6,7 +6,7 @@ title: About the powershell Resource
 
 Use the `powershell` InSpec audit resource to test a Powershell script on the Windows platform.
 
-# Syntax
+## Syntax
 
 A `powershell` resource block declares a Powershell script to be tested, and then compares the output of that command to the matcher in the test:
 
@@ -25,53 +25,53 @@ where
 * `'output'` tests the output of the command run on the system versus the output value stated 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" %>
 
-## exit_status
+### exit_status
 
 The `exit_status` matcher tests the exit status for the command:
 
     its('exit_status') { should eq 123 }
 
-## include
+### include
 
 <%= partial "/shared/matcher_include" %>
 
-## match
+### match
 
 <%= partial "/shared/matcher_match" %>
 
-## stderr
+### stderr
 
 The `stderr` matcher tests results of the command as returned in standard error (stderr):
 
     its('stderr') { should eq 'error' }
 
-## stdout
+### stdout
 
 The `stdout` matcher tests results of the command as returned in standard output (stdout):
 
     its('stdout') { should eq '/^1$/' }
 
-# Examples
+## Examples
 
 The following examples show how to use this InSpec audit resource.
 
-## Get all groups of Administrator user
+### Get all groups of Administrator user
 
     script = <<-EOH
       # find user
@@ -85,7 +85,7 @@ The following examples show how to use this InSpec audit resource.
       its('stdout') { should_not eq '' }
     end
 
-## Write-Output 'hello'
+### Write-Output 'hello'
 
 The following Powershell script:
 

data/docs/resources/process.md.erb

@@ -6,7 +6,7 @@ title: About the processes Resource
 
 Use the `processes` InSpec audit resource to test properties for programs that are running on the system.
 
-# Syntax
+## Syntax
 
 A `processes` resource block declares the name of the process to be tested, and then declares one (or more) property/value pairs:
 
@@ -20,53 +20,53 @@ where
 * `property_name` may be used to test user (`its('users')`) and state properties (`its('states')`)
 
 
-# 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" %>
 
-## property_name
+### property_name
 
 The `property_name` matcher tests the named property for the specified value:
 
     its('property_name') { should eq ['property_value'] }
 
-# Examples
+## Examples
 
 The following examples show how to use this InSpec audit resource.
 
-## Test if the list length for the mysqld process is 1
+### Test if the list length for the mysqld process is 1
 
     describe processes('mysqld') do
       its('list.length') { should eq 1 }
     end
 
-## Test if the init process is owned by the root user
+### Test if the init process is owned by the root user
 
     describe processes('init') do
       its('users') { should eq ['root'] }
     end
 
-## Test if a high-priority process is running
+### Test if a high-priority process is running
 
     describe processes('some_process') do
       its('states') { should eq ['R<'] }