inspec 2.1.21 → 2.1.30

data/docs/resources/ini.md.erb

@@ -1,76 +1,76 @@
----
-title: About the ini Resource
-platform: os
----
-
-# ini
-
-Use the `ini` InSpec audit resource to test settings in an INI file.
-
-<br>
-
-## Syntax
-
-An `ini` resource block declares the configuration settings to be tested:
-
-    describe ini('path') do
-      its('setting_name') { should eq 'value' }
-    end
-
-where
-
-* `'setting_name'` is a setting key defined in the INI file
-* `('path')` is the path to the INI file
-* `{ should eq 'value' }` is the value that is expected
-
-For example:
-
-    describe ini('path/to/ini_file.ini') do
-      its('port') { should eq '143' }
-      its('server') { should eq '192.0.2.62' }
-    end
-
-Settings inside of sections, such as the following:
-
-    [section_name]
-    setting_name = 123
-
-... can be retrieved by prefixing the setting_name with the section.
-
-    its('section_name.setting_name') { should cmp 123 }
-
-In the event a section or setting name has a period in it, the alternate syntax can be used:
-
-    its(['section.with.a.dot.in.it', 'setting.name.with.dots']) { should cmp 'lotsadots' }
-
-<br>
-
-## Properties
-
-This resource supports any of the settings listed in an INI file as properties.
-
-<br>
-
-## Examples
-
-The following examples show how to use this InSpec audit resource.
-
-### Test SMTP settings in a PHP INI file
-
-For example, a PHP INI file located at contains the following settings:
-
-    [mail function]
-    SMTP = smtp.gmail.com
-    smtp_port = 465
-
-and can be tested like this:
-
-    describe ini('/etc/php5/apache2/php.ini') do
-      its('mail function.smtp_port') { should eq('465') }
-    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 ini Resource
+platform: os
+---
+
+# ini
+
+Use the `ini` InSpec audit resource to test settings in an INI file.
+
+<br>
+
+## Syntax
+
+An `ini` resource block declares the configuration settings to be tested:
+
+    describe ini('path') do
+      its('setting_name') { should eq 'value' }
+    end
+
+where
+
+* `'setting_name'` is a setting key defined in the INI file
+* `('path')` is the path to the INI file
+* `{ should eq 'value' }` is the value that is expected
+
+For example:
+
+    describe ini('path/to/ini_file.ini') do
+      its('port') { should eq '143' }
+      its('server') { should eq '192.0.2.62' }
+    end
+
+Settings inside of sections, such as the following:
+
+    [section_name]
+    setting_name = 123
+
+... can be retrieved by prefixing the setting_name with the section.
+
+    its('section_name.setting_name') { should cmp 123 }
+
+In the event a section or setting name has a period in it, the alternate syntax can be used:
+
+    its(['section.with.a.dot.in.it', 'setting.name.with.dots']) { should cmp 'lotsadots' }
+
+<br>
+
+## Properties
+
+This resource supports any of the settings listed in an INI file as properties.
+
+<br>
+
+## Examples
+
+The following examples show how to use this InSpec audit resource.
+
+### Test SMTP settings in a PHP INI file
+
+For example, a PHP INI file located at contains the following settings:
+
+    [mail function]
+    SMTP = smtp.gmail.com
+    smtp_port = 465
+
+and can be tested like this:
+
+    describe ini('/etc/php5/apache2/php.ini') do
+      its('mail function.smtp_port') { should eq('465') }
+    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/interface.md.erb

