Amazon API Gateway

This feature is available with Invicti API Security Standalone or Bundle

Integrating Amazon API Gateway with Invicti Platform allows you to fetch Swagger2 and OpenAPI3 specification files from Amazon API Gateway and provide them as inputs to our DAST scanners. The imported specification files are used to build an inventory of API endpoints that can be scanned for vulnerabilities.

This document explains how to set up an integration between Invicti Platform and Amazon API Gateway.

Prerequisites

Create an IAM role for accessing your API with the following permissions:

• sts:AssumeRole
• sts:GetAccessKeyInfo
• sts:GetCallerIdentity
• Apigateway:GET

This integration has three steps. Before following these steps, ensure you have configured AWS according to the prerequisites listed above.

Step 1: Update your IAM role permissions

In order for Invicti Platform to successfully fetch your Swagger2 and OpenAPI3 specification files from Amazon API Gateway, you need to add a trusted policy to the IAM role that Invicti will be allowed to use. Follow the steps below to update your IAM role with the necessary permissions.

1. Select Discovery > Configuration from the left-side menu.
2. Further down, select API sources.

3. Click Add source.

4. Leave the Import type as External platform.
5. Enter a name for the source configuration. This will help you identify it later in your list of API sources.

6. Select AWS as the Source type.

7. In a new browser tab or window, log in to the AWS IAM Console.
8. Navigate to IAM > Roles.
9. Select the role that will be used by Invicti.
10. Select the Trust relationships tab, then click Edit trust policy.

11. Click Add new statement.

12. In the Access level - read or write section, ensure the AssumeRole is selected.

13. In the Add principal section, click Add and use the Principal type drop-down to select IAM Roles.

14. Select and copy the whole ARN field string for use in the next section below.
15. Click Add principal.
16. Click Update policy in the bottom right-hand corner.

Your IAM role now has the necessary permissions to configure the Amazon API Gateway import in Invicti. To do so, follow the instructions in the next section of this document.

Step 2: Configure the Amazon API Gateway import in Invicti

After adding the necessary permissions to your IAM role, you are now ready to complete the API integration setup in Invicti Platform. Follow the steps below to configure your Amazon API Gateway import in Invicti to establish a read-only connection.

1. The last step in Invicti that we performed prior to navigating to the AWS was selecting AWS as the Source type. We will continue from there on.
2. Scroll down to the Assume role field and paste the string that you copied from the ARN field in the AWS IAM Console (arn:aws:iam::<ACCOUNT_ID>:role/<ROLE>).
3. In the Stage names field, enter all the stage names for your APIs. Press Enter after each to add them. Stage Names are configured in Amazon API Gateway when you deploy an API.

4. In the Regions field, use the drop-down to select all the regions where your AWS sources are located.
5. Click Authenticate and Save.

Your Amazon API Gateway integration is now displayed on the Discovery > Configuration > Sources page. 

Step 3: Synchronize the API import

1. On the Discovery > Configuration > Sources page in Invicti, click the sync icon to start importing your API specification files from Amazon API Gateway into your Acunetix API Inventory.

2. When the sync is complete, your API specification files will be displayed on the Inventory > API catalog page in Invicti. From this page, you can link your API specification files to targets so they can be scanned for vulnerabilities. For more information, refer to Link or unlink discovered APIs to targets.

Amazon API Gateway is now integrated with Invicti Platform. After the initial synchronization, the integration will automatically sync your API specifications every 24 hours.