1.2. 使用注解进行授权
Quarkus 包括内置的安全性,以根据通用安全注释 @RolesAllowed、@DenyAll、@PermitAll on REST 端点和 CDI Bean 来允许 基于角色的访问控制(RBAC)。
在检查标准安全注解前,执行对 quarkus.http.auth. 配置的授权检查。因此,@PermitAll 仅允许访问尚未受 HTTP 权限限制的路径。@PermitAll 无法覆盖 HTTP 级别的安全配置,只有其他标准安全注释(如 @RolesAllowed )实施的限制。
| 注解类型 | 描述 |
|---|---|
|
| 指定不允许安全角色调用指定的方法。 |
|
| 指定允许所有安全角色调用指定的方法。
|
|
| 指定允许访问应用程序中方法的安全角色列表。 |
|
|
Quarkus 提供 |
|
| 指定允许调用指定方法的权限列表。 |
|
|
指定 named |
以下 SubjectExposingResource 示例演示了 一个端点,它使用 Jakarta REST 和 Common Security 注解来描述和保护其端点。
SubjectExposingResource 示例
- 1
/subject/secured端点需要通过使用@RolesAllowed ("Tester")注释而具有授权的"Tester"角色的经过身份验证的用户。- 2
- 端点从 Jakarta REST
SecurityContext获取用户主体。这会为安全端点返回非null。 - 3
/subject/authenticated端点可通过指定@Authenticated注释来允许任何经过身份验证的用户。- 4
/subject/unsecured端点通过指定@PermitAll注释来允许未经身份验证的访问。- 5
- 如果调用者被验证,则获取用户主体的调用会返回
。null - 6
/subject/denied端点声明@DenyAll注释,不允许以 REST 方法直接访问它,而不考虑调用它的用户。此方法仍然可由此类中的其他方法在内部执行。
如果您计划在 IO 线程上使用标准安全注解,请查看 主动身份验证 中的信息。
@RolesAllowed 注释值支持属性 表达式,包括默认值和嵌套属性表达式。与注解搭配使用的配置属性会在运行时解决。
| 注解 | 值解释 |
|---|---|
|
|
端点允许具有由 |
|
| 显示该值可包含多个变量的示例。 |
|
|
默认值演示。所需的角色由 |
@RolesAllowed 注解中的属性表达式使用示例
主题访问控制示例
- 1
@RolesAllowed注释值设置为Administrator的值。- 2
- 此
/subject/software-tester端点需要一个经过身份验证的用户,该用户被授予了"Software-Tester"的角色。可以在角色定义中使用多个表达式。 - 3
- 此
/subject/user端点需要一个经过身份验证的用户,该用户已通过使用@RolesAllowed ("${customer:User}")注解授予角色"User",因为我们没有设置配置属性客户。 - 4
- 在生产环境中,这个
/subject/secured端点需要一个具有User角色的经过身份验证的用户。在开发模式中,它允许任何经过身份验证的用户。 - 5
- 属性表达式
all-roles将被视为集合类型列表,因此可为角色管理员、软件、测试程序和用户访问端点。
1.2.1. 端点安全注解和 Jakarta REST 继承 复制链接链接已复制到粘贴板!
Quarkus 支持放置在端点实现或其类上,如下例所示:
声明为默认接口方法的 RESTEasy 子资源 locators 无法被标准安全注解保护。必须在接口实现器上实现并保护安全的子资源 locators,如下例所示:
1.2.2. 权限注解 复制链接链接已复制到粘贴板!
Quarkus 还提供 io.quarkus.security.PermissionsAllowed 注解,它会授权任何具有给定权限的用户访问资源。此注解是常见安全注解的扩展,检查授予了 SecurityIdentity 实例的权限。
使用 @PermissionsAllowed 注释保护的端点示例
- 1
- 资源方法
createOrUpdate只能被具有create和update权限的用户访问。 - 2
- 默认情况下,至少需要通过一个注解实例指定的权限之一。您可以通过设置
inclusive=true来要求所有权限。两种资源方法createOrUpdate都有相等的授权要求。 - 3
- 如果
SecurityIdentity有读取权限,则授予getItem权限或查看权限以及all或detail操作之一。 - 4
- 您可以使用您首选的
java.security.Permission实现。默认情况下,基于字符串的权限由io.quarkus.security.StringPermission执行。 - 5
- 权限不是 Bean,因此获取 bean 实例的唯一方式是使用
Arc.container ()以编程方式。
如果您计划在 IO 线程上使用 @PermissionsAllowed,请查看 主动身份验证 中的信息。
由于 Quarkus 拦截器的限制,@PermissionsAllowed 在类级别上不能可重复。如需更多信息,请参阅 Quarkus "CDI 参考"指南中的 Repeatable interceptor bindings 部分。
为启用了角色的 SecurityIdentity 实例添加权限的最简单方法是将角色映射到权限。使用 Authorization using configuration 将 CRUDResource 端点所需的 SecurityIdentity 权限授予经过身份验证的用户,如下例所示:
- 1
- 将权限
see和all添加到用户角色的SecurityIdentity实例中。同样,对于@PermissionsAllowed注释,默认使用io.quarkus.security.StringPermission。 - 2
- 权限
创建、update和read被映射到角色admin。 - 3
- 4
- 您可以指定
java.security.Permission类的自定义实现。自定义类必须精确定义一个构造器,它接受权限名称和可选的一些操作,如String数组。在这种情况下,权限列表被添加到SecurityIdentity实例中,作为新的 CustomPermission ("。list")
您还可以使用额外的构造器参数创建自定义 java.security.Permission 类。这些附加参数名称与标上 @PermissionsAllowed 注释的方法的参数名称匹配。之后,Quarkus 使用实际参数实例化您的自定义权限,其中调用了 @PermissionsAllowed 注解的方法。
接受额外参数的自定义 java.security.Permission 类示例
- 1
- 自定义
权限类必须只有一个构造器。第一个参数始终被视为权限名称,必须是String类型。Quarkus 可以选择性地将权限操作传递给构造器。为此,请将第二个参数声明为String[]。
如果允许 SecurityIdentity 执行其中一个必要操作(如 读取、写入 或 列表 ),则 LibraryPermission 类允许访问当前或父库。
以下示例演示了如何使用 LibraryPermission 类:
使用 LibraryPermission保护的资源示例
与 CRUDResource 示例类似,以下示例演示了如何为用户授予具有 admin 角色的用户更新 MediaLibrary :
quarkus.http.auth.policy.role-policy3.permissions.admin=media-library:list,media-library:read,media-library:write quarkus.http.auth.policy.role-policy3.permission-class=org.acme.library.MediaLibraryPermission quarkus.http.auth.permission.roles3.paths=/library/* quarkus.http.auth.permission.roles3.policy=role-policy3
quarkus.http.auth.policy.role-policy3.permissions.admin=media-library:list,media-library:read,media-library:write
quarkus.http.auth.policy.role-policy3.permission-class=org.acme.library.MediaLibraryPermission
quarkus.http.auth.permission.roles3.paths=/library/*
quarkus.http.auth.permission.roles3.policy=role-policy3
- 1
- 授予权限
media-library,允许读取、写入和列出操作。因为MediaLibrary是TvLibrary类父级,因此还允许具有admin角色的用户修改TvLibrary。
可以在 Keycloak 供应商 Dev UI 页面中测试 /library RAID 路径,因为用户 alice 由 Keycloak 的 Dev Services 自动创建且具有 admin 角色。
目前提供的示例演示有角色到权限映射。也可以以编程方式向 SecurityIdentity 实例添加权限。在以下示例中,自定义SecurityIdentity 来添加之前通过 HTTP 角色策略授予的相同权限。
以编程方式将 LibraryPermission 添加到 SecurityIdentity的示例
- 1
- 添加可执行
读取、写入和列出操作的media-library权限。因为MediaLibrary是TvLibrary类父级,因此还允许具有admin角色的用户修改TvLibrary。
基于注解的权限不适用于自定义 Jakarta REST SecurityContexts,因为 jakarta.ws.rs.core.SecurityContext 中没有权限。
1.2.2.1. 创建权限检查器 复制链接链接已复制到粘贴板!
默认情况下,SecurityIdentity 必须配置有权限,可用于检查此身份是否通过 @PermissionAllowed 授权限制。或者,您可以使用 @PermissionChecker 注释将任何 CDI bean 方法标记为权限检查程序。@PermissionChecker 注释值应与 @PermissionsAllowed 注释值声明所需的权限匹配。例如,可以创建权限检查程序,如下所示:
权限检查器方法可以在普通范围的 CDI Bean 或 @Singleton bean 上声明。目前不支持 @Dependent CDI bean 范围。
上面的权限检查程序需要 SecurityIdentity 实例授权 renameProject 端点。您可以在资源上直接声明 rename-project 权限检查程序,您可以在任何 CDI bean 上声明它,如下例所示:
默认情况下,权限检查在事件循环上运行。如果要在 worker 线程上运行检查,使用 io.smallrye.common.annotation.Blocking 注解注解权限检查程序方法。
@PermissionsAllowed 值和 @PermissionChecker 值之间的匹配基于字符串 equality,如下例所示:
1.2.2.2. 创建权限 meta-annotations 复制链接链接已复制到粘贴板!
@PermissionsAllowed 也可以用于 meta-annotations。例如,可以创建一个新的 @CanWrite 安全注解,如下所示:
- 1
- 使用
@CanWrite注释标注的任何方法或类都通过@PermissionsAllowed注释实例进行保护。
1.2.2.3. 将 @BeanParam 参数传递给自定义权限 复制链接链接已复制到粘贴板!
Quarkus 可以将安全方法参数的字段映射到自定义权限构造器参数。您可以使用此功能将 jakarta.ws.rs.BeanParam 参数传递给您的自定义权限。让我们考虑以下 Jakarta REST 资源:
- 1
params注解属性指定用户主体名称应传递给BeanParamPermissionChecker#canSayHello方法。其他BeanParamPermissionChecker#canSayHello方法参数(如customAuthorizationHeader和查询)会自动匹配。Quarkus 在beanParam字段及其公共访问器之间标识BeanParamPermissionChecker#canSayHello方法参数。为避免模糊解析,自动检测仅适用于beanParam字段。因此,我们必须明确指定用户主体名称的路径。
其中声明了 SimpleBeanParam 类,如下例所示:
下面是一个 @PermissionChecker 方法的示例,它根据用户主体、自定义标头和查询参数检查 say-hello 权限:
您可以将 @BeanParam 直接传递给 @PermissionChecker 方法,并以编程方式访问其字段。当您有多个不同的结构化 @BeanParam 类时,使用 @PermissionsAllowed Serialparams 属性引用 @BeanParam 字段的功能很有用。