OAuth 2.0 资源服务器 JWT

JWT 的最少依赖

大多数资源服务器的支持都集中在 spring-security-oauth2-resource-server 中。然而，用于解码和验证 JWT 的支持在 spring-security-oauth2-jose 中，这意味着两者都是一个支持 JWT 编码的 Bearer 令牌的资源服务器正常工作所必需的。

JWT 的最少配置

使用 Spring Boot 时，将应用程序配置为资源服务器包含两个基本步骤。首先，包含所需的依赖项。其次，指明授权服务器的位置。

指定授权服务器

在 Spring Boot 应用中，你需要指定要使用的授权服务器

spring:
  security:
    oauth2:
      resourceserver:
        jwt:
          issuer-uri: https://idp.example.com/issuer

其中 idp.example.com/issuer 是授权服务器发布的 JWT 令牌中 iss 声明包含的值。此资源服务器使用此属性进行进一步的自配置，发现授权服务器的公钥，并随后验证传入的 JWT。

要使用 issuer-uri 属性，授权服务器还必须支持以下端点之一：idp.example.com/issuer/.well-known/openid-configuration、idp.example.com/.well-known/openid-configuration/issuer 或 idp.example.com/.well-known/oauth-authorization-server/issuer。此端点被称为提供者配置 (Provider Configuration) 端点或授权服务器元数据 (Authorization Server Metadata) 端点。

启动期望

使用此属性和这些依赖项时，资源服务器会自动配置自身以验证 JWT 编码的 Bearer 令牌。

它通过一个确定性的启动过程实现这一点

  1. 访问 Provider Configuration 或 Authorization Server Metadata 端点，处理响应以获取 jwks_url 属性。

  2. 配置验证策略以查询 jwks_url 获取有效的公钥。

  3. 配置验证策略以针对 idp.example.com 验证每个 JWT 的 iss 声明。

此过程的一个结果是，授权服务器必须接收请求，以便资源服务器成功启动。

如果资源服务器在查询授权服务器时（在适当的超时设置下）授权服务器宕机，则启动将失败。

运行时期望

应用程序启动后，资源服务器会尝试处理任何包含 Authorization: Bearer header 的请求

GET / HTTP/1.1
Authorization: Bearer some-token-value # Resource Server will process this

只要指定了这种方案，资源服务器就会尝试根据 Bearer 令牌规范处理请求。

给定一个格式良好的 JWT，资源服务器会

  1. 根据启动期间从 jwks_url 端点获取并与 JWT header 匹配的公钥验证其签名。

  2. 验证 JWT 的 exp 和 nbf 时间戳以及 JWT 的 iss 声明。

  3. 将每个 scope 映射到带有前缀 SCOPE_ 的 authority。

随着授权服务器提供新密钥，Spring Security 会自动轮换用于验证 JWT 令牌的密钥。

默认情况下，生成的 Authentication#getPrincipal 是一个 Spring Security Jwt 对象，如果存在，Authentication#getName 会映射到 JWT 的 sub 属性。

从这里，你可以考虑跳转到

直接指定授权服务器 JWK Set Uri

如果授权服务器不支持任何配置端点，或者资源服务器必须能够独立于授权服务器启动，你也可以提供 jwk-set-uri

spring:
  security:
    oauth2:
      resourceserver:
        jwt:
          issuer-uri: https://idp.example.com
          jwk-set-uri: https://idp.example.com/.well-known/jwks.json

JWK Set uri 不是标准化的，但通常可以在授权服务器的文档中找到它。

因此，资源服务器在启动时不会 ping 授权服务器。我们仍然指定 issuer-uri，这样资源服务器仍然会验证传入 JWT 中的 iss 声明。

你可以直接在 DSL 上提供此属性。

覆盖或替换 Boot 自动配置

Spring Boot 为资源服务器生成两个 @Bean 对象。

第一个 bean 是一个 SecurityWebFilterChain，它将应用程序配置为资源服务器。当包含 spring-security-oauth2-jose 时，这个 SecurityWebFilterChain 看起来像

资源服务器 SecurityWebFilterChain

  • Java

  • Kotlin

