Skip to content

Make Azure auth params match between Java and Python #631

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Aug 28, 2025
+50 −11
Merged

Make Azure auth params match between Java and Python #631

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cbd21f8
Make Azure storage auth params match between Java and Python
martin-traverse Aug 28, 2025
ed2d71f
Update auth mechanism comments for Azure storage
martin-traverse Aug 28, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 48 additions & 6 deletions ...azure-storage/src/main/java/org/finos/tracdap/plugins/azure/storage/AzureBlobStorage.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,14 +60,22 @@

public class AzureBlobStorage extends CommonFileStorage {

// Supported authentication mechanisms are "default" and "account_key" and "sas_token"
// The "default" mechanism will try environment, CLI, managed identity and workload identity

public static final String STORAGE_ACCOUNT_PROPERTY = "storageAccount";
public static final String CONTAINER_PROPERTY = "container";
public static final String PREFIX_PROPERTY = "prefix";

public static final String CREDENTIALS_PROPERTY = "credentials";
public static final String CREDENTIALS_DEFAULT = "default";
public static final String CREDENTIALS_ACCESS_KEY = "accessKey";
public static final String ACCESS_KEY_PROPERTY = "accessKey";
public static final String CREDENTIALS_ACCOUNT_KEY = "account_key";
public static final String CREDENTIALS_ACCESS_KEY = "access_key"; // synonym for backwards compatability
public static final String CREDENTIALS_SAS_TOKEN = "sas_token";

public static final String ACCOUNT_KEY_PROPERTY = "accountKey";
public static final String ACCESS_KEY_PROPERTY = "accessKey"; // synonym for backwards compatability
public static final String SAS_TOKEN_PROPERTY = "sasToken";

public static final String BLOB_ENDPOINT_TEMPLATE = "https://%s.blob.core.windows.net/";
public static final Duration STARTUP_TIMEOUT = Duration.of(1, ChronoUnit.MINUTES);
Expand Down Expand Up @@ -118,16 +126,50 @@ private CredentialsProvider prepareCredentials(Properties properties) {
return builder -> builder.credential(credentials);
}

if (CREDENTIALS_ACCESS_KEY.equalsIgnoreCase(mechanism)) {
if (CREDENTIALS_ACCOUNT_KEY.equalsIgnoreCase(mechanism) || CREDENTIALS_ACCESS_KEY.equalsIgnoreCase(mechanism)) {

if (CREDENTIALS_ACCESS_KEY.equalsIgnoreCase(mechanism)) {
log.warn("Credentials mechanism [{}] is non-standard ans has been deprecated, please use [{}] instead",
CREDENTIALS_ACCESS_KEY, CREDENTIALS_ACCOUNT_KEY);
}

log.info("Using [{}] credentials mechanism", CREDENTIALS_ACCESS_KEY);
log.info("Using [{}] credentials mechanism", CREDENTIALS_ACCOUNT_KEY);

var accessKey = properties.getProperty(ACCESS_KEY_PROPERTY);
var credentials = new StorageSharedKeyCredential(storageAccount, accessKey);
var accountKey = CREDENTIALS_ACCOUNT_KEY.equalsIgnoreCase(mechanism)
? properties.getProperty(ACCOUNT_KEY_PROPERTY)
: properties.getProperty(ACCESS_KEY_PROPERTY);

if (accountKey == null || accountKey.isEmpty()) {
var message = String.format("Missing required config property [%s] for Azure blob storage", ACCOUNT_KEY_PROPERTY);
log.error(message);
throw new EStartup(message);
}

var credentials = new StorageSharedKeyCredential(storageAccount, accountKey);

return builder -> builder.credential(credentials);
}

if (CREDENTIALS_SAS_TOKEN.equalsIgnoreCase(mechanism)) {

log.info("Using [{}] credentials mechanism", CREDENTIALS_SAS_TOKEN);

var rawSasToken = properties.getProperty(SAS_TOKEN_PROPERTY);

if (rawSasToken == null || rawSasToken.isEmpty()) {
var message = String.format("Missing required config property [%s] for Azure blob storage", SAS_TOKEN_PROPERTY);
log.error(message);
throw new EStartup(message);
}

// SAS token should be a URL query param string, including the initial "?"
var sasToken = rawSasToken.startsWith("?")
? rawSasToken
: "?" + rawSasToken;

return builder -> builder.sasToken(sasToken);
}

var message = String.format("Unrecognised credentials mechanism: [%s]", mechanism);
log.error(message);
throw new EStartup(message);
Expand Down
7 changes: 2 additions & 5 deletions tracdap-runtime/python/src/tracdap/rt/_plugins/storage_azure.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,11 +46,8 @@ def _azure_fsspec_available():

class AzureBlobStorageProvider(IStorageProvider):

# This client depends on the Azure fsspec implementation, since there is no native implementation from Arrow
# To enable it, the tracdap package must be installed with the optional [azure] feature

# Current supported authentication mechanisms are "default" and "access_key"
# Client always uses location mode = primary, version aware = False
# Supported authentication mechanisms are "default" and "account_key" and "sas_token"
# The "default" mechanism will try environment, CLI, managed identity and workload identity

STORAGE_ACCOUNT_PROPERTY = "storageAccount"
CONTAINER_PROPERTY = "container"
Expand Down
Loading