inspec 1.51.25 → 2.0.16

data/docs/resources/aws_cloudwatch_log_metric_filter.md.erb

@@ -0,0 +1,151 @@
+---
+title: About the aws_cloudwatch_log_metric_filter Resource
+platform: aws
+---
+
+# aws\_cloudwatch\_log\_metric\_filter
+
+Use the `aws_cloudwatch_log_metric_filter` InSpec audit resource to search for and test properties of individual AWS Cloudwatch Log Metric Filters.
+
+A Log Metric Filter (LMF) is an AWS resource that observes log traffic, looks for a specified pattern, and updates a metric about the number times the match occurs.  The metric can also be connected to AWS Cloudwatch Alarms, so that actions can be taken when a match occurs.
+
+<br>
+
+## Syntax
+
+An `aws_cloudwatch_log_metric_filter` resource block searches for an LMF, specified by several search options.  If more than one log metric filter matches, an error occurs.
+
+    # Look for a LMF by its filter name and log group name.  This combination
+    # will always either find at most one LMF - no duplicates.
+    describe aws_cloudwatch_log_metric_filter(
+      filter_name: 'my-filter',
+      log_group_name: 'my-log-group'
+    ) do
+      it { should exist }
+    end
+
+    # Search for an LMF by pattern and log group.
+    # This could result in an error if the results are not unique.
+    describe aws_cloudwatch_log_metric_filter(
+      log_group_name:  'my-log-group',
+      pattern: 'my-filter'
+    ) do
+      it { should exist }
+    end
+
+<br>
+
+## Filter Attributes
+
+* `filter_name`, `log_group_name`, `pattern`
+
+<br>
+
+## Filter Examples
+
+### filter\_name
+
+This is the identifier of the log metric filter within its log group.  To ensure you have a unique result, you must also provide the `log_group_name`.
+
+    describe aws_cloudwatch_log_metric_filter(
+      filter_name: 'my-filter'
+    ) do
+      it { should exist }
+    end
+
+### log\_group\_name
+
+The name of the Cloudwatch Log Group that the LMF is watching.  Together with `filter_name`, this uniquely identifies an LMF.
+
+    describe aws_cloudwatch_log_metric_filter(
+      log_group_name: 'my-log-group',
+    ) do
+      it { should exist }
+    end
+
+### pattern
+
+The filter pattern used to match entries from the logs in the log group.
+
+    describe aws_cloudwatch_log_metric_filter(
+      pattern: '"ERROR" - "Exiting"',
+    ) do
+      it { should exist }
+    end
+
+<br>
+
+## Properties
+
+* `filter_name`, `log_group_name`,` metric_name`, `metric_namespace`, `pattern`
+
+<br>
+
+## Property Examples
+
+### filter\_name
+
+The name of the LMF within the `log_group`.
+
+    # Check the name of the LMF that has a certain pattern
+    describe aws_cloudwatch_log_metric_filter(
+      log_group_name: 'app-log-group',
+      pattern: 'KERBLEWIE',
+    ) do
+      its('filter_name') { should cmp 'kaboom_lmf' }
+    end
+
+### log\_group\_name
+
+The name of the log group that the LMF is watching.
+
+    # Check which log group the LMF 'error-watcher' is watching 
+    describe aws_cloudwatch_log_metric_filter(
+      filter_name: 'error-watcher',
+    ) do
+      its('log_group_name') { should cmp 'app-log-group' }
+    end
+
+### metric\_name, metric\_namespace
+
+The name and namespace of the Cloudwatch Metric that will be updated when the LMF matches.  You also need the `metric_namespace` to uniquely identify the metric.
+
+    # Ensure that the LMF has the right metric name
+    describe aws_cloudwatch_log_metric_filter(
+      filter_name: 'my-filter',
+      log_group_name: 'my-log-group',
+    ) do
+      its('metric_name') { should cmp 'MyMetric' }
+      its('metric_namespace') { should cmp 'MyFantasticMetrics' }
+    end
+
+### pattern
+
+The pattern used to match entries from the logs in the log group.
+
+    # Ensure that the LMF is watching for errors
+    describe aws_cloudwatch_log_metric_filter(
+      filter_name: 'error-watcher',
+      log_group_name: 'app-log-group',
+    ) do
+      its('pattern') { should cmp 'ERROR' }
+    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/).
+
+### exist
+
+Matches (i.e., passes the test) if the resource parameters (search criteria) were able to locate exactly one LMF.
+
+    describe aws_cloudwatch_log_metric_filter(
+      log_group_name: 'my-log-group',
+    ) do
+      it { should exist }
+    end
+
+
+

