plugin(wolf-rbac): added new api change_pwd and user_info. (apach…

…e#1204)
SaberMaster · Jun 30, 2020 · b2fdbd5 · b2fdbd5
1 parent 31de8fd
commit b2fdbd5
Show file tree

Hide file tree

Showing 5 changed files with 339 additions and 75 deletions.
diff --git a/doc/plugins/wolf-rbac-cn.md b/doc/plugins/wolf-rbac-cn.md
@@ -38,7 +38,7 @@ rbac功能由[wolf](https://github.com/iGeeky/wolf)提供, 有关 `wolf` 的更
 
 * `server`: 设置 `wolf-server` 的访问地址, 如果未设置, 默认为: `http://127.0.0.1:10080`.
 * `appid`: 设置应用id, 该应用id, 需要是在 `wolf-console` 中已经添加的应用id.
-
+* `header_prefix`: 自定义http头的前缀, 默认为: `X-`. `wolf-rbac`在鉴权成功后, 会在请求头(用于传给后端)及响应头(用于传给前端)中添加3个头: `X-UserId`, `X-Username`, `X-Nickname`.
 
 ## 依赖项
 
@@ -185,6 +185,45 @@ HTTP/1.1 200 OK
 <!DOCTYPE html>
 ```
 
+#### 获取 `RBAC` 用户信息
+
+```shell
+curl http://127.0.0.1:9080/apisix/plugin/wolf-rbac/user_info \
+--cookie x-rbac-token=V1#restful#eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6NzQ5LCJ1c2VybmFtZSI6InRlc3QiLCJtYW5hZ2VyIjoiIiwiYXBwaWQiOiJyZXN0ZnVsIiwiaWF0IjoxNTc5NDQ5ODQxLCJleHAiOjE1ODAwNTQ2NDF9.n2-830zbhrEh6OAxn4K_yYtg5pqfmjpZAjoQXgtcuts -i
+
+
+HTTP/1.1 200 OK
+{
+    "user_info":{
+        "nickname":"test",
+        "lastLogin":1582816780,
+        "id":749,
+        "username":"test",
+        "appIDs":["restful"],
+        "manager":"none",
+        "permissions":{"USER_LIST":true},
+        "profile":null,
+        "roles":{},
+        "createTime":1578820506,
+        "email":""
+    }
+}
+```
+
+#### 修改 `RBAC` 用户密码
+
+```shell
+curl http://127.0.0.1:9080/apisix/plugin/wolf-rbac/change_pwd \
+-H "Content-Type: application/json" \
+--cookie x-rbac-token=V1#restful#eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6NzQ5LCJ1c2VybmFtZSI6InRlc3QiLCJtYW5hZ2VyIjoiIiwiYXBwaWQiOiJyZXN0ZnVsIiwiaWF0IjoxNTc5NDQ5ODQxLCJleHAiOjE1ODAwNTQ2NDF9.n2-830zbhrEh6OAxn4K_yYtg5pqfmjpZAjoQXgtcuts -i \
+-X PUT -d '{"oldPassword": "old password", "newPassword": "new password"}'
+
+
+HTTP/1.1 200 OK
+{"message":"success to change password"}
+```
+
+
 ## 禁用插件
 
 当你想去掉 `rbac-wolf` 插件的时候，很简单，在routes中的插件配置中把对应的 `插件` 配置删除即可，无须重启服务，即刻生效：

diff --git a/doc/plugins/wolf-rbac.md b/doc/plugins/wolf-rbac.md
@@ -38,6 +38,7 @@ The rbac feature is provided by [wolf](https://github.com/iGeeky/wolf). For more
 
 * `server`: Set the service address of` wolf-server`. If not set, the default is: `http://127.0.0.1:10080`.
 * `appid`: Set the app id. The app id must be added in wolf-console.
+* `header_prefix`: prefix of custom HTTP header. The default value is `X-`. After authentication is successful, three headers will be added to the request header (for backend) and response header (for frontend): `X-UserId`, `X-Username`, `X-Nickname`.
 
 
 ## Dependencies
@@ -185,6 +186,45 @@ HTTP/1.1 200 OK
 <!DOCTYPE html>
 ```
 
+
+#### Get `RBAC` user information
+
+```shell
+curl http://127.0.0.1:9080/apisix/plugin/wolf-rbac/user_info \
+--cookie x-rbac-token=V1#restful#eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6NzQ5LCJ1c2VybmFtZSI6InRlc3QiLCJtYW5hZ2VyIjoiIiwiYXBwaWQiOiJyZXN0ZnVsIiwiaWF0IjoxNTc5NDQ5ODQxLCJleHAiOjE1ODAwNTQ2NDF9.n2-830zbhrEh6OAxn4K_yYtg5pqfmjpZAjoQXgtcuts -i
+
+
+HTTP/1.1 200 OK
+{
+    "user_info":{
+        "nickname":"test",
+        "lastLogin":1582816780,
+        "id":749,
+        "username":"test",
+        "appIDs":["restful"],
+        "manager":"none",
+        "permissions":{"USER_LIST":true},
+        "profile":null,
+        "roles":{},
+        "createTime":1578820506,
+        "email":""
+    }
+}
+```
+
+#### Change 'RBAC' user password
+
+```shell
+curl http://127.0.0.1:9080/apisix/plugin/wolf-rbac/change_pwd \
+-H "Content-Type: application/json" \
+--cookie x-rbac-token=V1#restful#eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6NzQ5LCJ1c2VybmFtZSI6InRlc3QiLCJtYW5hZ2VyIjoiIiwiYXBwaWQiOiJyZXN0ZnVsIiwiaWF0IjoxNTc5NDQ5ODQxLCJleHAiOjE1ODAwNTQ2NDF9.n2-830zbhrEh6OAxn4K_yYtg5pqfmjpZAjoQXgtcuts -i \
+-X PUT -d '{"oldPassword": "old password", "newPassword": "new password"}'
+
+
+HTTP/1.1 200 OK
+{"message":"success to change password"}
+```
+
 ## Disable Plugin
 
 When you want to disable the `wolf-rbac` plugin, it is very simple,