inspec 2.3.10 → 2.3.23

data/docs/resources/audit_policy.md.erb

@@ -1,57 +0,0 @@
----
-title: About the audit_policy Resource
-platform: linux
----
-
-# audit_policy
-
-Use the `audit_policy` InSpec audit 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 enabled auditing category property, the auditing level may be set to `No Auditing`, `Not Specified`, `Success`, `Success and Failure`, or `Failure`.
-
-<br>
-
-## Availability
-
-### Installation
-
-This resource is distributed along with InSpec itself. You can use it automatically.
-
-### Version
-
-This resource first became available in v1.0.0 of InSpec.
-
-## Syntax
-
-An `audit_policy` resource block declares a parameter that belongs to an audit policy category or subcategory:
-
-    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`
-
-<br>
-
-## Examples
-
-The following examples show how to use this InSpec audit resource.
-
-### Test that a parameter is not set to "No Auditing"
-
-    describe audit_policy do
-      its('Other Account Logon Events') { should_not eq 'No Auditing' }
-    end
-
-### Test that a parameter is set to "Success"
-
-    describe audit_policy do
-      its('User Account Management') { should eq 'Success' }
-    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/auditd.md.erb

@@ -1,89 +0,0 @@
----
-title: About the auditd Resource
-platform: linux
----
-
-# auditd
-
-Use the `auditd` InSpec audit 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. These rules are output using the auditctl -l command. This resource supports versions of `audit` >= 2.3.
-
-<br>
-
-## Availability
-
-### Installation
-
-This resource is distributed along with InSpec itself. You can use it automatically.
-
-### Version
-
-This resource first became available in v1.38.8 of InSpec.
-
-## Syntax
-
-An `auditd` resource block declares one (or more) rules to be tested, and then what that rule should do:
-
-    describe auditd do
-      its('lines') { should include %r(-w /etc/ssh/sshd_config) }
-    end
-
-or test that multiple individual rules are defined:
-
-    describe auditd do
-      its('lines') { should include %r(-a always,exit -F arch=.* -S init_module,delete_module -F key=modules) }
-      its('lines') { should include %r(-a always,exit -F arch=.* -S chmod,fchmod,fchmodat -F auid>=1000 -F auid!=-1 -F key=.+) }
-    end
-
-where each test must declare one (or more) rules to be tested.
-
-<br>
-
-## 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
-
-For `audit` >= 2.3:
-
-    describe auditd do
-      its('lines') { should include %r(-a always,exit -F arch=.* -S chown.* -F auid>=1000 -F auid!=-1 -F key=perm_mod) }
-    end
-
-### Query the audit daemon status
-
-    describe auditd.status('backlog') do
-      it { should cmp 0 }
-    end
-
-### Query properties of rules targeting specific syscalls or files - uniq is used to handle multiple rules for the same syscall with redundant field values
-
-    describe auditd.syscall('open') do
-      its('action.uniq') { should eq ['always'] }
-      its('list.uniq') { should eq ['exit'] }
-    end
-
-    describe auditd.file('/etc/sudoers') do
-      its('permissions') { should include ['x'] }
-    end
-
-The where accessor can be used to filter on fields. For example:
-
-    describe auditd.syscall('chown').where { arch == "b32" } do
-      its('action') { should eq ['always'] }
-      its('list') { should eq ['exit'] }
-      its('exit') { should include ['-EACCES'] }
-      its('exit') { should include ['-EPERM'] }
-    end
-
-The key filter may be useful in evaluating rules with particular key values:
-
-    describe auditd.where { key == "privileged" } do
-      its('permissions') { should include ['x'] }
-    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/auditd_conf.md.erb

@@ -1,78 +0,0 @@
----
-title: About the auditd_conf Resource
-platform: linux
----
-
-# auditd_conf
-
-Use the `auditd_conf` InSpec audit 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.
-
-<br>
-
-## Availability
-
-### Installation
-
-This resource is distributed along with InSpec itself. You can use it automatically.
-
-### Version
-
-This resource first became available in v1.0.0 of InSpec.
-
-## Syntax
-
-A `auditd_conf` resource block declares configuration settings that should be tested:
-
-    describe auditd_conf('path') do
-      its('keyword') { should cmp '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 cmp 'value' }` is the value that is expected
-
-<br>
-
-## Properties
-
-This matcher will match any property listed in the `auditd.conf` configuration file. Property names and expected values are case-insensitive:
-
-* `admin_space_left`, `admin_space_left_action`, `action_mail_acct`, `disk_error_action`, `disk_full_action`, `flush`, `freq`, `log_file`, `log_format`, `max_log_file`, `max_log_file_action`, `num_logs`, `space_left`, `space_left_action`
-
-## Property Examples
-
-The following examples show how to use this InSpec audit resource.
-
-### Test the auditd.conf file
-
-    describe auditd_conf do
-      its('log_file') { should cmp '/full/path/to/file' }
-      its('log_format') { should cmp 'raw' }
-      its('flush') { should cmp 'none' }
-      its('freq') { should cmp 1 }
-      its('num_logs') { should cmp 0 }
-      its('max_log_file') { should cmp 6 }
-      its('max_log_file_action') { should cmp 'email' }
-      its('space_left') { should cmp 2 }
-      its('action_mail_acct') { should cmp 'root' }
-      its('space_left_action') { should cmp 'email' }
-      its('admin_space_left') { should cmp 1 }
-      its('admin_space_left_action') { should cmp 'halt' }
-      its('disk_full_action') { should cmp 'halt' }
-      its('disk_error_action') { should cmp 'halt' }
-    end
-
-<br>
-
-## Matchers
-
-For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/).
-
-### `cmp`
-
-The `cmp` matcher compares values across types.
-
-    its('freq') { should cmp 1 }
-

