inspec 2.1.0 → 2.1.10

data/docs/resources/aws_sns_subscription.md.erb

@@ -0,0 +1,125 @@
+---
+title: About the aws_sns_subscription Resource
+---
+
+# aws\_sns\_subscription
+
+Use the `aws_sns_subscription` InSpec audit resource to test detailed properties of a AWS SNS Subscription.
+
+<br>
+
+## Syntax
+
+An `aws_sns_subscription` resource block uses resource parameters to search for a SNS Subscription, and then tests that subscriptions properties.  If no Subscriptions match, no error is raised, but the `exists` matcher will return `false` and all properties will be `nil`.
+
+    describe aws_sns_subscription('arn:aws:sns:us-east-1::test-topic-01:b214aff5-a2c7-438f-a753-8494493f2ff6') do
+      it { should exist }
+    end
+
+<br>
+
+## Examples
+
+The following examples show how to use this InSpec audit resource.
+
+As this is the initial release of `aws_sns_subscription`, its limited functionality precludes examples.
+
+<br>
+
+## Resource Parameters
+
+This InSpec resource accepts the following parameters, which are used to search for the Security Group.
+
+### subscription\_arn
+
+The ARN (Amazon Resource Name) of the AWS SNS Subscription.
+
+    # Using Hash syntax 
+    describe aws_sns_subscription(subscription_arn: 'arn:aws:sns:us-east-1::test-topic-01:b214aff5-a2c7-438f-a753-8494493f2ff6') do
+      it { should exist }
+    end
+
+    # Or omit hash syntax, rely on it being the default parameter
+    describe aws_sns_subscription('arn:aws:sns:us-east-1::test-topic-01:b214aff5-a2c7-438f-a753-8494493f2ff6') do
+      it { should exist }
+    end
+
+<br>
+
+## Matchers
+
+### exists
+
+The control will pass if the specified Aws Subscription was found.  Use should_not if you want to verify that the specified Subscription does not exist.
+
+    # Test that a specific subscription exists. 
+    describe aws_sns_subscription(subscription_arn: 'arn:aws:sns:us-east-1::test-topic-01:b214aff5-a2c7-438f-a753-8494493f2ff6')
+      it { should exist }
+    end   
+
+    # Test that a Subscription does not exist.
+    describe aws_sns_subscription(subscription_arn: 'arn:aws:sns:us-east-1::NOGOOD:b214aff5-a2c7-438f-a753-8494493f2ff6')
+      it { should_not exist }
+    end 
+    
+### be\_confirmation\_authenticated
+
+Provides whether or not the subscription confirmation request was authenticated.
+
+    describe aws_sns_subscription(subscription_arn: 'arn:aws:sns:us-east-1::NOGOOD:b214aff5-a2c7-438f-a753-8494493f2ff6')
+      it { should be_confirmation_authenticated }
+    end 
+
+### have\_raw\_message\_delivery
+
+Provides whether or not the original message is passed as is, not formatted as a json or yaml.
+
+    describe aws_sns_subscription(subscription_arn: 'arn:aws:sns:us-east-1::NOGOOD:b214aff5-a2c7-438f-a753-8494493f2ff6')
+      it { should have_raw_message_delivery }
+    end 
+
+## Properties
+
+### endpoint
+
+Provides the destination that the SNS Topic will send notifications to.
+
+    # Inspect the endpoint
+    describe aws_sns_subscription(subscription_arn: 'arn:aws:sns:us-east-1::test-topic-01:b214aff5-a2c7-438f-a753-8494493f2ff6' ) do
+      # If protocol is 'sms', this should be a phone number:
+      its('endpoint') { should cmp '+16105551234' }
+      # If protocol is 'email' or 'email-json', endpoint should be an email address
+      its('endpoint') { should cmp 'myemail@example.com' }
+      # If protocal is 'http', endpoint should be a URL beginning with 'https://'
+      its('endpoint') { should cmp 'https://www.exampleurl.com' }
+      # If the protocol is 'lambda', its endpoint should be the ARN of a AWS Lambda function
+      its('endpoint') { should cmp 'rn:aws:lambda:us-east-1:account-id:function:myfunction' }
+    end
+    
+### owner
+
+Provides the AWS Owners ID. 
+
+    # Inspect the owners ID
+    describe aws_sns_subscription(subscription_arn: 'arn:aws:sns:us-east-1::test-topic-01:b214aff5-a2c7-438f-a753-8494493f2ff6' ) do
+      its('owner') { should cmp '12345678' }
+    end
+    
+### protocol
+
+Provides the Subscriptions protocol used. For example http, https, email, email-json, sqs, etc.  For more information about protocols please visit https://docs.aws.amazon.com/sns/latest/api/API_Subscribe.html 
+
+    # Inspect the endpoint
+    describe aws_sns_subscription(subscription_arn: 'arn:aws:sns:us-east-1::test-topic-01:b214aff5-a2c7-438f-a753-8494493f2ff6' ) do
+      its('protocol') { should cmp 'sqs' }
+    end
+
+### topic\_arn
+
+Provides the SNS Topic arn that the Subscription is associated with.
+
+    # Inspect the topic arn
+    describe aws_sns_subscription(subscription_arn: 'arn:aws:sns:us-east-1::test-topic-01:b214aff5-a2c7-438f-a753-8494493f2ff6' ) do
+      its('topic_arn') { should cmp 'arn:aws:sns:us-east-1::test-topic-01' }
+    end
+    

