inspec 1.31.0 → 1.45.9

data/docs/resources/port.md.erb

@@ -6,6 +6,8 @@ title: About the port Resource
 
 Use the `port` InSpec audit resource to test basic port properties, such as port, process, if it's listening.
 
+<br>
+
 ## 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,63 +37,7 @@ 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
-
-This InSpec audit resource has the following matchers:
-
-### address
-
-The `addresses` matcher tests if the specified address is associated with a port:
-
-    its('addresses') { should include '0.0.0.0' }
-
-### be
-
-<%= partial "/shared/matcher_be" %>
-
-### be_listening
-
-The `be_listening` matcher tests if the port is listening for traffic:
-
-    it { should be_listening }
-
-### cmp
-
-<%= partial "/shared/matcher_cmp" %>
-
-### eq
-
-<%= partial "/shared/matcher_eq" %>
-
-### include
-
-<%= partial "/shared/matcher_include" %>
-
-### match
-
-<%= partial "/shared/matcher_match" %>
-
-### pids
-
-The `pids` matcher tests the process identifiers (PIDs):
-
-    its('pids') { should cmp 27808 }
-
-### processes
-
-The `processes` matcher tests if the named process is running on the system:
-
-    its('processes') { should cmp 'syslog' }
-
-### protocols
-
-The `protocols` matcher tests the Internet protocol: ICMP (`'icmp'`), TCP (`'tcp'` or `'tcp6'`), or UDP (`'udp'` or `'udp6'`):
-
-    its('protocols') { should include 'tcp' }
-
-or for the IPv6 protocol:
-
-    its('protocols') { should include 'tcp6' }
+<br>
 
 ## Examples
 
@@ -148,3 +94,43 @@ or:
     describe port(65432) do
       it { should_not be_listening }
     end
+
+<br>
+
+## Matchers
+
+This InSpec audit resource has the following matchers. For a full list of available matchers please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/).
+
+### address
+
+The `addresses` matcher tests if the specified address is associated with a port:
+
+    its('addresses') { should include '0.0.0.0' }
+
+### be_listening
+
+The `be_listening` matcher tests if the port is listening for traffic:
+
+    it { should be_listening }
+
+### pids
+
+The `pids` matcher tests the process identifiers (PIDs):
+
+    its('pids') { should cmp 27808 }
+
+### processes
+
+The `processes` matcher tests if the named process is running on the system:
+
+    its('processes') { should cmp 'syslog' }
+
+### protocols
+
+The `protocols` matcher tests the Internet protocol: ICMP (`'icmp'`), TCP (`'tcp'` or `'tcp6'`), or UDP (`'udp'` or `'udp6'`):
+
+    its('protocols') { should include 'tcp' }
+
+or for the IPv6 protocol:
+
+    its('protocols') { should include 'tcp6' }

data/docs/resources/postgres_conf.md.erb

@@ -6,6 +6,8 @@ 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.
 
+<br>
+
 ## 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:
@@ -21,37 +23,7 @@ where
 * `('path')` is the non-default path to the `postgresql.conf` file (optional)
 * `should eq 'value'` is the value that is expected
 
-## Matchers
-
-This InSpec audit resource has the following matchers:
-
-### be
-
-<%= partial "/shared/matcher_be" %>
-
-### cmp
-
-<%= partial "/shared/matcher_cmp" %>
-
-### eq
-
-<%= partial "/shared/matcher_eq" %>
-
-### include
-
-<%= partial "/shared/matcher_include" %>
-
-### match
-
-<%= partial "/shared/matcher_match" %>
-
-### setting
-
-The `setting` matcher tests specific, named settings in the `postgresql.conf` file:
-
-    its('setting') { should eq 'value' }
-
-Use a `setting` matcher for each setting to be tested.
+<br>
 
 ## Examples
 
@@ -90,3 +62,17 @@ The following examples show how to use this InSpec audit resource.
     end
 
 where `unix_socket_group` is set to the PostgreSQL default setting (the group to which the server user belongs).
+
+<br>
+
+## Matchers
+
+This InSpec audit resource has the following matchers. For a full list of available matchers please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/).
+
+### setting
+
+The `setting` matcher tests specific, named settings in the `postgresql.conf` file:
+
+    its('setting') { should eq 'value' }
+
+Use a `setting` matcher for each setting to be tested.

