inspec 2.0.16 → 2.0.17

data/docs/resources/login_def.md.erb

@@ -1,71 +1,71 @@
----
-title: About the login_defs Resource
-platform: linux
----
-
-# login_defs
-
-Use the `login_defs` InSpec audit resource to test configuration settings in the `/etc/login.defs` file. The `logins.defs` file defines site-specific configuration for the shadow password suite on Linux and Unix platforms, such as password expiration ranges, minimum/maximum values for automatic selection of user and group identifiers, or the method with which passwords are encrypted.
-
-<br>
-
-## Syntax
-
-A `login_defs` resource block declares the `login.defs` configuration data to be tested:
-
-    describe login_defs do
-      its('name') { should include('foo') }
-    end
-
-where
-
-* `name` is a configuration setting in `login.defs`
-* `{ should include('foo') }` tests the value of `name` as read from `login.defs` versus the value declared in the test
-
-<br>
-
-## Properties
-
-This resource supports the properties found in the `login.defs` configuration settings.
-
-<br>
-
-## Examples
-
-The following examples show how to use this InSpec audit resource.
-
-### name
-
-The `name` matcher tests the value of `name` as read from `login.defs` versus the value declared in the test:
-
-    its('name') { should eq 'foo' }
-
-### Test password expiration settings
-
-    describe login_defs do
-      its('PASS_MAX_DAYS') { should eq '180' }
-      its('PASS_MIN_DAYS') { should eq '1' }
-      its('PASS_MIN_LEN') { should eq '15' }
-      its('PASS_WARN_AGE') { should eq '30' }
-    end
-
-### Test the encryption method
-
-    describe login_defs do
-      its('ENCRYPT_METHOD') { should eq 'SHA512' }
-    end
-
-### Test umask setting
-
-    describe login_def do
-      its('UMASK') { should eq '077' }
-      its('PASS_MAX_DAYS') { should eq '90' }
-    end
-
-<br>
-
-## Matchers
-
-For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/).
-
-
+---
+title: About the login_defs Resource
+platform: linux
+---
+
+# login_defs
+
+Use the `login_defs` InSpec audit resource to test configuration settings in the `/etc/login.defs` file. The `logins.defs` file defines site-specific configuration for the shadow password suite on Linux and Unix platforms, such as password expiration ranges, minimum/maximum values for automatic selection of user and group identifiers, or the method with which passwords are encrypted.
+
+<br>
+
+## Syntax
+
+A `login_defs` resource block declares the `login.defs` configuration data to be tested:
+
+    describe login_defs do
+      its('name') { should include('foo') }
+    end
+
+where
+
+* `name` is a configuration setting in `login.defs`
+* `{ should include('foo') }` tests the value of `name` as read from `login.defs` versus the value declared in the test
+
+<br>
+
+## Properties
+
+This resource supports the properties found in the `login.defs` configuration settings.
+
+<br>
+
+## Examples
+
+The following examples show how to use this InSpec audit resource.
+
+### name
+
+The `name` matcher tests the value of `name` as read from `login.defs` versus the value declared in the test:
+
+    its('name') { should eq 'foo' }
+
+### Test password expiration settings
+
+    describe login_defs do
+      its('PASS_MAX_DAYS') { should eq '180' }
+      its('PASS_MIN_DAYS') { should eq '1' }
+      its('PASS_MIN_LEN') { should eq '15' }
+      its('PASS_WARN_AGE') { should eq '30' }
+    end
+
+### Test the encryption method
+
+    describe login_defs do
+      its('ENCRYPT_METHOD') { should eq 'SHA512' }
+    end
+
+### Test umask setting
+
+    describe login_def do
+      its('UMASK') { should eq '077' }
+      its('PASS_MAX_DAYS') { should eq '90' }
+    end
+
+<br>
+
+## Matchers
+
+For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/).
+
+

data/docs/resources/mount.md.erb

