Add ":servlet:spring-boot:java:oauth2:resource-server:opaque"

servlet/spring-boot/java/oauth2/resource-server/opaque/src/integTest/java/example/OAuth2ResourceServerApplicationITests.java

@@ -0,0 +1,105 @@
+/*
+ * Copyright 2020 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
+ *
+ *      https://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 example;
+
+import org.junit.jupiter.api.Test;
+
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.boot.test.autoconfigure.web.servlet.AutoConfigureMockMvc;
+import org.springframework.boot.test.context.SpringBootTest;
+import org.springframework.http.HttpHeaders;
+import org.springframework.mock.web.MockHttpServletRequest;
+import org.springframework.test.context.ActiveProfiles;
+import org.springframework.test.web.servlet.MockMvc;
+import org.springframework.test.web.servlet.request.RequestPostProcessor;
+
+import static org.hamcrest.Matchers.containsString;
+import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get;
+import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.content;
+import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.header;
+import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;
+
+/**
+ * Integration tests for {@link OAuth2ResourceServerApplication}.
+ *
+ * @author Josh Cummings
+ */
+@SpringBootTest
+@AutoConfigureMockMvc
+@ActiveProfiles("test")
+public class OAuth2ResourceServerApplicationITests {
+
+	String noScopesToken = "00ed5855-1869-47a0-b0c9-0f3ce520aee7";
+
+	String messageReadToken = "b43d1500-c405-4dc9-b9c9-6cfd966c34c9";
+
+	@Autowired
+	MockMvc mvc;
+
+	@Test
+	void performWhenValidBearerTokenThenAllows() throws Exception {
+
+		// @formatter:off
+		this.mvc.perform(get("/").with(bearerToken(this.noScopesToken)))
+				.andExpect(status().isOk())
+				.andExpect(content().string(containsString("Hello, subject!")));
+		// @formatter:on
+	}
+
+	// -- tests with scopes
+
+	@Test
+	void performWhenValidBearerTokenThenScopedRequestsAlsoWork() throws Exception {
+
+		// @formatter:off
+		this.mvc.perform(get("/message").with(bearerToken(this.messageReadToken)))
+				.andExpect(status().isOk())
+				.andExpect(content().string(containsString("secret message")));
+		// @formatter:on
+	}
+
+	@Test
+	void performWhenInsufficientlyScopedBearerTokenThenDeniesScopedMethodAccess() throws Exception {
+
+		// @formatter:off
+		this.mvc.perform(get("/message").with(bearerToken(this.noScopesToken)))
+				.andExpect(status().isForbidden())
+				.andExpect(header().string(HttpHeaders.WWW_AUTHENTICATE,
+						containsString("Bearer error=\"insufficient_scope\"")));
+		// @formatter:on
+	}
+
+	private static BearerTokenRequestPostProcessor bearerToken(String token) {
+		return new BearerTokenRequestPostProcessor(token);
+	}
+
+	private static class BearerTokenRequestPostProcessor implements RequestPostProcessor {
+
+		private String token;
+
+		BearerTokenRequestPostProcessor(String token) {
+			this.token = token;
+		}
+
+		@Override
+		public MockHttpServletRequest postProcessRequest(MockHttpServletRequest request) {
+			request.addHeader("Authorization", "Bearer " + this.token);
+			return request;
+		}
+
+	}
+
+}

servlet/spring-boot/java/oauth2/resource-server/opaque/src/main/java/example/OAuth2ResourceServerApplication.java

@@ -0,0 +1,33 @@
+/*
+ * Copyright 2020 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
+ *
+ *      https://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 example;
+
+import org.springframework.boot.SpringApplication;
+import org.springframework.boot.autoconfigure.SpringBootApplication;
+
+/**
+ * OAuth2 Resource Application.
+ *
+ * @author Josh Cummings
+ */
+@SpringBootApplication
+public class OAuth2ResourceServerApplication {
+
+	public static void main(String[] args) {
+		SpringApplication.run(OAuth2ResourceServerApplication.class, args);
+	}
+
+}

