inspec 2.0.16 → 2.0.17

data/docs/resources/postgres_conf.md.erb

@@ -1,79 +1,79 @@
----
-title: About the postgres_conf Resource
-platform: os
----
-
-# postgres_conf
-
-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:
-
-    describe postgres_conf('path') do
-      its('setting') { should eq 'value' }
-    end
-
-
-where
-
-* `'setting'` specifies a setting in the `postgresql.conf` file
-* `('path')` is the non-default path to the `postgresql.conf` file (optional)
-* `should eq 'value'` is the value that is expected
-
-<br>
-
-## Examples
-
-The following examples show how to use this InSpec audit resource.
-
-### Test the maximum number of allowed client connections
-
-    describe postgres_conf do
-      its('max_connections') { should eq '5' }
-    end
-
-### Test system logging
-
-    describe postgres_conf do
-      its('logging_collector') { should eq 'on' }
-      its('log_connections') { should eq 'on' }
-      its('log_disconnections') { should eq 'on' }
-      its('log_duration') { should eq 'on' }
-      its('log_hostname') { should eq 'on' }
-      its('log_line_prefix') { should eq '%t %u %d %h' }
-      its(['pgaudit.log_parameter']) { should cmp 'on' }
-    end
-
-### Test the port on which PostgreSQL listens
-
-    describe postgres_conf do
-      its('port') { should eq '5432' }
-    end
-
-### Test the Unix socket settings
-
-    describe postgres_conf do
-      its('unix_socket_directories') { should eq '.s.PGSQL.5432' }
-      its('unix_socket_group') { should eq nil }
-      its('unix_socket_permissions') { should eq '0770' }
-    end
-
-where `unix_socket_group` is set to the PostgreSQL default setting (the group to which the server user belongs).
-
-<br>
-
-## 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.
+---
+title: About the postgres_conf Resource
+platform: os
+---
+
+# postgres_conf
+
+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:
+
+    describe postgres_conf('path') do
+      its('setting') { should eq 'value' }
+    end
+
+
+where
+
+* `'setting'` specifies a setting in the `postgresql.conf` file
+* `('path')` is the non-default path to the `postgresql.conf` file (optional)
+* `should eq 'value'` is the value that is expected
+
+<br>
+
+## Examples
+
+The following examples show how to use this InSpec audit resource.
+
+### Test the maximum number of allowed client connections
+
+    describe postgres_conf do
+      its('max_connections') { should eq '5' }
+    end
+
+### Test system logging
+
+    describe postgres_conf do
+      its('logging_collector') { should eq 'on' }
+      its('log_connections') { should eq 'on' }
+      its('log_disconnections') { should eq 'on' }
+      its('log_duration') { should eq 'on' }
+      its('log_hostname') { should eq 'on' }
+      its('log_line_prefix') { should eq '%t %u %d %h' }
+      its(['pgaudit.log_parameter']) { should cmp 'on' }
+    end
+
+### Test the port on which PostgreSQL listens
+
+    describe postgres_conf do
+      its('port') { should eq '5432' }
+    end
+
+### Test the Unix socket settings
+
+    describe postgres_conf do
+      its('unix_socket_directories') { should eq '.s.PGSQL.5432' }
+      its('unix_socket_group') { should eq nil }
+      its('unix_socket_permissions') { should eq '0770' }
+    end
+
+where `unix_socket_group` is set to the PostgreSQL default setting (the group to which the server user belongs).
+
+<br>
+
+## 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