@Bean
SecurityWebFilterChain springSecurityFilterChain(ServerHttpSecurity http) {
	http
		.authorizeExchange(exchanges -> exchanges
			.anyExchange().authenticated()
		)
		.oauth2ResourceServer(OAuth2ResourceServerSpec::jwt)
	return http.build();
}
@Bean
fun springSecurityFilterChain(http: ServerHttpSecurity): SecurityWebFilterChain {
    return http {
        authorizeExchange {
            authorize(anyExchange, authenticated)
        }
        oauth2ResourceServer {
            jwt { }
        }
    }
}

如果应用程序没有暴露 SecurityWebFilterChain bean，Spring Boot 会暴露默认的那个（如前所示）。

要替换它，在应用程序中暴露 @Bean

替换 SecurityWebFilterChain

  • Java

  • Kotlin

import static org.springframework.security.oauth2.core.authorization.OAuth2ReactiveAuthorizationManagers.hasScope;

@Bean
SecurityWebFilterChain springSecurityFilterChain(ServerHttpSecurity http) {
	http
		.authorizeExchange(exchanges -> exchanges
			.pathMatchers("/message/**").access(hasScope("message:read"))
			.anyExchange().authenticated()
		)
		.oauth2ResourceServer(oauth2 -> oauth2
			.jwt(withDefaults())
		);
	return http.build();
}
import org.springframework.security.oauth2.core.authorization.OAuth2ReactiveAuthorizationManagers.hasScope

@Bean
fun springSecurityFilterChain(http: ServerHttpSecurity): SecurityWebFilterChain {
    return http {
        authorizeExchange {
            authorize("/message/**", hasScope("message:read"))
            authorize(anyExchange, authenticated)
        }
        oauth2ResourceServer {
            jwt { }
        }
    }
}

前面的配置要求任何以 /messages/ 开头的 URL 都需要 message:read 范围。

oauth2ResourceServer DSL 中的方法也会覆盖或替换自动配置。

例如，Spring Boot 创建的第二个 @Bean 是一个 ReactiveJwtDecoder，它将 String 令牌解码为已验证的 Jwt 实例

ReactiveJwtDecoder

  • Java

  • Kotlin

@Bean
public ReactiveJwtDecoder jwtDecoder() {
    return ReactiveJwtDecoders.fromIssuerLocation(issuerUri);
}
@Bean
fun jwtDecoder(): ReactiveJwtDecoder {
    return ReactiveJwtDecoders.fromIssuerLocation(issuerUri)
}

调用 ReactiveJwtDecoders#fromIssuerLocation 会调用 Provider Configuration 或 Authorization Server Metadata 端点来推导 JWK Set URI。如果应用程序没有暴露 ReactiveJwtDecoder bean，Spring Boot 会暴露上面默认的那个。

它的配置可以通过使用 jwkSetUri() 来覆盖，或者通过使用 decoder() 来替换。

使用 jwkSetUri()

你可以将授权服务器的 JWK Set URI 配置为属性 或在 DSL 中提供

  • Java

  • Kotlin

@Bean
SecurityWebFilterChain springSecurityFilterChain(ServerHttpSecurity http) {
	http
		.authorizeExchange(exchanges -> exchanges
			.anyExchange().authenticated()
		)
		.oauth2ResourceServer(oauth2 -> oauth2
			.jwt(jwt -> jwt
				.jwkSetUri("https://idp.example.com/.well-known/jwks.json")
			)
		);
	return http.build();
}
@Bean
fun springSecurityFilterChain(http: ServerHttpSecurity): SecurityWebFilterChain {
    return http {
        authorizeExchange {
            authorize(anyExchange, authenticated)
        }
        oauth2ResourceServer {
            jwt {
                jwkSetUri = "https://idp.example.com/.well-known/jwks.json"
            }
        }
    }
}

使用 jwkSetUri() 优先于任何配置属性。

使用 decoder()

decoder() 比 jwkSetUri() 更强大，因为它完全替换了 Spring Boot 对 JwtDecoder 的任何自动配置

  • Java

  • Kotlin

@Bean
SecurityWebFilterChain springSecurityFilterChain(ServerHttpSecurity http) {
	http
		.authorizeExchange(exchanges -> exchanges
			.anyExchange().authenticated()
		)
		.oauth2ResourceServer(oauth2 -> oauth2
			.jwt(jwt -> jwt
				.decoder(myCustomDecoder())
			)
		);
    return http.build();
}
@Bean
fun springSecurityFilterChain(http: ServerHttpSecurity): SecurityWebFilterChain {
    return http {
        authorizeExchange {
            authorize(anyExchange, authenticated)
        }
        oauth2ResourceServer {
            jwt {
                jwtDecoder = myCustomDecoder()
            }
        }
    }
}

