-
Notifications
You must be signed in to change notification settings - Fork 1.4k
validate redirect origin in oidc rp sign-in completion #3241
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
Open
dxbjavid
wants to merge
1
commit into
apache:main
Choose a base branch
from
dxbjavid:oidc-rp-redirect-origin-check
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+137
−4
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
103 changes: 103 additions & 0 deletions
103
...idc/src/test/java/org/apache/cxf/rs/security/oidc/rp/OidcRpAuthenticationServiceTest.java
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,103 @@ | ||
| /** | ||
| * Licensed to the Apache Software Foundation (ASF) under one | ||
| * or more contributor license agreements. See the NOTICE file | ||
| * distributed with this work for additional information | ||
| * regarding copyright ownership. The ASF licenses this file | ||
| * to you 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.apache.cxf.rs.security.oidc.rp; | ||
|
|
||
| import java.lang.reflect.Field; | ||
| import java.net.URI; | ||
|
|
||
| import jakarta.ws.rs.core.MultivaluedHashMap; | ||
| import jakarta.ws.rs.core.MultivaluedMap; | ||
| import jakarta.ws.rs.core.Response; | ||
|
|
||
| import org.apache.cxf.jaxrs.ext.MessageContext; | ||
| import org.apache.cxf.rs.security.oauth2.client.ClientTokenContextManager; | ||
|
|
||
| import org.junit.Test; | ||
|
|
||
| import static org.junit.Assert.assertEquals; | ||
| import static org.junit.Assert.assertNull; | ||
| import static org.mockito.Mockito.mock; | ||
| import static org.mockito.Mockito.when; | ||
|
|
||
| public class OidcRpAuthenticationServiceTest { | ||
|
|
||
| private static final String BASE_PATH = "https://app.example.com:8080/services/"; | ||
|
|
||
| @Test | ||
| public void testRejectsCrossOriginRedirectFromState() { | ||
| Response response = complete("https://evil.example.com/phish"); | ||
| assertEquals(200, response.getStatus()); | ||
| assertNull(response.getLocation()); | ||
| } | ||
|
|
||
| @Test | ||
| public void testRejectsProtocolRelativeRedirectFromState() { | ||
| Response response = complete("//evil.example.com/phish"); | ||
| assertEquals(200, response.getStatus()); | ||
| assertNull(response.getLocation()); | ||
| } | ||
|
|
||
| @Test | ||
| public void testRejectsUserinfoHostConfusionFromState() { | ||
| Response response = complete("https://app.example.com:8080@evil.example.com/phish"); | ||
| assertEquals(200, response.getStatus()); | ||
| assertNull(response.getLocation()); | ||
| } | ||
|
|
||
| @Test | ||
| public void testAllowsSameOriginRedirectFromState() { | ||
| Response response = complete("https://app.example.com:8080/services/protected"); | ||
| assertEquals(303, response.getStatus()); | ||
| assertEquals(URI.create("https://app.example.com:8080/services/protected"), response.getLocation()); | ||
| } | ||
|
|
||
| @Test | ||
| public void testAllowsRelativeRedirectFromState() { | ||
| Response response = complete("/services/protected"); | ||
| assertEquals(303, response.getStatus()); | ||
| assertEquals(URI.create("/services/protected"), response.getLocation()); | ||
| } | ||
|
|
||
| private Response complete(String stateLocation) { | ||
| MessageContext messageContext = mock(MessageContext.class); | ||
| when(messageContext.get("http.base.path")).thenReturn(BASE_PATH); | ||
|
|
||
| MultivaluedMap<String, String> state = new MultivaluedHashMap<>(); | ||
| state.putSingle("state", stateLocation); | ||
|
|
||
| OidcClientTokenContext tokenContext = mock(OidcClientTokenContext.class); | ||
| when(tokenContext.getState()).thenReturn(state); | ||
|
|
||
| OidcRpAuthenticationService service = new OidcRpAuthenticationService(); | ||
| service.setClientTokenContextManager(mock(ClientTokenContextManager.class)); | ||
| setMessageContext(service, messageContext); | ||
|
|
||
| return service.completeAuthentication(tokenContext); | ||
| } | ||
|
|
||
| private static void setMessageContext(OidcRpAuthenticationService service, MessageContext messageContext) { | ||
| try { | ||
| Field field = OidcRpAuthenticationService.class.getDeclaredField("mc"); | ||
| field.setAccessible(true); | ||
| field.set(service, messageContext); | ||
| } catch (ReflectiveOperationException ex) { | ||
| throw new IllegalStateException(ex); | ||
| } | ||
| } | ||
| } |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@coheigea need your advice please, the usage of
statefor redirect URL looks very suspicious, I haven't found any references in OIDC RP specs of such designation, is it correct or I am missing something? thank youThere was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
you're right that it isn't an OIDC concept, the spec treats state as opaque. this is cxf's own reuse of the parameter name rather than anything from the RP specs.
it comes from OidcRpAuthenticationFilter: when addRequestUriAsRedirectQuery is set, the filter writes the original request uri into a query parameter it happens to call state (redirectBuilder.queryParam("state", rc.getUriInfo().getRequestUri().toString())), and completeAuthentication later reads that same state back to send the browser to where it was originally heading. so in normal use the value is always the application's own request uri, which is why the legitimate case is same-origin.
the problem is that toRequestState copies every current request parameter into the context state, so /rp/complete?state=https://evil.example against an already-authenticated session is read back verbatim and returned as a 303 Location, an open redirect. the origin check just keeps that redirect within the application's own scheme and authority. if you'd rather the validation lived in the filter where the value is first written, i'm happy to move it there.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Oh thanks for clarifying @dxbjavid , I think hardening filter would make sense, also making sure the
stateis not colliding with the request state (may be filtering here will help), thanks again