HADOOP-18610. ABFS OAuth2 Token Provider support for Azure Workload Identity #5953
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,150 @@ | ||
| /** | ||
| * Licensed to the Apache Software Foundation (ASF) under one | ||
| * or more contributor license agreements. See the NOTICE file | ||
| * distributed with this work for additional information | ||
| * regarding copyright ownership. The ASF licenses this file | ||
| * to you 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 | ||
| * | ||
| * http://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.apache.hadoop.fs.azurebfs.oauth2; | ||
|
|
||
| import java.io.File; | ||
| import java.io.IOException; | ||
|
|
||
| import org.apache.hadoop.classification.VisibleForTesting; | ||
| import org.apache.hadoop.thirdparty.com.google.common.base.Strings; | ||
| import org.apache.hadoop.util.Preconditions; | ||
| import org.slf4j.Logger; | ||
| import org.slf4j.LoggerFactory; | ||
|
|
||
| import org.apache.commons.io.FileUtils; | ||
|
|
||
|
|
||
| /** | ||
| * Provides tokens based on Azure AD Workload Identity. | ||
| */ | ||
| public class WorkloadIdentityTokenProvider extends AccessTokenProvider { | ||
|
There was a problem hiding this comment. We can add tests around this class. Following is something around which we can write tests which can help prevent regressions in future:
There was a problem hiding this comment. Thank you for the guidance. I implemented several unit tests. There was a problem hiding this comment. I see, we have added tests around
There was a problem hiding this comment. I understand the request, but I don't see a reasonable way to mock the code for a unit test of
Without a way to mock the calls made by Do you have any ideas on how to work around the limitations of the code to implement the desired unit test? There was a problem hiding this comment. Yes, we dont need to mock the static method. What can be done is: There was a problem hiding this comment. Thank you for the help. I added more unit tests per your instructions. |
||
|
|
||
| private static final String OAUTH2_TOKEN_PATH = "/oauth2/v2.0/token"; | ||
| private final String authEndpoint; | ||
|
|
||
| private final String clientId; | ||
|
|
||
| private final String tokenFile; | ||
|
|
||
| private long tokenFetchTime = -1; | ||
|
|
||
| private static final long ONE_HOUR = 3600 * 1000; | ||
|
|
||
| private static final Logger LOG = LoggerFactory.getLogger(AccessTokenProvider.class); | ||
|
|
||
| public WorkloadIdentityTokenProvider(final String authority, final String tenantId, | ||
| final String clientId, final String tokenFile) { | ||
| Preconditions.checkNotNull(authority, "authority"); | ||
| Preconditions.checkNotNull(tenantId, "tenantId"); | ||
| Preconditions.checkNotNull(clientId, "clientId"); | ||
| Preconditions.checkNotNull(tokenFile, "tokenFile"); | ||
|
|
||
| this.authEndpoint = authority + tenantId + OAUTH2_TOKEN_PATH; | ||
| this.clientId = clientId; | ||
| this.tokenFile = tokenFile; | ||
| } | ||
|
|
||
| @Override | ||
| protected AzureADToken refreshToken() throws IOException { | ||
| LOG.debug("AADToken: refreshing token from JWT Assertion"); | ||
| String clientAssertion = getClientAssertion(); | ||
| AzureADToken token = getTokenUsingJWTAssertion(clientAssertion); | ||
| tokenFetchTime = System.currentTimeMillis(); | ||
| return token; | ||
| } | ||
|
|
||
| /** | ||
| * Gets the Azure AD token from a client assertion in JWT format. | ||
| * This method exists to make unit testing possible. | ||
| * | ||
| * @param clientAssertion the client assertion. | ||
| * @return the Azure AD token. | ||
| * @throws IOException if there is a failure in connecting to Azure AD. | ||
| */ | ||
| @VisibleForTesting | ||
| AzureADToken getTokenUsingJWTAssertion(String clientAssertion) throws IOException { | ||
| return AzureADAuthenticator | ||
| .getTokenUsingJWTAssertion(authEndpoint, clientId, clientAssertion); | ||
| } | ||
|
|
||
| /** | ||
| * Checks if the token is about to expire as per base expiry logic. | ||
| * Otherwise try to expire if enough time has elapsed since the last refresh. | ||
| * | ||
| * @return true if the token is expiring in next 1 hour or if a token has | ||
| * never been fetched | ||
| */ | ||
| @Override | ||
| protected boolean isTokenAboutToExpire() { | ||
| return super.isTokenAboutToExpire() || hasEnoughTimeElapsedSinceLastRefresh(); | ||
| } | ||
|
|
||
| /** | ||
| * Checks to see if enough time has elapsed since the last token refresh. | ||
| * | ||
| * @return true if the token was last refreshed more than an hour ago. | ||
| */ | ||
| protected boolean hasEnoughTimeElapsedSinceLastRefresh() { | ||
| if (getTokenFetchTime() == -1) { | ||
| return true; | ||
| } | ||
| boolean expiring = false; | ||
| long elapsedTimeSinceLastTokenRefreshInMillis = | ||
| System.currentTimeMillis() - getTokenFetchTime(); | ||
| // In case token is not refreshed for 1 hr or any clock skew issues, | ||
| // refresh token. | ||
| expiring = elapsedTimeSinceLastTokenRefreshInMillis >= ONE_HOUR | ||
| || elapsedTimeSinceLastTokenRefreshInMillis < 0; | ||
| if (expiring) { | ||
| LOG.debug("JWTToken: token renewing. Time elapsed since last token fetch:" | ||
| + " {} milliseconds", elapsedTimeSinceLastTokenRefreshInMillis); | ||
| } | ||
| return expiring; | ||
| } | ||
|
|
||
| /** | ||
| * Gets the client assertion from the token file. The token in the file | ||
| * is automatically refreshed by Azure at least once every 24 hours. | ||
| * See <a href="https://azure.github.io/azure-workload-identity/docs/faq.html#does-workload-identity-work-in-disconnected-environments"> | ||
| * Azure Workload Identity FAQ</a>. | ||
| * | ||
| * @return the client assertion. | ||
| * @throws IOException if the token file is empty. | ||
| */ | ||
| private String getClientAssertion() | ||
| throws IOException { | ||
| File file = new File(tokenFile); | ||
| String clientAssertion = FileUtils.readFileToString(file, "UTF-8"); | ||
| if (Strings.isNullOrEmpty(clientAssertion)) { | ||
| throw new IOException("Empty token file."); | ||
| } | ||
| return clientAssertion; | ||
| } | ||
|
|
||
| /** | ||
| * Returns the last time the token was fetched from the token file. | ||
| * This method exists to make unit testing possible. | ||
| * | ||
| * @return the time the token was last fetched. | ||
| */ | ||
| @VisibleForTesting | ||
| long getTokenFetchTime() { | ||
| return tokenFetchTime; | ||
| } | ||
| } | ||
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.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
always good to trim this so if someone splits a value with newlines it is trimmed properly