data/docs/resources/postgres_hba_conf.md.erb

@@ -5,6 +5,9 @@ title: About the postgres_hba_conf Resource
 # postgres_hba_conf
 
 Use the `postgres_hba_conf` InSpec audit resource to test the client authentication data defined in the pg_hba.conf file.
+
+<br>
+
 ## Syntax
 
 An `postgres_hba_conf` InSpec audit resource block declares client authentication data that should be tested:
@@ -19,48 +22,14 @@ where
 * `'filter_value'` is the value that is to be filtered for
 * `'value'` is the value that is to be matched expected
 
-## Matchers
-
-This InSpec audit resource matches any service that is listed in the HBA configuration file:
-
-    its('auth_method') { should_not cmp 'peer' }
-
-or:
-
-    its('auth_method') { should cmp 'peer' }
-
-For example:
-
-    describe postgres_hba_conf.where { type == 'type' } do
-      its('auth_method') { should cmp 'value' }
-      its('user') { should cmp 'value' }
-    end
-
-### be
-
-<%= partial "/shared/matcher_be" %>
-
-### cmp
-
-<%= partial "/shared/matcher_cmp" %>
-
-### eq
-
-<%= partial "/shared/matcher_eq" %>
-
-### include
-
-<%= partial "/shared/matcher_include" %>
-
-### match
-
-<%= partial "/shared/matcher_match" %>
-
+<br>
 
 ## Supported Properties
 
     'address', 'auth_method', 'auth_params', 'conf_dir' , 'conf_file' , 'database', 'params' ,'type', 'user'
 
+<br>
+
 ## Property Examples and Return Types
 
 ### address([String])
@@ -70,7 +39,7 @@ For example:
     describe postgres_hba_conf.where { type == 'local' } do
       its('address') { should cmp 'value' }
     end
-    
+
 ### auth_method([String])
 
 `auth_method` returns a an array of strings that matches the where condition of the filter table
@@ -102,3 +71,22 @@ For example:
     describe postgres_hba_conf.where { database == 'acme_test_db' } do
       its('user') { should cmp 'value' }
     end
+
+<br>
+
+## Matchers
+
+This InSpec audit resource matches any service that is listed in the HBA configuration file. For a full list of available matchers please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/).
+
+    its('auth_method') { should_not cmp 'peer' }
+
+or:
+
+    its('auth_method') { should cmp 'peer' }
+
+For example:
+
+    describe postgres_hba_conf.where { type == 'type' } do
+      its('auth_method') { should cmp 'value' }
+      its('user') { should cmp 'value' }
+    end

data/docs/resources/postgres_ident_conf.md.erb

@@ -5,6 +5,9 @@ title: About the postgres_ident_conf Resource
 # postgres_ident_conf
 
 Use the `postgres_ident_conf` InSpec audit resource to test the client authentication data defined in the pg_hba.conf file.
+
+<br>
+
 ## Syntax
 
 An `postgres_ident_conf` InSpec audit resource block declares client authentication data that should be tested:
@@ -19,48 +22,14 @@ where
 * `'filter_value'` is the value that is to be filtered for
 * `'value'` is the value that is to be matched expected
 
-## Matchers
-
-This InSpec audit resource matches any service that is listed in the pg ident  configuration file:
-
-    its('pg_username') { should_not eq ['peer'] }
-
-or:
-
-    its('map_name') { should eq ['value'] }
-
-For example:
-
-    describe postgres_ident_conf.where { pg_username == 'name' } do
-      its('system_username') { should eq ['value'] }
-      its('map_name') { should eq ['value'] }
-    end
-
-### be
-
-<%= partial "/shared/matcher_be" %>
-
-### cmp
-
-<%= partial "/shared/matcher_cmp" %>
-
-### eq
-
-<%= partial "/shared/matcher_eq" %>
-
-### include
-
-<%= partial "/shared/matcher_include" %>
-
-### match
-
-<%= partial "/shared/matcher_match" %>
-
+<br>
 
 ## Supported Properties
 
     'conf_file', 'map_name', 'params', 'pg_username', 'system_username'
 
