basic-auth
#
目录#
名字basic-auth
是一个认证插件,它需要与 consumer
一起配合才能工作。
添加 Basic Authentication 到一个 service
或 route
。 然后 consumer
将其用户名和密码添加到请求头中以验证其请求。
有关 Basic Authentication 的更多信息,可参考 维基百科 查看更多信息。
#
属性名称 | 类型 | 必选项 | 默认值 | 有效值 | 描述 |
---|---|---|---|---|---|
username | string | 必须 | 不同的 consumer 对象应有不同的值,它应当是唯一的。不同 consumer 使用了相同的 username ,将会出现请求匹配异常。 | ||
password | string | 必须 | 用户的密码 |
#
如何启用basic-auth
的值。#
1. 创建一个 consumer 对象,并设置插件 curl http://127.0.0.1:9080/apisix/admin/consumers -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '{ "username": "foo", "plugins": { "basic-auth": { "username": "foo", "password": "bar" } }}'
你也可以通过 web 界面来完成上面的操作,先增加一个 consumer:
然后在 consumer 页面中添加 basic-auth 插件:
basic-auth
插件。#
2. 创建 Route 或 Service 对象,并开启 curl http://127.0.0.1:9080/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 } }}'
#
测试插件- 缺少 Authorization header
$ curl -i http://127.0.0.1:9080/helloHTTP/1.1 401 Unauthorized...{"message":"Missing authorization in request"}
- 用户名不存在:
$ curl -i -ubar:bar http://127.0.0.1:9080/helloHTTP/1.1 401 Unauthorized...{"message":"Invalid user key in authorization"}
- 密码错误:
$ curl -i -ufoo:foo http://127.0.0.1:9080/helloHTTP/1.1 401 Unauthorized...{"message":"Password is error"}...
- 成功请求:
$ curl -i -ufoo:bar http://127.0.0.1:9080/helloHTTP/1.1 200 OK...hello, foo!...
#
禁用插件当你想去掉 basic-auth
插件的时候,很简单,在插件的配置中把对应的 json
配置删除即可,无须重启服务,即刻生效:
$ curl http://127.0.0.1:9080/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 } }}'