servlet/spring-boot/java/oauth2/resource-server/opaque/src/main/java/example/OAuth2ResourceServerController.java

@@ -0,0 +1,48 @@
+/*
+ * Copyright 2020 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
+ *
+ *      https://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 example;
+
+import org.springframework.security.core.annotation.AuthenticationPrincipal;
+import org.springframework.security.oauth2.core.OAuth2AuthenticatedPrincipal;
+import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.PostMapping;
+import org.springframework.web.bind.annotation.RequestBody;
+import org.springframework.web.bind.annotation.RestController;
+
+/**
+ * Controller demonstrating OAuth.
+ *
+ * @author Josh Cummings
+ */
+@RestController
+public class OAuth2ResourceServerController {
+
+	@GetMapping("/")
+	public String index(@AuthenticationPrincipal OAuth2AuthenticatedPrincipal principal) {
+		return String.format("Hello, %s!", (String) principal.getAttribute("sub"));
+	}
+
+	@GetMapping("/message")
+	public String message() {
+		return "secret message";
+	}
+
+	@PostMapping("/message")
+	public String createMessage(@RequestBody String message) {
+		return String.format("Message was created. Content: %s", message);
+	}
+
+}

servlet/spring-boot/java/oauth2/resource-server/opaque/src/main/java/example/OAuth2ResourceServerSecurityConfiguration.java

@@ -0,0 +1,59 @@
+/*
+ * Copyright 2020 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
+ *
+ *      https://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 example;
+
+import org.springframework.beans.factory.annotation.Value;
+import org.springframework.http.HttpMethod;
+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.WebSecurityConfigurerAdapter;
+
+/**
+ * OAuth2 Security Configuration.
+ *
+ * @author Josh Cummings
+ */
+@EnableWebSecurity
+public class OAuth2ResourceServerSecurityConfiguration extends WebSecurityConfigurerAdapter {
+
+	@Value("${spring.security.oauth2.resourceserver.opaque.introspection-uri}")
+	String introspectionUri;
+
+	@Value("${spring.security.oauth2.resourceserver.opaque.introspection-client-id}")
+	String clientId;
+
+	@Value("${spring.security.oauth2.resourceserver.opaque.introspection-client-secret}")
+	String clientSecret;
+
+	@Override
+	protected void configure(HttpSecurity http) throws Exception {
+		// @formatter:off
+		http
+			.authorizeRequests((requests) -> requests
+					.mvcMatchers(HttpMethod.GET, "/message/**").hasAuthority("SCOPE_message:read")
+					.mvcMatchers(HttpMethod.POST, "/message/**").hasAuthority("SCOPE_message:write")
+					.anyRequest().authenticated()
+			)
+			.oauth2ResourceServer((resourceServer) -> resourceServer
+					.opaqueToken((opaqueToken) -> opaqueToken
+						.introspectionUri(this.introspectionUri)
+						.introspectionClientCredentials(this.clientId, this.clientSecret)
+					)
+			);
+		// @formatter:on
+	}
+
+}

servlet/spring-boot/java/oauth2/resource-server/opaque/src/main/java/org/springframework/boot/env/MockWebServerEnvironmentPostProcessor.java

@@ -0,0 +1,42 @@
+/*
+ * Copyright 2002-2019 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
+ *
+ *      https://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 org.springframework.boot.env;
+
+import org.springframework.beans.factory.DisposableBean;
+import org.springframework.boot.SpringApplication;
+import org.springframework.core.env.ConfigurableEnvironment;
+
+/**
+ * Add MockServerWebPropertySource to environment.
+ *
+ * @author Rob Winch
+ */
+public class MockWebServerEnvironmentPostProcessor implements EnvironmentPostProcessor, DisposableBean {
+
+	private final MockWebServerPropertySource propertySource = new MockWebServerPropertySource();
+
+	@Override
+	public void postProcessEnvironment(ConfigurableEnvironment environment, SpringApplication application) {
+		environment.getPropertySources().addFirst(this.propertySource);
+	}
+
+	@Override
+	public void destroy() throws Exception {
+		this.propertySource.destroy();
+	}
+
+}

