inspec 2.1.0 → 2.1.10

data/docs/resources/iis_site.md.erb

@@ -1,135 +1,135 @@
----
-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>
-
-## 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') }
+---
+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>
+
+## 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') }

data/docs/resources/inetd_conf.md.erb

@@ -1,94 +1,94 @@
----
-title: About the inetd_conf Resource
-platform: linux
----
-
-# inetd_conf
-
-Use the `inetd_conf` InSpec audit resource to test if a service is listed in the `inetd.conf` file on Linux and Unix platforms. inetd---the Internet service daemon---listens on dedicated ports, and then loads the appropriate program based on a request. The `inetd.conf` file is typically located at `/etc/inetd.conf` and contains a list of Internet services associated to the ports on which that service will listen. Only enabled services may handle a request; only services that are required by the system should be enabled.`
-
-<br>
-
-## Syntax
-
-An `inetd_conf` resource block declares the list of services that are enabled in the `inetd.conf` file:
-
-    describe inetd_conf('path') do
-      its('service_name') { should eq 'value' }
-    end
-
-where
-
-* `'service_name'` is a service listed in the `inetd.conf` file
-* `('path')` is the non-default path to the `inetd.conf` file
-* `should eq 'value'` is the value that is expected
-
-<br>
-
-## Properties
-
-This resource supports any of the properties listed as services in the `inetd.conf` file. You may want to ensure that specific services do not listen via `inetd.conf`.
-
-<br>
-
-## Examples
-
-The following examples show how to use this InSpec audit resource.
-
-### Basic tests for inetd_conf services:
-
-    its('shell') { should eq nil }
-
-or:
-
-    its('netstat') { should eq nil }
-
-or:
-
-    its('systat') { should eq nil }
-
-For example:
-
-    describe inetd_conf do
-      its('shell') { should eq nil }
-      its('login') { should eq nil }
-      its('exec') { should eq nil }
-    end
-
-### Verify that FTP is disabled
-
-The contents if the `inetd.conf` file contain the following:
-
-    #ftp      stream   tcp   nowait   root   /usr/sbin/tcpd   in.ftpd -l -a
-    #telnet   stream   tcp   nowait   root   /usr/sbin/tcpd   in.telnetd
-
-and the following test is defined:
-
-    describe inetd_conf do
-      its('ftp') { should eq nil }
-      its('telnet') { should eq nil }
-    end
-
-Because both the `ftp` and `telnet` Internet services are commented out (`#`), both services are disabled. Consequently, both tests will return `true`. However, if the `inetd.conf` file is set as follows:
-
-    ftp       stream   tcp   nowait   root   /usr/sbin/tcpd   in.ftpd -l -a
-    #telnet   stream   tcp   nowait   root   /usr/sbin/tcpd   in.telnetd
-
-then the same test will return `false` for `ftp` and the entire test will fail.
-
-### Test if telnet is installed
-
-    describe package('telnetd') do
-      it { should_not be_installed }
-    end
-
-    describe inetd_conf do
-      its('telnet') { should eq nil }
-    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 inetd_conf Resource
+platform: linux
+---
+
+# inetd_conf
+
+Use the `inetd_conf` InSpec audit resource to test if a service is listed in the `inetd.conf` file on Linux and Unix platforms. inetd---the Internet service daemon---listens on dedicated ports, and then loads the appropriate program based on a request. The `inetd.conf` file is typically located at `/etc/inetd.conf` and contains a list of Internet services associated to the ports on which that service will listen. Only enabled services may handle a request; only services that are required by the system should be enabled.`
+
+<br>
+
+## Syntax
+
+An `inetd_conf` resource block declares the list of services that are enabled in the `inetd.conf` file:
+
+    describe inetd_conf('path') do
+      its('service_name') { should eq 'value' }
+    end
+
+where
+
+* `'service_name'` is a service listed in the `inetd.conf` file
+* `('path')` is the non-default path to the `inetd.conf` file
+* `should eq 'value'` is the value that is expected
+
+<br>
+
+## Properties
+
+This resource supports any of the properties listed as services in the `inetd.conf` file. You may want to ensure that specific services do not listen via `inetd.conf`.
+
+<br>
+
+## Examples
+
+The following examples show how to use this InSpec audit resource.
+
+### Basic tests for inetd_conf services:
+
+    its('shell') { should eq nil }
+
+or:
+
+    its('netstat') { should eq nil }
+
+or:
+
+    its('systat') { should eq nil }
+
+For example:
+
+    describe inetd_conf do
+      its('shell') { should eq nil }
+      its('login') { should eq nil }
+      its('exec') { should eq nil }
+    end
+
+### Verify that FTP is disabled
+
+The contents if the `inetd.conf` file contain the following:
+
+    #ftp      stream   tcp   nowait   root   /usr/sbin/tcpd   in.ftpd -l -a
+    #telnet   stream   tcp   nowait   root   /usr/sbin/tcpd   in.telnetd
+
+and the following test is defined:
+
+    describe inetd_conf do
+      its('ftp') { should eq nil }
+      its('telnet') { should eq nil }
+    end
+
+Because both the `ftp` and `telnet` Internet services are commented out (`#`), both services are disabled. Consequently, both tests will return `true`. However, if the `inetd.conf` file is set as follows:
+
+    ftp       stream   tcp   nowait   root   /usr/sbin/tcpd   in.ftpd -l -a
+    #telnet   stream   tcp   nowait   root   /usr/sbin/tcpd   in.telnetd
+
+then the same test will return `false` for `ftp` and the entire test will fail.
+
+### Test if telnet is installed
+
+    describe package('telnetd') do
+      it { should_not be_installed }
+    end
+
+    describe inetd_conf do
+      its('telnet') { should eq nil }
+    end
+
+<br>
+
+## Matchers
+
+For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/).
+