inspec-core 2.1.67

data/docs/resources/users.md.erb

@@ -0,0 +1,127 @@
+---
+title: About the users Resource
+platform: os
+---
+
+# users
+
+Use the `users` InSpec audit resource to look up all local users available on the system, and then test specific properties of those users. This resource does not return information about users that may be located on other systems, such as LDAP or Active Directory.
+
+<br>
+
+## Syntax
+
+A `users` resource block declares a user name, and then one (or more) matchers:
+
+    describe users.where(uid: 0).entries do
+      it { should eq ['root'] }
+      its('uids') { should eq [1234] }
+      its('gids') { should eq [1234] }
+    end
+
+where
+
+* `gid`, `group`, `groups`, `home`, `maxdays`, `mindays`, `shell`, `uid`, and `warndays` are valid matchers for this resource
+* `where(uid: 0).entries` represents a filter that runs the test only against matching users
+
+For example:
+
+    describe users.where { username =~ /.*/ } do
+      it { should exist }
+    end
+
+or:
+
+    describe users.where { uid =~ /^S-1-5-[0-9-]+-501$/ } do
+      it { should exist }
+    end
+
+<br>
+
+## Examples
+
+The following examples show how to use this InSpec audit resource.
+
+### Use a regular expression to find users
+
+    describe users.where { uid =~ /S\-1\-5\-21\-\d+\-\d+\-\d+\-500/ } do
+      it { should exist }
+    end
+
+<br>
+
+## Matchers
+
+For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/).
+
+### exist
+
+The `exist` matcher tests if the named user exists:
+
+    it { should exist }
+
+### gid
+
+The `gid` matcher tests the group identifier:
+
+    its('gid') { should eq 1234 } }
+
+where `1234` represents the user identifier.
+
+### group
+
+The `group` matcher tests the group to which the user belongs:
+
+    its('group') { should eq 'root' }
+
+where `root` represents the group.
+
+### groups
+
+The `groups` matcher tests two (or more) groups to which the user belongs:
+
+    its('groups') { should eq ['root', 'other']}
+
+### home
+
+The `home` matcher tests the home directory path for the user:
+
+    its('home') { should eq '/root' }
+
+### maxdays
+
+The `maxdays` matcher tests the maximum number of days between password changes:
+
+    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:
+
+    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:
+
+    its('shells') { should eq ['/bin/bash'] }
+
+### uid
+
+The `uid` matcher tests the user identifier:
+
+    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:
+
+    its('warndays') { should eq 5 }
+
+where `5` represents the number of days a user is warned.

data/docs/resources/vbscript.md.erb

@@ -0,0 +1,55 @@
+---
+title: About the vbscript Resource
+platform: windows
+---
+
+# vbscript
+
+Use the `vbscript` InSpec audit resource to test a VBScript on the Windows platform.
+
+<br>
+
+## Syntax
+
+A `vbscript` resource block tests the output of a VBScript on the Windows platform:
+
+    describe vbscript('script contents') do
+      its('stdout') { should eq 'output' }
+    end
+
+where
+
+* `'script_name'` is the name of the VBScript to test
+* `('output')` is the expected output of the VBScript
+
+<br>
+
+## Examples
+
+The following examples show how to use this InSpec audit resource.
+
+### Test a VBScript
+
+A VBScript file similar to:
+
+    script = <<-EOH
+      WScript.Echo "hello"
+    EOH
+
+may be tested for multiple lines:
+
+    describe vbscript(script) do
+      its('stdout') { should eq "hello\r\n" }
+    end
+
+and tested for whitespace removal from standard output:
+
+    describe vbscript(script) do
+      its('strip') { should eq "hello" }
+    end
+
+<br>
+
+## Matchers
+
+For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/).

data/docs/resources/virtualization.md.erb