@@ -1,69 +1,69 @@
----
-title: About the mount Resource
-platform: linux
----
-
-# mount
-
-Use the `mount` InSpec audit resource to test the mount points on FreeBSD and Linux systems.
-
-<br>
-
-## Syntax
-
-An `mount` resource block declares the synchronization settings that should be tested:
-
-    describe mount('path') do
-      it { should MATCHER 'value' }
-    end
-
-where
-
-* `('path')` is the path to the mounted directory
-* `MATCHER` is a valid matcher for this resource
-* `'value'` is the value to be tested
-
-<br>
-
-## Examples
-
-The following examples show how to use this InSpec audit resource.
-
-### Test a the mount point on '/'
-
-    describe mount('/') do
-      it { should be_mounted }
-      its('device') { should eq  '/dev/mapper/VolGroup-lv_root' }
-      its('type') { should eq  'ext4' }
-      its('options') { should eq ['rw', 'mode=620'] }
-    end
-
-<br>
-
-## Matchers
-
-For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/).
-
-### be_mounted
-
-The `be_mounted` matcher tests if the file is accessible from the file system:
-
-    it { should be_mounted }
-
-### device
-
-The `device` matcher tests the device from the `fstab` table:
-
-    its('device') { should eq  '/dev/mapper/VolGroup-lv_root' }
-
-### options
-
-The `options` matcher tests the mount options for the file system from the `fstab` table:
-
-    its('options') { should eq ['rw', 'mode=620'] }
-
-### type
-
-The `type` matcher tests the file system type:
-
-    its('type') { should eq  'ext4' }
+---
+title: About the mount Resource
+platform: linux
+---
+
+# mount
+
+Use the `mount` InSpec audit resource to test the mount points on FreeBSD and Linux systems.
+
+<br>
+
+## Syntax
+
+An `mount` resource block declares the synchronization settings that should be tested:
+
+    describe mount('path') do
+      it { should MATCHER 'value' }
+    end
+
+where
+
+* `('path')` is the path to the mounted directory
+* `MATCHER` is a valid matcher for this resource
+* `'value'` is the value to be tested
+
+<br>
+
+## Examples
+
+The following examples show how to use this InSpec audit resource.
+
+### Test a the mount point on '/'
+
+    describe mount('/') do
+      it { should be_mounted }
+      its('device') { should eq  '/dev/mapper/VolGroup-lv_root' }
+      its('type') { should eq  'ext4' }
+      its('options') { should eq ['rw', 'mode=620'] }
+    end
+
+<br>
+
+## Matchers
+
+For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/).
+
+### be_mounted
+
+The `be_mounted` matcher tests if the file is accessible from the file system:
+
+    it { should be_mounted }
+
+### device
+
+The `device` matcher tests the device from the `fstab` table:
+
+    its('device') { should eq  '/dev/mapper/VolGroup-lv_root' }
+
+### options
+
+The `options` matcher tests the mount options for the file system from the `fstab` table:
+
+    its('options') { should eq ['rw', 'mode=620'] }
+
+### type
+
+The `type` matcher tests the file system type:
+
+    its('type') { should eq  'ext4' }

data/docs/resources/mssql_session.md.erb

