eSight 22.1.0 Self-service Integration Development Guide (Standard Edition) 02
Configuring API Management
Configuring Client Certificate Authentication for API Management (GUI Mode)
When a third-party system interconnects with eSight using the API gateway, the third-party system certificate is not verified by default. For higher security requirements, you can enable verification on the third-party system certificate and import the certificate to the certificate management services. You need to update the certificate before it expires.
Prerequisites
Run the following command to convert the certificate in .pfx format to the .cer format supported by APIGWService:
openssl pkcs12 -in *.pfx -out CA.cer -nokeys -cacerts
If the following information is displayed, enter the PFX certificate password:
Enter Import Password:
Procedure
- On the eSight O&M plane, choose from the main menu.
- In the navigation pane, choose API Gateway > General Configuration.
- In the Secure Connection area, set Verify certificate to Yes.
- To verify the common name (CN) or subject alternative name (SAN) in the certificate, you need to enable Verify CN/SAN.
- If CN/SAN verification is enabled, eSight will verify the CN and SAN of the third-party system identity certificate. To improve communication security, you are advised to enable CN/SAN verification.
- Import the trust certificate of the third-party system to the trust certificates of APIGWService.
- On the eSight O&M plane, choose from the main menu.
- In the navigation pane, choose Service Certificate Management and click the APIGWService card.
- On the APIGWService Certificates page, click the Trust Certificate tab and click Import.
- On the Import Trust Certificate page, enter related information.
- You are advised to set Certificate alias to a value different from existing certificate aliases in the trust certificate list.
- If Certificate format is set to PKCS12 or JKS, enter the password for the certificate file in the Certificate password text box.
- Click Submit.
- In the High Risk dialog box, read the information carefully and confirm whether to import the certificate.
- If yes, select I understand the risks and want to continue, click OK, and go to 4.g.
- If no, click Cancel.
- In the dialog box that is displayed, click OK.
Enabling or Disabling HTTP for Northbound API Management (GUI Mode)
In new installation scenarios, the northbound API gateway uses HTTPS to communicate with third-party systems by default. In upgrade scenarios, if HTTP is used in the earlier version, it will be inherited. HTTP may also be used in scenarios where third-party systems are interconnected. Therefore, eSight provides the function of enabling and disabling HTTP. HTTPS is recommended because it is more secure than HTTP.
After HTTP is configured, the client authentication function becomes invalid.
Procedure
- On the eSight O&M plane, choose from the main menu.
- In the navigation pane, choose API Gateway > General Configuration.
- In the Secure Connection area, disable Enable HTTPS.
- In the Warning dialog box, read the information carefully and confirm whether to use HTTP. Click OK.
- Click Apply.
- In the High Risk dialog box, read the information carefully and determine whether to apply the configuration.
- If yes, select I understand the risks and want to continue, click OK, and go to 7.
- If no, click Cancel.
- In the dialog box that is displayed, click OK.
Configuring the Limit of Concurrent Connections and Connection Frequency for One IP Address (GUI Mode)
After the service is deployed, the concurrent connections and connection frequency for one IP address are not limited by default. You can configure the limit of concurrent connections and frequency of connections that one external IP address can establish with the server to prevent denial of service (DoS) and Challenge Collapsar (CC) attacks. You are advised to set the connection frequency to at least 20 times per second.
Procedure
- On the eSight O&M plane, choose from the main menu.
- In the navigation pane, choose API Gateway > Access Configuration.
- In the Global Traffic Control Policy area, set the maximum number of requests and connection frequency.
- Click Apply in the lower right corner.
- In the High Risk dialog box, read the information carefully and determine whether to apply the global traffic control policy.
- If yes, select I understand the risks and want to continue, click OK, and go to 6.
- If no, click Cancel.
- Click OK.