+<br>
+
 ## Property Examples and Return Types
 
 ### map_name([String])
@@ -85,3 +54,22 @@ For example:
     describe pg_hba_conf.where { pg_username == 'name' } do
       its('system_username') { should eq ['value'] }
     end
+
+<br>
+
+## Matchers
+
+This InSpec audit resource matches any service that is listed in the pg ident configuration file. For a full list of available matchers please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/).
+
+    its('pg_username') { should_not eq ['peer'] }
+
+or:
+
+    its('map_name') { should eq ['value'] }
+
+For example:
+
+    describe postgres_ident_conf.where { pg_username == 'name' } do
+      its('system_username') { should eq ['value'] }
+      its('map_name') { should eq ['value'] }
+    end

data/docs/resources/postgres_session.md.erb

@@ -6,6 +6,8 @@ title: About the postgres_session Resource
 
 Use the `postgres_session` InSpec audit resource to test SQL commands run against a PostgreSQL database.
 
+<br>
+
 ## Syntax
 
 A `postgres_session` resource block declares the username and password to use for the session, and then the command to be run:
@@ -29,35 +31,7 @@ A full example is:
 
 where `its('output') { should eq '' }` compares the results of the query against the expected result in the test
 
-## Matchers
-
-This InSpec audit resource has the following matchers:
-
-### be
-
-<%= partial "/shared/matcher_be" %>
-
-### cmp
-
-<%= partial "/shared/matcher_cmp" %>
-
-### eq
-
-<%= partial "/shared/matcher_eq" %>
-
-### include
-
-<%= partial "/shared/matcher_include" %>
-
-### match
-
-<%= partial "/shared/matcher_match" %>
-
-### output
-
-The `output` matcher tests the results of the query:
-
-    its('output') { should eq(/^0/) }
+<br>
 
 ## Examples
 
@@ -80,3 +54,15 @@ The following examples show how to use this InSpec audit resource.
                   AND lanname!=\'c\';', ['postgres']) do
       its('output') { should eq '0' }
     end
+
+<br>
+
+## Matchers
+
+This InSpec audit resource has the following matchers. For a full list of available matchers please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/).
+
+### output
+
+The `output` matcher tests the results of the query:
+
+    its('output') { should eq(/^0/) }

data/docs/resources/powershell.md.erb

@@ -6,6 +6,8 @@ title: About the powershell Resource
 
 Use the `powershell` InSpec audit resource to test a Powershell script on the Windows platform.
 
+<br>
+
 ## 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:
@@ -24,48 +26,7 @@ where
 * `'matcher'` is one of `exit_status`, `stderr`, or `stdout`
 * `'output'` tests the output of the command run on the system versus the output value stated in the test
 
-
-## Matchers
-
-This InSpec audit resource has the following matchers:
-
-### be
-
-<%= partial "/shared/matcher_be" %>
-
-### cmp
-
-<%= partial "/shared/matcher_cmp" %>
-
-### eq
-
-<%= partial "/shared/matcher_eq" %>
-
-### exit_status
-
-The `exit_status` matcher tests the exit status for the command:
-
-    its('exit_status') { should eq 123 }
-
-### include
-
-<%= partial "/shared/matcher_include" %>
-
-### match
-
-<%= partial "/shared/matcher_match" %>
-
-### stderr
-
-The `stderr` matcher tests results of the command as returned in standard error (stderr):
-
-    its('stderr') { should eq 'error' }
-
-### stdout
-
-The `stdout` matcher tests results of the command as returned in standard output (stdout):
-
-    its('stdout') { should eq '/^1$/' }
+<br>
 
 ## Examples
 
@@ -114,3 +75,27 @@ No newline:
       its('stdout') { should eq 'hello' }
       its('stderr') { should eq '' }
     end
+
+<br>
+
+## Matchers
+
+This InSpec audit resource has the following matchers. For a full list of available matchers please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/).
+
+### exit_status
+
+The `exit_status` matcher tests the exit status for the command:
+
+    its('exit_status') { should eq 123 }
+
+### stderr
+
+The `stderr` matcher tests results of the command as returned in standard error (stderr):
+
+    its('stderr') { should eq 'error' }
+
+### stdout
+
+The `stdout` matcher tests results of the command as returned in standard output (stdout):
+
+    its('stdout') { should eq '/^1$/' }

