inspec 2.0.16 → 2.0.17

data/docs/resources/aws_iam_role.md.erb

@@ -1,65 +1,65 @@
----
-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,58 @@
----
-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\_access\_key
+
+The `have_access_key` matcher tests if the AWS root user has at least one access key.
+
+    it { should have_access_key }

data/docs/resources/aws_iam_user.md.erb

@@ -1,64 +1,64 @@
----
-title: About the aws_iam_user Resource
-platform: aws
----
-
-# aws\_iam\_user
-
-Use the `aws_iam_user` InSpec audit resource to test properties of a single AWS IAM user.
-
-To test properties of more than one user, use the `aws_iam_users` resource.
-
-To test properties of the special AWS root user (which owns the account), use the `aws_iam_root_user` resource.
-
-<br>
-
-## Syntax
-
-An `aws_iam_user` resource block declares a user by name, and then lists tests to be performed.
-
-    describe aws_iam_user(name: 'test_user') do
-      it { should exist }
-    end
-
-<br>
-
-## Examples
-
-The following examples show how to use this InSpec audit resource.
-
-### Test that a user does not exist
-
-    describe aws_iam_user(name: 'gone') do
-      it { should_not exist }
-    end
-
-### Test that a user has multi-factor authentication enabled
-
-    describe aws_iam_user(name: 'test_user') do
-      it { should have_mfa_enabled }
-    end
-
-### Test that a service user does not have a password
-
-    describe aws_iam_user(name: 'test_user') do
-      it { should have_console_password }
-    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\_console\_password
-
-The `have_console_password` matcher tests if the user has a password that could be used to log into the AWS web console.
-
-    it { should have_console_password }
-
-### have\_mfa\_enabled
-
-The `have_mfa_enabled` matcher tests if the 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 }
+---
+title: About the aws_iam_user Resource
+platform: aws
+---
+
+# aws\_iam\_user
+
+Use the `aws_iam_user` InSpec audit resource to test properties of a single AWS IAM user.
+
+To test properties of more than one user, use the `aws_iam_users` resource.
+
+To test properties of the special AWS root user (which owns the account), use the `aws_iam_root_user` resource.
+
+<br>
+
+## Syntax
+
+An `aws_iam_user` resource block declares a user by name, and then lists tests to be performed.
+
+    describe aws_iam_user(name: 'test_user') do
+      it { should exist }
+    end
+
+<br>
+
+## Examples
+
+The following examples show how to use this InSpec audit resource.
+
+### Test that a user does not exist
+
+    describe aws_iam_user(name: 'gone') do
+      it { should_not exist }
+    end
+
+### Test that a user has multi-factor authentication enabled
+
+    describe aws_iam_user(name: 'test_user') do
+      it { should have_mfa_enabled }
+    end
+
+### Test that a service user does not have a password
+
+    describe aws_iam_user(name: 'test_user') do
+      it { should have_console_password }
+    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\_console\_password
+
+The `have_console_password` matcher tests if the user has a password that could be used to log into the AWS web console.
+
+    it { should have_console_password }
+
+### have\_mfa\_enabled
+
+The `have_mfa_enabled` matcher tests if the 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 }

data/docs/resources/aws_iam_users.md.erb

