Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[SDK-4670] Improved state handling errors #140

Merged
merged 7 commits into from
Dec 18, 2023
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions src/main/java/com/auth0/RequestProcessor.java
Original file line number Diff line number Diff line change
Expand Up @@ -292,8 +292,17 @@ private void assertNoError(HttpServletRequest request) throws InvalidRequestExce
* @throws InvalidRequestException if the request contains a different state from the expected one
*/
private void assertValidState(HttpServletRequest request, HttpServletResponse response) throws InvalidRequestException {
// TODO in v2:
// - only store state/nonce in cookies, remove session storage
// - create specific exception classes for various state validation failures (missing from auth response, missing
// state cookie, mismatch)

String stateFromRequest = request.getParameter(KEY_STATE);

if (stateFromRequest == null) {
throw new InvalidRequestException(INVALID_STATE_ERROR, "The received state doesn't match the expected one. No state parameter was found on the authorization response.");
}

// If response is null, check the Session.
// This can happen when the deprecated handle method that only takes the request parameter is called
if (response == null) {
Expand All @@ -306,6 +315,9 @@ private void assertValidState(HttpServletRequest request, HttpServletResponse re
// Just in case state was stored in Session by building auth URL with deprecated method, but then called the
// supported handle method with the request and response
if (cookieState == null) {
if (SessionUtils.get(request, StorageUtils.STATE_KEY) == null) {
throw new InvalidRequestException(INVALID_STATE_ERROR, "The received state doesn't match the expected one. No state cookie or state session attribute found. Check that you are using non-deprecated methods and that cookies are not being removed on the server.");
}
checkSessionState(request, stateFromRequest);
return;
}
Expand Down
78 changes: 76 additions & 2 deletions src/test/java/com/auth0/RequestProcessorTest.java
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ public void shouldThrowOnProcessIfRequestHasMissingStateParameter() throws Excep
.build();
InvalidRequestException e = assertThrows(InvalidRequestException.class, () -> handler.process(request, response));
assertThat(e, InvalidRequestExceptionMatcher.hasCode("a0.invalid_state"));
assertEquals("The received state doesn't match the expected one.", e.getMessage());
assertEquals("The received state doesn't match the expected one. No state parameter was found on the authorization response.", e.getMessage());
}

@Test
Expand All @@ -120,7 +120,7 @@ public void shouldThrowOnProcessIfRequestHasMissingStateCookie() throws Exceptio
.build();
InvalidRequestException e = assertThrows(InvalidRequestException.class, () -> handler.process(request, response));
assertThat(e, InvalidRequestExceptionMatcher.hasCode("a0.invalid_state"));
assertEquals("The received state doesn't match the expected one.", e.getMessage());
assertEquals("The received state doesn't match the expected one. No state cookie or state session attribute found. Check that you are using non-deprecated methods and that cookies are not being removed on the server.", e.getMessage());
}

@Test
Expand Down Expand Up @@ -288,6 +288,80 @@ public void shouldReturnTokensOnProcessIfIdTokenCodeRequestPassesIdTokenVerifica
assertThat(tokens.getExpiresIn(), is(8400L));
}

@Test
public void shouldReturnTokensOnProcessIfIdTokenCodeRequestPassesIdTokenVerificationWhenUsingSessionStorage() throws Exception {
doNothing().when(tokenVerifier).verify(eq("frontIdToken"), eq(verifyOptions));

Map<String, Object> params = new HashMap<>();
params.put("code", "abc123");
params.put("state", "1234");
params.put("id_token", "frontIdToken");
params.put("expires_in", "8400");
params.put("token_type", "frontTokenType");
MockHttpServletRequest request = getRequest(params);
request.getSession().setAttribute("com.auth0.state", "1234");

TokenRequest codeExchangeRequest = mock(TokenRequest.class);
TokenHolder tokenHolder = mock(TokenHolder.class);
when(tokenHolder.getIdToken()).thenReturn("backIdToken");
when(tokenHolder.getExpiresIn()).thenReturn(4800L);
when(tokenHolder.getTokenType()).thenReturn("backTokenType");
when(codeExchangeRequest.execute()).thenReturn(tokenHolder);
when(client.exchangeCode("abc123", "https://me.auth0.com:80/callback")).thenReturn(codeExchangeRequest);

RequestProcessor handler = new RequestProcessor.Builder(client, "id_token code", verifyOptions)
.withIdTokenVerifier(tokenVerifier)
.build();
Tokens tokens = handler.process(request, response);

//Should not verify the ID Token twice
verify(tokenVerifier).verify("frontIdToken", verifyOptions);
verify(tokenVerifier, never()).verify("backIdToken", verifyOptions);
verifyNoMoreInteractions(tokenVerifier);

assertThat(tokens, is(notNullValue()));
assertThat(tokens.getIdToken(), is("frontIdToken"));
assertThat(tokens.getType(), is("frontTokenType"));
assertThat(tokens.getExpiresIn(), is(8400L));
}

@Test
public void shouldReturnTokensOnProcessIfIdTokenCodeRequestPassesIdTokenVerificationWhenUsingSessionStorageWithNullSession() throws Exception {
doNothing().when(tokenVerifier).verify(eq("frontIdToken"), eq(verifyOptions));

Map<String, Object> params = new HashMap<>();
params.put("code", "abc123");
params.put("state", "1234");
params.put("id_token", "frontIdToken");
params.put("expires_in", "8400");
params.put("token_type", "frontTokenType");
MockHttpServletRequest request = getRequest(params);
request.getSession().setAttribute("com.auth0.state", "1234");

TokenRequest codeExchangeRequest = mock(TokenRequest.class);
TokenHolder tokenHolder = mock(TokenHolder.class);
when(tokenHolder.getIdToken()).thenReturn("backIdToken");
when(tokenHolder.getExpiresIn()).thenReturn(4800L);
when(tokenHolder.getTokenType()).thenReturn("backTokenType");
when(codeExchangeRequest.execute()).thenReturn(tokenHolder);
when(client.exchangeCode("abc123", "https://me.auth0.com:80/callback")).thenReturn(codeExchangeRequest);

RequestProcessor handler = new RequestProcessor.Builder(client, "id_token code", verifyOptions)
.withIdTokenVerifier(tokenVerifier)
.build();
Tokens tokens = handler.process(request, null);

//Should not verify the ID Token twice
verify(tokenVerifier).verify("frontIdToken", verifyOptions);
verify(tokenVerifier, never()).verify("backIdToken", verifyOptions);
verifyNoMoreInteractions(tokenVerifier);

assertThat(tokens, is(notNullValue()));
assertThat(tokens.getIdToken(), is("frontIdToken"));
assertThat(tokens.getType(), is("frontTokenType"));
assertThat(tokens.getExpiresIn(), is(8400L));
}

@Test
public void shouldReturnTokensOnProcessIfTokenIdTokenCodeRequestPassesIdTokenVerification() throws Exception {
doNothing().when(tokenVerifier).verify(eq("frontIdToken"), eq(verifyOptions));
Expand Down
Loading