-
Notifications
You must be signed in to change notification settings - Fork 1.3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add support for OAuth 2.0 Device Authorization Grant
Closes gh-44
- Loading branch information
Showing
54 changed files
with
4,399 additions
and
124 deletions.
There are no files selected for viewing
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
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
267 changes: 267 additions & 0 deletions
267
.../authorization/authentication/OAuth2DeviceAuthorizationConsentAuthenticationProvider.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,267 @@ | ||
| /* | ||
| * Copyright 2020-2023 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.server.authorization.authentication; | ||
|
|
||
| import java.security.Principal; | ||
| import java.util.Collections; | ||
| import java.util.HashSet; | ||
| import java.util.Set; | ||
| import java.util.function.Consumer; | ||
|
|
||
| import org.apache.commons.logging.Log; | ||
| import org.apache.commons.logging.LogFactory; | ||
|
|
||
| import org.springframework.security.authentication.AuthenticationProvider; | ||
| import org.springframework.security.core.Authentication; | ||
| import org.springframework.security.core.AuthenticationException; | ||
| import org.springframework.security.core.GrantedAuthority; | ||
| import org.springframework.security.oauth2.core.OAuth2AuthenticationException; | ||
| import org.springframework.security.oauth2.core.OAuth2AuthorizationException; | ||
| import org.springframework.security.oauth2.core.OAuth2DeviceCode; | ||
| import org.springframework.security.oauth2.core.OAuth2Error; | ||
| import org.springframework.security.oauth2.core.OAuth2ErrorCodes; | ||
| import org.springframework.security.oauth2.core.OAuth2UserCode; | ||
| import org.springframework.security.oauth2.core.endpoint.OAuth2AuthorizationRequest; | ||
| import org.springframework.security.oauth2.core.endpoint.OAuth2ParameterNames; | ||
| import org.springframework.security.oauth2.server.authorization.OAuth2Authorization; | ||
| import org.springframework.security.oauth2.server.authorization.OAuth2AuthorizationConsent; | ||
| import org.springframework.security.oauth2.server.authorization.OAuth2AuthorizationConsentService; | ||
| import org.springframework.security.oauth2.server.authorization.OAuth2AuthorizationService; | ||
| import org.springframework.security.oauth2.server.authorization.OAuth2TokenType; | ||
| import org.springframework.security.oauth2.server.authorization.client.RegisteredClient; | ||
| import org.springframework.security.oauth2.server.authorization.client.RegisteredClientRepository; | ||
| import org.springframework.util.Assert; | ||
|
|
||
| /** | ||
| * An {@link AuthenticationProvider} implementation for the OAuth 2.0 Authorization Consent | ||
| * used in the Device Authorization Grant. | ||
| * | ||
| * @author Steve Riesenberg | ||
| * @since 1.1 | ||
| * @see OAuth2DeviceAuthorizationConsentAuthenticationToken | ||
| * @see OAuth2AuthorizationConsent | ||
| * @see OAuth2DeviceAuthorizationRequestAuthenticationProvider | ||
| * @see OAuth2DeviceVerificationAuthenticationProvider | ||
| * @see OAuth2DeviceCodeAuthenticationProvider | ||
| * @see RegisteredClientRepository | ||
| * @see OAuth2AuthorizationService | ||
| * @see OAuth2AuthorizationConsentService | ||
| */ | ||
| public final class OAuth2DeviceAuthorizationConsentAuthenticationProvider implements AuthenticationProvider { | ||
|
|
||
| private static final String DEFAULT_ERROR_URI = "https://datatracker.ietf.org/doc/html/rfc6749#section-4.1.2.1"; | ||
| private static final OAuth2TokenType STATE_TOKEN_TYPE = new OAuth2TokenType(OAuth2ParameterNames.STATE); | ||
|
|
||
| private final Log logger = LogFactory.getLog(getClass()); | ||
| private final RegisteredClientRepository registeredClientRepository; | ||
| private final OAuth2AuthorizationService authorizationService; | ||
| private final OAuth2AuthorizationConsentService authorizationConsentService; | ||
| private Consumer<OAuth2AuthorizationConsentAuthenticationContext> authorizationConsentCustomizer; | ||
|
|
||
| /** | ||
| * Constructs an {@code OAuth2DeviceAuthorizationConsentAuthenticationProvider} using the provided parameters. | ||
| * | ||
| * @param registeredClientRepository the repository of registered clients | ||
| * @param authorizationService the authorization service | ||
| * @param authorizationConsentService the authorization consent service | ||
| */ | ||
| public OAuth2DeviceAuthorizationConsentAuthenticationProvider( | ||
| RegisteredClientRepository registeredClientRepository, | ||
| OAuth2AuthorizationService authorizationService, | ||
| OAuth2AuthorizationConsentService authorizationConsentService) { | ||
| Assert.notNull(registeredClientRepository, "registeredClientRepository cannot be null"); | ||
| Assert.notNull(authorizationService, "authorizationService cannot be null"); | ||
| Assert.notNull(authorizationConsentService, "authorizationConsentService cannot be null"); | ||
| this.registeredClientRepository = registeredClientRepository; | ||
| this.authorizationService = authorizationService; | ||
| this.authorizationConsentService = authorizationConsentService; | ||
| } | ||
|
|
||
| @Override | ||
| public Authentication authenticate(Authentication authentication) throws AuthenticationException { | ||
| OAuth2DeviceAuthorizationConsentAuthenticationToken deviceAuthorizationConsentAuthentication = | ||
| (OAuth2DeviceAuthorizationConsentAuthenticationToken) authentication; | ||
|
|
||
| OAuth2Authorization authorization = this.authorizationService.findByToken( | ||
| deviceAuthorizationConsentAuthentication.getState(), STATE_TOKEN_TYPE); | ||
| if (authorization == null) { | ||
| throwError(OAuth2ErrorCodes.INVALID_REQUEST, OAuth2ParameterNames.STATE); | ||
| } | ||
|
|
||
| if (this.logger.isTraceEnabled()) { | ||
| this.logger.trace("Retrieved authorization with device authorization consent state"); | ||
| } | ||
|
|
||
| Authentication principal = (Authentication) deviceAuthorizationConsentAuthentication.getPrincipal(); | ||
|
|
||
| RegisteredClient registeredClient = this.registeredClientRepository.findByClientId( | ||
| deviceAuthorizationConsentAuthentication.getClientId()); | ||
| if (registeredClient == null || !registeredClient.getId().equals(authorization.getRegisteredClientId())) { | ||
| throwError(OAuth2ErrorCodes.INVALID_REQUEST, OAuth2ParameterNames.CLIENT_ID); | ||
| } | ||
|
|
||
| if (this.logger.isTraceEnabled()) { | ||
| this.logger.trace("Retrieved registered client"); | ||
| } | ||
|
|
||
| OAuth2AuthorizationRequest authorizationRequest = authorization.getAttribute( | ||
| OAuth2AuthorizationRequest.class.getName()); | ||
| Set<String> requestedScopes = authorizationRequest.getScopes(); | ||
| Set<String> authorizedScopes = deviceAuthorizationConsentAuthentication.getScopes() != null ? | ||
| new HashSet<>(deviceAuthorizationConsentAuthentication.getScopes()) : | ||
| new HashSet<>(); | ||
| if (!requestedScopes.containsAll(authorizedScopes)) { | ||
| throwError(OAuth2ErrorCodes.INVALID_SCOPE, OAuth2ParameterNames.SCOPE); | ||
| } | ||
|
|
||
| if (this.logger.isTraceEnabled()) { | ||
| this.logger.trace("Validated device authorization consent request parameters"); | ||
| } | ||
|
|
||
| OAuth2AuthorizationConsent currentAuthorizationConsent = this.authorizationConsentService.findById( | ||
| authorization.getRegisteredClientId(), principal.getName()); | ||
| Set<String> currentAuthorizedScopes = currentAuthorizationConsent != null ? | ||
| currentAuthorizationConsent.getScopes() : Collections.emptySet(); | ||
|
|
||
| if (!currentAuthorizedScopes.isEmpty()) { | ||
| for (String requestedScope : requestedScopes) { | ||
| if (currentAuthorizedScopes.contains(requestedScope)) { | ||
| authorizedScopes.add(requestedScope); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| OAuth2AuthorizationConsent.Builder authorizationConsentBuilder; | ||
| if (currentAuthorizationConsent != null) { | ||
| if (this.logger.isTraceEnabled()) { | ||
| this.logger.trace("Retrieved existing authorization consent"); | ||
| } | ||
| authorizationConsentBuilder = OAuth2AuthorizationConsent.from(currentAuthorizationConsent); | ||
| } else { | ||
| authorizationConsentBuilder = OAuth2AuthorizationConsent.withId( | ||
| authorization.getRegisteredClientId(), principal.getName()); | ||
| } | ||
| authorizedScopes.forEach(authorizationConsentBuilder::scope); | ||
|
|
||
| if (this.authorizationConsentCustomizer != null) { | ||
| // @formatter:off | ||
| OAuth2AuthorizationConsentAuthenticationContext authorizationConsentAuthenticationContext = | ||
| OAuth2AuthorizationConsentAuthenticationContext.with(deviceAuthorizationConsentAuthentication) | ||
| .authorizationConsent(authorizationConsentBuilder) | ||
| .registeredClient(registeredClient) | ||
| .authorization(authorization) | ||
| .authorizationRequest(authorizationRequest) | ||
| .build(); | ||
| // @formatter:on | ||
| this.authorizationConsentCustomizer.accept(authorizationConsentAuthenticationContext); | ||
| if (this.logger.isTraceEnabled()) { | ||
| this.logger.trace("Customized authorization consent"); | ||
| } | ||
| } | ||
|
|
||
| Set<GrantedAuthority> authorities = new HashSet<>(); | ||
| authorizationConsentBuilder.authorities(authorities::addAll); | ||
|
|
||
| OAuth2Authorization.Token<OAuth2DeviceCode> deviceCodeToken = authorization.getToken(OAuth2DeviceCode.class); | ||
| OAuth2Authorization.Token<OAuth2UserCode> userCodeToken = authorization.getToken(OAuth2UserCode.class); | ||
|
|
||
| if (authorities.isEmpty()) { | ||
| // Authorization consent denied (or revoked) | ||
| if (currentAuthorizationConsent != null) { | ||
| this.authorizationConsentService.remove(currentAuthorizationConsent); | ||
| if (this.logger.isTraceEnabled()) { | ||
| this.logger.trace("Revoked authorization consent"); | ||
| } | ||
| } | ||
| authorization = OAuth2Authorization.from(authorization) | ||
| .token(deviceCodeToken.getToken(), metadata -> | ||
| metadata.put(OAuth2Authorization.Token.ACCESS_DENIED_METADATA_NAME, true)) | ||
| .token(userCodeToken.getToken(), metadata -> | ||
| metadata.put(OAuth2Authorization.Token.INVALIDATED_METADATA_NAME, true)) | ||
| .build(); | ||
| this.authorizationService.save(authorization); | ||
| if (this.logger.isTraceEnabled()) { | ||
| this.logger.trace("Invalidated device code and user code because authorization consent was denied"); | ||
| } | ||
| throw new OAuth2AuthenticationException(OAuth2ErrorCodes.ACCESS_DENIED); | ||
| } | ||
|
|
||
| OAuth2AuthorizationConsent authorizationConsent = authorizationConsentBuilder.build(); | ||
| if (!authorizationConsent.equals(currentAuthorizationConsent)) { | ||
| this.authorizationConsentService.save(authorizationConsent); | ||
| if (this.logger.isTraceEnabled()) { | ||
| this.logger.trace("Saved authorization consent"); | ||
| } | ||
| } | ||
|
|
||
| OAuth2Authorization updatedAuthorization = OAuth2Authorization.from(authorization) | ||
| .principalName(principal.getName()) | ||
| .authorizedScopes(authorizedScopes) | ||
| .token(deviceCodeToken.getToken(), metadata -> metadata | ||
| .put(OAuth2Authorization.Token.ACCESS_GRANTED_METADATA_NAME, true)) | ||
| .token(userCodeToken.getToken(), metadata -> metadata | ||
| .put(OAuth2Authorization.Token.INVALIDATED_METADATA_NAME, true)) | ||
| .attribute(Principal.class.getName(), principal) | ||
| .attributes(attrs -> attrs.remove(OAuth2ParameterNames.STATE)) | ||
| .build(); | ||
| this.authorizationService.save(updatedAuthorization); | ||
|
|
||
| if (this.logger.isTraceEnabled()) { | ||
| this.logger.trace("Saved authorization with authorized scopes"); | ||
| // This log is kept separate for consistency with other providers | ||
| this.logger.trace("Authenticated authorization consent request"); | ||
| } | ||
|
|
||
| return new OAuth2DeviceVerificationAuthenticationToken(registeredClient.getClientId(), principal, | ||
| deviceAuthorizationConsentAuthentication.getUserCode()); | ||
| } | ||
|
|
||
| @Override | ||
| public boolean supports(Class<?> authentication) { | ||
| return OAuth2DeviceAuthorizationConsentAuthenticationToken.class.isAssignableFrom(authentication); | ||
| } | ||
|
|
||
| /** | ||
| * Sets the {@code Consumer} providing access to the {@link OAuth2AuthorizationConsentAuthenticationContext} | ||
| * containing an {@link OAuth2AuthorizationConsent.Builder} and additional context information. | ||
| * | ||
| * <p> | ||
| * The following context attributes are available: | ||
| * <ul> | ||
| * <li>The {@link OAuth2AuthorizationConsent.Builder} used to build the authorization consent | ||
| * prior to {@link OAuth2AuthorizationConsentService#save(OAuth2AuthorizationConsent)}.</li> | ||
| * <li>The {@link Authentication} of type | ||
| * {@link OAuth2DeviceAuthorizationConsentAuthenticationToken}.</li> | ||
| * <li>The {@link RegisteredClient} associated with the authorization request.</li> | ||
| * <li>The {@link OAuth2Authorization} associated with the state token presented in the | ||
| * authorization consent request.</li> | ||
| * <li>The {@link OAuth2AuthorizationRequest} associated with the authorization consent request.</li> | ||
| * </ul> | ||
| * | ||
| * @param authorizationConsentCustomizer the {@code Consumer} providing access to the | ||
| * {@link OAuth2AuthorizationConsentAuthenticationContext} containing an {@link OAuth2AuthorizationConsent.Builder} | ||
| */ | ||
| public void setAuthorizationConsentCustomizer(Consumer<OAuth2AuthorizationConsentAuthenticationContext> authorizationConsentCustomizer) { | ||
| Assert.notNull(authorizationConsentCustomizer, "authorizationConsentCustomizer cannot be null"); | ||
| this.authorizationConsentCustomizer = authorizationConsentCustomizer; | ||
| } | ||
|
|
||
| private static void throwError(String errorCode, String parameterName) { | ||
| OAuth2Error error = new OAuth2Error(errorCode, "OAuth 2.0 Parameter: " + parameterName, DEFAULT_ERROR_URI); | ||
| throw new OAuth2AuthorizationException(error); | ||
| } | ||
|
|
||
| } |
Oops, something went wrong.