当你需要更深入的配置（例如验证）时，这非常有用。

暴露 ReactiveJwtDecoder 的 @Bean

或者，暴露 ReactiveJwtDecoder 的 @Bean 与使用 decoder() 效果相同：你可以像这样用 jwkSetUri 构建一个

  • Java

  • Kotlin

@Bean
public ReactiveJwtDecoder jwtDecoder() {
    return NimbusReactiveJwtDecoder.withJwkSetUri(jwkSetUri).build();
}
@Bean
fun jwtDecoder(): ReactiveJwtDecoder {
    return NimbusReactiveJwtDecoder.withJwkSetUri(jwkSetUri).build()
}

或者你可以使用 issuer，让 NimbusReactiveJwtDecoder 在调用 build() 时查找 jwkSetUri，如下所示

  • Java

  • Kotlin

@Bean
public ReactiveJwtDecoder jwtDecoder() {
    return NimbusReactiveJwtDecoder.withIssuerLocation(issuer).build();
}
@Bean
fun jwtDecoder(): ReactiveJwtDecoder {
    return NimbusReactiveJwtDecoder.withIssuerLocation(issuer).build()
}

或者，如果默认设置适合你，你也可以使用 JwtDecoders，它除了配置解码器的验证器外，还执行上述操作

  • Java

  • Kotlin

@Bean
public ReactiveJwtDecoder jwtDecoder() {
    return ReactiveJwtDecoders.fromIssuerLocation(issuer);
}
@Bean
fun jwtDecoder(): ReactiveJwtDecoder {
    return ReactiveJwtDecoders.fromIssuerLocation(issuer)
}

配置可信算法

默认情况下，NimbusReactiveJwtDecoder，因此资源服务器，只信任和验证使用 RS256 的令牌。

你可以使用 Spring Boot 或通过使用 NimbusJwtDecoder 构建器来自定义此行为。

使用 Spring Boot 自定义可信算法

设置算法最简单的方法是将其作为属性

spring:
  security:
    oauth2:
      resourceserver:
        jwt:
          jws-algorithms: RS512
          jwk-set-uri: https://idp.example.org/.well-known/jwks.json

通过使用构建器自定义可信算法

然而，为了获得更大的能力，我们可以使用 NimbusReactiveJwtDecoder 自带的构建器

  • Java

  • Kotlin

@Bean
ReactiveJwtDecoder jwtDecoder() {
    return NimbusReactiveJwtDecoder.withIssuerLocation(this.issuer)
            .jwsAlgorithm(RS512).build();
}
@Bean
fun jwtDecoder(): ReactiveJwtDecoder {
    return NimbusReactiveJwtDecoder.withIssuerLocation(this.issuer)
            .jwsAlgorithm(RS512).build()
}

多次调用 jwsAlgorithm 会配置 NimbusReactiveJwtDecoder 信任多个算法

  • Java

  • Kotlin

@Bean
ReactiveJwtDecoder jwtDecoder() {
    return NimbusReactiveJwtDecoder.withIssuerLocation(this.issuer)
            .jwsAlgorithm(RS512).jwsAlgorithm(ES512).build();
}
@Bean
fun jwtDecoder(): ReactiveJwtDecoder {
    return NimbusReactiveJwtDecoder.withIssuerLocation(this.issuer)
            .jwsAlgorithm(RS512).jwsAlgorithm(ES512).build()
}

或者，你可以调用 jwsAlgorithms

  • Java

  • Kotlin

@Bean
ReactiveJwtDecoder jwtDecoder() {
    return NimbusReactiveJwtDecoder.withIssuerLocation(this.jwkSetUri)
            .jwsAlgorithms(algorithms -> {
                    algorithms.add(RS512);
                    algorithms.add(ES512);
            }).build();
}
@Bean
fun jwtDecoder(): ReactiveJwtDecoder {
    return NimbusReactiveJwtDecoder.withIssuerLocation(this.jwkSetUri)
            .jwsAlgorithms {
                it.add(RS512)
                it.add(ES512)
            }
            .build()
}