@@ -1,90 +1,90 @@
----
-title: About the aws_iam_users Resource
-platform: aws
----
-
-# aws\_iam\_users
-
-Use the `aws_iam_users` InSpec audit resource to test properties of a all or multiple users.
-
-To test properties of a single user, use the `aws_iam_user` resource.
-
-To test properties of the special AWS root user (which owns the account), use the `aws_iam_root_user` resource.
-
-<br>
-
-## Syntax
-
-An `aws_iam_users` resource block users a filter to select a group of users and then tests that group
-
-    describe aws_iam_users.where(has_mfa_enabled?: false) do
-      it { should_not exist }
-    end
-
-<br>
-
-## Filter Criteria
-
-* `has_mfa_enabled`, `has_console_password`, `password_ever_used?`, `password_never_used?`, `password_last_used_days_ago`, `username`
-
-<br>
-
-## Examples
-
-The following examples show how to use this InSpec audit resource.
-
-### Test that all users have Multi-Factor Authentication enabled
-
-    describe aws_iam_users.where(has_mfa_enabled?: false) do
-      it { should_not exist }
-    end
-
-### Test that at least one user has a console password to log into the AWS web console
-
-    describe aws_iam_users.where(has_console_password?: true) do
-      it { should exist }
-    end
-
-### Test that all users who have a console password have Multi-Factor Authentication enabled
-
-    console_users_without_mfa = aws_iam_users
-                                .where(has_console_password?: true)
-                                .where(has_mfa_enabled?: false)
-
-    describe console_users_without_mfa do
-      it { should_not exist }
-    end
-
-### Test that all users who have a console password have used it at least once
-
-    console_users_with_unused_password = aws_iam_users
-                                         .where(has_console_password?: true)
-                                         .where(password_never_used?: false)
-
-    describe console_users_with_unused_password do
-      it { should_not exist }
-    end
-
-### Test that at least one user exists who has a console password and has used it at least once
-
-    console_users_with_used_password = aws_iam_users
-                                       .where(has_console_password?: true)
-                                       .where(password_ever_used?: false)
-
-    describe console_users_with_used_password do
-      it { should exist }
-    end
-
-
-### Test that users with passwords that have not been used for 90 days do not
-
-    describe aws_iam_users.where { password_last_used_days_ago > 90 } do
-      it { should_not exist }
-    end
-
-<br>
-
-## Matchers
-
-This InSpec audit resource has no specific matchers. 
+---
+title: About the aws_iam_users Resource
+platform: aws
+---
+
+# aws\_iam\_users
+
+Use the `aws_iam_users` InSpec audit resource to test properties of a all or multiple users.
+
+To test properties of a single user, use the `aws_iam_user` resource.
+
+To test properties of the special AWS root user (which owns the account), use the `aws_iam_root_user` resource.
+
+<br>
+
+## Syntax
+
+An `aws_iam_users` resource block users a filter to select a group of users and then tests that group
+
+    describe aws_iam_users.where(has_mfa_enabled?: false) do
+      it { should_not exist }
+    end
+
+<br>
+
+## Filter Criteria
+
+* `has_mfa_enabled`, `has_console_password`, `password_ever_used?`, `password_never_used?`, `password_last_used_days_ago`, `username`
+
+<br>
+
+## Examples
+
+The following examples show how to use this InSpec audit resource.
+
+### Test that all users have Multi-Factor Authentication enabled
+
+    describe aws_iam_users.where(has_mfa_enabled?: false) do
+      it { should_not exist }
+    end
+
+### Test that at least one user has a console password to log into the AWS web console
+
+    describe aws_iam_users.where(has_console_password?: true) do
+      it { should exist }
+    end
+
+### Test that all users who have a console password have Multi-Factor Authentication enabled
+
+    console_users_without_mfa = aws_iam_users
+                                .where(has_console_password?: true)
+                                .where(has_mfa_enabled?: false)
+
+    describe console_users_without_mfa do
+      it { should_not exist }
+    end
+
+### Test that all users who have a console password have used it at least once
+
+    console_users_with_unused_password = aws_iam_users
+                                         .where(has_console_password?: true)
+                                         .where(password_never_used?: false)
+
+    describe console_users_with_unused_password do
+      it { should_not exist }
+    end
+
+### Test that at least one user exists who has a console password and has used it at least once
+
+    console_users_with_used_password = aws_iam_users
+                                       .where(has_console_password?: true)
+                                       .where(password_ever_used?: false)
+
+    describe console_users_with_used_password do
+      it { should exist }
+    end
+
+
+### Test that users with passwords that have not been used for 90 days do not
+
+    describe aws_iam_users.where { password_last_used_days_ago > 90 } do
+      it { should_not exist }
+    end
+
+<br>
+
+## Matchers
+
+This InSpec audit resource has no specific matchers. 
 For a full list of available matchers, please visit our [matchers page](https://www.inspec.io/docs/reference/matchers/).