@@ -1,60 +1,60 @@
----
-title: About the mssql_session Resource
-platform: windows
----
-
-# mssql_session
-
-Use the `mssql_session` InSpec audit resource to test SQL commands run against a Microsoft SQL database.
-
-<br>
-
-## Syntax
-
-A `mssql_session` resource block declares the username and password to use for the session, and then the command to be run:
-
-    describe mssql_session(user: 'username', password: 'password').query('QUERY').row(0).column('result') do
-      its('value') { should eq('') }
-    end
-
-where
-
-* `mssql_session` declares a username and password with permission to run the query.  Omitting the username or password parameters results in the use of Windows authentication as the user InSpec is executing as.  You may also optionally pass a host and instance name.  If omitted, they will default to host: localhost and the default instance.
-* `query('QUERY')` contains the query to be run
-* `its('value') { should eq('') }` compares the results of the query against the expected result in the test
-
-<br>
-
-## Examples
-
-The following examples show how to use this InSpec audit resource.
-
-### Test for matching databases
-
-    sql = mssql_session(user: 'my_user', password: 'password')
-
-    describe sql.query("SELECT SERVERPROPERTY('ProductVersion') as result").row(0).column('result') do
-      its("value") { should cmp > '12.00.4457' }
-    end
-
-### Test using Windows authentication
-
-    sql = mssql_session
-
-    describe sql.query("SELECT SERVERPROPERTY('ProductVersion') as result").row(0).column('result') do
-      its("value") { should cmp > '12.00.4457' }
-    end
-
-### Test a specific host and instance
-
-    sql = mssql_session(user: 'my_user', password: 'password', host: 'mssqlserver', instance: 'foo')
-
-    describe sql.query("SELECT SERVERPROPERTY('ProductVersion') as result").row(0).column('result') do
-      its("value") { should cmp > '12.00.4457' }
-    end
-
-<br>
-
-## Matchers
-
-For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/).
+---
+title: About the mssql_session Resource
+platform: windows
+---
+
+# mssql_session
+
+Use the `mssql_session` InSpec audit resource to test SQL commands run against a Microsoft SQL database.
+
+<br>
+
+## Syntax
+
+A `mssql_session` resource block declares the username and password to use for the session, and then the command to be run:
+
+    describe mssql_session(user: 'username', password: 'password').query('QUERY').row(0).column('result') do
+      its('value') { should eq('') }
+    end
+
+where
+
+* `mssql_session` declares a username and password with permission to run the query.  Omitting the username or password parameters results in the use of Windows authentication as the user InSpec is executing as.  You may also optionally pass a host and instance name.  If omitted, they will default to host: localhost and the default instance.
+* `query('QUERY')` contains the query to be run
+* `its('value') { should eq('') }` compares the results of the query against the expected result in the test
+
+<br>
+
+## Examples
+
+The following examples show how to use this InSpec audit resource.
+
+### Test for matching databases
+
+    sql = mssql_session(user: 'my_user', password: 'password')
+
+    describe sql.query("SELECT SERVERPROPERTY('ProductVersion') as result").row(0).column('result') do
+      its("value") { should cmp > '12.00.4457' }
+    end
+
+### Test using Windows authentication
+
+    sql = mssql_session
+
+    describe sql.query("SELECT SERVERPROPERTY('ProductVersion') as result").row(0).column('result') do
+      its("value") { should cmp > '12.00.4457' }
+    end
+
+### Test a specific host and instance
+
+    sql = mssql_session(user: 'my_user', password: 'password', host: 'mssqlserver', instance: 'foo')
+
+    describe sql.query("SELECT SERVERPROPERTY('ProductVersion') as result").row(0).column('result') do
+      its("value") { should cmp > '12.00.4457' }
+    end
+
+<br>
+
+## Matchers
+
+For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/).

data/docs/resources/mysql_conf.md.erb

