inspec 0.9.0

data/docs/dsl_inspec.rst

@@ -0,0 +1,182 @@
+=====================================================
+InSpec DSL
+=====================================================
+
+|inspec| is a run-time framework and rule language used to specify compliance, securuty, and policy requirements. It includes a collection of resources that help you write auditing controls quickly and easily. The syntax used by both open source and |chef compliance| auditing is the same. The open source |inspec resource| framework is compatible with |chef compliance|.
+
+The InSpec DSL is a Ruby DSL for writing audit controls, which includes audit resources that you can invoke.
+
+The following sections describe the syntax and show some simple examples of using the |inspec resources| to define
+
+Syntax
+=====================================================
+
+The following resource tests |ssh| server configuration. For example, a simple control may desrcibed as:
+
+.. code-block:: ruby
+
+  describe sshd_config do
+    its('Port') { should eq('22') }
+  end
+
+In various use cases like implementing IT compliance across different departments, it becomes handy to extend the control with metadata. Each control may define an additional ``impact``, ``title`` or ``desc``. An example looks like:
+
+.. code-block:: ruby
+
+   control 'sshd-8' do
+     impact 0.6
+     title 'Server: Configure the service port'
+     desc '
+       Always specify which port the SSH server should listen to.
+       Prevent unexpected settings.
+     '
+     describe sshd_config do
+       its('Port') { should eq('22') }
+     end
+   end
+
+where
+
+* ``'sshd-8'`` is the name of the control
+* ``impact``, ``title``, and ``desc`` define metadata that fully describes the importance of the control, its purpose, with a succinct and complete description
+* ``impact`` is an float that measures the importance of the compliance results and must be a value between ``0.0`` and ``1.0``.
+* ``describe`` is a block that contains at least one test. A ``control`` block must contain at least one ``describe`` block, but may contain as many as required
+* ``sshd_config`` is an |inspec| resource. For the full list of InSpec resources, see |inspec| resource documentation
+* ``its('Port')`` is the matcher; ``{ should eq('22') }`` is the test. A ``describe`` block must contain at least one matcher, but may contain as many as required
+
+
+Author Tests
+-----------------------------------------------------
+It is recommended that test files are located in the ``/tests`` directory. When writing controls, the ``impact``, ``title``, ``desc`` metadata are _optional_, but are highly recommended.
+
+Examples
+=====================================================
+The following examples show simple compliance tests using a single ``control`` block.
+
+Test System Event Log
+-----------------------------------------------------
+The following test shows how to audit machines running |windows| 2012 R2 that pwassword complexity is enabled:
+
+.. code-block:: ruby
+
+  control 'windows-account-102' do
+    impact 1.0
+    title 'Windows Password Complexity is Enabled'
+    desc 'Password must meet complexity requirement'
+    describe security_policy do
+      its('PasswordComplexity') { should eq 1 }
+    end
+  end
+
+Are PosgtreSQL passwords empty?
+-----------------------------------------------------
+The following test shows how to audit machines running |postgresql| to ensure that passwords are not empty.
+
+.. code-block:: ruby
+
+   control 'postgres-7' do
+     impact 1.0
+     title 'Don't allow empty passwords'
+     describe postgres_session('user', 'pass').query("SELECT * FROM pg_shadow WHERE passwd IS NULL;") do
+       its('output') { should eq('') }
+     end
+   end
+
+
+Are MySQL passwords in ENV?
+-----------------------------------------------------
+The following test shows how to audit machines running |mysql| to ensure that passwords are not stored in ``ENV``:
+
+.. code-block:: ruby
+
+   control 'mysql-3' do
+     impact 1.0
+     title 'Do not store your MySQL password in your ENV'
+     desc '
+       Storing credentials in your ENV may easily expose
+       them to an attacker. Prevent this at all costs.
+     '
+     describe command('env') do
+       its(:stdout) { should_not match(/^MYSQL_PWD=/) }
+     end
+   end
+
+Is /etc/ssh a Directory?
+-----------------------------------------------------
+The following test shows how to audit machines to ensure that ``/etc/ssh`` is a directory:
+
+.. code-block:: ruby
+
+   control 'basic-1' do
+     impact 1.0
+     title '/etc/ssh should be a directory'
+     desc '
+       In order for OpenSSH to function correctly, its
+       configuration path must be a folder.
+     '
+     describe file('/etc/ssh') do
+       it { should be_directory }
+     end
+   end
+
+Is Apache running?
+-----------------------------------------------------
+The following test shows how to audit machines to ensure that |apache| is enabled and running:
+
+.. code-block:: ruby
+
+   control 'apache-1' do
+     impact 0.3
+     title 'Apache2 should be configured and running'
+     describe service(apache.service) do
+       it { should be_enabled }
+       it { should be_running }
+     end
+   end
+
+Are insecure packages installed ?
+-----------------------------------------------------
+The following test shows how to audit machines for insecure packages:
+
+.. code-block:: ruby
+
+  control 'cis-os-services-5.1.3' do
+    impact 0.7
+    title '5.1.3 Ensure rsh client is not installed'
+
+    describe package('rsh') do
+      it { should_not be_installed }
+    end
+
+    describe package('rsh-redone-client') do
+      it { should_not be_installed }
+    end
+  end
+
+
+Test Windows Registry Keys
+-----------------------------------------------------
+The following test shows how to audit machines to ensure Safe DLL Seach Mode is enabled:
+
+.. code-block:: ruby
+
+  control 'windows-base-101' do
+    impact 1.0
+    title 'Safe DLL Search Mode is Enabled'
+    desc '
+      @link: https://msdn.microsoft.com/en-us/library/ms682586(v=vs.85).aspx
+    '
+    describe registry_key('HKLM\\System\\CurrentControlSet\\Control\\Session Manager') do
+      it { should exist }
+      it { should_not have_property_value('SafeDllSearchMode', :type_dword, '0') }
+    end
+  end
+
+.. |inspec| replace:: InSpec
+.. |inspec resource| replace:: InSpec Resource
+.. |chef compliance| replace:: Chef Compliance
+.. |ruby| replace:: Ruby
+.. |ruby| replace:: SSH
+.. |windows| replace:: Microsoft Windows
+.. |postgresql| replace:: PostgreSQL
+.. |apache| replace:: Apache

data/docs/readme.rst

@@ -0,0 +1,100 @@
+=====================================================
+InSpec Documentation
+=====================================================
+
+InSpec a collection of resources and matchers to test the compliance of your nodes. This documentation provides an introduction to this mechanism and shows how to write custom tests.
+
+Introduction
+-----------------------------------------------------
+
+At first, we add our tests to the ``test`` folder. Each test file must end with ``_spec.rb``:
+
+.. code-block:: bash
+
+    mkdir test
+    touch test/example_spec.rb
+
+We add a control to this file, to check the ``/tmp`` path in our system:
+
+.. code-block:: ruby
+
+  # encoding: utf-8
+
+  control "cis-fs-2.1" do                     # A unique ID for this control
+    impact 0.7                                # The criticality, if this control fails.
+    title "Create separate /tmp partition"    # A human-readable title
+    desc "An optional description..."
+    describe file('/tmp') do                  # The actual test
+      it { should be_mounted }
+    end
+  end
+
+
+Let's add another spec for checking the SSH server configuration:
+
+.. code-block:: bash
+
+    touch test/sshd_spec.rb
+
+It will contain:
+
+.. code-block:: ruby
+
+  # encoding: utf-8
+
+  # Skip all controls, if SSH doesn't exist on the system
+  only_if do
+    command('sshd').exist?
+  end
+
+  control "sshd-11" do
+    impact 1.0
+    title "Server: Set protocol version to SSHv2"
+    desc "
+      Set the SSH protocol version to 2. Don't use legacy
+      insecure SSHv1 connections anymore.
+    "
+    describe sshd_config do
+      its('Protocol') { should eq('2') }
+    end
+  end
+
+  control "sshd-7" do
+    impact 1.0
+    title "Server: Do not permit root-based login with password."
+    desc "
+      To reduce the potential to gain full privileges
+      of a system in the course of an attack (by either misconfiguration
+      or vulnerabilities), do not allow login as root with password
+    "
+    describe sshd_config do
+      its('PermitRootLogin') { should match(/no|without-password/) }
+    end
+  end
+
+
+Now, we are ready to run the tests locally:
+
+bundle exec bin/inspec exec demo/test/example_spec.rb
+
+.. code-block:: bash
+
+  # run tests individually
+  $ inspec exec test/example_spec.rb
+  $ inspec exec test/sshd_spec.rb
+
+  # if you want to run all test located within the directory
+  $ inspec exec ./test
+
+
+Stability Index
+-----------------------------------------------------
+
+Every available InSpec resource will indicate its stability. As InSpec matures, certain parts are more reliable than others. Brand new features are likely to be redesigned and marked as such.
+
+The stability indices are as follows:
+
+* ``Stability: Deprecated`` - This features will be removed in future versions, because its known for being problematic. Do not rely on it.
+* ``Stability: Experimental`` - New features may change or are removed in future versions
+* ``Stability: Stable`` - API is well established and proofed. Maintaining compatibility is a high priority
+* ``Stability: Locked`` - Only security and performance fixes are allowed

data/docs/resources.rst

