inspec 1.31.0 → 1.45.9

data/docs/resources/file.md.erb

@@ -6,6 +6,8 @@ title: About the file Resource
 
 Use the `file` InSpec audit resource to test all system file types, including files, directories, symbolic links, named pipes, sockets, character devices, block devices, and doors.
 
+<br>
+
 ## Syntax
 
 A `file` 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:
@@ -20,14 +22,183 @@ where
 * `MATCHER` is a valid matcher for this resource
 * `'value'` is the value to be tested
 
+<br>
 
-## Matchers
+## Examples
+
+The following examples show how to use this InSpec audit resource.
+
+### Test the contents of a file for MD5 requirements
+
+    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
+
+    describe file('/tmp') do
+     it { should exist }
+    end
+
+### Test that a file does not exist
+
+    describe file('/tmpest') do
+     it { should_not exist }
+    end
+
+### Test if a path is a directory
+
+    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
+
+    describe file('/proc/version') do
+      its('type') { should cmp 'file' }
+      it { should be_file }
+      it { should_not be_directory }
+    end
+
+### Test if a file is a symbolic link
+
+    describe file('/dev/stdout') do
+      its('type') { should cmp 'symlink' }
+      it { should be_symlink }
+      it { should_not be_file }
+      it { should_not be_directory }
+    end
+
+### Test if a file is a character device
+
+    describe file('/dev/zero') do
+      its('type') { should cmp '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
+
+    describe file('/dev/zero') do
+      its('type') { should cmp 'block' }
+      it { should be_character_device }
+      it { should_not be_file }
+      it { should_not be_directory }
+    end
+
+### Test the mode for a file
+
+    describe file('/dev') do
+     its('mode') { should cmp '00755' }
+    end
+
+### Test the owner of a file
+
+    describe file('/root') do
+      its('owner') { should eq 'root' }
+    end
+
+### Test if a file is owned by the root user
+
+    describe file('/dev') do
+      it { should be_owned_by 'root' }
+    end
+
+### Test the mtime for a file
+
+    describe file('/') do
+      its('mtime') { should <= Time.now.to_i }
+      its('mtime') { should >= Time.now.to_i - 1000 }
+    end
+
+### Test that a file's size is between 64 and 10240
+
+    describe file('/') do
+      its('size') { should be > 64 }
+      its('size') { should be < 10240 }
+    end
+
+### Test that a file's size is zero
+
+    describe file('/proc/cpuinfo') do
+      its('size') { should be 0 }
+    end
+
+### Test that a file is not mounted
+
+    describe file('/proc/cpuinfo') do
+      it { should_not be_mounted }
+    end
+
+### Test an MD5 checksum
+
+    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
+
+    require 'digest'
+    cpuinfo = file('/proc/cpuinfo').content
+
+    sha256sum = Digest::SHA256.hexdigest(cpuinfo)
+
+    describe file('/proc/cpuinfo') do
+      its('sha256sum') { should eq sha256sum }
+    end
+
+### Verify NTP
+
+The following example shows how to use the `file` audit resource to verify if the `ntp.conf` and `leap-seconds` files are present, and then the `command` resource to verify if NTP is installed and running:
+
+    describe file('/etc/ntp.conf') do
+       it { should be_file }
+    end
 
-This InSpec audit resource has the following matchers:
+    describe file('/etc/ntp.leapseconds') do
+      it { should be_file }
+    end
+
+    describe command('pgrep ntp') do
+       its('exit_status') { should eq 0 }
+    end
+
+### Test parameters of symlinked file
 
-### be
+If you need to test the parameters of the target file for a symlink, you can use the `link_path` method for the `file` resource.
 
-<%= partial "/shared/matcher_be" %>
+For example, for the following symlink:
+
+    lrwxrwxrwx. 1 root root 11 03-10 17:56 /dev/virtio-ports/com.redhat.rhevm.vdsm -> ../vport2p1
+
+... you can write controls for both the link and the target.
+
+    describe file('/dev/virtio-ports/com.redhat.rhevm.vdsm') do
+      it { should be_symlink }
+    end
+
+    virito_port_vdsm = file('/dev/virtio-ports/com.redhat.rhevm.vdsm').link_path
+    describe file(virito_port_vdsm) do
+      it { should exist }
+      it { should be_character_device }
+      it { should be_owned_by 'ovirtagent' }
+      it { should be_grouped_into 'ovirtagent' }
+    end
+
+<br>
+
+## Matchers
+
+This InSpec audit resource has the following matchers. For a full list of available matchers please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/).
 
 ### be\_block\_device
 