data/docs/resources/aws_ec2_instance.md.erb

@@ -0,0 +1,106 @@
+---
+title: About the aws_ec2_instance Resource
+platform: aws
+---
+
+# aws\_ec2\_instance
+
+Use the `aws_ec2_instance` InSpec audit resource to test properties of a single AWS EC2 instance.
+
+<br>
+
+## Syntax
+
+An `aws_ec2_instance` resource block declares the tests for a single AWS EC2 instance by either name or id.
+
+    describe aws_ec2_instance('i-01a2349e94458a507') do
+      it { should exist }
+    end
+
+    describe aws_ec2_instance(name: 'my-instance') do
+      it { should be_running }
+    end
+
+<br>
+
+## Examples
+
+The following examples show how to use this InSpec audit resource.
+
+### Test that an EC2 instance does not exist
+
+    describe aws_ec2_instance(name: 'dev-server') do
+      it { should_not exist }
+    end
+
+### Test that an EC2 instance is running
+
+    describe aws_ec2_instance(name: 'prod-database') do
+      it { should be_running }
+    end
+
+### Test that an EC2 instance is using the correct image ID
+
+    describe aws_iam_instance(name: 'my-instance') do
+      its('image_id') { should eq 'ami-27a58d5c' }
+    end
+
+### Test that an EC2 instance has the correct tag
+
+    describe aws_ec2_instance('i-090c29e4f4c165b74') do
+      its('tags') { should include(key: 'Contact', value: 'Gilfoyle') }
+    end
+
+<br>
+
+## Properties
+
+* `architecture`, `client_token`, `image_id`,`instance_type`, `key_name`, `launch_time`,`private_ip_address`,  `private_dns_name`, `public_dns_name`, `public_ip_address`,  `root_device_type`, `root_device_name`, `security_group_ids`, `subnet_id`, `tags`,`virtualization_type`, `vpc_id`
+
+<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\_pending
+
+The `be\_pending` matcher tests if the described EC2 instance state is `pending`. This indicates that an instance is provisioning. This state should be temporary.
+
+    it { should be_pending }
+
+### be\_running
+
+The `be_running` matcher tests if the described EC2 instance state is `running`. This indicates the instance is fully operational from AWS's perspective.
+
+    it { should be_running }
+
+### be\_shutting\_down
+
+The `be_shutting_down` matcher tests if the described EC2 instance state is `shutting-down`. This indicates the instance has received a termination command and is in the process of being permanently halted and de-provisioned. This state should be temporary.
+
+    it { should be_shutting_down }
+
+### be\_stopped
+
+The `be_stopped` matcher tests if the described EC2 instance state is `stopped`. This indicates that the instance is suspended and may be started again.
+
+    it { should be_stopped }
+
+### be\_stopping
+
+The `be_stopping` matcher tests if the described EC2 instance state is `stopping`. This indicates that an AWS stop command has been issued, which will suspend the instance in an OS-unaware manner.  This state should be temporary.
+
+    it { should be_stopping }
+
+### be\_terminated
+
+The `be_terminated` matcher tests if the described EC2 instance state is `terminated`.  This indicates the instance is permanently halted and will be removed from the instance listing in a short period. This state should be temporary.
+
+    it { should be_terminated }
+
+### be\_unknown
+
+The `be_unknown` matcher tests if the described EC2 instance state is `unknown`. This indicates an error condition in the AWS management system. This state should be temporary.
+
+    it { should be_unknown }

data/docs/resources/aws_iam_access_key.md.erb