servlet/spring-boot/java/oauth2/resource-server/opaque/src/main/java/org/springframework/boot/env/MockWebServerPropertySource.java

@@ -0,0 +1,201 @@
+/*
+ * Copyright 2002-2019 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
+ *
+ *      https://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 org.springframework.boot.env;
+
+import java.io.IOException;
+import java.util.Base64;
+import java.util.Map;
+import java.util.Optional;
+import java.util.stream.Collectors;
+import java.util.stream.Stream;
+
+import okhttp3.mockwebserver.Dispatcher;
+import okhttp3.mockwebserver.MockResponse;
+import okhttp3.mockwebserver.MockWebServer;
+import okhttp3.mockwebserver.RecordedRequest;
+import okio.Buffer;
+import org.apache.commons.logging.Log;
+import org.apache.commons.logging.LogFactory;
+
+import org.springframework.beans.factory.DisposableBean;
+import org.springframework.core.env.PropertySource;
+import org.springframework.http.HttpHeaders;
+import org.springframework.http.MediaType;
+
+/**
+ * Add the resource server URL to environment.
+ *
+ * @author Rob Winch
+ */
+public class MockWebServerPropertySource extends PropertySource<MockWebServer> implements DisposableBean {
+
+	// @formatter:off
+	private static final MockResponse NO_SCOPES_RESPONSE = response(
+			"{\n" +
+					"      \"active\": true,\n" +
+					"      \"sub\": \"subject\"\n" +
+					"     }",
+			200
+	);
+	// @formatter:on
+
+	// @formatter:off
+	private static final MockResponse MESSASGE_READ_SCOPE_RESPONSE = response(
+			"{\n" +
+					"      \"active\": true,\n" +
+					"      \"scope\" : \"message:read\"," +
+					"      \"sub\": \"subject\"\n" +
+					"     }",
+			200
+	);
+	// @formatter:on
+
+	// @formatter:off
+	private static final MockResponse INACTIVE_RESPONSE = response(
+			"{\n" +
+					"      \"active\": false,\n" +
+					"     }",
+			200
+	);
+	// @formatter:on
+
+	// @formatter:off
+	private static final MockResponse BAD_REQUEST_RESPONSE = response(
+			"{ \"message\" : \"This mock authorization server requires a username and password of " +
+					"client/secret and a POST body of token=${token}\" }",
+			400
+	);
+	// @formatter:on
+
+	// @formatter:off
+	private static final MockResponse NOT_FOUND_RESPONSE = response(
+			"{ \"message\" : \"This mock authorization server responds to just one request: POST /introspect.\" }",
+			404
+	);
+	// @formatter:on
+
+	/**
+	 * Name of the random {@link PropertySource}.
+	 */
+	public static final String MOCK_WEB_SERVER_PROPERTY_SOURCE_NAME = "mockwebserver";
+
+	private static final String NAME = "mockwebserver.url";
+
+	private static final Log logger = LogFactory.getLog(MockWebServerPropertySource.class);
+
+	private boolean started;
+
+	public MockWebServerPropertySource() {
+		super(MOCK_WEB_SERVER_PROPERTY_SOURCE_NAME, new MockWebServer());
+	}
+
+	@Override
+	public Object getProperty(String name) {
+		if (!name.equals(NAME)) {
+			return null;
+		}
+		if (logger.isTraceEnabled()) {
+			logger.trace("Looking up the url for '" + name + "'");
+		}
+		String url = getUrl();
+		return url;
+	}
+
+	@Override
+	public void destroy() throws Exception {
+		getSource().shutdown();
+	}
+
+	/**
+	 * Get's the URL (e.g. "http://localhost:123456")
+	 * @return the resource URL.
+	 */
+	private String getUrl() {
+		MockWebServer mockWebServer = getSource();
+		if (!this.started) {
+			initializeMockWebServer(mockWebServer);
+		}
+		String url = mockWebServer.url("").url().toExternalForm();
+		return url.substring(0, url.length() - 1);
+	}
+
+	private void initializeMockWebServer(MockWebServer mockWebServer) {
+		Dispatcher dispatcher = new Dispatcher() {
+			@Override
+			public MockResponse dispatch(RecordedRequest request) {
+				return doDispatch(request);
+			}
+		};
+
+		mockWebServer.setDispatcher(dispatcher);
+		try {
+			mockWebServer.start();
+			this.started = true;
+		}
+		catch (IOException ex) {
+			throw new RuntimeException("Could not start " + mockWebServer, ex);
+		}
+	}
+
+	private MockResponse doDispatch(RecordedRequest request) {
+		if ("/introspect".equals(request.getPath())) {
+			// @formatter:off
+			return Optional.ofNullable(request.getHeader(HttpHeaders.AUTHORIZATION))
+					.filter((authorization) -> isAuthorized(authorization, "client", "secret"))
+					.map((authorization) -> parseBody(request.getBody()))
+					.map((parameters) -> parameters.get("token"))
+					.map((token) -> {
+						if ("00ed5855-1869-47a0-b0c9-0f3ce520aee7".equals(token)) {
+							return NO_SCOPES_RESPONSE;
+						}
+						else if ("b43d1500-c405-4dc9-b9c9-6cfd966c34c9".equals(token)) {
+							return MESSASGE_READ_SCOPE_RESPONSE;
+						}
+						else {
+							return INACTIVE_RESPONSE;
+						}
+					})
+					.orElse(BAD_REQUEST_RESPONSE);
+			// @formatter:on
+		}
+
+		return NOT_FOUND_RESPONSE;
+	}
+
+	private boolean isAuthorized(String authorization, String username, String password) {
+		String[] values = new String(Base64.getDecoder().decode(authorization.substring(6))).split(":");
+		return username.equals(values[0]) && password.equals(values[1]);
+	}
+
+	private Map<String, Object> parseBody(Buffer body) {
+		// @formatter:off
+		return Stream.of(body.readUtf8().split("&"))
+				.map((parameter) -> parameter.split("="))
+				.collect(Collectors.toMap((parts) -> parts[0], (parts) -> parts[1]));
+		// @formatter:on
+	}
+
+	private static MockResponse response(String body, int status) {
+		// @formatter:off
+		return new MockResponse()
+				.setHeader(HttpHeaders.CONTENT_TYPE, MediaType.APPLICATION_JSON_VALUE)
+				.setResponseCode(status)
+				.setBody(body);
+		// @formatter:on
+	}
+
+}

