inspec 2.1.21 → 2.1.30

data/docs/resources/aws_iam_policy.md.erb

@@ -1,144 +1,144 @@
----
-title: About the aws_iam_policy Resource
-platform: aws
----
-
-# aws\_iam\_policy
-
-Use the `aws_iam_policy` InSpec audit resource to test properties of a single managed AWS IAM Policy.
-
-A policy is an entity in AWS that, when attached to an identity or resource, defines their permissions. AWS evaluates these policies when a principal, such as a user, makes a request. Permissions in the policies determine if the request is allowed or denied.
-
-Each IAM Policy is uniquely identified by either its policy\_name or arn.
-
-<br>
-
-## Syntax
-
-An `aws_iam_policy` resource block identifies a policy by policy name.
-
-    # Find a policy by name
-    describe aws_iam_policy('AWSSupportAccess') do
-      it { should exist }
-    end
-
-    # Find a customer-managed by name
-    describe aws_iam_policy('customer-managed-policy') do
-      it { should exist }
-    end
-
-    # Hash syntax for policy name
-    describe aws_iam_policy(policy_name: 'AWSSupportAccess') do
-      it { should exist }
-    end
-
-<br>
-
-## Examples
-
-The following examples show how to use this InSpec audit resource.
-
-### Test that a policy does exist
-
-    describe aws_iam_policy('AWSSupportAccess') do
-      it { should exist }
-    end
-
-### Test that a policy is attached to at least one entity
-
-    describe aws_iam_policy('AWSSupportAccess') do
-      it { should be_attached }
-    end
-
-<br>
-
-## Properties
-
-* `arn`, `attachment_count`, `attached_groups`, `attached_roles`,`attached_users`, `default_version_id`
-
-## Property Examples
-
-### arn
-
-"The ARN identifier of the specified policy. An ARN uniquely identifies the policy within AWS."
-
-    describe aws_iam_policy('AWSSupportAccess') do
-      its('arn') { should cmp "arn:aws:iam::aws:policy/AWSSupportAccess" }
-    end
-
-### attachment\_count
-
-The count of attached entities for the specified policy.
-
-    describe aws_iam_policy('AWSSupportAccess') do
-      its('attachment_count') { should cmp 1 }
-    end
-
-### attached\_groups
-
-The list of groupnames of the groups attached to the policy.
-
-    describe aws_iam_policy('AWSSupportAccess') do
-      its('attached_groups') { should include "test-group" }
-    end
-
-### attached\_roles
-
-The list of rolenames of the roles attached to the policy.
-
-    describe aws_iam_policy('AWSSupportAccess') do
-      its('attached_roles') { should include "test-role" }
-    end
-
-### attached\_users
-
-The list of usernames of the users attached to the policy.
-
-    describe aws_iam_policy('AWSSupportAccess') do
-      its('attached_users') { should include "test-user" }
-    end
-
-### default\_version\_id
-
-The 'default_version_id' value of the specified policy.
-
-    describe aws_iam_policy('AWSSupportAccess') do
-      its('default_version_id') { should cmp "v1" }
-    end
-
-
-## 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\_attached
-
-The test will pass if the identified policy is attached to at least one IAM user, group, or role.
-
-    describe aws_iam_policy('AWSSupportAccess') do
-      it { should be_attached }
-    end
-
-### be\_attached\_to\_group(GROUPNAME)
-
-The test will pass if the identified policy attached the specified group.
-
-    describe aws_iam_policy('AWSSupportAccess') do
-      it { should be_attached_to_group(GROUPNAME) }
-    end
-
-### be\_attached\_to\_user(USERNAME)
-
-The test will pass if the identified policy attached the specified user.
-
-    describe aws_iam_policy('AWSSupportAccess') do
-      it { should be_attached_to_user(USERNAME) }
-    end
-
-### be\_attached\_to\_role(ROLENAME)
-
-The test will pass if the identified policy attached the specified role.
-
-    describe aws_iam_policy('AWSSupportAccess') do
-      it { should be_attached_to_role(ROLENAME) }
-    end
+---
+title: About the aws_iam_policy Resource
+platform: aws
+---
+
+# aws\_iam\_policy
+
+Use the `aws_iam_policy` InSpec audit resource to test properties of a single managed AWS IAM Policy.
+
+A policy is an entity in AWS that, when attached to an identity or resource, defines their permissions. AWS evaluates these policies when a principal, such as a user, makes a request. Permissions in the policies determine if the request is allowed or denied.
+
+Each IAM Policy is uniquely identified by either its policy\_name or arn.
+
+<br>
+
+## Syntax
+
+An `aws_iam_policy` resource block identifies a policy by policy name.
+
+    # Find a policy by name
+    describe aws_iam_policy('AWSSupportAccess') do
+      it { should exist }
+    end
+
+    # Find a customer-managed by name
+    describe aws_iam_policy('customer-managed-policy') do
+      it { should exist }
+    end
+
+    # Hash syntax for policy name
+    describe aws_iam_policy(policy_name: 'AWSSupportAccess') do
+      it { should exist }
+    end
+
+<br>
+
+## Examples
+
+The following examples show how to use this InSpec audit resource.
+
+### Test that a policy does exist
+
+    describe aws_iam_policy('AWSSupportAccess') do
+      it { should exist }
+    end
+
+### Test that a policy is attached to at least one entity
+
+    describe aws_iam_policy('AWSSupportAccess') do
+      it { should be_attached }
+    end
+
+<br>
+
+## Properties
+
+* `arn`, `attachment_count`, `attached_groups`, `attached_roles`,`attached_users`, `default_version_id`
+
+## Property Examples
+
+### arn
+
+"The ARN identifier of the specified policy. An ARN uniquely identifies the policy within AWS."
+
+    describe aws_iam_policy('AWSSupportAccess') do
+      its('arn') { should cmp "arn:aws:iam::aws:policy/AWSSupportAccess" }
+    end
+
+### attachment\_count
+
+The count of attached entities for the specified policy.
+
+    describe aws_iam_policy('AWSSupportAccess') do
+      its('attachment_count') { should cmp 1 }
+    end
+
+### attached\_groups
+
+The list of groupnames of the groups attached to the policy.
+
+    describe aws_iam_policy('AWSSupportAccess') do
+      its('attached_groups') { should include "test-group" }
+    end
+
+### attached\_roles
+
+The list of rolenames of the roles attached to the policy.
+
+    describe aws_iam_policy('AWSSupportAccess') do
+      its('attached_roles') { should include "test-role" }
+    end
+
+### attached\_users
+
+The list of usernames of the users attached to the policy.
+
+    describe aws_iam_policy('AWSSupportAccess') do
+      its('attached_users') { should include "test-user" }
+    end
+
+### default\_version\_id
+
+The 'default_version_id' value of the specified policy.
+
+    describe aws_iam_policy('AWSSupportAccess') do
+      its('default_version_id') { should cmp "v1" }
+    end
+
+
+## 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\_attached
+
+The test will pass if the identified policy is attached to at least one IAM user, group, or role.
+
+    describe aws_iam_policy('AWSSupportAccess') do
+      it { should be_attached }
+    end
+
+### be\_attached\_to\_group(GROUPNAME)
+
+The test will pass if the identified policy attached the specified group.
+
+    describe aws_iam_policy('AWSSupportAccess') do
+      it { should be_attached_to_group(GROUPNAME) }
+    end
+
+### be\_attached\_to\_user(USERNAME)
+
+The test will pass if the identified policy attached the specified user.
+
+    describe aws_iam_policy('AWSSupportAccess') do
+      it { should be_attached_to_user(USERNAME) }
+    end
+
+### be\_attached\_to\_role(ROLENAME)
+
+The test will pass if the identified policy attached the specified role.
+
+    describe aws_iam_policy('AWSSupportAccess') do
+      it { should be_attached_to_role(ROLENAME) }
+    end

