inspec 2.3.10 → 2.3.23

data/docs/resources/host.md.erb

@@ -1,96 +0,0 @@
----
-title: About the host Resource
-platform: os
----
-
-# host
-
-Use the `host` InSpec audit resource to test the name used to refer to a specific host and its availability, including the Internet protocols and ports over which that host name should be available.
-
-<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 `host` resource block declares a host name, and then (depending on what is to be tested) a port and/or a protocol:
-
-    describe host('example.com', port: 80, protocol: 'tcp') do
-      it { should be_reachable }
-      it { should be_resolvable }
-      its('ipaddress') { should include '12.34.56.78' }
-    end
-
-where
-
-* `host()` must specify a host name and may specify a port number and/or a protocol
-* `'example.com'` is the host name
-* `port:` is the port number
-* `protocol: 'name'` is the Internet protocol: TCP (`protocol: 'tcp'`), UDP (`protocol: 'udp'` or  ICMP (`protocol: 'icmp'`))
-
-<br>
-
-## Resource Properties
-
-* `connection`, `ipaddress`, `protocol`, `socket`
-
-<br>
-
-## Resource Examples
-
-The following examples show how to use this InSpec audit resource.
-
-### ipaddress
-
-The `ipaddress` matcher tests if a host name is resolvable to a specific IP address:
-
-    describe host('example.com') do
-      its('ipaddress') { should include '93.184.216.34' }
-    end
-
-### Verify host name is reachable over a specific protocol and port number
-
-    describe host('example.com', port: 80, protocol: 'tcp') do
-      it { should be_reachable }
-    end
-
-### Verify that a specific IP address can be resolved
-
-    describe host('example.com') do
-      it { should be_resolvable }
-      its('ipaddress') { should include '93.184.216.34' }
-    end
-
-### Review the connection setup and socket contents when checking reachability
-
-    describe host('example.com', port: 12345, protocol: 'tcp') do
-      it { should be_reachable }
-      its('connection') { should_not match /connection refused/ }
-      its('socket') { should match /STATUS_OK/ }
-    end
-
-<br>
-
-## Matchers
-
-This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/).
-
-### be_reachable
-
-The `be_reachable` matcher tests if the host name is available:
-
-    it { should be_reachable }
-
-### be_resolvable
-
-The `be_resolvable` matcher tests for host name resolution, i.e. "resolvable to an IP address":
-
-    it { should be_resolvable }

data/docs/resources/http.md.erb

@@ -1,207 +0,0 @@
----
-title: About the http Resource
-platform: linux
----
-
-# http
-
-Use the `http` InSpec audit resource to test an http endpoint.
-
-<br>
-
-## Availability
-
-### Installation
-
-This resource is distributed along with InSpec itself. You can use it automatically.
-
-### Version
-
-This resource first became available in v1.10.0 of InSpec.
-
-## Syntax
-
-An `http` resource block declares the configuration settings to be tested:
-
-    describe http('url', auth: {user: 'user', pass: 'test'}, params: {params}, method: 'method', headers: {headers}, data: data, open_timeout: 60, read_timeout: 60, ssl_verify: true) do
-      its('status') { should eq number }
-      its('body') { should eq 'body' }
-      its('headers.name') { should eq 'header' }
-    end
-
-where
-
-* `('url')` is the url to test
-* `auth: { user: 'user', pass: 'test' }` may be specified for basic auth request
-* `{params}` may be specified for http request parameters
-* `'method'` may be specified for http request method (default to 'GET')
-* `{headers}` may be specified for http request headers
-* `data` may be specified for http request body
-* `open_timeout` may be specified for a timeout for opening connections (default to 60)
-* `read_timeout` may be specified for a timeout for reading connections (default to 60)
-* `ssl_verify` may be specified to enable or disable verification of SSL certificates (default to `true`)
-
-<br>
-
-## Example
-
-The following examples show how to use this InSpec audit resource. An `http` resource block declares the configuration settings to be tested:
-
-### Simple http test
-
-For example, a service is listening on default http port can be tested like this:
-
-    describe http('http://localhost') do
-      its('status') { should cmp 200 }
-    end
-
-### Complex http test
-
-    describe http('http://localhost:8080/ping',
-                  auth: {user: 'user', pass: 'test'},
-                  params: {format: 'html'},
-                  method: 'POST',
-                  headers: {'Content-Type' => 'application/json'},
-                  data: '{"data":{"a":"1","b":"five"}}') do
-      its('status') { should cmp 200 }
-      its('body') { should cmp 'pong' }
-      its('headers.Content-Type') { should cmp 'text/html' }
-    end
-
-<br>
-
-## Local vs. Remote
-
-Beginning with InSpec 1.41, you can enable the ability to have the HTTP test execute on the remote target:
-
-    describe http('http://www.example.com', enable_remote_worker: true) do
-      its('body') { should cmp 'awesome' }
-    end
-
-In InSpec 2.0, the HTTP test will automatically execute remotely whenever InSpec is testing a remote node.
-
-<br>
-
-## Parameters
-
-* `url`, `auth`, `params`, `method`, `headers`, `data`, `open_timeout`, `read_timeout`, `ssl_verify`
-
-## Parameter Examples
-
-### url
-
-`('url')` is the url to test.
-
-    describe http('http://localhost:8080/ping') do
-      ...
-    end
-
-### auth
-
-`auth: { user: 'user', pass: 'test' }` may be specified for basic auth request.
-
-    describe http('http://localhost:8080/ping',
-                  auth: {user: 'user', pass: 'test'}) do
-      ...
-    end
-
-### params
-
-`{params}` may be specified for http request parameters.
-
-    describe http('http://localhost:8080/ping',
-                  params: {format: 'html'}) do
-      ...
-    end
-
-### method
-
-`'method'` may be specified for http request method (default to 'GET').
-
-    describe http('http://localhost:8080/ping',
-                  method: 'POST') do
-      ...
-    end
-
-### headers
-
-`{headers}` may be specified for http request headers.
-
-    describe http('http://localhost:8080/ping',
-                  headers: {'Content-Type' => 'application/json'}) do
-      ...
-    end
-
-### data
-
-`data` may be specified for http request body.
-
-        describe http('http://localhost:8080/ping',
-                  data: '{"data":{"a":"1","b":"five"}}') do
-          ...
-        end
-
-### open_timeout
-
-`open_timeout` may be specified for a timeout for opening connections (default to 60).
-
-    describe http('http://localhost:8080/ping',
-                  open_timeout: '90') do
-      ...
-    end
-
-### read_timeout
-
-`read_timeout` may be specified for a timeout for reading connections (default to 60).
-
-    describe http('http://localhost:8080/ping',
-                  read_timeout: '90') do
-      ...
-    end
-
-### ssl_verify
-
-`ssl_verify` may be specified to enable or disable verification of SSL certificates (default to `true`).
-
-    describe http('http://localhost:8080/ping',
-                  ssl_verify: true) do
-      ...
-    end
-
-<br>
-
-## Properties
-
-* `body`, `headers`, `http_method`, `status`,
-
-<br>
-
-## Property Examples
-
-### body
-
-The `body` matcher tests body content of http response:
-
-    its('body') { should eq 'hello\n' }
-
-### headers
-
-The `headers` matcher returns an hash of all http headers:
-
-    its('headers') { should eq {} }
-
-Individual headers can be tested via:
-
-    its('headers.Content-Type') { should cmp 'text/html' }
-
-### status
-
-The `status` matcher tests status of the http response:
-
-    its('status') { should eq 200 }
-
-<br>
-
-## Matchers
-
-For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/).

