跳到主要内容

Kong Authorization

kong-authz 是一个 Kong 插件,它使用 lua-casbin 执行请求授权。您可以照常定义模型和策略;该插件会在 Kong 路由上强制执行这些策略。

先决条件​

信息

默认情况下,策略从文件中加载。若要使用基于数据库的策略,请安装 4daysorm-adapter 或 luasql-adapter。

Installation​

安装 Casbin 的系统依赖项:

  • 对于带有 apt 的系统:
sudo apt install gcc libpcre3 libpcre3-dev
  • 对于基于 Alpine 的系统:
sudo apk add gcc pcre pcre-dev libc-dev

从 LuaRocks 安装 Casbin 的最新版本:

sudo luarocks install casbin

安装 kong-authz 插件:

sudo luarocks install https://raw.githubusercontent.com/casbin-lua/kong-authz/master/kong-authz-0.0.1-1.rockspec

通过在 plugins 变量后追加 kong-authz(逗号分隔),将该插件添加到您的 kong.conf 中:

# kong.conf
plugins = bundled, kong-authz

启动或重启 Kong:

kong start [-c /path/to/kong.conf]

配置​

通过 Kong Admin API 在服务、API 或全局级别配置此插件。

File-Based Policy Storage​

使用基于文件的策略进行全局配置:

curl -i -X POST \
--url http://localhost:8001/plugins/ \
--data 'name=kong-authz' \
--data 'config.model_path=/path/to/model_path.conf' \
--data 'config.policy_path=/path/to/policy_path.csv' \
--data 'config.username=user'

Database Policy Storage with LuaSQL​

使用 LuaSQL adapter 为特定服务进行配置:

curl -i -X POST \
--url http://localhost:8001/services/example-service/plugins/ \
--data 'name=kong-authz' \
--data 'config.model_path=/mnt/kong/examples/authz_model.conf' \
--data 'config.username=user' \
--data 'config.adapter=luasql' \
--data 'config.db_info.db_type=mysql' \
--data 'config.db_info.database=casbin' \
--data 'config.db_info.username=root' \
--data 'config.db_info.password=********' \
--data 'config.db_info.host=127.0.0.1' \
--data 'config.db_info.port=3306'

Database Policy Storage with 4DaysORM​

使用 4DaysORM 适配器为特定服务进行配置:

curl -i -X POST \
--url http://localhost:8001/services/example-service/plugins/ \
--data 'name=kong-authz' \
--data 'config.model_path=/mnt/kong/examples/authz_model.conf' \
--data 'config.username=user' \
--data 'config.adapter=4daysorm' \
--data 'config.db_info.db_type=mysql' \
--data 'config.db_info.database=casbin' \
--data 'config.db_info.username=root' \
--data 'config.db_info.password=********' \
--data 'config.db_info.host=127.0.0.1' \
--data 'config.db_info.port=3306'

授权流程​

授权通过 {subject, object, action} 评估请求,确定哪个 subject 可以对哪个 object 执行哪种 action。在此插件中:

  1. subject:请求头中传递的已登录用户名
  2. object:资源的 URL 路径(例如 "dataset1/item1")
  3. action:HTTP 方法(GET、POST、PUT、DELETE)或自定义操作,如 "read-file" 或 "write-blog"

有关策略编写的详细信息,请参阅 Casbin 文档。

配置示例​

为服务配置 kong-authz 的完整示例:

  1. 创建一个示例服务:
curl -i -X POST \
--url http://localhost:8001/services/ \
--data 'name=example-service' \
--data 'url=http://mockbin.org'
  1. 为该服务创建路由:
curl -i -X POST \
--url http://localhost:8001/services/example-service/routes \
--data 'hosts[]=example.com'
  1. 应用 kong-authz 插件:
curl -i -X POST \
--url http://localhost:8001/services/example-service/plugins/ \
--data 'name=kong-authz' \
--data 'config.model_path=/path/to/authz_model.conf' \
--data 'config.policy_path=/path/to/authz_policy.csv' \
--data 'config.username=user'
  1. 使用请求测试授权:
curl -i -X GET \
--url http://localhost:8000/ \
--header 'Host: example.com' \
--header 'user: anonymous'

首次执行时,这将使用指定的模型和策略路径创建一个 Casbin Enforcer。任何非 500 错误均表示配置成功。如果出现 500 错误,请检查 Kong 安装目录中的 error.log 文件。

资源​

Comments are powered by giscus and GitHub Discussions. They load from giscus.app and GitHub only after you click the button below.