data/docs/resources/aws_iam_role.md.erb

@@ -1,63 +1,63 @@
----
-title: About the aws_iam_role Resource
-platform: aws
----
-
-# aws\_iam\_role
-
-Use the `aws_iam_role` InSpec audit resource to test properties of a single IAM Role. A Role is a collection of permissions that may be temporarily assumed by a user, EC2 Instance, Lambda Function, or certain other resources.
-
-<br>
-
-## Syntax
-
-    # Ensure that a certain role exists by name
-    describe aws_iam_role('my-role') do
-      it { should exist }
-    end
-
-<br>
-
-## Resource Parameters
-
-### role\_name
-
-This resource expects a single parameter that uniquely identifies the IAM Role, the Role Name. You may pass it as a string, or as the value in a hash:
-
-    describe aws_iam_role('my-role') do
-      it { should exist }
-    end
-    # Same
-    describe aws_iam_role(role_name: 'my-role') do
-      it { should exist }
-    end
-
-<br>
-
-## Properties
-
-### description
-
-A textual description of the IAM Role.
-
-    describe aws_iam_role('my-role') do
-      its('description') { should be('Our most important Role')}
-    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
-
-Indicates that the Role Name provided was found. Use `should_not` to test for IAM Roles that should not exist.
-
-    describe aws_iam_role('should-be-there') do
-      it { should exist }
-    end
-
-    describe aws_iam_role('should-not-be-there') do
-      it { should_not exist }
-    end
+---
+title: About the aws_iam_role Resource
+platform: aws
+---
+
+# aws\_iam\_role
+
+Use the `aws_iam_role` InSpec audit resource to test properties of a single IAM Role. A Role is a collection of permissions that may be temporarily assumed by a user, EC2 Instance, Lambda Function, or certain other resources.
+
+<br>
+
+## Syntax
+
+    # Ensure that a certain role exists by name
+    describe aws_iam_role('my-role') do
+      it { should exist }
+    end
+
+<br>
+
+## Resource Parameters
+
+### role\_name
+
+This resource expects a single parameter that uniquely identifies the IAM Role, the Role Name. You may pass it as a string, or as the value in a hash:
+
+    describe aws_iam_role('my-role') do
+      it { should exist }
+    end
+    # Same
+    describe aws_iam_role(role_name: 'my-role') do
+      it { should exist }
+    end
+
+<br>
+
+## Properties
+
+### description
+
+A textual description of the IAM Role.
+
+    describe aws_iam_role('my-role') do
+      its('description') { should be('Our most important Role')}
+    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
+
+Indicates that the Role Name provided was found. Use `should_not` to test for IAM Roles that should not exist.
+
+    describe aws_iam_role('should-be-there') do
+      it { should exist }
+    end
+
+    describe aws_iam_role('should-not-be-there') do
+      it { should_not exist }
+    end

