inspec-core 2.1.67

data/docs/resources/cpan.md.erb

@@ -0,0 +1,79 @@
+---
+title: About the cpan Resource
+platform: linux
+---
+
+# cpan
+
+Use the `cpan` InSpec audit resource to test Perl modules that are installed by system packages or the CPAN installer.
+
+<br>
+
+## Syntax
+
+A `cpan` resource block declares a package and (optionally) a package version:
+
+    describe cpan('package_name') do
+      it { should be_installed }
+    end
+
+where
+
+* `'package_name'` is the name of the package, such as `'DBD::Pg'`
+* `be_installed` tests to see if the package described above is installed
+
+<br>
+
+## Resource Parameters
+
+This resource uses package names and perl library paths as resource parameters.
+
+<br>
+
+## Resource Parameter Examples
+
+### Test if DBD::Pg is installed on the system
+
+    describe cpan('DBD:Pg') do
+      it { should be_installed }
+    end
+
+### Test if DBD::Pg 3.7.0 is installed on the system
+
+    describe cpan('DBD::Pg') do
+      it { should be_installed }
+      its('version') { should eq '3.7.0' }
+    end
+
+### Test if DBD::Pg is installed within a custom PERL5LIB path on the system
+
+Hint: You can pass multiple paths separated with a colon
+`/path/to/perl5/lib:/usr/share/perl5/vendor_perl/lib/perl5`
+
+    describe cpan('DBD::Pg', '/home/jdoe/perl5/lib/perl5') do
+      it { should be_installed }
+    end
+
+<br>
+
+## Property Examples
+
+The following examples show how to use this InSpec audit resource.
+
+### version
+
+The `version` property tests if the named package version is on the system:
+
+    its('version') { should eq '1.2.3' }
+
+<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 package is installed on the system:
+
+    it { should be_installed }

data/docs/resources/cran.md.erb

@@ -0,0 +1,64 @@
+---
+title: About the cran Resource
+platform: linux
+---
+
+# cran
+
+Use the `cran` InSpec audit resource to test R modules that are installed from CRAN package repository.
+
+<br>
+
+## Syntax
+
+A `cran` resource block declares a package and (optionally) a package version:
+
+    describe cran('package_name') do
+      it { should be_installed }
+    end
+
+where
+
+* `'package_name'` is the name of the package, such as `'DBI'`
+* `be_installed` tests to see if the package described above is installed
+
+<br>
+
+## Examples
+
+The following examples show how to use this InSpec audit resource.
+
+### Test if DBI is installed on the system
+
+    describe cran('DBI') do
+      it { should be_installed }
+    end
+
+### Test if DBI 0.5.1 is installed on the system
+
+    describe cran('DBI') do
+      it { should be_installed }
+      its('version') { should eq '0.5.1' }
+    end
+
+<br>
+
+## Property Examples
+
+### version
+
+The `version` property tests if the named package version is on the system:
+
+    its('version') { should eq '1.2.3' }
+
+<br>
+
+## 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:
+
+    it { should be_installed }

data/docs/resources/crontab.md.erb

@@ -0,0 +1,89 @@
+---
+title: About the crontab Resource
+platform: linux
+---
+
+# crontab
+
+Use the `crontab` InSpec audit resource to test the crontab entries for a particular user on the system. It recognizes special time strings (@yearly, @weekly, etc).
+
+<br>
+
+## Syntax
+
+A `crontab` resource block declares a user (which defaults to the current user, if not specified), and then the details to be tested, such as the schedule elements for each crontab entry or the commands itself:
+
+    describe crontab do
+      its('commands') { should include '/some/scheduled/task.sh' }
+    end
+
+<br>
+
+## Examples
+
+The following examples show how to use this InSpec audit resource.
+
+### Test that root's crontab has a particular command
+
+    describe crontab('root') do
+      its('commands') { should include '/path/to/some/script' }
+    end
+
+### Test that myuser's crontab entry for command '/home/myuser/build.sh' runs every minute
+
+    describe crontab('myuser').commands('/home/myuser/build.sh') do
+      its('hours') { should cmp '*' }
+      its('minutes') { should cmp '*' }
+    end
+
+### Test that the logged-in user's crontab has no tasks set to run on every hour and every minute
+
+    describe crontab.where({'hour' => '*', 'minute' => '*'}) do
+      its('entries.length') { should cmp '0' }
+    end
+
+### Test that the logged-in user's crontab contains a single command that matches a pattern
+
+    describe crontab.where { command =~ /a partial command string/ } do
+      its('entries.length') { should cmp 1 }
+    end
+
+### Test a special time string (i.e., @yearly /root/annual_report.sh)
+
+    describe crontab.commands('/root/annual_report.sh') do
+      its('hours') { should cmp '0' }
+      its('minutes') { should cmp '0' }
+      its('days') { should cmp '1' }
+      its('months') { should cmp '1' }
+    end
+
+### Test @reboot case
+
+    describe crontab.commands('/root/reboot.sh') do
+      its('hours') { should cmp '-1' }
+      its('minutes') { should cmp '-1' }
+    end
+
+<br>
+
+## Property Examples
+
+
+### Test a special time string
+
+    describe crontab do
+      its('minutes') { should cmp '0' }
+      its('hours') { should cmp '0' }
+      its('days') { should cmp '1' }
+      its('weekdays') { should cmp '1' }
+      its('user') { should include 'username'}
+      its('commands') { should include '/some/scheduled/task.sh' }
+    end
+
+InSpec will automatically interpret crontab-supported special time strings. For example, a crontab entry set to run `@yearly` can be tested as if the entry was manually configured to run on January 1, 12 AM.
+
+<br>
+
+## Matchers
+
+For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/).

