|
@@ -0,0 +1,326 @@
|
|
|
+/*
|
|
|
+ * 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 org.springframework.security.oauth2.client.endpoint;
|
|
|
+
|
|
|
+import okhttp3.mockwebserver.MockResponse;
|
|
|
+import okhttp3.mockwebserver.MockWebServer;
|
|
|
+import okhttp3.mockwebserver.RecordedRequest;
|
|
|
+import org.junit.After;
|
|
|
+import org.junit.Before;
|
|
|
+import org.junit.Test;
|
|
|
+import org.springframework.http.HttpHeaders;
|
|
|
+import org.springframework.http.HttpMethod;
|
|
|
+import org.springframework.http.MediaType;
|
|
|
+import org.springframework.security.oauth2.client.registration.ClientRegistration;
|
|
|
+import org.springframework.security.oauth2.core.AuthorizationGrantType;
|
|
|
+import org.springframework.security.oauth2.core.ClientAuthenticationMethod;
|
|
|
+import org.springframework.security.oauth2.core.OAuth2AccessToken;
|
|
|
+import org.springframework.security.oauth2.core.OAuth2AuthenticationException;
|
|
|
+import org.springframework.security.oauth2.core.endpoint.OAuth2AccessTokenResponse;
|
|
|
+
|
|
|
+import java.time.Instant;
|
|
|
+
|
|
|
+import static org.assertj.core.api.Assertions.assertThat;
|
|
|
+import static org.assertj.core.api.Assertions.assertThatThrownBy;
|
|
|
+
|
|
|
+/**
|
|
|
+ * Tests for {@link DefaultClientCredentialsTokenResponseClient}.
|
|
|
+ *
|
|
|
+ * @author Joe Grandja
|
|
|
+ */
|
|
|
+public class DefaultClientCredentialsTokenResponseClientTests {
|
|
|
+ private DefaultClientCredentialsTokenResponseClient tokenResponseClient = new DefaultClientCredentialsTokenResponseClient();
|
|
|
+ private ClientRegistration clientRegistration;
|
|
|
+ private MockWebServer server;
|
|
|
+
|
|
|
+ @Before
|
|
|
+ public void setup() throws Exception {
|
|
|
+ this.server = new MockWebServer();
|
|
|
+ this.server.start();
|
|
|
+
|
|
|
+ String tokenUri = this.server.url("/oauth2/token").toString();
|
|
|
+
|
|
|
+ this.clientRegistration = ClientRegistration.withRegistrationId("registration-1")
|
|
|
+ .clientId("client-1")
|
|
|
+ .clientSecret("secret")
|
|
|
+ .clientAuthenticationMethod(ClientAuthenticationMethod.BASIC)
|
|
|
+ .authorizationGrantType(AuthorizationGrantType.CLIENT_CREDENTIALS)
|
|
|
+ .scope("read", "write")
|
|
|
+ .tokenUri(tokenUri)
|
|
|
+ .build();
|
|
|
+ }
|
|
|
+
|
|
|
+ @After
|
|
|
+ public void cleanup() throws Exception {
|
|
|
+ this.server.shutdown();
|
|
|
+ }
|
|
|
+
|
|
|
+ @Test
|
|
|
+ public void setRestOperationsWhenRestOperationsIsNullThenThrowIllegalArgumentException() {
|
|
|
+ assertThatThrownBy(() -> this.tokenResponseClient.setRestOperations(null))
|
|
|
+ .isInstanceOf(IllegalArgumentException.class);
|
|
|
+ }
|
|
|
+
|
|
|
+ @Test
|
|
|
+ public void getTokenResponseWhenRequestIsNullThenThrowIllegalArgumentException() {
|
|
|
+ assertThatThrownBy(() -> this.tokenResponseClient.getTokenResponse(null))
|
|
|
+ .isInstanceOf(IllegalArgumentException.class);
|
|
|
+ }
|
|
|
+
|
|
|
+ @Test
|
|
|
+ public void getTokenResponseWhenSuccessResponseThenReturnAccessTokenResponse() throws Exception {
|
|
|
+ String accessTokenSuccessResponse = "{\n" +
|
|
|
+ " \"access_token\": \"access-token-1234\",\n" +
|
|
|
+ " \"token_type\": \"bearer\",\n" +
|
|
|
+ " \"expires_in\": \"3600\",\n" +
|
|
|
+ " \"scope\": \"read write\",\n" +
|
|
|
+ " \"custom_parameter_1\": \"custom-value-1\",\n" +
|
|
|
+ " \"custom_parameter_2\": \"custom-value-2\"\n" +
|
|
|
+ "}\n";
|
|
|
+ this.server.enqueue(jsonResponse(accessTokenSuccessResponse));
|
|
|
+
|
|
|
+ Instant expiresAtBefore = Instant.now().plusSeconds(3600);
|
|
|
+
|
|
|
+ OAuth2ClientCredentialsGrantRequest clientCredentialsGrantRequest =
|
|
|
+ new OAuth2ClientCredentialsGrantRequest(this.clientRegistration);
|
|
|
+
|
|
|
+ OAuth2AccessTokenResponse accessTokenResponse = this.tokenResponseClient.getTokenResponse(clientCredentialsGrantRequest);
|
|
|
+
|
|
|
+ Instant expiresAtAfter = Instant.now().plusSeconds(3600);
|
|
|
+
|
|
|
+ RecordedRequest recordedRequest = this.server.takeRequest();
|
|
|
+ assertThat(recordedRequest.getMethod()).isEqualTo(HttpMethod.POST.toString());
|
|
|
+ assertThat(recordedRequest.getHeader(HttpHeaders.ACCEPT)).isEqualTo(MediaType.APPLICATION_JSON.toString());
|
|
|
+ assertThat(recordedRequest.getHeader(HttpHeaders.CONTENT_TYPE)).startsWith(MediaType.APPLICATION_FORM_URLENCODED.toString());
|
|
|
+
|
|
|
+ String formParameters = recordedRequest.getBody().readUtf8();
|
|
|
+ assertThat(formParameters).contains("grant_type=client_credentials");
|
|
|
+ assertThat(formParameters).contains("scope=read+write");
|
|
|
+
|
|
|
+ assertThat(accessTokenResponse.getAccessToken().getTokenValue()).isEqualTo("access-token-1234");
|
|
|
+ assertThat(accessTokenResponse.getAccessToken().getTokenType()).isEqualTo(OAuth2AccessToken.TokenType.BEARER);
|
|
|
+ assertThat(accessTokenResponse.getAccessToken().getExpiresAt()).isBetween(expiresAtBefore, expiresAtAfter);
|
|
|
+ assertThat(accessTokenResponse.getAccessToken().getScopes()).containsExactly("read", "write");
|
|
|
+ assertThat(accessTokenResponse.getRefreshToken()).isNull();
|
|
|
+ assertThat(accessTokenResponse.getAdditionalParameters().size()).isEqualTo(2);
|
|
|
+ assertThat(accessTokenResponse.getAdditionalParameters()).containsEntry("custom_parameter_1", "custom-value-1");
|
|
|
+ assertThat(accessTokenResponse.getAdditionalParameters()).containsEntry("custom_parameter_2", "custom-value-2");
|
|
|
+ }
|
|
|
+
|
|
|
+ @Test
|
|
|
+ public void getTokenResponseWhenClientAuthenticationBasicThenAuthorizationHeaderIsSent() throws Exception {
|
|
|
+ String accessTokenSuccessResponse = "{\n" +
|
|
|
+ " \"access_token\": \"access-token-1234\",\n" +
|
|
|
+ " \"token_type\": \"bearer\",\n" +
|
|
|
+ " \"expires_in\": \"3600\"\n" +
|
|
|
+ "}\n";
|
|
|
+ this.server.enqueue(jsonResponse(accessTokenSuccessResponse));
|
|
|
+
|
|
|
+ OAuth2ClientCredentialsGrantRequest clientCredentialsGrantRequest =
|
|
|
+ new OAuth2ClientCredentialsGrantRequest(this.clientRegistration);
|
|
|
+
|
|
|
+ this.tokenResponseClient.getTokenResponse(clientCredentialsGrantRequest);
|
|
|
+
|
|
|
+ RecordedRequest recordedRequest = this.server.takeRequest();
|
|
|
+ assertThat(recordedRequest.getHeader(HttpHeaders.AUTHORIZATION)).startsWith("Basic ");
|
|
|
+ }
|
|
|
+
|
|
|
+ @Test
|
|
|
+ public void getTokenResponseWhenClientAuthenticationPostThenFormParametersAreSent() throws Exception {
|
|
|
+ String accessTokenSuccessResponse = "{\n" +
|
|
|
+ " \"access_token\": \"access-token-1234\",\n" +
|
|
|
+ " \"token_type\": \"bearer\",\n" +
|
|
|
+ " \"expires_in\": \"3600\"\n" +
|
|
|
+ "}\n";
|
|
|
+ this.server.enqueue(jsonResponse(accessTokenSuccessResponse));
|
|
|
+
|
|
|
+ ClientRegistration clientRegistration = this.from(this.clientRegistration)
|
|
|
+ .clientAuthenticationMethod(ClientAuthenticationMethod.POST)
|
|
|
+ .build();
|
|
|
+
|
|
|
+ OAuth2ClientCredentialsGrantRequest clientCredentialsGrantRequest =
|
|
|
+ new OAuth2ClientCredentialsGrantRequest(clientRegistration);
|
|
|
+
|
|
|
+ this.tokenResponseClient.getTokenResponse(clientCredentialsGrantRequest);
|
|
|
+
|
|
|
+ RecordedRequest recordedRequest = this.server.takeRequest();
|
|
|
+ assertThat(recordedRequest.getHeader(HttpHeaders.AUTHORIZATION)).isNull();
|
|
|
+
|
|
|
+ String formParameters = recordedRequest.getBody().readUtf8();
|
|
|
+ assertThat(formParameters).contains("client_id=client-1");
|
|
|
+ assertThat(formParameters).contains("client_secret=secret");
|
|
|
+ }
|
|
|
+
|
|
|
+ @Test
|
|
|
+ public void getTokenResponseWhenSuccessResponseAndNotBearerTokenTypeThenThrowOAuth2AuthenticationException() {
|
|
|
+ String accessTokenSuccessResponse = "{\n" +
|
|
|
+ " \"access_token\": \"access-token-1234\",\n" +
|
|
|
+ " \"token_type\": \"not-bearer\",\n" +
|
|
|
+ " \"expires_in\": \"3600\"\n" +
|
|
|
+ "}\n";
|
|
|
+ this.server.enqueue(jsonResponse(accessTokenSuccessResponse));
|
|
|
+
|
|
|
+ OAuth2ClientCredentialsGrantRequest clientCredentialsGrantRequest =
|
|
|
+ new OAuth2ClientCredentialsGrantRequest(this.clientRegistration);
|
|
|
+
|
|
|
+ assertThatThrownBy(() -> this.tokenResponseClient.getTokenResponse(clientCredentialsGrantRequest))
|
|
|
+ .isInstanceOf(OAuth2AuthenticationException.class)
|
|
|
+ .hasMessageContaining("[invalid_token_response] An error occurred parsing the Access Token response (200 OK): tokenType cannot be null");
|
|
|
+ }
|
|
|
+
|
|
|
+ @Test
|
|
|
+ public void getTokenResponseWhenSuccessResponseAndMissingTokenTypeParameterThenThrowOAuth2AuthenticationException() {
|
|
|
+ String accessTokenSuccessResponse = "{\n" +
|
|
|
+ " \"access_token\": \"access-token-1234\"\n" +
|
|
|
+ "}\n";
|
|
|
+ this.server.enqueue(jsonResponse(accessTokenSuccessResponse));
|
|
|
+
|
|
|
+ OAuth2ClientCredentialsGrantRequest clientCredentialsGrantRequest =
|
|
|
+ new OAuth2ClientCredentialsGrantRequest(this.clientRegistration);
|
|
|
+
|
|
|
+ assertThatThrownBy(() -> this.tokenResponseClient.getTokenResponse(clientCredentialsGrantRequest))
|
|
|
+ .isInstanceOf(OAuth2AuthenticationException.class)
|
|
|
+ .hasMessageContaining("[invalid_token_response] An error occurred parsing the Access Token response (200 OK). Missing required parameters: access_token and/or token_type");
|
|
|
+ }
|
|
|
+
|
|
|
+ @Test
|
|
|
+ public void getTokenResponseWhenSuccessResponseIncludesScopeThenAccessTokenHasResponseScope() {
|
|
|
+ String accessTokenSuccessResponse = "{\n" +
|
|
|
+ " \"access_token\": \"access-token-1234\",\n" +
|
|
|
+ " \"token_type\": \"bearer\",\n" +
|
|
|
+ " \"expires_in\": \"3600\",\n" +
|
|
|
+ " \"scope\": \"read\"\n" +
|
|
|
+ "}\n";
|
|
|
+ this.server.enqueue(jsonResponse(accessTokenSuccessResponse));
|
|
|
+
|
|
|
+ OAuth2ClientCredentialsGrantRequest clientCredentialsGrantRequest =
|
|
|
+ new OAuth2ClientCredentialsGrantRequest(this.clientRegistration);
|
|
|
+
|
|
|
+ OAuth2AccessTokenResponse accessTokenResponse = this.tokenResponseClient.getTokenResponse(clientCredentialsGrantRequest);
|
|
|
+
|
|
|
+ assertThat(accessTokenResponse.getAccessToken().getScopes()).containsExactly("read");
|
|
|
+ }
|
|
|
+
|
|
|
+ @Test
|
|
|
+ public void getTokenResponseWhenSuccessResponseDoesNotIncludeScopeThenAccessTokenHasDefaultScope() {
|
|
|
+ String accessTokenSuccessResponse = "{\n" +
|
|
|
+ " \"access_token\": \"access-token-1234\",\n" +
|
|
|
+ " \"token_type\": \"bearer\",\n" +
|
|
|
+ " \"expires_in\": \"3600\"\n" +
|
|
|
+ "}\n";
|
|
|
+ this.server.enqueue(jsonResponse(accessTokenSuccessResponse));
|
|
|
+
|
|
|
+ OAuth2ClientCredentialsGrantRequest clientCredentialsGrantRequest =
|
|
|
+ new OAuth2ClientCredentialsGrantRequest(this.clientRegistration);
|
|
|
+
|
|
|
+ OAuth2AccessTokenResponse accessTokenResponse = this.tokenResponseClient.getTokenResponse(clientCredentialsGrantRequest);
|
|
|
+
|
|
|
+ assertThat(accessTokenResponse.getAccessToken().getScopes()).containsExactly("read", "write");
|
|
|
+ }
|
|
|
+
|
|
|
+ @Test
|
|
|
+ public void getTokenResponseWhenTokenUriMalformedThenThrowOAuth2AuthenticationException() {
|
|
|
+ String malformedTokenUri = "http:\\provider.com\\oauth2\\token";
|
|
|
+ ClientRegistration clientRegistration = this.from(this.clientRegistration)
|
|
|
+ .tokenUri(malformedTokenUri)
|
|
|
+ .build();
|
|
|
+
|
|
|
+ OAuth2ClientCredentialsGrantRequest clientCredentialsGrantRequest =
|
|
|
+ new OAuth2ClientCredentialsGrantRequest(clientRegistration);
|
|
|
+
|
|
|
+ assertThatThrownBy(() -> this.tokenResponseClient.getTokenResponse(clientCredentialsGrantRequest))
|
|
|
+ .isInstanceOf(OAuth2AuthenticationException.class)
|
|
|
+ .hasMessageContaining("[invalid_token_request] An error occurred while sending the Access Token Request:");
|
|
|
+ }
|
|
|
+
|
|
|
+ @Test
|
|
|
+ public void getTokenResponseWhenTokenUriInvalidThenThrowOAuth2AuthenticationException() {
|
|
|
+ String invalidTokenUri = "http://invalid-provider.com/oauth2/token";
|
|
|
+ ClientRegistration clientRegistration = this.from(this.clientRegistration)
|
|
|
+ .tokenUri(invalidTokenUri)
|
|
|
+ .build();
|
|
|
+
|
|
|
+ OAuth2ClientCredentialsGrantRequest clientCredentialsGrantRequest =
|
|
|
+ new OAuth2ClientCredentialsGrantRequest(clientRegistration);
|
|
|
+
|
|
|
+ assertThatThrownBy(() -> this.tokenResponseClient.getTokenResponse(clientCredentialsGrantRequest))
|
|
|
+ .isInstanceOf(OAuth2AuthenticationException.class)
|
|
|
+ .hasMessageContaining("[invalid_token_request] An error occurred while sending the Access Token Request:");
|
|
|
+ }
|
|
|
+
|
|
|
+ @Test
|
|
|
+ public void getTokenResponseWhenMalformedResponseThenThrowOAuth2AuthenticationException() {
|
|
|
+ String accessTokenSuccessResponse = "{\n" +
|
|
|
+ " \"access_token\": \"access-token-1234\",\n" +
|
|
|
+ " \"token_type\": \"bearer\",\n" +
|
|
|
+ " \"expires_in\": \"3600\",\n" +
|
|
|
+ " \"scope\": \"read write\",\n" +
|
|
|
+ " \"custom_parameter_1\": \"custom-value-1\",\n" +
|
|
|
+ " \"custom_parameter_2\": \"custom-value-2\"\n";
|
|
|
+// "}\n"; // Make the JSON invalid/malformed
|
|
|
+ this.server.enqueue(jsonResponse(accessTokenSuccessResponse));
|
|
|
+
|
|
|
+ OAuth2ClientCredentialsGrantRequest clientCredentialsGrantRequest =
|
|
|
+ new OAuth2ClientCredentialsGrantRequest(this.clientRegistration);
|
|
|
+
|
|
|
+ assertThatThrownBy(() -> this.tokenResponseClient.getTokenResponse(clientCredentialsGrantRequest))
|
|
|
+ .isInstanceOf(OAuth2AuthenticationException.class)
|
|
|
+ .hasMessageContaining("[invalid_token_request] An error occurred while sending the Access Token Request:");
|
|
|
+ }
|
|
|
+
|
|
|
+ @Test
|
|
|
+ public void getTokenResponseWhenErrorResponseThenThrowOAuth2AuthenticationException() {
|
|
|
+ String accessTokenErrorResponse = "{\n" +
|
|
|
+ " \"error\": \"unauthorized_client\"\n" +
|
|
|
+ "}\n";
|
|
|
+ this.server.enqueue(jsonResponse(accessTokenErrorResponse).setResponseCode(400));
|
|
|
+
|
|
|
+ OAuth2ClientCredentialsGrantRequest clientCredentialsGrantRequest =
|
|
|
+ new OAuth2ClientCredentialsGrantRequest(this.clientRegistration);
|
|
|
+
|
|
|
+ assertThatThrownBy(() -> this.tokenResponseClient.getTokenResponse(clientCredentialsGrantRequest))
|
|
|
+ .isInstanceOf(OAuth2AuthenticationException.class)
|
|
|
+ .hasMessageContaining("[unauthorized_client]");
|
|
|
+ }
|
|
|
+
|
|
|
+ @Test
|
|
|
+ public void getTokenResponseWhenServerErrorResponseThenThrowOAuth2AuthenticationException() {
|
|
|
+ this.server.enqueue(new MockResponse().setResponseCode(500));
|
|
|
+
|
|
|
+ OAuth2ClientCredentialsGrantRequest clientCredentialsGrantRequest =
|
|
|
+ new OAuth2ClientCredentialsGrantRequest(this.clientRegistration);
|
|
|
+
|
|
|
+ assertThatThrownBy(() -> this.tokenResponseClient.getTokenResponse(clientCredentialsGrantRequest))
|
|
|
+ .isInstanceOf(OAuth2AuthenticationException.class)
|
|
|
+ .hasMessageContaining("[server_error]");
|
|
|
+ }
|
|
|
+
|
|
|
+ private MockResponse jsonResponse(String json) {
|
|
|
+ return new MockResponse()
|
|
|
+ .setHeader(HttpHeaders.CONTENT_TYPE, MediaType.APPLICATION_JSON_VALUE)
|
|
|
+ .setBody(json);
|
|
|
+ }
|
|
|
+
|
|
|
+ private ClientRegistration.Builder from(ClientRegistration registration) {
|
|
|
+ return ClientRegistration.withRegistrationId(registration.getRegistrationId())
|
|
|
+ .clientId(registration.getClientId())
|
|
|
+ .clientSecret(registration.getClientSecret())
|
|
|
+ .clientAuthenticationMethod(registration.getClientAuthenticationMethod())
|
|
|
+ .authorizationGrantType(registration.getAuthorizationGrantType())
|
|
|
+ .scope(registration.getScopes())
|
|
|
+ .tokenUri(registration.getProviderDetails().getTokenUri());
|
|
|
+ }
|
|
|
+}
|