-
Notifications
You must be signed in to change notification settings - Fork 6k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Closes gh-6053
- Loading branch information
Showing
15 changed files
with
1,142 additions
and
4 deletions.
There are no files selected for viewing
129 changes: 129 additions & 0 deletions
129
...a/org/springframework/security/oauth2/client/JwtBearerOAuth2AuthorizedClientProvider.java
This file contains 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,129 @@ | ||
| /* | ||
| * Copyright 2002-2021 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 | ||
| * | ||
| * https://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.springframework.security.oauth2.client; | ||
|
|
||
| import java.time.Clock; | ||
| import java.time.Duration; | ||
| import java.time.Instant; | ||
|
|
||
| import org.springframework.lang.Nullable; | ||
| import org.springframework.security.oauth2.client.endpoint.DefaultJwtBearerTokenResponseClient; | ||
| import org.springframework.security.oauth2.client.endpoint.OAuth2AccessTokenResponseClient; | ||
| import org.springframework.security.oauth2.client.endpoint.OAuth2JwtBearerGrantRequest; | ||
| import org.springframework.security.oauth2.client.registration.ClientRegistration; | ||
| import org.springframework.security.oauth2.core.AbstractOAuth2Token; | ||
| import org.springframework.security.oauth2.core.endpoint.OAuth2AccessTokenResponse; | ||
| import org.springframework.security.oauth2.jwt.Jwt; | ||
| import org.springframework.util.Assert; | ||
|
|
||
| /** | ||
| * An implementation of an {@link OAuth2AuthorizedClientProvider} for the | ||
| * {@link OAuth2JwtBearerGrantRequest#JWT_BEARER_GRANT_TYPE jwt-bearer} grant. | ||
| * | ||
| * @author Joe Grandja | ||
| * @since 5.5 | ||
| * @see OAuth2AuthorizedClientProvider | ||
| * @see DefaultJwtBearerTokenResponseClient | ||
| */ | ||
| public final class JwtBearerOAuth2AuthorizedClientProvider implements OAuth2AuthorizedClientProvider { | ||
|
|
||
| private OAuth2AccessTokenResponseClient<OAuth2JwtBearerGrantRequest> accessTokenResponseClient = new DefaultJwtBearerTokenResponseClient(); | ||
|
|
||
| private Duration clockSkew = Duration.ofSeconds(60); | ||
|
|
||
| private Clock clock = Clock.systemUTC(); | ||
|
|
||
| /** | ||
| * Attempt to authorize the {@link OAuth2AuthorizationContext#getClientRegistration() | ||
| * client} in the provided {@code context}. Returns {@code null} if authorization is | ||
| * not supported, e.g. the client's | ||
| * {@link ClientRegistration#getAuthorizationGrantType() authorization grant type} is | ||
| * not {@link OAuth2JwtBearerGrantRequest#JWT_BEARER_GRANT_TYPE jwt-bearer}. | ||
| * @param context the context that holds authorization-specific state for the client | ||
| * @return the {@link OAuth2AuthorizedClient} or {@code null} if authorization is not | ||
| * supported | ||
| */ | ||
| @Override | ||
| @Nullable | ||
| public OAuth2AuthorizedClient authorize(OAuth2AuthorizationContext context) { | ||
| Assert.notNull(context, "context cannot be null"); | ||
|
|
||
| ClientRegistration clientRegistration = context.getClientRegistration(); | ||
| if (!OAuth2JwtBearerGrantRequest.JWT_BEARER_GRANT_TYPE.equals(clientRegistration.getAuthorizationGrantType())) { | ||
| return null; | ||
| } | ||
|
|
||
| Jwt jwt = context.getAttribute(OAuth2AuthorizationContext.JWT_ATTRIBUTE_NAME); | ||
| if (jwt == null) { | ||
| return null; | ||
| } | ||
|
|
||
| OAuth2AuthorizedClient authorizedClient = context.getAuthorizedClient(); | ||
| if (authorizedClient != null && !hasTokenExpired(authorizedClient.getAccessToken())) { | ||
| // If client is already authorized but access token is NOT expired than no | ||
| // need for re-authorization | ||
| return null; | ||
| } | ||
|
|
||
| OAuth2JwtBearerGrantRequest jwtBearerGrantRequest = new OAuth2JwtBearerGrantRequest(clientRegistration, jwt); | ||
| OAuth2AccessTokenResponse tokenResponse = this.accessTokenResponseClient | ||
| .getTokenResponse(jwtBearerGrantRequest); | ||
|
|
||
| return new OAuth2AuthorizedClient(clientRegistration, context.getPrincipal().getName(), | ||
| tokenResponse.getAccessToken()); | ||
| } | ||
|
|
||
| private boolean hasTokenExpired(AbstractOAuth2Token token) { | ||
| return this.clock.instant().isAfter(token.getExpiresAt().minus(this.clockSkew)); | ||
| } | ||
|
|
||
| /** | ||
| * Sets the client used when requesting an access token credential at the Token | ||
| * Endpoint for the {@code jwt-bearer} grant. | ||
| * @param accessTokenResponseClient the client used when requesting an access token | ||
| * credential at the Token Endpoint for the {@code jwt-bearer} grant | ||
| */ | ||
| public void setAccessTokenResponseClient( | ||
| OAuth2AccessTokenResponseClient<OAuth2JwtBearerGrantRequest> accessTokenResponseClient) { | ||
| Assert.notNull(accessTokenResponseClient, "accessTokenResponseClient cannot be null"); | ||
| this.accessTokenResponseClient = accessTokenResponseClient; | ||
| } | ||
|
|
||
| /** | ||
| * Sets the maximum acceptable clock skew, which is used when checking the | ||
| * {@link OAuth2AuthorizedClient#getAccessToken() access token} expiry. The default is | ||
| * 60 seconds. An access token is considered expired if it's before | ||
| * {@code Instant.now(this.clock) - clockSkew}. | ||
| * @param clockSkew the maximum acceptable clock skew | ||
| */ | ||
| public void setClockSkew(Duration clockSkew) { | ||
| Assert.notNull(clockSkew, "clockSkew cannot be null"); | ||
| Assert.isTrue(clockSkew.getSeconds() >= 0, "clockSkew must be >= 0"); | ||
| this.clockSkew = clockSkew; | ||
| } | ||
|
|
||
| /** | ||
| * Sets the {@link Clock} used in {@link Instant#now(Clock)} when checking the access | ||
| * token expiry. | ||
| * @param clock the clock | ||
| */ | ||
| public void setClock(Clock clock) { | ||
| Assert.notNull(clock, "clock cannot be null"); | ||
| this.clock = clock; | ||
| } | ||
|
|
||
| } |
This file contains 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 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
Oops, something went wrong.