@@ -1,58 +1,58 @@
----
-title: About the interface Resource
-platform: os
----
-
-# interface
-
-Use the `interface` InSpec audit resource to test basic network adapter properties, such as name, status, and link speed (in MB/sec).
-
-* On Linux platforms, `/sys/class/net/#{iface}` is used as source
-* On the Windows platform, the `Get-NetAdapter` cmdlet is used as source
-
-<br>
-
-## Syntax
-
-An `interface` resource block declares network interface properties to be tested:
-
-    describe interface('eth0') do
-      it { should be_up }
-      its('speed') { should eq 1000 }
-      its('name') { should eq eth0 }
-    end
-
-<br>
-
-## Properties
-
-`name`, `speed`
-
-<br>
-
-## Resource Property Examples
-
-### name
-
-The `name` matcher tests if the named network interface exists:
-
-    its('name') { should eq eth0 }
-
-### speed
-
-The `speed` matcher tests the speed of the network interface, in MB/sec:
-
-    its('speed') { should eq 1000 }
-
-<br>
-
-## Matchers
-
-For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/).
-
-### be_up
-
-The `be_up` matcher tests if the network interface is available:
-
-    it { should be_up }
-
+---
+title: About the interface Resource
+platform: os
+---
+
+# interface
+
+Use the `interface` InSpec audit resource to test basic network adapter properties, such as name, status, and link speed (in MB/sec).
+
+* On Linux platforms, `/sys/class/net/#{iface}` is used as source
+* On the Windows platform, the `Get-NetAdapter` cmdlet is used as source
+
+<br>
+
+## Syntax
+
+An `interface` resource block declares network interface properties to be tested:
+
+    describe interface('eth0') do
+      it { should be_up }
+      its('speed') { should eq 1000 }
+      its('name') { should eq eth0 }
+    end
+
+<br>
+
+## Properties
+
+`name`, `speed`
+
+<br>
+
+## Resource Property Examples
+
+### name
+
+The `name` matcher tests if the named network interface exists:
+
+    its('name') { should eq eth0 }
+
+### speed
+
+The `speed` matcher tests the speed of the network interface, in MB/sec:
+
+    its('speed') { should eq 1000 }
+
+<br>
+
+## Matchers
+
+For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/).
+
+### be_up
+
+The `be_up` matcher tests if the network interface is available:
+
+    it { should be_up }
+

data/docs/resources/iptables.md.erb

@@ -1,64 +1,64 @@
----
-title: About the iptables Resource
-platform: linux
----
-
-# iptables
-
-Use the `iptables` InSpec audit resource to test rules that are defined in `iptables`, which maintains tables of IP packet filtering rules. There may be more than one table. Each table contains one (or more) chains (both built-in and custom). A chain is a list of rules that match packets. When the rule matches, the rule defines what target to assign to the packet.
-
-<br>
-
-## Syntax
-
-A `iptables` resource block declares tests for rules in IP tables:
-
-    describe iptables(rule:'name', table:'name', chain: 'name') do
-      it { should have_rule('RULE') }
-    end
-
-where
-
-* `iptables()` may specify any combination of `rule`, `table`, or `chain`
-* `rule:'name'` is the name of a rule that matches a set of packets
-* `table:'name'` is the packet matching table against which the test is run
-* `chain: 'name'` is the name of a user-defined chain or one of `ACCEPT`, `DROP`, `QUEUE`, or `RETURN`
-* `have_rule('RULE')` tests that rule in the iptables list. This must match the entire line taken from `iptables -S CHAIN`.
-
-<br>
-
-## Examples
-
-The following examples show how to use this InSpec audit resource.
-
-### Test if the INPUT chain is in default ACCEPT mode
-
-    describe iptables do
-      it { should have_rule('-P INPUT ACCEPT') }
-    end
-
-### Test if the INPUT chain from the mangle table is in ACCEPT mode
-
-    describe iptables(table:'mangle', chain: 'INPUT') do
-      it { should have_rule('-P INPUT ACCEPT') }
-    end
-
-### Test if there is a rule allowing Postgres (5432/TCP) traffic
-
-    describe iptables do
-      it { should have_rule('-A INPUT -p tcp -m tcp -m multiport --dports 5432 -m comment --comment "postgres" -j ACCEPT') }
-    end
-
-Note that the rule specification must exactly match what's in the output of `iptables -S INPUT`, which will depend on how you've built your rules.
-
-<br>
-
-## Matchers
-
-For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/).
-
-### have_rule
-
-The `have_rule` matcher tests the named rule against the information in the `iptables` file:
-
-    it { should have_rule('RULE') }
+---
+title: About the iptables Resource
+platform: linux
+---
+
+# iptables
+
+Use the `iptables` InSpec audit resource to test rules that are defined in `iptables`, which maintains tables of IP packet filtering rules. There may be more than one table. Each table contains one (or more) chains (both built-in and custom). A chain is a list of rules that match packets. When the rule matches, the rule defines what target to assign to the packet.
+
+<br>
+
+## Syntax
+
+A `iptables` resource block declares tests for rules in IP tables:
+
+    describe iptables(rule:'name', table:'name', chain: 'name') do
+      it { should have_rule('RULE') }
+    end
+
+where
+
+* `iptables()` may specify any combination of `rule`, `table`, or `chain`
+* `rule:'name'` is the name of a rule that matches a set of packets
+* `table:'name'` is the packet matching table against which the test is run
+* `chain: 'name'` is the name of a user-defined chain or one of `ACCEPT`, `DROP`, `QUEUE`, or `RETURN`
+* `have_rule('RULE')` tests that rule in the iptables list. This must match the entire line taken from `iptables -S CHAIN`.
+
+<br>
+
+## Examples
+
+The following examples show how to use this InSpec audit resource.
+
+### Test if the INPUT chain is in default ACCEPT mode
+
+    describe iptables do
+      it { should have_rule('-P INPUT ACCEPT') }
+    end
+
+### Test if the INPUT chain from the mangle table is in ACCEPT mode
+
+    describe iptables(table:'mangle', chain: 'INPUT') do
+      it { should have_rule('-P INPUT ACCEPT') }
+    end
+
+### Test if there is a rule allowing Postgres (5432/TCP) traffic
+
+    describe iptables do
+      it { should have_rule('-A INPUT -p tcp -m tcp -m multiport --dports 5432 -m comment --comment "postgres" -j ACCEPT') }
+    end
+
+Note that the rule specification must exactly match what's in the output of `iptables -S INPUT`, which will depend on how you've built your rules.
+
+<br>
+
+## Matchers
+
+For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/).
+
+### have_rule
+
+The `have_rule` matcher tests the named rule against the information in the `iptables` file:
+
+    it { should have_rule('RULE') }

