-
Notifications
You must be signed in to change notification settings - Fork 5.9k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add support BearerTokenAuthenticationConverter
Closes gh-14750
- Loading branch information
Max Batischev
authored and
Max Batischev
committed
Apr 7, 2024
1 parent
c8e5fbf
commit e91cbc1
Showing
6 changed files
with
457 additions
and
5 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
180 changes: 180 additions & 0 deletions
180
...rk/security/oauth2/server/resource/authentication/BearerTokenAuthenticationConverter.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,180 @@ | ||
| /* | ||
| * Copyright 2002-2024 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.resource.authentication; | ||
|
|
||
| import java.util.regex.Matcher; | ||
| import java.util.regex.Pattern; | ||
|
|
||
| import jakarta.servlet.http.HttpServletRequest; | ||
|
|
||
| import org.springframework.http.HttpHeaders; | ||
| import org.springframework.http.HttpMethod; | ||
| import org.springframework.http.MediaType; | ||
| import org.springframework.security.authentication.AuthenticationDetailsSource; | ||
| import org.springframework.security.core.Authentication; | ||
| import org.springframework.security.oauth2.core.OAuth2AuthenticationException; | ||
| import org.springframework.security.oauth2.server.resource.BearerTokenError; | ||
| import org.springframework.security.oauth2.server.resource.BearerTokenErrors; | ||
| import org.springframework.security.web.authentication.AuthenticationConverter; | ||
| import org.springframework.security.web.authentication.WebAuthenticationDetailsSource; | ||
| import org.springframework.util.Assert; | ||
| import org.springframework.util.StringUtils; | ||
|
|
||
| /** | ||
| * Implementation of {@link AuthenticationConverter}, that converts bearer token to | ||
| * {@link BearerTokenAuthenticationToken} | ||
| * | ||
| * @author Max Batischev | ||
| * @since 6.3 | ||
| */ | ||
| public final class BearerTokenAuthenticationConverter implements AuthenticationConverter { | ||
|
|
||
| private AuthenticationDetailsSource<HttpServletRequest, ?> authenticationDetailsSource = new WebAuthenticationDetailsSource(); | ||
|
|
||
| private static final Pattern authorizationPattern = Pattern.compile("^Bearer (?<token>[a-zA-Z0-9-._~+/]+=*)$", | ||
| Pattern.CASE_INSENSITIVE); | ||
|
|
||
| private static final String ACCESS_TOKEN_PARAMETER_NAME = "access_token"; | ||
|
|
||
| private boolean allowFormEncodedBodyParameter = false; | ||
|
|
||
| private boolean allowUriQueryParameter = false; | ||
|
|
||
| private String bearerTokenHeaderName = HttpHeaders.AUTHORIZATION; | ||
|
|
||
| @Override | ||
| public Authentication convert(HttpServletRequest request) { | ||
| String token = token(request); | ||
| if (StringUtils.hasText(token)) { | ||
| BearerTokenAuthenticationToken authenticationToken = new BearerTokenAuthenticationToken(token); | ||
| authenticationToken.setDetails(this.authenticationDetailsSource.buildDetails(request)); | ||
|
|
||
| return authenticationToken; | ||
| } | ||
| return null; | ||
| } | ||
|
|
||
| private String token(HttpServletRequest request) { | ||
| final String authorizationHeaderToken = resolveFromAuthorizationHeader(request); | ||
| final String parameterToken = isParameterTokenSupportedForRequest(request) | ||
| ? resolveFromRequestParameters(request) : null; | ||
| if (authorizationHeaderToken != null) { | ||
| if (parameterToken != null) { | ||
| final BearerTokenError error = BearerTokenErrors | ||
| .invalidRequest("Found multiple bearer tokens in the request"); | ||
| throw new OAuth2AuthenticationException(error); | ||
| } | ||
| return authorizationHeaderToken; | ||
| } | ||
| if (parameterToken != null && isParameterTokenEnabledForRequest(request)) { | ||
| return parameterToken; | ||
| } | ||
| return null; | ||
| } | ||
|
|
||
| private String resolveFromAuthorizationHeader(HttpServletRequest request) { | ||
| String authorization = request.getHeader(this.bearerTokenHeaderName); | ||
| if (!StringUtils.startsWithIgnoreCase(authorization, "bearer")) { | ||
| return null; | ||
| } | ||
| Matcher matcher = authorizationPattern.matcher(authorization); | ||
| if (!matcher.matches()) { | ||
| BearerTokenError error = BearerTokenErrors.invalidToken("Bearer token is malformed"); | ||
| throw new OAuth2AuthenticationException(error); | ||
| } | ||
| return matcher.group("token"); | ||
| } | ||
|
|
||
| private boolean isParameterTokenEnabledForRequest(HttpServletRequest request) { | ||
| return ((this.allowFormEncodedBodyParameter && isFormEncodedRequest(request) && !isGetRequest(request) | ||
| && !hasAccessTokenInQueryString(request)) || (this.allowUriQueryParameter && isGetRequest(request))); | ||
| } | ||
|
|
||
| private static String resolveFromRequestParameters(HttpServletRequest request) { | ||
| String[] values = request.getParameterValues(ACCESS_TOKEN_PARAMETER_NAME); | ||
| if (values == null || values.length == 0) { | ||
| return null; | ||
| } | ||
| if (values.length == 1) { | ||
| return values[0]; | ||
| } | ||
| BearerTokenError error = BearerTokenErrors.invalidRequest("Found multiple bearer tokens in the request"); | ||
| throw new OAuth2AuthenticationException(error); | ||
| } | ||
|
|
||
| private boolean isParameterTokenSupportedForRequest(final HttpServletRequest request) { | ||
| return isFormEncodedRequest(request) || isGetRequest(request); | ||
| } | ||
|
|
||
| private boolean isGetRequest(HttpServletRequest request) { | ||
| return HttpMethod.GET.name().equals(request.getMethod()); | ||
| } | ||
|
|
||
| private boolean isFormEncodedRequest(HttpServletRequest request) { | ||
| return MediaType.APPLICATION_FORM_URLENCODED_VALUE.equals(request.getContentType()); | ||
| } | ||
|
|
||
| private static boolean hasAccessTokenInQueryString(HttpServletRequest request) { | ||
| return (request.getQueryString() != null) && request.getQueryString().contains(ACCESS_TOKEN_PARAMETER_NAME); | ||
| } | ||
|
|
||
| /** | ||
| * Set if transport of access token using URI query parameter is supported. Defaults | ||
| * to {@code false}. | ||
| * | ||
| * The spec recommends against using this mechanism for sending bearer tokens, and | ||
| * even goes as far as stating that it was only included for completeness. | ||
| * @param allowUriQueryParameter if the URI query parameter is supported | ||
| */ | ||
| public void setAllowUriQueryParameter(boolean allowUriQueryParameter) { | ||
| this.allowUriQueryParameter = allowUriQueryParameter; | ||
| } | ||
|
|
||
| /** | ||
| * Set this value to configure what header is checked when resolving a Bearer Token. | ||
| * This value is defaulted to {@link HttpHeaders#AUTHORIZATION}. | ||
| * | ||
| * This allows other headers to be used as the Bearer Token source such as | ||
| * {@link HttpHeaders#PROXY_AUTHORIZATION} | ||
| * @param bearerTokenHeaderName the header to check when retrieving the Bearer Token. | ||
| */ | ||
| public void setBearerTokenHeaderName(String bearerTokenHeaderName) { | ||
| this.bearerTokenHeaderName = bearerTokenHeaderName; | ||
| } | ||
|
|
||
| /** | ||
| * Set if transport of access token using form-encoded body parameter is supported. | ||
| * Defaults to {@code false}. | ||
| * @param allowFormEncodedBodyParameter if the form-encoded body parameter is | ||
| * supported | ||
| */ | ||
| public void setAllowFormEncodedBodyParameter(boolean allowFormEncodedBodyParameter) { | ||
| this.allowFormEncodedBodyParameter = allowFormEncodedBodyParameter; | ||
| } | ||
|
|
||
| /** | ||
| * Set the {@link AuthenticationDetailsSource} to use. Defaults to | ||
| * {@link WebAuthenticationDetailsSource}. | ||
| * @param authenticationDetailsSource the {@code AuthenticationDetailsSource} to use | ||
| */ | ||
| public void setAuthenticationDetailsSource( | ||
| AuthenticationDetailsSource<HttpServletRequest, ?> authenticationDetailsSource) { | ||
| Assert.notNull(authenticationDetailsSource, "authenticationDetailsSource cannot be null"); | ||
| this.authenticationDetailsSource = authenticationDetailsSource; | ||
| } | ||
|
|
||
| } |
Oops, something went wrong.