方法:将权限作为自定义声明添加到 JWT 访问令牌中
本指南演示如何将资源所有者权限添加到 JWT 访问令牌中。“权限”一词可以表示各种形式,例如资源所有者的角色、权限或组。
为了使资源所有者的权限可用于资源服务器,我们将自定义声明添加到访问令牌中。当客户端使用访问令牌访问受保护的资源时,资源服务器将能够获取有关资源所有者访问级别的信息,以及其他潜在用途和好处。
向 JWT 访问令牌添加自定义声明
您可以使用 `OAuth2TokenCustomizer
以下是向访问令牌添加自定义声明的示例——换句话说,授权服务器发出的每个访问令牌都将填充自定义声明。
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.security.oauth2.server.authorization.OAuth2TokenType;
import org.springframework.security.oauth2.server.authorization.token.JwtEncodingContext;
import org.springframework.security.oauth2.server.authorization.token.OAuth2TokenCustomizer;
@Configuration
public class CustomClaimsConfiguration {
@Bean
public OAuth2TokenCustomizer<JwtEncodingContext> jwtTokenCustomizer() {
return (context) -> {
if (OAuth2TokenType.ACCESS_TOKEN.equals(context.getTokenType())) {
context.getClaims().claims((claims) -> {
claims.put("claim-1", "value-1");
claims.put("claim-2", "value-2");
});
}
};
}
}
将权限作为自定义声明添加到 JWT 访问令牌中
要将资源所有者的权限添加到 JWT 访问令牌中,我们可以参考上面的自定义声明映射方法,并使用 `Principal` 的权限填充自定义声明。
出于演示目的,我们定义了一个带有权限集的示例用户,并在访问令牌中使用这些权限填充自定义声明。
1 | 使用内存中的 `UserDetailsService` 定义一个示例用户 `user1`。 |
2 | 为 `user1` 分配角色。 |
3 | 定义一个 `OAuth2TokenCustomizer |
4 | 检查 JWT 是否为访问令牌。 |
5 | 通过 `JwtEncodingContext` 访问默认声明。 |
6 | 从 `Principal` 对象中提取角色。角色信息存储为以 `ROLE_` 为前缀的字符串,因此我们在此处删除前缀。 |
7 | 将自定义声明 `roles` 设置为从上一步收集的角色集。 |
由于此自定义,用户权限信息将作为自定义声明包含在访问令牌中。