spring.AbstractAuthorizationCodeProviderTests.java Source code

Java tutorial

Introduction

Here is the source code for spring.AbstractAuthorizationCodeProviderTests.java

Source

/*
 * Copyright 2006-2011 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 spring;

import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertFalse;
import static org.junit.Assert.assertNotNull;
import static org.junit.Assert.assertTrue;
import static org.junit.Assert.fail;

import java.util.Arrays;

import org.junit.Ignore;
import org.junit.Test;
import org.springframework.http.HttpHeaders;
import org.springframework.http.HttpStatus;
import org.springframework.http.MediaType;
import org.springframework.http.ResponseEntity;
import org.springframework.security.oauth2.client.resource.BaseOAuth2ProtectedResourceDetails;
import org.springframework.security.oauth2.client.resource.UserRedirectRequiredException;
import org.springframework.security.oauth2.client.test.OAuth2ContextConfiguration;
import org.springframework.security.oauth2.client.token.AccessTokenRequest;
import org.springframework.security.oauth2.common.OAuth2AccessToken;
import org.springframework.security.oauth2.common.exceptions.RedirectMismatchException;
import org.springframework.security.oauth2.common.util.OAuth2Utils;
import org.springframework.util.LinkedMultiValueMap;
import org.springframework.web.client.HttpClientErrorException;

import spring.HttpTestUtils.UriBuilder;

/**
 * @author Dave Syer
 * @author Luke Taylor
 */
public abstract class AbstractAuthorizationCodeProviderTests extends AbstractEmptyAuthorizationCodeProviderTests {

    @Test
    @OAuth2ContextConfiguration(resource = MyTrustedClient.class, initialize = false)
    public void testUnauthenticatedAuthorizationRespondsUnauthorized() throws Exception {

        AccessTokenRequest request = context.getAccessTokenRequest();
        request.setCurrentUri("http://anywhere");
        request.add(OAuth2Utils.USER_OAUTH_APPROVAL, "true");

        try {
            String code = getAccessTokenProvider().obtainAuthorizationCode(context.getResource(), request);
            assertNotNull(code);
            fail("Expected UserRedirectRequiredException");
        } catch (HttpClientErrorException e) {
            assertEquals(HttpStatus.UNAUTHORIZED, e.getStatusCode());
        }

    }

    @Test
    @OAuth2ContextConfiguration(resource = MyTrustedClient.class, initialize = false)
    public void testSuccessfulAuthorizationCodeFlow() throws Exception {

        // Once the request is ready and approved, we can continue with the access token
        approveAccessTokenGrant("http://anywhere", true);

        // Finally everything is in place for the grant to happen...
        assertNotNull(context.getAccessToken());

        AccessTokenRequest request = context.getAccessTokenRequest();
        assertNotNull(request.getAuthorizationCode());
        assertEquals(HttpStatus.OK, http.getStatusCode("/system/beans"));

    }

    @Test
    @OAuth2ContextConfiguration(resource = MyTrustedClient.class, initialize = false)
    public void testWrongRedirectUri() throws Exception {
        approveAccessTokenGrant("http://anywhere", true);
        AccessTokenRequest request = context.getAccessTokenRequest();
        // The redirect is stored in the preserved state...
        context.getOAuth2ClientContext().setPreservedState(request.getStateKey(), "http://nowhere");
        // Finally everything is in place for the grant to happen...
        try {
            assertNotNull(context.getAccessToken());
            fail("Expected RedirectMismatchException");
        } catch (RedirectMismatchException e) {
            // expected
        }
        assertEquals(HttpStatus.BAD_REQUEST, getTokenEndpointResponse().getStatusCode());
    }

    @Test
    @OAuth2ContextConfiguration(resource = MyTrustedClient.class, initialize = false)
    public void testUserDeniesConfirmation() throws Exception {
        approveAccessTokenGrant("http://anywhere", false);
        String location = null;
        try {
            assertNotNull(context.getAccessToken());
            fail("Expected UserRedirectRequiredException");
        } catch (UserRedirectRequiredException e) {
            location = e.getRedirectUri();
        }
        assertTrue("Wrong location: " + location, location.contains("state="));
        assertTrue(location.startsWith("http://anywhere"));
        assertTrue(location.substring(location.indexOf('?')).contains("error=access_denied"));
        // It was a redirect that triggered our client redirect exception:
        assertEquals(HttpStatus.FOUND, getTokenEndpointResponse().getStatusCode());
    }

    @Test
    public void testNoClientIdProvided() throws Exception {
        ResponseEntity<String> response = attemptToGetConfirmationPage(null, "http://anywhere");
        // With no client id you get an InvalidClientException on the server which is forwarded to /oauth/error
        assertEquals(HttpStatus.UNAUTHORIZED, response.getStatusCode());
        String body = response.getBody();
        assertTrue("Wrong body: " + body, body.contains("<html"));
        assertTrue("Wrong body: " + body, body.contains("Bad client credentials"));
    }