信任单个非对称密钥

比使用 JWK Set 端点支持资源服务器更简单的方法是硬编码一个 RSA 公钥。公钥可以使用 Spring Boot 或通过使用构建器来提供。

通过 Spring Boot

你可以使用 Spring Boot 指定一个密钥

spring:
  security:
    oauth2:
      resourceserver:
        jwt:
          public-key-location: classpath:my-key.pub

或者，为了实现更复杂的查找，你可以后处理 RsaKeyConversionServicePostProcessor

BeanFactoryPostProcessor

  • Java

  • Kotlin

@Bean
BeanFactoryPostProcessor conversionServiceCustomizer() {
    return beanFactory ->
        beanFactory.getBean(RsaKeyConversionServicePostProcessor.class)
                .setResourceLoader(new CustomResourceLoader());
}
@Bean
fun conversionServiceCustomizer(): BeanFactoryPostProcessor {
    return BeanFactoryPostProcessor { beanFactory: ConfigurableListableBeanFactory ->
        beanFactory.getBean<RsaKeyConversionServicePostProcessor>()
                .setResourceLoader(CustomResourceLoader())
    }
}

指定密钥的位置

key.location: hfds://my-key.pub

然后自动装配该值

  • Java

  • Kotlin

@Value("${key.location}")
RSAPublicKey key;
@Value("\${key.location}")
val key: RSAPublicKey? = null

使用构建器

要直接注入一个 RSAPublicKey，请使用适当的 NimbusReactiveJwtDecoder 构建器

  • Java

  • Kotlin

@Bean
public ReactiveJwtDecoder jwtDecoder() {
    return NimbusReactiveJwtDecoder.withPublicKey(this.key).build();
}
@Bean
fun jwtDecoder(): ReactiveJwtDecoder {
    return NimbusReactiveJwtDecoder.withPublicKey(key).build()
}

信任单个对称密钥

你也可以使用单个对称密钥。你可以加载你的 SecretKey 并使用适当的 NimbusReactiveJwtDecoder 构建器

  • Java

  • Kotlin

@Bean
public ReactiveJwtDecoder jwtDecoder() {
    return NimbusReactiveJwtDecoder.withSecretKey(this.key).build();
}
@Bean
fun jwtDecoder(): ReactiveJwtDecoder {
    return NimbusReactiveJwtDecoder.withSecretKey(this.key).build()
}

配置授权

从 OAuth 2.0 授权服务器颁发的 JWT 通常具有 scope 或 scp 属性，指示已授予的范围（或权限）—— 例如

{ ..., "scope" : "messages contacts"}

在这种情况下，资源服务器会尝试将这些 scope 强制转换为授予权限列表，并在每个 scope 前加上字符串 SCOPE_。

这意味着，要使用从 JWT 派生的 scope 保护端点或方法，相应的表达式应包含此前缀

  • Java

  • Kotlin

import static org.springframework.security.oauth2.core.authorization.OAuth2ReactiveAuthorizationManagers.hasScope;

@Bean
SecurityWebFilterChain springSecurityFilterChain(ServerHttpSecurity http) {
	http
		.authorizeExchange(exchanges -> exchanges
			.mvcMatchers("/contacts/**").access(hasScope("contacts"))
			.mvcMatchers("/messages/**").access(hasScope("messages"))
			.anyExchange().authenticated()
		)
		.oauth2ResourceServer(OAuth2ResourceServerSpec::jwt);
    return http.build();
}
import org.springframework.security.oauth2.core.authorization.OAuth2ReactiveAuthorizationManagers.hasScope

@Bean
fun springSecurityFilterChain(http: ServerHttpSecurity): SecurityWebFilterChain {
    return http {
        authorizeExchange {
            authorize("/contacts/**", hasScope("contacts"))
            authorize("/messages/**", hasScope("messages"))
            authorize(anyExchange, authenticated)
        }
        oauth2ResourceServer {
            jwt { }
        }
    }
}

你可以使用方法安全执行类似操作

  • Java

  • Kotlin

@PreAuthorize("hasAuthority('SCOPE_messages')")
public Flux<Message> getMessages(...) {}
@PreAuthorize("hasAuthority('SCOPE_messages')")
fun getMessages(): Flux<Message> { }

