aws_canary_sensor_capture

This is a terraform module that reaches out to Canary's web API and pulls sensor data for each Canary device associated with an account every hour leveraging AWS Lambda, Cloudwatch events, DynmaoDB, API Gateway, and KMS.

Input variables:

• aws_region - The AWS region for your resources, which defaults to us-west-2
• rate_expression - The AWS Cloudwatch Scheduled Events rate expression, which defaults to rate(1 hour)
• kms_arn - The ARN of the AWS KMS Key used for encryption/decryption of your Canary password and the bearer token when they are stored in DynamoDB
• canary_username - Your Canary username (an email address)
• canary_encrytped_password - Your Canary password encrypted with the AWS KMS Key referenced in the argument kms_arn (see the sections below on Creating a KMS Key and Usage if unsure)
• number_of_generated_api_keys - The number of API keys to generate for use against the API, which defaults to 1
• usage_plan_per_user_quota_offset - The number of requests subtracted from the given limit in the initial time period, defaults to 0 (value must be zero for usage_plan_per_user_quota_period of DAY)
• usage_plan_per_user_quota - The maximum number of requests that can be made in a given time period, defaults to 25
• usage_plan_per_user_quota_period - The time period in which the limit applies. Valid values are DAY, WEEK or MONTH, defaults to DAY
• usage_plan_rate_limit - The API request steady-state rate limit, defaults to 100
• usage_plan_burst_limit - The API request burst limit, the maximum rate limit over a time ranging from one to a few seconds, depending upon whether the underlying token bucket is at its full capacity, defaults to 150

Outputs:

• api_keys - A list of API keys
• api_gateway_endpoint - The API Gateway endpoint

Example:

Basic example - In your terraform code add something like this:

module "canary" {
  source = "github.com/joshdurbin/aws_canary_sensor_capture"
  kms_arn = "arn:aws:kms:us-west-2:abc123abc123:key/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee"
  canary_username = "bobsdinner@gmail.com"
  canary_encrytped_password = "..."
}

output "my_canary_api_keys" {
  value = "${module.canary.api_keys}"
}

output "my_canary_api_gateway_endpoint" {
  value = "${module.canary.api_gateway_endpoint}"
}

Creating KMS Key:

To create a KMS key, do the following...

1. Make sure your local AWS CLI is properly setup
2. Create a KMS key by executing aws kms create-key, which will return something like:

{
    "KeyMetadata": {
        "Origin": "AWS_KMS", 
        "KeyId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
        "Description": "", 
        "Enabled": true, 
        "KeyUsage": "ENCRYPT_DECRYPT", 
        "KeyState": "Enabled", 
        "CreationDate": 1490166961.32, 
        "Arn": "arn:aws:kms:us-west-2:abc123abc123:key/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
        "AWSAccountId": "abc123abc123"
    }
}

The Arn referenced in the JSON response body should be used as argument #1 in the usage instructions.

Encrypting plaintext input with a KMS Key:

To encrypt your password with your KMS key, do the following...

1. Make sure your local AWS CLI is properly setup and that you've already created a KMS key
2. Execute aws kms encrypt --key-id aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee --plaintext "your_canary_password" where the key-id references your Key and "your_canary_password" is replaced with your password. This command will result in a JSON response body like:

{
    "KeyId": "arn:aws:kms:us-west-2:abc123abc123:key/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", 
    "CiphertextBlob": "......"
}

The CiphertextBlob referenced in the JSON response body should be used as argument #3 in the usage instructions.

Authors

Created and maintained by Josh Durbin.

License

Apache 2 Licensed. See LICENSE for full details.