inspec 1.31.0 → 1.45.9

data/docs/resources/mysql_conf.md.erb

@@ -6,6 +6,8 @@ title: About the mysql_conf Resource
 
 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:
@@ -14,44 +16,24 @@ A `mysql_conf` resource block declares one (or more) settings in the `my.cnf` fi
       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
 
-
-## 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 `my.cnf` file:
-
-    its('setting') { should eq 'value' }
-
-Use a `setting` matcher for each setting to be tested.
+<br>
 
 ## Examples
 
@@ -100,3 +82,17 @@ The following examples show how to use this InSpec audit resource.
     describe mysql_conf.params('mysqld') do
       its('safe-user-create') { should eq('1') }
     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/).
+
+### 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.

data/docs/resources/mysql_session.md.erb

@@ -6,6 +6,8 @@ title: About the mysql_session Resource
 
 Use the `mysql_session` InSpec audit resource to test SQL commands run against a MySQL database.
 
+<br>
+
 ## Syntax
 
 A `mysql_session` resource block declares the username and password to use for the session, and then the command to be run:
@@ -20,35 +22,7 @@ where
 * `query('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
-
-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
 
@@ -73,3 +47,15 @@ The following examples show how to use this InSpec audit resource.
 ### Alternate Connection: Using a socket
 
   sql = mysql_session('my_user','password', nil, nil, '/var/lib/mysql-default/mysqld.sock')
+
+<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/nginx.md.erb

@@ -0,0 +1,78 @@
+---
+title: The Nginx Resource
+---
+
+# nginx
+
+Use the `nginx` InSpec audit resource to test the fields and validity of nginx.
+
+Nginx resource extracts and exposes data reported by the command 'nginx -V'
+
+<br>
+
+## Syntax
+
+An `nginx` InSpec audit resource block extracts configuration settings that should be tested:
+
+    describe nginx do
+      its('attribute') { should eq 'value' }
+    end
+
+    describe nginx('path to nginx') do
+      its('attribute') { should eq 'value' }
+    end
+
+where
+
+* `'attribute'` is a configuration parsed from result of the command 'nginx -V'
+* `'value'` is the value that is expected of the attribute
+
+<br>
+
+## Supported Properties
+
+* 'compiler_info',  'error_log_path',  'http_client_body_temp_path',  'http_fastcgi_temp_path',  'http_log_path',  'http_proxy_temp_path',  'http_scgi_temp_path',  'http_uwsgi_temp_path',  'lock_path',  'modules', 'modules_path',  'openssl_version',  'prefix',  'sbin_path',  'service',  'support_info',  'version'
+
+<br>
+
+## Property Examples and Return Types
+
+### version(String)
+
+`version` returns a string of the version of the running nginx instance
+
+    describe nginx do
+      its('version') { should eq '1.12.0' }
+    end
+
+### modules(String)
+
+`modules` returns a array modules in the running nginx instance
+
+    describe nginx do
+      its('modules') { should include 'my_module' }
+    end
+
+### openssl_version(Hash)
+
+`openssl_version ` returns a hash with 'version' and 'date' as keys
+
+    describe nginx do
+      its('openssl_version.date') { should eq '11 Feb 2013' }
+    end
+
+### compiler_info(Hash)
+
+`compiler_info ` returns a hash with 'compiler' , version' and 'date' as keys
+
+    describe nginx do
+      its('compiler_info.compiler') { should eq 'gcc' }
+    end
+
+### support_info(String)
+
+`support_info ` returns a string containing supported protocols
+
+    describe nginx do
+      its('support_info') { should match /TLS/ }
+    end

data/docs/resources/nginx_conf.md.erb

@@ -0,0 +1,127 @@
+---
+title: About the nginx_conf Resource
+---
+
+# nginx_conf
+
+Use the `nginx_conf` InSpec resource to test configuration data for the NGINX server located at `/etc/nginx/nginx.conf` on Linux and Unix platforms.
+
+**Stability: Experimental**
+
+<br>
+
+## Syntax
+
+An `nginx_conf` resource block declares the client NGINX configuration data to be tested:
+
+    describe nginx_conf.params['pid'] do
+      it { should cmp 'logs/nginx.pid' }
+    end
+
+where
+
+* `nginx_conf` is the resource to reference your NGINX configuration
+* `params` accesses all its parameters
+* `params['pid']` selects the `pid` entry from the global NGINX configuration
+* `{ should cmp 'logs/nginx.pid' }` tests if the PID is set to `logs/nginx.pid` (via `cmp` matcher)
+
+<br>
+
+## Examples
+
+The following examples show how to use this InSpec audit resource.
+
+### Find a specific server
+
+    servers = nginx_conf.servers
+    domain2 = servers.find { |s| s.params['server_name'].flatten.include? 'domain2.com' }
+    describe 'No server serves domain2' do
+      subject { domain2 }
+      it { should be_nil }
+    end
+
+### Test a raw parameter
+
+    describe nginx_conf.params['worker_processes'].flatten do
+      it { should cmp 5 }
+    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/).
+
+### http
+
+Retrieves all `http` entries in the configuration file.
+
+    nginx_conf.http
+    => nginx_conf /etc/nginx/nginx.conf, http entries
+
+It provides further access to all individual entries, servers, and locations.
+
+    nginx_conf.http.entries
+    => [nginx_conf /etc/nginx/nginx.conf, http entry ...]
+
+    nginx_conf.http.servers
+    => [nginx_conf /etc/nginx/nginx.conf, server entry ...]
+
+    nginx_conf.http.locations
+    => [nginx_conf /etc/nginx/nginx.conf, location entry ...]
+
+You can access each of these from the array and inspect it further (see below).
+
+### servers
+
+Retrieve all `servers` entries in the configuration:
+
+    # all servers across all configs aggregated:
+    nginx_conf.servers
+    => [nginx_conf /etc/nginx/nginx.conf, server entry ...]
+
+    # servers that belong to a specific http entry:
+    nginx_conf.http.entries[0].servers
+    => [nginx_conf /etc/nginx/nginx.conf, server entry ...]
+
+Servers provide access to all their locations, parent http entry, and raw parameters:
+
+    server = nginx_conf.servers[0]
+
+    server.locations
+    => [nginx_conf /etc/nginx/nginx.conf, location entry ...]
+
+    server.parent
+    => nginx_conf /etc/nginx/nginx.conf, http entry
+
+    server.params
+    => {"listen"=>[["85"]],
+       "server_name"=>[["domain1.com", "www.domain1.com"]],
+       "root"=>[["html"]],
+       "location"=>[{"_"=>["~", "\\.php$"], "fastcgi_pass"=>[["127.0.0.1:1025"]]}]}
+
+### locations
+
+Retrieve all `location` entries in the configuration:
+
+    # all locations across all configs aggregated:
+    nginx_conf.locations
+    => [nginx_conf /etc/nginx/nginx.conf, location entry ...]
+
+    # locations of a http entry aggregated:
+    nginx_conf.http.entries[0].locations
+    => [nginx_conf /etc/nginx/nginx.conf, location entry ...]
+
+    # locations of a specific server:
+    nginx_conf.servers[0].locations
+    => [nginx_conf /etc/nginx/nginx.conf, location entry ...]
+
+Locations provide access to their parent server entry and raw parameters:
+
+    location = nginx_conf.locations[0]
+
+    location.parent
+    => nginx_conf /etc/nginx/nginx.conf, server entry
+
+    location.params
+    => {"_"=>["~", "\\.php$"], "fastcgi_pass"=>[["127.0.0.1:1025"]]}

data/docs/resources/npm.md.erb

@@ -6,6 +6,7 @@ title: About the npm Resource
 
 Use the `npm` InSpec audit resource to test if a global NPM package is installed. NPM is the the package manager for Node.js packages (https://docs.npmjs.com), such as Bower and StatsD.
 
+<br>
 
 ## Syntax
 
@@ -20,56 +21,39 @@ where
 * `('npm_package_name')` must specify an NPM package, such as `'bower'` or `'statsd'`
 * `be_installed` is a valid matcher for this resource
 
+<br>
 
-## Matchers
-
-This InSpec audit resource has the following matchers:
-
-### be
-
-<%= partial "/shared/matcher_be" %>
+## Examples
 
-### be_installed
+The following examples show how to use this InSpec audit resource.
 
-The `be_installed` matcher tests if the named Gem package and package version (if specified) is installed:
+### Verify that bower is installed, with a specific version
 
-    it { should be_installed }
+    describe npm('bower') do
+      it { should be_installed }
+      its('version') { should eq '1.4.1' }
+    end
 
-### cmp
+### Verify that statsd is not installed
 
-<%= partial "/shared/matcher_cmp" %>
+    describe npm('statsd') do
+      it { should_not be_installed }
+    end
 
-### eq
+<br>
 
-<%= partial "/shared/matcher_eq" %>
+## Matchers
 
-### include
+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/).
 
-<%= partial "/shared/matcher_include" %>
+### be_installed
 
-### match
+The `be_installed` matcher tests if the named Gem package and package version (if specified) is installed:
 
-<%= partial "/shared/matcher_match" %>
+    it { should be_installed }
 
 ### version
 
 The `version` matcher tests if the named package version is on the system:
 
     its('version') { should eq '1.2.3' }
-
-## Examples
-
-The following examples show how to use this InSpec audit resource.
-
-### Verify that bower is installed, with a specific version
-
-    describe npm('bower') do
-      it { should be_installed }
-      its('version') { should eq '1.4.1' }
-    end
-
-### Verify that statsd is not installed
-
-    describe npm('statsd') do
-      it { should_not be_installed }
-    end

data/docs/resources/ntp_conf.md.erb

@@ -6,6 +6,7 @@ title: About the ntp_conf Resource
 
 Use the `ntp_conf` InSpec audit resource to test the synchronization settings defined in the `ntp.conf` file. This file is typically located at `/etc/ntp.conf`.
 
+<br>
 
 ## Syntax
 
@@ -21,56 +22,38 @@ where
 * `('path')` is the non-default path to the `ntp.conf` file
 * `{ should eq 'value' }` is the value that is expected
 
+<br>
 
-## Matchers
-
-This resource matches any service that is listed in the `ntp.conf` file:
-
-    its('server') { should_not eq nil }
-
-or:
+## Examples
 
-    its('restrict') { should include '-4 default kod notrap nomodify nopeer noquery'}
+The following examples show how to use this InSpec audit resource.
 
-For example:
+### Test for clock drift against named servers
 
     describe ntp_conf do
-      its('server') { should_not eq nil }
-      its('restrict') { should include '-4 default kod notrap nomodify nopeer noquery'}
+      its('driftfile') { should eq '/var/lib/ntp/ntp.drift' }
+      its('server') { should eq [
+        0.ubuntu.pool.ntp.org,
+        1.ubuntu.pool.ntp.org,
+        2.ubuntu.pool.ntp.org
+      ] }
     end
 
+<br>
 
-### be
-
-<%= partial "/shared/matcher_be" %>
-
-### cmp
-
-<%= partial "/shared/matcher_cmp" %>
-
-### eq
-
-<%= partial "/shared/matcher_eq" %>
-
-### include
-
-<%= partial "/shared/matcher_include" %>
+## Matchers
 
-### match
+This resource matches any service that is listed in the `ntp.conf` file. For a full list of available matchers please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/).
 
-<%= partial "/shared/matcher_match" %>
+    its('server') { should_not eq nil }
 
-## Examples
+or:
 
-The following examples show how to use this InSpec audit resource.
+    its('restrict') { should include '-4 default kod notrap nomodify nopeer noquery'}
 
-### Test for clock drift against named servers
+For example:
 
     describe ntp_conf do
-      its('driftfile') { should eq '/var/lib/ntp/ntp.drift' }
-      its('server') { should eq [
-        0.ubuntu.pool.ntp.org,
-        1.ubuntu.pool.ntp.org,
-        2.ubuntu.pool.ntp.org
-      ] }
+      its('server') { should_not eq nil }
+      its('restrict') { should include '-4 default kod notrap nomodify nopeer noquery'}
     end

data/docs/resources/oneget.md.erb

@@ -6,6 +6,8 @@ title: About the oneget Resource
 
 Use the `oneget` InSpec audit resource to test if the named package and/or package version is installed on the system. This resource uses Oneget, which is `part of the Windows Management Framework 5.0 and Windows 10 <https://github.com/OneGet/oneget>`__. This resource uses the `Get-Package` cmdlet to return all of the package names in the Oneget repository.
 
