inspec-core 2.3.10 → 2.3.23

data/docs/resources/mssql_session.md.erb

@@ -1,78 +0,0 @@
----
-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>
-
-## Availability
-
-### Installation
-
-This resource is distributed along with InSpec itself. You can use it automatically.
-
-### Version
-
-This resource first became available in v1.24.0 of InSpec.
-
-## 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
-  
-### Test a specific database
-
-    sql = mssql_session(user: 'my_user', password: 'password', db_name: 'test')
-
-    describe sql.query("SELECT Name AS result FROM Product WHERE ProductID == 1").row(0).column('result') do
-      its("value") { should eq 'foo' }
-    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,109 +0,0 @@
----
-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>
-
-## Availability
-
-### Installation
-
-This resource is distributed along with InSpec itself. You can use it automatically.
-
-### Version
-
-This resource first became available in v1.0.0 of InSpec.
-
-## 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.

data/docs/resources/mysql_session.md.erb

@@ -1,84 +0,0 @@
----
-title: About the mysql_session Resource
-platform: os
----
-
-# mysql_session
-
-Use the `mysql_session` InSpec audit resource to test SQL commands run against a MySQL database.
-
-<br>
-
-## Availability
-
-### Installation
-
-This resource is distributed along with InSpec itself. You can use it automatically.
-
-### Version
-
-This resource first became available in v1.0.0 of InSpec.
-
-## Syntax
-
-A `mysql_session` resource block declares the username and password to use for the session, and then the command to be run:
-
-    describe mysql_session('username', 'password').query('QUERY') do
-      its('stdout') { should match(/expected-result/) }
-    end
-
-where
-
-* `mysql_session` declares a username and password, connecting locally, with permission to run the query
-* `query('QUERY')` contains the query to be run
-* `its('stdout') { should eq(/expected-result/) }` 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 = mysql_session('my_user','password')
-
-    describe sql.query('show databases like \'test\';') do
-      its('stdout') { should_not match(/test/) }
-    end
-
-### Alternate Connection: Different Host
-
-    sql = mysql_session('my_user','password','db.example.com')
-
-### Alternate Connection: Different Port
-
-    sql = mysql_session('my_user','password','localhost',3307)
-
-### Alternate Connection: Using a socket
-
-    sql = mysql_session('my_user','password', nil, nil, '/var/lib/mysql-default/mysqld.sock')
-
-### Test for a successful query
-
-    describe mysql_session('my_user','password').query('show tables in existing_database;') do
-      its('exit_status') { should eq(0) }
-    end
-
-### Test for a failing query
-
-    describe mysql_session('my_user','password').query('show tables in non_existent_database;') do
-      its('exit_status') { should_not eq(0) }
-    end
-
-### Test for specific error message
-
-    describe mysql_session('my_user','password').query('show tables in non_existent_database;') do
-      its('stderr') { should match(/Unknown database/) }
-    end
-
-<br>
-
-## Matchers
-
-This InSpec audit resource builds a [command](https://www.inspec.io/docs/reference/resources/command) object and returns the the result object. For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/).

data/docs/resources/nginx.md.erb

@@ -1,89 +0,0 @@
----
-title: The Nginx Resource
-platform: linux
----
-
-# 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>
-
-## Availability
-
-### Installation
-
-This resource is distributed along with InSpec itself. You can use it automatically.
-
-### Version
-
-This resource first became available in v1.37.6 of InSpec.
-
-## 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>
-
-## 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
-
-### 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

@@ -1,148 +0,0 @@
----
-title: About the nginx_conf Resource
-platform: linux
----
-
-# 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>
-
-## Availability
-
-### Installation
-
-This resource is distributed along with InSpec itself. You can use it automatically.
-
-### Version
-
-This resource first became available in v1.37.6 of InSpec.
-
-## 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
-
-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"]]}
-
-### configuration file path
-
-If the NGINX configuration file is not located at the default path, `/etc/nginx/nginx.conf`, the path can specified as the first parameter of the describe block:
-
-    describe nginx_conf('/opt/nginx/nginx.conf').params['pid'] do
-      it { should cmp 'logs/nginx.pid' }
-    end
-
-