Help Center/ API Gateway/ User Guide/ API Policies/ Signature Keys
Updated on 2024-10-18 GMT+08:00
View PDF
Share

Signature Keys

Signature keys are used by backend services to verify the identity of APIG.

A signature key consists of a key and secret, and can be used only after being bound to an API. When an API bound with a signature key is called, APIG adds signature details to the API request. The backend service of the API signs the request in the same way, and verifies the identity of APIG by checking whether the signature is consistent with that in the Authorization header sent by APIG.

Usage Guidelines

Procedure

Figure 1 Signature key process flow
  1. Create a signature key on the APIG console.
  2. Bind the signature key to an API.
  3. APIG sends signed requests containing a signature in the Authorization header to the backend service. The backend service can use different programming languages (Java, Go, Python, JavaScript, C#, PHP, C++, and C) to sign each request, and check whether the two signatures are consistent.

Configuration Parameters

Table 1 Configuration parameters

Parameter

Description

Name

Signature key name.

Type

Authentication type. Options: HMAC, Basic auth, AES, and Public key.

Public key is available only if public_key_enable has been turned on on the Parameters page of the gateway.

Signature Algorithm

Select an AES signature algorithm. Options:

  • aes-128-cfb
  • aes-256-cfb

Key

Set the key based on the signature key type you have selected.

  • If Type is HMAC, enter the key of the key pair used for app authentication.
  • If Type is Basic auth, enter the username used for basic authentication.
  • If Type is set to AES, enter the key used for AES authentication.
  • If Type is Public key, enter the public key used for authentication.

Secret

Enter the secret information based on the key type you have selected.

  • If Type is HMAC, enter the secret of the key pair used for app authentication.
  • If Type is Basic auth, enter the password used for basic authentication.
  • If Type is set to AES, enter the vector used for AES authentication.
  • If Type is Public key, enter the private key used for authentication.

Confirm Secret

Enter the secret again.

Verifying the Signing Result

Sign each backend request by following the instructions in Signature Algorithm, and check whether the backend signature is consistent with the signature in the Authorization header of the API request.

Parent topic: API Policies