data/docs/resources/iis_app.md.erb

@@ -1,132 +0,0 @@
----
-title: About the iis_app Resource
-platform: windows
----
-
-# iis_app
-
-Use the `iis_app` InSpec audit resource to test the state of IIS on Windows Server 2012 (and later).
-
-<br>
-
-## Availability
-
-### Installation
-
-This resource is distributed along with InSpec itself. You can use it automatically.
-
-### Version
-
-This resource first became available in v1.28.0 of InSpec.
-
-## Syntax
-
-An `iis_app` resource block declares details about the named site:
-
-    describe iis_app('application_path', 'site_name') do
-      it { should exist }
-      it { should have_application_pool('application_pool') }
-      it { should have_protocols('protocol') }
-      it { should have_site_name('site') }
-      it { should have_physical_path('physical_path') }
-      it { should have_path('application_path') }
-    end
-
-where
-
-* `'application_path'` is the path to the application, such as `'/myapp'`
-* `'site_name'` is the name of the site, such as `'Default Web Site'`
-* `('application_pool')` is the name of the application pool in which the site's root application is run, such as `'DefaultAppPool'`
-* `('protocols')` is a binding for the site, such as `'http'`. A site may have multiple bindings; therefore, use a `have_protocol` matcher for each site protocol to be tested
-* `('physical_path')` is the physical path to the application, such as `'C:\\inetpub\\wwwroot\\myapp'`
-
-For example:
-
-    describe iis_app('/myapp', 'Default Web Site') do
-      it { should exist }
-      it { should have_application_pool('MyAppPool') }
-      it { should have_protocols('http') }
-      it { should have_site_name('Default Web Site') }
-      it { should have_physical_path('C:\\inetpub\\wwwroot\\myapp') }
-      it { should have_path('\\My Application') }
-    end
-
-<br>
-
-## Properties
-application\_pool, path, physical\_path, protocols, site\_name
-
-<br>
-
-## Resource Examples
-
-The following examples show how to use this InSpec audit resource.
-
-### Test a default IIS web application
-
-    describe iis_app('Default Web Site') do
-      it { should exist }
-      it { should be_running }
-      it { should have_app_pool('DefaultAppPool') }
-      it { should have_binding('http *:80:') }
-      it { should have_path('%SystemDrive%\\inetpub\\wwwroot') }
-    end
-
-### Test if IIS service is running
-
-    describe service('W3SVC') do
-      it { should be_installed }
-      it { should be_running }
-    end
-
-<br>
-
-## Matchers
-
-For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/).
-
-### exist
-
-The `exist` matcher tests if the site exists:
-
-    it { should exist }
-
-### have\_application\_pool
-
-The `have_application_pool` matcher tests if the named application pool exists for the web application:
-
-    it { should have_application_pool('DefaultAppPool') }
-
-### have_protocol
-
-The `have_protocol` matcher tests if the specified protocol exists for the web application:
-
-    it { should have_protocol('http') }
-
-or:
-
-    it { should have_protocol('https') }
-
-A web application may have multiple bindings; use a `have_protocol` matcher for each unique web application binding to be tested.
-
-##### Protocol Attributes
-
-The `have_protocol` matcher can also test attributes that are defined for a web application enabledProtocols.
-
-    it { should have_protocol('http') }
-
-For example, testing a site that doesn't have https enabled:
-
-    it { should_not have_protocol('https') }
-    it { should have_protocol('http') }
-
-Testing a web application with https enabled and http enabled:
-
-    it { should have_protocol('https') }
-    it { should have_protocol('http') }
-
-### have\_physical\_path
-
-The `have_physical_path` matcher tests if the named path is defined for the web application:
-
-    it { should have_physical_path('C:\\inetpub\\wwwroot') }

