OAuth 2.0 资源服务器多租户

QWen Max 中英对照 Multitenancy OAuth 2.0 Resource Server Multi-tenancy

同时支持 JWT 和 Opaque Token

在某些情况下，你可能需要访问这两种类型的令牌。例如，你可能支持多个租户，其中一个租户颁发 JWT，而另一个租户颁发不透明令牌。

如果此决策必须在请求时做出，那么你可以使用 AuthenticationManagerResolver 来实现，如下所示：

Java

@Bean
AuthenticationManagerResolver<HttpServletRequest> tokenAuthenticationManagerResolver
        (JwtDecoder jwtDecoder, OpaqueTokenIntrospector opaqueTokenIntrospector) {
    AuthenticationManager jwt = new ProviderManager(new JwtAuthenticationProvider(jwtDecoder));
    AuthenticationManager opaqueToken = new ProviderManager(
            new OpaqueTokenAuthenticationProvider(opaqueTokenIntrospector));
    return (request) -> useJwt(request) ? jwt : opaqueToken;
}

java

Kotlin

@Bean
fun tokenAuthenticationManagerResolver
        (jwtDecoder: JwtDecoder, opaqueTokenIntrospector: OpaqueTokenIntrospector):
        AuthenticationManagerResolver<HttpServletRequest> {
    val jwt = ProviderManager(JwtAuthenticationProvider(jwtDecoder))
    val opaqueToken = ProviderManager(OpaqueTokenAuthenticationProvider(opaqueTokenIntrospector));

    return AuthenticationManagerResolver { request ->
        if (useJwt(request)) {
            jwt
        } else {
            opaqueToken
        }
    }
}

kotlin

备注

useJwt(HttpServletRequest) 的实现可能依赖于自定义的请求素材，如路径。

然后在DSL中指定此 AuthenticationManagerResolver：

Java

http
    .authorizeHttpRequests(authorize -> authorize
        .anyRequest().authenticated()
    )
    .oauth2ResourceServer(oauth2 -> oauth2
        .authenticationManagerResolver(this.tokenAuthenticationManagerResolver)
    );

java

Kotlin

http {
    authorizeRequests {
        authorize(anyRequest, authenticated)
    }
    oauth2ResourceServer {
        authenticationManagerResolver = tokenAuthenticationManagerResolver()
    }
}

kotlin

Xml

<http>
    <oauth2-resource-server authentication-manager-resolver-ref="tokenAuthenticationManagerResolver"/>
</http>

xml

多租户

当存在多种通过某些租户标识符来验证持有者令牌的策略时，资源服务器就被认为是多租户的。

例如，你的资源服务器可能接受来自两个不同授权服务器的持有者令牌。或者，你的授权服务器可能代表多个发行人。

在每种情况下，都有两件需要做的事情以及与你选择如何做这些事情相关的权衡：

1. 解析租户

2. 传播租户

通过声明解析租户

区分租户的一种方法是通过 issuer 声明。由于 issuer 声明伴随已签名的 JWT，这可以使用 JwtIssuerAuthenticationManagerResolver 来完成，如下所示：

Java

JwtIssuerAuthenticationManagerResolver authenticationManagerResolver = JwtIssuerAuthenticationManagerResolver
    .fromTrustedIssuers("https://idp.example.org/issuerOne", "https://idp.example.org/issuerTwo");

http
    .authorizeHttpRequests(authorize -> authorize
        .anyRequest().authenticated()
    )
    .oauth2ResourceServer(oauth2 -> oauth2
        .authenticationManagerResolver(authenticationManagerResolver)
    );

java

Kotlin

val customAuthenticationManagerResolver = JwtIssuerAuthenticationManagerResolver
    .fromTrustedIssuers("https://idp.example.org/issuerOne", "https://idp.example.org/issuerTwo")
http {
    authorizeRequests {
        authorize(anyRequest, authenticated)
    }
    oauth2ResourceServer {
        authenticationManagerResolver = customAuthenticationManagerResolver
    }
}

kotlin

Xml

<http>
    <oauth2-resource-server authentication-manager-resolver-ref="authenticationManagerResolver"/>
</http>

<bean id="authenticationManagerResolver"
        class="org.springframework.security.oauth2.server.resource.authentication.JwtIssuerAuthenticationManagerResolver">
    <constructor-arg>
        <list>
            <value>https://idp.example.org/issuerOne</value>
            <value>https://idp.example.org/issuerTwo</value>
        </list>
    </constructor-arg>
</bean>

xml

这样很好，因为颁发者端点是延迟加载的。实际上，对应的 JwtAuthenticationProvider 只有在发送带有相应颁发者的第一个请求时才会被实例化。这使得应用程序启动独立于那些授权服务器是否启动和可用。

动态租户

当然，你可能不希望每次添加新租户时都重新启动应用程序。在这种情况下，你可以使用 JwtIssuerAuthenticationManagerResolver 配置一个 AuthenticationManager 实例的仓库，你可以在运行时编辑它，如下所示：

