multi-auth

描述

插件 multi-auth 用于向 Route 或者 Service 中,添加多种身份验证方式。它支持 auth 类型的插件。您可以使用 multi-auth 插件,来组合不同的身份认证方式。

插件通过迭代 auth_plugins 属性指定的插件列表,提供了灵活的身份认证机制。它允许多个 Consumer 在使用不同身份验证方式时共享相同的 Route ,同时。例如:一个 Consumer 使用 basic 认证,而另一个消费者使用 JWT 认证。

属性

For Route:

名称类型必选项默认值描述
auth_pluginsarrayTrue-添加需要支持的认证插件。至少需要 2 个插件。

启用插件

要启用插件,您必须创建两个或多个具有不同身份验证插件配置的 Consumer:

首先创建一个 Consumer 使用 basic-auth 插件:

multi-auth - 图1note

您可以这样从 config.yaml 中获取 admin_key 并存入环境变量:

  1. admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g')
multi-auth - 图2note

您可以这样从 config.yaml 中获取 admin_key 并存入环境变量:

  1. admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g')
  1. curl http://127.0.0.1:9180/apisix/admin/consumers -H "X-API-KEY: $admin_key" -X PUT -d '
  2. {
  3. "username": "foo1",
  4. "plugins": {
  5. "basic-auth": {
  6. "username": "foo1",
  7. "password": "bar1"
  8. }
  9. }
  10. }'

然后再创建一个 Consumer 使用 key-auth 插件:

  1. curl http://127.0.0.1:9180/apisix/admin/consumers -H "X-API-KEY: $admin_key" -X PUT -d '
  2. {
  3. "username": "foo2",
  4. "plugins": {
  5. "key-auth": {
  6. "key": "auth-one"
  7. }
  8. }
  9. }'

创建 Consumer 之后,您可以配置一个路由或服务来验证请求:

  1. curl http://127.0.0.1:9180/apisix/admin/routes/1 -H "X-API-KEY: $admin_key" -X PUT -d '
  2. {
  3. "methods": ["GET"],
  4. "uri": "/hello",
  5. "plugins": {
  6. "multi-auth":{
  7. "auth_plugins":[
  8. {
  9. "basic-auth":{ }
  10. },
  11. {
  12. "key-auth":{
  13. "query":"apikey",
  14. "hide_credentials":true,
  15. "header":"apikey"
  16. }
  17. }
  18. ]
  19. }
  20. },
  21. "upstream": {
  22. "type": "roundrobin",
  23. "nodes": {
  24. "127.0.0.1:1980": 1
  25. }
  26. }
  27. }'

使用示例

如上所述配置插件后,您可以向对应的 API 发起一个请求,如下所示:

请求开启 basic-auth 插件的 API

  1. curl -i -ufoo1:bar1 http://127.0.0.1:9080/hello

请求开启 key-auth 插件的 API

  1. curl http://127.0.0.1:9080/hello -H 'apikey: auth-one' -i
  1. HTTP/1.1 200 OK
  2. ...
  3. hello, world

如果请求未授权,将会返回 401 Unauthorized 错误:

  1. {"message":"Authorization Failed"}

删除插件

要删除 multi-auth 插件,您可以从插件配置中删除插件对应的 JSON 配置,APISIX 会自动加载,您不需要重新启动即可生效。

  1. curl http://127.0.0.1:9180/apisix/admin/routes/1 -H "X-API-KEY: $admin_key" -X PUT -d '
  2. {
  3. "methods": ["GET"],
  4. "uri": "/hello",
  5. "plugins": {},
  6. "upstream": {
  7. "type": "roundrobin",
  8. "nodes": {
  9. "127.0.0.1:1980": 1
  10. }
  11. }
  12. }'