Samples use OAuth2AuthorizedClientExchangeFilterFunction

Issue: gh-5386
This commit is contained in:
Rob Winch
2018-05-25 09:37:28 -05:00
parent c68cf991ae
commit 68117d7b0b
8 changed files with 143 additions and 53 deletions

View File

@@ -23,6 +23,7 @@ import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
import org.springframework.boot.test.autoconfigure.web.servlet.AutoConfigureMockMvc; import org.springframework.boot.test.autoconfigure.web.servlet.AutoConfigureMockMvc;
import org.springframework.boot.test.context.SpringBootTest; import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.context.annotation.ComponentScan; import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Import;
import org.springframework.mock.web.MockHttpServletRequest; import org.springframework.mock.web.MockHttpServletRequest;
import org.springframework.mock.web.MockHttpServletResponse; import org.springframework.mock.web.MockHttpServletResponse;
import org.springframework.mock.web.MockHttpSession; import org.springframework.mock.web.MockHttpSession;
@@ -47,6 +48,7 @@ import org.springframework.test.annotation.DirtiesContext;
import org.springframework.test.context.junit4.SpringRunner; import org.springframework.test.context.junit4.SpringRunner;
import org.springframework.test.web.servlet.MockMvc; import org.springframework.test.web.servlet.MockMvc;
import org.springframework.test.web.servlet.MvcResult; import org.springframework.test.web.servlet.MvcResult;
import sample.config.WebClientConfig;
import java.util.HashMap; import java.util.HashMap;
import java.util.Map; import java.util.Map;
@@ -160,6 +162,7 @@ public class OAuth2AuthorizationCodeGrantApplicationTests {
@SpringBootConfiguration @SpringBootConfiguration
@EnableAutoConfiguration @EnableAutoConfiguration
@ComponentScan(basePackages = "sample.web") @ComponentScan(basePackages = "sample.web")
@Import(WebClientConfig.class)
public static class SpringBootApplicationTestConfig { public static class SpringBootApplicationTestConfig {
} }
} }

View File

@@ -0,0 +1,35 @@
/*
* Copyright 2002-2018 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package sample.config;
import org.springframework.context.annotation.Bean;
import org.springframework.security.oauth2.client.web.reactive.function.client.OAuth2AuthorizedClientExchangeFilterFunction;
import org.springframework.web.reactive.function.client.WebClient;
/**
* @author Rob Winch
* @since 5.1
*/
public class WebClientConfig {
@Bean
WebClient webClient() {
return WebClient.builder()
.filter(new OAuth2AuthorizedClientExchangeFilterFunction())
.build();
}
}

View File

