Skip to main content
Version: Next

authz-keycloak

目录#

名字#

authz-keycloak 是和 Keycloak Identity Server 配合使用的鉴权插件。Keycloak 是一种兼容 OAuth/OIDC 和 UMA 协议的身份认证服务器。尽管本插件是和 Keycloak 服务器配合开发的，但也应该能够适配任意兼容 OAuth/OIDC 和 UMA 协议的身份认证服务器。

有关 Keycloak 的更多信息，可参考 Keycloak Authorization Docs 查看更多信息。

属性#

名称类型必选项默认值有效值描述
token_endpointstring必须[1, 4096]接受 OAuth2 兼容 token 的接口，需要支持 urn:ietf:params:oauth:grant-type:uma-ticket 授权类型
grant_typestring可选"urn:ietf:params:oauth:grant-type:uma-ticket"["urn:ietf:params:oauth:grant-type:uma-ticket"]
audiencestring可选客户端应用访问相应的资源服务器时所需提供的身份信息。当 permissions 参数有值时这个参数是必填的。
permissionsarray[string]可选描述客户端应用所需访问的资源和权限范围的字符串。格式必须为：RESOURCE_ID#SCOPE_ID
timeoutinteger可选3000[1000, ...]与身份认证服务器的 http 连接的超时时间
ssl_verifyboolean可选true验证 SSL 证书与主机名是否匹配
policy_enforcement_modestring可选"ENFORCING"["ENFORCING", "PERMISSIVE"]

策略执行模式#

定义了在处理身份认证请求时如何应用策略

Enforcing

  • （默认）如果资源没有绑定任何访问策略，请求默认会被拒绝。

Permissive

  • 如果资源没有绑定任何访问策略，请求会被允许。

如何启用#

创建一个 route 对象，并在该 route 对象上启用 authz-keycloak 插件：

curl http://127.0.0.1:9080/apisix/admin/routes/5 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '{    "uri": "/get",    "plugins": {        "authz-keycloak": {            "token_endpoint": "http://127.0.0.1:8090/auth/realms/{client_id}/protocol/openid-connect/token",            "permissions": ["resource name#scope name"],            "audience": "Client ID"        }    },    "upstream": {        "type": "roundrobin",        "nodes": {            "127.0.0.1:8080": 1        }    }}'

测试插件#

curl http://127.0.0.1:9080/get -H 'Authorization: Bearer {JWT Token}'

禁用插件#

在插件设置页面中删除相应的 json 配置即可禁用 authz-keycloak 插件。APISIX 的插件是热加载的，因此无需重启 APISIX 服务。

curl http://127.0.0.1:9080/apisix/admin/routes/5 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '{    "uri": "/get",    "plugins": {    },    "upstream": {        "type": "roundrobin",        "nodes": {            "127.0.0.1:8080": 1        }    }}'

示例#

请查看 authz-keycloak.t 中的单元测试来了解如何将身份认证策略与您的 API 工作流集成。运行以下 docker 镜像并访问 http://localhost:8090 来查看单元测试中绑定的访问策略：

docker run -e KEYCLOAK_USER=admin -e KEYCLOAK_PASSWORD=123456 -p 8090:8080 sshniro/keycloak-apisix

下面这张截图显示了如何在 Keycloak 服务器上配置访问策略：

Keycloak policy design

后续开发#

  • 目前 authz-plugin 仅支持通过定义资源名和访问权限范畴来应用 route 的访问策略。但是 Keycloak 官方适配的其他语言的客户端 (Java, JS) 还可以通过动态查询 Keycloak 路径以及懒加载身份资源的路径来支持路径匹配。未来版本的 authz-plugin 将会支持这项功能。

  • 支持从 Keycloak JSON 文件中读取权限范畴和其他配置项。