data/docs/resources/csv.md.erb

@@ -0,0 +1,54 @@
+---
+title: About the csv Resource
+platform: os
+---
+
+# csv
+
+Use the `csv` InSpec audit resource to test configuration data in a CSV file.
+
+<br>
+
+## Syntax
+
+A `csv` resource block declares the configuration data to be tested:
+
+    describe csv('file') do
+      its('name') { should cmp '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
+
+<br>
+
+## Examples
+
+The following examples show how to use this InSpec audit resource.
+
+### Test a CSV file
+
+    describe csv('some_file.csv') do
+      its('setting') { should eq 1 }
+    end
+
+<br>
+
+## Property Examples
+
+### name
+
+The `name` property tests the value of `name` as read from a CSV file compared to the value declared in the test.
+
+    its('name') { should cmp 'foo' }
+
+<br>
+
+## Matchers
+
+For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/).
+
+

data/docs/resources/dh_params.md.erb

@@ -0,0 +1,205 @@
+---
+title: The dh_params Resource
+platform: linux
+---
+
+# dh_params
+
+Use the `dh_params` InSpec audit resource to test Diffie-Hellman (DH) parameters.
+
+<br>
+
+## Syntax
+
+A `dh_params` resource block declares a parameter file to be tested.
+
+    describe dh_params('/path/to/file.dh_pem') do
+      it { should be_dh_params }
+      it { should be_valid }
+      its('generator') { should eq 2 }
+      its('modulus') { should eq '00:91:a0:15:89:e5:bc:38:93:12:02:fc:...' }
+      its('prime_length') { should eq 2048 }
+      its('pem') { should eq '-----BEGIN DH PARAMETERS...' }
+      its('text') { should eq 'PKCS#3 DH Parameters: (2048 bit)...' }
+    end
+
+<br>
+
+## Properties
+
+* `generator`, `modulus`, `prime_length`, `pem`, `text`
+
+<br>
+
+## Property Examples
+
+### generator (Integer)
+
+Verify generator used for the Diffie-Hellman operation:
+
+    describe dh_params('/path/to/file.dh_pem') do
+      its('generator') { should eq 2 }
+    end
+
+### modulus (String)
+
+Verify prime modulus used for the Diffie-Hellman operation:
+
+    describe dh_params('/path/to/file.dh_pem') do
+      its('modulus') { should eq '00:91:a0:15:89:e5:bc:38:93:12:02:fc:...' }
+    end
+
+Example using multi-line string:
+
+    describe dh_params('/path/to/file.dh_pem') do
+      its('modulus') do
+        # regex removes all whitespace
+        should eq <<-EOF.gsub(/[[:space:]]+/, '')
+          00:91:a0:15:89:e5:bc:38:93:12:02:fc:91:a2:85:
+          f7:f7:29:63:2e:d3:4e:7a:86:f7:ee:84:fe:42:d0:
+          48:bc:9c:91:d5:54:f8:78:1d:c0:41:78:a2:c4:ac:
+          1a:24:8b:9d:88:55:98:0b:ac:a7:23:eb:c2:aa:2b:
+          2e:a9:f9:af:d4:8e:4e:11:bc:7f:35:a2:ac:da:3a:
+          ef:f0:25:6c:9a:a4:fd:00:28:76:86:2c:57:87:67:
+          30:5d:b1:d6:5b:22:8f:72:a1:ea:de:8b:ef:9e:33:
+          1a:40:92:68:85:02:54:02:09:fa:c0:60:c1:3c:4e:
+          28:26:db:ed:25:8e:38:21:56:40:dc:c0:c0:66:1f:
+          2b:32:c3:b4:78:a9:26:94:ea:f7:41:28:b2:f5:5b:
+          01:38:0c:46:09:85:26:4d:69:12:8d:95:0f:35:e2:
+          e6:4e:47:3a:86:dd:8a:b2:fe:45:15:27:d8:59:c2:
+          3c:f4:62:ff:5f:74:e9:77:92:50:47:36:2b:05:57:
+          60:ee:7b:a1:60:cc:1c:7a:2b:77:18:8a:37:f7:c7:
+          31:3e:15:cb:15:7f:7b:66:96:fb:c6:be:7d:d6:03:
+          5e:0d:60:75:2b:5b:62:2a:a3:37:b6:34:f9:fe:96:
+          4c:f6:c5:e3:a1:52:af:01:c1:4f:c7:42:a0:be:ed:
+          cd:13
+        EOF
+      end
+    end
+
+### prime_length (Integer)
+
+Verify length of prime modulus used for the Diffie-Hellman operation:
+
+    describe dh_params('/path/to/file.dh_pem') do
+      its('prime_length') { should eq 2048 }
+    end
+
+### pem (String)
+
+Verify `pem` output of DH parameters:
+
+    describe dh_params('/path/to/file.dh_pem') do
+      its('pem') { should eq '-----BEGIN DH PARAMETERS...' }
+    end
+
+Example using multi-line string:
+
+    its('pem') do
+      # regex removes all leading spaces
+      should eq <<-EOF.gsub(/^[[:blank:]]+/, '')
+        -----BEGIN DH PARAMETERS-----
+        MIIBCAKCAQEAkaAVieW8OJMSAvyRooX39yljLtNOeob37oT+QtBIvJyR1VT4eB3A
+        QXiixKwaJIudiFWYC6ynI+vCqisuqfmv1I5OEbx/NaKs2jrv8CVsmqT9ACh2hixX
+        h2cwXbHWWyKPcqHq3ovvnjMaQJJohQJUAgn6wGDBPE4oJtvtJY44IVZA3MDAZh8r
+        MsO0eKkmlOr3QSiy9VsBOAxGCYUmTWkSjZUPNeLmTkc6ht2Ksv5FFSfYWcI89GL/
+        X3Tpd5JQRzYrBVdg7nuhYMwceit3GIo398cxPhXLFX97Zpb7xr591gNeDWB1K1ti
+        KqM3tjT5/pZM9sXjoVKvAcFPx0Kgvu3NEwIBAg==
+        -----END DH PARAMETERS-----
+      EOF
+    end
+
+Verify via `openssl dhparam` command:
+
+    $ openssl dhparam -in /path/to/file.dh_pem
+    -----BEGIN DH PARAMETERS-----
+    MIIBCAKCAQEAkaAVieW8OJMSAvyRooX39yljLtNOeob37oT+QtBIvJyR1VT4eB3A
+    QXiixKwaJIudiFWYC6ynI+vCqisuqfmv1I5OEbx/NaKs2jrv8CVsmqT9ACh2hixX
+    h2cwXbHWWyKPcqHq3ovvnjMaQJJohQJUAgn6wGDBPE4oJtvtJY44IVZA3MDAZh8r
+    MsO0eKkmlOr3QSiy9VsBOAxGCYUmTWkSjZUPNeLmTkc6ht2Ksv5FFSfYWcI89GL/
+    X3Tpd5JQRzYrBVdg7nuhYMwceit3GIo398cxPhXLFX97Zpb7xr591gNeDWB1K1ti
+    KqM3tjT5/pZM9sXjoVKvAcFPx0Kgvu3NEwIBAg==
+    -----END DH PARAMETERS-----
+
+### text (String)
+
+Verify human-readable text output of DH parameters:
+
+    describe dh_params('/path/to/file.dh_pem') do
+      its('text') { should eq 'PKCS#3 DH Parameters: (2048 bit)...' }
+    end
+
+Example using multi-line string:
+
+    its('text') do
+      # regex removes 2 leading spaces
+      should eq <<-EOF.gsub(/^[[:blank:]]{2}/, '')
+        PKCS#3 DH Parameters: (2048 bit)
+            prime:
+                00:91:a0:15:89:e5:bc:38:93:12:02:fc:91:a2:85:
+                f7:f7:29:63:2e:d3:4e:7a:86:f7:ee:84:fe:42:d0:
+                48:bc:9c:91:d5:54:f8:78:1d:c0:41:78:a2:c4:ac:
+                1a:24:8b:9d:88:55:98:0b:ac:a7:23:eb:c2:aa:2b:
+                2e:a9:f9:af:d4:8e:4e:11:bc:7f:35:a2:ac:da:3a:
+                ef:f0:25:6c:9a:a4:fd:00:28:76:86:2c:57:87:67:
+                30:5d:b1:d6:5b:22:8f:72:a1:ea:de:8b:ef:9e:33:
+                1a:40:92:68:85:02:54:02:09:fa:c0:60:c1:3c:4e:
+                28:26:db:ed:25:8e:38:21:56:40:dc:c0:c0:66:1f:
+                2b:32:c3:b4:78:a9:26:94:ea:f7:41:28:b2:f5:5b:
+                01:38:0c:46:09:85:26:4d:69:12:8d:95:0f:35:e2:
+                e6:4e:47:3a:86:dd:8a:b2:fe:45:15:27:d8:59:c2:
+                3c:f4:62:ff:5f:74:e9:77:92:50:47:36:2b:05:57:
+                60:ee:7b:a1:60:cc:1c:7a:2b:77:18:8a:37:f7:c7:
+                31:3e:15:cb:15:7f:7b:66:96:fb:c6:be:7d:d6:03:
+                5e:0d:60:75:2b:5b:62:2a:a3:37:b6:34:f9:fe:96:
+                4c:f6:c5:e3:a1:52:af:01:c1:4f:c7:42:a0:be:ed:
+                cd:13
+            generator: 2 (0x2)
+        EOF
+    end
+
+Verify via `openssl dhparam` command:
+
+    $ openssl dhparam -in /path/to/file.dh_pem -noout -text
+    PKCS#3 DH Parameters: (2048 bit)
+        prime:
+            00:91:a0:15:89:e5:bc:38:93:12:02:fc:91:a2:85:
+            f7:f7:29:63:2e:d3:4e:7a:86:f7:ee:84:fe:42:d0:
+            48:bc:9c:91:d5:54:f8:78:1d:c0:41:78:a2:c4:ac:
+            1a:24:8b:9d:88:55:98:0b:ac:a7:23:eb:c2:aa:2b:
+            2e:a9:f9:af:d4:8e:4e:11:bc:7f:35:a2:ac:da:3a:
+            ef:f0:25:6c:9a:a4:fd:00:28:76:86:2c:57:87:67:
+            30:5d:b1:d6:5b:22:8f:72:a1:ea:de:8b:ef:9e:33:
+            1a:40:92:68:85:02:54:02:09:fa:c0:60:c1:3c:4e:
+            28:26:db:ed:25:8e:38:21:56:40:dc:c0:c0:66:1f:
+            2b:32:c3:b4:78:a9:26:94:ea:f7:41:28:b2:f5:5b:
+            01:38:0c:46:09:85:26:4d:69:12:8d:95:0f:35:e2:
+            e6:4e:47:3a:86:dd:8a:b2:fe:45:15:27:d8:59:c2:
+            3c:f4:62:ff:5f:74:e9:77:92:50:47:36:2b:05:57:
+            60:ee:7b:a1:60:cc:1c:7a:2b:77:18:8a:37:f7:c7:
+            31:3e:15:cb:15:7f:7b:66:96:fb:c6:be:7d:d6:03:
+            5e:0d:60:75:2b:5b:62:2a:a3:37:b6:34:f9:fe:96:
+            4c:f6:c5:e3:a1:52:af:01:c1:4f:c7:42:a0:be:ed:
+            cd:13
+        generator: 2 (0x2)
+
+<br>
+
+## Matchers
+
+For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/).
+
+### valid?
+
+Verify whether DH parameters are valid:
+
+    describe dh_params('/path/to/file.dh_pem') do
+      it { should be_valid }
+    end
+
+### be\_dh\_params
+
+    describe dh_params('/path/to/file.dh_pem') do
+        it { should be_dh_params}
+    end
+