手动提取权限

然而，在某些情况下，此默认设置不足。例如，一些授权服务器不使用 scope 属性。相反，它们有自己的自定义属性。在其他时候，资源服务器可能需要将属性或属性组合适配到内部权限。

为此，DSL 暴露了 jwtAuthenticationConverter()

  • Java

  • Kotlin

@Bean
SecurityWebFilterChain springSecurityFilterChain(ServerHttpSecurity http) {
	http
		.authorizeExchange(exchanges -> exchanges
			.anyExchange().authenticated()
		)
		.oauth2ResourceServer(oauth2 -> oauth2
			.jwt(jwt -> jwt
				.jwtAuthenticationConverter(grantedAuthoritiesExtractor())
			)
		);
	return http.build();
}

Converter<Jwt, Mono<AbstractAuthenticationToken>> grantedAuthoritiesExtractor() {
    JwtAuthenticationConverter jwtAuthenticationConverter =
            new JwtAuthenticationConverter();
    jwtAuthenticationConverter.setJwtGrantedAuthoritiesConverter
            (new GrantedAuthoritiesExtractor());
    return new ReactiveJwtAuthenticationConverterAdapter(jwtAuthenticationConverter);
}
@Bean
fun springSecurityFilterChain(http: ServerHttpSecurity): SecurityWebFilterChain {
    return http {
        authorizeExchange {
            authorize(anyExchange, authenticated)
        }
        oauth2ResourceServer {
            jwt {
                jwtAuthenticationConverter = grantedAuthoritiesExtractor()
            }
        }
    }
}

fun grantedAuthoritiesExtractor(): Converter<Jwt, Mono<AbstractAuthenticationToken>> {
    val jwtAuthenticationConverter = JwtAuthenticationConverter()
    jwtAuthenticationConverter.setJwtGrantedAuthoritiesConverter(GrantedAuthoritiesExtractor())
    return ReactiveJwtAuthenticationConverterAdapter(jwtAuthenticationConverter)
}

jwtAuthenticationConverter() 负责将 Jwt 转换为 Authentication。作为其配置的一部分，我们可以提供一个辅助转换器，将 Jwt 转换为授予权限的 Collection。

该最终转换器可能类似于以下 GrantedAuthoritiesExtractor

  • Java

  • Kotlin

static class GrantedAuthoritiesExtractor
        implements Converter<Jwt, Collection<GrantedAuthority>> {

    public Collection<GrantedAuthority> convert(Jwt jwt) {
        Collection<?> authorities = (Collection<?>)
                jwt.getClaims().getOrDefault("mycustomclaim", Collections.emptyList());

        return authorities.stream()
                .map(Object::toString)
                .map(SimpleGrantedAuthority::new)
                .collect(Collectors.toList());
    }
}
internal class GrantedAuthoritiesExtractor : Converter<Jwt, Collection<GrantedAuthority>> {
    override fun convert(jwt: Jwt): Collection<GrantedAuthority> {
        val authorities: List<Any> = jwt.claims
                .getOrDefault("mycustomclaim", emptyList<Any>()) as List<Any>
        return authorities
                .map { it.toString() }
                .map { SimpleGrantedAuthority(it) }
    }
}

为了更大的灵活性，DSL 支持用任何实现 Converter<Jwt, Mono<AbstractAuthenticationToken>> 的类完全替换转换器

  • Java

  • Kotlin

static class CustomAuthenticationConverter implements Converter<Jwt, Mono<AbstractAuthenticationToken>> {
    public AbstractAuthenticationToken convert(Jwt jwt) {
        return Mono.just(jwt).map(this::doConversion);
    }
}
internal class CustomAuthenticationConverter : Converter<Jwt, Mono<AbstractAuthenticationToken>> {
    override fun convert(jwt: Jwt): Mono<AbstractAuthenticationToken> {
        return Mono.just(jwt).map(this::doConversion)
    }
}

配置验证

使用最少的 Spring Boot 配置，指示授权服务器的 issuer URI，资源服务器默认会验证 iss 声明以及 exp 和 nbf 时间戳声明。

在需要自定义验证需求的情况下，资源服务器提供了两个标准验证器，并且还接受自定义的 OAuth2TokenValidator 实例。