@@ -1,99 +1,99 @@
----
-title: About the mysql_conf Resource
-platform: os
----
-
-# mysql_conf
-
-Use the `mysql_conf` InSpec audit resource to test the contents of the configuration file for MySQL, typically located at `/etc/mysql/my.cnf` or `/etc/my.cnf`.
-
-<br>
-
-## Syntax
-
-A `mysql_conf` resource block declares one (or more) settings in the `my.cnf` file, and then compares the setting in the configuration file to the value stated in the test:
-
-    describe mysql_conf('path') do
-      its('setting') { should eq 'value' }
-    end
-
-    # Test a parameter set within the [mysqld] section
-    describe mysql_conf do
-      its('mysqld.port') { should cmp 3306 }
-    end
-
-    # Test a parameter set within the [mariadb] section using array notation
-    describe mysql_conf do
-      its(['mariadb', 'max-connections']) { should_not be_nil }
-    end
-
-where
-
-* `'setting'` specifies a setting in the `my.cnf` file, such as `max_connections`
-  * when checking a setting within sections, such as `[mysqld]`, the section name must be included
-* `('path')` is the non-default path to the `my.cnf` file
-* `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 connections
-
-    describe mysql_conf do
-      its('max_connections') { should eq '505' }
-      its('max_user_connections') { should eq '500' }
-    end
-
-### Test slow query logging**
-
-    describe mysql_conf do
-      its('slow_query_log_file') { should eq 'hostname_slow.log' }
-      its('slow_query_log') { should eq '0' }
-      its('log_queries_not_using_indexes') { should eq '1' }
-      its('long_query_time') { should eq '0.5' }
-      its('min_examined_row_limit') { should eq '100' }
-    end
-
-### Test the port and socket on which MySQL listens
-
-    describe mysql_conf do
-      its('port') { should eq '3306' }
-      its('socket') { should eq '/var/run/mysqld/mysql.sock' }
-    end
-
-### Test connection and thread variables
-
-    describe mysql_conf do
-      its('port') { should eq '3306' }
-      its('socket') { should eq '/var/run/mysqld/mysql.sock' }
-      its('max_allowed_packet') { should eq '12M' }
-      its('default_storage_engine') { should eq 'InnoDB' }
-      its('character_set_server') { should eq 'utf8' }
-      its('collation_server') { should eq 'utf8_general_ci' }
-      its('max_connections') { should eq '505' }
-      its('max_user_connections') { should eq '500' }
-      its('thread_cache_size') { should eq '505' }
-    end
-
-### Test the safe-user-create parameter
-
-    describe mysql_conf.params('mysqld') do
-      its('safe-user-create') { should eq('1') }
-    end
-
-<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 `my.cnf` file:
-
-    its('setting') { should eq 'value' }
-
-Use a `setting` matcher for each setting to be tested.
+---
+title: About the mysql_conf Resource
+platform: os
+---
+
+# mysql_conf
+
+Use the `mysql_conf` InSpec audit resource to test the contents of the configuration file for MySQL, typically located at `/etc/mysql/my.cnf` or `/etc/my.cnf`.
+
+<br>
+
+## Syntax
+
+A `mysql_conf` resource block declares one (or more) settings in the `my.cnf` file, and then compares the setting in the configuration file to the value stated in the test:
+
+    describe mysql_conf('path') do
+      its('setting') { should eq 'value' }
+    end
+
+    # Test a parameter set within the [mysqld] section
+    describe mysql_conf do
+      its('mysqld.port') { should cmp 3306 }
+    end
+
+    # Test a parameter set within the [mariadb] section using array notation
+    describe mysql_conf do
+      its(['mariadb', 'max-connections']) { should_not be_nil }
+    end
+
+where
+
+* `'setting'` specifies a setting in the `my.cnf` file, such as `max_connections`
+  * when checking a setting within sections, such as `[mysqld]`, the section name must be included
+* `('path')` is the non-default path to the `my.cnf` file
+* `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 connections
+
+    describe mysql_conf do
+      its('max_connections') { should eq '505' }
+      its('max_user_connections') { should eq '500' }
+    end
+
+### Test slow query logging**
+
+    describe mysql_conf do
+      its('slow_query_log_file') { should eq 'hostname_slow.log' }
+      its('slow_query_log') { should eq '0' }
+      its('log_queries_not_using_indexes') { should eq '1' }
+      its('long_query_time') { should eq '0.5' }
+      its('min_examined_row_limit') { should eq '100' }
+    end
+
+### Test the port and socket on which MySQL listens
+
+    describe mysql_conf do
+      its('port') { should eq '3306' }
+      its('socket') { should eq '/var/run/mysqld/mysql.sock' }
+    end
+
+### Test connection and thread variables
+
+    describe mysql_conf do
+      its('port') { should eq '3306' }
+      its('socket') { should eq '/var/run/mysqld/mysql.sock' }
+      its('max_allowed_packet') { should eq '12M' }
+      its('default_storage_engine') { should eq 'InnoDB' }
+      its('character_set_server') { should eq 'utf8' }
+      its('collation_server') { should eq 'utf8_general_ci' }
+      its('max_connections') { should eq '505' }
+      its('max_user_connections') { should eq '500' }
+      its('thread_cache_size') { should eq '505' }
+    end
+
+### Test the safe-user-create parameter
+
+    describe mysql_conf.params('mysqld') do
+      its('safe-user-create') { should eq('1') }
+    end
+
+<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 `my.cnf` file:
+
+    its('setting') { should eq 'value' }
+
+Use a `setting` matcher for each setting to be tested.