@@ -0,0 +1,57 @@
+---
+title: About the virtualization Resource
+platform: linux
+---
+
+# virtualization
+
+Use the `virtualization` InSpec audit resource to test the virtualization platform on which the system is running.
+
+<br>
+
+## Syntax
+
+An `virtualization` resource block declares the virtualization platform that should be tested:
+
+    describe virtualization do
+      its('system') { should MATCHER 'value' }
+    end
+
+where
+
+* `('system')` is the name of the system information of the virtualization platform (e.g. docker, lxc, vbox, kvm, etc)
+* `MATCHER` is a valid matcher for this resource
+* `'value'` is the value to be tested
+
+<br>
+
+## Examples
+
+The following examples show how to use this InSpec audit resource.
+
+### Test for Docker
+
+    describe virtualization do
+      its('system') { should eq 'docker' }
+    end
+
+### Test for VirtualBox
+
+    describe virtualization do
+      its('system') { should eq 'vbox' }
+      its('role') { should eq 'guest' }
+    end
+
+### Detect the virtualization platform
+
+    if virtualization.system == 'vbox'
+      describe package('name') do
+        it { should be_installed }
+      end
+    end
+
+<br>
+
+## Matchers
+
+For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/).

data/docs/resources/windows_feature.md.erb

@@ -0,0 +1,47 @@
+---
+title: About the windows_feature Resource
+platform: windows
+---
+
+# windows_feature
+
+Use the `windows_feature` InSpec audit resource to test features on Windows via the `Get-WindowsFeature` cmdlet.
+
+<br>
+
+## Syntax
+
+A `windows_feature` resource block declares the name of the Windows feature, tests if that feature is installed, and then returns information about that feature:
+
+    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 resource
+
+<br>
+
+## Examples
+
+The following examples show how to use this InSpec audit resource.
+
+### Test the DHCP Server feature
+
+    describe windows_feature('DHCP Server') do
+      it{ should be_installed }
+    end
+
+<br>
+
+## Matchers
+
+For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/).
+
+### be_installed
+
+The `be_installed` matcher tests if the named Windows feature is installed:
+
+    it { should be_installed }

data/docs/resources/windows_hotfix.md.erb

@@ -0,0 +1,53 @@
+---
+title: About the windows_hotfix Resource
+platform: windows
+---
+
+# windows_hotfix
+
+Use the `windows_hotfix` InSpec audit resource to test if the hotfix has been installed on a Windows system.
+
+<br>
+
+## Syntax
+
+A `windows_hotfix` resource block declares a hotfix to validate:
+
+    describe windows_hotfix('name') do
+      it { should be_installed }
+    end
+
+where
+
+* `('name')` must specify the name of a hotfix, such as `'KB4012213'`
+* `be_installed` is a valid matcher for this resource
+
+<br>
+
+## Examples
+
+The following examples show how to use this InSpec audit resource.
+
+### Test if KB4012213 is installed
+
+    describe windows_hotfix('KB4012213') do
+      it { should be_installed }
+    end
+
+### Test that a hotfix is not installed
+
+    describe windows_hotfix('KB9999999') do
+      it { should_not be_installed }
+    end
+
+<br>
+
+## Matchers
+
+For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/).
+
+### be_installed
+
+The `be_installed` matcher tests if the named hotfix is installed on the system:
+
+    it { should be_installed }

data/docs/resources/windows_task.md.erb

