mirror of
https://github.com/halo-dev/docs.git
synced 2026-01-28 01:09:02 +08:00
docs: update documentations for 2.21 (#502)
Signed-off-by: Ryan Wang <i@ryanc.cc>
This commit is contained in:
Ryan Wang
@@ -0,0 +1,251 @@
|
||||
---
|
||||
title: 基于角色的权限控制
|
||||
description: 了解 Halo 的基于角色的权限控制机制。
|
||||
---
|
||||
|
||||
基于角色的权限控制（Role-Based Access Control，RBAC）是一种广泛应用的访问控制机制，旨在通过定义用户的角色来简化和增强权限管理。
|
||||
在 Halo 中，RBAC 通过限制对系统资源的访问来确保系统的安全性和可管理性。
|
||||
|
||||
## RBAC 的基本概念
|
||||
|
||||
RBAC 通过三个核心概念来管理权限：
|
||||
|
||||
1. **角色（Role）** ：角色定义了一组操作权限，这些操作可以包括对某些资源的“读”、“写”或“执行”等权限。在 Halo 中，角色可以绑定到用户，从而赋予它们相应的权限，同时角色可以依赖于其他角色，从而实现权限的继承以简化权限管理。
|
||||
|
||||
2. **用户（User）** ：用户是实际使用 Halo 资源的实体。
|
||||
|
||||
3. **角色绑定（RoleBinding）** ：角色绑定是将用户与特定的角色关联起来。通过角色绑定，某个用户可以获得与角色相关的权限。
|
||||
|
||||
通过上述三者的结合，RBAC 可以灵活地控制用户对 Halo 资源的访问权限。
|
||||
|
||||
## 什么是基于角色的权限控制
|
||||
|
||||
RBAC 的核心思想是将权限分配给角色，而不是直接分配给用户。用户通过被分配一个或多个角色来获得相应的权限。每个角色都定义了可以执行的操作，如读取、写入、删除等操作。这种设计具有以下几个优点：
|
||||
|
||||
1. 简化权限管理：管理员可以通过管理少数角色来控制大量用户的权限，而不需要为每个用户单独配置权限。
|
||||
2. 权限最小化：用户只会被赋予完成工作所需的最低权限，减少了安全风险。
|
||||
3. 易于扩展：新增用户或变更权限只需要调整角色，无需修改大量的用户配置。
|
||||
|
||||
## Role 和 RoleBinding
|
||||
|
||||
在 Halo 中，Role 是通过自定义模型来定义的。一个典型的 Role 的 YAML 配置如下：
|
||||
|
||||
```yaml
|
||||
apiVersion: v1alpha1
|
||||
kind: Role
|
||||
metadata:
|
||||
name: example-role
|
||||
rules:
|
||||
- apiGroups: [""]
|
||||
resources: ["menus"]
|
||||
verbs: ["get", "list"]
|
||||
```
|
||||
|
||||
上面的例子定义了一个名为 example-role 的角色。该角色允许用户对菜单资源执行 get 和 list 操作。
|
||||
|
||||
- `apiGroups` 定义了资源所属的 API 组，`""` 表示核心 API 组。
|
||||
- `resources` 是指定角色可以操作的资源类型。
|
||||
- `verbs` 表示可以执行的操作，比如 get、create、delete 等。
|
||||
|
||||
## RoleBinding 与角色的关联
|
||||
|
||||
定义好角色后，我们需要通过 `RoleBinding` 将其与某个用户关联，`RoleBinding` 绑定了 `Role` 并指定了哪些用户可以获得该角色的权限。
|
||||
在 Halo 为用户分配角色也是通过 `RoleBinding` 来实现的。一个典型的 RoleBinding 的 YAML 配置如下：
|
||||
|
||||
```yaml
|
||||
apiVersion: v1alpha1
|
||||
kind: RoleBinding
|
||||
metadata:
|
||||
name: fake-user-binding
|
||||
subjects:
|
||||
# 绑定的用户，这是一个数组，可以绑定多个用户
|
||||
- kind: User
|
||||
name: fake-user
|
||||
apiGroup: ""
|
||||
roleRef:
|
||||
kind: Role
|
||||
name: example-role
|
||||
apiGroup: ""
|
||||
```
|
||||
|
||||
## 角色模板
|
||||
|
||||
虽然角色已经定义了一组操作权限，但是粒度太细的角色会导致权限管理复杂，如文章管理的角色可能需要包含了文章、分类、标签、用户等多个资源的操作权限才能提供完整的功能，而这些操作权限可能会被多个角色共享。
|
||||
为了简化权限管理，Halo 提供了角色模板的功能，角色模板是一组操作权限的集合，可以被多个角色共享。同时，角色模板也可以继承其他角色模板，从而实现权限的继承。
|
||||
|
||||
### 创建角色模板
|
||||
|
||||
角色模板是通过一个特殊的 label 来标识 Role 对象实现的，一个典型的角色模板的 YAML 配置如下：
|
||||
|
||||
```yaml
|
||||
apiVersion: v1alpha1
|
||||
kind: Role
|
||||
metadata:
|
||||
name: example-role
|
||||
labels:
|
||||
# 通过 halo.run/role-template: "true" 标识为角色模板
|
||||
halo.run/role-template: "true"
|
||||
rules:
|
||||
- apiGroups: [""]
|
||||
resources: ["menus"]
|
||||
verbs: ["get", "list"]
|
||||
```
|
||||
|
||||
Halo 在用户界面只会显示非模板角色，这样可以避免用户误操作角色模板，同时也可以简化用户对角色的管理。
|
||||
用户创建角色时通过选择`角色模板`来创建角色，角色模板在用户界面以`权限`的概念展示，比如`文章管理`、`用户管理`等。
|
||||
|
||||
## 继承角色/角色模板
|
||||
|
||||
可以在角色的 `annotations` 中添加 `rbac.authorization.halo.run/dependencies` 来声明角色间的依赖关系，例如菜单管理必须要依赖菜单查看，以避免分配了管理权限却没有查看权限的情况。
|
||||
当角色依赖于其他角色时，Halo 会自动将依赖的角色的权限合并到当前角色中以实现权限的继承。
|
||||
|
||||
```yaml
|
||||
apiVersion: v1alpha1
|
||||
kind: Role
|
||||
metadata:
|
||||
name: example-role
|
||||
labels:
|
||||
halo.run/role-template: "true"
|
||||
annotations:
|
||||
rbac.authorization.halo.run/dependencies: |
|
||||
[ "view-menu" ]
|
||||
rules:
|
||||
- apiGroups: [""]
|
||||
resources: ["menus"]
|
||||
verbs: [ "create", "update", "delete" ]
|
||||
---
|
||||
apiVersion: v1alpha1
|
||||
kind: Role
|
||||
metadata:
|
||||
name: view-menu
|
||||
labels:
|
||||
halo.run/role-template: "true"
|
||||
rules:
|
||||
- apiGroups: [""]
|
||||
resources: ["menus"]
|
||||
verbs: ["get", "list"]
|
||||
```
|
||||
|
||||
## 聚合角色
|
||||
|
||||
角色定义依赖关系适合于定义角色模板时复用 `rules` 或者用户创建角色时绑定其他角色，但是如果想要将一个角色的权限合并到另一个已有的角色中（如 Halo 提供的），这种情况下角色依赖关系就无法满足需求了。
|
||||
例如，当插件开发者想要将自己插件的角色权限合合并到 Halo 的角色中时，无法修改 Halo 的角色定义，这时可以通过聚合角色来实现。
|
||||
|
||||
聚合角色通过 `rbac.authorization.halo.run/aggregate-to-{role-name}` 的 `labels` 来声明，其中的 `{role-name}` 占位符表示要聚合到的角色名。
|
||||
|
||||
例如插件开发者想要将插件的某些 API 资源公开给所有人访问即不需要授权，可以通过将角色聚合到 `anonymous` 角色来实现。
|
||||
|
||||
```yaml
|
||||
apiVersion: v1alpha1
|
||||
kind: Role
|
||||
metadata:
|
||||
name: template-moment-anonymous-resources
|
||||
labels:
|
||||
halo.run/role-template: "true"
|
||||
rbac.authorization.halo.run/aggregate-to-anonymous: "true"
|
||||
rules:
|
||||
- apiGroups: ["api.moment.halo.run"]
|
||||
resources: ["moments"]
|
||||
verbs: ["get", "list"]
|
||||
```
|
||||
|
||||
上述配置将 `template-moment-anonymous-resources` 角色聚合到 `anonymous` 角色中，用户无需登录即可访问 `api.moment.halo.run` 下的 `moments` 资源。
|
||||
|
||||
`rbac.authorization.halo.run/aggregate-to-editor` 表示将 `role-template-view-categories` 角色聚合到 `editor` 角色中，这样所有拥有 `editor` 角色的用户都会拥有 `role-template-view-categories` 角色的权限。
|
||||
|
||||
在 Halo 中，`anonymous` 角色是一个特殊的角色，表示未登录的匿名访客。
|
||||
|
||||
## 隐藏角色模板
|
||||
|
||||
Halo 提供了隐藏角色模板的功能，隐藏的角色模板不会在用户界面的权限列表中显示，对于聚合角色来说，隐藏角色模板是非常有用的，它可以避免用户在权限列表中看到不应该看到的角色模板。
|
||||
|
||||
隐藏角色模板通过 `halo.run/hidden: "true"` 的 `labels` 来标识，**它必须是一个角色模板**。
|
||||
|
||||
```yaml
|
||||
apiVersion: v1alpha1
|
||||
kind: Role
|
||||
metadata:
|
||||
name: template-moment-anonymous-resources
|
||||
labels:
|
||||
# 声明为角色模板
|
||||
halo.run/role-template: "true"
|
||||
# 声明为隐藏
|
||||
halo.run/hidden: "true"
|
||||
# 聚合到 anonymous 角色
|
||||
rbac.authorization.halo.run/aggregate-to-anonymous: "true"
|
||||
rules:
|
||||
- apiGroups: ["api.moment.halo.run"]
|
||||
resources: ["moments"]
|
||||
verbs: ["get", "list"]
|
||||
```
|
||||
|
||||
## Halo 中的特殊角色
|
||||
|
||||
### anonymous 角色
|
||||
|
||||
在 Halo 中，任何访问者都会被赋予一个特殊的角色，这个角色是 `anonymous`，表示未登录的匿名访客。`anonymous` 角色是一个特殊的角色，它不需要绑定到用户，用户无需登录即可获得 `anonymous` 角色的权限。
|
||||
|
||||
`anonymous` 角色的定义参考 [anonymous 角色](https://github.com/halo-dev/halo/blob/main/application/src/main/resources/extensions/role-template-anonymous.yaml)。
|
||||
|
||||
### authenticated 角色
|
||||
|
||||
`authenticated` 角色表示已登录的用户，用户登录后会被赋予 `authenticated` 角色。`authenticated` 角色的权限是 Halo 中所有用户的最小权限，即所有登录用户都会获得 `authenticated` 角色的权限。
|
||||
|
||||
如果开发插件时但凡登录用户都需要具备的权限集合，可以通过将角色聚合到 `authenticated` 角色来实现。这样便不需要为每个用户单独配置权限，只需要将角色聚合到 `authenticated` 角色即可。
|
||||
|
||||
`authenticated` 角色的定义参考 [authenticated 角色](https://github.com/halo-dev/halo/blob/main/application/src/main/resources/extensions/role-template-authenticated.yaml)。
|
||||
|
||||
## Halo 中的内置角色
|
||||
|
||||
Halo 中内置了一些角色，管理员可以在创建用户时直接分配这些角色。内置角色的权限是固定的，不可修改。
|
||||
|
||||
### 超级管理员
|
||||
|
||||
超级管理员的角色名为 `super-role`，它包含了 Halo 中所有资源的所有权限。超级管理员可以访问 Halo 中的所有资源，包括系统资源和插件资源。
|
||||
|
||||
```yaml
|
||||
apiVersion: v1alpha1
|
||||
kind: Role
|
||||
metadata:
|
||||
name: super-role
|
||||
labels:
|
||||
rbac.authorization.halo.run/system-reserved: "true"
|
||||
annotations:
|
||||
rbac.authorization.halo.run/display-name: "超级管理员"
|
||||
rbac.authorization.halo.run/ui-permissions: |
|
||||
["*"]
|
||||
rules:
|
||||
- apiGroups: ["*"]
|
||||
resources: ["*"]
|
||||
nonResourceURLs: ["*"]
|
||||
verbs: ["*"]
|
||||
```
|
||||
|
||||
### 访客角色
|
||||
|
||||
访客角色的角色名为 `guest`，它没有任何权限，当用户被分配了访客角色时，用户只具有 `anonymous` 和 `authenticated` 角色的权限，由于 `anonymous` 和 `authenticated` 角色是不可分配的，因此访客角色用来表示用户的这种状态。
|
||||
|
||||
```yaml
|
||||
apiVersion: v1alpha1
|
||||
kind: Role
|
||||
metadata:
|
||||
name: guest
|
||||
labels:
|
||||
rbac.authorization.halo.run/system-reserved: "true"
|
||||
annotations:
|
||||
rbac.authorization.halo.run/display-name: "访客"
|
||||
rbac.authorization.halo.run/disallow-access-console: "true"
|
||||
rules: []
|
||||
```
|
||||
|
||||
### 文章内置角色
|
||||
|
||||
文章是 Halo 的核心功能之一，因此 Halo 内置了一些文章相关的角色，以便个人中心功能的正常运行。
|
||||
|
||||
- 文章作者：文章作者允许用户管理自己的文章，包括投稿、创建、修改、发布、删除等操作。
|
||||
- 投稿者：投稿者允许用户投稿文章，但是不能直接发布文章，需要管理员审核后才能发布。
|
||||
- 文章管理员：文章管理员允许用户管理所有文章，包括修改、发布、删除等文章关联的所有操作。
|
||||
|
||||
## 参考
|
||||
|
||||
关于角色模板的配置详解请参考[API 权限控制](./role-template.md)。
|
||||
@@ -0,0 +1,211 @@
|
||||
---
|
||||
title: API 权限控制
|
||||
description: 了解如何对插件中的 API 定义角色模板以接入权限控制
|
||||
---
|
||||
|
||||
插件中的 APIs 无论是自定义模型自动生成的 APIs 或者是通过 `@Controller` 自定义的 APIs 都只有超级管理员能够访问，如果想将这些 APIs 授权给其他用户访问，
|
||||
则需要定义一些[角色模板](../../core/framework.md#rbac)的资源以便可以在用户界面上将其分配给其他角色使用。
|
||||
|
||||
## 角色模板定义
|
||||
|
||||
定义角色模板需要遵循一定的规范：
|
||||
|
||||
- **文件位置和标记**：角色模板定义文件存放于 `src/main/resources/extensions`，文件名可以任意，它的 kind 为 Role 且必须具有标签 `halo.run/role-template: "true"` 来标识其为模板。
|
||||
- **角色类型**：通常，我们为同一种资源定义两种角色模板：只读权限和管理权限，分别对应 `view` 和 `manage`，如果需要更细粒度的控制，可以定义更多的角色模板。
|
||||
- **角色名称**：角色名称必须以插件名作为前缀，以避免与其他插件冲突，例如 `my-plugin-role-view-persons`。
|
||||
- **角色依赖**：如果一个角色需要依赖于另一个角色，可以通过 `rbac.authorization.halo.run/dependencies` 作为 key 的 `metadata.annotations` 来声明依赖关系。
|
||||
- **UI 权限**：如果需要在前端界面上控制某个角色的权限，可以通过 `rbac.authorization.halo.run/ui-permissions` 作为 key 的 `metadata.annotations` 来声明。
|
||||
- **角色模板分组**：如果需要将多个角色模板归为一组显示，可以通过 `rbac.authorization.halo.run/module` 作为 key 的 `metadata.annotations` 来声明分组名称。
|
||||
- **角色显示名称**：如果需要在前端界面上显示角色的友好名称，可以通过 `rbac.authorization.halo.run/display-name` 作为 key 的 `metadata.annotations` 来声明显示名称。
|
||||
- **隐藏角色模板**：如果不想在前端界面上显示某个角色模板，可以通过 `halo.run/hidden: "true"` 的 `metadata.labels` 来隐藏角色模板。
|
||||
|
||||
角色模板定义的基本框架如下：
|
||||
|
||||
```yaml
|
||||
apiVersion: v1alpha1
|
||||
kind: Role
|
||||
metadata:
|
||||
name: role-template-name
|
||||
labels:
|
||||
halo.run/role-template: "true"
|
||||
rules:
|
||||
- apiGroups: []
|
||||
resources: []
|
||||
resourceNames: []
|
||||
verbs: []
|
||||
- nonResourceURLs: []
|
||||
verbs: []
|
||||
```
|
||||
|
||||
在遵循上述规范的基础上，最重要的是定义 `rules` 字段，它是一个数组，用于定义角色模板的权限规则，规则分为两种类型：[资源型](#resource-rules)和[非资源型](#non-resource-rules)。
|
||||
|
||||
### 资源型规则 {#resource-rules}
|
||||
|
||||
资源型规则用于定义对资源的操作权限，API 符合以下特征：
|
||||
|
||||
- 以 `/api` 开头，且以 `/api/<version>/<resource>[/<resourceName>/<subresource>]` 规则组成 APIs，最少路径层级为 3 即 `/api/<version>/<resource>`，最多路径层级为 5 即包含 `<resourceName>` 和 `<subresource>`，例如 `/api/v1/posts`。
|
||||
- 以 `/apis/<group>/<version>/<resource>[/<resourceName>/<subresource>]` 规则组成的 APIs，最少路径层级为 4 即 `/apis/<group>/<version>/<resource>`，最多路径层级为 6 即包含 `<resourceName>` 和 `<subresource>`，例如 `/apis/my-plugin.halo.run/v1alpha1/persons`。
|
||||
|
||||
:::info 注
|
||||
`[]`包裹的部分表示可选，`/api` 前缀被 Halo 保留，不允许插件定义以 `/api` 开头的资源型 APIs，所以插件的资源型 APIs 都是以 `/apis` 开头的。
|
||||
:::
|
||||
|
||||
通常可以通过 `apiGroups`、`resources`、`resourceNames`、`verbs` 来组合定义。
|
||||
例如对于资源型 API `GET /apis/my-plugin.halo.run/v1alpha1/persons`，可以定义如下规则：
|
||||
|
||||
```yaml
|
||||
rules:
|
||||
- apiGroups: [ "my-plugin.halo.run" ]
|
||||
resources: [ "my-plugin/persons" ]
|
||||
verbs: [ "list" ]
|
||||
```
|
||||
|
||||
而对于资源型 API `GET /apis/my-plugin.halo.run/v1alpha1/persons/zhangsan`，可以定义如下规则：
|
||||
|
||||
```yaml
|
||||
rules:
|
||||
- apiGroups: [ "my-plugin.halo.run" ]
|
||||
resources: [ "my-plugin/persons" ]
|
||||
resourceNames: [ "zhangsan" ]
|
||||
verbs: [ "get" ]
|
||||
```
|
||||
|
||||
关于 `verbs` 的详细说明请参考 [Verbs 详解](#verbs)。
|
||||
|
||||
### 非资源型规则 {#non-resource-rules}
|
||||
|
||||
凡是不符合资源型 APIs 规则的 APIs 都被定型为非资源型 APIs，例如 `/healthz`，可以使用以下配置方式：
|
||||
|
||||
```yaml
|
||||
rules:
|
||||
- nonResourceURLs: ["/healthz", "/healthz/*"]
|
||||
verbs: [ "get", "create"]
|
||||
```
|
||||
|
||||
非资源型规则使用 `nonResourceURLs` 来定义，其中 `nonResourceURLs` 是一个字符串数组，用于定义非资源型 APIs 的路径，`verbs` 用于定义非资源型 APIs 的请求动词。
|
||||
|
||||
`nonResourceURL` 中的 `*` 是一个全局通配符，表示匹配所有路径，如 `/healthz/*` 表示匹配 `/healthz/` 下的所有路径。
|
||||
|
||||
### 示例：定义人员管理角色模板
|
||||
|
||||
以下 YAML 文件展示了如何定义用于人员管理的角色模板：
|
||||
|
||||
```yaml
|
||||
apiVersion: v1alpha1
|
||||
kind: Role
|
||||
metadata:
|
||||
# 使用 plugin name 作为前缀防止与其他插件冲突，比如这里的 my-plugin
|
||||
name: my-plugin-role-view-persons
|
||||
labels:
|
||||
halo.run/role-template: "true"
|
||||
annotations:
|
||||
rbac.authorization.halo.run/module: "Persons Management"
|
||||
rbac.authorization.halo.run/display-name: "Person Manage"
|
||||
rbac.authorization.halo.run/ui-permissions: |
|
||||
["plugin:my-plugin:person:view"]
|
||||
rules:
|
||||
- apiGroups: ["my-plugin.halo.run"]
|
||||
resources: ["my-plugin/persons"]
|
||||
verbs: ["*"]
|
||||
---
|
||||
apiVersion: v1alpha1
|
||||
kind: Role
|
||||
metadata:
|
||||
name: my-plugin-role-manage-persons
|
||||
labels:
|
||||
halo.run/role-template: "true"
|
||||
annotations:
|
||||
rbac.authorization.halo.run/dependencies: |
|
||||
[ "role-template-view-person" ]
|
||||
rbac.authorization.halo.run/module: "Persons Management"
|
||||
rbac.authorization.halo.run/display-name: "Person Manage"
|
||||
rbac.authorization.halo.run/ui-permissions: |
|
||||
["plugin:my-plugin:person:manage"]
|
||||
rules:
|
||||
- apiGroups: [ "my-plugin.halo.run" ]
|
||||
resources: [ "my-plugin/persons" ]
|
||||
verbs: [ "get", "list" ]
|
||||
```
|
||||
|
||||
上述便是根据 [自定义模型](../api-reference/server/extension.md) 章节中定义的 Person 自定义模型来配置角色模板的示例。
|
||||
|
||||
1. 定义了一个用于管理 Person 自定义模型对象的角色模板 `my-plugin-role-manage-persons`，它具有所有权限。
|
||||
2. 定义了一个只允许查询 Person 资源的角色模板 `my-plugin-role-view-persons`。
|
||||
3. `metadata.name` 的命名规则参考 [metadata name 命名规范](../api-reference/server/extension.md#naming-spec-for-metadata-name)。
|
||||
|
||||
下面让我们回顾一下这些配置：
|
||||
|
||||
`rules` 是个数组，它允许配置多组规则：
|
||||
|
||||
- `apiGroups` 对应 `GVK` 中的 `group` 所声明的值。
|
||||
- `resources` 对应 API 中的 resource 部分。
|
||||
- `verbs` 表示请求动词，可选值为 "create", "delete", "deletecollection", "get", "list", "patch", "update", "watch"。参考 [Verbs 详解](#verbs)。
|
||||
|
||||
`metadata.labels` 中必须包含 `halo.run/role-template: "true"` 以表示它此资源要作为角色模板。
|
||||
|
||||
`metadata.annotations` 中：
|
||||
|
||||
- `rbac.authorization.halo.run/dependencies`：用于声明角色间的依赖关系，例如管理角色必须要依赖查看角色，以避免分配了管理权限却没有查看权限的情况。
|
||||
- `rbac.authorization.halo.run/module`：角色模板分组名称。在此示例中，管理 Person 的模板角色将和查看 Person 的模板角色将被在 UI 层面归为一组展示。
|
||||
- `rbac.authorization.halo.run/display-name`：模板角色的显示名称，用于展示为用户可读的名称信息。
|
||||
|
||||
### UI 权限控制 {#ui-permissions}
|
||||
|
||||
参考 [UI 权限控制](./ui-permission.md)。
|
||||
|
||||
### Verbs 详解 {#verbs}
|
||||
|
||||
`verbs` 字段用于指定用户或服务在特定资源上能执行的操作类型。这些操作被定义为一组“动词”，每个动词与相应的 HTTP 请求方法相对应。为了更好地理解如何确定合适的 `verbs`，以下是详细的解释和每种动词的具体用途：
|
||||
|
||||
动词和对应的 HTTP 方法：
|
||||
|
||||
- create: 对应 HTTP 的 POST 方法。用于创建一个新的资源实例，如果是创建子资源且不需要资源名称可以使用 `-` 表示缺省，如 `POST /apis/my-plugin.halo.run/v1alpha1/persons/-/subresource`，同时需要注意 `POST /apis/my-plugin.halo.run/v1alpha1/persons/{some-name}` 不是一个符合规范的 create 操作，创建资源不应该包含资源名称。
|
||||
- get: 对应 HTTP 的 GET 方法。用于获取单个资源的详细信息，即 API 中包含 resourceName 部分如 `GET /apis/my-plugin.halo.run/v1alpha1/persons/zhangsan`。
|
||||
- list: 同样对应 HTTP 的 GET 方法，但用于获取资源的集合（列表），这通常涵盖了多个资源实例的摘要或详细信息，如 `GET /apis/my-plugin.halo.run/v1alpha1/persons`。
|
||||
- watch: 也是对应 HTTP 的 GET 方法。用于实时监控资源或资源集合的变化，通常是通过 WebSocket 连接来实现的，如 `ws://localhost:8090/apis/my-plugin.halo.run/v1alpha1/persons`。
|
||||
- update: 对应 HTTP 的 PUT 方法。用于更新现有资源的全部内容。
|
||||
- patch: 对应 HTTP 的 PATCH 方法。用于对现有资源进行部分更新。
|
||||
- delete: 对应 HTTP 的 DELETE 方法。用于删除单个资源，即 API 中包含 resourceName 部分如 `DELETE /apis/my-plugin.halo.run/v1alpha1/persons/zhangsan`。
|
||||
- deletecollection: 同样对应 HTTP 的 DELETE 方法，但用于删除一个资源集合。
|
||||
|
||||
可以使用如下表格来简化理解：
|
||||
|
||||
| Verb | HTTP Method(s) | Description |
|
||||
|--------------------|----------------|--------------------------|
|
||||
| `create` | POST | 创建新资源实例 |
|
||||
| `get` | GET | 获取单个资源详细信息 |
|
||||
| `list` | GET | 获取资源列表 |
|
||||
| `watch` | GET | 监控资源或资源集合的变化 |
|
||||
| `update` | PUT | 更新现有资源 |
|
||||
| `patch` | PATCH | 部分更新资源 |
|
||||
| `delete` | DELETE | 删除单个资源 |
|
||||
| `deletecollection` | DELETE | 删除资源集合 |
|
||||
|
||||
## 角色绑定
|
||||
|
||||
角色绑定用于将角色中定义的权限授予一个或一组用户。它包含主体列表（用户）以及对所授予角色的引用。
|
||||
|
||||
角色绑定示例：
|
||||
|
||||
```yaml
|
||||
apiVersion: v1alpha1
|
||||
# 这个角色绑定允许 "guqing" 用户拥有 "post-reader" 角色的权限
|
||||
# 你需要在 Halo 中已经定义了一个名为 "post-reader" 的角色。
|
||||
kind: RoleBinding
|
||||
metadata:
|
||||
name: guqing-post-reader-binding
|
||||
roleRef:
|
||||
# "roleRef" 指定了绑定到的角色
|
||||
apiGroup: ''
|
||||
# 这里必须是 Role
|
||||
kind: Role
|
||||
# 这里的 name 必须匹配到一个已经定义的角色
|
||||
name: post-reader
|
||||
subjects:
|
||||
- apiGroup: ''
|
||||
kind: User
|
||||
# 这里的 name 是用户的 username
|
||||
name: guqing
|
||||
```
|
||||
|
||||
在 Halo 中，当你给一个用户分配角色后，实际上就是创建了一个”RoleBinding”对象来完成的。
|
||||
@@ -0,0 +1,101 @@
|
||||
---
|
||||
title: UI 权限控制
|
||||
description: 了解如何控制用户界面的操作权限。
|
||||
---
|
||||
UI（用户界面）权限控制是指在应用程序中，通过用户角色或身份的不同，控制用户界面上可见和可操作的元素。
|
||||
这种权限控制的目的是根据用户的权限等级和角色，动态调整他们在应用中的操作权限，从而确保系统的安全性和功能的正确使用。
|
||||
|
||||
## 什么是 UI 权限控制
|
||||
|
||||
UI 权限控制基于后端的权限系统，将不同用户分组或分角色，并根据这些分组或角色，决定用户在界面中能够看到哪些内容、进行哪些操作。
|
||||
与传统的后端权限控制相比，UI 权限控制侧重于前端展示层面的权限管理，例如隐藏按钮、禁用功能、调整界面元素等，以防止未经授权的用户误操作或访问敏感数据。
|
||||
|
||||
## UI 权限控制的核心概念
|
||||
|
||||
1. 用户角色（User Role）：UI 权限控制通常基于用户角色。例如，管理员可能拥有对系统所有模块的访问权限，而普通用户只能访问某些特定模块或功能。
|
||||
|
||||
2. 权限模型：权限模型规定了每个角色能够执行的操作以及能访问的资源。UI 权限控制根据这个模型，动态调整界面上展示的内容。
|
||||
|
||||
3. 可见性控制：UI 控制权限的一个常见方式是调整某些界面元素的可见性。例如，一个普通用户可能看不到“管理用户”或“高级设置”选项，而这些选项对管理员是可见的。
|
||||
|
||||
4. 操作控制：除了控制可见性外，UI 权限控制还可以控制用户能执行的操作。例如，某个表单中的提交按钮可能在用户没有相应权限时被禁用或移除。
|
||||
|
||||
5. 动态渲染：基于用户权限动态渲染 UI，是指前端应用在加载时会根据用户的权限信息来渲染不同的界面元素。这样确保用户只能看到和操作与其权限相符的部分。
|
||||
|
||||
## Halo 的 UI 权限控制
|
||||
|
||||
Halo 的 UI 权限控制是通过与角色模板结合来实现的，在角色模板的 `metadata.annotations` 中定义 `rbac.authorization.halo.run/ui-permissions` 来控制 UI 权限，这样可以在前端界面通过这个权限来控制菜单或者页面按钮是否展示。
|
||||
|
||||
值的规则为 `plugin:{your-plugin-name}:scope-name`, `scope-name` 为你自定义的权限名称，如下面的示例中的 `plugin:my-plugin:person:view`。
|
||||
|
||||
```yaml
|
||||
apiVersion: v1alpha1
|
||||
kind: Role
|
||||
metadata:
|
||||
name: my-plugin-role-view-persons
|
||||
labels:
|
||||
halo.run/role-template: "true"
|
||||
annotations:
|
||||
# UI 权限控制
|
||||
rbac.authorization.halo.run/ui-permissions: |
|
||||
["plugin:my-plugin:person:view"]
|
||||
rules:
|
||||
- apiGroups: ["my-plugin.halo.run"]
|
||||
resources: ["my-plugin/persons"]
|
||||
verbs: ["*"]
|
||||
```
|
||||
|
||||
当用户被分配了拥有 `my-plugin-role-view-persons` 权限的角色时，前端界面便会根据这个权限来控制菜单或者页面按钮是否展示。
|
||||
|
||||
### 菜单权限控制
|
||||
|
||||
你可以在 UI 层面使用这个权限来控制菜单是否展示：
|
||||
|
||||
```vue
|
||||
export default definePlugin({
|
||||
components: {},
|
||||
routes: [
|
||||
{
|
||||
parentName: "Root",
|
||||
route: {
|
||||
path: "/example",
|
||||
name: "Example",
|
||||
component: HomeView,
|
||||
meta: {
|
||||
title: "示例页面",
|
||||
searchable: true,
|
||||
// 菜单权限控制
|
||||
permissions: ["plugin:my-plugin:person:view"],
|
||||
menu: {
|
||||
name: "示例页面",
|
||||
group: "示例分组",
|
||||
icon: markRaw(IconPlug),
|
||||
priority: 0,
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
],
|
||||
extensionPoints: {},
|
||||
});
|
||||
```
|
||||
|
||||
参考：[plugin-starter](https://github.com/halo-dev/plugin-starter/blob/5a4a25db252a7986900368a5fbf35e8d27f5257f/ui/src/index.ts#L6-L29)
|
||||
|
||||
> 该配置示例为在插件前端部分入口文件 `index.ts`
|
||||
|
||||
### 按钮或页面组件权限控制
|
||||
|
||||
在按钮或页面组件中使用 `HasPermission` 组件来控制组件的渲染，它不需要导入可以直接使用。
|
||||
|
||||
```vue
|
||||
<template>
|
||||
<!-- HasPermission 组件不需要导入，直接使用即可 -->
|
||||
<HasPermission :permissions="['plugin:my-plugin:person:view']">
|
||||
<UserFilterDropdown
|
||||
v-model="selectedUser"
|
||||
label="用户"
|
||||
/>
|
||||
</HasPermission>
|
||||
</template>
|
||||
```
|
||||
Reference in New Issue
Block a user