data/docs/resources/json.md.erb

@@ -1,63 +1,63 @@
----
-title: About the json Resource
-platform: os
----
-
-# json
-
-Use the `json` InSpec audit resource to test data in a JSON file.
-
-<br>
-
-## Syntax
-
-A `json` resource block declares the data to be tested. Assume the following JSON file:
-
-    {
-      "name" : "hello",
-      "meta" : {
-        "creator" : "John Doe"
-      },
-      "array": [
-        "zero",
-        "one"
-      ]
-    }
-
-This file can be queried using:
-
-    describe json('/path/to/name.json') do
-      its('name') { should eq 'hello' }
-      its(['meta','creator']) { should eq 'John Doe' }
-      its(['array', 1]) { should eq 'one' }
-    end
-
-where
-
-* `name` is a configuration setting in a JSON file
-* `should eq 'foo'` tests a value of `name` as read from a JSON file versus the value declared in the test
-
-<br>
-
-## Examples
-
-The following examples show how to use this InSpec audit resource.
-
-### name
-
-The `name` matcher tests the value of the filename as read from a JSON file versus the value declared in the test:
-
-    its('name') { should eq '/tmp/example.json' }
-
-### Test a cookbook version in a policyfile.lock.json file
-
-    describe json('policyfile.lock.json') do
-      its(['cookbook_locks', 'omnibus', 'version']) { should eq('2.2.0') }
-    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 json Resource
+platform: os
+---
+
+# json
+
+Use the `json` InSpec audit resource to test data in a JSON file.
+
+<br>
+
+## Syntax
+
+A `json` resource block declares the data to be tested. Assume the following JSON file:
+
+    {
+      "name" : "hello",
+      "meta" : {
+        "creator" : "John Doe"
+      },
+      "array": [
+        "zero",
+        "one"
+      ]
+    }
+
+This file can be queried using:
+
+    describe json('/path/to/name.json') do
+      its('name') { should eq 'hello' }
+      its(['meta','creator']) { should eq 'John Doe' }
+      its(['array', 1]) { should eq 'one' }
+    end
+
+where
+
+* `name` is a configuration setting in a JSON file
+* `should eq 'foo'` tests a value of `name` as read from a JSON file versus the value declared in the test
+
+<br>
+
+## Examples
+
+The following examples show how to use this InSpec audit resource.
+
+### name
+
+The `name` matcher tests the value of the filename as read from a JSON file versus the value declared in the test:
+
+    its('name') { should eq '/tmp/example.json' }
+
+### Test a cookbook version in a policyfile.lock.json file
+
+    describe json('policyfile.lock.json') do
+      its(['cookbook_locks', 'omnibus', 'version']) { should eq('2.2.0') }
+    end
+
+<br>
+
+## Matchers
+
+For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/).
+