e1f491bd61
Added support for client secret POST authentication method. Added validation of client authentication method when authenticating a client. Closes gh-134
213 lines
9.7 KiB
Java
213 lines
9.7 KiB
Java
/*
|
|
* 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 org.springframework.security.oauth2.server.authorization.web;
|
|
|
|
import org.junit.After;
|
|
import org.junit.Before;
|
|
import org.junit.Test;
|
|
import org.springframework.http.HttpMethod;
|
|
import org.springframework.http.HttpStatus;
|
|
import org.springframework.http.converter.HttpMessageConverter;
|
|
import org.springframework.mock.http.client.MockClientHttpResponse;
|
|
import org.springframework.mock.web.MockHttpServletRequest;
|
|
import org.springframework.mock.web.MockHttpServletResponse;
|
|
import org.springframework.security.authentication.AuthenticationManager;
|
|
import org.springframework.security.core.Authentication;
|
|
import org.springframework.security.core.context.SecurityContextHolder;
|
|
import org.springframework.security.oauth2.core.ClientAuthenticationMethod;
|
|
import org.springframework.security.oauth2.core.OAuth2AuthenticationException;
|
|
import org.springframework.security.oauth2.core.OAuth2Error;
|
|
import org.springframework.security.oauth2.core.OAuth2ErrorCodes;
|
|
import org.springframework.security.oauth2.core.http.converter.OAuth2ErrorHttpMessageConverter;
|
|
import org.springframework.security.oauth2.server.authorization.authentication.OAuth2ClientAuthenticationToken;
|
|
import org.springframework.security.oauth2.server.authorization.client.RegisteredClient;
|
|
import org.springframework.security.oauth2.server.authorization.client.TestRegisteredClients;
|
|
import org.springframework.security.web.authentication.AuthenticationConverter;
|
|
import org.springframework.security.web.util.matcher.AntPathRequestMatcher;
|
|
import org.springframework.security.web.util.matcher.RequestMatcher;
|
|
|
|
import javax.servlet.FilterChain;
|
|
import javax.servlet.http.HttpServletRequest;
|
|
import javax.servlet.http.HttpServletResponse;
|
|
|
|
import static org.assertj.core.api.Assertions.assertThat;
|
|
import static org.assertj.core.api.Assertions.assertThatThrownBy;
|
|
import static org.mockito.ArgumentMatchers.any;
|
|
import static org.mockito.Mockito.mock;
|
|
import static org.mockito.Mockito.verify;
|
|
import static org.mockito.Mockito.verifyNoInteractions;
|
|
import static org.mockito.Mockito.when;
|
|
|
|
/**
|
|
* Tests for {@link OAuth2ClientAuthenticationFilter}.
|
|
*
|
|
* @author Patryk Kostrzewa
|
|
* @author Joe Grandja
|
|
*/
|
|
public class OAuth2ClientAuthenticationFilterTests {
|
|
private String filterProcessesUrl = "/oauth2/token";
|
|
private AuthenticationManager authenticationManager;
|
|
private RequestMatcher requestMatcher;
|
|
private AuthenticationConverter authenticationConverter;
|
|
private OAuth2ClientAuthenticationFilter filter;
|
|
private final HttpMessageConverter<OAuth2Error> errorHttpResponseConverter =
|
|
new OAuth2ErrorHttpMessageConverter();
|
|
|
|
@Before
|
|
public void setUp() {
|
|
this.authenticationManager = mock(AuthenticationManager.class);
|
|
this.requestMatcher = new AntPathRequestMatcher(this.filterProcessesUrl, HttpMethod.POST.name());
|
|
this.filter = new OAuth2ClientAuthenticationFilter(this.authenticationManager, this.requestMatcher);
|
|
this.authenticationConverter = mock(AuthenticationConverter.class);
|
|
this.filter.setAuthenticationConverter(this.authenticationConverter);
|
|
}
|
|
|
|
@After
|
|
public void cleanup() {
|
|
SecurityContextHolder.clearContext();
|
|
}
|
|
|
|
@Test
|
|
public void constructorWhenAuthenticationManagerNullThenThrowIllegalArgumentException() {
|
|
assertThatThrownBy(() -> new OAuth2ClientAuthenticationFilter(null, this.requestMatcher))
|
|
.isInstanceOf(IllegalArgumentException.class)
|
|
.hasMessage("authenticationManager cannot be null");
|
|
}
|
|
|
|
@Test
|
|
public void constructorWhenRequestMatcherNullThenThrowIllegalArgumentException() {
|
|
assertThatThrownBy(() -> new OAuth2ClientAuthenticationFilter(this.authenticationManager, null))
|
|
.isInstanceOf(IllegalArgumentException.class)
|
|
.hasMessage("requestMatcher cannot be null");
|
|
}
|
|
|
|
@Test
|
|
public void setAuthenticationConverterWhenNullThenThrowIllegalArgumentException() {
|
|
assertThatThrownBy(() -> this.filter.setAuthenticationConverter(null))
|
|
.isInstanceOf(IllegalArgumentException.class)
|
|
.hasMessage("authenticationConverter cannot be null");
|
|
}
|
|
|
|
@Test
|
|
public void setAuthenticationSuccessHandlerWhenNullThenThrowIllegalArgumentException() {
|
|
assertThatThrownBy(() -> this.filter.setAuthenticationSuccessHandler(null))
|
|
.isInstanceOf(IllegalArgumentException.class)
|
|
.hasMessage("authenticationSuccessHandler cannot be null");
|
|
}
|
|
|
|
@Test
|
|
public void setAuthenticationFailureHandlerWhenNullThenThrowIllegalArgumentException() {
|
|
assertThatThrownBy(() -> this.filter.setAuthenticationFailureHandler(null))
|
|
.isInstanceOf(IllegalArgumentException.class)
|
|
.hasMessage("authenticationFailureHandler cannot be null");
|
|
}
|
|
|
|
@Test
|
|
public void doFilterWhenRequestDoesNotMatchThenNotProcessed() throws Exception {
|
|
String requestUri = "/path";
|
|
MockHttpServletRequest request = new MockHttpServletRequest("POST", requestUri);
|
|
request.setServletPath(requestUri);
|
|
MockHttpServletResponse response = new MockHttpServletResponse();
|
|
FilterChain filterChain = mock(FilterChain.class);
|
|
|
|
this.filter.doFilter(request, response, filterChain);
|
|
|
|
verify(filterChain).doFilter(any(HttpServletRequest.class), any(HttpServletResponse.class));
|
|
}
|
|
|
|
@Test
|
|
public void doFilterWhenRequestMatchesAndEmptyCredentialsThenNotProcessed() throws Exception {
|
|
MockHttpServletRequest request = new MockHttpServletRequest("POST", this.filterProcessesUrl);
|
|
request.setServletPath(this.filterProcessesUrl);
|
|
MockHttpServletResponse response = new MockHttpServletResponse();
|
|
FilterChain filterChain = mock(FilterChain.class);
|
|
|
|
this.filter.doFilter(request, response, filterChain);
|
|
|
|
verify(filterChain).doFilter(any(HttpServletRequest.class), any(HttpServletResponse.class));
|
|
}
|
|
|
|
@Test
|
|
public void doFilterWhenRequestMatchesAndInvalidCredentialsThenInvalidRequestError() throws Exception {
|
|
when(this.authenticationConverter.convert(any(HttpServletRequest.class))).thenThrow(
|
|
new OAuth2AuthenticationException(new OAuth2Error(OAuth2ErrorCodes.INVALID_REQUEST)));
|
|
|
|
MockHttpServletRequest request = new MockHttpServletRequest("POST", this.filterProcessesUrl);
|
|
request.setServletPath(this.filterProcessesUrl);
|
|
MockHttpServletResponse response = new MockHttpServletResponse();
|
|
FilterChain filterChain = mock(FilterChain.class);
|
|
|
|
this.filter.doFilter(request, response, filterChain);
|
|
|
|
verifyNoInteractions(filterChain);
|
|
|
|
assertThat(SecurityContextHolder.getContext().getAuthentication()).isNull();
|
|
assertThat(response.getStatus()).isEqualTo(HttpStatus.BAD_REQUEST.value());
|
|
OAuth2Error error = readError(response);
|
|
assertThat(error.getErrorCode()).isEqualTo(OAuth2ErrorCodes.INVALID_REQUEST);
|
|
}
|
|
|
|
@Test
|
|
public void doFilterWhenRequestMatchesAndBadCredentialsThenInvalidClientError() throws Exception {
|
|
when(this.authenticationConverter.convert(any(HttpServletRequest.class))).thenReturn(
|
|
new OAuth2ClientAuthenticationToken("clientId", "invalid-secret", ClientAuthenticationMethod.BASIC, null));
|
|
when(this.authenticationManager.authenticate(any(Authentication.class))).thenThrow(
|
|
new OAuth2AuthenticationException(new OAuth2Error(OAuth2ErrorCodes.INVALID_CLIENT)));
|
|
|
|
MockHttpServletRequest request = new MockHttpServletRequest("POST", this.filterProcessesUrl);
|
|
request.setServletPath(this.filterProcessesUrl);
|
|
MockHttpServletResponse response = new MockHttpServletResponse();
|
|
FilterChain filterChain = mock(FilterChain.class);
|
|
|
|
this.filter.doFilter(request, response, filterChain);
|
|
|
|
verifyNoInteractions(filterChain);
|
|
|
|
assertThat(SecurityContextHolder.getContext().getAuthentication()).isNull();
|
|
assertThat(response.getStatus()).isEqualTo(HttpStatus.UNAUTHORIZED.value());
|
|
OAuth2Error error = readError(response);
|
|
assertThat(error.getErrorCode()).isEqualTo(OAuth2ErrorCodes.INVALID_CLIENT);
|
|
}
|
|
|
|
@Test
|
|
public void doFilterWhenRequestMatchesAndValidCredentialsThenProcessed() throws Exception {
|
|
RegisteredClient registeredClient = TestRegisteredClients.registeredClient().build();
|
|
when(this.authenticationConverter.convert(any(HttpServletRequest.class))).thenReturn(
|
|
new OAuth2ClientAuthenticationToken(registeredClient.getClientId(), registeredClient.getClientSecret(), ClientAuthenticationMethod.BASIC, null));
|
|
when(this.authenticationManager.authenticate(any(Authentication.class))).thenReturn(
|
|
new OAuth2ClientAuthenticationToken(registeredClient));
|
|
|
|
MockHttpServletRequest request = new MockHttpServletRequest("POST", this.filterProcessesUrl);
|
|
request.setServletPath(this.filterProcessesUrl);
|
|
MockHttpServletResponse response = new MockHttpServletResponse();
|
|
FilterChain filterChain = mock(FilterChain.class);
|
|
|
|
this.filter.doFilter(request, response, filterChain);
|
|
|
|
verify(filterChain).doFilter(any(HttpServletRequest.class), any(HttpServletResponse.class));
|
|
|
|
Authentication authentication = SecurityContextHolder.getContext().getAuthentication();
|
|
assertThat(authentication).isInstanceOf(OAuth2ClientAuthenticationToken.class);
|
|
assertThat(((OAuth2ClientAuthenticationToken) authentication).getRegisteredClient()).isEqualTo(registeredClient);
|
|
}
|
|
|
|
private OAuth2Error readError(MockHttpServletResponse response) throws Exception {
|
|
MockClientHttpResponse httpResponse = new MockClientHttpResponse(
|
|
response.getContentAsByteArray(), HttpStatus.valueOf(response.getStatus()));
|
|
return this.errorHttpResponseConverter.read(OAuth2Error.class, httpResponse);
|
|
}
|
|
}
|