Skip to content

Use requested scope when refresh response omits it #20110

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

Use requested scope when refresh response omits it #20110

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
10 changes: 9 additions & 1 deletion ...gframework/security/oauth2/client/endpoint/RestClientRefreshTokenTokenResponseClient.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,15 @@ private OAuth2AccessTokenResponse populateTokenResponse(OAuth2RefreshTokenGrantR
OAuth2AccessTokenResponse.Builder tokenResponseBuilder = OAuth2AccessTokenResponse
.withResponse(accessTokenResponse);
if (CollectionUtils.isEmpty(accessTokenResponse.getAccessToken().getScopes())) {
tokenResponseBuilder.scopes(grantRequest.getAccessToken().getScopes());
// RFC 6749 section 5.1 allows the response to omit the scope when it is
// identical to the scope requested by the client. Fall back to the requested
// scope, if present, and otherwise to the previously granted scope.
if (!CollectionUtils.isEmpty(grantRequest.getScopes())) {
tokenResponseBuilder.scopes(grantRequest.getScopes());
}
else {
tokenResponseBuilder.scopes(grantRequest.getAccessToken().getScopes());
}
}
if (accessTokenResponse.getRefreshToken() == null) {
// Reuse existing refresh token
Expand Down
10 changes: 9 additions & 1 deletion ...ork/security/oauth2/client/endpoint/WebClientReactiveRefreshTokenTokenResponseClient.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,15 @@ private OAuth2AccessTokenResponse populateTokenResponse(OAuth2RefreshTokenGrantR
OAuth2AccessTokenResponse.Builder tokenResponseBuilder = OAuth2AccessTokenResponse
.withResponse(accessTokenResponse);
if (CollectionUtils.isEmpty(accessTokenResponse.getAccessToken().getScopes())) {
tokenResponseBuilder.scopes(grantRequest.getAccessToken().getScopes());
// RFC 6749 section 5.1 allows the response to omit the scope when it is
// identical to the scope requested by the client. Fall back to the requested
// scope, if present, and otherwise to the previously granted scope.
if (!CollectionUtils.isEmpty(grantRequest.getScopes())) {
tokenResponseBuilder.scopes(grantRequest.getScopes());
}
else {
tokenResponseBuilder.scopes(grantRequest.getAccessToken().getScopes());
}
}
if (accessTokenResponse.getRefreshToken() == null) {
// Reuse existing refresh token
Expand Down
11 changes: 11 additions & 0 deletions ...ework/security/oauth2/client/endpoint/RestClientRefreshTokenTokenResponseClientTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -264,6 +264,17 @@ public void getTokenResponseWhenSuccessResponseDoesNotIncludeScopeThenAccessToke
assertThat(accessTokenResponse.getAccessToken().getScopes()).containsExactlyInAnyOrder("read", "write");
}

@Test
public void getTokenResponseWhenResponseOmitsScopeAndRequestNarrowsScopeThenAccessTokenHasRequestedScope() {
this.server.enqueue(MockResponses.json("access-token-response.json"));
ClientRegistration clientRegistration = this.clientRegistration.build();
OAuth2RefreshTokenGrantRequest grantRequest = new OAuth2RefreshTokenGrantRequest(clientRegistration,
this.accessToken, this.refreshToken, Collections.singleton("read"));
OAuth2AccessTokenResponse accessTokenResponse = this.tokenResponseClient.getTokenResponse(grantRequest);
assertThat(accessTokenResponse).isNotNull();
assertThat(accessTokenResponse.getAccessToken().getScopes()).containsExactly("read");
}

@Test
public void getTokenResponseWhenRequestDoesNotIncludeScopeThenAccessTokenHasResponseScope() throws Exception {
this.server.enqueue(MockResponses.json("access-token-response-read.json"));
Expand Down
13 changes: 13 additions & 0 deletions ...ecurity/oauth2/client/endpoint/WebClientReactiveRefreshTokenTokenResponseClientTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -236,6 +236,19 @@ public void getTokenResponseWhenSuccessResponseIncludesScopeThenAccessTokenHasRe
assertThat(accessTokenResponse.getAccessToken().getScopes()).containsExactly("read");
}

@Test
public void getTokenResponseWhenResponseOmitsScopeAndRequestNarrowsScopeThenAccessTokenHasRequestedScope() {
this.server.enqueue(MockResponses.json("access-token-response.json"));
OAuth2RefreshTokenGrantRequest refreshTokenGrantRequest = new OAuth2RefreshTokenGrantRequest(
this.clientRegistrationBuilder.build(), this.accessToken, this.refreshToken,
Collections.singleton("read"));
OAuth2AccessTokenResponse accessTokenResponse = this.tokenResponseClient
.getTokenResponse(refreshTokenGrantRequest)
.block();
assertThat(accessTokenResponse).isNotNull();
assertThat(accessTokenResponse.getAccessToken().getScopes()).containsExactly("read");
}

@Test
public void getTokenResponseWhenErrorResponseThenThrowOAuth2AuthorizationException() {
this.server.enqueue(MockResponses.json("unauthorized-client-response.json").setResponseCode(400));
Expand Down