data/docs/resources/aws_iam_root_user.md.erb

@@ -1,58 +1,70 @@
----
-title: About the aws_iam_root_user Resource
-platform: aws
----
-
-# aws\_iam\_root\_user
-
-Use the `aws_iam_root_user` InSpec audit resource to test properties of the root user (owner of the account).
-
-To test properties of all or multiple users, use the `aws_iam_users` resource.
-
-To test properties of a specific AWS user use the `aws_iam_user` resource.
-
-<br>
-
-## Syntax
-
-An `aws_iam_root_user` resource block requires no parameters but has several matchers
-
-    describe aws_iam_root_user do
-      its { should have_mfa_enabled }
-    end
-
-<br>
-
-## Examples
-
-The following examples show how to use this InSpec audit resource.
-
-### Test that the AWS root account has at-least one access key
-
-    describe aws_iam_root_user do
-      it { should have_access_key }
-    end
-
-### Test that the AWS root account has Multi-Factor Authentication enabled
-
-    describe aws_iam_root_user do
-      it { should have_mfa_enabled }
-    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/).
-
-### have\_mfa\_enabled
-
-The `have_mfa_enabled` matcher tests if the AWS root user has Multi-Factor Authentication enabled, requiring them to enter a secondary code when they login to the web console.
-
-    it { should have_mfa_enabled }
-
-### have\_access\_key
-
-The `have_access_key` matcher tests if the AWS root user has at least one access key.
-
-    it { should have_access_key }
+---
+title: About the aws_iam_root_user Resource
+platform: aws
+---
+
+# aws\_iam\_root\_user
+
+Use the `aws_iam_root_user` InSpec audit resource to test properties of the root user (owner of the account).
+
+To test properties of all or multiple users, use the `aws_iam_users` resource.
+
+To test properties of a specific AWS user use the `aws_iam_user` resource.
+
+<br>
+
+## Syntax
+
+An `aws_iam_root_user` resource block requires no parameters but has several matchers
+
+    describe aws_iam_root_user do
+      its { should have_mfa_enabled }
+    end
+
+<br>
+
+## Examples
+
+The following examples show how to use this InSpec audit resource.
+
+### Test that the AWS root account has at-least one access key
+
+    describe aws_iam_root_user do
+      it { should have_access_key }
+    end
+
+### Test that the AWS root account has Multi-Factor Authentication enabled
+
+    describe aws_iam_root_user do
+      it { should have_mfa_enabled }
+    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/).
+
+### have\_mfa\_enabled
+
+The `have_mfa_enabled` matcher tests if the AWS root user has Multi-Factor Authentication enabled, requiring them to enter a secondary code when they login to the web console.
+
+    it { should have_mfa_enabled }
+
+### have\_hardware\_mfa\_enabled
+
+The `have_hardware_mfa_enabled` matcher tests if the AWS root user has Hardware Multi-Factor Authentication device enabled, requiring them to enter a secondary code when they login to the web console.
+
+    it { should have_hardware_mfa_enabled }
+
+### have\_virtual\_mfa\_enabled
+
+The `have_virtual_mfa_enabled` matcher tests if the AWS root user has Virtual Multi-Factor Authentication device enabled, requiring them to enter a secondary code when they login to the web console.
+
+    it { should have_virtual_mfa_enabled }
+
+### have\_access\_key
+
+The `have_access_key` matcher tests if the AWS root user has at least one access key.
+
+    it { should have_access_key }