data/docs/resources/processes.md.erb

@@ -6,6 +6,8 @@ title: About the processes Resource
 
 Use the `processes` InSpec audit resource to test properties for programs that are running on the system.
 
+<br>
+
 ## Syntax
 
 A `processes` resource block declares the name of the process to be tested, and then declares one (or more) property/value pairs:
@@ -16,39 +18,10 @@ A `processes` resource block declares the name of the process to be tested, and
 
 where
 
-* `processes('process_name')` specifies the name of a process to check. If this is a string, it will be converted to a Regexp. For more specificity, pass a Regexp directly.
+* `processes('process_name')` specifies the name of a process to check. If this is a string, it will be converted to a Regexp. For more specificity, pass a Regexp directly. If left blank, all processes will be returned.
 * `property_name` may be used to test user (`its('users')`) and state properties (`its('states')`)
 
-
-## Matchers
-
-This InSpec audit resource has the following matchers:
-
-### be
-
-<%= partial "/shared/matcher_be" %>
-
-### cmp
-
-<%= partial "/shared/matcher_cmp" %>
-
-### eq
-
-<%= partial "/shared/matcher_eq" %>
-
-### include
-
-<%= partial "/shared/matcher_include" %>
-
-### match
-
-<%= partial "/shared/matcher_match" %>
-
-### property_name
-
-The `property_name` matcher tests the named property for the specified value:
-
-    its('property_name') { should eq ['property_value'] }
+<br>
 
 ## Examples
 
@@ -100,9 +73,9 @@ needed.
 ### Notes for auditing Windows systems
 
 Sometimes with system properties there isn't a direct comparison between different operating systems.
-Most of the `property_name`'s do align between the different OS's.  
+Most of the `property_name`'s do align between the different OS's.
 
-There are however some exception's, for example, within linux `states` offers multiple properties. 
+There are however some exception's, for example, within linux `states` offers multiple properties.
 Windows doesn't have direct comparison that is a single property so instead `states` is mapped to the property of `Responding`, This is a boolean true/false flag to help determine if the process is hung.
 
 Below is a mapping table to help you understand what property the unix field maps to the windows `Get-Process` Property
@@ -121,3 +94,14 @@ Below is a mapping table to help you understand what property the unix field map
 |time             |TotalProcessorTime|
 |users            |UserName|
 |commands         |Path|
+
+
+## Matchers
+
+This InSpec audit resource has the following matchers. For a full list of available matchers please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/).
+
+### property_name
+
+The `property_name` matcher tests the named property for the specified value:
+
+    its('property_name') { should eq ['property_value'] }

data/docs/resources/rabbitmq_config.md.erb

@@ -6,6 +6,8 @@ title: About the rabbitmq_config Resource
 
 Use the `rabbitmq_config` InSpec audit resource to test configuration data for the RabbitMQ daemon located at `/etc/rabbitmq/rabbitmq.config` on Linux and Unix platforms.
 
+<br>
+
 ## Syntax
 
 A `rabbitmq_config` resource block declares the RabbitMQ configuration data to be tested:
@@ -19,30 +21,7 @@ where
 * `params` is the list of parameters configured in the RabbitMQ config file
 * `{ should cmp 5671 }` tests the value of `rabbit.ssl_listeners` as read from `rabbitmq.config` versus the value declared in the test
 
-
-## Matchers
-
-This InSpec audit resource has the following matchers:
-
-### be
-
-<%= partial "/shared/matcher_be" %>
-
-### cmp
-
-<%= partial "/shared/matcher_cmp" %>
-
-### eq
-
-<%= partial "/shared/matcher_eq" %>
-
-### include
-
-<%= partial "/shared/matcher_include" %>
-
-### match
-
-<%= partial "/shared/matcher_match" %>
+<br>
 
 ## Examples
 
@@ -53,3 +32,9 @@ The following examples show how to use this InSpec audit resource.
     describe rabbitmq_config.params('rabbit', 'tcp_listeners') do
       it { should eq [5672] }
     end
+
+<br>
+
+## Matchers
+
+For a full list of available matchers please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/).