aws-samples / aws-waf-ipset-auto-update-aws-ip-ranges Goto Github PK

This project creates two regional AWS WAF IP sets and automatically updates them with AWS service's IP ranges from the ip-ranges.json file. The ranges are configurable as well as the regions for EC2 ranges. Use cases include allowing CloudFront requests, Route53 health checker and EC2 IP range (which includes AWS Lambda and CloudWatch Synthetics). The IP sets are created in the region where the CloudFormation stack is created and the IP addresses in the IP sets are completely replaced on every update.

The CloudFormation template cloudformation/template.yml creates a stack with the following resources:

1. Two AWS WAF IP sets. One for IPv4 addresses and one for IPv6 addresses.
2. AWS Lambda function with customizable environment variables. The function's code is in lambda/update_aws_waf_ipset.py and is written in Python.
3. Lambda function's execution role.
4. SNS subscription and Lambda invocation permissions for the arn:aws:sns:us-east-1:806199016981:AmazonIpSpaceChanged SNS topic.

                          +-----------------+         +----------------+
                          | Lambda          |         |                |
                          | Execution Role  |    +--->+AWS WAF IPv4 Set|
                          +--------+--------+    |    |                |
                                   |             |    +----------------+
                                   |             |
+--------------------+    +--------+--------+    |
|SNS Topic           +--->+ Lambda function +----+
|AmazonIpSpaceChanged|    +--------+--------+    |
+--------------------+             |             |    +----------------+
                                   |             |    |                |
                                   v             +--->+AWS WAF IPv6 Set|
                          +--------+--------+         |                |
                          | CloudWatch Logs |         +----------------+
                          +-----------------+

These are the overall steps to deploy:

1. Create an S3 bucket to store the code. The bucket must be in the same region where the stack will be created.
2. Package the Lambda code into a .zip file.
3. Upload the packaged code to S3.
4. Create the CloudFormation stack.
5. Trigger a test Lambda invocation.
6. Reference the IP sets in a web ACL rule or rule group
7. Clean-up

To simplify setup and deployment, assign the values to the following variables. Replace the values according to your deployment options.

REGION=<region>
CFN_STACK_NAME=<Stack name>
BUCKET_NAME=<bucket name>
OBJECT_NAME=auto-update_aws_waf_ipset.zip

Skip this step if you already have an S3 bucket to store the code.

To create the S3 bucket, run the following commands, depending on the region:

For us-east-1:

aws s3api create-bucket --bucket $BUCKET_NAME \
    --region $REGION

For any other region outside of us-east-1:

aws s3api create-bucket \
    --bucket $BUCKET_NAME \
    --region $REGION \
    --create-bucket-configuration LocationConstraint=$REGION

Run the following commands from the repository root:

cp lambda/update_aws_waf_ipset.py .
zip $OBJECT_NAME update_aws_waf_ipset.py

aws s3 cp $OBJECT_NAME s3://$BUCKET_NAME

The CloudFormation template has the following input parameters.

• LambdaCodeS3Bucket: The S3 bucket where the Lambda function's packaged code is stored.
• LambdaCodeS3Object: The S3 object name of Lambda function's packaged code. This must be a .zip file.
• IPV4SetNameSuffix: Enter the name for the AWS WAF IPv6 set. Default is IPv4Set.
• IPV6SetNameSuffix: Enter the name for the AWS WAF IPv6 set. Default is IPv6Set.
• SERVICES: Enter the name of the AWS services to add, separated by commas and as explained in https://docs.aws.amazon.com/general/latest/gr/aws-ip-ranges.html. The default is ROUTE53_HEALTHCHECKS,CLOUDFRONT.
• EC2REGIONS: For the "EC2" service only, specify the AWS regions to add, separated by commas. Use 'all' to add all AWS regions. Default is all.

Use the command below to create the stack with the default values. You can update the parameter values as required.

aws cloudformation create-stack \
  --stack-name $CFN_STACK_NAME \
  --template-body file://cloudformation/template.yml \
  --region $REGION \
  --parameters ParameterKey=LambdaCodeS3Bucket,ParameterValue=$BUCKET_NAME \
  ParameterKey=LambdaCodeS3Object,ParameterValue=$OBJECT_NAME \
  --capabilities CAPABILITY_IAM

Run the following command and wait to check if the CloudFormation stack is created successfully. The command exits with no error or output when the stack is successfully created.

aws cloudformation wait stack-create-complete \
    --stack-name $CFN_STACK_NAME \
    --region $REGION

If the stack creation fails, troubleshoot by reviewing the stack events. The typical failure reasons are insufficient IAM permissions and the code's S3 bucket in a different AWS region.

After the stack is created, the AWS WAF IP sets are not updated until a new SNS message is received. To test the function and update the IP sets with the current IP ranges for the first time, do a test invocation with the AWS CLI command below:

aws lambda invoke \
  --function-name $CFN_STACK_NAME-UpdateWAFIPSets \
  --region $REGION \
  --payload file://lambda/test_event.json lambda_return.json

After successful invocation, you should receive the response below with no errors.

{
    "StatusCode": 200,
    "ExecutedVersion": "$LATEST"
}

The content of the lambda_return.json will list all IPv4 and IPv6 prefixes downloaded and updated by the Lambda function.

Alternatively, you can invoke the test event in the AWS Lambda console with sample event below. This event uses a test-hash md5 string that the function parses as a test event.

{
  "Records": [
    {
      "EventVersion": "1.0",
      "EventSubscriptionArn": "arn:aws:sns:EXAMPLE",
      "EventSource": "aws:sns",
      "Sns": {
        "SignatureVersion": "1",
        "Timestamp": "1970-01-01T00:00:00.000Z",
        "Signature": "EXAMPLE",
        "SigningCertUrl": "EXAMPLE",
        "MessageId": "12345678-1234-1234-1234-123456789012",
        "Message": "{\"create-time\": \"yyyy-mm-ddThh:mm:ss+00:00\", \"synctoken\": \"0123456789\", \"md5\": \"test-hash\", \"url\": \"https://ip-ranges.amazonaws.com/ip-ranges.json\"}",
        "Type": "Notification",
        "UnsubscribeUrl": "EXAMPLE",
        "TopicArn": "arn:aws:sns:EXAMPLE",
        "Subject": "TestInvoke"
      }
    }
  ]
}

See Using an IP set in a rule group or Web ACL.

Remove the temporary files.

rm update_aws_waf_ipset.py
rm $OBJECT_NAME
rm lambda_return.json

After the stack is created, you can customize the Lambda function's execution by editing the function's environment variables.

• SERVICES: Optional. Comma separated values for service's to get the ranges for. Value is set to ROUTE53_HEALTHCHECKS,CLOUDFRONT if it is not explicitly set.
• EC2_REGIONS. Optional. Comma separated values for EC2 regions to be added to the IP set.
• INFO_LOGGING: Optional. Set it to true for more detailed logging of the AWS Lambda Python script.
• IPV4_SET_NAME: The AWS WAF IPv4 set name.
• IPV4_SET_ID: The ID of the AWS WAF IPV4 set to update.
• IPV6_SET_NAME: The AWS WAF IPv4 set name.
• IPV6_SET_ID: The ID of the AWS WAF IPV6 set to update.

See CONTRIBUTING for more information.

This library is licensed under the MIT-0 License. See the LICENSE file.