@@ -0,0 +1,123 @@
+---
+title: About the aws_iam_access_key Resource
+platform: aws
+---
+
+# aws\_iam\_access\_key
+
+Use the `aws_iam_access_key` InSpec audit resource to test properties of a single AWS IAM access key.
+
+<br>
+
+## Syntax
+
+An `aws_iam_access_key` resource block declares the tests for a single AWS IAM access key.  An access key is uniquely identified by its access key id.  
+
+    # This is unique - the key will either exist or it won't, but it will never be an error.
+    describe aws_iam_access_key(access_key_id: 'AKIA12345678ABCD') do
+      it { should exist }
+      it { should_not be_active }
+      its('create_date') { should be > Time.now - 365 * 86400 }
+      its('last_used_date') { should be > Time.now - 90 * 86400 }
+    end
+
+    # id is an alias for access_key_id
+    describe aws_iam_access_key(id: 'AKIA12345678ABCD') do
+      # Same
+    end
+    
+
+Access keys are associated with IAM users, who may have zero, one or two access keys.  You may also lookup an access key by username.  If the user has more than one access key, an error occurs (You may use `aws_iam_access_keys` with the `username` resource parameter to access a user's keys when they have multiple keys.)
+
+    # This is not unique.  If the user has zero or one keys, it is not an error.  
+    # If they have two, it is an error.
+    describe aws_iam_access_key(username: 'roderick') do
+      it { should exist }
+      it { should be_active }
+    end
+
+You may also use both username and access key id to ensure that a particular key is associated with a particular user.
+
+    describe aws_iam_access_key(username: 'roderick', access_key_id: 'AKIA12345678ABCD') do
+      it { should exist }
+    end
+
+<br>
+
+## Examples
+
+The following examples show how to use this InSpec audit resource.
+
+### Test that an IAM access key is not active
+
+    describe aws_iam_access_key(username: 'username', id: 'access-key-id') do
+      it { should_not be_active }
+    end
+
+### Test that an IAM access key is older than one year
+
+    describe aws_iam_access_key(username: 'username', id: 'access-key-id') do
+      its('create_date') { should be > Time.now - 365 * 86400 }
+    end
+
+### Test that an IAM access key has been used in the past 90 days
+
+    describe aws_iam_access_key(username: 'username', id: 'access-key-id') do
+      its('last_used_date') { should be > Time.now - 90 * 86400 }
+    end
+
+<br>
+
+## Properties
+
+* `access_key_id`, `create_date`, `last_used_date`, `username`
+
+<br>
+
+## Property Examples
+
+### access\_key\_id
+
+The unique ID of this access key.
+
+    describe aws_iam_access_key(username: 'bob')
+      its('access_key_id') { should cmp 'AKIA12345678ABCD' }
+    end
+
+### create\_date
+
+The date and time, as a Ruby DateTime, at which the access key was created.
+
+    # Is the access key less than a year old?
+    describe aws_iam_access_key(username: 'bob')
+      its('create_date') { should be > Time.now - 365 * 86400 }
+    end
+
+### last\_used\_date
+
+The date and time, as a Ruby DateTime, at which the access key was last_used.
+
+    # Has the access key been used in the last year?
+    describe aws_iam_access_key(username: 'bob')
+      its('last_used_date') { should be > Time.now - 365 * 86400 }
+    end
+
+### username
+
+The IAM user that owns this key.
+
+    describe aws_iam_access_key(access_key_id: 'AKIA12345678ABCD')
+      its('username') { should cmp 'bob' }
+    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\_active
+
+The `be_active` matcher tests if the described IAM access key is active.
+
+    it { should be_active }

data/docs/resources/aws_iam_access_keys.md.erb

@@ -0,0 +1,198 @@
+---
+title: About the aws_iam_access_keys Resource
+platform: aws
+---
+
+# aws\_iam\_access\_keys
+
+Use the `aws_iam_access_keys` InSpec audit resource to test properties of some or all IAM Access Keys.
+
+To test properties of a single Access Key, use the `aws_iam_access_key` resource instead.  
+To test properties of an individual user's access keys, use the `aws_iam_user` resource.
+
+Access Keys are closely related to AWS User resources.  Use this resource to perform audits of all keys or of keys specified by criteria unrelated to any particular user.  
+
+<br>
+
+## Syntax
+
+An `aws_iam_access_keys` resource block uses an optional filter to select a group of access keys and then tests that group.
+
+    # Do not allow any access keys
+    describe aws_iam_access_keys do
+      it { should_not exist }
+    end
+
+    # Don't let fred have access keys, using filter argument syntax
+    describe aws_iam_access_keys.where(username: 'fred') do
+      it { should_not exist }
+    end  
+
+    # Don't let fred have access keys, using filter block syntax (most flexible)
+    describe aws_iam_access_keys.where { username == 'fred' } do
+      it { should_not exist }
+    end    
+
+<br>
+
+## Examples
+
+The following examples show how to use this InSpec audit resource.
+
+### Disallow access keys created more than 90 days ago
+
+    describe aws_iam_access_keys.where { created_age > 90 } do
+      it { should_not exist }
+    end 
+
+<br>
+
+## Filter Criteria
+* `active`, `create_date`, `created_days_ago`, `created_hours_ago`, `created_with_user`, `ever_used`, `inactive`, `last_used_date`, `last_used_hours_ago`, `last_used_days_ago`, `never_used`, `user_created_date`
+
+<br>
+
+## Filter Examples
+
+### active
+
+A true / false value indicating if an Access Key is currently "Active" (the normal state) in the AWS console.  See also: `inactive`.
+
+    # Check if a particular key is enabled
+    describe aws_iam_access_keys.where { active } do
+      its('access_key_ids') { should include('AKIA1234567890ABCDEF')}
+    end
+
+### create\_date
+
+A DateTime identifying when the Access Key was created.  See also `created_days_ago` and `created_hours_ago`.
+
+    # Detect keys older than 2017
+    describe aws_iam_access_keys.where { create_date < DateTime.parse('2017-01-01') } do
+      it { should_not exist }
+    end
+
+### created\_days\_ago, created\_hours\_ago
+
+An integer, representing how old the access key is.
+
+    # Don't allow keys that are older than 90 days
+    describe aws_iam_access_keys.where { created_days_ago > 90 } do
+      it { should_not exist }
+    end
+
+### created\_with\_user
+
+A true / false value indicating if the Access Key was likely created at the same time as the user, by checking if the difference between created_date and user_created_date is less than 1 hour.
+
+    # Do not automatically create keys for users
+    describe aws_iam_access_keys.where { created_with_user } do
+      it { should_not exist }
+    end
+
+### ever\_used
+
+A true / false value indicating if the Access Key has ever been used, based on the last_used_date. See also: `never_used`.
+
+    # Check to see if a particular key has ever been used
+    describe aws_iam_access_keys.where { ever_used } do
+      its('access_key_ids') { should include('AKIA1234567890ABCDEF')}
+    end
+
+### inactive
+
+A true / false value indicating if the Access Key has been marked Inactive in the AWS console. See also: `active`.
+
+    # Don't leave inactive keys laying around
+    describe aws_iam_access_keys.where { inactive } do
+      it { should_not exist }
+    end
+
+### last\_used\_date
+
+A DateTime identifying when the Access Key was last used. Returns nil if the key has never been used. See also: `ever_used`, `last_used_days_ago`, `last_used_hours_ago`, and `never_used`.
+
+    # No one should do anything on Mondays
+    describe aws_iam_access_keys.where { ever_used and last_used_date.monday? } do
+      it { should_not exist }
+    end
+
+### last\_used\_days\_ago, last\_used\_hours\_ago
+
+An integer representing when the key was last used. See also: `ever_used`, `last_used_date`, and `never_used`.
+
+    # Don't allow keys that sit unused for more than 90 days
+    describe aws_iam_access_keys.where { last_used_days_ago > 90 } do
+      it { should_not exist }
+    end
+
+### never\_used
+
+A true / false value indicating if the Access Key has never been used, based on the `last_used_date`. See also: `ever_used`.
+
+    # Don't allow unused keys to lay around
+    describe aws_iam_access_keys.where { never_used } do
+      it { should_not exist }
+    end
+
+### username
+
+Searches for access keys owned by the named user. Each user may have zero, one, or two access keys.
+
+    describe aws_iam_access_keys(username: 'bob') do
+      it { should exist }
+    end
+
+### user\_created\_date
+
+The date at which the user was created.
+
+    # Users have to be a week old to have a key
+    describe aws_iam_access_keys.where { user_created_date > Date.now - 7 }
+      it { should_not exist }
+    end
+
+<br>
+
+## Properties
+
+* `access_key_ids`, `entries`
+
+## Property Examples
+
+### access\_key\_ids
+
+Provides a list of all access key IDs matched.
+
+    describe aws_iam_access_keys do
+      its('access_key_ids') { should include('AKIA1234567890ABCDEF') }
+    end
+
+### 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 access keys on the account
+    describe aws_iam_access_keys do
+      its('entries.count') { should be <= 100}
+    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.
+
+    # Sally should have at least one access key
+    describe aws_iam_access_keys.where(username: 'sally') do
+      it { should exist }
+    end
+
+    # Don't let fred have access keys
+    describe aws_iam_access_keys.where(username: 'fred') do
+      it { should_not exist }
+    end