HTTP Service Clients Integration

Spring Security’s OAuth Support can integrate with RestClient and WebClient HTTP Service Clients.spring-doc.cn

Configuration

After RestClient or WebClient specific configuration, usage of HTTP Service Clients Integration only requires adding a @ClientRegistrationId to methods that require OAuth or their declaring HTTP interface.spring-doc.cn

Since the presence of @ClientRegistrationId determines if and how the OAuth token will be resolved, it is safe to add Spring Security’s OAuth support any configuration.spring-doc.cn

RestClient Configuration

Spring Security’s OAuth Support can integrate with HTTP Service Clients backed by RestClient. The first step is to create an OAuthAuthorizedClientManager Bean.spring-doc.cn

Next you must configure HttpServiceProxyFactory and RestClient to be aware of @ClientRegistrationId To simplify this configuration, use OAuth2RestClientHttpServiceGroupConfigurer.spring-doc.cn

Javaspring-doc.cn
Kotlinspring-doc.cn

@Bean
OAuth2RestClientHttpServiceGroupConfigurer securityConfigurer(
		OAuth2AuthorizedClientManager manager) {
	return OAuth2RestClientHttpServiceGroupConfigurer.from(manager);
}

@Bean
fun securityConfigurer(manager: OAuth2AuthorizedClientManager): OAuth2RestClientHttpServiceGroupConfigurer {
    return OAuth2RestClientHttpServiceGroupConfigurer.from(manager)
}

The configuration:spring-doc.cn

Adds ClientRegistrationIdProcessor to HttpServiceProxyFactoryspring-doc.cn
Adds OAuth2ClientHttpRequestInterceptor to the RestClientspring-doc.cn

WebClient Configuration

Spring Security’s OAuth Support can integrate with HTTP Service Clients backed by WebClient. The first step is to create an ReactiveOAuthAuthorizedClientManager Bean.spring-doc.cn

Next you must configure HttpServiceProxyFactory and WebRestClient to be aware of @ClientRegistrationId To simplify this configuration, use OAuth2WebClientHttpServiceGroupConfigurer.spring-doc.cn

Javaspring-doc.cn
Kotlinspring-doc.cn

@Bean
OAuth2WebClientHttpServiceGroupConfigurer securityConfigurer(
		ReactiveOAuth2AuthorizedClientManager manager) {
	return OAuth2WebClientHttpServiceGroupConfigurer.from(manager);
}

@Bean
fun securityConfigurer(
    manager: ReactiveOAuth2AuthorizedClientManager?
): OAuth2WebClientHttpServiceGroupConfigurer {
    return OAuth2WebClientHttpServiceGroupConfigurer.from(manager)
}

The configuration:spring-doc.cn

Adds ClientRegistrationIdProcessor to HttpServiceProxyFactoryspring-doc.cn
Adds ServerOAuth2AuthorizedClientExchangeFilterFunction to the WebClientspring-doc.cn

@ClientRegistrationId

You can add the ClientRegistrationId on the HTTP Service to specify which ClientRegistration to use.spring-doc.cn

Javaspring-doc.cn
Kotlinspring-doc.cn

	@GetExchange("/user")
	@ClientRegistrationId("github")
	User getAuthenticatedUser();

    @GetExchange("/user")
    @ClientRegistrationId("github")
    fun getAuthenticatedUser() : User

The @ClientRegistrationId will be processed by ClientRegistrationIdProcessorspring-doc.cn

Type Level Declarations

@ClientRegistrationId can also be added at the type level to avoid repeating the declaration on every method.spring-doc.cn

Javaspring-doc.cn
Kotlinspring-doc.cn

@HttpExchange
@ClientRegistrationId("github")
public interface UserService {

	@GetExchange("/user")
	User getAuthenticatedUser();

	@GetExchange("/users/{username}/hovercard")
	Hovercard getHovercard(@PathVariable String username);

}

@HttpExchange
@ClientRegistrationId("github")
interface UserService {
    @GetExchange("/user")
    fun getAuthenticatedUser(): User

    @GetExchange("/users/{username}/hovercard")
    fun getHovercard(@PathVariable username: String): Hovercard
}

`ClientRegistrationIdProcessor`

The configured ClientRegistrationIdProcessor will:spring-doc.cn

Automatically invoke ClientAttributes.clientRegistrationId(String) for each @ClientRegistrationId.spring-doc.cn
This adds the ClientRegistration.getId() to the attributesspring-doc.cn

The id is then processed by:spring-doc.cn

OAuth2ClientHttpRequestInterceptor for RestClient Integration spring-doc.cn
ServletOAuth2AuthorizedClientExchangeFilterFunction (servlets) or ServerOAuth2AuthorizedClientExchangeFilterFunction (reactive environments) for WebClient.spring-doc.cn