Azure: Support vended credentials refresh in ADLSFileIO. #11577
There are no files selected for viewing
This file contains hidden or 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 hidden or 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 hidden or 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,160 @@ | ||
| /* | ||
| * 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.iceberg.azure.adlsv2; | ||
|
|
||
| import com.azure.core.credential.AccessToken; | ||
| import com.azure.core.credential.SimpleTokenCache; | ||
| import java.io.IOException; | ||
| import java.io.Serializable; | ||
| import java.io.UncheckedIOException; | ||
| import java.time.Instant; | ||
| import java.time.ZoneOffset; | ||
| import java.util.List; | ||
| import java.util.Map; | ||
| import java.util.stream.Collectors; | ||
| import org.apache.iceberg.azure.AzureProperties; | ||
| import org.apache.iceberg.io.CloseableGroup; | ||
| import org.apache.iceberg.relocated.com.google.common.base.Preconditions; | ||
| import org.apache.iceberg.relocated.com.google.common.collect.Maps; | ||
| import org.apache.iceberg.rest.ErrorHandlers; | ||
| import org.apache.iceberg.rest.HTTPClient; | ||
| import org.apache.iceberg.rest.RESTClient; | ||
| import org.apache.iceberg.rest.auth.AuthManager; | ||
| import org.apache.iceberg.rest.auth.AuthManagers; | ||
| import org.apache.iceberg.rest.auth.AuthSession; | ||
| import org.apache.iceberg.rest.credentials.Credential; | ||
| import org.apache.iceberg.rest.responses.LoadCredentialsResponse; | ||
| import org.apache.iceberg.util.SerializableMap; | ||
| import reactor.core.publisher.Mono; | ||
|
|
||
| public class VendedAdlsCredentialProvider implements Serializable, AutoCloseable { | ||
|
ChaladiMohanVamsi marked this conversation as resolved.
ChaladiMohanVamsi marked this conversation as resolved.
|
||
|
|
||
| public static final String URI = "credentials.uri"; | ||
|
|
||
| private final SerializableMap<String, String> properties; | ||
| private transient volatile Map<String, SimpleTokenCache> sasCredentialByAccount; | ||
| private transient volatile HTTPClient client; | ||
| private transient AuthManager authManager; | ||
| private transient AuthSession authSession; | ||
|
|
||
| public VendedAdlsCredentialProvider(Map<String, String> properties) { | ||
| Preconditions.checkArgument(null != properties, "Invalid properties: null"); | ||
| Preconditions.checkArgument(null != properties.get(URI), "Invalid URI: null"); | ||
|
Contributor
There was a problem hiding this comment. can you please apply the below diff to this class? This is fixing an issue that we're currently also fixing for S3 / GCP in #12612 / #12638. You will also have to update the tests in a similar way as in those PRs
Contributor
Author
There was a problem hiding this comment. Applied the patch and associated test cases. |
||
| this.properties = SerializableMap.copyOf(properties); | ||
| } | ||
|
|
||
| String credentialForAccount(String storageAccount) { | ||
| return sasCredentialByAccount() | ||
| .computeIfAbsent( | ||
| storageAccount, | ||
| ignored -> | ||
| new SimpleTokenCache( | ||
| () -> Mono.fromSupplier(() -> sasTokenForAccount(storageAccount)))) | ||
| .getToken() | ||
| .map(AccessToken::getToken) | ||
| .block(); | ||
| } | ||
|
|
||
| private AccessToken sasTokenForAccount(String storageAccount) { | ||
| LoadCredentialsResponse response = fetchCredentials(); | ||
| List<Credential> adlsCredentials = | ||
| response.credentials().stream() | ||
| .filter(c -> c.prefix().contains(storageAccount)) | ||
| .collect(Collectors.toList()); | ||
| Preconditions.checkState( | ||
| !adlsCredentials.isEmpty(), | ||
| String.format("Invalid ADLS Credentials for storage-account %s: empty", storageAccount)); | ||
| Preconditions.checkState( | ||
| adlsCredentials.size() == 1, | ||
| "Invalid ADLS Credentials: only one ADLS credential should exist per storage-account"); | ||
|
|
||
| Credential adlsCredential = adlsCredentials.get(0); | ||
| checkCredential(adlsCredential, AzureProperties.ADLS_SAS_TOKEN_PREFIX + storageAccount); | ||
| checkCredential( | ||
| adlsCredential, AzureProperties.ADLS_SAS_TOKEN_EXPIRES_AT_MS_PREFIX + storageAccount); | ||
|
|
||
| String sasToken = | ||
| adlsCredential.config().get(AzureProperties.ADLS_SAS_TOKEN_PREFIX + storageAccount); | ||
| Instant tokenExpiresAt = | ||
| Instant.ofEpochMilli( | ||
| Long.parseLong( | ||
| adlsCredential | ||
| .config() | ||
| .get(AzureProperties.ADLS_SAS_TOKEN_EXPIRES_AT_MS_PREFIX + storageAccount))); | ||
|
|
||
| return new AccessToken(sasToken, tokenExpiresAt.atOffset(ZoneOffset.UTC)); | ||
| } | ||
|
|
||
| private Map<String, SimpleTokenCache> sasCredentialByAccount() { | ||
|
nastra marked this conversation as resolved.
|
||
| if (this.sasCredentialByAccount == null) { | ||
| synchronized (this) { | ||
| if (this.sasCredentialByAccount == null) { | ||
| this.sasCredentialByAccount = Maps.newHashMap(); | ||
| } | ||
| } | ||
| } | ||
| return this.sasCredentialByAccount; | ||
| } | ||
|
|
||
| private RESTClient httpClient() { | ||
|
ChaladiMohanVamsi marked this conversation as resolved.
|
||
| if (null == client) { | ||
| synchronized (this) { | ||
| if (null == client) { | ||
| authManager = AuthManagers.loadAuthManager("adls-credentials-refresh", properties); | ||
| HTTPClient httpClient = HTTPClient.builder(properties).uri(properties.get(URI)).build(); | ||
| authSession = authManager.catalogSession(httpClient, properties); | ||
| client = httpClient.withAuthSession(authSession); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| return client; | ||
| } | ||
|
|
||
| private LoadCredentialsResponse fetchCredentials() { | ||
| return httpClient() | ||
|
nastra marked this conversation as resolved.
|
||
| .get( | ||
| properties.get(URI), | ||
| null, | ||
| LoadCredentialsResponse.class, | ||
| Map.of(), | ||
| ErrorHandlers.defaultErrorHandler()); | ||
| } | ||
|
|
||
| private void checkCredential(Credential credential, String property) { | ||
| Preconditions.checkState( | ||
| credential.config().containsKey(property), | ||
| "Invalid ADLS Credentials: %s not set", | ||
| property); | ||
| } | ||
|
|
||
| @Override | ||
| public void close() { | ||
| CloseableGroup closeableGroup = new CloseableGroup(); | ||
| closeableGroup.addCloseable(authSession); | ||
| closeableGroup.addCloseable(authManager); | ||
| closeableGroup.addCloseable(client); | ||
| closeableGroup.setSuppressCloseFailure(true); | ||
| try { | ||
| closeableGroup.close(); | ||
| } catch (IOException e) { | ||
| throw new UncheckedIOException("Failed to close the VendedAdlsCredentialProvider", e); | ||
| } | ||
| } | ||
| } | ||
This file contains hidden or 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,66 @@ | ||
| /* | ||
| * 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.iceberg.azure.adlsv2; | ||
|
|
||
| import com.azure.core.credential.AzureSasCredential; | ||
| import com.azure.core.http.HttpPipelineCallContext; | ||
| import com.azure.core.http.HttpPipelineNextPolicy; | ||
| import com.azure.core.http.HttpPipelineNextSyncPolicy; | ||
| import com.azure.core.http.HttpResponse; | ||
| import com.azure.core.http.policy.AzureSasCredentialPolicy; | ||
| import com.azure.core.http.policy.HttpPipelinePolicy; | ||
| import reactor.core.publisher.Mono; | ||
|
|
||
| public class VendedAzureSasCredentialPolicy implements HttpPipelinePolicy { | ||
|
Contributor
There was a problem hiding this comment. I believe we should be able to make this non-public
Contributor
Author
There was a problem hiding this comment. updated it to non-public. |
||
| private final String account; | ||
| private final VendedAdlsCredentialProvider vendedAdlsCredentialProvider; | ||
| private AzureSasCredential azureSasCredential; | ||
| private AzureSasCredentialPolicy azureSasCredentialPolicy; | ||
|
|
||
| public VendedAzureSasCredentialPolicy( | ||
| String account, VendedAdlsCredentialProvider vendedAdlsCredentialProvider) { | ||
| this.account = account; | ||
| this.vendedAdlsCredentialProvider = vendedAdlsCredentialProvider; | ||
| } | ||
|
|
||
| @Override | ||
| public Mono<HttpResponse> process( | ||
| HttpPipelineCallContext httpPipelineCallContext, | ||
| HttpPipelineNextPolicy httpPipelineNextPolicy) { | ||
| maybeUpdateCredential(); | ||
| return azureSasCredentialPolicy.process(httpPipelineCallContext, httpPipelineNextPolicy); | ||
| } | ||
|
|
||
| @Override | ||
| public HttpResponse processSync( | ||
| HttpPipelineCallContext context, HttpPipelineNextSyncPolicy next) { | ||
| maybeUpdateCredential(); | ||
| return azureSasCredentialPolicy.processSync(context, next); | ||
| } | ||
|
|
||
| private void maybeUpdateCredential() { | ||
| String sasToken = vendedAdlsCredentialProvider.credentialForAccount(account); | ||
| if (azureSasCredential == null) { | ||
| this.azureSasCredential = new AzureSasCredential(sasToken); | ||
| this.azureSasCredentialPolicy = new AzureSasCredentialPolicy(azureSasCredential, false); | ||
| } else { | ||
| azureSasCredential.update(sasToken); | ||
| } | ||
| } | ||
| } | ||
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.
Uh oh!
There was an error while loading. Please reload this page.