data/docs/resources/aws_cloudtrail_trail.md.erb

@@ -1,165 +0,0 @@
----
-title: About the aws_cloudtrail_trail Resource
-platform: aws
----
-
-# aws\_cloudtrail\_trail
-
-Use the `aws_cloudtrail_trail` InSpec audit resource to test properties of a single AWS Cloudtrail Trail.
-
-AWS CloudTrail is a service that enables governance, compliance, operational auditing, and risk auditing of your AWS account. With CloudTrail, you can log, continuously monitor, and retain account activity related to actions across your AWS infrastructure. CloudTrail provides event history of your AWS account activity, including actions taken through the AWS Management Console, AWS SDKs, command line tools, and other AWS services. This event history simplifies security analysis, resource change tracking, and troubleshooting.
-
-Each AWS Cloudtrail Trail is uniquely identified by its `trail_name` or `trail_arn`.
-
-<br>
-
-## Availability
-
-### Installation
-
-This resource is distributed along with InSpec itself. You can use it automatically.
-
-### Version
-
-This resource first became available in v2.0.16 of InSpec.
-
-## Syntax
-
-An `aws_cloudtrail_trail` resource block identifies a trail by `trail_name`.
-
-    # Find a trail by name
-    describe aws_cloudtrail_trail('trail-name') do
-      it { should exist }
-    end
-
-    # Hash syntax for trail name
-    describe aws_cloudtrail_trail(trail_name: 'trail-name') do
-      it { should exist }
-    end
-
-<br>
-
-## Examples
-
-The following examples show how to use this InSpec audit resource.
-
-### Test that the specified trail does exist
-
-    describe aws_cloudtrail_trail('trail-name') do
-      it { should exist }
-    end
-
-### Test that the specified trail is encrypted using SSE-KMS
-
-    describe aws_cloudtrail_trail('trail-name') do
-      it { should be_encrypted }
-    end
-
-### Test that the specified trail is a multi-region trail
-
-    describe aws_cloudtrail_trail('trail-name') do
-      it { should be_multi_region_trail }
-    end
-
-<br>
-
-## Properties
-
-* `s3_bucket_name`, `trail_arn`, `cloud_watch_logs_role_arn`, `cloud_watch_logs_log_group_arn`, `kms_key_id`, `home_region`,
-
-<br>
-
-## Property Examples
-
-### s3\_bucket\_name
-
-Specifies the name of the Amazon S3 bucket designated for publishing log files.
-
-    describe aws_cloudtrail_trail('trail-name') do
-      its('s3_bucket_name') { should cmp "s3-bucket-name" }
-    end
-
-### trail\_arn
-
-The ARN identifier of the specified trail. An ARN uniquely identifies the trail within AWS.
-
-    describe aws_cloudtrail_trail('trail-name') do
-      its('trail_arn') { should cmp "arn:aws:cloudtrail:us-east-1:484747447281:trail/trail-name" }
-    end
-
-### cloud\_watch\_logs\_role\_arn
-
-Specifies the role for the CloudWatch Logs endpoint to assume to write to a user\'s log group.
-
-    describe aws_cloudtrail_trail('trail-name') do
-      its('cloud_watch_logs_role_arn') { should include "arn:aws:iam:::role/CloudTrail_CloudWatchLogs_Role" }
-    end
-
-### cloud\_watch\_logs\_log\_group\_arn
-
-Specifies a log group name using an Amazon Resource Name (ARN), a unique identifier that represents the log group to which CloudTrail logs will be delivered.
-
-    describe aws_cloudtrail_trail('trail-name') do
-      its('cloud_watch_logs_log_group_arn') { should include "arn:aws:logs:us-east-1::log-group:test:*" }
-    end
-
-### kms\_key\_id
-
-Specifies the KMS key ID to used to encrypt the logs delivered by CloudTrail.
-
-    describe aws_cloudtrail_trail('trail-name') do
-      its('kms_key_id') { should include "key-arn" }
-    end
-
-### home\_region
-
-Specifies the region in which the trail was created.
-
-    describe aws_cloudtrail_trail('trail-name') do
-      its('home_region') { should include "us-east-1" }
-    end
-
-### delivered\_logs\_days\_ago
-
-Specifies the number of days ago the CloudTrail delivered logs to CloudWatch Logs.
-
-    # Ensure the latest delivery time was recent
-    describe aws_cloudtrail_trail('trail-name') do
-      its('delivered_logs_days_ago') { should eq 0 }
-    end
-
-<br>
-
-## Matchers
-
-This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/).
-
-### be\_multi\_region\_trail
-
-The test will pass if the identified trail is a multi-region trail.
-
-    describe aws_cloudtrail_trail('trail-name') do
-      it { should be_multi_region_trail }
-    end
-
-### be\_encrypted
-
-The test will pass if the logs delivered by the identified trail is encrypted.
-
-    describe aws_cloudtrail_trail('trail-name') do
-      it { should be_encrypted }
-    end
-
-### be\_log\_file\_validation\_enabled
-
-The test will pass if the identified trail has log file integrity validation is enabled.
-
-    describe aws_cloudtrail_trail('trail-name') do
-      it { should be_log_file_validation_enabled }
-    end
-
-## AWS Permissions
-
-Your [Principal](https://docs.aws.amazon.com/IAM/latest/UserGuide/intro-structure.html#intro-structure-principal) will need the `cloudtrail:DescribeTrails` action with Effect set to Allow.
-
-You can find detailed documentation at [Actions, Resources, and Condition Keys for AWS CloudTrail](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_awscloudtrail.html).

data/docs/resources/aws_cloudtrail_trails.md.erb

@@ -1,96 +0,0 @@
----
-title: About the aws_cloudtrail_trails Resource
-platform: aws
----
-
-# aws\_cloudtrail\_trails
-
-Use the `aws_cloudtrail_trails` InSpec audit resource to test properties of some or all AWS CloudTrail Trails.
-
-AWS CloudTrail is a service that enables governance, compliance, operational auditing, and risk auditing of your AWS account. With CloudTrail, you can log, continuously monitor, and retain account activity related to actions across your AWS infrastructure. CloudTrail provides event history of your AWS account activity, including actions taken through the AWS Management Console, AWS SDKs, command line tools, and other AWS services. This event history simplifies security analysis, resource change tracking, and troubleshooting.
-
-Each AWS CloudTrail Trails is uniquely identified by its trail name or trail arn.
-
-<br>
-
-## Availability
-
-### Installation
-
-This resource is distributed along with InSpec itself. You can use it automatically.
-
-### Version
-
-This resource first became available in v2.0.16 of InSpec.
-
-## Syntax
-
-An `aws_cloudtrail_trails` resource block collects a group of CloudTrail Trails and then tests that group.
-
-    # Verify the number of CloudTrail Trails in the AWS account
-    describe aws_cloudtrail_trails do
-      its('entries.count') { should cmp 10 }
-    end
-
-<br>
-
-## Examples
-
-The following examples show how to use this InSpec audit resource.
-
-As this is the initial release of `aws_cloudtrail_trails`, its limited functionality precludes examples.
-
-<br>
-
-## Properties
-* `entries`, `names`, `trail_arns`
-
-<br>
-
-## Property Examples
-
-### entries
-
-Provides access to the raw results of the query. This can be useful for checking counts and other advanced operations.
-
-    # Allow at most 100 CloudTrail Trails on the account
-    describe aws_cloudtrail_trails do
-      its('entries.count') { should be <= 100}
-    end
-
-### names
-
-Provides a list of trail names for all CloudTrail Trails in the AWS account.
-
-    describe aws_cloudtrail_trails do
-      its('names') { should include('trail-1') }
-    end
-
-### trail\_arns
-
-Provides a list of trail arns for all CloudTrail Trails in the AWS account.
-
-    describe aws_cloudtrail_trails do
-      its('trail_arns') { should include('arn:aws:cloudtrail:us-east-1::trail/trail-1') }
-    end
-
-<br>
-
-## Matchers
-
-This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/).
-
-### exists
-
-The control will pass if the filter returns at least one result. Use `should_not` if you expect zero matches.
-
-    # Verify that at least one CloudTrail Trail exists.
-    describe aws_cloudtrail_trails
-      it { should exist }
-    end
-
-## AWS Permissions
-
-Your [Principal](https://docs.aws.amazon.com/IAM/latest/UserGuide/intro-structure.html#intro-structure-principal) will need the `cloudtrail:DescribeTrails` action with Effect set to Allow.
-
-You can find detailed documentation at [Actions, Resources, and Condition Keys for AWS CloudTrail](https://docs.aws.amazon.com/IAM/latest/UserGuide/list_awscloudtrail.html).