data/docs/resources/aws_sns_topic.md.erb

@@ -1,63 +1,63 @@
----
-title: About the aws_sns_topic Resource
----
-
-# aws\_sns\_topic
-
-Use the `aws_sns_topic` InSpec audit resource to test properties of a single AWS Simple Notification Service Topic.  SNS topics are channels for related events. AWS resources place events in the SNS topic, while other AWS resources _subscribe_ to receive notifications when new events have appeared.
-
-<br>
-
-## Syntax
-
-    # Ensure that a topic exists and has at least one subscription
-    describe aws_sns_topic('arn:aws:sns:*::my-topic-name') do
-      it { should exist }
-      its('confirmed_subscription_count') { should_not be_zero }
-    end
-
-    # You may also use has syntax to pass the ARN
-    describe aws_sns_topic(arn: 'arn:aws:sns:*::my-topic-name') do
-      it { should exist }
-    end
-
-## Resource Parameters
-
-### ARN
-
-This resource expects a single parameter that uniquely identifes the SNS Topic, an ARN. Amazon Resource Names for SNS topics have the format `arn:aws:sns:region:account-id:topicname`.  AWS requires a fully-specified ARN for looking up an SNS topic.  The account ID and region are required.  Wildcards are not permitted.
-
-See also the [AWS documentation on ARNs](http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html).
-
-<br>
-
-## Properties
-
-### confirmed\_subscription\_count
-
-An integer indicating the number of currently active subscriptions.
-
-    # Make sure someone is listening
-    describe aws_sns_topic('arn:aws:sns:*::my-topic-name') do
-      its('confirmed_subscription_count') { should_not be_zero}
-    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 ARN provided was found.  Use `should_not` to test for SNS topics that should not exist.
-
-    # Expect good news
-    describe aws_sns_topic('arn:aws:sns:*::good-news') do
-      it { should exist }
-    end
-
-    # No bad news allowed
-    describe aws_sns_topic('arn:aws:sns:*::bad-news') do
-      it { should_not exist }
-    end
+---
+title: About the aws_sns_topic Resource
+---
+
+# aws\_sns\_topic
+
+Use the `aws_sns_topic` InSpec audit resource to test properties of a single AWS Simple Notification Service Topic.  SNS topics are channels for related events. AWS resources place events in the SNS topic, while other AWS resources _subscribe_ to receive notifications when new events have appeared.
+
+<br>
+
+## Syntax
+
+    # Ensure that a topic exists and has at least one subscription
+    describe aws_sns_topic('arn:aws:sns:*::my-topic-name') do
+      it { should exist }
+      its('confirmed_subscription_count') { should_not be_zero }
+    end
+
+    # You may also use has syntax to pass the ARN
+    describe aws_sns_topic(arn: 'arn:aws:sns:*::my-topic-name') do
+      it { should exist }
+    end
+
+## Resource Parameters
+
+### ARN
+
+This resource expects a single parameter that uniquely identifies the SNS Topic, an ARN. Amazon Resource Names for SNS topics have the format `arn:aws:sns:region:account-id:topicname`.  AWS requires a fully-specified ARN for looking up an SNS topic.  The account ID and region are required.  Wildcards are not permitted.
+
+See also the [AWS documentation on ARNs](http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html).
+
+<br>
+
+## Properties
+
+### confirmed\_subscription\_count
+
+An integer indicating the number of currently active subscriptions.
+
+    # Make sure someone is listening
+    describe aws_sns_topic('arn:aws:sns:*::my-topic-name') do
+      its('confirmed_subscription_count') { should_not be_zero}
+    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 ARN provided was found.  Use `should_not` to test for SNS topics that should not exist.
+
+    # Expect good news
+    describe aws_sns_topic('arn:aws:sns:*::good-news') do
+      it { should exist }
+    end
+
+    # No bad news allowed
+    describe aws_sns_topic('arn:aws:sns:*::bad-news') do
+      it { should_not exist }
+    end

