『Apisix安全篇』快速掌握APISIX Basic-Auth插件高效使用

2024-05-16 14:52

本文主要是介绍『Apisix安全篇』快速掌握APISIX Basic-Auth插件高效使用,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!


📣读完这篇文章里你能收获到

  • 👨‍💻 学习如何快速安装并配置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不被未授权的访问。
image.png

二、basic-auth插件的属性

2.1 Consumer端

名称类型必选项描述
usernamestringConsumer的用户名,必须是唯一的
passwordstring用户的密码,支持通过APISIX Secret资源加密存储

2.2 Route端

名称类型必选项默认值描述
hide_credentialsbooleanfalse设置为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
  1. 创建操作

image.png

  1. 填写基础信息,注意名称必须唯一

image.png

  1. 启用basic-auth插件

image.png

  1. 勾选启用并填写账号``密码

image.png

3.2.2 启用Route插件

My_Photor_1713238894243.png
image.png

四、测试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,以提供更强的安全性。

这篇关于『Apisix安全篇』快速掌握APISIX Basic-Auth插件高效使用的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/995220

相关文章

Python使用Tenacity一行代码实现自动重试详解

《Python使用Tenacity一行代码实现自动重试详解》tenacity是一个专为Python设计的通用重试库,它的核心理念就是用简单、清晰的方式,为任何可能失败的操作添加重试能力,下面我们就来看... 目录一切始于一个简单的 API 调用Tenacity 入门:一行代码实现优雅重试精细控制:让重试按我

MySQL中EXISTS与IN用法使用与对比分析

《MySQL中EXISTS与IN用法使用与对比分析》在MySQL中,EXISTS和IN都用于子查询中根据另一个查询的结果来过滤主查询的记录,本文将基于工作原理、效率和应用场景进行全面对比... 目录一、基本用法详解1. IN 运算符2. EXISTS 运算符二、EXISTS 与 IN 的选择策略三、性能对比

使用Python构建智能BAT文件生成器的完美解决方案

《使用Python构建智能BAT文件生成器的完美解决方案》这篇文章主要为大家详细介绍了如何使用wxPython构建一个智能的BAT文件生成器,它不仅能够为Python脚本生成启动脚本,还提供了完整的文... 目录引言运行效果图项目背景与需求分析核心需求技术选型核心功能实现1. 数据库设计2. 界面布局设计3

使用IDEA部署Docker应用指南分享

《使用IDEA部署Docker应用指南分享》本文介绍了使用IDEA部署Docker应用的四步流程:创建Dockerfile、配置IDEADocker连接、设置运行调试环境、构建运行镜像,并强调需准备本... 目录一、创建 dockerfile 配置文件二、配置 IDEA 的 Docker 连接三、配置 Do

Android Paging 分页加载库使用实践

《AndroidPaging分页加载库使用实践》AndroidPaging库是Jetpack组件的一部分,它提供了一套完整的解决方案来处理大型数据集的分页加载,本文将深入探讨Paging库... 目录前言一、Paging 库概述二、Paging 3 核心组件1. PagingSource2. Pager3.

python使用try函数详解

《python使用try函数详解》Pythontry语句用于异常处理,支持捕获特定/多种异常、else/final子句确保资源释放,结合with语句自动清理,可自定义异常及嵌套结构,灵活应对错误场景... 目录try 函数的基本语法捕获特定异常捕获多个异常使用 else 子句使用 finally 子句捕获所

C++11右值引用与Lambda表达式的使用

《C++11右值引用与Lambda表达式的使用》C++11引入右值引用,实现移动语义提升性能,支持资源转移与完美转发;同时引入Lambda表达式,简化匿名函数定义,通过捕获列表和参数列表灵活处理变量... 目录C++11新特性右值引用和移动语义左值 / 右值常见的左值和右值移动语义移动构造函数移动复制运算符

Python对接支付宝支付之使用AliPay实现的详细操作指南

《Python对接支付宝支付之使用AliPay实现的详细操作指南》支付宝没有提供PythonSDK,但是强大的github就有提供python-alipay-sdk,封装里很多复杂操作,使用这个我们就... 目录一、引言二、准备工作2.1 支付宝开放平台入驻与应用创建2.2 密钥生成与配置2.3 安装ali

C#中lock关键字的使用小结

《C#中lock关键字的使用小结》在C#中,lock关键字用于确保当一个线程位于给定实例的代码块中时,其他线程无法访问同一实例的该代码块,下面就来介绍一下lock关键字的使用... 目录使用方式工作原理注意事项示例代码为什么不能lock值类型在C#中,lock关键字用于确保当一个线程位于给定实例的代码块中时

MySQL 强制使用特定索引的操作

《MySQL强制使用特定索引的操作》MySQL可通过FORCEINDEX、USEINDEX等语法强制查询使用特定索引,但优化器可能不采纳,需结合EXPLAIN分析执行计划,避免性能下降,注意版本差异... 目录1. 使用FORCE INDEX语法2. 使用USE INDEX语法3. 使用IGNORE IND