本指南演示如何向 JWT 访问令牌添加资源所有者权限。 术语“权限”可能表示不同的形式,例如资源所有者的角色、权限或组。
若要使资源所有者的权限可供资源服务器使用,请向访问令牌添加自定义声明。 当客户端使用访问令牌访问受保护的资源时,资源服务器将能够获取有关资源所有者的访问级别的信息,以及其他潜在用途和好处。
向 JWT 访问令牌添加自定义声明
可以使用 .
请注意,这只能定义一次,因此必须注意确保自定义适当的令牌类型(在本例中为访问令牌)。
如果您有兴趣自定义 ID 令牌,请参阅用户信息映射器指南以获取更多信息。OAuth2TokenCustomizer<JWTEncodingContext>
@Bean
@Bean
以下是向访问令牌添加自定义声明的示例,换言之,授权服务器颁发的每个访问令牌都将填充自定义声明。
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 | 定义具有 in-memory 的示例用户。user1 UserDetailsService |
2 | 为 分配角色。user1 |
3 | 定义一个允许自定义 JWT 声明的内容。OAuth2TokenCustomizer<JwtEncodingContext> @Bean |
4 | 检查JWT是否为访问令牌。 |
5 | 通过 .JwtEncodingContext |
6 | 从对象中提取角色。角色信息存储为以 为前缀的字符串,因此我们在这里去除了前缀。Principal ROLE_ |
7 | 将自定义声明设置为从上一步收集的角色集。roles |
此自定义的结果是,有关用户的颁发机构信息将作为自定义声明包含在访问令牌中。
1 | 定义具有 in-memory 的示例用户。user1 UserDetailsService |
2 | 为 分配角色。user1 |
3 | 定义一个允许自定义 JWT 声明的内容。OAuth2TokenCustomizer<JwtEncodingContext> @Bean |
4 | 检查JWT是否为访问令牌。 |
5 | 通过 .JwtEncodingContext |
6 | 从对象中提取角色。角色信息存储为以 为前缀的字符串,因此我们在这里去除了前缀。Principal ROLE_ |
7 | 将自定义声明设置为从上一步收集的角色集。roles |