data/docs/resources/aws_sns_topics.md.erb

@@ -0,0 +1,52 @@
+---
+title: About the aws_sns_topics Resource
+---
+
+# aws\_sns\_topics
+Use the `aws_sns_topics` InSpec audit resource to test all or a group of the SNS Topic ARNs in an account.
+
+User the 'aws_sns_topic' InSpec audit resource to test a single SNS Topic in an account.
+
+<br>
+
+## Syntax
+
+An `aws_sns_topics` resource block takes no filter conditions.
+
+    # Get all SNS Topic arns
+    describe aws_sns_topics do
+      its('topic_arns') { should include 'arn:aws:sns:us-east-1:333344445555:MyTopic' }
+    end
+
+<br>
+
+## Examples
+
+The following examples show how to use this InSpec audit resource.
+
+As this is the initial release of `aws_sns_topics`, its limited functionality precludes examples.
+
+<br>
+
+## Matchers
+
+### exists
+
+The control will pass if the filter returns at least one result. Use should_not if you expect zero matches.
+
+    # Test if there is any SNS Topics
+    describe aws_sns_topics
+      it { should exist }
+    end
+
+
+## Properties
+
+### topic\_arns
+
+Provides an array of all SNS Topic arns.
+
+    # Test that a specific SNS Topic exists
+    describe aws_sns_topics do
+      its('topic_arns') { should include 'arn:aws:sns:us-east-1:333344445555:MyTopic' }
+    end

data/docs/resources/aws_subnet.md.erb