    @Test
    public void testNoRedirect() throws Exception {
        ResponseEntity<String> response = attemptToGetConfirmationPage("my-trusted-client", null);
        // With no redirect uri you get an UnapprovedClientAuthenticationException on the server which is redirected to
        // /oauth/error.
        assertEquals(HttpStatus.BAD_REQUEST, response.getStatusCode());
        String body = response.getBody();
        assertTrue("Wrong body: " + body, body.contains("<html"));
        assertTrue("Wrong body: " + body, body.contains("invalid_request"));
    }

    @Test
    public void testIllegalAttemptToApproveWithoutUsingAuthorizationRequest() throws Exception {

        HttpHeaders headers = getAuthenticatedHeaders();

        String authorizeUrl = getAuthorizeUrl("my-trusted-client", "http://anywhere.com", "read");
        authorizeUrl = authorizeUrl + "&user_oauth_approval=true";
        ResponseEntity<String> response = http.postForStatus(authorizeUrl, headers,
                new LinkedMultiValueMap<String, String>());
        assertEquals(HttpStatus.BAD_REQUEST, response.getStatusCode());
    }

    @Test
    @OAuth2ContextConfiguration(resource = MyClientWithRegisteredRedirect.class, initialize = false)
    public void testSuccessfulFlowWithRegisteredRedirect() throws Exception {

        // Once the request is ready and approved, we can continue with the access token
        approveAccessTokenGrant(null, true);

        // Finally everything is in place for the grant to happen...
        assertNotNull(context.getAccessToken());

        AccessTokenRequest request = context.getAccessTokenRequest();
        assertNotNull(request.getAuthorizationCode());
        assertEquals(HttpStatus.OK, http.getStatusCode("/system/beans"));

    }

    @Test
    @Ignore("TODO")
    public void testInvalidScopeInAuthorizationRequest() throws Exception {

        HttpHeaders headers = getAuthenticatedHeaders();
        headers.setAccept(Arrays.asList(MediaType.TEXT_HTML));

        String scope = "bogus";
        String redirectUri = "http://anywhere?key=value";
        String clientId = "my-client-with-registered-redirect";

        UriBuilder uri = http.buildUri(authorizePath()).queryParam("response_type", "code")
                .queryParam("state", "mystateid").queryParam("scope", scope);
        if (clientId != null) {
            uri.queryParam("client_id", clientId);
        }
        if (redirectUri != null) {
            uri.queryParam("redirect_uri", redirectUri);
        }
        ResponseEntity<String> response = http.getForString(uri.pattern(), headers, uri.params());
        assertEquals(HttpStatus.FOUND, response.getStatusCode());
        String location = response.getHeaders().getLocation().toString();
        assertTrue(location.startsWith("http://anywhere"));
        assertTrue(location.contains("error=invalid_scope"));
        assertFalse(location.contains("redirect_uri="));
    }

    @Test
    public void testInvalidAccessToken() throws Exception {

        // now make sure an unauthorized request fails the right way.
        HttpHeaders headers = new HttpHeaders();
        headers.set("Authorization", String.format("%s %s", OAuth2AccessToken.BEARER_TYPE, "FOO"));
        ResponseEntity<String> response = http.getForString("/admin/beans", headers);
        assertEquals(HttpStatus.UNAUTHORIZED, response.getStatusCode());

        String authenticate = response.getHeaders().getFirst("WWW-Authenticate");
        assertNotNull(authenticate);
        assertTrue(authenticate.startsWith("Bearer"));
        // Resource Server doesn't know what scopes are required until the token can be validated
        assertFalse(authenticate.contains("scope=\""));

    }

    @Test
    @OAuth2ContextConfiguration(resource = MyClientWithRegisteredRedirect.class, initialize = false)
    public void testRegisteredRedirectWithWrongRequestedRedirect() throws Exception {
        try {
            approveAccessTokenGrant("http://nowhere", true);
            fail("Expected RedirectMismatchException");
        } catch (HttpClientErrorException e) {
            assertEquals(HttpStatus.BAD_REQUEST, e.getStatusCode());
        }
    }

    @Test
    @OAuth2ContextConfiguration(resource = MyClientWithRegisteredRedirect.class, initialize = false)
    public void testRegisteredRedirectWithWrongOneInTokenEndpoint() throws Exception {
        approveAccessTokenGrant("http://anywhere?key=value", true);
        // Setting the redirect uri directly in the request should override the saved value
        context.getAccessTokenRequest().set("redirect_uri", "http://nowhere.com");
        try {
            assertNotNull(context.getAccessToken());
            fail("Expected RedirectMismatchException");
        } catch (RedirectMismatchException e) {
            assertEquals(HttpStatus.BAD_REQUEST.value(), e.getHttpErrorCode());
            assertEquals("invalid_grant", e.getOAuth2ErrorCode());
        }
    }

    @Test
    @OAuth2ContextConfiguration(resource = MyTrustedClient.class, initialize = false)
    public void testWrongClientIdTokenEndpoint() throws Exception {
        approveAccessTokenGrant("http://anywhere?key=value", true);
        ((BaseOAuth2ProtectedResourceDetails) context.getResource()).setClientId("non-existent");
        try {
            assertNotNull(context.getAccessToken());
            fail("Expected HttpClientErrorException");
        } catch (HttpClientErrorException e) {
            assertEquals(HttpStatus.UNAUTHORIZED, e.getStatusCode());
        }
    }

}