+<br>
+
 ## Syntax
 
 A `oneget` resource block declares a package and (optionally) a package version:
@@ -19,49 +21,32 @@ where
 * `('name')` must specify the name of a package, such as `'VLC'`
 * `be_installed` is a valid matcher for this resource
 
+<br>
 
-## Matchers
-
-This InSpec audit resource has the following matchers:
-
-### be
-
-<%= partial "/shared/matcher_be" %>
-
-### be_installed
-
-The `be_installed` matcher tests if the named package is installed on the system:
+## Examples
 
-    it { should be_installed }
+The following examples show how to use this InSpec audit resource.
 
-### cmp
+### Test if VLC is installed
 
-<%= partial "/shared/matcher_cmp" %>
+    describe oneget('VLC') do
+      it { should be_installed }
+    end
 
-### eq
+<br>
 
-<%= partial "/shared/matcher_eq" %>
+## Matchers
 
-### include
+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/).
 
-<%= partial "/shared/matcher_include" %>
+### be_installed
 
-### match
+The `be_installed` matcher tests if the named package is installed on the system:
 
-<%= partial "/shared/matcher_match" %>
+    it { should be_installed }
 
 ### version
 
 The `version` matcher tests if the named package version is on the system:
 
     its('version') { should eq '1.2.3' }
-
-## Examples
-
-The following examples show how to use this InSpec audit resource.
-
-### Test if VLC is installed
-
-    describe oneget('VLC') do
-      it { should be_installed }
-    end

data/docs/resources/oracledb_session.md.erb

@@ -6,6 +6,8 @@ title: About the oracledb_session Resource
 
 Use the `oracledb_session` InSpec audit resource to test SQL commands run against a Oracle database.
 
+<br>
+
 ## Syntax
 
 A `oracledb_session` resource block declares the username and password to use for the session with an optional service to connect to, and then the command to be run:
@@ -20,17 +22,7 @@ where
 * `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
 
-## Matchers
-
-This InSpec audit resource has the following matchers:
-
-### cmp
-
-<%= partial "/shared/matcher_cmp" %>
-
-### eq
-
-<%= partial "/shared/matcher_eq" %>
+<br>
 
 ## Examples
 
@@ -51,3 +43,9 @@ The following examples show how to use this InSpec audit resource.
     describe sql.query('SELECT NAME FROM v$database;').row(0).column('name') do
       its('value') { should cmp 'ORCL' }
     end
+
+<br>
+
+## Matchers
+
+For a full list of available matchers please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/).