📣读完这篇文章里你能收获到
- 👨💻 学习如何快速安装并配置APISIX Basic-Auth插件，为您的API安全保驾护航。
- 🛠️ 文章详细介绍了如何创建带有basic-auth配置的Consumer，以及如何在Route中启用该插件。
- 🔍 你将了解到如何通过Admin API和Dashboard可视化操作来管理和测试basic-auth插件的功能。
- 🗑️ 文章最后指导了如何删除basic-auth插件，以便在不需要时可以轻松移除。
🚀 『Apisix系列汇总』探索新一代微服务体系下的API管理新范式与最佳实践 【点击此跳转】
文章目录
- 一、basic-auth插件概述
- 二、basic-auth插件的属性
- 2.1 Consumer端
- 2.2 Route端
- 三、启用basic-auth插件
- 3.1 Admin API操作
- 3.1.1 创建Consumer
- 3.1.2 启用Route插件
- 3.2 Dashboard可视化操作
- 3.2.1 创建Consumer
- 3.2.2 启用Route插件
- 四、测试basic-auth插件
- 五、删除basic-auth插件
- 六、总结
一、basic-auth插件概述
basic-auth插件是Apache APISIX中用于实现HTTP基本认证的插件。通过该插件，我们可以要求客户端在请求API时提供有效的用户名和密码。这些凭据将用于验证请求的合法性，从而保护我们的API不被未授权的访问。
二、basic-auth插件的属性
2.1 Consumer端
| 名称 | 类型 | 必选项 | 描述 |
|---|---|---|---|
| username | string | 是 | Consumer的用户名，必须是唯一的 |
| password | string | 是 | 用户的密码，支持通过APISIX Secret资源加密存储 |
2.2 Route端
| 名称 | 类型 | 必选项 | 默认值 | 描述 |
|---|---|---|---|---|
| hide_credentials | boolean | 否 | false | 设置为true时，不会将Authorization请求头传递给上游服务器 |
三、启用basic-auth插件
3.1 Admin API操作
3.1.1 创建Consumer
要启用basic-auth插件，首先需要创建一个带有身份验证配置的Consumer：
curl http://127.0.0.1:9180/apisix/admin/consumers \
-H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '{"username": "foo","plugins": {"basic-auth": {"username": "foo","password": "bar"}}
}'
3.1.2 启用Route插件
接下来，我们可以在Route中配置basic-auth插件：
curl http://127.0.0.1:9180/apisix/admin/routes/1 \
-H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '{"methods": ["GET"],"uri": "/hello","plugins": {"basic-auth": {}},"upstream": {"type": "roundrobin","nodes": {"127.0.0.1:8080": 1}}
}'
3.2 Dashboard可视化操作
3.2.1 创建Consumer
- 创建操作
- 填写基础信息，注意名称必须唯一
- 启用basic-auth插件
- 勾选
启用并填写账号``密码
3.2.2 启用Route插件
四、测试basic-auth插件
启用插件后，我们可以通过HTTP客户端来测试认证是否生效。使用正确的用户名和密码进行请求，应该能够成功访问API：
curl -i -ufoo:bar http://127.0.0.1:9080/hello
如果认证成功，将返回状态码200 OK。如果认证失败，APISIX将返回401 Unauthorized，并附带相应的错误信息。
五、删除basic-auth插件
当不再需要basic-auth插件时，可以通过删除Route中的相关配置来禁用它：
curl http://127.0.0.1:9180/apisix/admin/routes/1 \
-H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '{"methods": ["GET"],"uri": "/hello","plugins": {},"upstream": {"type": "roundrobin","nodes": {"127.0.0.1:8080": 1}}
}'
六、总结
通过本文的介绍，如何在Apache APISIX中启用和使用basic-auth插件来为我们的API服务添加一层基本的安全保护。basic-auth插件是一个简单而有效的认证机制，适用于多种场景。然而，在生产环境中，我们可能需要考虑更高级的认证机制，如OAuth 2.0或JWT，以提供更强的安全性。