@@ -0,0 +1,95 @@
+---
+title: About the windows_task Resource
+platform: windows
+---
+
+# windows_task
+
+Use the `windows_task` InSpec audit resource to test a scheduled tasks configuration on a Windows platform.
+Microsoft and application vendors use scheduled tasks to perform a variety of system maintenance tasks but system administrators can schedule their own.
+
+<br>
+
+## Syntax
+
+A `windows_task` resource block declares the name of the task (as its full path) and tests its configuration:
+
+    describe windows_task('task name uri') do
+      its('parameter') { should eq 'value' }
+      it { should be_enabled }
+    end
+
+where
+
+* `'parameter'` must be a valid parameter defined within this resource  ie `logon_mode`, `last_result`, `task_to_run`, `run_as_user`
+* `'value'` will be used to compare the value gather from your chosen parameter
+* `'be_enabled'` is an example of a valid matcher that checks the state of a task, other examples are `exist` or `be_disabled`
+
+<br>
+
+## Examples
+
+The following examples show how to use this InSpec resource.
+
+### Tests that a task is enabled
+
+    ```ruby
+    describe windows_task('\Microsoft\Windows\Time Synchronization\SynchronizeTime') do
+      it { should be_enabled }
+    end
+    ```
+
+### Tests that a task is disabled
+
+    ```ruby
+    describe windows_task('\Microsoft\Windows\AppID\PolicyConverter') do
+      it { should be_disabled }
+    end
+    ```
+
+### Tests the configuration parameters of a task
+
+    ```ruby
+    describe windows_task('\Microsoft\Windows\AppID\PolicyConverter') do
+      its('logon_mode') { should eq 'Interactive/Background' }
+      its('last_result') { should eq '1' }
+      its('task_to_run') { should cmp '%Windir%\system32\appidpolicyconverter.exe' }
+      its('run_as_user') { should eq 'LOCAL SERVICE' }
+    end
+    ```
+
+### Tests that a task is defined
+
+    ```ruby
+    describe windows_task('\Microsoft\Windows\Defrag\ScheduledDefrag') do
+      it { should exist }
+    end
+    ```
+
+## Gathering Tasknames
+
+Rather then use the GUI you can use the `schtasks.exe` to output a full list of tasks available on the system
+
+`schtasks /query /FO list`
+
+rather than use the `list` output you can use `CSV` if it is easier.
+
+Please make sure you use the full TaskName (include the prefix `\`) within your control
+
+    ```ruby
+    C:\>schtasks /query /FO list
+    ...
+    Folder: \Microsoft\Windows\Diagnosis
+    HostName:      XPS15
+    TaskName:      \Microsoft\Windows\Diagnosis\Scheduled
+    Next Run Time: N/A
+    Status:        Ready
+    Logon Mode:    Interactive/Background
+    ...
+    ```
+
+<br>
+
+## Matchers
+
+For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/).

data/docs/resources/wmi.md.erb

@@ -0,0 +1,81 @@
+---
+title: About the wmi Resource
+platform: windows
+---
+
+# wmi
+
+Use the `wmi` InSpec audit resource to test WMI settings on the Windows platform.
+
+<br>
+
+## Syntax
+
+A `wmi` resource block tests WMI settings on the Windows platform:
+
+    describe wmi({
+      class: 'class_name'
+      namespace: 'path\\to\\setting'
+      filter: 'filter'
+      query: 'query'
+    }) do
+      its('setting_name') { should eq '' }
+    end
+
+where
+
+* `class`, `namespace`, `filter`, and `query` comprise a Ruby Hash of the WMI object
+* `('class')` is the WMI class to which the setting belongs, such as `win32_service`
+* `('namespace')` is path to that object, such as `root\\cimv2`
+* Use `('filter')` fine-tune the information defined by the WMI class, such as to find a specific service (`filter: "name like '%winrm%'")`, to find a specific setting (`filter: 'KeyName = \'MinimumPasswordAge\' And precedence=1'`), and so on
+* Use `('query')` to run a query that returns data to be tested, such as `"SELECT Setting FROM RSOP_SecuritySettingBoolean WHERE KeyName='LSAAnonymousNameLookup' AND Precedence=1"`
+* `('setting_name')` is a setting in the WMI object to be tested, and then `should eq ''` is the expected value for that setting
+
+For example, both of the following tests will verify if WinRM is present on the target node. The first tests if WinRM belongs to the list of services running under the `win32_service` class:
+
+    describe wmi({class: 'win32_service'}) do
+      its('DisplayName') { should include 'Windows Remote Management (WS-Management)'}
+    end
+
+and the second uses a filter in the Ruby Hash to first identify WinRM, and then perform additional tests:
+
+    describe wmi({
+      class: 'win32_service',
+      filter: "name like '%winrm%'"
+    }) do
+      its('Status') { should cmp 'ok' }
+      its('State') { should cmp 'Running' }
+      its('ExitCode') { should cmp 0 }
+      its('DisplayName') { should eq 'Windows Remote Management (WS-Management)'}
+    end
+
+<br>
+
+## Examples
+
+The following examples show how to use this InSpec audit resource.
+
+### Test a password expiration policy
+
+    describe wmi({
+      class: 'RSOP_SecuritySettingNumeric',
+      namespace: 'root\\rsop\\computer',
+      filter: 'KeyName = \'MinimumPasswordAge\' And precedence=1'
+    }) do
+       its('Setting') { should eq 1 }
+    end
+
+### Test if an anonymous user can query the Local Security Authority (LSA)
+
+    describe wmi({
+      namespace: 'root\rsop\computer',
+      query: "SELECT Setting FROM RSOP_SecuritySettingBoolean WHERE KeyName='LSAAnonymousNameLookup' AND Precedence=1"
+    }) do
+      its('Setting') { should eq false }
+    end
+
+<br>
+
+## Matchers
+
+For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/).