@@ -15,24 +15,28 @@
*/ */
package sample.web; package sample.web;
import org.springframework.http.HttpHeaders;
import org.springframework.security.oauth2.client.OAuth2AuthorizedClient; import org.springframework.security.oauth2.client.OAuth2AuthorizedClient;
import org.springframework.security.oauth2.client.annotation.OAuth2Client; import org.springframework.security.oauth2.client.annotation.OAuth2Client;
import org.springframework.stereotype.Controller; import org.springframework.stereotype.Controller;
import org.springframework.ui.Model; import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.GetMapping; import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.reactive.function.client.ClientRequest;
import org.springframework.web.reactive.function.client.ExchangeFilterFunction;
import org.springframework.web.reactive.function.client.WebClient; import org.springframework.web.reactive.function.client.WebClient;
import reactor.core.publisher.Mono;
import java.util.List; import java.util.List;
import static org.springframework.security.oauth2.client.web.reactive.function.client.OAuth2AuthorizedClientExchangeFilterFunction.oauth2AuthorizedClient;
/** /**
* @author Joe Grandja * @author Joe Grandja
* @author Rob Winch
*/ */
@Controller @Controller
public class GitHubReposController { public class GitHubReposController {
private final WebClient webClient;
public GitHubReposController(WebClient webClient) {
this.webClient = webClient;
}
@GetMapping("/") @GetMapping("/")
public String index() { public String index() {
@@ -42,11 +46,10 @@ public class GitHubReposController {
@GetMapping("/repos") @GetMapping("/repos")
public String gitHubRepos(Model model, @OAuth2Client("github") OAuth2AuthorizedClient authorizedClient) { public String gitHubRepos(Model model, @OAuth2Client("github") OAuth2AuthorizedClient authorizedClient) {
String endpointUri = "https://api.github.com/user/repos"; String endpointUri = "https://api.github.com/user/repos";
List repos = WebClient.builder() List repos = this.webClient
.filter(oauth2Credentials(authorizedClient))
.build()
.get() .get()
.uri(endpointUri) .uri(endpointUri)
.attributes(oauth2AuthorizedClient(authorizedClient))
.retrieve() .retrieve()
.bodyToMono(List.class) .bodyToMono(List.class)
.block(); .block();
@@ -54,14 +57,4 @@ public class GitHubReposController {
return "github-repos"; return "github-repos";
} }
private ExchangeFilterFunction oauth2Credentials(OAuth2AuthorizedClient authorizedClient) {
return ExchangeFilterFunction.ofRequestProcessor(
clientRequest -> {
ClientRequest authorizedRequest = ClientRequest.from(clientRequest)
.header(HttpHeaders.AUTHORIZATION, "Bearer " + authorizedClient.getAccessToken().getTokenValue())
.build();
return Mono.just(authorizedRequest);
});
}
} }

View File

@@ -0,0 +1,35 @@
/*
* Copyright 2002-2018 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package sample;
import org.springframework.context.annotation.Bean;
import org.springframework.security.oauth2.client.web.reactive.function.client.OAuth2AuthorizedClientExchangeFilterFunction;
import org.springframework.web.reactive.function.client.WebClient;
/**
* @author Rob Winch
* @since 5.1
*/
public class WebClientConfig {
@Bean
WebClient webClient() {
return WebClient.builder()
.filter(new OAuth2AuthorizedClientExchangeFilterFunction())
.build();
}
}

View File

@@ -16,17 +16,16 @@
package sample.web; package sample.web;
import static org.springframework.security.oauth2.client.web.reactive.function.client.OAuth2AuthorizedClientExchangeFilterFunction.oauth2AuthorizedClient;
import java.util.Map; import java.util.Map;
import org.springframework.http.HttpHeaders;
import org.springframework.security.oauth2.client.OAuth2AuthorizedClient; import org.springframework.security.oauth2.client.OAuth2AuthorizedClient;
import org.springframework.security.oauth2.client.annotation.OAuth2Client; import org.springframework.security.oauth2.client.annotation.OAuth2Client;
import org.springframework.stereotype.Controller; import org.springframework.stereotype.Controller;
import org.springframework.ui.Model; import org.springframework.ui.Model;
import org.springframework.util.StringUtils; import org.springframework.util.StringUtils;
import org.springframework.web.bind.annotation.GetMapping; import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.reactive.function.client.ClientRequest;
import org.springframework.web.reactive.function.client.ExchangeFilterFunction;
import org.springframework.web.reactive.function.client.WebClient; import org.springframework.web.reactive.function.client.WebClient;
import reactor.core.publisher.Mono; import reactor.core.publisher.Mono;
@@ -36,6 +35,11 @@ import reactor.core.publisher.Mono;
*/ */
@Controller @Controller
public class OAuth2LoginController { public class OAuth2LoginController {
private final WebClient webClient;
public OAuth2LoginController(WebClient webClient) {
this.webClient = webClient;
}
@GetMapping("/") @GetMapping("/")
public String index(Model model, @OAuth2Client OAuth2AuthorizedClient authorizedClient) { public String index(Model model, @OAuth2Client OAuth2AuthorizedClient authorizedClient) {
@@ -50,25 +54,14 @@ public class OAuth2LoginController {
String userInfoEndpointUri = authorizedClient.getClientRegistration() String userInfoEndpointUri = authorizedClient.getClientRegistration()
.getProviderDetails().getUserInfoEndpoint().getUri(); .getProviderDetails().getUserInfoEndpoint().getUri();
if (!StringUtils.isEmpty(userInfoEndpointUri)) { // userInfoEndpointUri is optional for OIDC Clients if (!StringUtils.isEmpty(userInfoEndpointUri)) { // userInfoEndpointUri is optional for OIDC Clients
userAttributes = WebClient.builder() userAttributes = this.webClient
.filter(oauth2Credentials(authorizedClient))
.build()
.get() .get()
.uri(userInfoEndpointUri) .uri(userInfoEndpointUri)
.attributes(oauth2AuthorizedClient(authorizedClient))
.retrieve() .retrieve()
.bodyToMono(Map.class); .bodyToMono(Map.class);
} }
model.addAttribute("userAttributes", userAttributes); model.addAttribute("userAttributes", userAttributes);
return "userinfo"; return "userinfo";
} }
private ExchangeFilterFunction oauth2Credentials(OAuth2AuthorizedClient authorizedClient) {
return ExchangeFilterFunction.ofRequestProcessor(
clientRequest -> {
ClientRequest authorizedRequest = ClientRequest.from(clientRequest)
.header(HttpHeaders.AUTHORIZATION, "Bearer " + authorizedClient.getAccessToken().getTokenValue())
.build();
return Mono.just(authorizedRequest);
});
}
} }

View File

@@ -32,6 +32,7 @@ import org.springframework.boot.test.autoconfigure.web.servlet.AutoConfigureMock
import org.springframework.boot.test.context.SpringBootTest; import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.ComponentScan; import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Import;
import org.springframework.http.HttpStatus; import org.springframework.http.HttpStatus;
import org.springframework.security.config.annotation.web.builders.HttpSecurity; import org.springframework.security.config.annotation.web.builders.HttpSecurity;
import org.springframework.security.config.annotation.web.configuration.EnableWebSecurity; import org.springframework.security.config.annotation.web.configuration.EnableWebSecurity;
@@ -57,6 +58,7 @@ import org.springframework.security.oauth2.core.user.OAuth2UserAuthority;
import org.springframework.test.context.junit4.SpringRunner; import org.springframework.test.context.junit4.SpringRunner;
import org.springframework.web.util.UriComponents; import org.springframework.web.util.UriComponents;
import org.springframework.web.util.UriComponentsBuilder; import org.springframework.web.util.UriComponentsBuilder;
import sample.WebClientConfig;
import java.net.URI; import java.net.URI;
import java.net.URL; import java.net.URL;
@@ -401,6 +403,7 @@ public class OAuth2LoginApplicationTests {
@SpringBootConfiguration @SpringBootConfiguration
@EnableAutoConfiguration @EnableAutoConfiguration
@ComponentScan(basePackages = "sample.web") @ComponentScan(basePackages = "sample.web")
@Import(WebClientConfig.class)
public static class SpringBootApplicationTestConfig { public static class SpringBootApplicationTestConfig {
@Autowired @Autowired

View File

@@ -0,0 +1,35 @@
/*
* Copyright 2002-2018 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package sample;
import org.springframework.context.annotation.Bean;
import org.springframework.security.oauth2.client.web.reactive.function.client.OAuth2AuthorizedClientExchangeFilterFunction;
import org.springframework.web.reactive.function.client.WebClient;
/**
* @author Rob Winch
* @since 5.1
*/
public class WebClientConfig {
@Bean
WebClient webClient() {
return WebClient.builder()
.filter(new OAuth2AuthorizedClientExchangeFilterFunction())
.build();
}
}

View File

@@ -15,26 +15,30 @@
*/ */
package sample.web; package sample.web;
import org.springframework.http.HttpHeaders; import static org.springframework.security.oauth2.client.web.reactive.function.client.OAuth2AuthorizedClientExchangeFilterFunction.oauth2AuthorizedClient;
import java.util.Collections;
import java.util.Map;
import org.springframework.security.oauth2.client.OAuth2AuthorizedClient; import org.springframework.security.oauth2.client.OAuth2AuthorizedClient;
import org.springframework.security.oauth2.client.annotation.OAuth2Client; import org.springframework.security.oauth2.client.annotation.OAuth2Client;
import org.springframework.stereotype.Controller; import org.springframework.stereotype.Controller;
import org.springframework.ui.Model; import org.springframework.ui.Model;
import org.springframework.util.StringUtils; import org.springframework.util.StringUtils;
import org.springframework.web.bind.annotation.GetMapping; import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.reactive.function.client.ClientRequest;
import org.springframework.web.reactive.function.client.ExchangeFilterFunction;
import org.springframework.web.reactive.function.client.WebClient; import org.springframework.web.reactive.function.client.WebClient;
import reactor.core.publisher.Mono;
import java.util.Collections;
import java.util.Map;
/** /**
* @author Joe Grandja * @author Joe Grandja
* @author Rob Winch
*/ */
@Controller @Controller
public class OAuth2LoginController { public class OAuth2LoginController {
private final WebClient webClient;
public OAuth2LoginController(WebClient webClient) {
this.webClient = webClient;
}
@GetMapping("/") @GetMapping("/")
public String index(Model model, @OAuth2Client OAuth2AuthorizedClient authorizedClient) { public String index(Model model, @OAuth2Client OAuth2AuthorizedClient authorizedClient) {
@@ -49,11 +53,10 @@ public class OAuth2LoginController {
String userInfoEndpointUri = authorizedClient.getClientRegistration() String userInfoEndpointUri = authorizedClient.getClientRegistration()
.getProviderDetails().getUserInfoEndpoint().getUri(); .getProviderDetails().getUserInfoEndpoint().getUri();
if (!StringUtils.isEmpty(userInfoEndpointUri)) { // userInfoEndpointUri is optional for OIDC Clients if (!StringUtils.isEmpty(userInfoEndpointUri)) { // userInfoEndpointUri is optional for OIDC Clients
userAttributes = WebClient.builder() userAttributes = this.webClient
.filter(oauth2Credentials(authorizedClient))
.build()
.get() .get()
.uri(userInfoEndpointUri) .uri(userInfoEndpointUri)
.attributes(oauth2AuthorizedClient(authorizedClient))
.retrieve() .retrieve()
.bodyToMono(Map.class) .bodyToMono(Map.class)
.block(); .block();
@@ -61,14 +64,4 @@ public class OAuth2LoginController {
model.addAttribute("userAttributes", userAttributes); model.addAttribute("userAttributes", userAttributes);
return "userinfo"; return "userinfo";
} }
private ExchangeFilterFunction oauth2Credentials(OAuth2AuthorizedClient authorizedClient) {
return ExchangeFilterFunction.ofRequestProcessor(
clientRequest -> {
ClientRequest authorizedRequest = ClientRequest.from(clientRequest)
.header(HttpHeaders.AUTHORIZATION, "Bearer " + authorizedClient.getAccessToken().getTokenValue())
.build();
return Mono.just(authorizedRequest);
});
}
} }