wolf-rbac

    名字

    wolf-rbac 是一个认证及授权(rbac)插件，它需要与 consumer 一起配合才能工作。同时需要添加 wolf-rbac 到一个 service 或 route 中。 rbac 功能由wolf提供, 有关 wolf 的更多信息, 请参考。

    接口

    插件会增加这些接口：

    • /apisix/plugin/wolf-rbac/login
    • /apisix/plugin/wolf-rbac/change_pwd
    • /apisix/plugin/wolf-rbac/user_info

    添加应用, 管理员, 普通用户, 权限, 资源 及给用户授权.

    如何启用

    1. 创建一个 consumer 对象，并设置插件 wolf-rbac 的值。

    然后在 consumer 页面中添加 wolf-rbac 插件：

    注意: 上面填写的 appid 需要在 wolf 控制台中已经存在的.

    1. 创建 Route 或 Service 对象，并开启 wolf-rbac 插件。
    1. curl http://127.0.0.1:9080/apisix/admin/routes/1  -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
    2. {
    3.     "methods": ["GET"],
    4.     "uri": "/*",
    5.     "plugins": {
    6.         "wolf-rbac": {}
    7.     },
    8.     "upstream": {
    9.         "type": "roundrobin",
    10.         "nodes": {
    11.             "www.baidu.com:80": 1
    12.         }
    13.     }
    14. }'

    首先进行登录获取 wolf-rbac token:

    • 以 POST application/json 方式登陆.
    1. curl http://127.0.0.1:9080/apisix/plugin/wolf-rbac/login -i \
    3. -d '{"appid": "restful", "username":"test", "password":"user-password", "authType":1}'
    5. HTTP/1.1 200 OK
    6. Date: Wed, 24 Jul 2019 10:33:31 GMT
    7. Content-Type: text/plain
    8. Transfer-Encoding: chunked
    9. Connection: keep-alive
    10. Server: APISIX web server
    11. {"rbac_token":"V1#restful#eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6NzQ5LCJ1c2VybmFtZSI6InRlc3QiLCJtYW5hZ2VyIjoiIiwiYXBwaWQiOiJyZXN0ZnVsIiwiaWF0IjoxNTc5NDQ5ODQxLCJleHAiOjE1ODAwNTQ2NDF9.n2-830zbhrEh6OAxn4K_yYtg5pqfmjpZAjoQXgtcuts","user_info":{"nickname":"test","username":"test","id":"749"}}
    • 以 POST x-www-form-urlencoded 方式登陆
    1. curl http://127.0.0.1:9080/apisix/plugin/wolf-rbac/login -i \
    2. -H "Content-Type: application/x-www-form-urlencoded" \
    3. -d 'appid=restful&username=test&password=user-password'

    使用获取到的 token 进行请求尝试

    • 缺少 token
    • token 放到请求头(Authorization)中：
    1. curl http://127.0.0.1:9080/ -H"Host: www.baidu.com" \
    2. -H 'Authorization: V1#restful#eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6NzQ5LCJ1c2VybmFtZSI6InRlc3QiLCJtYW5hZ2VyIjoiIiwiYXBwaWQiOiJyZXN0ZnVsIiwiaWF0IjoxNTc5NDQ5ODQxLCJleHAiOjE1ODAwNTQ2NDF9.n2-830zbhrEh6OAxn4K_yYtg5pqfmjpZAjoQXgtcuts' -i
    5. HTTP/1.1 200 OK
    8. <!DOCTYPE html>
    • token 放到请求头(x-rbac-token)中：
    1. curl http://127.0.0.1:9080/ -H"Host: www.baidu.com" \
    2. -H 'x-rbac-token: V1#restful#eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6NzQ5LCJ1c2VybmFtZSI6InRlc3QiLCJtYW5hZ2VyIjoiIiwiYXBwaWQiOiJyZXN0ZnVsIiwiaWF0IjoxNTc5NDQ5ODQxLCJleHAiOjE1ODAwNTQ2NDF9.n2-830zbhrEh6OAxn4K_yYtg5pqfmjpZAjoQXgtcuts' -i
    7. HTTP/1.1 200 OK
    10. <!DOCTYPE html>
    • token 放到请求参数中：
    1. curl 'http://127.0.0.1:9080?rbac_token=V1%23restful%23eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6NzQ5LCJ1c2VybmFtZSI6InRlc3QiLCJtYW5hZ2VyIjoiIiwiYXBwaWQiOiJyZXN0ZnVsIiwiaWF0IjoxNTc5NDQ5ODQxLCJleHAiOjE1ODAwNTQ2NDF9.n2-830zbhrEh6OAxn4K_yYtg5pqfmjpZAjoQXgtcuts' -H"Host: www.baidu.com" -i
    6. HTTP/1.1 200 OK
    9. <!DOCTYPE html>

    获取 RBAC 用户信息

    1. curl http://127.0.0.1:9080/apisix/plugin/wolf-rbac/user_info \
    2. --cookie x-rbac-token=V1#restful#eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6NzQ5LCJ1c2VybmFtZSI6InRlc3QiLCJtYW5hZ2VyIjoiIiwiYXBwaWQiOiJyZXN0ZnVsIiwiaWF0IjoxNTc5NDQ5ODQxLCJleHAiOjE1ODAwNTQ2NDF9.n2-830zbhrEh6OAxn4K_yYtg5pqfmjpZAjoQXgtcuts -i
    7. HTTP/1.1 200 OK
    8. {
    9.     "user_info":{
    10.         "nickname":"test",
    11.         "lastLogin":1582816780,
    12.         "id":749,
    13.         "username":"test",
    14.         "appIDs":["restful"],
    15.         "manager":"none",
    16.         "permissions":{"USER_LIST":true},
    17.         "profile":null,
    18.         "roles":{},
    19.         "createTime":1578820506,
    20.         "email":""
    21.     }
    22. }

    修改 RBAC 用户密码

    1. curl http://127.0.0.1:9080/apisix/plugin/wolf-rbac/change_pwd \
    2. -H "Content-Type: application/json" \
    3. --cookie x-rbac-token=V1#restful#eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6NzQ5LCJ1c2VybmFtZSI6InRlc3QiLCJtYW5hZ2VyIjoiIiwiYXBwaWQiOiJyZXN0ZnVsIiwiaWF0IjoxNTc5NDQ5ODQxLCJleHAiOjE1ODAwNTQ2NDF9.n2-830zbhrEh6OAxn4K_yYtg5pqfmjpZAjoQXgtcuts -i \
    4. -X PUT -d '{"oldPassword": "old password", "newPassword": "new password"}'
    9. HTTP/1.1 200 OK
    10. {"message":"success to change password"}

    禁用插件

    当你想去掉 rbac-wolf 插件的时候，很简单，在 routes 中的插件配置中把对应的 插件 配置删除即可，无须重启服务，即刻生效：

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