Triage and Remediation
Check Cause
Using Console
Using Console
- Sign in to the AWS Management Console.
- Navigate to the API Gateway console. You can do this by typing “API Gateway” in the search bar and selecting it from the dropdown menu.
- In the API Gateway console, select the API you want to check.
- In the API details page, select the “Stages” option from the left-hand side menu. Here, you can see all the stages of your API. Click on the stage you want to check.
- In the stage editor, select the “Logs/Tracing” tab. Here, you can see the “CloudWatch Settings”. If the “Enable CloudWatch Logs” option is not selected, it means that AWS KMS Customer Master Keys for EFS Encryption is not enabled in API Gateway.
Using CLI
Using CLI
- First, you need to install and configure AWS CLI on your local machine. You can do this by following the instructions provided by AWS. Make sure you have the necessary permissions to access the resources.
-
Once AWS CLI is installed and configured, you can use the following command to list all the API Gateways:
This command will return a list of all the API Gateways along with their details.
-
Now, to check the AWS KMS Customer Master Keys for EFS Encryption, you need to list all the resources of each API Gateway. You can do this by using the following command:
Replace
<rest-api-id>
with the ID of the API Gateway you want to check. This command will return a list of all the resources of the specified API Gateway. -
Finally, for each resource, you need to check the
aws:kms:KeyArn
property. If this property is not set or is set to a key that is not a Customer Master Key, then the EFS Encryption is misconfigured. You can do this by using the following command:Replace<rest-api-id>
,<resource-id>
, and<http-method>
with the ID of the API Gateway, the ID of the resource, and the HTTP method of the integration, respectively. This command will return the details of the integration, including theaws:kms:KeyArn
property.
Using Python
Using Python
- Install and configure AWS SDK for Python (Boto3) on your local system. This will allow you to interact with AWS services using Python.
- Create a Python script that uses Boto3 to list all the API Gateways in your AWS account.
- For each API Gateway, check if the EFS encryption is enabled. If the EFS encryption is not enabled, the API Gateway is misconfigured.
- Print out the names of the misconfigured API Gateways.