Add SAS Token Authentication Support to Azure Repo Plugin #42982
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
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 |
|---|---|---|
|
|
@@ -21,6 +21,7 @@ | |
|
|
||
| import com.microsoft.azure.storage.LocationMode; | ||
| import com.microsoft.azure.storage.RetryPolicy; | ||
| import org.elasticsearch.common.Nullable; | ||
| import org.elasticsearch.common.Strings; | ||
| import org.elasticsearch.common.settings.SecureSetting; | ||
| import org.elasticsearch.common.settings.SecureString; | ||
|
|
@@ -53,6 +54,10 @@ final class AzureStorageSettings { | |
| public static final AffixSetting<SecureString> KEY_SETTING = Setting.affixKeySetting(AZURE_CLIENT_PREFIX_KEY, "key", | ||
| key -> SecureSetting.secureString(key, null)); | ||
|
|
||
| /** Azure SAS token */ | ||
| public static final AffixSetting<SecureString> SAS_TOKEN_SETTING = Setting.affixKeySetting(AZURE_CLIENT_PREFIX_KEY, "sas_token", | ||
|
There was a problem hiding this comment. can you add docs for the new setting as well? There was a problem hiding this comment. Done in b7045d0 :) |
||
| key -> SecureSetting.secureString(key, null)); | ||
|
|
||
| /** max_retries: Number of retries in case of Azure errors. Defaults to 3 (RetryPolicy.DEFAULT_CLIENT_RETRY_COUNT). */ | ||
| public static final Setting<Integer> MAX_RETRIES_SETTING = | ||
| Setting.affixKeySetting(AZURE_CLIENT_PREFIX_KEY, "max_retries", | ||
|
|
@@ -82,29 +87,29 @@ final class AzureStorageSettings { | |
| PROXY_HOST_SETTING); | ||
|
|
||
| private final String account; | ||
| private final String connectString; | ||
| private final String endpointSuffix; | ||
| private final TimeValue timeout; | ||
| private final int maxRetries; | ||
| private final Proxy proxy; | ||
| private final LocationMode locationMode; | ||
|
|
||
| // copy-constructor | ||
| private AzureStorageSettings(String account, String connectString, String endpointSuffix, TimeValue timeout, int maxRetries, | ||
| Proxy proxy, LocationMode locationMode) { | ||
| this.account = account; | ||
| this.connectString = connectString; | ||
| this.endpointSuffix = endpointSuffix; | ||
| this.timeout = timeout; | ||
| this.maxRetries = maxRetries; | ||
| this.proxy = proxy; | ||
| this.locationMode = locationMode; | ||
| } | ||
|
|
||
| private AzureStorageSettings(String account, String key, String sasToken, String endpointSuffix, TimeValue timeout, int maxRetries, | ||
| Proxy.Type proxyType, String proxyHost, Integer proxyPort) { | ||
| this.account = account; | ||
| this.connectString = buildConnectString(account, key, sasToken, endpointSuffix); | ||
| this.endpointSuffix = endpointSuffix; | ||
| this.timeout = timeout; | ||
| this.maxRetries = maxRetries; | ||
|
|
@@ -145,13 +150,26 @@ public Proxy getProxy() { | |
| return proxy; | ||
| } | ||
|
|
||
| public String getConnectString() { | ||
| return connectString; | ||
| } | ||
|
|
||
| private static String buildConnectString(String account, @Nullable String key, @Nullable String sasToken, String endpointSuffix) { | ||
| final boolean hasSasToken = Strings.hasText(sasToken); | ||
| final boolean hasKey = Strings.hasText(key); | ||
| if (hasSasToken == false && hasKey == false) { | ||
| throw new SettingsException("Neither a secret key nor a shared access token was set."); | ||
| } | ||
| if (hasSasToken && hasKey) { | ||
| throw new SettingsException("Both a secret as well as a shared access token were set."); | ||
| } | ||
| final StringBuilder connectionStringBuilder = new StringBuilder(); | ||
| connectionStringBuilder.append("DefaultEndpointsProtocol=https").append(";AccountName=").append(account); | ||
| if (hasKey) { | ||
| connectionStringBuilder.append(";AccountKey=").append(key); | ||
| } else { | ||
| connectionStringBuilder.append(";SharedAccessSignature=").append(sasToken); | ||
| } | ||
| if (Strings.hasText(endpointSuffix)) { | ||
| connectionStringBuilder.append(";EndpointSuffix=").append(endpointSuffix); | ||
| } | ||
|
|
@@ -166,7 +184,6 @@ public LocationMode getLocationMode() { | |
| public String toString() { | ||
| final StringBuilder sb = new StringBuilder("AzureStorageSettings{"); | ||
| sb.append("account='").append(account).append('\''); | ||
|
There was a problem hiding this comment. add connectString instead here? There was a problem hiding this comment. @ywelsch this was actually an on purpose removal, do we really want to add secure credentials in There was a problem hiding this comment. I think it's better to remove the There was a problem hiding this comment. Unfortunately, for that we'd have to keep some field that holds this information. Maybe not worth it? |
||
| sb.append(", timeout=").append(timeout); | ||
| sb.append(", endpointSuffix='").append(endpointSuffix).append('\''); | ||
| sb.append(", maxRetries=").append(maxRetries); | ||
|
|
@@ -201,8 +218,9 @@ public static Map<String, AzureStorageSettings> load(Settings settings) { | |
| /** Parse settings for a single client. */ | ||
| private static AzureStorageSettings getClientSettings(Settings settings, String clientName) { | ||
| try (SecureString account = getConfigValue(settings, clientName, ACCOUNT_SETTING); | ||
| SecureString key = getConfigValue(settings, clientName, KEY_SETTING); | ||
| SecureString sasToken = getConfigValue(settings, clientName, SAS_TOKEN_SETTING)) { | ||
| return new AzureStorageSettings(account.toString(), key.toString(), sasToken.toString(), | ||
| getValue(settings, clientName, ENDPOINT_SUFFIX_SETTING), | ||
| getValue(settings, clientName, TIMEOUT_SETTING), | ||
| getValue(settings, clientName, MAX_RETRIES_SETTING), | ||
|
|
@@ -228,10 +246,9 @@ static Map<String, AzureStorageSettings> overrideLocationMode(Map<String, AzureS | |
| LocationMode locationMode) { | ||
| final var map = new HashMap<String, AzureStorageSettings>(); | ||
| for (final Map.Entry<String, AzureStorageSettings> entry : clientsSettings.entrySet()) { | ||
| map.put(entry.getKey(), | ||
| new AzureStorageSettings(entry.getValue().account, entry.getValue().connectString, entry.getValue().endpointSuffix, | ||
| entry.getValue().timeout, entry.getValue().maxRetries, entry.getValue().proxy, locationMode)); | ||
| } | ||
| return Map.copyOf(map); | ||
| } | ||
|
|
||
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
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.
I think we should say a word about the type of SAS token and the required permissions
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.
I think the type doesn't matter just the permissions (service as well as accounts SAS should work)? I added a comment on the permissions now :)
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.
Talked to Armin using another channel. I'd expect to see some
createorlistpermissions too hereThere 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.
Alright, updated this with all the details now.
createwe don't need since it's implied bywritefor the operations we execute https://docs.microsoft.com/en-us/rest/api/storageservices/Constructing-an-Account-SAS?redirectedfrom=MSDN#blob-service (as a matter of fact it is for all operations on the blob service). But we neededlist.Also, I added some detail on the service and resource type the token has to apply to.