Java

private void addManager(Map<String, AuthenticationManager> authenticationManagers, String issuer) {
    JwtAuthenticationProvider authenticationProvider = new JwtAuthenticationProvider
            (JwtDecoders.fromIssuerLocation(issuer));
    authenticationManagers.put(issuer, authenticationProvider::authenticate);
}

// ...

JwtIssuerAuthenticationManagerResolver authenticationManagerResolver =
        new JwtIssuerAuthenticationManagerResolver(authenticationManagers::get);

http
    .authorizeHttpRequests(authorize -> authorize
        .anyRequest().authenticated()
    )
    .oauth2ResourceServer(oauth2 -> oauth2
        .authenticationManagerResolver(authenticationManagerResolver)
    );

java

Kotlin

private fun addManager(authenticationManagers: MutableMap<String, AuthenticationManager>, issuer: String) {
    val authenticationProvider = JwtAuthenticationProvider(JwtDecoders.fromIssuerLocation(issuer))
    authenticationManagers[issuer] = AuthenticationManager {
        authentication: Authentication? -> authenticationProvider.authenticate(authentication)
    }
}

// ...

val customAuthenticationManagerResolver: JwtIssuerAuthenticationManagerResolver =
    JwtIssuerAuthenticationManagerResolver(authenticationManagers::get)
http {
    authorizeRequests {
        authorize(anyRequest, authenticated)
    }
    oauth2ResourceServer {
        authenticationManagerResolver = customAuthenticationManagerResolver
    }
}

kotlin

在这种情况下，你使用一种策略来构建 JwtIssuerAuthenticationManagerResolver，该策略根据颁发者（issuer）获取 AuthenticationManager。这种方法允许我们在运行时向仓库（如代码片段中所示的 Map）中添加和移除元素。

备注

简单地接受任何发行者并从中构建一个 AuthenticationManager 是不安全的。发行者应该是代码可以从可信来源（如允许的发行者列表）验证的。

仅解析一次声明

你可能已经注意到，这种策略虽然简单，但有一个缺点，即 JWT 首先由 AuthenticationManagerResolver 解析，然后在请求的后续过程中再由 JwtDecoder 解析一次。

这种额外的解析可以通过使用来自Nimbus的JWTClaimsSetAwareJWSKeySelector直接配置JwtDecoder来缓解：

Java

@Component
public class TenantJWSKeySelector
    implements JWTClaimsSetAwareJWSKeySelector<SecurityContext> {

    private final TenantRepository tenants; 1
    private final Map<String, JWSKeySelector<SecurityContext>> selectors = new ConcurrentHashMap<>(); 2

    public TenantJWSKeySelector(TenantRepository tenants) {
        this.tenants = tenants;
    }

    @Override
    public List<? extends Key> selectKeys(JWSHeader jwsHeader, JWTClaimsSet jwtClaimsSet, SecurityContext securityContext)
            throws KeySourceException {
        return this.selectors.computeIfAbsent(toTenant(jwtClaimsSet), this::fromTenant)
                .selectJWSKeys(jwsHeader, securityContext);
    }

    private String toTenant(JWTClaimsSet claimSet) {
        return (String) claimSet.getClaim("iss");
    }

    private JWSKeySelector<SecurityContext> fromTenant(String tenant) {
        return Optional.ofNullable(this.tenants.findById(tenant)) 3
                .map(t -> t.getAttrbute("jwks_uri"))
                .map(this::fromUri)
                .orElseThrow(() -> new IllegalArgumentException("unknown tenant"));
    }

    private JWSKeySelector<SecurityContext> fromUri(String uri) {
        try {
            return JWSAlgorithmFamilyJWSKeySelector.fromJWKSetURL(new URL(uri)); 4
        } catch (Exception ex) {
            throw new IllegalArgumentException(ex);
        }
    }
}

java

Kotlin

@Component
class TenantJWSKeySelector(tenants: TenantRepository) : JWTClaimsSetAwareJWSKeySelector<SecurityContext> {
    private val tenants: TenantRepository 1
    private val selectors: MutableMap<String, JWSKeySelector<SecurityContext>> = ConcurrentHashMap() 2

    init {
        this.tenants = tenants
    }

    fun selectKeys(jwsHeader: JWSHeader?, jwtClaimsSet: JWTClaimsSet, securityContext: SecurityContext): List<Key?> {
        return selectors.computeIfAbsent(toTenant(jwtClaimsSet)) { tenant: String -> fromTenant(tenant) }
                .selectJWSKeys(jwsHeader, securityContext)
    }

    private fun toTenant(claimSet: JWTClaimsSet): String {
        return claimSet.getClaim("iss") as String
    }

    private fun fromTenant(tenant: String): JWSKeySelector<SecurityContext> {
        return Optional.ofNullable(this.tenants.findById(tenant)) 3
                .map { t -> t.getAttrbute("jwks_uri") }
                .map { uri: String -> fromUri(uri) }
                .orElseThrow { IllegalArgumentException("unknown tenant") }
    }