@@ -0,0 +1,4319 @@
+=====================================================
+InSpec Resources Reference
+=====================================================
+
+The following InSpec audit resources are available:
+
+* ``apache_conf``
+* ``apt``
+* ``audit_policy``
+* ``auditd_conf``
+* ``auditd_rules``
+* ``bond``
+* ``bridge``
+* ``csv``
+* ``command``
+* ``directory``
+* ``etc_group``
+* ``file``
+* ``gem``
+* ``group``
+* ``host``
+* ``inetd_conf``
+* ``interface``
+* ``iptables``
+* ``kernel_module``
+* ``kernel_parameter``
+* ``limits_conf``
+* ``login_defs``
+* ``mysql_conf``
+* ``mysql_session``
+* ``npm``
+* ``ntp_conf``
+* ``oneget``
+* ``os``
+* ``os_env``
+* ``package``
+* ``parse_config``
+* ``parse_config_file``
+* ``passwd``
+* ``pip``
+* ``port``
+* ``postgres_conf``
+* ``postgres_session``
+* ``processes``
+* ``registry_key``
+* ``script``
+* ``security_policy``
+* ``service``
+* ``ssh_config``
+* ``sshd_config``
+* ``user``
+* ``windows_feature``
+* ``yaml``
+* ``yum``
+
+See below for more information about each InSpec audit resource, its related matchers, and examples of how to use it in a recipe.
+
+
+apache_conf
+=====================================================
+Use the ``apache_conf`` |inspec resource| to test the configuration settings for |apache|. This file is typically located under ``/etc/apache2`` on the |debian| and |ubuntu| platforms and under ``/etc/httpd`` on the |fedora|, |centos|, |redhat enterprise linux|, and |archlinux| platforms. The configuration settings may vary significantly from platform to platform.
+
+**Stability: Experimental**
+
+Syntax
+-----------------------------------------------------
+An ``apache_conf`` |inspec resource| block declares configuration settings that should be tested:
+
+.. code-block:: ruby
+
+   describe apache_conf('path') do
+     its('setting_name') { should eq 'value' }
+   end
+
+where
+
+* ``'setting_name'`` is a configuration setting defined in the |apache| configuration file
+* ``('path')`` is the non-default path to the |apache| configuration file
+* ``{ should eq 'value' }`` is the value that is expected
+
+Matchers
+-----------------------------------------------------
+This |inspec resource| matches any service that is listed in the |apache| configuration file:
+
+.. code-block:: ruby
+
+   its('PidFile') { should_not eq '/var/run/httpd.pid' }
+
+or:
+
+.. code-block:: ruby
+
+   its('Timeout') { should eq 300 }
+
+For example:
+
+.. code-block:: ruby
+
+   describe apache_conf do
+     its('MaxClients') { should eq 100 }
+     its('Listen') { should eq '443'}
+   end
+
+Examples
+-----------------------------------------------------
+The following examples show how to use this InSpec audit resource in a test.
+
+**Test for blocking .htaccess files on CentOS**
+
+.. code-block:: ruby
+
+   describe apache_conf do
+     its('AllowOverride') { should eq 'None' }
+   end
+
+**Test ports for SSL**
+
+.. code-block:: ruby
+
+   describe apache_conf do
+     its('Listen') { should eq '443'}
+   end
+
+
+apt
+=====================================================
+Use the ``apt`` |inspec resource| to verify |apt| repositories on the |debian| and |ubuntu| platforms, and also |ppa| repositories on the |ubuntu| platform.
+
+**Stability: Stable**
+
+Syntax
+-----------------------------------------------------
+An ``apt`` |inspec resource| block tests the contents of |apt| and |ppa| repositories:
+
+.. code-block:: ruby
+
+   describe apt('path') do
+     it { should exist }
+     it { should be_enabled }
+   end
+
+where
+
+* ``apt('path')`` must specify an |apt| or |ppa| repository
+* ``('path')`` may be an ``http://`` address, a ``ppa:`` address, or a short ``repo-name/ppa`` address
+* ``exist`` and ``be_enabled`` are a valid matchers for this |inspec resource|
+
+Matchers
+-----------------------------------------------------
+This InSpec audit resource has the following matchers.
+
+be_enabled
++++++++++++++++++++++++++++++++++++++++++++++++++++++
+The ``be_enabled`` matcher tests if a package exists in the repository:
+
+.. code-block:: ruby
+
+   it { should be_enabled }
+
+exist
++++++++++++++++++++++++++++++++++++++++++++++++++++++
+The ``exist`` matcher tests if a package exists on the system:
+
+.. code-block:: ruby
+
+   it { should exist }
+
+Examples
+-----------------------------------------------------
+The following examples show how to use this InSpec audit resource in a test.
+
+**Test if apt repository exists and is enabled**
+
+.. code-block:: ruby
+
+   describe apt('http://ppa.launchpad.net/juju/stable/ubuntu') do
+     it { should exist }
+     it { should be_enabled }
+   end
+
+**Verify that a PPA repository exists and is enabled**
+
+.. code-block:: ruby
+
+   describe apt('ppa:nginx/stable') do
+     it { should exist }
+     it { should be_enabled }
+   end
+
+**Verify that a repository is not present**
+
+.. code-block:: ruby
+
+   describe apt('ubuntu-wine/ppa') do
+     it { should_not exist }
+     it { should_not be_enabled }
+   end
+
+
+
+audit_policy
+=====================================================
+Use the ``audit_policy`` |inspec resource| to test auditing policies on the |windows| platform. An auditing policy is a category of security-related events to be audited. Auditing is disabled by default and may be enabled for categories like account management, logon events, policy changes, process tracking, privilege use, system events, or object access. For each auditing category property that is enabled, the auditing level may be set to ``No Auditing``, ``Not Specified``, ``Success``, ``Success and Failure``, or ``Failure``.
+
+**Stability: Experimental**
+
+Syntax
+-----------------------------------------------------
+An ``audit_policy`` |inspec resource| block declares a parameter that belongs to an audit policy category or subcategory:
+
+.. code-block:: ruby
+
+   describe audit_policy do
+     its('parameter') { should eq 'value' }
+   end
+
+where
+
+* ``'parameter'`` must specify a parameter
+* ``'value'`` must be one of ``No Auditing``, ``Not Specified``, ``Success``, ``Success and Failure``, or ``Failure``
+
+Matchers
+-----------------------------------------------------
+This InSpec audit resource does not have any matchers.
+
+Examples
+-----------------------------------------------------
+The following examples show how to use this InSpec audit resource.
+
+**Test that a parameter is not set to "No Auditing"**
+
+.. code-block:: ruby
+
+   describe audit_policy do
+     its('Other Account Logon Events') { should_not eq 'No Auditing' }
+   end
+
+**Test that a parameter is set to "Success"**
+
+.. code-block:: ruby
+
+   describe audit_policy do
+     its('User Account Management') { should eq 'Success' }
+   end
+
+
+
+auditd_conf
+=====================================================
+Use the ``auditd_conf`` |inspec resource| to test the configuration settings for the audit daemon. This file is typically located under ``/etc/audit/auditd.conf'`` on |unix| and |linux| platforms.
+
+**Stability: Experimental**
+
+Syntax
+-----------------------------------------------------
+A ``auditd_conf`` |inspec resource| block declares configuration settings that should be tested:
+
+.. code-block:: ruby
+
+   describe auditd_conf('path') do
+     its('keyword') { should eq 'value' }
+   end
+
+where
+
+* ``'keyword'`` is a configuration setting defined in the ``auditd.conf`` configuration file
+* ``('path')`` is the non-default path to the ``auditd.conf`` configuration file
+* ``{ should eq 'value' }`` is the value that is expected
+
+Matchers
+-----------------------------------------------------
+This |inspec resource| matches any keyword that is listed in the ``auditd.conf`` configuration file:
+
+.. code-block:: ruby
+
+   its('log_format') { should eq 'raw' }
+
+Examples
+-----------------------------------------------------
+The following examples show how to use this InSpec audit resource.
+
+**Test the auditd.conf file**
+
+.. code-block:: ruby
+
+   describe auditd_conf do
+     its('log_file') { should eq '/full/path/to/file' }
+     its('log_format') { should eq 'raw' }
+     its('flush') { should eq 'none' }
+     its('freq') { should eq '1' }
+     its('num_logs') { should eq '0' }
+     its('max_log_file') { should eq '6' }
+     its('max_log_file_action') { should eq 'email' }
+     its('space_left') { should eq '2' }
+     its('action_mail_acct') { should eq 'root' }
+     its('space_left_action') { should eq 'email' }
+     its('admin_space_left') { should eq '1' }
+     its('admin_space_left_action') { should eq 'halt' }
+     its('disk_full_action') { should eq 'halt' }
+     its('disk_error_action') { should eq 'halt' }
+   end
+
+
+
+auditd_rules
+=====================================================
+Use the ``auditd_rules`` |inspec resource| to test the rules for logging that exist on the system. The ``audit.rules`` file is typically located under ``/etc/audit/`` and contains the list of rules that define what is captured in log files.
+
+**Stability: Experimental**
+
+Syntax
+-----------------------------------------------------
+A ``auditd_rules`` |inspec resource| block declares one (or more) rules to be tested, and then what that rule should do:
+
+.. code-block:: ruby
+
+   describe auditd_rules do
+     its('LIST_RULES') { should eq [
+      'exit,always syscall=rmdir,unlink',
+      'exit,always auid=1001 (0x3e9) syscall=open',
+      'exit,always watch=/etc/group perm=wa',
+      'exit,always watch=/etc/passwd perm=wa',
+      'exit,always watch=/etc/shadow perm=wa',
+      'exit,always watch=/etc/sudoers perm=wa',
+      'exit,always watch=/etc/secret_directory perm=r',
+    ] }
+   end
+
+or test that individual rules are defined:
+
+.. code-block:: ruby
+
+  describe auditd_rules do
+    its('LIST_RULES') {should contain_match(/^exit,always watch=\/etc\/group perm=wa key=identity/) }
+    its('LIST_RULES') {should contain_match(/^exit,always watch=\/etc\/passwd perm=wa key=identity/) }
+    its('LIST_RULES') {should contain_match(/^exit,always watch=\/etc\/gshadow perm=wa key=identity/)}
+    its('LIST_RULES') {should contain_match(/^exit,always watch=\/etc\/shadow perm=wa key=identity/)}
+    its('LIST_RULES') {should contain_match(/^exit,always watch=\/etc\/security\/opasswd perm=wa key=identity/)}
+  end
+
+where each test
+
+* Must declare one (or more) rules to be tested
+
+Examples
+-----------------------------------------------------
+The following examples show how to use this InSpec audit resource.
+
+**Test if a rule contains a matching element that is identified by a regular expression.**
+
+.. code-block:: ruby
+
+   describe audit_daemon_rules do
+     its("LIST_RULES") {
+       should contain_match(/^exit,always arch=.* key=time-change syscall=adjtimex,settimeofday/)
+     }
+   end
+
+
+
+bond
+=====================================================
+Use the ``bond`` |inspec resource| to test a logical, bonded network interface (i.e. "two or more network interfaces aggregated into a single, logical network interface"). On |linux| platforms, any value in the ``/proc/net/bonding`` directory may be tested.
+
+**Stability: Stable**
+
+Syntax
+-----------------------------------------------------
+A ``bond`` |inspec resource| block declares a bonded network interface, and then specifies the properties of that bonded network interface to be tested:
+
+.. code-block:: ruby
+
+   describe bond('name') do
+     it { should exist }
+   end
+
+where
+
+* ``'name'`` is the name of the bonded network interface
+* ``{ should exist }`` is a valid matcher for this |inspec resource|
+
+Matchers
+-----------------------------------------------------
+This InSpec audit resource has the following matchers.
+
+content
++++++++++++++++++++++++++++++++++++++++++++++++++++++
+The ``content`` matcher tests if contents in the file that defines the bonded network interface match the value specified in the test. The values of the ``content`` matcher are arbitrary:
+
+.. code-block:: ruby
+
+   its('content') { should match('value') }
+
+exist
++++++++++++++++++++++++++++++++++++++++++++++++++++++
+The ``exist`` matcher tests if the bonded network interface is available:
+
+.. code-block:: ruby
+
+   it { should exist }
+
+have_interface
++++++++++++++++++++++++++++++++++++++++++++++++++++++
+The ``have_interface`` matcher tests if the bonded network interface has one (or more) secondary interfaces:
+
+.. code-block:: ruby
+
+   it { should have_interface }
+
+interfaces
++++++++++++++++++++++++++++++++++++++++++++++++++++++
+The ``interfaces`` matcher tests if the named secondary interfaces are available:
+
+.. code-block:: ruby
+
+   its('interfaces') { should eq ['eth0', 'eth1', ...] }
+
+params
++++++++++++++++++++++++++++++++++++++++++++++++++++++
+The ``params`` matcher tests arbitrary parameters for the bonded network interface:
+
+.. code-block:: ruby
+
+   its('params') { should eq 'value' }
+
+Examples
+-----------------------------------------------------
+The following examples show how to use this InSpec audit resource.
+
+**Test if eth0 is a secondary interface for bond0**
+
+.. code-block:: ruby
+
+   describe bond('bond0') do
+     it { should exist }
+     it { should have_interface 'eth0' }
+   end
+
+**Test parameters for bond0**
+
+.. code-block:: ruby
+
+   describe bond('bond0') do
+     its('Bonding Mode') { should eq 'IEEE 802.3ad Dynamic link aggregation' }
+     its('Transmit Hash Policy') { should eq 'layer3+4 (1)' }
+     its('MII Status') { should eq 'up' }
+     its('MII Polling Interval (ms)') { should eq '100' }
+     its('Up Delay (ms)') { should eq '0' }
+     its('Down Delay (ms)') { should eq '0' }
+   end
+
+
+
+
+
+bridge
+=====================================================
+Use the ``bridge`` |inspec resource| to test basic network bridge properties, such as name, if an interface is defined, and the associations for any defined interface.
+
+* On |linux| platforms, any value in the ``/sys/class/net/{interface}/bridge`` directory may be tested
+* On the |windows| platform, the ``Get-NetAdapter`` cmdlet is associated with the ``Get-NetAdapterBinding`` cmdlet and returns the ``ComponentID ms_bridge`` value as a |json| object
+
+.. not sure the previous two bullet items are actually true, but keeping there for reference for now, just in case
+
+**Stability: Stable**
+
+Syntax
+-----------------------------------------------------
+A ``bridge`` |inspec resource| block declares the bridge to be tested and what interface it should be associated with:
+
+.. code-block:: ruby
+
+   describe bridge('br0') do
+     it { should exist }
+     it { should have_interface 'eth0' }
+   end
+
+..
+.. where
+..
+.. * ``xxxxx`` must specify xxxxx
+.. * xxxxx
+.. * ``xxxxx`` is a valid matcher for this InSpec audit resource
+..
+
+
+Matchers
+-----------------------------------------------------
+This InSpec audit resource has the following matchers.
+
+exist
++++++++++++++++++++++++++++++++++++++++++++++++++++++
+The ``exist`` matcher tests if the network bridge is available:
+
+.. code-block:: ruby
+
+   it { should exist }
+
+have_interface
++++++++++++++++++++++++++++++++++++++++++++++++++++++
+The ``have_interface`` matcher tests if the named interface is defined for the network bridge:
+
+.. code-block:: ruby
+
+   it { should have_interface 'eth0' }
+
+interfaces
++++++++++++++++++++++++++++++++++++++++++++++++++++++
+The ``interfaces`` matcher tests if the named interface is present:
+
+.. code-block:: ruby
+
+   its('interfaces') { should eq 'foo' }
+   its('interfaces') { should eq 'bar' }
+   its('interfaces') { should include('foo') }
+
+..
+.. Examples
+.. -----------------------------------------------------
+.. The following examples show how to use this InSpec audit resource.
+..
+.. **xxxxx**
+..
+.. xxxxx
+..
+.. **xxxxx**
+..
+.. xxxxx
+..
+
+
+
+
+command
+=====================================================
+Use the ``command`` |inspec resource| to test an arbitrary command that is run on the system.
+
+**Stability: Stable**
+
+Syntax
+-----------------------------------------------------
+A ``command`` |inspec resource| block declares a command to be run, one (or more) expected outputs, and the location to which that output is sent:
+
+.. code-block:: ruby
+
+   describe command('command') do
+     it { should exist }
+     its('matcher') { should eq 'output' }
+   end
+
+where
+
+* ``'command'`` must specify a command to be run
+* ``'matcher'`` is one of ``exit_status``, ``stderr``, or ``stdout``
+* ``'output'`` tests the output of the command run on the system versus the output value stated in the test
+
+Matchers
+-----------------------------------------------------
+This InSpec audit resource has the following matchers.
+
+exist
++++++++++++++++++++++++++++++++++++++++++++++++++++++
+The ``exist`` matcher tests if a command may be run on the system:
+
+.. code-block:: ruby
+
+   it { should exist }
+
+exit_status
++++++++++++++++++++++++++++++++++++++++++++++++++++++
+The ``exit_status`` matcher tests the exit status for the command:
+
+.. code-block:: ruby
+
+   its('exit_status') { should eq 123 }
+
+stderr
++++++++++++++++++++++++++++++++++++++++++++++++++++++
+The ``stderr`` matcher tests results of the command as returned in standard error (stderr):
+
+.. code-block:: ruby
+
+   its('stderr') { should eq 'error' }
+
+stdout
++++++++++++++++++++++++++++++++++++++++++++++++++++++
+The ``stdout`` matcher tests results of the command as returned in standard output (stdout):
+
+.. code-block:: ruby
+
+   its('stdout') { should eq '/^1$/' }
+
+Examples
+-----------------------------------------------------
+The following examples show how to use this InSpec audit resource.
+
+**Test for PostgreSQL database running a RC, but no development, or beta release**
+
+.. code-block:: ruby
+
+   describe command('psql -V') do
+     its('stdout') { should eq '/RC/' }
+     its('stdout') { should_not eq '/DEVEL/' }
+     its('stdout') { should_not eq '/BETA/' }
+   end
+
+**Test standard output (stdout)**
+
+.. code-block:: ruby
+
+   describe command('echo hello') do
+     its('stdout') { should eq 'hello\n' }
+     its('stderr') { should eq '' }
+     its('exit_status') { should eq 0 }
+   end
+
+**Test standard error (stderr)**
+
+.. code-block:: ruby
+
+   describe command('>&2 echo error') do
+     its('stdout') { should eq '' }
+     its('stderr') { should eq 'error\n' }
+     its('exit_status') { should eq 0 }
+   end
+
+**Test an exit status code**
+
+.. code-block:: ruby
+
+   describe command('exit 123') do
+     its('stdout') { should eq '' }
+     its('stderr') { should eq '' }
+     its('exit_status') { should eq 123 }
+   end
+
+**Test if the command shell exists**
+
+.. code-block:: ruby
+
+   describe command('/bin/sh').exist? do
+     it { should eq true }
+   end
+
+**Test for a command that should not exist**
+
+.. code-block:: ruby
+
+   describe command('this is not existing').exist? do
+     it { should eq false }
+   end
+
+
+
+
+csv
+=====================================================
+Use the ``csv`` |inspec resource| to test configuration data in a |csv| file.
+
+**Stability: Experimental**
+
+Syntax
+-----------------------------------------------------
+A ``csv`` |inspec resource| block declares the configuration data to be tested:
+
+.. code-block:: ruby
+
+   describe csv('file') do
+     its('name') { should eq 'foo' }
+   end
+
+where
+
+* ``'file'`` is the path to a |csv| file
+* ``name`` is a configuration setting in a |csv| file
+* ``should eq 'foo'`` tests a value of ``name`` as read from a |csv| file versus the value declared in the test
+
+Matchers
+-----------------------------------------------------
+This InSpec audit resource has the following matchers.
+
+name
++++++++++++++++++++++++++++++++++++++++++++++++++++++
+The ``name`` matcher tests the value of ``name`` as read from a |csv| file versus the value declared in the test:
+
+.. code-block:: ruby
+
+   its('name') { should eq 'foo' }
+
+Examples
+-----------------------------------------------------
+The following examples show how to use this InSpec audit resource.
+
+**Test a CSV file**
+
+.. code-block:: ruby
+
+   describe csv('some_file.csv') do
+     its('setting') { should eq 1 }
+   end
+
+
+
+directory
+=====================================================
+Use the ``directory`` |inspec resource| to test if the file type is a directory. This is equivalent to using the ``file`` |inspec resource| and the ``be_directory`` matcher, but provides a simpler and more direct way to test directories. All of the matchers available to ``file`` may be used with ``directory``.
+
+**Stability: Experimental**
+
+Syntax
+-----------------------------------------------------
+A ``directory`` |inspec resource| block declares the location of the directory to be tested, and then one (or more) matchers:
+
+.. code-block:: ruby
+
+   describe directory('path') do
+     it { should MATCHER 'value' }
+   end
+
+Matchers
+-----------------------------------------------------
+This |inspec resource| may use any of the matchers available to the ``file`` resource that are useful for testing a directory.
+
+..
+.. Examples
+.. -----------------------------------------------------
+.. The following examples show how to use this InSpec audit resource.
+..
+.. **xxxxx**
+..
+.. xxxxx
+..
+.. **xxxxx**
+..
+.. xxxxx
+..
+
+
+etc_group
+=====================================================
+Use the ``etc_group`` |inspec resource| to test groups that are defined on |linux| and |unix| platforms. The ``/etc/group`` file stores details about each group---group name, password, group identifier, along with a comma-separate list of users that belong to the group.
+
+**Stability: Experimental**
+
+Syntax
+-----------------------------------------------------
+A ``etc_group`` |inspec resource| block declares a collection of properties to be tested:
+
+.. code-block:: ruby
+
+   describe etc_group('path') do
+     its('matcher') { should eq 'some_value' }
+   end
+
+or:
+
+.. code-block:: ruby
+
+   describe etc_group.where(item: 'value', item: 'value') do
+     its('gids') { should_not contain_duplicates }
+     its('groups') { should include 'user_name' }
+     its('users') { should include 'user_name' }
+   end
+
+where
+
+* ``('path')`` is the non-default path to the ``inetd.conf`` file
+* ``.where()`` may specify a specific item and value, to which the matchers are compared
+* ``'gids'``, ``'groups'``, and ``'users'`` are valid matchers for this |inspec resource|
+
+Matchers
+-----------------------------------------------------
+This InSpec audit resource has the following matchers.
+
+gids
++++++++++++++++++++++++++++++++++++++++++++++++++++++
+The ``gids`` matcher tests if the named group identifier is present or if it contains duplicates:
+
+.. code-block:: ruby
+
+   its('gids') { should_not contain_duplicates }
+
+groups
++++++++++++++++++++++++++++++++++++++++++++++++++++++
+The ``groups`` matcher tests all groups for the named user:
+
+.. code-block:: ruby
+
+   its('groups') { should include 'my_group' }
+
+users
++++++++++++++++++++++++++++++++++++++++++++++++++++++
+The ``users`` matcher tests all groups for the named user:
+
+.. code-block:: ruby
+
+   its('users') { should include 'my_user' }
+
+where
++++++++++++++++++++++++++++++++++++++++++++++++++++++
+The ``where`` matcher allows the test to be focused to one (or more) specific items:
+
+.. code-block:: ruby
+
+   etc_group.where(item: 'value', item: 'value')
+
+where ``item`` may be one (or more) of:
+
+* ``name: 'name'``
+* ``group_name: 'group_name'``
+* ``password: 'password'``
+* ``gid: 'gid'``
+* ``group_id: 'gid'``
+* ``users: 'user_name'``
+* ``members: 'member_name'``
+
+Examples
+-----------------------------------------------------
+The following examples show how to use this InSpec audit resource.
+
+**Test group identifiers (GIDs) for duplicates**
+
+.. code-block:: ruby
+
+   describe etc_group do
+     its('gids') { should_not contain_duplicates }
+   end
+
+**Test all groups to see if a specific user belongs to one (or more) groups**
+
+.. code-block:: ruby
+
+   describe etc_group do
+     its('groups') { should include 'my_group' }
+   end
+
+
+**Test all groups for a specific user name**
+
+.. code-block:: ruby
+
+   describe etc_group do
+     its('users') { should include 'my_user' }
+   end
+
+**Filter a list of groups for a specific user**
+
+.. code-block:: ruby
+
+   describe etc_group.where(name: 'my_group') do
+     its('users') { should include 'my_user' }
+   end
+
+
+
+file
+=====================================================
+Use the ``file`` |inspec resource| to test all system file types, including files, directories, symbolic links, named pipes, sockets, character devices, block devices, and doors.
+
+**Stability: Stable**
+
+Syntax
+-----------------------------------------------------
+A ``file`` |inspec resource| block declares the location of the file type to be tested, what type that file should be (if required), and then one (or more) matchers:
+
+.. code-block:: ruby
+
+   describe file('path') do
+     it { should MATCHER 'value' }
+   end
+
+where
+
+* ``('path')`` is the name of the file and/or the path to the file
+* ``MATCHER`` is a valid matcher for this |inspec resource|
+* ``'value'`` is the value to be tested
+
+Matchers
+-----------------------------------------------------
+This InSpec audit resource has the following matchers.
+
+be_block_device
++++++++++++++++++++++++++++++++++++++++++++++++++++++
+The ``be_block_device`` matcher tests if the file exists as a block device, such as ``/dev/disk0`` or ``/dev/disk0s9``:
+
+.. code-block:: ruby
+
+   it { should be_block_device }
+
+be_character_device
++++++++++++++++++++++++++++++++++++++++++++++++++++++
+The ``be_character_device`` matcher tests if the file exists as a character device (that corresponds to a block device), such as ``/dev/rdisk0`` or ``/dev/rdisk0s9``:
+
+.. code-block:: ruby
+
+   it { should be_character_device }
+
+be_directory
++++++++++++++++++++++++++++++++++++++++++++++++++++++
+The ``be_directory`` matcher tests if the file exists as a directory, such as ``/etc/passwd``, ``/etc/shadow``, or ``/var/log/httpd``:
+
+.. code-block:: ruby
+
+   it { should be_directory }
+
+be_executable
++++++++++++++++++++++++++++++++++++++++++++++++++++++
+The ``be_executable`` matcher tests if the file exists as an executable:
+
+.. code-block:: ruby
+
+   it { should be_executable }
+
+The ``be_executable`` matcher may also test if the file is executable by a specific owner, group, or user. For example, a group:
+
+.. code-block:: ruby
+
+   it { should be_executable.by('group') }
+
+an owner:
+
+.. code-block:: ruby
+
+   it { should be_executable.by('owner') }
+
+a user:
+
+.. code-block:: ruby
+
+   it { should be_executable.by_user('user') }
+
+be_file
++++++++++++++++++++++++++++++++++++++++++++++++++++++
+The ``be_file`` matcher tests if the file exists as a file. This can be useful with configuration files like ``/etc/passwd`` where there typically is not an associated file extension---``passwd.txt``:
+
+.. code-block:: ruby
+
+   it { should be_file }
+
+be_grouped_into
++++++++++++++++++++++++++++++++++++++++++++++++++++++
+The ``be_grouped_into`` matcher tests if the file exists as part of the named group:
+
+.. code-block:: ruby
+
+   it { should be_grouped_into 'group' }
+
+be_immutable
++++++++++++++++++++++++++++++++++++++++++++++++++++++
+The ``be_immutable`` matcher tests if the file is immutable, i.e. "cannot be changed":
+
+.. code-block:: ruby
+
+   it { should be_immutable }
+
+be_linked_to
++++++++++++++++++++++++++++++++++++++++++++++++++++++
+The ``be_linked_to`` matcher tests if the file is linked to the named target:
+
+.. code-block:: ruby
+
+   it { should be_linked_to '/etc/target-file' }
+
+be_mounted
++++++++++++++++++++++++++++++++++++++++++++++++++++++
+The ``be_mounted`` matcher tests if the file is accessible from the file system:
+
+.. code-block:: ruby
+
+   it { should be_mounted }
+
+be_owned_by
++++++++++++++++++++++++++++++++++++++++++++++++++++++
+The ``be_owned_by`` matcher tests if the file is owned by the named user, such as ``root``:
+
+.. code-block:: ruby
+
+   it { should be_owned_by 'root' }
+
+be_pipe
++++++++++++++++++++++++++++++++++++++++++++++++++++++
+The ``be_pipe`` matcher tests if the file exists as first-in, first-out special file (``.fifo``) that is typically used to define a named pipe, such as ``/var/log/nginx/access.log.fifo``:
+
+.. code-block:: ruby
+
+   it { should be_pipe }
+
+be_readable
++++++++++++++++++++++++++++++++++++++++++++++++++++++
+The ``be_readable`` matcher tests if the file is readable:
+
+.. code-block:: ruby
+
+   it { should be_readable }
+
+The ``be_readable`` matcher may also test if the file is readable by a specific owner, group, or user. For example, a group:
+
+.. code-block:: ruby
+
+   it { should be_readable.by('group') }
+
+an owner:
+
+.. code-block:: ruby
+
+   it { should be_readable.by('owner') }
+
+a user:
+
+.. code-block:: ruby
+
+   it { should be_readable.by_user('user') }
+
+be_socket
++++++++++++++++++++++++++++++++++++++++++++++++++++++
+The ``be_socket`` matcher tests if the file exists as socket (``.sock``), such as ``/var/run/php-fpm.sock``:
+
+.. code-block:: ruby
+
+   it { should be_socket }
+
+be_symlink
++++++++++++++++++++++++++++++++++++++++++++++++++++++
+The ``be_symlink`` matcher tests if the file exists as a symbolic, or soft link that contains an absolute or relative path reference to another file:
+
+.. code-block:: ruby
+
+   it { should be_symlink }
+
+be_version
++++++++++++++++++++++++++++++++++++++++++++++++++++++
+The ``be_version`` matcher tests the version of the file:
+
+.. code-block:: ruby
+
+   it { should be_version '1.2.3' }
+
+be_writable
++++++++++++++++++++++++++++++++++++++++++++++++++++++
+The ``be_writable`` matcher tests if the file is writable:
+
+.. code-block:: ruby
+
+   it { should be_writable }
+
+The ``be_writable`` matcher may also test if the file is writable by a specific owner, group, or user. For example, a group:
+
+.. code-block:: ruby
+
+   it { should be_writable.by('group') }
+
+an owner:
+
+.. code-block:: ruby
+
+   it { should be_writable.by('owner') }
+
+a user:
+
+.. code-block:: ruby
+
+   it { should be_writable.by_user('user') }
+
+content
++++++++++++++++++++++++++++++++++++++++++++++++++++++
+The ``content`` matcher tests if contents in the file match the value specified in the test. The values of the ``content`` matcher are arbitrary and depend on the file type being tested and also the type of information that is expected to be in that file:
+
+.. code-block:: ruby
+
+   its('content') { should contain 'value' }
+
+The following complete example tests the ``pg_hba.conf`` file in |postgresql| for |md5| requirements.  The tests look at all ``host`` and ``local`` settings in that file, and then compare the |md5| checksums against the values in the test:
+
+.. code-block:: bash
+
+   describe file(hba_config_file) do
+     its('content') { should match '/local\s.*?all\s.*?all\s.*?md5/' }
+     its('content') { should match '%r{/host\s.*?all\s.*?all\s.*?127.0.0.1\/32\s.*?md5/}' }
+     its('content') { should match '%r{/host\s.*?all\s.*?all\s.*?::1\/128\s.*?md5/}' }
+   end
+
+exist
++++++++++++++++++++++++++++++++++++++++++++++++++++++
+The ``exist`` matcher tests if the named file exists:
+
+.. code-block:: ruby
+
+   it { should exist }
+
+file_version
++++++++++++++++++++++++++++++++++++++++++++++++++++++
+The ``file_version`` matcher tests if the file's version matches the specified value. The difference between a file's "file version" and "product version" is that the file version is the version number of the file itself, whereas the product version is the version number associated with the application from which that file originates:
+
+.. code-block:: ruby
+
+   its('file_version') { should eq '1.2.3' }
+
+group
++++++++++++++++++++++++++++++++++++++++++++++++++++++
+The ``group`` matcher tests if the group to which a file belongs matches the specified value:
+
+.. code-block:: ruby
+
+   its('group') { should eq 'admins' }
+
+have_mode
++++++++++++++++++++++++++++++++++++++++++++++++++++++
+The ``have_mode`` matcher tests if a file has a mode assigned to it:
+
+.. code-block:: ruby
+
+   it { should have_mode }
+
+link_path
++++++++++++++++++++++++++++++++++++++++++++++++++++++
+The ``link_path`` matcher tests if the file exists at the specified path:
+
+.. code-block:: ruby
+
+   its('link_path') { should eq '/some/path/to/file' }
+
+link_target
++++++++++++++++++++++++++++++++++++++++++++++++++++++
+The ``link_target`` matcher tests if a file that is linked to this file exists at the specified path:
+
+.. code-block:: ruby
+
+   its('link_target') { should eq '/some/path/to/file' }
+
+md5sum
++++++++++++++++++++++++++++++++++++++++++++++++++++++
+The ``md5sum`` matcher tests if the |md5| checksum for a file matches the specified value:
+
+.. code-block:: ruby
+
+   its('md5sum') { should eq '3329x3hf9130gjs9jlasf2305mx91s4j' }
+
+mode
++++++++++++++++++++++++++++++++++++++++++++++++++++++
+The ``mode`` matcher tests if the mode assigned to the file matches the specified value:
+
+.. code-block:: ruby
+
+   its('mode') { should eq 0644 }
+
+mtime
++++++++++++++++++++++++++++++++++++++++++++++++++++++
+The ``mtime`` matcher tests if the file modification time for the file matches the specified value:
+
+.. code-block:: ruby
+
+   its('mtime') { should eq 'October 31 2015 12:10:45' }
+
+or:
+
+.. code-block:: bash
+
+   describe file('/').mtime.to_i do
+     it { should <= Time.now.to_i }
+     it { should >= Time.now.to_i - 1000}
+   end
+
+owner
++++++++++++++++++++++++++++++++++++++++++++++++++++++
+The ``owner`` matcher tests if the owner of the file matches the specified value:
+
+.. code-block:: ruby
+
+   its('owner') { should eq 'root' }
+
+product_version
++++++++++++++++++++++++++++++++++++++++++++++++++++++
+The ``product_version`` matcher tests if the file's product version matches the specified value. The difference between a file's "file version" and "product version" is that the file version is the version number of the file itself, whereas the product version is the version number associated with the application from which that file originates:
+
+.. code-block:: ruby
+
+   its('product_version') { should eq 2.3.4 }
+
+selinux_label
++++++++++++++++++++++++++++++++++++++++++++++++++++++
+The ``selinux_label`` matcher tests if the |selinux| label for a file matches the specified value:
+
+.. code-block:: ruby
+
+   its('selinux_label') { should eq 'system_u:system_r:httpd_t:s0' }
+
+sha256sum
++++++++++++++++++++++++++++++++++++++++++++++++++++++
+The ``sha256sum`` matcher tests if the |sha256| checksum for a file matches the specified value:
+
+.. code-block:: ruby
+
+   its('sha256sum') { should eq 'b837ch38lh19bb8eaopl8jvxwd2e4g58jn9lkho1w3ed9jbkeicalplaad9k0pjn' }
+
+size
++++++++++++++++++++++++++++++++++++++++++++++++++++++
+The ``size`` matcher tests if a file's size matches, is greater than, or is less than the specified value. For example, equal:
+
+.. code-block:: ruby
+
+   its('size') { should eq 32375 }
+
+Greater than:
+
+.. code-block:: ruby
+
+   its('size') { should > 64 }
+
+Less than:
+
+.. code-block:: ruby
+
+   its('size') { should < 10240 }
+
+type
++++++++++++++++++++++++++++++++++++++++++++++++++++++
+The ``type`` matcher tests if the first letter of the file's mode string contains one of the following characters:
+
+* ``-`` or ``f`` (the file is a file); use ``'file`` to test for this file type
+* ``d`` (the file is a directory); use ``'directory`` to test for this file type
+* ``l`` (the file is a symbolic link); use ``'link`` to test for this file type
+* ``p`` (the file is a named pipe); use ``'pipe`` to test for this file type
+* ``s`` (the file is a socket); use ``'socket`` to test for this file type
+* ``c`` (the file is a character device); use ``'character`` to test for this file type
+* ``b`` (the file is a block device); use ``'block`` to test for this file type
+* ``D`` (the file is a door); use ``'door`` to test for this file type
+
+For example:
+
+.. code-block:: ruby
+
+   its('type') { should eq 'file' }
+
+or:
+
+.. code-block:: ruby
+
+   its('type') { should eq 'socket' }
+
+Examples
+-----------------------------------------------------
+The following examples show how to use this InSpec audit resource.
+
+**Test the contents of a file for MD5 requirements**
+
+.. code-block:: bash
+
+   describe file(hba_config_file) do
+     its('content') { should match '/local\s.*?all\s.*?all\s.*?md5/' }
+     its('content') { should match '%r{/host\s.*?all\s.*?all\s.*?127.0.0.1\/32\s.*?md5/}' }
+     its('content') { should match '%r{/host\s.*?all\s.*?all\s.*?::1\/128\s.*?md5/}' }
+   end
+
+**Test if a file exists**
+
+.. code-block:: bash
+
+   describe file('/tmp') do
+    it { should exist }
+   end
+
+**Test that a file does not exist**
+
+.. code-block:: bash
+
+   describe file('/tmpest') do
+    it { should_not exist }
+   end
+
+**Test if a path is a directory**
+
+.. code-block:: bash
+
+   describe file('/tmp') do
+    its('type') { should eq :directory }
+    it { should be_directory }
+   end
+
+**Test if a path is a file and not a directory**
+
+.. code-block:: bash
+
+   describe file('/proc/version') do
+     its('type') { should eq 'file' }
+     it { should be_file }
+     it { should_not be_directory }
+   end
+
+**Test if a file is a symbolic link**
+
+.. code-block:: bash
+
+   describe file('/dev/stdout') do
+     its('type') { should eq 'symlink' }
+     it { should be_symlink }
+     it { should_not be_file }
+     it { should_not be_directory }
+   end
+
+**Test if a file is a character device**
+
+.. code-block:: bash
+
+   describe file('/dev/zero') do
+     its('type') { should eq 'character' }
+     it { should be_character_device }
+     it { should_not be_file }
+     it { should_not be_directory }
+   end
+
+**Test if a file is a block device**
+
+.. code-block:: bash
+
+   describe file('/dev/zero') do
+     its('type') { should eq 'block' }
+     it { should be_character_device }
+     it { should_not be_file }
+     it { should_not be_directory }
+   end
+
+**Test the mode for a file**
+
+.. code-block:: bash
+
+   describe file('/dev') do
+    its('mode') { should eq 00755 }
+   end
+
+**Test the owner of a file**
+
+.. code-block:: bash
+
+   describe file('/root') do
+     its('owner') { should eq 'root' }
+   end
+
+**Test if a file is owned by the root user**
+
+.. code-block:: bash
+
+   describe file('/dev') do
+     it { should be_owned_by 'root' }
+   end
+
+**Test the mtime for a file**
+
+.. code-block:: bash
+
+   describe file('/').mtime.to_i do
+     it { should <= Time.now.to_i }
+     it { should >= Time.now.to_i - 1000}
+   end
+
+**Test that a file's size is between 64 and 10240**
+
+.. code-block:: bash
+
+   describe file('/') do
+     its('size') { should be > 64 }
+     its('size') { should be < 10240 }
+   end
+
+**Test that a file's size is zero**
+
+.. code-block:: bash
+
+   describe file('/proc/cpuinfo') do
+     its('size') { should be 0 }
+   end
+
+**Test that a file is not mounted**
+
+.. code-block:: bash
+
+   describe file('/proc/cpuinfo') do
+     it { should_not be_mounted }
+   end
+
+**Test an MD5 checksum**
+
+.. code-block:: bash
+
+   require 'digest'
+   cpuinfo = file('/proc/cpuinfo').content
+   md5sum = Digest::MD5.hexdigest(cpuinfo)
+
+   describe file('/proc/cpuinfo') do
+     its('md5sum') { should eq md5sum }
+   end
+
+**Test an SHA-256 checksum**
+
+.. code-block:: bash
+
+   require 'digest'
+   cpuinfo = file('/proc/cpuinfo').content
+   sha256sum = Digest::SHA256.hexdigest(cpuinfo)
+
+   describe file('/proc/cpuinfo') do
+     its('sha256sum') { should eq sha256sum }
+   end
+
+
+gem
+=====================================================
+Use the ``gem`` |inspec resource| to test if a global |gem| package is installed.
+
+**Stability: Experimental**
+
+Syntax
+-----------------------------------------------------
+A ``gem`` |inspec resource| block declares a package and (optionally) a package version:
+
+.. code-block:: ruby
+
+   describe gem('gem_package_name') do
+     it { should be_installed }
+   end
+
+where
+
+* ``('gem_package_name')`` must specify a |gem| package, such as ``'rubocop'``
+* ``be_installed`` is a valid matcher for this |inspec resource|
+
+Matchers
+-----------------------------------------------------
+This InSpec audit resource has the following matchers.
+
+be_installed
++++++++++++++++++++++++++++++++++++++++++++++++++++++
+The ``be_installed`` matcher tests if the named |gem| package is installed:
+
+.. code-block:: ruby
+
+   it { should be_installed }
+
+version
++++++++++++++++++++++++++++++++++++++++++++++++++++++
+The ``version`` matcher tests if the named package version is on the system:
+
+.. code-block:: ruby
+
+   its('version') { should eq '0.33.0' }
+
+Examples
+-----------------------------------------------------
+The following examples show how to use this InSpec audit resource.
+
+**Verify that a gem package is installed, with a specific version**
+
+.. code-block:: ruby
+
+   describe gem('rubocop') do
+     it { should be_installed }
+     its('version') { should eq '0.33.0' }
+   end
+
+**Verify that a gem package is not installed**
+
+.. code-block:: ruby
+
+   describe gem('rubocop') do
+     it { should_not be_installed }
+   end
+
+
+group
+=====================================================
+Use the ``group`` |inspec resource| to test groups on the system.
+
+Syntax
+-----------------------------------------------------
+A ``group`` |inspec resource| block declares a group, and then the details to be tested, such as if the group is a local group, the group identifier, or if the group exists:
+
+.. code-block:: ruby
+
+   describe group('group_name') do
+     it { should exist }
+     its('gid') { should eq 0 }
+   end
+
+where
+
+* ``'group_name'`` must specify the name of a group on the system
+* ``exist`` and ``'gid'`` are valid matchers for this |inspec resource|
+
+Matchers
+-----------------------------------------------------
+This InSpec audit resource has the following matchers.
+
+be_local
++++++++++++++++++++++++++++++++++++++++++++++++++++++
+The ``be_local`` matcher tests if the group is a local group:
+
+.. code-block:: ruby
+
+   it { should be_local }
+
+exist
++++++++++++++++++++++++++++++++++++++++++++++++++++++
+The ``exist`` matcher tests if the named user exists:
+
+.. code-block:: ruby
+
+   it { should exist }
+
+gid
++++++++++++++++++++++++++++++++++++++++++++++++++++++
+The ``gid`` matcher tests the named group identifier:
+
+.. code-block:: ruby
+
+   its('gid') { should eq 1234 }
+
+Examples
+-----------------------------------------------------
+The following examples show how to use this InSpec audit resource.
+
+**Test the group identifier for the root group**
+
+.. code-block:: ruby
+
+   describe group('root') do
+     it { should exist }
+     its('gid') { should eq 0 }
+   end
+
+
+
+host
+=====================================================
+Use the ``host`` |inspec 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.
+
+**Stability: Stable**
+
+Syntax
+-----------------------------------------------------
+A ``host`` |inspec resource| block declares a host name, and then (depending on what is to be tested) a port and/or a protocol:
+
+.. code-block:: ruby
+
+   describe host('example.com', port: 80, proto: 'tcp') do
+     it { should be_reachable }
+   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
+* ``proto: 'name'`` is the Internet protocol: |tcp| (``proto: 'tcp'``), |udp| (``proto: 'udp'`` or  |icmp| (``proto: 'icmp'``))
+* ``be_reachable`` is a valid matcher for this |inspec resource|
+
+Matchers
+-----------------------------------------------------
+This InSpec audit resource has the following matchers.
+
+be_reachable
++++++++++++++++++++++++++++++++++++++++++++++++++++++
+The ``be_reachable`` matcher tests if the host name is available:
+
+.. code-block:: ruby
+
+   it { should be_reachable }
+
+be_resolvable
++++++++++++++++++++++++++++++++++++++++++++++++++++++
+The ``be_resolvable`` matcher tests for host name resolution, i.e. "resolvable to an IP address":
+
+.. code-block:: ruby
+
+   it { should be_resolvable }
+
+ipaddress
+-----------------------------------------------------
+The ``ipaddress`` matcher tests if a host name is resolvable to a specific IP address:
+
+.. code-block:: ruby
+
+   its('ipaddress') { should include '93.184.216.34' }
+
+Examples
+-----------------------------------------------------
+The following examples show how to use this InSpec audit resource.
+
+**Verify host name s reachable over a specific protocol and port number**
+
+.. code-block:: ruby
+
+   describe host('example.com', port: 53, proto: 'udp') do
+     it { should be_reachable }
+   end
+
+**Verify that a specific IP address can be resolved**
+
+.. code-block:: ruby
+
+   describe host('example.com', port: 80, proto: 'tcp') do
+     it { should be_resolvable }
+     its('ipaddress') { should include '192.168.1.1' }
+   end
+
+
+
+
+inetd_conf
+=====================================================
+Use the ``inetd_conf`` |inspec resource| to test if a service is enabled 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.
+
+**Stability: Experimental**
+
+Syntax
+-----------------------------------------------------
+An ``inetd_conf`` |inspec resource| block declares the list of services that are enabled in the ``inetd.conf`` file:
+
+.. code-block:: ruby
+
+   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
+
+Matchers
+-----------------------------------------------------
+This |inspec resource| matches any service that is listed in the ``inetd.conf`` file. You may want to ensure that specific services do not listen via ``inetd.conf``:
+
+.. code-block:: ruby
+
+   its('shell') { should eq nil }
+
+or:
+
+.. code-block:: ruby
+
+   its('netstat') { should eq nil }
+
+or:
+
+.. code-block:: ruby
+
+   its('systat') { should eq nil }
+
+For example:
+
+.. code-block:: ruby
+
+   describe inetd_conf do
+     its('shell') { should eq nil }
+     its('login') { should eq nil }
+     its('exec') { should eq nil }
+   end
+
+Examples
+-----------------------------------------------------
+The following examples show how to use this InSpec audit resource.
+
+**Verify that FTP is disabled**
+
+The contents if the ``inetd.conf`` file contain the following:
+
+.. code-block:: text
+
+   #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:
+
+.. code-block:: ruby
+
+   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:
+
+.. code-block:: text
+
+   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**
+
+.. code-block:: ruby
+
+   describe package('telnetd') do
+     it { should_not be_installed }
+   end
+
+   describe inetd_conf do
+     its('telnet') { should eq nil }
+   end
+
+
+
+interface
+=====================================================
+Use the ``interface`` |inspec resource| to test basic network adapter properties, such as name, status, state, address, 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
+
+**Stability: Stable**
+
+Syntax
+-----------------------------------------------------
+An ``interface`` |inspec resource| block declares network interface properties to be tested:
+
+.. code-block:: ruby
+
+   describe interface do
+     it { should be_up }
+     its('speed') { should eq 1000 }
+     its('name') { should eq eth0 }
+   end
+
+
+Matchers
+-----------------------------------------------------
+This InSpec audit resource has the following matchers.
+
+be_up
++++++++++++++++++++++++++++++++++++++++++++++++++++++
+The ``be_up`` matcher tests if the network interface is available:
+
+.. code-block:: ruby
+
+   it { should be_up }
+
+name
++++++++++++++++++++++++++++++++++++++++++++++++++++++
+The ``name`` matcher tests if the named network interface exists:
+
+.. code-block:: ruby
+
+   its('name') { should eq eth0 }
+
+speed
++++++++++++++++++++++++++++++++++++++++++++++++++++++
+The ``speed`` matcher tests the speed of the network interface, in MB/sec:
+
+.. code-block:: ruby
+
+   its('speed') { should eq 1000 }
+
+..
+.. Examples
+.. -----------------------------------------------------
+.. The following examples show how to use this InSpec audit resource.
+..
+.. **xxxxx**
+..
+.. xxxxx
+..
+.. **xxxxx**
+..
+.. xxxxx
+..
+
+
+
+iptables
+=====================================================
+Use the ``iptables`` |inspec 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.
+
+**Stability: Experimental**
+
+Syntax
+-----------------------------------------------------
+A ``iptables`` |inspec resource| block declares tests for rules in IP tables:
+
+.. code-block:: ruby
+
+   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 file
+
+Matchers
+-----------------------------------------------------
+This InSpec audit resource has the following matchers.
+
+have_rule
++++++++++++++++++++++++++++++++++++++++++++++++++++++
+The ``have_rule`` matcher tests the named rule against the information in the ``iptables`` file:
+
+.. code-block:: ruby
+
+   it { should have_rule('RULE') }
+
+Examples
+-----------------------------------------------------
+The following examples show how to use this InSpec audit resource.
+
+**Test if the IP table allows a packet through**
+
+.. code-block:: ruby
+
+   describe iptables do
+     it { should have_rule('-P INPUT ACCEPT') }
+   end
+
+**Test if the IP table allows a packet through, for a specific table and chain**
+
+.. code-block:: ruby
+
+   describe iptables(table:'mangle', chain: 'input') do
+     it { should have_rule('-P INPUT ACCEPT') }
+   end
+
+
+
+json
+=====================================================
+Use the ``json`` |inspec resource| to test data in a |json| file.
+
+**Stability: Experimental**
+
+Syntax
+-----------------------------------------------------
+A ``json`` |inspec resource| block declares the data to be tested:
+
+.. code-block:: ruby
+
+   describe json do
+     its('name') { should eq 'foo' }
+   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
+
+Matchers
+-----------------------------------------------------
+This InSpec audit resource has the following matchers.
+
+name
++++++++++++++++++++++++++++++++++++++++++++++++++++++
+The ``name`` matcher tests the value of ``name`` as read from a |json| file versus the value declared in the test:
+
+.. code-block:: ruby
+
+   its('name') { should eq 'foo' }
+
+Examples
+-----------------------------------------------------
+The following examples show how to use this InSpec audit resource.
+
+**Test a cookbook version in a policyfile.lock.json file**
+
+.. code-block:: ruby
+
+   describe json('policyfile.lock.json') do
+     its('cookbook_locks.omnibus.version') { should eq('2.2.0') }
+   end
+
+
+
+kernel_module
+=====================================================
+Use the ``kernel_module`` |inspec resource| to test kernel modules on |linux| platforms. These parameters are located under ``/lib/modules``. Any submodule may be tested using this resource.
+
+**Stability: Stable**
+
+Syntax
+-----------------------------------------------------
+A ``kernel_module`` |inspec resource| block declares a module name, and then tests if that module is a loadable kernel module:
+
+.. code-block:: ruby
+
+   describe kernel_module('module_name') do
+     it { should be_loaded }
+   end
+
+where
+
+* ``'module_name'`` must specify a kernel module, such as ``'bridge'``
+* ``{ should be_loaded }`` tests if the module is a loadable kernel module
+
+Matchers
+-----------------------------------------------------
+This InSpec audit resource has the following matchers.
+
+be_loaded
++++++++++++++++++++++++++++++++++++++++++++++++++++++
+The ``be_loaded`` matcher tests if the module is a loadable kernel module:
+
+.. code-block:: ruby
+
+   it { should be_loaded }
+
+Examples
+-----------------------------------------------------
+The following examples show how to use this InSpec audit resource.
+
+**Test if a module is loaded**
+
+.. code-block:: ruby
+
+   describe kernel_module('bridge') do
+     it { should be_loaded }
+   end
+
+
+kernel_parameter
+=====================================================
+Use the ``kernel_parameter`` |inspec resource| to test kernel parameters on |linux| platforms.
+
+**Stability: Stable**
+
+Syntax
+-----------------------------------------------------
+A ``kernel_parameter`` |inspec resource| block declares a parameter and then a value to be tested:
+
+.. code-block:: ruby
+
+   describe kernel_parameter('path.to.parameter') do
+     its('value') { should eq 0 }
+   end
+
+where
+
+* ``'kernel.parameter'`` must specify a kernel parameter, such as ``'net.ipv4.conf.all.forwarding'``
+* ``{ should eq 0 }`` states the value to be tested
+
+Matchers
+-----------------------------------------------------
+This InSpec audit resource has the following matchers.
+
+value
++++++++++++++++++++++++++++++++++++++++++++++++++++++
+The ``value`` matcher tests the value assigned to the named IP address versus the value declared in the test:
+
+.. code-block:: ruby
+
+   its('value') { should eq 0 }
+
+Examples
+-----------------------------------------------------
+The following examples show how to use this InSpec audit resource.
+
+**Test if global forwarding is enabled for an IPv4 address**
+
+.. code-block:: ruby
+
+   describe kernel_parameter('net.ipv4.conf.all.forwarding') do
+     its(:value) { should eq 1 }
+   end
+
+**Test if global forwarding is disabled for an IPv6 address**
+
+.. code-block:: ruby
+
+   describe kernel_parameter('net.ipv6.conf.all.forwarding') do
+     its(:value) { should eq 0 }
+   end
+
+**Test if an IPv6 address accepts redirects**
+
+.. code-block:: ruby
+
+   describe kernel_parameter('net.ipv6.conf.interface.accept_redirects') do
+     its(:value) { should eq 'true' }
+   end
+
+
+limits_conf
+=====================================================
+Use the ``limits_conf`` |inspec resource| to test configuration settings in the ``/etc/security/limits.conf`` file. The ``limits.conf`` defines limits for processes (by user and/or group names) and helps ensure that the system on which those processes are running remains stable. Each process may be assigned a hard or soft limit.
+
+* Soft limits are maintained by the shell and defines the number of file handles (or open files) available to the user or group after login
+* Hard limits are maintained by the kernel and defines the maximum number of allowed file handles
+
+Entries in the ``limits.conf`` file are similar to:
+
+.. code-block:: bash
+
+   grantmc     soft   nofile   4096
+   grantmc     hard   nofile   63536
+
+   ^^^^^^^^^   ^^^^   ^^^^^^   ^^^^^
+   domain      type    item    value
+
+**Stability: Experimental**
+
+Syntax
+-----------------------------------------------------
+A ``limits_conf`` |inspec resource| block declares a domain to be tested, along with associated type, item, and value:
+
+.. code-block:: ruby
+
+   describe limits_conf('path') do
+     its('domain') { should include ['type', 'item', 'value'] }
+     its('domain') { should eq ['type', 'item', 'value'] }
+   end
+
+where
+
+* ``('path')`` is the non-default path to the ``inetd.conf`` file
+* ``'domain'`` is a user or group name, such as ``grantmc``
+* ``'type'`` is either ``hard`` or ``soft``
+* ``'item'`` is the item for which limits are defined, such as ``core``, ``nofile``, ``stack``, ``nproc``, ``priority``, or ``maxlogins``
+* ``'value'`` is the value associated with the ``item``
+
+Matchers
+-----------------------------------------------------
+This InSpec audit resource has the following matchers.
+
+domain
++++++++++++++++++++++++++++++++++++++++++++++++++++++
+The ``domain`` matcher tests the domain in the ``limits.conf`` file, along with associated type, item, and value:
+
+.. code-block:: ruby
+
+   its('domain') { should include ['type', 'item', 'value'] }
+
+For example:
+
+.. code-block:: ruby
+
+   its('grantmc') { should include ['hard', 'nofile', '63536'] }
+
+Examples
+-----------------------------------------------------
+The following examples show how to use this InSpec audit resource.
+
+**Test * and ftp limits**
+
+.. code-block:: ruby
+
+   describe limits_conf('path') do
+     its('*') { should include ['soft', 'core', '0'] }
+     its('*') { should include ['hard', 'rss', '10000'] }
+     its('ftp') { should eq ['hard', 'nproc', '0'] }
+   end
+
+login_defs
+=====================================================
+Use the ``login_defs`` |inspec resource| to test configuration settings in the ``/etc/login.defs`` file. The ``logins.defs`` file defines site-specific configuration for the shadow password suite on |linux| and |unix| platforms, such as password expiration ranges, minimum/maximum values for automatic selection of user and group identifiers, or the method with which passwords are encrypted.
+
+**Stability: Experimental**
+
+Syntax
+-----------------------------------------------------
+A ``login_defs`` |inspec resource| block declares the ``login.defs`` configuration data to be tested:
+
+.. code-block:: ruby
+
+   describe login_defs do
+     its('name') { should include('foo') }
+   end
+
+where
+
+* ``name`` is a configuration setting in ``login.defs``
+* ``{ should include('foo') }`` tests the value of ``name`` as read from ``login.defs`` versus the value declared in the test
+
+Matchers
+-----------------------------------------------------
+This InSpec audit resource has the following matchers.
+
+name
++++++++++++++++++++++++++++++++++++++++++++++++++++++
+The ``name`` matcher tests the value of ``name`` as read from ``login.defs`` versus the value declared in the test:
+
+.. code-block:: ruby
+
+   its('name') { should eq 'foo' }
+
+Examples
+-----------------------------------------------------
+The following examples show how to use this InSpec audit resource.
+
+**Test password expiration settings**
+
+.. code-block:: ruby
+
+   describe login_defs do
+     its('PASS_MAX_DAYS') { should eq '180' }
+     its('PASS_MIN_DAYS') { should eq '1' }
+     its('PASS_MIN_LEN') { should eq '15' }
+     its('PASS_WARN_AGE') { should eq '30' }
+   end
+
+**Test the encryption method**
+
+.. code-block:: ruby
+
+   describe login_defs do
+     its('ENCRYPT_METHOD') { should eq 'SHA512' }
+   end
+
+**Test umask and password expiration**
+
+.. code-block:: ruby
+
+   describe login_def do
+     its('UMASK') { should eq '077' }
+     its('PASS_MAX_DAYS') { should eq '90' }
+   end
+
+mysql_conf
+=====================================================
+Use the ``mysql_conf`` |inspec resource| to test the contents of the configuration file for |mysql|, typically located at ``/etc/mysql/my.cnf`` or ``/etc/my.cnf``.
+
+Syntax
+-----------------------------------------------------
+A ``mysql_conf`` |inspec 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:
+
+.. code-block:: ruby
+
+   describe mysql_conf('path') do
+     its('setting') { should eq 'value' }
+   end
+
+where
+
+* ``'setting'`` specifies a setting in the ``my.cnf`` file, such as ``max_connections``
+* ``('path')`` is the non-default path to the ``my.cnf`` file
+* ``should eq 'value'`` is the value that is expected
+
+**Stability: Experimental**
+
+Matchers
+-----------------------------------------------------
+This InSpec audit resource has the following matchers.
+
+setting
++++++++++++++++++++++++++++++++++++++++++++++++++++++
+The ``setting`` matcher tests specific, named settings in the ``my.cnf`` file:
+
+.. code-block:: ruby
+
+   its('setting') { should eq 'value' }
+
+Use a ``setting`` matcher for each setting to be tested.
+
+Examples
+-----------------------------------------------------
+The following examples show how to use this InSpec audit resource.
+
+**Test the maximum number of allowed connections**
+
+.. code-block:: ruby
+
+   describe mysql_conf do
+     its('max_connections') { should eq '505' }
+     its('max_user_connections') { should eq '500' }
+   end
+
+**Test slow query logging**
+
+.. code-block:: ruby
+
+   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**
+
+.. code-block:: ruby
+
+   describe mysql_conf do
+     its('port') { should eq '3306' }
+     its('socket') { should eq '/var/run/mysqld/mysql.sock' }
+   end
+
+**Test connection and thread variables**
+
+.. code-block:: ruby
+
+   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**
+
+.. code-block:: ruby
+
+   describe mysql_conf.params('mysqld') do
+     its('safe-user-create') { should eq('1') }
+   end
+
+
+mysql_session
+=====================================================
+Use the ``mysql_session`` |inspec resource| to test SQL commands run against a |mysql| database.
+
+**Stability: Experimental**
+
+Syntax
+-----------------------------------------------------
+A ``mysql_session`` |inspec resource| block declares the username and password to use for the session, and then the command to be run:
+
+.. code-block:: ruby
+
+   describe mysql_session('username', 'password').query('QUERY') do
+     its('output') { should eq('') }
+   end
+
+where
+
+* ``mysql_session`` declares a username and password with permission to run the query
+* ``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.
+
+output
++++++++++++++++++++++++++++++++++++++++++++++++++++++
+The ``output`` matcher tests the results of the query:
+
+.. code-block:: ruby
+
+   its('output') { should eq(/^0/) }
+
+Examples
+-----------------------------------------------------
+The following examples show how to use this InSpec audit resource.
+
+**Test for matching databases**
+
+.. code-block:: ruby
+
+   sql = mysql_session('my_user','password')
+   describe sql.query('show databases like \'test\';') do
+     its(:stdout) { should_not match(/test/) }
+   end
+
+
+
+
+npm
+=====================================================
+Use the ``npm`` |inspec resource| to test if a global |npm| package is installed. |npm| is the `the package manager for Nodejs packages <https://docs.npmjs.com>`__, such as |bower| and |statsd|.
+
+**Stability: Experimental**
+
+Syntax
+-----------------------------------------------------
+A ``npm`` |inspec resource| block declares a package and (optionally) a package version:
+
+.. code-block:: ruby
+
+   describe gem('npm_package_name') do
+     it { should be_installed }
+   end
+
+where
+
+* ``('npm_package_name')`` must specify a |npm| package, such as ``'bower'`` or ``'statsd'``
+* ``be_installed`` is a valid matcher for this |inspec resource|
+
+Matchers
+-----------------------------------------------------
+This InSpec audit resource has the following matchers.
+
+be_installed
++++++++++++++++++++++++++++++++++++++++++++++++++++++
+The ``be_installed`` matcher tests if the named |gem| package and package version (if specified) is installed:
+
+.. code-block:: ruby
+
+   it { should be_installed }
+
+version
++++++++++++++++++++++++++++++++++++++++++++++++++++++
+The ``version`` matcher tests if the named package version is on the system:
+
+.. code-block:: ruby
+
+   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**
+
+.. code-block:: ruby
+
+   describe npm('bower') do
+     it { should be_installed }
+     its('version') { should eq '1.4.1' }
+   end
+
+**Verify that statsd is not installed**
+
+.. code-block:: ruby
+
+   describe npm('statsd') do
+     it { should_not be_installed }
+   end
+
+
+ntp_conf
+=====================================================
+Use the ``ntp_conf`` |inspec resource| to test the synchronization settings defined in the ``ntp.conf`` file. This file is typically located at ``/etc/ntp.conf``.
+
+**Stability: Experimental**
+
+Syntax
+-----------------------------------------------------
+An ``ntp_conf`` |inspec resource| block declares the synchronization settings that should be tested:
+
+.. code-block:: ruby
+
+   describe ntp_conf('path') do
+     its('setting_name') { should eq 'value' }
+   end
+
+where
+
+* ``'setting_name'`` is a synchronization setting defined in the ``ntp.conf`` file
+* ``('path')`` is the non-default path to the ``ntp.conf`` file
+* ``{ should eq 'value' }`` is the value that is expected
+
+Matchers
+-----------------------------------------------------
+This |inspec resource| matches any service that is listed in the ``ntp.conf`` file:
+
+.. code-block:: ruby
+
+   its('server') { should_not eq nil }
+
+or:
+
+.. code-block:: ruby
+
+   its('restrict') { should include '-4 default kod notrap nomodify nopeer noquery'}
+
+For example:
+
+.. code-block:: ruby
+
+   describe ntp_conf do
+     its('server') { should_not eq nil }
+     its('restrict') { should include '-4 default kod notrap nomodify nopeer noquery'}
+   end
+
+Examples
+-----------------------------------------------------
+The following examples show how to use this InSpec audit resource.
+
+**Test for clock drift against named servers**
+
+.. code-block:: ruby
+
+   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
+     ] }
+   end
+
+
+
+oneget
+=====================================================
+Use the ``oneget`` |inspec 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.
+
+**Stability: Experimental**
+
+Syntax
+-----------------------------------------------------
+A ``oneget`` |inspec resource| block declares a package and (optionally) a package version:
+
+.. code-block:: ruby
+
+   describe oneget('name') do
+     it { should be_installed }
+   end
+
+where
+
+* ``('name')`` must specify the name of a package, such as ``'VLC'``
+* ``be_installed`` is a valid matcher for this |inspec resource|
+
+Matchers
+-----------------------------------------------------
+This InSpec audit resource has the following matchers.
+
+be_installed
++++++++++++++++++++++++++++++++++++++++++++++++++++++
+The ``be_installed`` matcher tests if the named package is installed on the system:
+
+.. code-block:: ruby
+
+   it { should be_installed }
+
+version
++++++++++++++++++++++++++++++++++++++++++++++++++++++
+The ``version`` matcher tests if the named package version is on the system:
+
+.. code-block:: ruby
+
+   its('version') { should eq '1.2.3' }
+
+Examples
+-----------------------------------------------------
+The following examples show how to use this InSpec audit resource.
+
+**Test if VLC is installed**
+
+.. code-block:: ruby
+
+   describe oneget('VLC') do
+     it { should be_installed }
+   end
+
+
+os
+=====================================================
+Use the ``os`` |inspec resource| to test the platform on which the system is running.
+
+**Stability: Stable**
+
+Syntax
+-----------------------------------------------------
+A ``os`` |inspec resource| block declares the platform to be tested:
+
+.. code-block:: ruby
+
+   describe os['family'] do
+     it { should eq 'platform' }
+   end
+
+where
+
+* ``'platform'`` is one of ``bsd``, ``debian``, ``linux``, ``redhat``, ``solaris``, ``suse``,  ``unix``, or ``windows``
+
+
+Matchers
+-----------------------------------------------------
+This InSpec audit resource does not have any matchers.
+
+Examples
+-----------------------------------------------------
+The following examples show how to use this InSpec audit resource.
+
+**Test for RedHat**
+
+.. code-block:: ruby
+
+   describe os['family'] do
+     it { should eq 'redhat' }
+   end
+
+**Test for Ubuntu**
+
+.. code-block:: ruby
+
+   describe os['family'] do
+     it { should eq 'debian' }
+   end
+
+**Test for Microsoft Windows**
+
+.. code-block:: ruby
+
+   describe os['family'] do
+     it { should eq 'windows' }
+   end
+
+
+os_env
+=====================================================
+Use the ``os_env`` |inspec resource| to test the environment variables for the platform on which the system is running.
+
+**Stability: Experimental**
+
+Syntax
+-----------------------------------------------------
+A ``os_env`` |inspec resource| block declares an environment variable, and then declares its value:
+
+.. code-block:: ruby
+
+   describe os_env('VARIABLE') do
+     its('matcher') { should eq 1 }
+   end
+
+where
+
+* ``('VARIABLE')`` must specify an environment variable, such as ``PATH``
+* ``matcher`` is a valid matcher for this InSpec resource
+
+Matchers
+-----------------------------------------------------
+This InSpec audit resource has the following matchers.
+
+content
++++++++++++++++++++++++++++++++++++++++++++++++++++++
+The ``content`` matcher return the value of the environment variable:
+
+.. code-block:: ruby
+
+   its('content') { should eq '/usr/local/bin:/usr/local/sbin:/usr/sbin:/usr/bin:/sbin' }
+
+split
++++++++++++++++++++++++++++++++++++++++++++++++++++++
+The ``split`` splits the content with the ``:``` deliminator:
+
+.. code-block:: ruby
+
+   its('split') { should include ('') }
+
+or:
+
+.. code-block:: ruby
+
+   its('split') { should_not include ('.') }
+
+Use ``-1`` to test for cases where there is a trailing colon (``:``), such as ``dir1::dir2:``:
+
+.. code-block:: ruby
+
+   its('split') { should include ('-1') }
+
+
+Examples
+-----------------------------------------------------
+The following examples show how to use this InSpec audit resource.
+
+**Test the PATH environment variable**
+
+.. code-block:: ruby
+
+   describe os_env('PATH') do
+     its('split') { should_not include('') }
+     its('split') { should_not include('.') }
+   end
+
+
+package
+=====================================================
+Use the ``package`` |inspec resource| to test if the named package and/or package version is installed on the system.
+
+**Stability: Stable**
+
+Syntax
+-----------------------------------------------------
+A ``package`` |inspec resource| block declares a package and (optionally) a package version:
+
+.. code-block:: ruby
+
+   describe package('name') do
+     it { should be_installed }
+   end
+
+where
+
+* ``('name')`` must specify the name of a package, such as ``'nginx'``
+* ``be_installed`` is a valid matcher for this |inspec resource|
+
+Matchers
+-----------------------------------------------------
+This InSpec audit resource has the following matchers.
+
+be_installed
++++++++++++++++++++++++++++++++++++++++++++++++++++++
+The ``be_installed`` matcher tests if the named package is installed on the system:
+
+.. code-block:: ruby
+
+   it { should be_installed }
+
+version
++++++++++++++++++++++++++++++++++++++++++++++++++++++
+The ``version`` matcher tests if the named package version is on the system:
+
+.. code-block:: ruby
+
+   its('version) { should eq '1.2.3' }
+
+Examples
+-----------------------------------------------------
+The following examples show how to use this InSpec audit resource.
+
+**Test if nginx version 1.9.5 is installed**
+
+.. code-block:: ruby
+
+   describe package('nginx') do
+     it { should be_installed }
+     its('version') { should eq 1.9.5 }
+   end
+
+**Test that a package is not installed**
+
+.. code-block:: ruby
+
+   describe package('some_package') do
+     it { should_not be_installed }
+   end
+
+**Test if telnet is installed**
+
+.. code-block:: ruby
+
+   describe package('telnetd') do
+     it { should_not be_installed }
+   end
+
+   describe inetd_conf do
+     its('telnet') { should eq nil }
+   end
+
+**Test if ClamAV (an antivirus engine) is installed and running**
+
+.. code-block:: ruby
+
+   describe package('clamav') do
+     it { should be_installed }
+     its('version') { should eq '0.98.7' }
+   end
+
+   describe service('clamd') do
+     it { should_not be_enabled }
+     it { should_not be_installed }
+     it { should_not be_running }
+   end
+
+
+parse_config
+=====================================================
+Use the ``parse_config`` |inspec resource| to test arbitrary configuration files.
+
+**Stability: Experimental**
+
+Syntax
+-----------------------------------------------------
+A ``parse_config`` |inspec resource| block declares the location of the configuration setting to be tested, and then what value is to be tested. Because this |inspec resource| relies on arbitrary configuration files, the test itself is often arbitrary and relies on custom |ruby| code:
+
+.. code-block:: ruby
+
+   output = command('some-command').stdout
+
+   describe parse_config(output, { data_config_option: value } ) do
+     its('setting') { should eq 1 }
+   end
+
+or:
+
+.. code-block:: ruby
+
+   audit = command('/sbin/auditctl -l').stdout
+     options = {
+       assignment_re: /^\s*([^:]*?)\s*:\s*(.*?)\s*$/,
+       multiple_values: true
+     }
+
+   describe parse_config(audit, options) do
+     its('setting') { should eq 1 }
+   end
+
+where each test
+
+* Must declare the location of the configuration file to be tested
+* Must declare one (or more) settings to be tested
+* May run a command to ``stdout``, and then run the test against that output
+* May use options to define how configuration data is to be parsed
+
+Options
+-----------------------------------------------------
+This |inspec resource| supports the following options for parsing configuration data. Use them in an ``options`` block stated outside of (and immediately before) the actual test:
+
+.. code-block:: ruby
+
+   options = {
+       assignment_re: /^\s*([^:]*?)\s*:\s*(.*?)\s*$/,
+       multiple_values: true
+     }
+   describe parse_config(options) do
+     its('setting') { should eq 1 }
+   end
+
+assignment_re
++++++++++++++++++++++++++++++++++++++++++++++++++++++
+Use ``assignment_re`` to test a key value using a regular expression:
+
+.. code-block:: ruby
+
+   'key = value'
+
+may be tested using the following regular expression, which determines assignment from key to value:
+
+.. code-block:: ruby
+
+   assignment_re: /^\s*([^=]*?)\s*=\s*(.*?)\s*$/
+
+comment_char
++++++++++++++++++++++++++++++++++++++++++++++++++++++
+Use ``comment_char`` to test for comments in a configuration file:
+
+.. code-block:: ruby
+
+   comment_char: '#'
+
+key_vals
++++++++++++++++++++++++++++++++++++++++++++++++++++++
+Use ``key_vals`` to test how many values a key contains:
+
+.. code-block:: ruby
+
+   key = a b c
+
+contains three values. To test that value to ensure it only contains one, use:
+
+.. code-block:: ruby
+
+   key_vals: 1
+
+multiple_values
++++++++++++++++++++++++++++++++++++++++++++++++++++++
+Use ``multiple_values`` if the source file uses the same key multiple times. All values will be aggregated in an array:
+
+.. code-block:: ruby
+
+   # # file structure:
+   # key = a
+   # key = b
+   # key2 = c
+   params['key'] = ['a', 'b']
+   params['key2'] = ['c']
+
+To use plain key value mapping, use ``multiple_values: false``:
+
+.. code-block:: ruby
+
+   # # file structure:
+   # key = a
+   # key = b
+   # key2 = c
+   params['key'] = 'b'
+   params['key2'] = 'c'
+
+
+standalone_comments
++++++++++++++++++++++++++++++++++++++++++++++++++++++
+Use ``standalone_comments`` to parse comments as a line , otherwise inline comments are allowed:
+
+.. code-block:: ruby
+
+   'key = value # comment'
+   params['key'] = 'value # comment'
+
+
+Use ``standalone_comments: false``, to parse the following:
+
+.. code-block:: ruby
+
+   'key = value # comment'
+   params['key'] = 'value'
+
+Examples
+-----------------------------------------------------
+The following examples show how to use this InSpec audit resource.
+
+**Test the expiration time for new account passwords**
+
+.. code-block:: ruby
+
+   output = command('useradd -D').stdout
+
+   describe parse_config(output) do
+     its('INACTIVE') { should eq '35' }
+   end
+
+**Test that bob is a user**
+
+.. code-block:: ruby
+
+   describe parse_config(data, { multiple_values: true }) do
+     its('users') { should include 'bob'}
+   end
+
+
+parse_config_file
+=====================================================
+Use the ``parse_config_file`` InSpec audit resource to test arbitrary configuration files. It works identiacal to ``parse_config``. Instead of using a command output, this resource works with files.
+
+**Stability: Experimental**
+
+Syntax
+-----------------------------------------------------
+A ``parse_config_file`` InSpec audit resource block declares the location of the configuration file to be tested, and then which settings in that file are to be tested.
+
+.. code-block:: ruby
+
+   describe parse_config_file('/path/to/file', { data_config_option: value } ) do
+     its('setting') { should eq 1 }
+   end
+
+or:
+
+.. code-block:: ruby
+
+   options = {
+     assignment_re: /^\s*([^:]*?)\s*:\s*(.*?)\s*$/,
+     multiple_values: true
+   }
+
+   describe parse_config_file('path/to/file', options) do
+     its('setting') { should eq 1 }
+   end
+
+where each test
+
+* Must declare the location of the configuration file to be tested
+* Must declare one (or more) settings to be tested
+* May run a command to ``stdout``, and then run the test against that output
+* May use options to define how configuration data is to be parsed
+
+Options
+-----------------------------------------------------
+This |inspec resource| supports the following options for parsing configuration data. Use them in an ``options`` block stated outside of (and immediately before) the actual test:
+
+.. code-block:: ruby
+
+   options = {
+       assignment_re: /^\s*([^:]*?)\s*:\s*(.*?)\s*$/,
+       multiple_values: true
+     }
+   describe parse_config_file('path/to/file',  options) do
+     its('setting') { should eq 1 }
+   end
+
+assignment_re
++++++++++++++++++++++++++++++++++++++++++++++++++++++
+Use ``assignment_re`` to parse a key value using a regular expression:
+
+.. code-block:: ruby
+
+   'key = value'
+
+may be parsed using the following regular expression, which determines assignment from key to value:
+
+.. code-block:: ruby
+
+   assignment_re: /^\s*([^=]*?)\s*=\s*(.*?)\s*$/
+
+comment_char
++++++++++++++++++++++++++++++++++++++++++++++++++++++
+Use ``comment_char`` to parse for comments in a configuration file:
+
+.. code-block:: ruby
+
+   comment_char: '#'
+
+key_vals
++++++++++++++++++++++++++++++++++++++++++++++++++++++
+Use ``key_vals`` to parse how many values a key contains:
+
+.. code-block:: ruby
+
+   key = a b c
+
+contains three values. To test that value to ensure it only contains one, use:
+
+.. code-block:: ruby
+
+   key_vals: 1
+
+
+multiple_values
++++++++++++++++++++++++++++++++++++++++++++++++++++++
+Use ``multiple_values`` if the source file uses the same key multiple times. All values will be aggregated in an array:
+
+.. code-block:: ruby
+
+   # # file structure:
+   # key = a
+   # key = b
+   # key2 = c
+   params['key'] = ['a', 'b']
+   params['key2'] = ['c']
+
+To use plain key value mapping, use ``multiple_values: false``:
+
+.. code-block:: ruby
+
+   # # file structure:
+   # key = a
+   # key = b
+   # key2 = c
+   params['key'] = 'b'
+   params['key2'] = 'c'
+
+
+standalone_comments
++++++++++++++++++++++++++++++++++++++++++++++++++++++
+Use ``standalone_comments`` to parse comments as a line , otherwise inline comments are allowed:
+
+.. code-block:: ruby
+
+   'key = value # comment'
+   params['key'] = 'value # comment'
+
+
+Use ``standalone_comments: false``, to parse the following:
+
+.. code-block:: ruby
+
+  'key = value # comment'
+  params['key'] = 'value'
+
+Examples
+-----------------------------------------------------
+The following examples show how to use this InSpec audit resource.
+
+**Test a configuration setting**
+
+.. code-block:: ruby
+
+   describe parse_config_file('/path/to/file.conf') do
+     its('PARAM_X') { should eq 'Y' }
+   end
+
+**Use options, and then test a configuration setting**
+
+.. code-block:: ruby
+
+   describe parse_config_file('/path/to/file.conf', { multiple_values: true }) do
+     its('PARAM_X') { should include 'Y' }
+   end
+
+
+
+passwd
+=====================================================
+Use the ``passwd`` |inspec resource| to test the contents of ``/etc/passwd``, which contains the following information for users that may log into the system and/or as users that own running processes. The format for ``/etc/passwd`` includes:
+
+* A username
+* The password for that user (on newer systems passwords should be stored in ``/etc/shadow`` )
+* The user identifier (UID) assigned to that user
+* The group identifier (GID) assigned to that user
+* Additional information about that user
+* That user's home directory
+* That user's default command shell
+
+defined as a colon-delimited row in the file, one row per user:
+
+.. code-block:: bash
+
+   root:x:1234:5678:additional_info:/home/dir/:/bin/bash
+
+**Stability: Experimental**
+
+Syntax
+-----------------------------------------------------
+A ``passwd`` |inspec resource| block declares one (or more) users and associated user information to be tested:
+
+.. code-block:: ruby
+
+   describe passwd do
+     its('matcher') { should eq 0 }
+   end
+
+   describe passwd.uid(filter) do
+     its(:username) { should eq 'root' }
+     its(:count) { should eq 1 }
+   end
+
+where
+
+* ``gids``, ``passwords``, ``uids``, and ``usernames`` are valid matchers for ``passwd``
+* ``filter`` is a filter for a specific uid
+* ``count``, ``uid``, ``username`` are valid matchers for ``passwd.uid(userid)``
+
+
+Matchers for ``passwd``
+-----------------------------------------------------
+This InSpec audit resource has the following matchers.
+
+gids
++++++++++++++++++++++++++++++++++++++++++++++++++++++
+The ``gids`` matcher tests if the group indentifiers in the test match group identifiers in ``/etc/passwd``:
+
+.. code-block:: ruby
+
+   its('gids') { should eq 1234 }
+
+passwords
++++++++++++++++++++++++++++++++++++++++++++++++++++++
+The ``passwords`` matcher tests if passwords are
+
+* Encrypted
+* Have direct logins disabled, as indicated by an asterisk (``*``)
+* In the ``/etc/shadow`` file, as indicated by the letter x (``x``)
+
+For example:
+
+.. code-block:: ruby
+
+   its('passwords') { should eq 'x' }
+
+uids
++++++++++++++++++++++++++++++++++++++++++++++++++++++
+The ``uids`` matcher tests if the user indentifiers in the test match user identifiers in ``/etc/passwd``:
+
+.. code-block:: ruby
+
+   its('uids') { should eq ['1234', '1235'] }
+
+usernames
++++++++++++++++++++++++++++++++++++++++++++++++++++++
+The ``usernames`` matcher tests if the usernames in the test match usernames in ``/etc/passwd``:
+
+.. code-block:: ruby
+
+   its('usernames') { should eq ['root', 'www-data'] }
+
+
+Matchers for ``passwd.uid(userid)``
+-----------------------------------------------------
+This InSpec audit resource has the following matchers.
+
+count
++++++++++++++++++++++++++++++++++++++++++++++++++++++
+The ``count`` matcher tests the number of times the named user appears in ``/etc/passwd``:
+
+.. code-block:: ruby
+
+   its('count') { should eq 1 }
+
+uid
++++++++++++++++++++++++++++++++++++++++++++++++++++++
+The ``uid`` matcher tests if the user identifier in the test matches a user identifier in ``/etc/passwd``:
+
+.. code-block:: ruby
+
+   its('uid') { should eq 1234 }
+
+username
++++++++++++++++++++++++++++++++++++++++++++++++++++++
+The ``username`` matcher tests if the user name in the test matches a user name in ``/etc/passwd``:
+
+.. code-block:: ruby
+
+   its('username') { should eq 'root' }
+
+Examples
+-----------------------------------------------------
+The following examples show how to use this InSpec audit resource.
+
+**Test usernames and UIDs**
+
+.. code-block:: ruby
+
+   describe passwd do
+     its('usernames') { should eq ['root', 'www-data'] }
+     its('uids') { should eq [0, 33] }
+   end
+
+**Select one user and test for multiple occurances in passwd**
+
+.. code-block:: ruby
+
+   describe passwd.uid(0) do
+     its('username') { should eq 'root' }
+     its('count') { should eq 1 }
+   end
+
+   describe passwd.uid(33) do
+     its('username') { should eq 'www-data' }
+     its('count') { should eq 1 }
+   end
+
+
+pip
+=====================================================
+Use the ``pip`` |inspec resource| to test packages that are installed using the |pip| installer.
+
+**Stability: Experimental**
+
+Syntax
+-----------------------------------------------------
+A ``pip`` |inspec resource| block declares a package and (optionally) a package version:
+
+.. code-block:: ruby
+
+   describe pip('Jinja2') do
+     it { should be_installed }
+   end
+
+where
+
+* ``'Jinja2'`` is the name of the package
+* ``be_installed`` tests to see if the ``Jinja2`` package is installed
+
+Matchers
+-----------------------------------------------------
+This InSpec audit resource has the following matchers.
+
+be_installed
++++++++++++++++++++++++++++++++++++++++++++++++++++++
+The ``be_installed`` matcher tests if the named package is installed on the system:
+
+.. code-block:: ruby
+
+   it { should be_installed }
+
+version
++++++++++++++++++++++++++++++++++++++++++++++++++++++
+The ``version`` matcher tests if the named package version is on the system:
+
+.. code-block:: ruby
+
+   its('version') { should eq '1.2.3' }
+
+Examples
+-----------------------------------------------------
+The following examples show how to use this InSpec audit resource.
+
+**Test if Jinja2 is installed on the system**
+
+.. code-block:: ruby
+
+   describe pip('Jinja2') do
+     it { should be_installed }
+   end
+
+**Test if Jinja2 2.8 is installed on the system**
+
+.. code-block:: ruby
+
+   describe pip('Jinja2') do
+     it { should be_installed }
+     its('version') { should eq '2.8' }
+   end
+
+
+port
+=====================================================
+Use the ``port`` |inspec resource| to test basic port properties, such as port, process, if it's listening.
+
+**Stability: Stable**
+
+Syntax
+-----------------------------------------------------
+A ``port`` |inspec resource| block declares a port, and then depending on what needs to be tested, a process, protocol, process identifier, and its state (is it listening?):
+
+.. code-block:: ruby
+
+   describe port(514) do
+     it { should be_listening }
+     its('process') {should eq 'syslog'}
+   end
+
+where the ``process`` returns the process listening on port 514.
+
+Matchers
+-----------------------------------------------------
+This InSpec audit resource has the following matchers.
+
+be_listening
++++++++++++++++++++++++++++++++++++++++++++++++++++++
+The ``be_listening`` matcher tests if the port is listening for traffic:
+
+.. code-block:: ruby
+
+   it { should be_listening }
+
+pid
++++++++++++++++++++++++++++++++++++++++++++++++++++++
+The ``pid`` matcher tests the process identifier (PID):
+
+.. code-block:: ruby
+
+   its('pid') { should eq '27808' }
+
+process
++++++++++++++++++++++++++++++++++++++++++++++++++++++
+The ``process`` matcher tests if the named process is running on the system:
+
+.. code-block:: ruby
+
+   its('process') { should eq 'syslog' }
+
+protocol
++++++++++++++++++++++++++++++++++++++++++++++++++++++
+The ``protocol`` matcher tests the Internet protocol: |icmp| (``'icmp'``), |tcp| (``'tcp'`` or ``'tcp6'``), or |udp| (``'udp'`` or ``'udp6'``):
+
+.. code-block:: ruby
+
+   its('protocol') { should eq 'tcp' }
+
+or for the |ipv6| protocol:
+
+.. code-block:: ruby
+
+   its('protocol') { should eq 'tcp6' }
+
+Examples
+-----------------------------------------------------
+The following examples show how to use this InSpec audit resource.
+
+**Test port 80, listening with the TCP protocol**
+
+.. code-block:: ruby
+
+   describe port(80) do
+     it { should be_listening }
+     its('protocol') {should eq 'tcp'}
+   end
+
+**Test port 80, listening with TCP version IPv6 protocol**
+
+.. code-block:: ruby
+
+   describe port(80) do
+     it { should be_listening }
+     its('protocol') {should eq 'tcp6'}
+   end
+
+**Test ports for HTTPs**
+
+.. code-block:: ruby
+
+   describe port(80) do
+     it { should_not be_listening }
+   end
+
+   describe port(443) do
+     it { should be_listening }
+     its('protocol') {should eq 'tcp'}
+   end
+
+postgres_conf
+=====================================================
+Use the ``postgres_conf`` |inspec resource| to test the contents of the configuration file for |postgresql|, typically located at ``/etc/postgresql/<version>/main/postgresql.conf`` or ``/var/lib/postgres/data/postgresql.conf``, depending on the platform.
+
+**Stability: Experimental**
+
+Syntax
+-----------------------------------------------------
+A ``postgres_conf`` |inspec resource| block declares one (or more) settings in the ``postgresql.conf`` file, and then compares the setting in the configuration file to the value stated in the test:
+
+.. code-block:: ruby
+
+   describe postgres_conf('path') do
+     its('setting') { should eq 'value' }
+   end
+
+where
+
+* ``'setting'`` specifies a setting in the ``postgresql.conf`` file
+* ``('path')`` is the non-default path to the ``postgresql.conf`` file (optional)
+* ``should eq 'value'`` is the value that is expected
+
+Matchers
+-----------------------------------------------------
+This InSpec audit resource has the following matchers.
+
+setting
++++++++++++++++++++++++++++++++++++++++++++++++++++++
+The ``setting`` matcher tests specific, named settings in the ``postgresql.conf`` file:
+
+.. code-block:: ruby
+
+   its('setting') { should eq 'value' }
+
+Use a ``setting`` matcher for each setting to be tested.
+
+Examples
+-----------------------------------------------------
+The following examples show how to use this InSpec audit resource.
+
+**Test the maximum number of allowed client connections**
+
+.. code-block:: ruby
+
+   describe postgres_conf do
+     its('max_connections') { should eq '5' }
+   end
+
+**Test system logging**
+
+.. code-block:: ruby
+
+   describe postgres_conf do
+     its('logging_collector') { should eq 'on' }
+     its('log_connections') { should eq 'on' }
+     its('log_disconnections') { should eq 'on' }
+     its('log_duration') { should eq 'on' }
+     its('log_hostname') { should eq 'on' }
+     its('log_line_prefix') { should eq '%t %u %d %h' }
+   end
+
+**Test the port on which PostgreSQL listens**
+
+.. code-block:: ruby
+
+   describe postgres_conf do
+     its('port') { should eq '5432' }
+   end
+
+**Test the Unix socket settings**
+
+.. code-block:: ruby
+
+   describe postgres_conf do
+     its('unix_socket_directories') { should eq '.s.PGSQL.5432' }
+     its('unix_socket_group') { should eq nil }
+     its('unix_socket_permissions') { should eq '0770' }
+   end
+
+where ``unix_socket_group`` is set to the |postgresql| default setting (the group to which the server user belongs).
+
+
+
+postgres_session
+=====================================================
+Use the ``postgres_session`` |inspec resource| to test SQL commands run against a |postgresql| database.
+
+**Stability: Experimental**
+
+Syntax
+-----------------------------------------------------
+A ``postgres_session`` |inspec resource| block declares the username and password to use for the session, and then the command to be run:
+
+.. code-block:: ruby
+
+   sql = postgres_session('username', 'password')
+
+   describe sql.query('SELECT * FROM pg_shadow WHERE passwd IS NULL;') do
+     its('output') { should eq('') }
+   end
+
+where
+
+* ``sql = postgres_session`` declares a username and password with permission to run the query
+* ``sql.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.
+
+output
++++++++++++++++++++++++++++++++++++++++++++++++++++++
+The ``output`` matcher tests the results of the query:
+
+.. code-block:: ruby
+
+   its('output') { should eq(/^0/) }
+
+Examples
+-----------------------------------------------------
+The following examples show how to use this InSpec audit resource.
+
+**Test the PostgreSQL shadow password**
+
+.. code-block:: ruby
+
+   sql = postgres_session('my_user', 'password')
+
+   describe sql.query('SELECT * FROM pg_shadow WHERE passwd IS NULL;') do
+     its('output') { should eq('') }
+   end
+
+**Test for risky database entries**
+
+.. code-block:: ruby
+
+   describe postgres_session('my_user', 'password').query('SELECT count (*)
+                 FROM pg_language
+                 WHERE lanpltrusted = 'f'
+                 AND lanname!='internal'
+                 AND lanname!='c';') do
+     its('output') { should eq(/^0/) }
+   end
+
+
+
+processes
+=====================================================
+Use the ``processes`` |inspec resource| to test properties for programs that are running on the system.
+
+**Stability: Experimental**
+
+Syntax
+-----------------------------------------------------
+A ``processes`` |inspec resource| block declares the name of the process to be tested, and then declares one (or more) property/value pairs:
+
+.. code-block:: ruby
+
+   describe processes('process_name') do
+     its('property_name') { should eq 'property_value' }
+   end
+
+where
+
+* ``processes('process_name')`` must specify the name of a process that is running on the system
+* Multiple properties may be tested; for each property to be tested, use an ``its('property_name')`` statement
+
+Matchers
+-----------------------------------------------------
+This InSpec audit resource has the following matchers.
+
+property_name
++++++++++++++++++++++++++++++++++++++++++++++++++++++
+The ``property_name`` matcher tests the named property for the specified value:
+
+.. code-block:: ruby
+
+   its('property_name') { should eq 'property_value' }
+
+Examples
+-----------------------------------------------------
+The following examples show how to use this InSpec audit resource.
+
+.. The title for the example below needs to be clarified, then it can be uncommented
+.. 
+.. **Test for multiple instances of Nginx**
+.. 
+.. .. code-block:: ruby
+.. 
+..   describe processes('postgres') do
+..     its('list.length') { should be(1) }
+..   end
+.. 
+
+**Test for multiple instances of mysqld**
+
+.. code-block:: ruby
+
+   describe processes('mysqld') do
+     its('list.length') { should eq 1 }
+   end
+
+**Test if the init process is owned by the root user**
+
+.. code-block:: ruby
+
+   describe processes('init') do
+     its('user') { should eq 'root' }
+   end
+
+**Test if a high-priority process is running**
+
+.. code-block:: ruby
+
+   describe processes('some_process') do
+     its('state') { should eq 'R<' }
+   end
+
+
+registry_key
+=====================================================
+Use the ``registry_key`` |inspec resource| to test key values in the |windows| registry.
+
+**Stability: Stable**
+
+Syntax
+-----------------------------------------------------
+A ``registry_key`` |inspec resource| block declares the item in the |windows| registry, the path to a setting under that item, and then one (or more) name/value pairs to be tested:
+
+.. code-block:: ruby
+
+   describe registry_key('registry_item', 'path\to\key') do
+     its('name') { should eq 'value' }
+   end
+
+   describe registry_key('path\to\key') do
+     its('name') { should eq 'value' }
+   end
+
+where
+
+* ``'registry_item'`` is a key in the |windows| registry (optional)
+* ``'path\to\key'`` is the path in the |windows| registry
+* ``('name')`` and ``'value'`` represent the name of the key and the value assigned to that key
+
+Matchers
+-----------------------------------------------------
+This InSpec audit resource has the following matchers.
+
+name
++++++++++++++++++++++++++++++++++++++++++++++++++++++
+The ``name`` matcher tests the value for the specified registry setting:
+
+.. code-block:: ruby
+
+   its('name') { should eq 'value' }
+
+Examples
+-----------------------------------------------------
+The following examples show how to use this InSpec audit resource.
+
+**Test the start time for the Schedule service**
+
+.. code-block:: ruby
+
+   describe registry_key('Task Scheduler','HKEY_LOCAL_MACHINE\...\Schedule') do
+     its('Start') { should eq 2 }
+   end
+
+where ``'HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\services\Schedule'`` is the full path to the setting.
+
+
+script
+=====================================================
+Use the ``script`` |inspec resource| to test a |powershell| script on the |windows| platform.
+
+**Stability: Experimental**
+
+Syntax
+-----------------------------------------------------
+A ``script`` |inspec resource| block declares a script to be tested, and then a command that should be part of that script:
+
+.. code-block:: ruby
+
+   script = <<-EOH
+     # you powershell script
+   EOH
+
+   describe script(script) do
+     its('matcher') { should eq 'output' }
+   end
+
+
+where
+
+* ``'script'`` must specify a Powershell script to be run
+* ``'matcher'`` is one of ``exit_status``, ``stderr``, or ``stdout``
+* ``'output'`` tests the output of the command run on the system versus the output value stated in the test
+
+
+Matchers
+-----------------------------------------------------
+This InSpec audit resource has the following matchers.
+
+exit_status
++++++++++++++++++++++++++++++++++++++++++++++++++++++
+The ``exit_status`` matcher tests the exit status for the command:
+
+.. code-block:: ruby
+
+   its('exit_status') { should eq 123 }
+
+stderr
++++++++++++++++++++++++++++++++++++++++++++++++++++++
+The ``stderr`` matcher tests results of the command as returned in standard error (stderr):
+
+.. code-block:: ruby
+
+   its('stderr') { should eq 'error' }
+
+stdout
++++++++++++++++++++++++++++++++++++++++++++++++++++++
+The ``stdout`` matcher tests results of the command as returned in standard output (stdout):
+
+.. code-block:: ruby
+
+   its('stdout') { should eq '/^1$/' }
+
+Examples
+-----------------------------------------------------
+The following examples show how to use this InSpec audit resource.
+
+**Get all groups of Administrator user**
+
+.. code-block:: ruby
+
+   myscript = <<-EOH
+     # find user
+     $user = Get-WmiObject Win32_UserAccount -filter "Name = 'Administrator'"
+     # get related groups
+     $groups = $user.GetRelated('Win32_Group') | Select-Object -Property Caption, Domain, Name, LocalAccount, SID, SIDType, Status
+     $groups | ConvertTo-Json
+   EOH
+
+   describe script(myscript) do
+     its('stdout') { should_not eq '' }
+   end
+
+
+security_policy
+=====================================================
+Use the ``security_policy`` |inspec resource| to test security policies on the |windows| platform.
+
+**Stability: Experimental**
+
+Syntax
+-----------------------------------------------------
+A ``security_policy`` |inspec resource| block declares the name of a security policy and the value to be tested:
+
+.. code-block:: ruby
+
+   describe security_policy do
+     its('policy_name') { should eq 'value' }
+   end
+
+where
+
+* ``'policy_name'`` must specify a security policy
+* ``{ should eq 'value' }`` tests the value of ``policy_name`` against the value declared in the test
+
+Matchers
+-----------------------------------------------------
+This InSpec audit resource has the following matchers.
+
+policy_name
++++++++++++++++++++++++++++++++++++++++++++++++++++++
+The ``policy_name`` matcher must be the name of a security policy:
+
+.. code-block:: ruby
+
+   its('SeNetworkLogonRight') { should eq '*S-1-5-11' }
+
+Examples
+-----------------------------------------------------
+The following examples show how to use this InSpec audit resource.
+
+**Verify that only the Administrators group has remote access**
+
+.. code-block:: ruby
+
+   describe security_policy do
+     its('SeRemoteInteractiveLogonRight') { should eq '*S-1-5-32-544' }
+   end
+
+
+service
+=====================================================
+Use the ``service`` |inspec resource| to test if the named service is installed, running and/or enabled.
+
+**Stability: Stable**
+
+Syntax
+-----------------------------------------------------
+A ``service`` |inspec resource| block declares the name of a service and then one (or more) matchers to test the state of the service:
+
+.. code-block:: ruby
+
+   describe service('service_name') do
+     it { should be_installed }
+     it { should be_enabled }
+     it { should be_running }
+   end
+
+where
+
+* ``('service_name')`` must specify a service name
+* ``be_installed``, ``be_enabled``, and ``be_running`` are valid matchers for this |inspec resource|
+
+Matchers
+-----------------------------------------------------
+This InSpec audit resource has the following matchers.
+
+be_enabled
++++++++++++++++++++++++++++++++++++++++++++++++++++++
+The ``be_enabled`` matcher tests if the named service is enabled:
+
+.. code-block:: ruby
+
+   it { should be_enabled }
+
+be_installed
++++++++++++++++++++++++++++++++++++++++++++++++++++++
+The ``be_installed`` matcher tests if the named service is installed:
+
+.. code-block:: ruby
+
+   it { should be_installed }
+
+be_running
++++++++++++++++++++++++++++++++++++++++++++++++++++++
+The ``be_running`` matcher tests if the named service is running:
+
+.. code-block:: ruby
+
+   it { should be_running }
+
+Examples
+-----------------------------------------------------
+The following examples show how to use this InSpec audit resource.
+
+**Test if the postgresql service is both running and enabled**
+
+.. code-block:: ruby
+
+   describe service('postgresql') do
+     it { should be_enabled }
+     it { should be_running }
+   end
+
+**Test if the mysql service is both running and enabled**
+
+.. code-block:: ruby
+
+   describe service('mysqld') do
+     it { should be_enabled }
+     it { should be_running }
+   end
+
+**Test if ClamAV (an antivirus engine) is installed and running**
+
+.. code-block:: ruby
+
+   describe package('clamav') do
+     it { should be_installed }
+     its('version') { should eq '0.98.7' }
+   end
+
+   describe service('clamd') do
+     it { should_not be_enabled }
+     it { should_not be_installed }
+     it { should_not be_running }
+   end
+
+
+ssh_config
+=====================================================
+Use the ``ssh_config`` |inspec resource| to test |openssh| |ssh| client configuration data located at ``/etc/ssh/ssh_config`` on |linux| and |unix| platforms.
+
+**Stability: Experimental**
+
+Syntax
+-----------------------------------------------------
+A ``ssh_config`` |inspec resource| block declares the client |openssh| configuration data to be tested:
+
+.. code-block:: ruby
+
+   describe ssh_config('path') do
+     its('name') { should include('foo') }
+   end
+
+where
+
+* ``name`` is a configuration setting in ``ssh_config``
+* ``('path')`` is the non-default ``/path/to/ssh_config``
+* ``{ should include('foo') }`` tests the value of ``name`` as read from ``ssh_config`` versus the value declared in the test
+
+Matchers
+-----------------------------------------------------
+This InSpec audit resource has the following matchers.
+
+name
++++++++++++++++++++++++++++++++++++++++++++++++++++++
+The ``name`` matcher tests the value of ``name`` as read from ``ssh_config`` versus the value declared in the test:
+
+.. code-block:: ruby
+
+   its('name') { should eq 'foo' }
+
+or:
+
+.. code-block:: ruby
+
+   its('name') { should include('bar') }
+
+Examples
+-----------------------------------------------------
+The following examples show how to use this InSpec audit resource.
+
+**Test SSH configuration settings**
+
+.. code-block:: ruby
+
+   describe ssh_config do
+     its('cipher') { should contain '3des' }
+     its('port') { should '22' }
+     its('hostname') { should include('example.com') }
+   end
+
+**Test which variables from the local environment are sent to the server**
+
+.. code-block:: ruby
+
+   only_if do
+     command('sshd').exist? or command('ssh').exists?
+   end
+
+   describe ssh_config do
+     its('SendEnv') { should include('GORDON_CLIENT') }
+   end
+
+**Test owner and group permissions**
+
+.. code-block:: ruby
+
+   describe ssh_config do
+     its('owner') { should eq 'root' }
+     its('mode') { should eq 644 }
+   end
+
+**Test SSH configuration**
+
+.. code-block:: ruby
+
+   describe ssh_config do
+     its('Host') { should eq '*' }
+     its('Tunnel') { should eq nil }
+     its('SendEnv') { should eq 'LANG LC_*' }
+     its('HashKnownHosts') { should eq 'yes' }
+   end
+
+
+sshd_config
+=====================================================
+Use the ``sshd_config`` |inspec resource| to test configuration data for the |openssh| daemon located at ``/etc/ssh/sshd_config`` on |linux| and |unix| platforms. sshd---the |openssh| daemon---listens on dedicated ports, starts a daemon for each incoming connection, and then handles encryption, authentication, key exchanges, command executation, and data exchanges.
+
+**Stability: Experimental**
+
+Syntax
+-----------------------------------------------------
+A ``sshd_config`` |inspec resource| block declares the client |openssh| configuration data to be tested:
+
+.. code-block:: ruby
+
+   describe sshd_config('path') do
+     its('name') { should include('foo') }
+   end
+
+where
+
+* ``name`` is a configuration setting in ``sshd_config``
+* ``('path')`` is the non-default ``/path/to/sshd_config``
+* ``{ should include('foo') }`` tests the value of ``name`` as read from ``sshd_config`` versus the value declared in the test
+
+Matchers
+-----------------------------------------------------
+This InSpec audit resource has the following matchers.
+
+name
++++++++++++++++++++++++++++++++++++++++++++++++++++++
+The ``name`` matcher tests the value of ``name`` as read from ``sshd_config`` versus the value declared in the test:
+
+.. code-block:: ruby
+
+   its('name') { should eq 'foo' }
+
+or:
+
+.. code-block:: ruby
+
+   its('name') {should include('bar') }
+
+Examples
+-----------------------------------------------------
+The following examples show how to use this InSpec audit resource.
+
+**Test which variables may be sent to the server**
+
+.. code-block:: ruby
+
+   describe sshd_config do
+     its('AcceptEnv') { should include('GORDON_SERVER') }
+   end
+
+**Test for IPv6-only addresses**
+
+.. code-block:: ruby
+
+   describe sshd_config do
+     its('AddressFamily') { should eq 'inet6' }
+   end
+
+**Test protocols**
+
+.. code-block:: ruby
+
+   describe sshd_config do
+     its('Protocol') { should eq '2' }
+   end
+
+**Test ciphers**
+
+.. code-block:: ruby
+
+   describe sshd_config do
+     its('Ciphers') { should eq('chacha20-poly1305@openssh.com,aes256-ctr,aes192-ctr,aes128-ctr') }
+   end
+
+**Test SSH protocols**
+
+.. code-block:: ruby
+
+   describe sshd_config do
+     its('Port') { should eq '22' }
+     its('UsePAM') { should eq 'yes' }
+     its('ListenAddress') { should eq nil }
+     its('HostKey') { should eq [
+        '/etc/ssh/ssh_host_rsa_key',
+        '/etc/ssh/ssh_host_dsa_key',
+        '/etc/ssh/ssh_host_ecdsa_key',
+       ] }
+   end
+
+
+user
+=====================================================
+Use the ``user`` |inspec resource| to test user profiles, including the groups to which they belong, the frequency of required password changes, the directory paths to home and shell.
+
+**Stability: Stable**
+
+Syntax
+-----------------------------------------------------
+A ``user`` |inspec resource| block declares a user name, and then one (or more) matchers:
+
+.. code-block:: ruby
+
+   describe user('root') do
+     it { should exist }
+     its('uid') { should eq 1234 }
+     its('gid') { should eq 1234 }
+     its('group') { should eq 'root' }
+     its('groups') { should eq ['root', 'other']}
+     its('home') { should eq '/root' }
+     its('shell') { should eq '/bin/bash' }
+     its('mindays') { should eq 0 }
+     its('maxdays') { should eq 90 }
+     its('warndays') { should eq 8 }
+   end
+
+where
+
+* ``('root')`` is the user to be tested
+* ``it { should exist }`` tests if the user exists
+* ``gid``, ``group``, ``groups``, ``home``, ``maxdays``, ``mindays``, ``shell``, ``uid``, and ``warndays`` are valid matchers for this |inspec resource|
+
+Matchers
+-----------------------------------------------------
+This InSpec audit resource has the following matchers.
+
+exist
++++++++++++++++++++++++++++++++++++++++++++++++++++++
+The ``exist`` matcher tests if the named user exists:
+
+.. code-block:: ruby
+
+   it { should exist }
+
+gid
++++++++++++++++++++++++++++++++++++++++++++++++++++++
+The ``gid`` matcher tests the group identifier:
+
+.. code-block:: ruby
+
+   its('gid') { should eq 1234 } }
+
+where ``1234`` represents the user identifier.
+
+group
++++++++++++++++++++++++++++++++++++++++++++++++++++++
+The ``group`` matcher tests the group to which the user belongs:
+
+.. code-block:: ruby
+
+   its('group') { should eq 'root' }
+
+where ``root`` represents the group.
+
+groups
++++++++++++++++++++++++++++++++++++++++++++++++++++++
+The ``groups`` matcher tests two (or more) groups to which the user belongs:
+
+.. code-block:: ruby
+
+   its('groups') { should eq ['root', 'other']}
+
+home
++++++++++++++++++++++++++++++++++++++++++++++++++++++
+The ``home`` matcher tests the home directory path for the user:
+
+.. code-block:: ruby
+
+   its('home') { should eq '/root' }
+
+maxdays
++++++++++++++++++++++++++++++++++++++++++++++++++++++
+The ``maxdays`` matcher tests the maximum number of days between password changes:
+
+.. code-block:: ruby
+
+   its('maxdays') { should eq 99 }
+
+where ``99`` represents the maximum number of days.
+
+mindays
++++++++++++++++++++++++++++++++++++++++++++++++++++++
+The ``mindays`` matcher tests the minimum number of days between password changes:
+
+.. code-block:: ruby
+
+   its('mindays') { should eq 0 }
+
+where ``0`` represents the maximum number of days.
+
+shell
++++++++++++++++++++++++++++++++++++++++++++++++++++++
+The ``shell`` matcher tests the path to the default shell for the user:
+
+.. code-block:: ruby
+
+   its('shell') { should eq '/bin/bash' }
+
+uid
++++++++++++++++++++++++++++++++++++++++++++++++++++++
+The ``uid`` matcher tests the user identifier:
+
+.. code-block:: ruby
+
+   its('uid') { should eq 1234 } }
+
+where ``1234`` represents the user identifier.
+
+warndays
++++++++++++++++++++++++++++++++++++++++++++++++++++++
+The ``warndays`` matcher tests the number of days a user is warned before a password must be changed:
+
+.. code-block:: ruby
+
+   its('warndays') { should eq 5 }
+
+where ``5`` represents the number of days a user is warned.
+
+Examples
+-----------------------------------------------------
+The following examples show how to use this InSpec audit resource.
+
+**Verify available users for the MySQL server**
+
+.. code-block:: ruby
+
+   describe user('root') do
+     it { should exist }
+     it { should belong_to_group 'root' }
+     its('uid') { should eq 0 }
+     its('groups') { should eq ['root'] }
+   end
+
+   describe user('mysql') do
+    it { should_not exist }
+   end
+
+**Test users on multiple platforms**
+
+The |nginx| user is typically ``www-data``, but on |centos| it's ``nginx``. The following example shows how to test for the |nginx| user with a single test, but accounting for all platforms:
+
+.. code-block:: ruby
+
+   web_user = 'www-data'
+   web_user = 'nginx' if os[:family] == 'centos'
+
+   describe user(web_user) do
+     it { should exist }
+   end
+
+
+windows_feature
+=====================================================
+Use the ``windows_feature`` |inspec resource| to test features on |windows|. The ``Get-WindowsFeature`` cmdlet returns the following values: ``Property Name``, ``DisplayName``, ``Description``, ``Installed``, and ``InstallState``, returned as a |json| object similar to:
+
+**Stability: Experimental**
+
+.. code-block:: javascript
+
+   {
+     "Name": "XPS-Viewer",
+     "DisplayName": "XPS Viewer",
+     "Description": "The XPS Viewer reads, sets permissions, and digitally signs XPS documents.",
+     "Installed": false,
+     "InstallState": 0
+   }
+
+Syntax
+-----------------------------------------------------
+A ``windows_feature`` |inspec resource| block declares the name of the |windows| feature, tests if that feature is installed, and then returns information about that feature:
+
+.. code-block:: ruby
+
+   describe windows_feature('feature_name') do
+     it { should be_installed }
+   end
+
+where
+
+* ``('feature_name')`` must specify a |windows| feature name, such as ``DHCP Server`` or ``IIS-Webserver``
+* ``be_installed`` is a valid matcher for this |inspec resource|
+
+Matchers
+-----------------------------------------------------
+This InSpec audit resource has the following matchers.
+
+be_installed
++++++++++++++++++++++++++++++++++++++++++++++++++++++
+The ``be_installed`` matcher tests if the named |windows| feature is installed:
+
+.. code-block:: ruby
+
+   it { should be_installed }
+
+Examples
+-----------------------------------------------------
+The following examples show how to use this InSpec audit resource.
+
+**Test the DHCP Server feature**
+
+.. code-block:: ruby
+
+   describe windows_feature('DHCP Server') do
+     it{ should be_installed }
+   end
+
+
+yaml
+=====================================================
+Use the ``yaml`` |inspec resource| to test configuration data in a |yaml| file.
+
+**Stability: Experimental**
+
+Syntax
+-----------------------------------------------------
+A ``yaml`` |inspec resource| block declares the configuration data to be tested:
+
+.. code-block:: ruby
+
+   describe yaml do
+     its('name') { should eq 'foo' }
+   end
+
+where
+
+* ``name`` is a configuration setting in a |yaml| file
+* ``should eq 'foo'`` tests a value of ``name`` as read from a |yaml| file versus the value declared in the test
+
+Matchers
+-----------------------------------------------------
+This InSpec audit resource has the following matchers.
+
+name
++++++++++++++++++++++++++++++++++++++++++++++++++++++
+The ``name`` matcher tests the value of ``name`` as read from a |yaml| file versus the value declared in the test:
+
+.. code-block:: ruby
+
+   its('name') { should eq 'foo' }
+
+Examples
+-----------------------------------------------------
+The following examples show how to use this InSpec audit resource.
+
+**Test a kitchen.yml file driver**
+
+.. code-block:: ruby
+
+   describe yaml('.kitchen.yaml') do
+     its('driver.name') { should eq('vagrant') }
+   end
+
+
+yum
+=====================================================
+Use the ``yum`` |inspec resource| to test packages in the |yum| repository.
+
+**Stability: Experimental**
+
+Syntax
+-----------------------------------------------------
+A ``yum`` |inspec resource| block declares a package repo, tests if the package repository is present, and if it that package repository is a valid package source (i.e. "is enabled"):
+
+.. code-block:: ruby
+
+   describe yum.repo('name') do
+     it { should exist }
+     it { should be_enabled }
+   end
+
+where
+
+* ``repo('name')`` is the (optional) name of a package repo, using either a full identifier (``'updates/7/x86_64'``) or a short identifier (``'updates'``)
+
+Matchers
+-----------------------------------------------------
+This InSpec audit resource has the following matchers.
+
+be_enabled
++++++++++++++++++++++++++++++++++++++++++++++++++++++
+The ``be_enabled`` matcher tests if the package repository is a valid package source:
+
+.. code-block:: ruby
+
+   it { should be_enabled }
+
+exist
++++++++++++++++++++++++++++++++++++++++++++++++++++++
+The ``exist`` matcher tests if the package repository exists:
+
+.. code-block:: ruby
+
+   it { should exist }
+
+repo('name')
++++++++++++++++++++++++++++++++++++++++++++++++++++++
+The ``repo('name')`` matcher names a specific package repository:
+
+.. code-block:: ruby
+
+   describe yum.repo('epel') do
+     ...
+   end
+
+repos
++++++++++++++++++++++++++++++++++++++++++++++++++++++
+The ``repos`` matcher tests if a named repo, using either a full identifier (``'updates/7/x86_64'``) or a short identifier (``'updates'``), is included in the |yum| repo:
+
+.. code-block:: ruby
+
+   its('repos') { should include 'some_repo' }
+
+Examples
+-----------------------------------------------------
+The following examples show how to use this InSpec audit resource.
+
+**Test if the yum repo exists**
+
+.. code-block:: ruby
+
+   describe yum do
+     its('repos') { should exist }
+   end
+
+**Test if the 'base/7/x86_64' repo exists and is enabled**
+
+.. code-block:: ruby
+
+   describe yum do
+     its('repos') { should include 'base/7/x86_64' }
+     its('epel') { should exist }
+     its('epel') { should be_enabled }
+   end
+
+**Test if a specific yum repo exists**
+
+.. code-block:: ruby
+
+   describe yum.repo('epel') do
+     it { should exist }
+     it { should be_enabled }
+   end
+
+
+
+
+.. |inspec resource| replace:: InSpec audit resource
+.. |apt| replace:: Apt
+.. |apache| replace:: Apache
+.. |archlinux| replace:: Arch Linux
+.. |debian| replace:: Debian
+.. |fedora| replace:: Fedora
+.. |redhat enterprise linux| replace:: Red Hat Enterprise Linux
+.. |centos| replace:: CentOS
+.. |redhat| replace:: Red Hat
+.. |ubuntu| replace:: Ubuntu
+.. |windows| replace:: Microsoft Windows
+.. |unix| replace:: UNIX
+.. |linux| replace:: Linux
+.. |ppa| replace:: PPA
+.. |json| replace:: JSON
+.. |csv| replace:: CSV
+.. |postgresql| replace:: PostgreSQL
+.. |md5| replace:: MD5
+.. |sha256| replace:: SHA-256
+.. |selinux| replace:: SELinux
+.. |gem| replace:: gem
+.. |icmp| replace:: ICMP
+.. |tcp| replace:: TCP
+.. |udp| replace:: UDP
+.. |inetd| replace:: inetd
+.. |mysql| replace:: MySQL
+.. |npm| replace:: npm
+.. |bower| replace:: bower
+.. |statsd| replace:: StatsD
+.. |oneget| replace:: OneGet
+.. |ruby| replace:: Ruby
+.. |pip| replace:: pip
+.. |ipv4| replace:: Internet Protocol version 4 (IPv4)
+.. |ipv6| replace:: Internet Protocol version 6 (IPv6)
+.. |powershell| replace:: Windows PowerShell
+.. |openssh| replace:: Open SSH
+.. |ssh| replace:: SSH
+.. |nginx| replace:: Nginx
+.. |yaml| replace:: YAML
+.. |yum| replace:: Yum