@@ -1,134 +1,134 @@
----
-title: About the aws_subnet Resource
-platform: aws
----
-
-# aws\_subnet
-
-Use the `aws_subnet` InSpec audit resource to test properties of a vpc subnet.
-
-To test properties of a single VPC subnet, use the `aws_subnet` resource.
-
-To test properties of all or a group of VPC subnets, use the `aws_subnets` resource.
-
-<br>
-
-## Syntax
-
-An `aws_subnet` resource block uses the parameter to select a VPC and a subnet in the VPC.
-
-    describe aws_subnet(subnet_id: 'subnet-1234567') do
-      it { should exist }
-      its('cidr_block') { should eq '10.0.1.0/24' }
-    end
-
-<br>
-
-## Resource Parameters
-
-This InSpec resource accepts the following parameters, which are used to search for the VPCs subnet.
-
-### subnet\_id
-
-A string identifying the subnet that the VPC contains.
-
-    # This will error if there is more than the default SG
-    describe aws_subnet(subnet_id: 'subnet-12345678') do
-      it { should exist }    
-    end
-
-<br>
-
-## Properties
-
-* `availavailability_zone`, `available_ip_address_count`, `cidr_block`, `subnet_id`, `vpc_id`
-
-<br>
-
-## Property Examples
-
-### availability\_zone
-
-Provides the Availability Zone of the subnet.
-
-    describe aws_subnet(subnet_id: 'subnet-12345678') do
-      its('availability_zone') { should eq 'us-east-1c' }    
-    end
-
-### available\_ip\_address\_count
-
-Provides the number of available IPv4 addresses on the subnet.
-
-    describe aws_subnet(subnet_id: 'subnet-12345678') do
-      its('available_ip_address_count') { should eq 251 }    
-    end
-
-### cidr\_block
-
-Provides the block of ip addresses specified to the subnet.
-
-    describe aws_subnet(subnet_id: 'subnet-12345678') do
-      its('cidr_block') { should eq '10.0.1.0/24' }    
-    end
-
-### subnet\_id
-
-Provides the ID of the Subnet.
-
-    describe aws_subnet(subnet_id: 'subnet-12345678') do
-      its('subnet_id') { should eq 'subnet-12345678' }    
-    end
-
-### vpc\_id
-
-Provides the ID of the VPC the subnet is in.
-
-    describe aws_subnet(subnet_id: 'subnet-12345678') do
-      its('vpc_id') { should eq 'vpc-12345678' }    
-    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/).
-
-### assigning\_ipv\_6\_address\_on\_creation
-
-Detects if the network interface on the subnet accepts IPv6 addresses.
-
-    describe aws_subnet(subnet_id: 'subnet-12345678') do
-      it { should be_assigning_ipv_6_address_on_creation }    
-    end
-    
-### available
-
-Provides the current state of the subnet.
-
-    describe aws_subnet(subnet_id: 'subnet-12345678') do
-      it { should be_available }    
-    end
-
-### default\_for\_az
-
-Detects if the subnet is the default subnet for the Availability Zone.
-
-    describe aws_subnet(subnet_id: 'subnet-12345678') do
-      it { should be_default_for_az }    
-    end
-
-### exist
-
-The `exist` matcher indicates that a subnet exists for the specified vpc.
-
-    describe aws_subnet(subnet_id: 'subnet-12345678') do
-      it { should exist }
-    end
-    
-### mapping\_public\_ip\_on\_launch
-
-Provides the VPC ID for the subnet.
-
-    describe aws_subnet(subnet_id: 'subnet-12345678') do
-      it { should be_mapping_public_ip_on_launch }    
-    end
+---
+title: About the aws_subnet Resource
+platform: aws
+---
+
+# aws\_subnet
+
+Use the `aws_subnet` InSpec audit resource to test properties of a vpc subnet.
+
+To test properties of a single VPC subnet, use the `aws_subnet` resource.
+
+To test properties of all or a group of VPC subnets, use the `aws_subnets` resource.
+
+<br>
+
+## Syntax
+
+An `aws_subnet` resource block uses the parameter to select a VPC and a subnet in the VPC.
+
+    describe aws_subnet(subnet_id: 'subnet-1234567') do
+      it { should exist }
+      its('cidr_block') { should eq '10.0.1.0/24' }
+    end
+
+<br>
+
+## Resource Parameters
+
+This InSpec resource accepts the following parameters, which are used to search for the VPCs subnet.
+
+### subnet\_id
+
+A string identifying the subnet that the VPC contains.
+
+    # This will error if there is more than the default SG
+    describe aws_subnet(subnet_id: 'subnet-12345678') do
+      it { should exist }    
+    end
+
+<br>
+
+## Properties
+
+* `availability_zone`, `available_ip_address_count`, `cidr_block`, `subnet_id`, `vpc_id`
+
+<br>
+
+## Property Examples
+
+### availability\_zone
+
+Provides the Availability Zone of the subnet.
+
+    describe aws_subnet(subnet_id: 'subnet-12345678') do
+      its('availability_zone') { should eq 'us-east-1c' }    
+    end
+
+### available\_ip\_address\_count
+
+Provides the number of available IPv4 addresses on the subnet.
+
+    describe aws_subnet(subnet_id: 'subnet-12345678') do
+      its('available_ip_address_count') { should eq 251 }    
+    end
+
+### cidr\_block
+
+Provides the block of ip addresses specified to the subnet.
+
+    describe aws_subnet(subnet_id: 'subnet-12345678') do
+      its('cidr_block') { should eq '10.0.1.0/24' }    
+    end
+
+### subnet\_id
+
+Provides the ID of the Subnet.
+
+    describe aws_subnet(subnet_id: 'subnet-12345678') do
+      its('subnet_id') { should eq 'subnet-12345678' }    
+    end
+
+### vpc\_id
+
+Provides the ID of the VPC the subnet is in.
+
+    describe aws_subnet(subnet_id: 'subnet-12345678') do
+      its('vpc_id') { should eq 'vpc-12345678' }    
+    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/).
+
+### assigning\_ipv\_6\_address\_on\_creation
+
+Detects if the network interface on the subnet accepts IPv6 addresses.
+
+    describe aws_subnet(subnet_id: 'subnet-12345678') do
+      it { should be_assigning_ipv_6_address_on_creation }    
+    end
+    
+### available
+
+Provides the current state of the subnet.
+
+    describe aws_subnet(subnet_id: 'subnet-12345678') do
+      it { should be_available }    
+    end
+
+### default\_for\_az
+
+Detects if the subnet is the default subnet for the Availability Zone.
+
+    describe aws_subnet(subnet_id: 'subnet-12345678') do
+      it { should be_default_for_az }    
+    end
+
+### exist
+
+The `exist` matcher indicates that a subnet exists for the specified vpc.
+
+    describe aws_subnet(subnet_id: 'subnet-12345678') do
+      it { should exist }
+    end
+    
+### mapping\_public\_ip\_on\_launch
+
+Provides the VPC ID for the subnet.
+
+    describe aws_subnet(subnet_id: 'subnet-12345678') do
+      it { should be_mapping_public_ip_on_launch }    
+    end