authz-casdoor

描述

使用 authz-casdoor 插件可添加 Casdoor 集中认证方式。

属性

名称类型必选项描述
endpoint_addrstringCasdoor 的 URL。
client_idstringCasdoor 的客户端 id。
client_secretstringCasdoor 的客户端密钥。
callback_urlstring用于接收 code 与 state 的回调地址。

注意:schema 中还定义了 encrypt_fields = {"client_secret"},这意味着该字段将会被加密存储在 etcd 中。具体参考 加密存储字段

authz-casdoor - 图1IMPORTANT

指定 endpoint_addrcallback_url 属性时不要以 “/” 来结尾。

callback_url 必须是路由的 URI。具体细节可查看下方示例内容,了解相关配置。

启用插件

以下示例展示了如何在指定路由上启用 auth-casdoor 插件:

  1. curl "http://127.0.0.1:9180/apisix/admin/routes/1" -H "X-API-KEY: edd1c9f034335f136f87ad84b625c8f1" -X PUT -d '
  2. {
  3. "methods": ["GET"],
  4. "uri": "/anything/*",
  5. "plugins": {
  6. "authz-casdoor": {
  7. "endpoint_addr":"http://localhost:8000",
  8. "callback_url":"http://localhost:9080/anything/callback",
  9. "client_id":"7ceb9b7fda4a9061ec1c",
  10. "client_secret":"3416238e1edf915eac08b8fe345b2b95cdba7e04"
  11. }
  12. },
  13. "upstream": {
  14. "type": "roundrobin",
  15. "nodes": {
  16. "httpbin.org:80": 1
  17. }
  18. }
  19. }'

测试插件

一旦启用了该插件,访问该路由的新用户首先会经过 authz-casdoor 插件的处理,然后被重定向到 Casdoor 登录页面。

成功登录后,Casdoor 会将该用户重定向到 callback_url,并指定 GET 参数的 codestate。该插件还会向 Casdoor 请求一个访问 Token,并确认用户是否已登录。在成功认证后,该流程只出现一次并且后续请求不会被打断。

上述操作完成后,用户就会被重定向到目标 URL。

禁用插件

当需要禁用 authz-casdoor 插件时,可以通过以下命令删除相应的 JSON 配置,APISIX 将会自动重新加载相关配置,无需重启服务:

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