data/docs/resources/iis_site.md.erb

@@ -1,145 +0,0 @@
----
-title: About the iis_site Resource
-platform: windows
----
-
-# iis_site
-
-Use the `iis_site` InSpec audit resource to test the state of IIS on Windows Server 2012 (and later).
-
-<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
-
-An `iis_site` resource block declares details about the named site:
-
-    describe iis_site('site_name') do
-      it { should exist }
-      it { should be_running }
-      it { should have_app_pool('app_pool_name') }
-      it { should have_binding('binding_details') }
-      it { should have_path('path_to_site') }
-    end
-
-where
-
-* `'site_name'` is the name of the site, such as `'Default Web Site'`
-* `('app_pool_name')` is the name of the application pool in which the site's root application is run, such as `'DefaultAppPool'`
-* `('binding_details')` is a binding for the site, such as `'net.pipe *'`. A site may have multiple bindings; therefore, use a `have_binding` matcher for each site binding to be tested
-* `('path_to_site')` is the path to the site, such as `'C:\\inetpub\\wwwroot'`
-
-For example:
-
-    describe iis_site('Default Web Site') do
-      it { should exist }
-      it { should be_running }
-      it { should have_app_pool('DefaultAppPool') }
-      it { should have_binding('https :443:www.contoso.com sslFlags=0') }
-      it { should have_binding('net.pipe *') }
-      it { should have_path('C:\\inetpub\\wwwroot') }
-    end
-
-<br>
-
-## Properties
-
-app\_pool, bindings, path, state
-
-<br>
-
-## Property Examples
-
-The following examples show how to use this InSpec audit resource.
-
-### Test a default IIS site
-
-    describe iis_site('Default Web Site') do
-      it { should exist }
-      it { should be_running }
-      it { should have_app_pool('DefaultAppPool') }
-      it { should have_binding('http *:80:') }
-      it { should have_path('%SystemDrive%\\inetpub\\wwwroot') }
-    end
-
-### Test if IIS service is running
-
-    describe service('W3SVC') do
-      it { should be_installed }
-      it { should be_running }
-    end
-
-<br>
-
-## Matchers
-
-For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/).
-
-### be_running
-
-The `be_running` matcher tests if the site is running:
-
-    it { should be_running }
-
-### exist
-
-The `exist` matcher tests if the site exists:
-
-    it { should exist }
-
-### have\_app\_pool
-
-The `have_app_pool` matcher tests if the named application pool exists for the site:
-
-    it { should have_app_pool('DefaultAppPool') }
-
-For example, testing if a site's application pool inherits the settings of the parent application pool:
-
-    it { should have_app_pool('/') }
-
-### have_binding
-
-The `have_binding` matcher tests if the specified binding exists for the site:
-
-    it { should have_binding('http :80:*') }
-
-or:
-
-    it { should have_binding('net.pipe *') }
-
-A site may have multiple bindings; use a `have_binding` matcher for each unique site binding to be tested.
-
-##### Binding Attributes
-
-The `have_binding` matcher can also test attributes that are defined for a site binding. For example, the `sslFlags` attribute defines if SSL is enabled, and (when enabled) what level of SSL is applied to the site.
-
-Testing a site with SSL disabled:
-
-    it { should have_binding('https :443:www.contoso.com sslFlags=0') }
-
-Testing a site with SSL enabled:
-
-    it { should have_binding('https :443:www.contoso.com sslFlags=Ssl') }
-
-Testing a site with certificate mapping authentication enabled:
-
-    it { should have_binding('https :443:www.contoso.com sslFlags=SslMapCert') }
-
-Testing a site with 128-bit SSL enabled:
-
-    it { should have_binding('https :443:www.contoso.com sslFlags=Ssl128') }
-
-### have_path
-
-The `have_path` matcher tests if the named path is defined for the site:
-
-    it { should have_path('C:\\inetpub\\wwwroot') }