inspec 1.51.25 → 2.0.16

data/docs/resources/aide_conf.md.erb

@@ -1,5 +1,6 @@
 ---
 title: The aide_conf Resource
+platform: linux
 ---
 
 # aide_conf
@@ -38,9 +39,11 @@ Use the where clause to match a selection_line to one rule or a particular set o
 
 * `conf_path`, `content`, `rules`, `all_have_rule`
 
+<br>
+
 ## Property Examples
 
-The following examples show how to use this InSpec audit resource. 
+The following examples show how to use this InSpec audit resource.
 
 ### Test if all selection lines contain the xattr rule
 
@@ -65,14 +68,9 @@ The following examples show how to use this InSpec audit resource.
     describe aide_conf.all_have_rule('sha512') do
       it { should eq true }
     end
-    
+
 <br>
 
 ## Matchers
 
-For a full list of available matchers please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/). 
-This InSpec audit resource uses the matchers `eq` and `include`. 
-
-For a full list of available matchers please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/).
-
-
+For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/).

data/docs/resources/apache.md.erb

@@ -1,5 +1,6 @@
 ---
 title: About the apache Resource
+platform: linux
 ---
 
 # apache
@@ -63,4 +64,4 @@ The following examples show how to use this InSpec audit resource.
 
 ## Matchers
 
-For a full list of available matchers please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/).
+For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/).

data/docs/resources/apache_conf.md.erb

@@ -1,5 +1,6 @@
 ---
 title: About the apache_conf Resource
+platform: linux
 ---
 
 # apache_conf
@@ -50,7 +51,7 @@ The following examples show how to use this InSpec audit resource.
 
 ## Matchers
 
-For a full list of available matchers please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/).
+For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/).
 This InSpec audit resource matches any service that is listed in the Apache configuration file:
 
     its('PidFile') { should_not eq '/var/run/httpd.pid' }

data/docs/resources/apt.md.erb

@@ -1,5 +1,6 @@
 ---
 title: About the apt Resource
+platform: linux
 ---
 
 # apt
@@ -54,7 +55,7 @@ The following examples show how to use this InSpec audit resource.
 
 ## Matchers
 
-For a full list of available matchers please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/). 
+For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/).
 
 
 ### be_enabled

data/docs/resources/audit_policy.md.erb

@@ -1,10 +1,11 @@
 ---
 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`.
+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>
 
@@ -43,4 +44,4 @@ The following examples show how to use this InSpec audit resource.
 
 ## Matchers
 
-For a full list of available matchers please visit our [matchers page](https://www.inspec.io/docs/reference/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,5 +1,6 @@
 ---
 title: About the auditd Resource
+platform: linux
 ---
 
 # auditd
@@ -75,4 +76,4 @@ The key filter may be useful in evaluating rules with particular key values:
 
 ## Matchers
 
-For a full list of available matchers please visit our [matchers page](https://www.inspec.io/docs/reference/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,5 +1,6 @@
 ---
 title: About the auditd_conf Resource
+platform: linux
 ---
 
 # auditd_conf
@@ -57,12 +58,11 @@ The following examples show how to use this InSpec audit resource.
 
 ## Matchers
 
-For a full list of available matchers please visit our [matchers page](https://www.inspec.io/docs/reference/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. 
+The `cmp` matcher compares values across types.
 
     its('freq') { should cmp 1 }
 
- For a full list of available matchers please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/).

data/docs/resources/aws_cloudtrail_trail.md.erb

@@ -0,0 +1,140 @@
+---
+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>
+
+## 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
+
+<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

data/docs/resources/aws_cloudtrail_trails.md.erb

@@ -0,0 +1,81 @@
+---
+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>
+
+## 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   
+

data/docs/resources/aws_cloudwatch_alarm.md.erb

@@ -0,0 +1,86 @@
+---
+title: About the aws_cloudwatch_alarm Resource
+platform: aws
+---
+
+# aws\_cloudwatch\_alarm
+
+Use the `aws_cloudwatch_alarm` InSpec audit resource to test properties of a single Cloudwatch Alarm.
+
+Cloudwatch Alarms are currently identified using the metric name and metric namespace.  Future work may allow other approaches to identifying alarms.
+
+<br>
+
+## Syntax
+
+An `aws_cloudwatch_alarm` resource block searches for a Cloudwatch Alarm, specified by several search options.  If more than one Alarm matches, an error occurs.
+
+    # Look for a specific alarm
+    aws_cloudwatch_alarm(
+      metric: 'my-metric-name',
+      metric_namespace: 'my-metric-namespace',
+    ) do
+      it { should exist }
+    end
+
+<br>
+
+## Examples
+
+The following examples show how to use this InSpec audit resource.
+
+### Ensure an Alarm has at least one alarm action
+
+    describe aws_cloudwatch_alarm(
+      metric: 'my-metric-name',
+      metric_namespace: 'my-metric-namespace',
+    ) do 
+      its('alarm_actions') { should_not be_empty }
+    end 
+
+<br>
+
+## Properties
+
+* `alarm_actions`
+
+## Property Examples
+
+### alarm\_actions
+
+`alarm_actions` returns a list of strings.  Each string is the ARN of an action that will be taken should the alarm be triggered.  
+
+    # Ensure that the alarm has at least one action
+    describe aws_cloudwatch_alarm(
+      metric: 'bed-metric',
+      metric_namespace: 'my-metric-namespace',
+    ) do 
+      its('alarm_actions') { should_not be_empty }
+    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 a Cloudwatch Alarm could be found. Use `should_not` if you expect zero matches.
+
+    # Expect good metric
+    describe aws_cloudwatch_alarm(
+      metric: 'good-metric',
+      metric_namespace: 'my-metric-namespace',
+    ) do 
+      it { should exist }
+    end
+
+    # Disallow alarms based on bad-metric
+    describe aws_cloudwatch_alarm(
+      metric: 'bed-metric',
+      metric_namespace: 'my-metric-namespace',
+    ) do 
+      it { should_not exist }
+    end
+