@@ -61,6 +232,10 @@ an owner:
 
     it { should be_executable.by('owner') }
 
+any user other than the owner or members of the file's group:
+
+    it { should be_executable.by('others') }
+
 a user:
 
     it { should be_executable.by_user('user') }
@@ -121,16 +296,38 @@ an owner:
 
     it { should be_readable.by('owner') }
 
+any user other than the owner or members of the file's group:
+
+    it { should be_readable.by('others') }
+
 a user:
 
     it { should be_readable.by_user('user') }
 
+### be_setgid
+
+The `be_setgid` matcher tests if the 'setgid' permission is set on the file or directory.  On executable files, this causes the process to be started owned by the group that owns the file, rather than the primary group of the invocating user.  This can result in escalation of privilege.  On Linux, when setgid is set on directories, setgid causes newly created files and directories to be owned by the group that owns the setgid parent directory; additionally, newly created subdirectories will have the setgid bit set.  To use this matcher:
+
+    it { should be_setgid }
+
 ### be_socket
 
 The `be_socket` matcher tests if the file exists as socket (`.sock`), such as `/var/run/php-fpm.sock`:
 
     it { should be_socket }
 
+### be_sticky
+
+The `be_sticky` matcher tests if the 'sticky bit' permission is set on the directory.  On directories, this restricts file deletion to the owner of the file, even if the permission of the parent directory would normally permit deletion by others.  This is commonly used on /tmp filesystems.  To use this matcher:
+
+    it { should be_sticky }
+
+### be_setuid
+
+The `be_setuid` matcher tests if the 'setuid' permission is set on the file.  On executable files, this causes the process to be started owned by the user that owns the file, rather than invocating user.  This can result in escalation of privilege.  To use this matcher:
+
+    it { should be_setuid }
+
 ### 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:
@@ -157,13 +354,13 @@ an owner:
 
     it { should be_writable.by('owner') }
 
-a user:
+any user other than the owner or members of the file's group:
 
-    it { should be_writable.by_user('user') }
+    it { should be_writable.by('others') }
 
-### cmp
+a user:
 
-<%= partial "/shared/matcher_cmp" %>
+    it { should be_writable.by_user('user') }
 
 ### content
 