servlet/spring-boot/java/oauth2/resource-server/opaque/src/main/java/org/springframework/boot/env/package-info.java

@@ -0,0 +1,23 @@
+/*
+ * Copyright 2002-2019 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
+ *
+ *      https://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.
+ */
+
+/**
+ * This provides integration of a {@link okhttp3.mockwebserver.MockWebServer} and the
+ * {@link org.springframework.core.env.Environment}.
+ *
+ * @author Rob Winch
+ */
+package org.springframework.boot.env;

servlet/spring-boot/java/oauth2/resource-server/opaque/src/main/resources/META-INF/spring.factories

@@ -0,0 +1 @@
+org.springframework.boot.env.EnvironmentPostProcessor=org.springframework.boot.env.MockWebServerEnvironmentPostProcessor

servlet/spring-boot/java/oauth2/resource-server/opaque/src/main/resources/application.yml

@@ -0,0 +1,8 @@
+spring:
+  security:
+    oauth2:
+      resourceserver:
+        opaque:
+          introspection-uri: ${mockwebserver.url}/introspect
+          introspection-client-id: client
+          introspection-client-secret: secret

servlet/spring-boot/java/oauth2/resource-server/opaque/src/test/java/example/OAuth2ResourceServerControllerTests.java

@@ -0,0 +1,104 @@
+/*
+ * Copyright 2020 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
+ *
+ *      https://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 example;
+
+import org.junit.jupiter.api.Test;
+
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.boot.test.autoconfigure.web.servlet.WebMvcTest;
+import org.springframework.security.core.authority.SimpleGrantedAuthority;
+import org.springframework.security.test.web.servlet.request.SecurityMockMvcRequestPostProcessors;
+import org.springframework.test.web.servlet.MockMvc;
+
+import static org.hamcrest.CoreMatchers.is;
+import static org.springframework.security.test.web.servlet.request.SecurityMockMvcRequestPostProcessors.jwt;
+import static org.springframework.security.test.web.servlet.request.SecurityMockMvcRequestPostProcessors.opaqueToken;
+import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get;
+import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.post;
+import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.content;
+import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;
+
+/**
+ * @author Josh Cummings
+ * @since 5.3
+ */
+@WebMvcTest(OAuth2ResourceServerController.class)
+public class OAuth2ResourceServerControllerTests {
+
+	@Autowired
+	MockMvc mvc;
+
+	@Test
+	void indexGreetsAuthenticatedUser() throws Exception {
+		// @formatter:off
+		SecurityMockMvcRequestPostProcessors.OpaqueTokenRequestPostProcessor token = opaqueToken()
+				.attributes((a) -> a.put("sub", "ch4mpy"));
+		this.mvc.perform(get("/").with(token))
+				.andExpect(content().string(is("Hello, ch4mpy!")));
+		// @formatter:on
+	}
+
+	@Test
+	void messageCanBeReadWithScopeMessageReadAuthority() throws Exception {
+		// @formatter:off
+		SecurityMockMvcRequestPostProcessors.OpaqueTokenRequestPostProcessor token = opaqueToken()
+				.attributes((a) -> a.put("scope", "message:read"));
+		this.mvc.perform(get("/message").with(token))
+				.andExpect(content().string(is("secret message")));
+
+		this.mvc.perform(get("/message")
+				.with(jwt().authorities(new SimpleGrantedAuthority(("SCOPE_message:read")))))
+				.andExpect(content().string(is("secret message")));
+		// @formatter:on
+	}
+
+	@Test
+	void messageCanNotBeReadWithoutScopeMessageReadAuthority() throws Exception {
+		// @formatter:off
+		this.mvc.perform(get("/message").with(opaqueToken()))
+				.andExpect(status().isForbidden());
+		// @formatter:on
+	}
+
+	@Test
+	void messageCanNotBeCreatedWithoutAnyScope() throws Exception {
+		// @formatter:off
+		this.mvc.perform(post("/message")
+				.content("Hello message")
+				.with(opaqueToken()))
+				.andExpect(status().isForbidden());
+		// @formatter:on
+	}
+
+	@Test
+	void messageCanNotBeCreatedWithScopeMessageReadAuthority() throws Exception {
+		this.mvc.perform(post("/message").content("Hello message")
+				.with(opaqueToken().authorities(new SimpleGrantedAuthority("SCOPE_message:read"))))
+				.andExpect(status().isForbidden());
+	}
+
+	@Test
+	void messageCanBeCreatedWithScopeMessageWriteAuthority() throws Exception {
+		// @formatter:off
+		this.mvc.perform(post("/message")
+				.content("Hello message")
+				.with(opaqueToken().authorities(new SimpleGrantedAuthority("SCOPE_message:write"))))
+				.andExpect(status().isOk())
+				.andExpect(content().string(is("Message was created. Content: Hello message")));
+		// @formatter:on
+	}
+
+}