OpenAILike鉴权方式使用说明

## 鉴权方式说明

----

>☛ 适用插件：xfunc-hmac-ws、hmac-auth
>
>☛ 旧有鉴权逻辑仍兼容，参考[24.2 http接口 · GitBook (xfyun.cn)](https://aidocs.xfyun.cn/docs/public/http.html)
>
>☛ 新增鉴权方式仅适用https请求

### 1. hmac-auth插件鉴权方式

与旧有的鉴权逻辑需要客户端进行复杂的signature计算生成，并在Header中设置多个字段等不同，新的鉴权方式只需用户在请求Header中设置一个Authorization字段即可，字段内容格式如下：

```
Bearer ${api_key}:${api_secret}
```

“Bearer”为固定开头，空格后跟api_key与api_secret，二者之间使用英文冒号":"分割。

如下为一个请求示例：

```bash
curl -i -X GET   --url http://localhost:8089/hello   --header 'Host: example.com' --header 'Authorization: Bearer 3e8fa3fd-5ad5-488f-a103-96189b65:zLwHceRSXPEuCCWFmDUfIVzntFXxhYtj'
```

### 2. xfunc-hmac-ws插件鉴权方式

**该插件同样支持上述hmac-auth插件的鉴权方式**，除此之外它还支持将认证信息放入url参数中。

请求格式如下：

```bash
curl -i -X GET  --url http://localhost:8089/hello?authorization=url_encode(base64("Bearer ${api_key}:${api_secret}")) --header 'Host: example.com'
```

例如，api_key = "3e8fa3fd-5ad5-488f-a103-96189b6560af", api_secret = "zLwHceRSXPEuCCWFmDUfIVzntFXxhYtj"，

则authorization字段的原始值为

```
Bearer 3e8fa3fd-5ad5-488f-a103-96189b6560af:zLwHceRSXPEuCCWFmDUfIVzntFXxhYtj
```

作为路径参数时，需先对其进行base64编码，编码后的值为：

```
QmVhcmVyIDNlOGZhM2ZkLTVhZDUtNDg4Zi1hMTAzLTk2MTg5YjY1NjBhZjp6THdIY2VSU1hQRXVDQ1dGbURVZklWem50Rlh4aFl0ag==
```

再对其进行URL encode，得到如下值：

```
QmVhcmVyIDNlOGZhM2ZkLTVhZDUtNDg4Zi1hMTAzLTk2MTg5YjY1NjBhZjp6THdIY2VSU1hQRXVDQ1dGbURVZklWem50Rlh4aFl0ag%3D%3D
```

所以最终的请求为：

```bash
curl -i -X GET  --url http://localhost:8089/hello?authorization=QmVhcmVyIDNlOGZhM2ZkLTVhZDUtNDg4Zi1hMTAzLTk2MTg5YjY1NjBhZjp6THdIY2VSU1hQRXVDQ1dGbURVZklWem50Rlh4aFl0ag%3D%3D --header 'Host: example.com'
```