@@ -179,10 +376,6 @@ The following complete example tests the `pg_hba.conf` file in PostgreSQL for MD
       its('content') { should match(%r{host\s.*?all\s.*?all\s.*?::1\/128\s.*?md5})
     end
 
-### eq
-
-<%= partial "/shared/matcher_eq" %>
-
 ### exist
 
 The `exist` matcher tests if the named file exists:
@@ -207,26 +400,13 @@ The `have_mode` matcher tests if a file has a mode assigned to it:
 
     it { should have_mode }
 
-### include
-
-<%= partial "/shared/matcher_include" %>
-
 ### link_path
 
-The `link_path` matcher tests if the file exists at the specified path:
+The `link_path` matcher tests if the file exists at the specified path. If the file is a symlink,
+InSpec will resolve the symlink and return the ultimate linked file:
 
     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:
-
-    its('link_target') { should eq '/some/path/to/file' }
-
-### match
-
-<%= partial "/shared/matcher_match" %>
-
 ### md5sum
 
 The `md5sum` matcher tests if the MD5 checksum for a file matches the specified value:
@@ -241,15 +421,11 @@ The `mode` matcher tests if the mode assigned to the file matches the specified
 
 ### mtime
 
-The `mtime` matcher tests if the file modification time for the file matches the specified value:
+The `mtime` matcher tests if the file modification time for the file matches the specified value. The mtime, where supported, is returned as the number of seconds since the epoch.
 
-    its('mtime') { should eq 'October 31 2015 12:10:45' }
-
-or:
-
-    describe file('/').mtime.to_i do
-      it { should <= Time.now.to_i }
-      it { should >= Time.now.to_i - 1000}
+    describe file('/') do
+      its('mtime') { should <= Time.now.to_i }
+      its('mtime') { should >= Time.now.to_i - 1000 }
     end
 
 ### owner
@@ -292,191 +468,26 @@ Less than:
 
 ### type
 
-The `type` matcher tests if the first letter of the file's mode string contains one of the following characters:
+The `type` matcher tests for the file type. The available types are:
+
+* `file`: the object is a file
+* `directory`: the object is a directory
+* `link`: the object is a symbolic link
+* `pipe`: the object is a named pipe
+* `socket`: the object is a socket
+* `character_device`: the object is a character device
+* `block_device`: the object is a block device
+* `door`: the object is a door device
 
-* `-` 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
+The `type` method usually returns the type as a Ruby "symbol". We recommend using the `cmp` matcher to match
+either by symbol or string.
 
 For example:
 
-    its('type') { should eq 'file' }
+    its('type') { should eq :file }
+    its('type') { should cmp 'file' }
 
 or:
 
-    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
-
-    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
-
-    describe file('/tmp') do
-     it { should exist }
-    end
-
-### Test that a file does not exist
-
-    describe file('/tmpest') do
-     it { should_not exist }
-    end
-
-### Test if a path is a directory
-
-    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
-
-    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
-
-    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
-
-    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
-
-    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
-
-    describe file('/dev') do
-     its('mode') { should cmp '00755' }
-    end
-
-### Test the owner of a file
-
-    describe file('/root') do
-      its('owner') { should eq 'root' }
-    end
-
-### Test if a file is owned by the root user
-
-    describe file('/dev') do
-      it { should be_owned_by 'root' }
-    end
-
-### Test the mtime for a file
-
-    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
-
-    describe file('/') do
-      its('size') { should be > 64 }
-      its('size') { should be < 10240 }
-    end
-
-### Test that a file's size is zero
-
-    describe file('/proc/cpuinfo') do
-      its('size') { should be 0 }
-    end
-
-### Test that a file is not mounted
-
-    describe file('/proc/cpuinfo') do
-      it { should_not be_mounted }
-    end
-
-### Test an MD5 checksum
-
-    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
-
-    require 'digest'
-    cpuinfo = file('/proc/cpuinfo').content
-
-    sha256sum = Digest::SHA256.hexdigest(cpuinfo)
-
-    describe file('/proc/cpuinfo') do
-      its('sha256sum') { should eq sha256sum }
-    end
-
-### Verify NTP
-
-The following example shows how to use the `file` audit resource to verify if the `ntp.conf` and `leap-seconds` files are present, and then the `command` resource to verify if NTP is installed and running:
-
-    describe file('/etc/ntp.conf') do
-       it { should be_file }
-    end
-
-    describe file('/etc/ntp.leapseconds') do
-      it { should be_file }
-    end
-
-    describe command('pgrep ntp') do
-       its('exit_status') { should eq 0 }
-    end
-
-### Test parameters of symlinked file
-
-If you need to test the parameters of the target file for a symlink, you can use the `link_path` method for the `file` resource.
-
-For example, for the following symlink:
-
-    lrwxrwxrwx. 1 root root 11 03-10 17:56 /dev/virtio-ports/com.redhat.rhevm.vdsm -> ../vport2p1
-
-... you can write controls for both the link and the target.
-
-    describe file('/dev/virtio-ports/com.redhat.rhevm.vdsm') do
-      it { should be_symlink }
-    end
-
-    virito_port_vdsm = file('/dev/virtio-ports/com.redhat.rhevm.vdsm').link_path
-    describe file(virito_port_vdsm) do
-      it { should exist }
-      it { should be_character_device }
-      it { should be_owned_by 'ovirtagent' }
-      it { should be_grouped_into 'ovirtagent' }
-    end
+    its('type') { should eq :socket }
+    its('type') { should cmp 'socket' }

data/docs/resources/firewalld.md.erb

@@ -0,0 +1,104 @@
+---
+title: About the firewalld Resource
+---
+
+# firewalld
+
+Use the `firewalld` InSpec audit resource to test that firewalld is configured to allow and deny access to specific hosts, services and ports on a system.
+
+A firewalld has a number of zones that can be configured to allow and deny access to specific hosts, services, and ports.
+
+<br>
+
+## Syntax
+
+    describe firewalld do
+      it { should be_running }
+      its('default_zone') { should eq 'public' }
+      it { should have_service_enabled_in_zone('ssh', 'public') }
+      it { should have_rule_enabled('family=ipv4 source address=192.168.0.14 accept', 'public') }
+    end
+
+Use the where clause to test open interfaces, sources, and services in active zones.
+
+    describe firewalld.where { zone == 'public' } do
+      its('interfaces') { should cmp ['enp0s3', 'eno2'] }
+      its('sources') { should cmp ['192.168.1.0/24', '192.168.1.2'] }
+      its('services') { should cmp ['ssh', 'icmp'] }
+    end
+    
+<br>
+
+## Supported Properties
+
+### interfaces
+
+The `interfaces` property is used in conjunction with the where class to display open interfaces in an active zone.
+
+    describe firewalld.where { zone == 'public' } do
+      its('interfaces') { should cmp ['enp0s3', 'eno2'] }
+    end
+
+### sources
+
+The `sources` property is used in conjunction with the where class to display open sources in an active zone.
+
+    describe firewalld.where { zone == 'public' } do
+      its('sources') { should cmp ['192.168.1.0/24', '192.168.1.2'] }
+    end
+
+### services
+
+The `services` property is used in conjunction with the where class to display open services in an active zone.
+
+    describe firewalld.where { zone == 'public' } do
+      its('services') { should cmp ['ssh', 'icmp'] }
+    end
+
+### default_zone
+
+The `default_zone` property displays the default active zone to be used.
+
+    its('default_zone') { should eq 'public' }
+
+<br>
+
+## Matchers
+
+This InSpec audit resource has the following 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 firewalld service is installed:
+
+    it { should be_installed }
+
+### `be_running`
+
+The `be_running` matcher tests if the firewalld service is running:
+
+    it { should be_running }
+
+### have_zone
+
+`have_zone` returns true or false if the zone is set on firewalld. It does not mean the zone is active.
+
+    it { should have_zone('public') }
+
+### `have_service_enabled_in_zone`
+
+`have_service_enabled_in_zone` returns true or false if the service is allowed in the specified zone.
+
+    it { should have_service_enabled_in_zone('ssh', 'public') }
+
+### `have_port_enabled_in_zone`
+
+`have_port_enabled_in_zone` returns true or false if the port is allowed in the specified zone.
+
+    it { should have_port_enabled_in_zone('22/tcp', 'public') }
+
+### `have_rule_enabled`
+
+`have_rule_enabled` returns true or false if the rich-rule has been specified in the zone.
+
+    it { should have_rule_enabled('family=ipv4 source address=192.168.0.14 accept', 'public') }

data/docs/resources/gem.md.erb

@@ -6,6 +6,8 @@ title: About the gem Resource
 
 Use the `gem` InSpec audit resource to test if a global Gem package is installed.
 
+<br>
+
 ## Syntax
 
 A `gem` resource block declares a package and (optionally) a package version:
@@ -20,41 +22,7 @@ where
 * `('gem_binary')` can specify the path to a non-default gem binary, defaults to `'gem'`
 * `be_installed` is a valid matcher for this resource
 
-## Matchers
-
-This InSpec audit resource has the following matchers:
-
-### be
-
-<%= partial "/shared/matcher_be" %>
-
-### be_installed
-
-The `be_installed` matcher tests if the named Gem package is installed:
-
-    it { should be_installed }
-
-### cmp
-
-<%= partial "/shared/matcher_cmp" %>
-
-### eq
-
-<%= partial "/shared/matcher_eq" %>
-
-### include
-
-<%= partial "/shared/matcher_include" %>
-
-### match
-
-<%= partial "/shared/matcher_match" %>
-
-### version
-
-The `version` matcher tests if the named package version is on the system:
-
-    its('version') { should eq '0.33.0' }
+<br>
 
 ## Examples
 
@@ -90,3 +58,21 @@ The following examples show how to use this InSpec audit resource.
     describe gem('knife-backup', :chef_server) do
       it { should be_installed }
     end
+
+<br>
+
+## Matchers
+
+This InSpec audit resource has the following 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 Gem package is installed:
+
+    it { should be_installed }
+
+### version
+
+The `version` matcher tests if the named package version is on the system:
+
+    its('version') { should eq '0.33.0' }