|
| 1 | +/* |
| 2 | + * Copyright 2002-2019 the original author or authors. |
| 3 | + * |
| 4 | + * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | + * you may not use this file except in compliance with the License. |
| 6 | + * You may obtain a copy of the License at |
| 7 | + * |
| 8 | + * https://www.apache.org/licenses/LICENSE-2.0 |
| 9 | + * |
| 10 | + * Unless required by applicable law or agreed to in writing, software |
| 11 | + * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | + * See the License for the specific language governing permissions and |
| 14 | + * limitations under the License. |
| 15 | + */ |
| 16 | +package org.springframework.security.oauth2.client; |
| 17 | + |
| 18 | +import org.springframework.lang.Nullable; |
| 19 | +import org.springframework.security.oauth2.client.endpoint.DefaultPasswordTokenResponseClient; |
| 20 | +import org.springframework.security.oauth2.client.endpoint.OAuth2AccessTokenResponseClient; |
| 21 | +import org.springframework.security.oauth2.client.endpoint.OAuth2PasswordGrantRequest; |
| 22 | +import org.springframework.security.oauth2.client.registration.ClientRegistration; |
| 23 | +import org.springframework.security.oauth2.core.AbstractOAuth2Token; |
| 24 | +import org.springframework.security.oauth2.core.AuthorizationGrantType; |
| 25 | +import org.springframework.security.oauth2.core.endpoint.OAuth2AccessTokenResponse; |
| 26 | +import org.springframework.util.Assert; |
| 27 | +import org.springframework.util.StringUtils; |
| 28 | + |
| 29 | +import java.time.Clock; |
| 30 | +import java.time.Duration; |
| 31 | +import java.time.Instant; |
| 32 | + |
| 33 | +/** |
| 34 | + * An implementation of an {@link OAuth2AuthorizedClientProvider} |
| 35 | + * for the {@link AuthorizationGrantType#PASSWORD password} grant. |
| 36 | + * |
| 37 | + * @author Joe Grandja |
| 38 | + * @since 5.2 |
| 39 | + * @see OAuth2AuthorizedClientProvider |
| 40 | + * @see DefaultPasswordTokenResponseClient |
| 41 | + */ |
| 42 | +public final class PasswordOAuth2AuthorizedClientProvider implements OAuth2AuthorizedClientProvider { |
| 43 | + private OAuth2AccessTokenResponseClient<OAuth2PasswordGrantRequest> accessTokenResponseClient = |
| 44 | + new DefaultPasswordTokenResponseClient(); |
| 45 | + private Duration clockSkew = Duration.ofSeconds(60); |
| 46 | + private Clock clock = Clock.systemUTC(); |
| 47 | + |
| 48 | + /** |
| 49 | + * Attempt to authorize (or re-authorize) the {@link OAuth2AuthorizationContext#getClientRegistration() client} in the provided {@code context}. |
| 50 | + * Returns {@code null} if authorization (or re-authorization) is not supported, |
| 51 | + * e.g. the client's {@link ClientRegistration#getAuthorizationGrantType() authorization grant type} |
| 52 | + * is not {@link AuthorizationGrantType#PASSWORD password} OR |
| 53 | + * the {@link OAuth2AuthorizationContext#USERNAME_ATTRIBUTE_NAME username} and/or |
| 54 | + * {@link OAuth2AuthorizationContext#PASSWORD_ATTRIBUTE_NAME password} attributes |
| 55 | + * are not available in the provided {@code context} OR |
| 56 | + * the {@link OAuth2AuthorizedClient#getAccessToken() access token} is not expired. |
| 57 | + * |
| 58 | + * <p> |
| 59 | + * The following {@link OAuth2AuthorizationContext#getAttributes() context attributes} are supported: |
| 60 | + * <ol> |
| 61 | + * <li>{@link OAuth2AuthorizationContext#USERNAME_ATTRIBUTE_NAME} (required) - a {@code String} value for the resource owner's username</li> |
| 62 | + * <li>{@link OAuth2AuthorizationContext#PASSWORD_ATTRIBUTE_NAME} (required) - a {@code String} value for the resource owner's password</li> |
| 63 | + * </ol> |
| 64 | + * |
| 65 | + * @param context the context that holds authorization-specific state for the client |
| 66 | + * @return the {@link OAuth2AuthorizedClient} or {@code null} if authorization (or re-authorization) is not supported |
| 67 | + */ |
| 68 | + @Override |
| 69 | + @Nullable |
| 70 | + public OAuth2AuthorizedClient authorize(OAuth2AuthorizationContext context) { |
| 71 | + Assert.notNull(context, "context cannot be null"); |
| 72 | + |
| 73 | + ClientRegistration clientRegistration = context.getClientRegistration(); |
| 74 | + OAuth2AuthorizedClient authorizedClient = context.getAuthorizedClient(); |
| 75 | + |
| 76 | + if (!AuthorizationGrantType.PASSWORD.equals(clientRegistration.getAuthorizationGrantType())) { |
| 77 | + return null; |
| 78 | + } |
| 79 | + |
| 80 | + String username = context.getAttribute(OAuth2AuthorizationContext.USERNAME_ATTRIBUTE_NAME); |
| 81 | + String password = context.getAttribute(OAuth2AuthorizationContext.PASSWORD_ATTRIBUTE_NAME); |
| 82 | + if (!StringUtils.hasText(username) || !StringUtils.hasText(password)) { |
| 83 | + return null; |
| 84 | + } |
| 85 | + |
| 86 | + if (authorizedClient != null && !hasTokenExpired(authorizedClient.getAccessToken())) { |
| 87 | + // If client is already authorized and access token is NOT expired than no need for re-authorization |
| 88 | + return null; |
| 89 | + } |
| 90 | + |
| 91 | + if (authorizedClient != null && hasTokenExpired(authorizedClient.getAccessToken()) && authorizedClient.getRefreshToken() != null) { |
| 92 | + // If client is already authorized and access token is expired and a refresh token is available, |
| 93 | + // than return and allow RefreshTokenOAuth2AuthorizedClientProvider to handle the refresh |
| 94 | + return null; |
| 95 | + } |
| 96 | + |
| 97 | + OAuth2PasswordGrantRequest passwordGrantRequest = |
| 98 | + new OAuth2PasswordGrantRequest(clientRegistration, username, password); |
| 99 | + OAuth2AccessTokenResponse tokenResponse = |
| 100 | + this.accessTokenResponseClient.getTokenResponse(passwordGrantRequest); |
| 101 | + |
| 102 | + return new OAuth2AuthorizedClient(clientRegistration, context.getPrincipal().getName(), |
| 103 | + tokenResponse.getAccessToken(), tokenResponse.getRefreshToken()); |
| 104 | + } |
| 105 | + |
| 106 | + private boolean hasTokenExpired(AbstractOAuth2Token token) { |
| 107 | + return token.getExpiresAt().isBefore(Instant.now(this.clock).minus(this.clockSkew)); |
| 108 | + } |
| 109 | + |
| 110 | + /** |
| 111 | + * Sets the client used when requesting an access token credential at the Token Endpoint for the {@code password} grant. |
| 112 | + * |
| 113 | + * @param accessTokenResponseClient the client used when requesting an access token credential at the Token Endpoint for the {@code password} grant |
| 114 | + */ |
| 115 | + public void setAccessTokenResponseClient(OAuth2AccessTokenResponseClient<OAuth2PasswordGrantRequest> accessTokenResponseClient) { |
| 116 | + Assert.notNull(accessTokenResponseClient, "accessTokenResponseClient cannot be null"); |
| 117 | + this.accessTokenResponseClient = accessTokenResponseClient; |
| 118 | + } |
| 119 | + |
| 120 | + /** |
| 121 | + * Sets the maximum acceptable clock skew, which is used when checking the |
| 122 | + * {@link OAuth2AuthorizedClient#getAccessToken() access token} expiry. The default is 60 seconds. |
| 123 | + * An access token is considered expired if it's before {@code Instant.now(this.clock) - clockSkew}. |
| 124 | + * |
| 125 | + * @param clockSkew the maximum acceptable clock skew |
| 126 | + */ |
| 127 | + public void setClockSkew(Duration clockSkew) { |
| 128 | + Assert.notNull(clockSkew, "clockSkew cannot be null"); |
| 129 | + Assert.isTrue(clockSkew.getSeconds() >= 0, "clockSkew must be >= 0"); |
| 130 | + this.clockSkew = clockSkew; |
| 131 | + } |
| 132 | + |
| 133 | + /** |
| 134 | + * Sets the {@link Clock} used in {@link Instant#now(Clock)} when checking the access token expiry. |
| 135 | + * |
| 136 | + * @param clock the clock |
| 137 | + */ |
| 138 | + public void setClock(Clock clock) { |
| 139 | + Assert.notNull(clock, "clock cannot be null"); |
| 140 | + this.clock = clock; |
| 141 | + } |
| 142 | +} |
0 commit comments