HMAC 插件基于 HmacSHA256 算法为 HTTP 请求生成不可伪造的 AK/SK 签名，开启后需要携带相关请求头和签名等信息访问当前资源。本文介绍如何创建一个 HMAC 插件。 ## 前提条件 * 如果生效级别选择服务级别，请先创建服务。具体操作，请参见 [创建服务](https://www.volcengine.com/docs/6569/85695)。 * 如果生效级别选择路由级别，请先创建路由。具体操作，请参见 [创建路由](https://www.volcengine.com/docs/6569/179038)。 * 已创建消费者，且生成认证信息。具体操作，请参见 [创建消费者](https://www.volcengine.com/docs/6569/1215179)和 [生成认证信息](https://www.volcengine.com/docs/6569/1215181)。 ## 使用限制 * 同一插件在同一资源上只能绑定一次。 * 同一插件在不同级别的资源上绑定时，只匹配生效优先级最高的资源，生效优先级由高到低：路由 \> 服务。例如，服务 Ⅰ 具有两条路由：路由 A 和路由 B，将插件配置在服务 Ⅰ 和路由 A 上，此时路由 A 的生效规则遵循路由 A 的插件配置，路由 B 的生效规则遵循服务 Ⅰ 的插件配置。 * 实例级别的插件所属实例只能选择2024年1月19日00:00以后创建的网关实例。如果您的控制台无法开启插件，请 [提交工单](https://console.volcengine.com/workorder/create?step=3&SubProductID=P00000170&FlowKey=DhvSFwiOSXyEVSlGZJXx)。 ## 操作步骤 1. 登录 [API 网关控制台](https://console.volcengine.com/veapig)。 2. 在顶部导航栏，选择目标地域。 3. 在左侧导航栏选择 **插件管理 \> HMAC 插件**。 4. 在 HMAC 页面，单击 **创建插件**。 5. 在创建 HMAC 插件页面，完成以下配置，然后单击 **确定**。 ![图片](https://portal.volccdn.com/obj/volcfe/cloud-universal-doc/upload_6ab5c9997cb15405dfd9764087e6c24f.png) |配置项 |说明 | |---|---| |生效级别 |选择 HMAC 插件的生效级别。包括：服务级别、路由级别。|\ | |:::tip|\ | |同一插件在不同级别的资源上绑定时，只会匹配生效优先级最高的资源。生效优先级从高到低：路由 \> 服务。|\ | ||\ | |:::| |所属服务 |生效级别选择 **服务级别**，请选择所属实例和所属服务。 | |所属路由 |生效级别选择 **路由级别**，请选择所属实例、所属服务和所属路由。 | |备注 |可选。您可以根据业务需要选择是否编辑备注内容，例如 HMAC 插件的用途，便于后期识别。 | |消费者 |选择消费者。|\ | |:::warning|\ | |消费者必须已生成认证信息。|\ | ||\ | |:::| ## 结果验证 ### 查看配置配置完成后，在 HMAC 列表将生成一条新的插件记录。插件状态为 **已启用**，表示插件功能生效。 ![图片](https://portal.volccdn.com/obj/volcfe/cloud-universal-doc/upload_7a9adeb0e9808d0df7347823b1802e24.png =913x) ### 认证测试 1. 使用 API 网关实例中配置的域名访问服务，当访问请求携带 HMAC 认证信息时。HMAC 认证信息的签名方式，请参见 [签名方法](https://www.volcengine.com/docs/6369/67269)。 ```Bash curl -H "Host: apig-example.com" http://14.xxx.xxx.xxx -H "Authorization: HMAC-SHA256 Credential=API***, SignedHeaders=host;x-content-sha256;x-date, Signature=***" ``` 预期结果如下，表示能够通过 API 网关访问到后端的服务。 ```Bash Welcome to nginx!

Welcome to nginx!

If you see this page, the nginx web server is successfully installed and working. Further configuration is required.

For online documentation and support please refer to nginx.org.
Commercial support is available at nginx.com.

Thank you for using nginx.

``` 2. 使用 API 网关实例中配置的域名访问服务，当访问请求未携带 HMAC 认证信息时。 ```Bash curl -H "Host: apig-example.com" http://14.xxx.xxx.xxx ``` 预期结果如下，表示认证失败，无法通过 API 网关访问到后端的服务。 ```Bash Consumer authentication failed. ```