自定义时间戳验证

JWT 实例通常有一个有效期窗口，窗口的开始由 nbf 声明指示，结束由 exp 声明指示。

然而，每个服务器都可能出现时钟漂移，这可能导致令牌在一个服务器上看起来已过期，但在另一个服务器上未过期。随着分布式系统中协作服务器数量的增加，这可能会导致一些实现上的问题。

资源服务器使用 JwtTimestampValidator 来验证令牌的有效期窗口，你可以使用 clockSkew 配置它以缓解时钟漂移问题

  • Java

  • Kotlin

@Bean
ReactiveJwtDecoder jwtDecoder() {
     NimbusReactiveJwtDecoder jwtDecoder = (NimbusReactiveJwtDecoder)
             ReactiveJwtDecoders.fromIssuerLocation(issuerUri);

     OAuth2TokenValidator<Jwt> withClockSkew = new DelegatingOAuth2TokenValidator<>(
            new JwtTimestampValidator(Duration.ofSeconds(60)),
            new IssuerValidator(issuerUri));

     jwtDecoder.setJwtValidator(withClockSkew);

     return jwtDecoder;
}
@Bean
fun jwtDecoder(): ReactiveJwtDecoder {
    val jwtDecoder = ReactiveJwtDecoders.fromIssuerLocation(issuerUri) as NimbusReactiveJwtDecoder
    val withClockSkew: OAuth2TokenValidator<Jwt> = DelegatingOAuth2TokenValidator(
            JwtTimestampValidator(Duration.ofSeconds(60)),
            JwtIssuerValidator(issuerUri))
    jwtDecoder.setJwtValidator(withClockSkew)
    return jwtDecoder
}

默认情况下，资源服务器配置了 60 秒的时钟偏移。

配置自定义验证器

你可以使用 OAuth2TokenValidator API 添加对 aud 声明的检查

  • Java

  • Kotlin

public class AudienceValidator implements OAuth2TokenValidator<Jwt> {
    OAuth2Error error = new OAuth2Error("invalid_token", "The required audience is missing", null);

    public OAuth2TokenValidatorResult validate(Jwt jwt) {
        if (jwt.getAudience().contains("messaging")) {
            return OAuth2TokenValidatorResult.success();
        } else {
            return OAuth2TokenValidatorResult.failure(error);
        }
    }
}
class AudienceValidator : OAuth2TokenValidator<Jwt> {
    var error: OAuth2Error = OAuth2Error("invalid_token", "The required audience is missing", null)
    override fun validate(jwt: Jwt): OAuth2TokenValidatorResult {
        return if (jwt.audience.contains("messaging")) {
            OAuth2TokenValidatorResult.success()
        } else {
            OAuth2TokenValidatorResult.failure(error)
        }
    }
}

然后，要将其添加到资源服务器中，你可以指定 ReactiveJwtDecoder 实例

  • Java

  • Kotlin

@Bean
ReactiveJwtDecoder jwtDecoder() {
    NimbusReactiveJwtDecoder jwtDecoder = (NimbusReactiveJwtDecoder)
            ReactiveJwtDecoders.fromIssuerLocation(issuerUri);

    OAuth2TokenValidator<Jwt> audienceValidator = new AudienceValidator();
    OAuth2TokenValidator<Jwt> withIssuer = JwtValidators.createDefaultWithIssuer(issuerUri);
    OAuth2TokenValidator<Jwt> withAudience = new DelegatingOAuth2TokenValidator<>(withIssuer, audienceValidator);

    jwtDecoder.setJwtValidator(withAudience);

    return jwtDecoder;
}
@Bean
fun jwtDecoder(): ReactiveJwtDecoder {
    val jwtDecoder = ReactiveJwtDecoders.fromIssuerLocation(issuerUri) as NimbusReactiveJwtDecoder
    val audienceValidator: OAuth2TokenValidator<Jwt> = AudienceValidator()
    val withIssuer: OAuth2TokenValidator<Jwt> = JwtValidators.createDefaultWithIssuer(issuerUri)
    val withAudience: OAuth2TokenValidator<Jwt> = DelegatingOAuth2TokenValidator(withIssuer, audienceValidator)
    jwtDecoder.setJwtValidator(withAudience)
    return jwtDecoder
}