@@ -1,93 +1,93 @@
----
-title: About the postgres_hba_conf Resource
-platform: linux
----
-
-# 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:
-
-    describe postgres_hba_conf.where { type == 'local' } do
-     its('auth_method') { should eq ['peer'] }
-    end
-
-where
-
-* `'attribute'` is a attribute in the  pg hba configuration file
-* `'filter_value'` is the value that is to be filtered for
-* `'value'` is the value that is to be matched expected
-
-<br>
-
-## Properties
-
-    'address', 'auth_method', 'auth_params', 'conf_dir' , 'conf_file' , 'database', 'params' ,'type', 'user'
-
-<br>
-
-## Property Examples
-
-### address([String])
-
-`address` returns a an array of strings that matches the where condition of the filter table
-
-    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
-
-    describe postgres_hba_conf.where { type == 'local' } do
-      its('auth_method') { should cmp 'value' }
-    end
-
-### database([String])
-
-`database` returns a an array of strings that matches the where condition of the filter table
-
-    describe postgres_hba_conf.where { type == 'local' } do
-      its('database') { should cmp 'value' }
-    end
-
-### type([String])
-
-`type` returns a an array of strings that matches the where condition of the filter table
-
-    describe postgres_hba_conf.where { database == 'acme_test_db' } do
-      its('type') { should cmp 'value' }
-    end
-
-### user([String])
-
-`user` returns a an array of strings that matches the where condition of the filter table
-
-    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
+---
+title: About the postgres_hba_conf Resource
+platform: linux
+---
+
+# 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:
+
+    describe postgres_hba_conf.where { type == 'local' } do
+     its('auth_method') { should eq ['peer'] }
+    end
+
+where
+
+* `'attribute'` is a attribute in the  pg hba configuration file
+* `'filter_value'` is the value that is to be filtered for
+* `'value'` is the value that is to be matched expected
+
+<br>
+
+## Properties
+
+    'address', 'auth_method', 'auth_params', 'conf_dir' , 'conf_file' , 'database', 'params' ,'type', 'user'
+
+<br>
+
+## Property Examples
+
+### address([String])
+
+`address` returns a an array of strings that matches the where condition of the filter table
+
+    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
+
+    describe postgres_hba_conf.where { type == 'local' } do
+      its('auth_method') { should cmp 'value' }
+    end
+
+### database([String])
+
+`database` returns a an array of strings that matches the where condition of the filter table
+
+    describe postgres_hba_conf.where { type == 'local' } do
+      its('database') { should cmp 'value' }
+    end
+
+### type([String])
+
+`type` returns a an array of strings that matches the where condition of the filter table
+
+    describe postgres_hba_conf.where { database == 'acme_test_db' } do
+      its('type') { should cmp 'value' }
+    end
+
+### user([String])
+
+`user` returns a an array of strings that matches the where condition of the filter table
+
+    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

@@ -1,76 +1,76 @@
----
-title: About the postgres_ident_conf Resource
-platform: linux
----
-
-# 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:
-
-    describe postgres_ident_conf.where { pg_username == 'filter_value' } do
-      its('attribute') { should eq ['value'] }
-    end
-
-where
-
-* `'attribute'` is a attribute in the  pg ident configuration file
-* `'filter_value'` is the value that is to be filtered for
-* `'value'` is the value that is to be matched expected
-
-<br>
-
-## Properties
-
-    'conf_file', 'map_name', 'params', 'pg_username', 'system_username'
-
-<br>
-
-## Property Examples
-
-### map_name([String])
-
-`address` returns a an array of strings that matches the where condition of the filter table
-
-    describe pg_hba_conf.where { pg_username == 'name' } do
-      its('map_name') { should eq ['value'] }
-    end
-### pg_username([String])
-
-`pg_username` returns a an array of strings that matches the where condition of the filter table
-
-    describe pg_hba_conf.where { pg_username == 'name' } do
-      its('pg_username') { should eq ['value'] }
-    end
-
-### system_username([String])
-
-`system_username` returns a an array of strings that matches the where condition of the filter table
-
-    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
+---
+title: About the postgres_ident_conf Resource
+platform: linux
+---
+
+# 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:
+
+    describe postgres_ident_conf.where { pg_username == 'filter_value' } do
+      its('attribute') { should eq ['value'] }
+    end
+
+where
+
+* `'attribute'` is a attribute in the  pg ident configuration file
+* `'filter_value'` is the value that is to be filtered for
+* `'value'` is the value that is to be matched expected
+
+<br>
+
+## Properties
+
+    'conf_file', 'map_name', 'params', 'pg_username', 'system_username'
+
+<br>
+
+## Property Examples
+
+### map_name([String])
+
+`address` returns a an array of strings that matches the where condition of the filter table
+
+    describe pg_hba_conf.where { pg_username == 'name' } do
+      its('map_name') { should eq ['value'] }
+    end
+### pg_username([String])
+
+`pg_username` returns a an array of strings that matches the where condition of the filter table
+
+    describe pg_hba_conf.where { pg_username == 'name' } do
+      its('pg_username') { should eq ['value'] }
+    end
+
+### system_username([String])
+
+`system_username` returns a an array of strings that matches the where condition of the filter table
+
+    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