Triage and Remediation
Check Cause
Using Console
Using Console
- Log in to the AWS Management Console and navigate to the API Gateway service.
- In the API Gateway dashboard, select the APIs that you want to examine.
- In the API details page, select the “Stages” option from the left-hand navigation panel.
- In the Stages section, check the “Client Certificate for Endpoint Verification” field. If the certificate is due to expire in less than 7 days, it is a misconfiguration.
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 ACM and API Gateway services.
-
Once the AWS CLI is set up, you can list all the ACM Certificates using the following command:
Replace ‘your-region’ with the region where your ACM Certificates are located. This command will return a list of Certificate ARNs.
-
For each Certificate ARN, you can describe the certificate to get its details, including the renewal status. Use the following command:
Replace ‘your-certificate-arn’ with the ARN of the certificate you want to check, and ‘your-region’ with the region where the certificate is located. Look for the ‘RenewalSummary’ field in the output. If the ‘RenewalStatus’ is ‘PENDING_VALIDATION’, it means the certificate is due for renewal.
-
To check if the certificate is used in API Gateway, list all the Rest APIs in API Gateway using the following command:
For each Rest API, get its details using the following command:Replace ‘your-rest-api-id’ with the ID of the Rest API you want to check, and ‘your-region’ with the region where the Rest API is located. If the ‘endpointConfiguration’ field contains the ARN of the certificate, it means the certificate is used in the Rest API.
Using Python
Using Python
-
Install and configure AWS SDK for Python (Boto3):
You need to install Boto3 in your local environment. You can install it using pip:
After installing Boto3, you need to configure it. You can configure it using AWS CLI:It will ask for your AWS Access Key ID, Secret Access Key, Default region name, and Default output format. You can get these details from your AWS account.
-
Use Boto3 to list all the ACM Certificates:
You can use the
list_certificates
method of ACM client in Boto3 to list all the ACM Certificates. Here is a sample script:This script will print all the ACM Certificates in your AWS account. -
Check the renewal status of each certificate:
You can use the
describe_certificate
method of ACM client in Boto3 to get the details of each certificate. Here is a sample script:This script will print all the ACM Certificates in your AWS account that are eligible for renewal and will expire in less than 7 days. -
Handle the exceptions:
You should handle the exceptions in your script to make it robust. For example, you can handle the
NoCredentialsError
exception if the AWS credentials are not configured properly. Here is a sample script:This script will print a message if the AWS credentials are not configured properly.