Skip to content

Fix OIDC discovery to fallback on text/html responses #17927

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.

Sign up for GitHub

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
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Fix OIDC discovery to fallback on text/html responses #17927

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 4 additions & 0 deletions ...ain/java/org/springframework/security/oauth2/client/registration/ClientRegistrations.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@
import org.springframework.util.Assert;
import org.springframework.web.client.HttpClientErrorException;
import org.springframework.web.client.RestTemplate;
import org.springframework.web.client.UnknownContentTypeException;
import org.springframework.web.util.UriComponents;
import org.springframework.web.util.UriComponentsBuilder;

Expand Down Expand Up @@ -279,6 +280,9 @@ private static ClientRegistration.Builder getBuilder(String issuer,
errors.add(ex.getMessage());
// else try another endpoint
}
catch (UnknownContentTypeException ex) {
errors.add(ex.getMessage());
}
catch (IllegalArgumentException | IllegalStateException ex) {
throw ex;
}
Expand Down
68 changes: 68 additions & 0 deletions ...ava/org/springframework/security/oauth2/client/registration/ClientRegistrationsTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -581,6 +581,39 @@ public void oidcWhenHostContainsUnderscoreThenRetains() {
assertThat(oidcRfc8414.getHost()).isEqualTo("elated_sutherland");
}

@Test
public void issuerWhenOidcHtmlThenFallbackToOAuth2ThenSuccess() throws Exception {
ClientRegistration registration = registrationOAuth2WithOidcHtml("issuer1", null).build();
ClientRegistration.ProviderDetails provider = registration.getProviderDetails();
assertThat(provider.getAuthorizationUri()).isEqualTo("https://example.com/o/oauth2/v2/auth");
assertThat(provider.getTokenUri()).isEqualTo("https://example.com/oauth2/v4/token");
assertThat(provider.getIssuerUri()).isEqualTo(this.issuer);

// order: OIDC(issuer-prefixed) -> OIDC(host-prefixed) -> OAuth
RecordedRequest request1 = this.server.takeRequest();
assertThat(request1.getPath()).isEqualTo("/issuer1/.well-known/openid-configuration");
RecordedRequest request2 = this.server.takeRequest();
assertThat(request2.getPath()).isEqualTo("/.well-known/openid-configuration/issuer1");
RecordedRequest request3 = this.server.takeRequest();
assertThat(request3.getPath()).isEqualTo("/.well-known/oauth-authorization-server/issuer1");
}

@Test
public void issuerWhenFirstEndpoint5xxThenThrowsIllegalArgumentException() throws Exception {
this.issuer = createIssuerFromServer("issuer1");
this.server.setDispatcher(new Dispatcher() {
@Override
public MockResponse dispatch(RecordedRequest req) {
return switch (req.getPath()) {
case "/issuer1/.well-known/openid-configuration" -> new MockResponse().setResponseCode(500);
default -> new MockResponse().setResponseCode(404);
};
}
});
assertThatIllegalArgumentException()
.isThrownBy(() -> ClientRegistrations.fromIssuerLocation(this.issuer).build());
}

@Test
public void issuerWhenAllEndpointsFailedThenExceptionIncludesFailureInformation() {
this.issuer = createIssuerFromServer("issuer1");
Expand Down Expand Up @@ -673,6 +706,41 @@ public MockResponse dispatch(RecordedRequest request) {
return ClientRegistrations.fromIssuerLocation(this.issuer).clientId("client-id").clientSecret("client-secret");
}

/**
* Simulates a situation when the OIDC discovery endpoints
* "/issuer1/.well-known/openid-configuration" and
* "/.well-known/openid-configuration/issuer1" respond with HTTP 200 and text/html
* (non-JSON), so discovery falls back to
* "/.well-known/oauth-authorization-server/issuer1", which responds with HTTP 200 and
* JSON.
*
* @see <a href="https://tools.ietf.org/html/rfc8414#section-3.1">Section 3.1</a>
* @see <a href="https://tools.ietf.org/html/rfc8414#section-5">Section 5</a>
*/
private ClientRegistration.Builder registrationOAuth2WithOidcHtml(String path, String body) throws Exception {
this.issuer = createIssuerFromServer(path);
this.response.put("issuer", this.issuer);
String responseBody = (body != null) ? body : this.mapper.writeValueAsString(this.response);
final Dispatcher dispatcher = new Dispatcher() {
@Override
public MockResponse dispatch(RecordedRequest request) {
return switch (request.getPath()) {
case "/issuer1/.well-known/openid-configuration", "/.well-known/openid-configuration/issuer1",
"/.well-known/openid-configuration/" ->
new MockResponse().setResponseCode(200)
.setBody("<html>not json</html>")
.setHeader(HttpHeaders.CONTENT_TYPE, MediaType.TEXT_HTML_VALUE);
case "/.well-known/oauth-authorization-server/issuer1",
"/.well-known/oauth-authorization-server/" ->
buildSuccessMockResponse(responseBody);
default -> new MockResponse().setResponseCode(404);
};
}
};
this.server.setDispatcher(dispatcher);
return ClientRegistrations.fromIssuerLocation(this.issuer).clientId("client-id").clientSecret("client-secret");
}

private MockResponse buildSuccessMockResponse(String body) {
// @formatter:off
return new MockResponse().setResponseCode(200)
Expand Down