    private fun fromUri(uri: String): JWSKeySelector<SecurityContext?> {
        return try {
            JWSAlgorithmFamilyJWSKeySelector.fromJWKSetURL(URL(uri)) 4
        } catch (ex: Exception) {
            throw IllegalArgumentException(ex)
        }
    }
}

kotlin

• 一个假设的租户信息来源

• 由租户标识符键控的JWKKeySelector缓存

• 查找租户比简单地动态计算 JWK Set 端点更安全——查找操作充当允许的租户列表

• 通过从 JWK Set 端点返回的密钥类型创建 JWSKeySelector ——这里的延迟查找意味着你不需要在启动时配置所有租户

上述密钥选择器由许多密钥选择器组成。它根据 JWT 中的 iss 声明来选择使用哪个密钥选择器。

备注

要使用这种方法，请确保授权服务器已配置为将声明集作为令牌签名的一部分。否则，你无法保证发行者未被恶意行为者篡改。

接下来，我们可以构建一个 JWTProcessor：

Java

@Bean
JWTProcessor jwtProcessor(JWTClaimsSetAwareJWSKeySelector keySelector) {
    ConfigurableJWTProcessor<SecurityContext> jwtProcessor =
            new DefaultJWTProcessor();
    jwtProcessor.setJWTClaimSetJWSKeySelector(keySelector);
    return jwtProcessor;
}

java

Kotlin

@Bean
fun jwtProcessor(keySelector: JWTClaimsSetAwareJWSKeySelector<SecurityContext>): JWTProcessor<SecurityContext> {
    val jwtProcessor = DefaultJWTProcessor<SecurityContext>()
    jwtProcessor.jwtClaimsSetAwareJWSKeySelector = keySelector
    return jwtProcessor
}

kotlin

正如你已经看到的，将租户感知下移到这一层的权衡是需要更多的配置。我们还需要一点点配置。

接下来，我们仍然希望确保你验证了颁发者。但是，由于每个JWT的颁发者可能不同，因此你也需要一个租户感知的验证器：

Java

@Component
public class TenantJwtIssuerValidator implements OAuth2TokenValidator<Jwt> {
    private final TenantRepository tenants;

    private final OAuth2Error error = new OAuth2Error(OAuth2ErrorCodes.INVALID_TOKEN, "The iss claim is not valid",
            "https://tools.ietf.org/html/rfc6750#section-3.1");

    public TenantJwtIssuerValidator(TenantRepository tenants) {
        this.tenants = tenants;
    }

    @Override
    public OAuth2TokenValidatorResult validate(Jwt token) {
        if(this.tenants.findById(token.getIssuer()) != null) {
            return OAuth2TokenValidatorResult.success();
        }
        return OAuth2TokenValidatorResult.failure(this.error);
    }
}

java

Kotlin

@Component
class TenantJwtIssuerValidator(private val tenants: TenantRepository) : OAuth2TokenValidator<Jwt> {
    private val error: OAuth2Error = OAuth2Error(OAuth2ErrorCodes.INVALID_TOKEN, "The iss claim is not valid",
            "https://tools.ietf.org/html/rfc6750#section-3.1")

    override fun validate(token: Jwt): OAuth2TokenValidatorResult {
        return if (tenants.findById(token.issuer) != null)
            OAuth2TokenValidatorResult.success() else OAuth2TokenValidatorResult.failure(error)
    }
}

kotlin

现在我们有了租户感知的处理器和租户感知的验证器，我们可以继续创建我们的 JwtDecoder：

Java

@Bean
JwtDecoder jwtDecoder(JWTProcessor jwtProcessor, OAuth2TokenValidator<Jwt> jwtValidator) {
    NimbusJwtDecoder decoder = new NimbusJwtDecoder(jwtProcessor);
    OAuth2TokenValidator<Jwt> validator = new DelegatingOAuth2TokenValidator<>
            (JwtValidators.createDefault(), jwtValidator);
    decoder.setJwtValidator(validator);
    return decoder;
}

java

Kotlin

@Bean
fun jwtDecoder(jwtProcessor: JWTProcessor<SecurityContext>?, jwtValidator: OAuth2TokenValidator<Jwt>?): JwtDecoder {
    val decoder = NimbusJwtDecoder(jwtProcessor)
    val validator: OAuth2TokenValidator<Jwt> = DelegatingOAuth2TokenValidator(JwtValidators.createDefault(), jwtValidator)
    decoder.setJwtValidator(validator)
    return decoder
}

kotlin

我们已经讨论完了租户解析的问题。

如果你选择通过JWT声明以外的方式来解析租户，那么你需要确保以相同的方式处理下游资源服务器。例如，如果你通过子域名来解析，可能需要使用相同的子域名来访问下游资源服务器。

但是，如果你通过 bearer token 中的声明来解决这个问题，请继续阅读以了解Spring Security 对 bearer token 传播的支持。