GH-39449: [C++] Use default Azure credentials implicitly and support anonymous credentials explicitly#39450

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
felipecrv merged 6 commits into from
Jan 5, 2024
Merged

GH-39449: [C++] Use default Azure credentials implicitly and support anonymous credentials explicitly #39450

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
fdf5931
GH-39449: [C++] Use default Azure credentials implicitly and support …
felipecrv Jan 4, 2024
3e2adff
Add one enum entry per kind of credential configuration
felipecrv Jan 4, 2024
ea37431
Expand explanation of AzureOptions::account_name
felipecrv Jan 4, 2024
90d457d
Add test for ConfigureAnonymousCredential()
felipecrv Jan 4, 2024
32d1690
Explain authentication in the AzureOptions docstring
felipecrv Jan 4, 2024
3460eb7
Fix unit test
felipecrv Jan 5, 2024
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
62 changes: 43 additions & 19 deletions cpp/src/arrow/filesystem/azurefs.cc
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -73,13 +73,17 @@ bool AzureOptions::Equals(const AzureOptions& other) const {
return false;
}
switch (credential_kind_) {
case CredentialKind::kDefault:
case CredentialKind::kAnonymous:
return true;
case CredentialKind::kTokenCredential:
return token_credential_ == other.token_credential_;
case CredentialKind::kStorageSharedKeyCredential:
case CredentialKind::kStorageSharedKey:
return storage_shared_key_credential_->AccountName ==
other.storage_shared_key_credential_->AccountName;
case CredentialKind::kClientSecret:
case CredentialKind::kManagedIdentity:
case CredentialKind::kWorkloadIdentity:
return token_credential_->GetCredentialName() ==
other.token_credential_->GetCredentialName();
}
DCHECK(false);
return false;
Expand DownExpand Up@@ -113,8 +117,19 @@ std::string AzureOptions::AccountDfsUrl(const std::string& account_name) const {
return BuildBaseUrl(dfs_storage_scheme, dfs_storage_authority, account_name);
}

Status AzureOptions::ConfigureDefaultCredential() {
credential_kind_ = CredentialKind::kDefault;
token_credential_ = std::make_shared<Azure::Identity::DefaultAzureCredential>();
return Status::OK();
}

Status AzureOptions::ConfigureAnonymousCredential() {
credential_kind_ = CredentialKind::kAnonymous;
return Status::OK();
}

Status AzureOptions::ConfigureAccountKeyCredential(const std::string& account_key) {
credential_kind_ = CredentialKind::kStorageSharedKeyCredential;
credential_kind_ = CredentialKind::kStorageSharedKey;
if (account_name.empty()) {
return Status::Invalid("AzureOptions doesn't contain a valid account name");
}
Expand All@@ -126,27 +141,21 @@ Status AzureOptions::ConfigureAccountKeyCredential(const std::string& account_ke
Status AzureOptions::ConfigureClientSecretCredential(const std::string& tenant_id,
const std::string& client_id,
const std::string& client_secret) {
credential_kind_ = CredentialKind::kTokenCredential;
credential_kind_ = CredentialKind::kClientSecret;
token_credential_ = std::make_shared<Azure::Identity::ClientSecretCredential>(
tenant_id, client_id, client_secret);
return Status::OK();
}

Status AzureOptions::ConfigureDefaultCredential() {
credential_kind_ = CredentialKind::kTokenCredential;
token_credential_ = std::make_shared<Azure::Identity::DefaultAzureCredential>();
return Status::OK();
}

Status AzureOptions::ConfigureManagedIdentityCredential(const std::string& client_id) {
credential_kind_ = CredentialKind::kTokenCredential;
credential_kind_ = CredentialKind::kManagedIdentity;
token_credential_ =
std::make_shared<Azure::Identity::ManagedIdentityCredential>(client_id);
return Status::OK();
}

Status AzureOptions::ConfigureWorkloadIdentityCredential() {
credential_kind_ = CredentialKind::kTokenCredential;
credential_kind_ = CredentialKind::kWorkloadIdentity;
token_credential_ = std::make_shared<Azure::Identity::WorkloadIdentityCredential>();
return Status::OK();
}
Expand All@@ -158,11 +167,18 @@ Result<std::unique_ptr<Blobs::BlobServiceClient>> AzureOptions::MakeBlobServiceC
}
switch (credential_kind_) {
case CredentialKind::kAnonymous:
break;
case CredentialKind::kTokenCredential:
return std::make_unique<Blobs::BlobServiceClient>(AccountBlobUrl(account_name));
case CredentialKind::kDefault:
if (!token_credential_) {
token_credential_ = std::make_shared<Azure::Identity::DefaultAzureCredential>();
}
[[fallthrough]];
case CredentialKind::kClientSecret:
case CredentialKind::kManagedIdentity:
case CredentialKind::kWorkloadIdentity:
return std::make_unique<Blobs::BlobServiceClient>(AccountBlobUrl(account_name),
token_credential_);
case CredentialKind::kStorageSharedKeyCredential:
case CredentialKind::kStorageSharedKey:
return std::make_unique<Blobs::BlobServiceClient>(AccountBlobUrl(account_name),
storage_shared_key_credential_);
}
Expand All@@ -176,11 +192,19 @@ AzureOptions::MakeDataLakeServiceClient() const {
}
switch (credential_kind_) {
case CredentialKind::kAnonymous:
break;
case CredentialKind::kTokenCredential:
return std::make_unique<DataLake::DataLakeServiceClient>(
AccountDfsUrl(account_name));
case CredentialKind::kDefault:
if (!token_credential_) {
token_credential_ = std::make_shared<Azure::Identity::DefaultAzureCredential>();
}
[[fallthrough]];
case CredentialKind::kClientSecret:
case CredentialKind::kManagedIdentity:
case CredentialKind::kWorkloadIdentity:
return std::make_unique<DataLake::DataLakeServiceClient>(
AccountDfsUrl(account_name), token_credential_);
case CredentialKind::kStorageSharedKeyCredential:
case CredentialKind::kStorageSharedKey:
return std::make_unique<DataLake::DataLakeServiceClient>(
AccountDfsUrl(account_name), storage_shared_key_credential_);
}
Expand Down
37 changes: 26 additions & 11 deletions cpp/src/arrow/filesystem/azurefs.h
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -47,8 +47,23 @@ namespace arrow::fs {
class TestAzureFileSystem;

/// Options for the AzureFileSystem implementation.
///
/// By default, authentication is handled by the Azure SDK's credential chain
/// which may read from multiple environment variables, such as:
/// - `AZURE_TENANT_ID`
/// - `AZURE_CLIENT_ID`
/// - `AZURE_CLIENT_SECRET`
/// - `AZURE_AUTHORITY_HOST`
/// - `AZURE_CLIENT_CERTIFICATE_PATH`
/// - `AZURE_FEDERATED_TOKEN_FILE`
///
/// Functions are provided for explicit configuration of credentials if that is preferred.
struct ARROW_EXPORT AzureOptions {
/// \brief account name of the Azure Storage account.
/// \brief The name of the Azure Storage Account being accessed.
///
/// All service URLs will be constructed using this storage account name.
/// `ConfigureAccountKeyCredential` assumes the user wants to authenticate
/// this account.
std::string account_name;

/// \brief hostname[:port] of the Azure Blob Storage Service.
Expand DownExpand Up@@ -92,30 +107,30 @@ struct ARROW_EXPORT AzureOptions {

private:
enum class CredentialKind {
kDefault,
kAnonymous,
kTokenCredential,
kStorageSharedKeyCredential,
} credential_kind_ = CredentialKind::kAnonymous;
kStorageSharedKey,
kClientSecret,
kManagedIdentity,
kWorkloadIdentity,
Comment on lines 112 to 115

@Tom-NewtonTom-NewtonJan 4, 2024

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think we really need to change this. I would rather just keep kTokenCredential to cover all the credentials that are based on https://github.com/Azure/azure-sdk-for-cpp/blob/e5e675440b44ace7d7a9e7bc303f877c06b59ea5/sdk/core/azure-core/inc/azure/core/credentials/credentials.hpp#L68

@felipecrvfelipecrvJan 4, 2024•
edited
Loading

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We need this to support Equals. Think of it as runtime type-information that describes which concrete implementation of TokenCredential is being used.

@felipecrvfelipecrvJan 4, 2024

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Besides that, we would need to make a distinction between kDefault and all the others kToken at least (to support the implicit default behavior). It's clearer if we then make a distinction on all of them.

@Tom-NewtonTom-NewtonJan 5, 2024

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think I would have done it differently but I don't feel strongly.

} credential_kind_ = CredentialKind::kDefault;

std::shared_ptr<Azure::Core::Credentials::TokenCredential> token_credential_;
std::shared_ptr<Azure::Storage::StorageSharedKeyCredential>
storage_shared_key_credential_;
mutable std::shared_ptr<Azure::Core::Credentials::TokenCredential> token_credential_;

@koukouJan 4, 2024

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How about always creating Azure::Identity::DefaultAzureCredential instead of using mutable?

diff --git a/cpp/src/arrow/filesystem/azurefs.cc b/cpp/src/arrow/filesystem/azurefs.cc
index e98d56c73..5099cd25d 100644
--- a/cpp/src/arrow/filesystem/azurefs.cc+++ b/cpp/src/arrow/filesystem/azurefs.cc@@ -110,7 +110,6 @@ std::string AzureOptions::AccountDfsUrl(const std::string& account_name) const {
Status AzureOptions::ConfigureDefaultCredential() {
credential_kind_ = CredentialKind::kDefault;
- token_credential_ = std::make_shared<Azure::Identity::DefaultAzureCredential>();
return Status::OK();
}
@@ -160,10 +159,9 @@ Result<std::unique_ptr<Blobs::BlobServiceClient>> AzureOptions::MakeBlobServiceC
case CredentialKind::kAnonymous:
return std::make_unique<Blobs::BlobServiceClient>(AccountBlobUrl(account_name));
case CredentialKind::kDefault:
- if (!token_credential_) {- token_credential_ = std::make_shared<Azure::Identity::DefaultAzureCredential>();- }- [[fallthrough]];+ return std::make_unique<Blobs::BlobServiceClient>(+ AccountBlobUrl(account_name),+ std::make_shared<Azure::Identity::DefaultAzureCredential>());
case CredentialKind::kClientSecret:
case CredentialKind::kManagedIdentity:
case CredentialKind::kWorkloadIdentity:
@@ -186,10 +184,9 @@ AzureOptions::MakeDataLakeServiceClient() const {
return std::make_unique<DataLake::DataLakeServiceClient>(
AccountDfsUrl(account_name));
case CredentialKind::kDefault:
- if (!token_credential_) {- token_credential_ = std::make_shared<Azure::Identity::DefaultAzureCredential>();- }- [[fallthrough]];+ return std::make_unique<DataLake::DataLakeServiceClient>(+ AccountDfsUrl(account_name),+ std::make_shared<Azure::Identity::DefaultAzureCredential>());
case CredentialKind::kClientSecret:
case CredentialKind::kManagedIdentity:
case CredentialKind::kWorkloadIdentity:
diff --git a/cpp/src/arrow/filesystem/azurefs.h b/cpp/src/arrow/filesystem/azurefs.h
index 55f89ba47..ba612f799 100644
--- a/cpp/src/arrow/filesystem/azurefs.h+++ b/cpp/src/arrow/filesystem/azurefs.h@@ -117,7 +117,7 @@ struct ARROW_EXPORT AzureOptions {
std::shared_ptr<Azure::Storage::StorageSharedKeyCredential>
storage_shared_key_credential_;
- mutable std::shared_ptr<Azure::Core::Credentials::TokenCredential> token_credential_;+ std::shared_ptr<Azure::Core::Credentials::TokenCredential> token_credential_;
public:
AzureOptions();

@felipecrvfelipecrvJan 5, 2024

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Creating DefaultAzureCredential is a lot of non-trivial work: env vars, multiple allocations and probes. We can't assume it to be a cheap operation. mutable is a common solution to lazily-initialized class members and this one has a very well-defined behavior: it's set once, then it doesn't change at all anymore.

@felipecrvfelipecrvJan 5, 2024

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

And it's important that we do mutate it in ConfigureDefaultCredential because the user might want to explicitly initialize the credential immediately after doing something with the env variables used by the Azure SDK or right before unsetting the variables.


public:
AzureOptions();
~AzureOptions();

Status ConfigureDefaultCredential();

Status ConfigureManagedIdentityCredential(const std::string& client_id = std::string());

Status ConfigureWorkloadIdentityCredential();

Status ConfigureAnonymousCredential();
Status ConfigureAccountKeyCredential(const std::string& account_key);

Status ConfigureClientSecretCredential(const std::string& tenant_id,
const std::string& client_id,
const std::string& client_secret);
Status ConfigureManagedIdentityCredential(const std::string& client_id = std::string());
Status ConfigureWorkloadIdentityCredential();

bool Equals(const AzureOptions& other) const;

Expand Down
30 changes: 23 additions & 7 deletions cpp/src/arrow/filesystem/azurefs_test.cc
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -280,22 +280,38 @@ TEST(AzureFileSystem, InitializingFilesystemWithoutAccountNameFails) {
ASSERT_RAISES(Invalid, AzureFileSystem::Make(options));
}

TEST(AzureFileSystem, InitializeFilesystemWithClientSecretCredential) {
TEST(AzureFileSystem, InitializeWithDefaultCredential) {
AzureOptions options;
options.account_name = "dummy-account-name";
ARROW_EXPECT_OK(
options.ConfigureClientSecretCredential("tenant_id", "client_id", "client_secret"));
ARROW_EXPECT_OK(options.ConfigureDefaultCredential());
EXPECT_OK_AND_ASSIGN(auto fs, AzureFileSystem::Make(options));
}

TEST(AzureFileSystem, InitializeFilesystemWithDefaultCredential) {
TEST(AzureFileSystem, InitializeWithDefaultCredentialImplicitly) {
AzureOptions options;
options.account_name = "dummy-account-name";
ARROW_EXPECT_OK(options.ConfigureDefaultCredential());
AzureOptions explictly_default_options;
explictly_default_options.account_name = "dummy-account-name";
ARROW_EXPECT_OK(explictly_default_options.ConfigureDefaultCredential());
ASSERT_TRUE(options.Equals(explictly_default_options));
}

TEST(AzureFileSystem, InitializeWithAnonymousCredential) {
AzureOptions options;
options.account_name = "dummy-account-name";
ARROW_EXPECT_OK(options.ConfigureAnonymousCredential());
EXPECT_OK_AND_ASSIGN(auto fs, AzureFileSystem::Make(options));
}

TEST(AzureFileSystem, InitializeWithClientSecretCredential) {
AzureOptions options;
options.account_name = "dummy-account-name";
ARROW_EXPECT_OK(
options.ConfigureClientSecretCredential("tenant_id", "client_id", "client_secret"));
EXPECT_OK_AND_ASSIGN(auto fs, AzureFileSystem::Make(options));
}

TEST(AzureFileSystem, InitializeFilesystemWithManagedIdentityCredential) {
TEST(AzureFileSystem, InitializeWithManagedIdentityCredential) {
AzureOptions options;
options.account_name = "dummy-account-name";
ARROW_EXPECT_OK(options.ConfigureManagedIdentityCredential());
Expand All@@ -305,7 +321,7 @@ TEST(AzureFileSystem, InitializeFilesystemWithManagedIdentityCredential) {
EXPECT_OK_AND_ASSIGN(fs, AzureFileSystem::Make(options));
}

Comment thread
felipecrv marked this conversation as resolved.
Outdated
TEST(AzureFileSystem, InitializeFilesystemWithWorkloadIdentityCredential) {
TEST(AzureFileSystem, InitializeWithWorkloadIdentityCredential) {
AzureOptions options;
options.account_name = "dummy-account-name";
ARROW_EXPECT_OK(options.ConfigureWorkloadIdentityCredential());
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
GH-39449: [C++] Use default Azure credentials implicitly and support anonymous credentials explicitly#39450

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

felipecrv
merged 6 commits into

from

Jan 5, 2024
 Merged


GH-39449: [C++] Use default Azure credentials implicitly and support anonymous credentials explicitly
#39450
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
fdf5931

GH-39449: [C++] Use default Azure credentials implicitly and support …


felipecrv Jan 4, 2024
3e2adff

Add one enum entry per kind of credential configuration


felipecrv Jan 4, 2024
ea37431

Expand explanation of AzureOptions::account_name


felipecrv Jan 4, 2024
90d457d

Add test for ConfigureAnonymousCredential()


felipecrv Jan 4, 2024
32d1690

Explain authentication in the AzureOptions docstring


felipecrv Jan 4, 2024
3460eb7

Fix unit test


felipecrv Jan 5, 2024

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


62 changes: 43 additions & 19 deletions
cpp/src/arrow/filesystem/azurefs.cc

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -73,13 +73,17 @@ bool AzureOptions::Equals(const AzureOptions& other) const {
 return false;
 }
 switch (credential_kind_) {
 case CredentialKind::kDefault:
 case CredentialKind::kAnonymous:
 return true;
 case CredentialKind::kTokenCredential:
 return token_credential_ == other.token_credential_;
 case CredentialKind::kStorageSharedKeyCredential:
 case CredentialKind::kStorageSharedKey:
 return storage_shared_key_credential_->AccountName ==
 other.storage_shared_key_credential_->AccountName;
 case CredentialKind::kClientSecret:
 case CredentialKind::kManagedIdentity:
 case CredentialKind::kWorkloadIdentity:
 return token_credential_->GetCredentialName() ==
 other.token_credential_->GetCredentialName();
 }
 DCHECK(false);
 return false;
Expand DownExpand Up@@ -113,8 +117,19 @@ std::string AzureOptions::AccountDfsUrl(const std::string& account_name) const {
 return BuildBaseUrl(dfs_storage_scheme, dfs_storage_authority, account_name);
}

Status AzureOptions::ConfigureDefaultCredential() {
 credential_kind_ = CredentialKind::kDefault;
 token_credential_ = std::make_shared<Azure::Identity::DefaultAzureCredential>();
 return Status::OK();
}

Status AzureOptions::ConfigureAnonymousCredential() {
 credential_kind_ = CredentialKind::kAnonymous;
 return Status::OK();
}

Status AzureOptions::ConfigureAccountKeyCredential(const std::string& account_key) {
 credential_kind_ = CredentialKind::kStorageSharedKeyCredential;
 credential_kind_ = CredentialKind::kStorageSharedKey;
 if (account_name.empty()) {
 return Status::Invalid("AzureOptions doesn't contain a valid account name");
 }
Expand All@@ -126,27 +141,21 @@ Status AzureOptions::ConfigureAccountKeyCredential(const std::string& account_ke
Status AzureOptions::ConfigureClientSecretCredential(const std::string& tenant_id,
 const std::string& client_id,
 const std::string& client_secret) {
 credential_kind_ = CredentialKind::kTokenCredential;
 credential_kind_ = CredentialKind::kClientSecret;
 token_credential_ = std::make_shared<Azure::Identity::ClientSecretCredential>(
 tenant_id, client_id, client_secret);
 return Status::OK();
}

Status AzureOptions::ConfigureDefaultCredential() {
 credential_kind_ = CredentialKind::kTokenCredential;
 token_credential_ = std::make_shared<Azure::Identity::DefaultAzureCredential>();
 return Status::OK();
}

Status AzureOptions::ConfigureManagedIdentityCredential(const std::string& client_id) {
 credential_kind_ = CredentialKind::kTokenCredential;
 credential_kind_ = CredentialKind::kManagedIdentity;
 token_credential_ =
 std::make_shared<Azure::Identity::ManagedIdentityCredential>(client_id);
 return Status::OK();
}

Status AzureOptions::ConfigureWorkloadIdentityCredential() {
 credential_kind_ = CredentialKind::kTokenCredential;
 credential_kind_ = CredentialKind::kWorkloadIdentity;
 token_credential_ = std::make_shared<Azure::Identity::WorkloadIdentityCredential>();
 return Status::OK();
}
Expand All@@ -158,11 +167,18 @@ Result<std::unique_ptr<Blobs::BlobServiceClient>> AzureOptions::MakeBlobServiceC
 }
 switch (credential_kind_) {
 case CredentialKind::kAnonymous:
 break;
 case CredentialKind::kTokenCredential:
 return std::make_unique<Blobs::BlobServiceClient>(AccountBlobUrl(account_name));
 case CredentialKind::kDefault:
 if (!token_credential_) {
 token_credential_ = std::make_shared<Azure::Identity::DefaultAzureCredential>();
 }
 [[fallthrough]];
 case CredentialKind::kClientSecret:
 case CredentialKind::kManagedIdentity:
 case CredentialKind::kWorkloadIdentity:
 return std::make_unique<Blobs::BlobServiceClient>(AccountBlobUrl(account_name),
 token_credential_);
 case CredentialKind::kStorageSharedKeyCredential:
 case CredentialKind::kStorageSharedKey:
 return std::make_unique<Blobs::BlobServiceClient>(AccountBlobUrl(account_name),
 storage_shared_key_credential_);
 }
Expand All@@ -176,11 +192,19 @@ AzureOptions::MakeDataLakeServiceClient() const {
 }
 switch (credential_kind_) {
 case CredentialKind::kAnonymous:
 break;
 case CredentialKind::kTokenCredential:
 return std::make_unique<DataLake::DataLakeServiceClient>(
 AccountDfsUrl(account_name));
 case CredentialKind::kDefault:
 if (!token_credential_) {
 token_credential_ = std::make_shared<Azure::Identity::DefaultAzureCredential>();
 }
 [[fallthrough]];
 case CredentialKind::kClientSecret:
 case CredentialKind::kManagedIdentity:
 case CredentialKind::kWorkloadIdentity:
 return std::make_unique<DataLake::DataLakeServiceClient>(
 AccountDfsUrl(account_name), token_credential_);
 case CredentialKind::kStorageSharedKeyCredential:
 case CredentialKind::kStorageSharedKey:
 return std::make_unique<DataLake::DataLakeServiceClient>(
 AccountDfsUrl(account_name), storage_shared_key_credential_);
 }
Expand Down

37 changes: 26 additions & 11 deletions
cpp/src/arrow/filesystem/azurefs.h

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -47,8 +47,23 @@ namespace arrow::fs {
class TestAzureFileSystem;

/// Options for the AzureFileSystem implementation.
///
/// By default, authentication is handled by the Azure SDK's credential chain
/// which may read from multiple environment variables, such as:
/// - `AZURE_TENANT_ID`
/// - `AZURE_CLIENT_ID`
/// - `AZURE_CLIENT_SECRET`
/// - `AZURE_AUTHORITY_HOST`
/// - `AZURE_CLIENT_CERTIFICATE_PATH`
/// - `AZURE_FEDERATED_TOKEN_FILE`
///
/// Functions are provided for explicit configuration of credentials if that is preferred.
struct ARROW_EXPORT AzureOptions {
 /// \brief account name of the Azure Storage account.
 /// \brief The name of the Azure Storage Account being accessed.
 ///
 /// All service URLs will be constructed using this storage account name.
 /// `ConfigureAccountKeyCredential` assumes the user wants to authenticate
 /// this account.
 std::string account_name;

 /// \brief hostname[:port] of the Azure Blob Storage Service.
Expand DownExpand Up@@ -92,30 +107,30 @@ struct ARROW_EXPORT AzureOptions {

 private:
 enum class CredentialKind {
 kDefault,
 kAnonymous,
 kTokenCredential,
 kStorageSharedKeyCredential,
 } credential_kind_ = CredentialKind::kAnonymous;
 kStorageSharedKey,
 kClientSecret,
 kManagedIdentity,
 kWorkloadIdentity,

Comment on lines

112
 to 
115

@Tom-NewtonTom-NewtonJan 4, 2024

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think we really need to change this. I would rather just keep kTokenCredential to cover all the credentials that are based on https://github.com/Azure/azure-sdk-for-cpp/blob/e5e675440b44ace7d7a9e7bc303f877c06b59ea5/sdk/core/azure-core/inc/azure/core/credentials/credentials.hpp#L68
@felipecrvfelipecrvJan 4, 2024•

edited

Loading

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We need this to support Equals. Think of it as runtime type-information that describes which concrete implementation of TokenCredential is being used.
@felipecrvfelipecrvJan 4, 2024

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Besides that, we would need to make a distinction between kDefault and all the others kToken at least (to support the implicit default behavior). It's clearer if we then make a distinction on all of them.
@Tom-NewtonTom-NewtonJan 5, 2024

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think I would have done it differently but I don't feel strongly.
 } credential_kind_ = CredentialKind::kDefault;

 std::shared_ptr<Azure::Core::Credentials::TokenCredential> token_credential_;
 std::shared_ptr<Azure::Storage::StorageSharedKeyCredential>
 storage_shared_key_credential_;
 mutable std::shared_ptr<Azure::Core::Credentials::TokenCredential> token_credential_;
@koukouJan 4, 2024

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How about always creating Azure::Identity::DefaultAzureCredential instead of using mutable?
diff --git a/cpp/src/arrow/filesystem/azurefs.cc b/cpp/src/arrow/filesystem/azurefs.cc
index e98d56c73..5099cd25d 100644
--- a/cpp/src/arrow/filesystem/azurefs.cc+++ b/cpp/src/arrow/filesystem/azurefs.cc@@ -110,7 +110,6 @@ std::string AzureOptions::AccountDfsUrl(const std::string& account_name) const {
Status AzureOptions::ConfigureDefaultCredential() {
credential_kind_ = CredentialKind::kDefault;
- token_credential_ = std::make_shared<Azure::Identity::DefaultAzureCredential>();
return Status::OK();
}
@@ -160,10 +159,9 @@ Result<std::unique_ptr<Blobs::BlobServiceClient>> AzureOptions::MakeBlobServiceC
case CredentialKind::kAnonymous:
return std::make_unique<Blobs::BlobServiceClient>(AccountBlobUrl(account_name));
case CredentialKind::kDefault:
- if (!token_credential_) {- token_credential_ = std::make_shared<Azure::Identity::DefaultAzureCredential>();- }- [[fallthrough]];+ return std::make_unique<Blobs::BlobServiceClient>(+ AccountBlobUrl(account_name),+ std::make_shared<Azure::Identity::DefaultAzureCredential>());
case CredentialKind::kClientSecret:
case CredentialKind::kManagedIdentity:
case CredentialKind::kWorkloadIdentity:
@@ -186,10 +184,9 @@ AzureOptions::MakeDataLakeServiceClient() const {
return std::make_unique<DataLake::DataLakeServiceClient>(
AccountDfsUrl(account_name));
case CredentialKind::kDefault:
- if (!token_credential_) {- token_credential_ = std::make_shared<Azure::Identity::DefaultAzureCredential>();- }- [[fallthrough]];+ return std::make_unique<DataLake::DataLakeServiceClient>(+ AccountDfsUrl(account_name),+ std::make_shared<Azure::Identity::DefaultAzureCredential>());
case CredentialKind::kClientSecret:
case CredentialKind::kManagedIdentity:
case CredentialKind::kWorkloadIdentity:
diff --git a/cpp/src/arrow/filesystem/azurefs.h b/cpp/src/arrow/filesystem/azurefs.h
index 55f89ba47..ba612f799 100644
--- a/cpp/src/arrow/filesystem/azurefs.h+++ b/cpp/src/arrow/filesystem/azurefs.h@@ -117,7 +117,7 @@ struct ARROW_EXPORT AzureOptions {
std::shared_ptr<Azure::Storage::StorageSharedKeyCredential>
storage_shared_key_credential_;
- mutable std::shared_ptr<Azure::Core::Credentials::TokenCredential> token_credential_;+ std::shared_ptr<Azure::Core::Credentials::TokenCredential> token_credential_;
public:
AzureOptions();
@felipecrvfelipecrvJan 5, 2024

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Creating DefaultAzureCredential is a lot of non-trivial work: env vars, multiple allocations and probes. We can't assume it to be a cheap operation. mutable is a common solution to lazily-initialized class members and this one has a very well-defined behavior: it's set once, then it doesn't change at all anymore.
@felipecrvfelipecrvJan 5, 2024

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

And it's important that we do mutate it in ConfigureDefaultCredential because the user might want to explicitly initialize the credential immediately after doing something with the env variables used by the Azure SDK or right before unsetting the variables.

 public:
 AzureOptions();
 ~AzureOptions();

 Status ConfigureDefaultCredential();

 Status ConfigureManagedIdentityCredential(const std::string& client_id = std::string());

 Status ConfigureWorkloadIdentityCredential();

 Status ConfigureAnonymousCredential();
 Status ConfigureAccountKeyCredential(const std::string& account_key);

 Status ConfigureClientSecretCredential(const std::string& tenant_id,
 const std::string& client_id,
 const std::string& client_secret);
 Status ConfigureManagedIdentityCredential(const std::string& client_id = std::string());
 Status ConfigureWorkloadIdentityCredential();

 bool Equals(const AzureOptions& other) const;

Expand Down

30 changes: 23 additions & 7 deletions
cpp/src/arrow/filesystem/azurefs_test.cc

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -280,22 +280,38 @@ TEST(AzureFileSystem, InitializingFilesystemWithoutAccountNameFails) {
 ASSERT_RAISES(Invalid, AzureFileSystem::Make(options));
}

TEST(AzureFileSystem, InitializeFilesystemWithClientSecretCredential) {
TEST(AzureFileSystem, InitializeWithDefaultCredential) {
 AzureOptions options;
 options.account_name = "dummy-account-name";
 ARROW_EXPECT_OK(
 options.ConfigureClientSecretCredential("tenant_id", "client_id", "client_secret"));
 ARROW_EXPECT_OK(options.ConfigureDefaultCredential());
 EXPECT_OK_AND_ASSIGN(auto fs, AzureFileSystem::Make(options));
}

TEST(AzureFileSystem, InitializeFilesystemWithDefaultCredential) {
TEST(AzureFileSystem, InitializeWithDefaultCredentialImplicitly) {
 AzureOptions options;
 options.account_name = "dummy-account-name";
 ARROW_EXPECT_OK(options.ConfigureDefaultCredential());
 AzureOptions explictly_default_options;
 explictly_default_options.account_name = "dummy-account-name";
 ARROW_EXPECT_OK(explictly_default_options.ConfigureDefaultCredential());
 ASSERT_TRUE(options.Equals(explictly_default_options));
}

TEST(AzureFileSystem, InitializeWithAnonymousCredential) {
 AzureOptions options;
 options.account_name = "dummy-account-name";
 ARROW_EXPECT_OK(options.ConfigureAnonymousCredential());
 EXPECT_OK_AND_ASSIGN(auto fs, AzureFileSystem::Make(options));
}

TEST(AzureFileSystem, InitializeWithClientSecretCredential) {
 AzureOptions options;
 options.account_name = "dummy-account-name";
 ARROW_EXPECT_OK(
 options.ConfigureClientSecretCredential("tenant_id", "client_id", "client_secret"));
 EXPECT_OK_AND_ASSIGN(auto fs, AzureFileSystem::Make(options));
}

TEST(AzureFileSystem, InitializeFilesystemWithManagedIdentityCredential) {
TEST(AzureFileSystem, InitializeWithManagedIdentityCredential) {
 AzureOptions options;
 options.account_name = "dummy-account-name";
 ARROW_EXPECT_OK(options.ConfigureManagedIdentityCredential());
Expand All@@ -305,7 +321,7 @@ TEST(AzureFileSystem, InitializeFilesystemWithManagedIdentityCredential) {
 EXPECT_OK_AND_ASSIGN(fs, AzureFileSystem::Make(options));
}

Comment thread
felipecrv marked this conversation as resolved.


Outdated

TEST(AzureFileSystem, InitializeFilesystemWithWorkloadIdentityCredential) {
TEST(AzureFileSystem, InitializeWithWorkloadIdentityCredential) {
 AzureOptions options;
 options.account_name = "dummy-account-name";
 ARROW_EXPECT_OK(options.ConfigureWorkloadIdentityCredential());
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
GH-39449: [C++] Use default Azure credentials implicitly and support anonymous credentials explicitly#39450

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

felipecrv
merged 6 commits into

from

Jan 5, 2024
 Merged


GH-39449: [C++] Use default Azure credentials implicitly and support anonymous credentials explicitly
#39450
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
fdf5931

GH-39449: [C++] Use default Azure credentials implicitly and support …


felipecrv Jan 4, 2024
3e2adff

Add one enum entry per kind of credential configuration


felipecrv Jan 4, 2024
ea37431

Expand explanation of AzureOptions::account_name


felipecrv Jan 4, 2024
90d457d

Add test for ConfigureAnonymousCredential()


felipecrv Jan 4, 2024
32d1690

Explain authentication in the AzureOptions docstring


felipecrv Jan 4, 2024
3460eb7

Fix unit test


felipecrv Jan 5, 2024

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


62 changes: 43 additions & 19 deletions
cpp/src/arrow/filesystem/azurefs.cc

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -73,13 +73,17 @@ bool AzureOptions::Equals(const AzureOptions& other) const {
 return false;
 }
 switch (credential_kind_) {
 case CredentialKind::kDefault:
 case CredentialKind::kAnonymous:
 return true;
 case CredentialKind::kTokenCredential:
 return token_credential_ == other.token_credential_;
 case CredentialKind::kStorageSharedKeyCredential:
 case CredentialKind::kStorageSharedKey:
 return storage_shared_key_credential_->AccountName ==
 other.storage_shared_key_credential_->AccountName;
 case CredentialKind::kClientSecret:
 case CredentialKind::kManagedIdentity:
 case CredentialKind::kWorkloadIdentity:
 return token_credential_->GetCredentialName() ==
 other.token_credential_->GetCredentialName();
 }
 DCHECK(false);
 return false;
Expand DownExpand Up@@ -113,8 +117,19 @@ std::string AzureOptions::AccountDfsUrl(const std::string& account_name) const {
 return BuildBaseUrl(dfs_storage_scheme, dfs_storage_authority, account_name);
}

Status AzureOptions::ConfigureDefaultCredential() {
 credential_kind_ = CredentialKind::kDefault;
 token_credential_ = std::make_shared<Azure::Identity::DefaultAzureCredential>();
 return Status::OK();
}

Status AzureOptions::ConfigureAnonymousCredential() {
 credential_kind_ = CredentialKind::kAnonymous;
 return Status::OK();
}

Status AzureOptions::ConfigureAccountKeyCredential(const std::string& account_key) {
 credential_kind_ = CredentialKind::kStorageSharedKeyCredential;
 credential_kind_ = CredentialKind::kStorageSharedKey;
 if (account_name.empty()) {
 return Status::Invalid("AzureOptions doesn't contain a valid account name");
 }
Expand All@@ -126,27 +141,21 @@ Status AzureOptions::ConfigureAccountKeyCredential(const std::string& account_ke
Status AzureOptions::ConfigureClientSecretCredential(const std::string& tenant_id,
 const std::string& client_id,
 const std::string& client_secret) {
 credential_kind_ = CredentialKind::kTokenCredential;
 credential_kind_ = CredentialKind::kClientSecret;
 token_credential_ = std::make_shared<Azure::Identity::ClientSecretCredential>(
 tenant_id, client_id, client_secret);
 return Status::OK();
}

Status AzureOptions::ConfigureDefaultCredential() {
 credential_kind_ = CredentialKind::kTokenCredential;
 token_credential_ = std::make_shared<Azure::Identity::DefaultAzureCredential>();
 return Status::OK();
}

Status AzureOptions::ConfigureManagedIdentityCredential(const std::string& client_id) {
 credential_kind_ = CredentialKind::kTokenCredential;
 credential_kind_ = CredentialKind::kManagedIdentity;
 token_credential_ =
 std::make_shared<Azure::Identity::ManagedIdentityCredential>(client_id);
 return Status::OK();
}

Status AzureOptions::ConfigureWorkloadIdentityCredential() {
 credential_kind_ = CredentialKind::kTokenCredential;
 credential_kind_ = CredentialKind::kWorkloadIdentity;
 token_credential_ = std::make_shared<Azure::Identity::WorkloadIdentityCredential>();
 return Status::OK();
}
Expand All@@ -158,11 +167,18 @@ Result<std::unique_ptr<Blobs::BlobServiceClient>> AzureOptions::MakeBlobServiceC
 }
 switch (credential_kind_) {
 case CredentialKind::kAnonymous:
 break;
 case CredentialKind::kTokenCredential:
 return std::make_unique<Blobs::BlobServiceClient>(AccountBlobUrl(account_name));
 case CredentialKind::kDefault:
 if (!token_credential_) {
 token_credential_ = std::make_shared<Azure::Identity::DefaultAzureCredential>();
 }
 [[fallthrough]];
 case CredentialKind::kClientSecret:
 case CredentialKind::kManagedIdentity:
 case CredentialKind::kWorkloadIdentity:
 return std::make_unique<Blobs::BlobServiceClient>(AccountBlobUrl(account_name),
 token_credential_);
 case CredentialKind::kStorageSharedKeyCredential:
 case CredentialKind::kStorageSharedKey:
 return std::make_unique<Blobs::BlobServiceClient>(AccountBlobUrl(account_name),
 storage_shared_key_credential_);
 }
Expand All@@ -176,11 +192,19 @@ AzureOptions::MakeDataLakeServiceClient() const {
 }
 switch (credential_kind_) {
 case CredentialKind::kAnonymous:
 break;
 case CredentialKind::kTokenCredential:
 return std::make_unique<DataLake::DataLakeServiceClient>(
 AccountDfsUrl(account_name));
 case CredentialKind::kDefault:
 if (!token_credential_) {
 token_credential_ = std::make_shared<Azure::Identity::DefaultAzureCredential>();
 }
 [[fallthrough]];
 case CredentialKind::kClientSecret:
 case CredentialKind::kManagedIdentity:
 case CredentialKind::kWorkloadIdentity:
 return std::make_unique<DataLake::DataLakeServiceClient>(
 AccountDfsUrl(account_name), token_credential_);
 case CredentialKind::kStorageSharedKeyCredential:
 case CredentialKind::kStorageSharedKey:
 return std::make_unique<DataLake::DataLakeServiceClient>(
 AccountDfsUrl(account_name), storage_shared_key_credential_);
 }
Expand Down

37 changes: 26 additions & 11 deletions
cpp/src/arrow/filesystem/azurefs.h

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -47,8 +47,23 @@ namespace arrow::fs {
class TestAzureFileSystem;

/// Options for the AzureFileSystem implementation.
///
/// By default, authentication is handled by the Azure SDK's credential chain
/// which may read from multiple environment variables, such as:
/// - `AZURE_TENANT_ID`
/// - `AZURE_CLIENT_ID`
/// - `AZURE_CLIENT_SECRET`
/// - `AZURE_AUTHORITY_HOST`
/// - `AZURE_CLIENT_CERTIFICATE_PATH`
/// - `AZURE_FEDERATED_TOKEN_FILE`
///
/// Functions are provided for explicit configuration of credentials if that is preferred.
struct ARROW_EXPORT AzureOptions {
 /// \brief account name of the Azure Storage account.
 /// \brief The name of the Azure Storage Account being accessed.
 ///
 /// All service URLs will be constructed using this storage account name.
 /// `ConfigureAccountKeyCredential` assumes the user wants to authenticate
 /// this account.
 std::string account_name;

 /// \brief hostname[:port] of the Azure Blob Storage Service.
Expand DownExpand Up@@ -92,30 +107,30 @@ struct ARROW_EXPORT AzureOptions {

 private:
 enum class CredentialKind {
 kDefault,
 kAnonymous,
 kTokenCredential,
 kStorageSharedKeyCredential,
 } credential_kind_ = CredentialKind::kAnonymous;
 kStorageSharedKey,
 kClientSecret,
 kManagedIdentity,
 kWorkloadIdentity,

Comment on lines

112
 to 
115

@Tom-NewtonTom-NewtonJan 4, 2024

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think we really need to change this. I would rather just keep kTokenCredential to cover all the credentials that are based on https://github.com/Azure/azure-sdk-for-cpp/blob/e5e675440b44ace7d7a9e7bc303f877c06b59ea5/sdk/core/azure-core/inc/azure/core/credentials/credentials.hpp#L68
@felipecrvfelipecrvJan 4, 2024•

edited

Loading

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We need this to support Equals. Think of it as runtime type-information that describes which concrete implementation of TokenCredential is being used.
@felipecrvfelipecrvJan 4, 2024

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Besides that, we would need to make a distinction between kDefault and all the others kToken at least (to support the implicit default behavior). It's clearer if we then make a distinction on all of them.
@Tom-NewtonTom-NewtonJan 5, 2024

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think I would have done it differently but I don't feel strongly.
 } credential_kind_ = CredentialKind::kDefault;

 std::shared_ptr<Azure::Core::Credentials::TokenCredential> token_credential_;
 std::shared_ptr<Azure::Storage::StorageSharedKeyCredential>
 storage_shared_key_credential_;
 mutable std::shared_ptr<Azure::Core::Credentials::TokenCredential> token_credential_;
@koukouJan 4, 2024

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How about always creating Azure::Identity::DefaultAzureCredential instead of using mutable?
diff --git a/cpp/src/arrow/filesystem/azurefs.cc b/cpp/src/arrow/filesystem/azurefs.cc
index e98d56c73..5099cd25d 100644
--- a/cpp/src/arrow/filesystem/azurefs.cc+++ b/cpp/src/arrow/filesystem/azurefs.cc@@ -110,7 +110,6 @@ std::string AzureOptions::AccountDfsUrl(const std::string& account_name) const {
Status AzureOptions::ConfigureDefaultCredential() {
credential_kind_ = CredentialKind::kDefault;
- token_credential_ = std::make_shared<Azure::Identity::DefaultAzureCredential>();
return Status::OK();
}
@@ -160,10 +159,9 @@ Result<std::unique_ptr<Blobs::BlobServiceClient>> AzureOptions::MakeBlobServiceC
case CredentialKind::kAnonymous:
return std::make_unique<Blobs::BlobServiceClient>(AccountBlobUrl(account_name));
case CredentialKind::kDefault:
- if (!token_credential_) {- token_credential_ = std::make_shared<Azure::Identity::DefaultAzureCredential>();- }- [[fallthrough]];+ return std::make_unique<Blobs::BlobServiceClient>(+ AccountBlobUrl(account_name),+ std::make_shared<Azure::Identity::DefaultAzureCredential>());
case CredentialKind::kClientSecret:
case CredentialKind::kManagedIdentity:
case CredentialKind::kWorkloadIdentity:
@@ -186,10 +184,9 @@ AzureOptions::MakeDataLakeServiceClient() const {
return std::make_unique<DataLake::DataLakeServiceClient>(
AccountDfsUrl(account_name));
case CredentialKind::kDefault:
- if (!token_credential_) {- token_credential_ = std::make_shared<Azure::Identity::DefaultAzureCredential>();- }- [[fallthrough]];+ return std::make_unique<DataLake::DataLakeServiceClient>(+ AccountDfsUrl(account_name),+ std::make_shared<Azure::Identity::DefaultAzureCredential>());
case CredentialKind::kClientSecret:
case CredentialKind::kManagedIdentity:
case CredentialKind::kWorkloadIdentity:
diff --git a/cpp/src/arrow/filesystem/azurefs.h b/cpp/src/arrow/filesystem/azurefs.h
index 55f89ba47..ba612f799 100644
--- a/cpp/src/arrow/filesystem/azurefs.h+++ b/cpp/src/arrow/filesystem/azurefs.h@@ -117,7 +117,7 @@ struct ARROW_EXPORT AzureOptions {
std::shared_ptr<Azure::Storage::StorageSharedKeyCredential>
storage_shared_key_credential_;
- mutable std::shared_ptr<Azure::Core::Credentials::TokenCredential> token_credential_;+ std::shared_ptr<Azure::Core::Credentials::TokenCredential> token_credential_;
public:
AzureOptions();
@felipecrvfelipecrvJan 5, 2024

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Creating DefaultAzureCredential is a lot of non-trivial work: env vars, multiple allocations and probes. We can't assume it to be a cheap operation. mutable is a common solution to lazily-initialized class members and this one has a very well-defined behavior: it's set once, then it doesn't change at all anymore.
@felipecrvfelipecrvJan 5, 2024

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

And it's important that we do mutate it in ConfigureDefaultCredential because the user might want to explicitly initialize the credential immediately after doing something with the env variables used by the Azure SDK or right before unsetting the variables.

 public:
 AzureOptions();
 ~AzureOptions();

 Status ConfigureDefaultCredential();

 Status ConfigureManagedIdentityCredential(const std::string& client_id = std::string());

 Status ConfigureWorkloadIdentityCredential();

 Status ConfigureAnonymousCredential();
 Status ConfigureAccountKeyCredential(const std::string& account_key);

 Status ConfigureClientSecretCredential(const std::string& tenant_id,
 const std::string& client_id,
 const std::string& client_secret);
 Status ConfigureManagedIdentityCredential(const std::string& client_id = std::string());
 Status ConfigureWorkloadIdentityCredential();

 bool Equals(const AzureOptions& other) const;

Expand Down

30 changes: 23 additions & 7 deletions
cpp/src/arrow/filesystem/azurefs_test.cc

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -280,22 +280,38 @@ TEST(AzureFileSystem, InitializingFilesystemWithoutAccountNameFails) {
 ASSERT_RAISES(Invalid, AzureFileSystem::Make(options));
}

TEST(AzureFileSystem, InitializeFilesystemWithClientSecretCredential) {
TEST(AzureFileSystem, InitializeWithDefaultCredential) {
 AzureOptions options;
 options.account_name = "dummy-account-name";
 ARROW_EXPECT_OK(
 options.ConfigureClientSecretCredential("tenant_id", "client_id", "client_secret"));
 ARROW_EXPECT_OK(options.ConfigureDefaultCredential());
 EXPECT_OK_AND_ASSIGN(auto fs, AzureFileSystem::Make(options));
}

TEST(AzureFileSystem, InitializeFilesystemWithDefaultCredential) {
TEST(AzureFileSystem, InitializeWithDefaultCredentialImplicitly) {
 AzureOptions options;
 options.account_name = "dummy-account-name";
 ARROW_EXPECT_OK(options.ConfigureDefaultCredential());
 AzureOptions explictly_default_options;
 explictly_default_options.account_name = "dummy-account-name";
 ARROW_EXPECT_OK(explictly_default_options.ConfigureDefaultCredential());
 ASSERT_TRUE(options.Equals(explictly_default_options));
}

TEST(AzureFileSystem, InitializeWithAnonymousCredential) {
 AzureOptions options;
 options.account_name = "dummy-account-name";
 ARROW_EXPECT_OK(options.ConfigureAnonymousCredential());
 EXPECT_OK_AND_ASSIGN(auto fs, AzureFileSystem::Make(options));
}

TEST(AzureFileSystem, InitializeWithClientSecretCredential) {
 AzureOptions options;
 options.account_name = "dummy-account-name";
 ARROW_EXPECT_OK(
 options.ConfigureClientSecretCredential("tenant_id", "client_id", "client_secret"));
 EXPECT_OK_AND_ASSIGN(auto fs, AzureFileSystem::Make(options));
}

TEST(AzureFileSystem, InitializeFilesystemWithManagedIdentityCredential) {
TEST(AzureFileSystem, InitializeWithManagedIdentityCredential) {
 AzureOptions options;
 options.account_name = "dummy-account-name";
 ARROW_EXPECT_OK(options.ConfigureManagedIdentityCredential());
Expand All@@ -305,7 +321,7 @@ TEST(AzureFileSystem, InitializeFilesystemWithManagedIdentityCredential) {
 EXPECT_OK_AND_ASSIGN(fs, AzureFileSystem::Make(options));
}

Comment thread
felipecrv marked this conversation as resolved.


Outdated

TEST(AzureFileSystem, InitializeFilesystemWithWorkloadIdentityCredential) {
TEST(AzureFileSystem, InitializeWithWorkloadIdentityCredential) {
 AzureOptions options;
 options.account_name = "dummy-account-name";
 ARROW_EXPECT_OK(options.ConfigureWorkloadIdentityCredential());
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
GH-39449: [C++] Use default Azure credentials implicitly and support anonymous credentials explicitly#39450

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

felipecrv
merged 6 commits into

from

Jan 5, 2024
 Merged


GH-39449: [C++] Use default Azure credentials implicitly and support anonymous credentials explicitly
#39450
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
fdf5931

GH-39449: [C++] Use default Azure credentials implicitly and support …


felipecrv Jan 4, 2024
3e2adff

Add one enum entry per kind of credential configuration


felipecrv Jan 4, 2024
ea37431

Expand explanation of AzureOptions::account_name


felipecrv Jan 4, 2024
90d457d

Add test for ConfigureAnonymousCredential()


felipecrv Jan 4, 2024
32d1690

Explain authentication in the AzureOptions docstring


felipecrv Jan 4, 2024
3460eb7

Fix unit test


felipecrv Jan 5, 2024

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


62 changes: 43 additions & 19 deletions
cpp/src/arrow/filesystem/azurefs.cc

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -73,13 +73,17 @@ bool AzureOptions::Equals(const AzureOptions& other) const {
 return false;
 }
 switch (credential_kind_) {
 case CredentialKind::kDefault:
 case CredentialKind::kAnonymous:
 return true;
 case CredentialKind::kTokenCredential:
 return token_credential_ == other.token_credential_;
 case CredentialKind::kStorageSharedKeyCredential:
 case CredentialKind::kStorageSharedKey:
 return storage_shared_key_credential_->AccountName ==
 other.storage_shared_key_credential_->AccountName;
 case CredentialKind::kClientSecret:
 case CredentialKind::kManagedIdentity:
 case CredentialKind::kWorkloadIdentity:
 return token_credential_->GetCredentialName() ==
 other.token_credential_->GetCredentialName();
 }
 DCHECK(false);
 return false;
Expand DownExpand Up@@ -113,8 +117,19 @@ std::string AzureOptions::AccountDfsUrl(const std::string& account_name) const {
 return BuildBaseUrl(dfs_storage_scheme, dfs_storage_authority, account_name);
}

Status AzureOptions::ConfigureDefaultCredential() {
 credential_kind_ = CredentialKind::kDefault;
 token_credential_ = std::make_shared<Azure::Identity::DefaultAzureCredential>();
 return Status::OK();
}

Status AzureOptions::ConfigureAnonymousCredential() {
 credential_kind_ = CredentialKind::kAnonymous;
 return Status::OK();
}

Status AzureOptions::ConfigureAccountKeyCredential(const std::string& account_key) {
 credential_kind_ = CredentialKind::kStorageSharedKeyCredential;
 credential_kind_ = CredentialKind::kStorageSharedKey;
 if (account_name.empty()) {
 return Status::Invalid("AzureOptions doesn't contain a valid account name");
 }
Expand All@@ -126,27 +141,21 @@ Status AzureOptions::ConfigureAccountKeyCredential(const std::string& account_ke
Status AzureOptions::ConfigureClientSecretCredential(const std::string& tenant_id,
 const std::string& client_id,
 const std::string& client_secret) {
 credential_kind_ = CredentialKind::kTokenCredential;
 credential_kind_ = CredentialKind::kClientSecret;
 token_credential_ = std::make_shared<Azure::Identity::ClientSecretCredential>(
 tenant_id, client_id, client_secret);
 return Status::OK();
}

Status AzureOptions::ConfigureDefaultCredential() {
 credential_kind_ = CredentialKind::kTokenCredential;
 token_credential_ = std::make_shared<Azure::Identity::DefaultAzureCredential>();
 return Status::OK();
}

Status AzureOptions::ConfigureManagedIdentityCredential(const std::string& client_id) {
 credential_kind_ = CredentialKind::kTokenCredential;
 credential_kind_ = CredentialKind::kManagedIdentity;
 token_credential_ =
 std::make_shared<Azure::Identity::ManagedIdentityCredential>(client_id);
 return Status::OK();
}

Status AzureOptions::ConfigureWorkloadIdentityCredential() {
 credential_kind_ = CredentialKind::kTokenCredential;
 credential_kind_ = CredentialKind::kWorkloadIdentity;
 token_credential_ = std::make_shared<Azure::Identity::WorkloadIdentityCredential>();
 return Status::OK();
}
Expand All@@ -158,11 +167,18 @@ Result<std::unique_ptr<Blobs::BlobServiceClient>> AzureOptions::MakeBlobServiceC
 }
 switch (credential_kind_) {
 case CredentialKind::kAnonymous:
 break;
 case CredentialKind::kTokenCredential:
 return std::make_unique<Blobs::BlobServiceClient>(AccountBlobUrl(account_name));
 case CredentialKind::kDefault:
 if (!token_credential_) {
 token_credential_ = std::make_shared<Azure::Identity::DefaultAzureCredential>();
 }
 [[fallthrough]];
 case CredentialKind::kClientSecret:
 case CredentialKind::kManagedIdentity:
 case CredentialKind::kWorkloadIdentity:
 return std::make_unique<Blobs::BlobServiceClient>(AccountBlobUrl(account_name),
 token_credential_);
 case CredentialKind::kStorageSharedKeyCredential:
 case CredentialKind::kStorageSharedKey:
 return std::make_unique<Blobs::BlobServiceClient>(AccountBlobUrl(account_name),
 storage_shared_key_credential_);
 }
Expand All@@ -176,11 +192,19 @@ AzureOptions::MakeDataLakeServiceClient() const {
 }
 switch (credential_kind_) {
 case CredentialKind::kAnonymous:
 break;
 case CredentialKind::kTokenCredential:
 return std::make_unique<DataLake::DataLakeServiceClient>(
 AccountDfsUrl(account_name));
 case CredentialKind::kDefault:
 if (!token_credential_) {
 token_credential_ = std::make_shared<Azure::Identity::DefaultAzureCredential>();
 }
 [[fallthrough]];
 case CredentialKind::kClientSecret:
 case CredentialKind::kManagedIdentity:
 case CredentialKind::kWorkloadIdentity:
 return std::make_unique<DataLake::DataLakeServiceClient>(
 AccountDfsUrl(account_name), token_credential_);
 case CredentialKind::kStorageSharedKeyCredential:
 case CredentialKind::kStorageSharedKey:
 return std::make_unique<DataLake::DataLakeServiceClient>(
 AccountDfsUrl(account_name), storage_shared_key_credential_);
 }
Expand Down

37 changes: 26 additions & 11 deletions
cpp/src/arrow/filesystem/azurefs.h

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -47,8 +47,23 @@ namespace arrow::fs {
class TestAzureFileSystem;

/// Options for the AzureFileSystem implementation.
///
/// By default, authentication is handled by the Azure SDK's credential chain
/// which may read from multiple environment variables, such as:
/// - `AZURE_TENANT_ID`
/// - `AZURE_CLIENT_ID`
/// - `AZURE_CLIENT_SECRET`
/// - `AZURE_AUTHORITY_HOST`
/// - `AZURE_CLIENT_CERTIFICATE_PATH`
/// - `AZURE_FEDERATED_TOKEN_FILE`
///
/// Functions are provided for explicit configuration of credentials if that is preferred.
struct ARROW_EXPORT AzureOptions {
 /// \brief account name of the Azure Storage account.
 /// \brief The name of the Azure Storage Account being accessed.
 ///
 /// All service URLs will be constructed using this storage account name.
 /// `ConfigureAccountKeyCredential` assumes the user wants to authenticate
 /// this account.
 std::string account_name;

 /// \brief hostname[:port] of the Azure Blob Storage Service.
Expand DownExpand Up@@ -92,30 +107,30 @@ struct ARROW_EXPORT AzureOptions {

 private:
 enum class CredentialKind {
 kDefault,
 kAnonymous,
 kTokenCredential,
 kStorageSharedKeyCredential,
 } credential_kind_ = CredentialKind::kAnonymous;
 kStorageSharedKey,
 kClientSecret,
 kManagedIdentity,
 kWorkloadIdentity,

Comment on lines

112
 to 
115

@Tom-NewtonTom-NewtonJan 4, 2024

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think we really need to change this. I would rather just keep kTokenCredential to cover all the credentials that are based on https://github.com/Azure/azure-sdk-for-cpp/blob/e5e675440b44ace7d7a9e7bc303f877c06b59ea5/sdk/core/azure-core/inc/azure/core/credentials/credentials.hpp#L68
@felipecrvfelipecrvJan 4, 2024•

edited

Loading

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We need this to support Equals. Think of it as runtime type-information that describes which concrete implementation of TokenCredential is being used.
@felipecrvfelipecrvJan 4, 2024

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Besides that, we would need to make a distinction between kDefault and all the others kToken at least (to support the implicit default behavior). It's clearer if we then make a distinction on all of them.
@Tom-NewtonTom-NewtonJan 5, 2024

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think I would have done it differently but I don't feel strongly.
 } credential_kind_ = CredentialKind::kDefault;

 std::shared_ptr<Azure::Core::Credentials::TokenCredential> token_credential_;
 std::shared_ptr<Azure::Storage::StorageSharedKeyCredential>
 storage_shared_key_credential_;
 mutable std::shared_ptr<Azure::Core::Credentials::TokenCredential> token_credential_;
@koukouJan 4, 2024

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How about always creating Azure::Identity::DefaultAzureCredential instead of using mutable?
diff --git a/cpp/src/arrow/filesystem/azurefs.cc b/cpp/src/arrow/filesystem/azurefs.cc
index e98d56c73..5099cd25d 100644
--- a/cpp/src/arrow/filesystem/azurefs.cc+++ b/cpp/src/arrow/filesystem/azurefs.cc@@ -110,7 +110,6 @@ std::string AzureOptions::AccountDfsUrl(const std::string& account_name) const {
Status AzureOptions::ConfigureDefaultCredential() {
credential_kind_ = CredentialKind::kDefault;
- token_credential_ = std::make_shared<Azure::Identity::DefaultAzureCredential>();
return Status::OK();
}
@@ -160,10 +159,9 @@ Result<std::unique_ptr<Blobs::BlobServiceClient>> AzureOptions::MakeBlobServiceC
case CredentialKind::kAnonymous:
return std::make_unique<Blobs::BlobServiceClient>(AccountBlobUrl(account_name));
case CredentialKind::kDefault:
- if (!token_credential_) {- token_credential_ = std::make_shared<Azure::Identity::DefaultAzureCredential>();- }- [[fallthrough]];+ return std::make_unique<Blobs::BlobServiceClient>(+ AccountBlobUrl(account_name),+ std::make_shared<Azure::Identity::DefaultAzureCredential>());
case CredentialKind::kClientSecret:
case CredentialKind::kManagedIdentity:
case CredentialKind::kWorkloadIdentity:
@@ -186,10 +184,9 @@ AzureOptions::MakeDataLakeServiceClient() const {
return std::make_unique<DataLake::DataLakeServiceClient>(
AccountDfsUrl(account_name));
case CredentialKind::kDefault:
- if (!token_credential_) {- token_credential_ = std::make_shared<Azure::Identity::DefaultAzureCredential>();- }- [[fallthrough]];+ return std::make_unique<DataLake::DataLakeServiceClient>(+ AccountDfsUrl(account_name),+ std::make_shared<Azure::Identity::DefaultAzureCredential>());
case CredentialKind::kClientSecret:
case CredentialKind::kManagedIdentity:
case CredentialKind::kWorkloadIdentity:
diff --git a/cpp/src/arrow/filesystem/azurefs.h b/cpp/src/arrow/filesystem/azurefs.h
index 55f89ba47..ba612f799 100644
--- a/cpp/src/arrow/filesystem/azurefs.h+++ b/cpp/src/arrow/filesystem/azurefs.h@@ -117,7 +117,7 @@ struct ARROW_EXPORT AzureOptions {
std::shared_ptr<Azure::Storage::StorageSharedKeyCredential>
storage_shared_key_credential_;
- mutable std::shared_ptr<Azure::Core::Credentials::TokenCredential> token_credential_;+ std::shared_ptr<Azure::Core::Credentials::TokenCredential> token_credential_;
public:
AzureOptions();
@felipecrvfelipecrvJan 5, 2024

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Creating DefaultAzureCredential is a lot of non-trivial work: env vars, multiple allocations and probes. We can't assume it to be a cheap operation. mutable is a common solution to lazily-initialized class members and this one has a very well-defined behavior: it's set once, then it doesn't change at all anymore.
@felipecrvfelipecrvJan 5, 2024

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

And it's important that we do mutate it in ConfigureDefaultCredential because the user might want to explicitly initialize the credential immediately after doing something with the env variables used by the Azure SDK or right before unsetting the variables.

 public:
 AzureOptions();
 ~AzureOptions();

 Status ConfigureDefaultCredential();

 Status ConfigureManagedIdentityCredential(const std::string& client_id = std::string());

 Status ConfigureWorkloadIdentityCredential();

 Status ConfigureAnonymousCredential();
 Status ConfigureAccountKeyCredential(const std::string& account_key);

 Status ConfigureClientSecretCredential(const std::string& tenant_id,
 const std::string& client_id,
 const std::string& client_secret);
 Status ConfigureManagedIdentityCredential(const std::string& client_id = std::string());
 Status ConfigureWorkloadIdentityCredential();

 bool Equals(const AzureOptions& other) const;

Expand Down

30 changes: 23 additions & 7 deletions
cpp/src/arrow/filesystem/azurefs_test.cc

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -280,22 +280,38 @@ TEST(AzureFileSystem, InitializingFilesystemWithoutAccountNameFails) {
 ASSERT_RAISES(Invalid, AzureFileSystem::Make(options));
}

TEST(AzureFileSystem, InitializeFilesystemWithClientSecretCredential) {
TEST(AzureFileSystem, InitializeWithDefaultCredential) {
 AzureOptions options;
 options.account_name = "dummy-account-name";
 ARROW_EXPECT_OK(
 options.ConfigureClientSecretCredential("tenant_id", "client_id", "client_secret"));
 ARROW_EXPECT_OK(options.ConfigureDefaultCredential());
 EXPECT_OK_AND_ASSIGN(auto fs, AzureFileSystem::Make(options));
}

TEST(AzureFileSystem, InitializeFilesystemWithDefaultCredential) {
TEST(AzureFileSystem, InitializeWithDefaultCredentialImplicitly) {
 AzureOptions options;
 options.account_name = "dummy-account-name";
 ARROW_EXPECT_OK(options.ConfigureDefaultCredential());
 AzureOptions explictly_default_options;
 explictly_default_options.account_name = "dummy-account-name";
 ARROW_EXPECT_OK(explictly_default_options.ConfigureDefaultCredential());
 ASSERT_TRUE(options.Equals(explictly_default_options));
}

TEST(AzureFileSystem, InitializeWithAnonymousCredential) {
 AzureOptions options;
 options.account_name = "dummy-account-name";
 ARROW_EXPECT_OK(options.ConfigureAnonymousCredential());
 EXPECT_OK_AND_ASSIGN(auto fs, AzureFileSystem::Make(options));
}

TEST(AzureFileSystem, InitializeWithClientSecretCredential) {
 AzureOptions options;
 options.account_name = "dummy-account-name";
 ARROW_EXPECT_OK(
 options.ConfigureClientSecretCredential("tenant_id", "client_id", "client_secret"));
 EXPECT_OK_AND_ASSIGN(auto fs, AzureFileSystem::Make(options));
}

TEST(AzureFileSystem, InitializeFilesystemWithManagedIdentityCredential) {
TEST(AzureFileSystem, InitializeWithManagedIdentityCredential) {
 AzureOptions options;
 options.account_name = "dummy-account-name";
 ARROW_EXPECT_OK(options.ConfigureManagedIdentityCredential());
Expand All@@ -305,7 +321,7 @@ TEST(AzureFileSystem, InitializeFilesystemWithManagedIdentityCredential) {
 EXPECT_OK_AND_ASSIGN(fs, AzureFileSystem::Make(options));
}

Comment thread
felipecrv marked this conversation as resolved.


Outdated

TEST(AzureFileSystem, InitializeFilesystemWithWorkloadIdentityCredential) {
TEST(AzureFileSystem, InitializeWithWorkloadIdentityCredential) {
 AzureOptions options;
 options.account_name = "dummy-account-name";
 ARROW_EXPECT_OK(options.ConfigureWorkloadIdentityCredential());
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
GH-39449: [C++] Use default Azure credentials implicitly and support anonymous credentials explicitly#39450

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

felipecrv
merged 6 commits into

from

Jan 5, 2024
 Merged


GH-39449: [C++] Use default Azure credentials implicitly and support anonymous credentials explicitly
#39450
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
fdf5931

GH-39449: [C++] Use default Azure credentials implicitly and support …


felipecrv Jan 4, 2024
3e2adff

Add one enum entry per kind of credential configuration


felipecrv Jan 4, 2024
ea37431

Expand explanation of AzureOptions::account_name


felipecrv Jan 4, 2024
90d457d

Add test for ConfigureAnonymousCredential()


felipecrv Jan 4, 2024
32d1690

Explain authentication in the AzureOptions docstring


felipecrv Jan 4, 2024
3460eb7

Fix unit test


felipecrv Jan 5, 2024

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


62 changes: 43 additions & 19 deletions
cpp/src/arrow/filesystem/azurefs.cc

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -73,13 +73,17 @@ bool AzureOptions::Equals(const AzureOptions& other) const {
 return false;
 }
 switch (credential_kind_) {
 case CredentialKind::kDefault:
 case CredentialKind::kAnonymous:
 return true;
 case CredentialKind::kTokenCredential:
 return token_credential_ == other.token_credential_;
 case CredentialKind::kStorageSharedKeyCredential:
 case CredentialKind::kStorageSharedKey:
 return storage_shared_key_credential_->AccountName ==
 other.storage_shared_key_credential_->AccountName;
 case CredentialKind::kClientSecret:
 case CredentialKind::kManagedIdentity:
 case CredentialKind::kWorkloadIdentity:
 return token_credential_->GetCredentialName() ==
 other.token_credential_->GetCredentialName();
 }
 DCHECK(false);
 return false;
Expand DownExpand Up@@ -113,8 +117,19 @@ std::string AzureOptions::AccountDfsUrl(const std::string& account_name) const {
 return BuildBaseUrl(dfs_storage_scheme, dfs_storage_authority, account_name);
}

Status AzureOptions::ConfigureDefaultCredential() {
 credential_kind_ = CredentialKind::kDefault;
 token_credential_ = std::make_shared<Azure::Identity::DefaultAzureCredential>();
 return Status::OK();
}

Status AzureOptions::ConfigureAnonymousCredential() {
 credential_kind_ = CredentialKind::kAnonymous;
 return Status::OK();
}

Status AzureOptions::ConfigureAccountKeyCredential(const std::string& account_key) {
 credential_kind_ = CredentialKind::kStorageSharedKeyCredential;
 credential_kind_ = CredentialKind::kStorageSharedKey;
 if (account_name.empty()) {
 return Status::Invalid("AzureOptions doesn't contain a valid account name");
 }
Expand All@@ -126,27 +141,21 @@ Status AzureOptions::ConfigureAccountKeyCredential(const std::string& account_ke
Status AzureOptions::ConfigureClientSecretCredential(const std::string& tenant_id,
 const std::string& client_id,
 const std::string& client_secret) {
 credential_kind_ = CredentialKind::kTokenCredential;
 credential_kind_ = CredentialKind::kClientSecret;
 token_credential_ = std::make_shared<Azure::Identity::ClientSecretCredential>(
 tenant_id, client_id, client_secret);
 return Status::OK();
}

Status AzureOptions::ConfigureDefaultCredential() {
 credential_kind_ = CredentialKind::kTokenCredential;
 token_credential_ = std::make_shared<Azure::Identity::DefaultAzureCredential>();
 return Status::OK();
}

Status AzureOptions::ConfigureManagedIdentityCredential(const std::string& client_id) {
 credential_kind_ = CredentialKind::kTokenCredential;
 credential_kind_ = CredentialKind::kManagedIdentity;
 token_credential_ =
 std::make_shared<Azure::Identity::ManagedIdentityCredential>(client_id);
 return Status::OK();
}

Status AzureOptions::ConfigureWorkloadIdentityCredential() {
 credential_kind_ = CredentialKind::kTokenCredential;
 credential_kind_ = CredentialKind::kWorkloadIdentity;
 token_credential_ = std::make_shared<Azure::Identity::WorkloadIdentityCredential>();
 return Status::OK();
}
Expand All@@ -158,11 +167,18 @@ Result<std::unique_ptr<Blobs::BlobServiceClient>> AzureOptions::MakeBlobServiceC
 }
 switch (credential_kind_) {
 case CredentialKind::kAnonymous:
 break;
 case CredentialKind::kTokenCredential:
 return std::make_unique<Blobs::BlobServiceClient>(AccountBlobUrl(account_name));
 case CredentialKind::kDefault:
 if (!token_credential_) {
 token_credential_ = std::make_shared<Azure::Identity::DefaultAzureCredential>();
 }
 [[fallthrough]];
 case CredentialKind::kClientSecret:
 case CredentialKind::kManagedIdentity:
 case CredentialKind::kWorkloadIdentity:
 return std::make_unique<Blobs::BlobServiceClient>(AccountBlobUrl(account_name),
 token_credential_);
 case CredentialKind::kStorageSharedKeyCredential:
 case CredentialKind::kStorageSharedKey:
 return std::make_unique<Blobs::BlobServiceClient>(AccountBlobUrl(account_name),
 storage_shared_key_credential_);
 }
Expand All@@ -176,11 +192,19 @@ AzureOptions::MakeDataLakeServiceClient() const {
 }
 switch (credential_kind_) {
 case CredentialKind::kAnonymous:
 break;
 case CredentialKind::kTokenCredential:
 return std::make_unique<DataLake::DataLakeServiceClient>(
 AccountDfsUrl(account_name));
 case CredentialKind::kDefault:
 if (!token_credential_) {
 token_credential_ = std::make_shared<Azure::Identity::DefaultAzureCredential>();
 }
 [[fallthrough]];
 case CredentialKind::kClientSecret:
 case CredentialKind::kManagedIdentity:
 case CredentialKind::kWorkloadIdentity:
 return std::make_unique<DataLake::DataLakeServiceClient>(
 AccountDfsUrl(account_name), token_credential_);
 case CredentialKind::kStorageSharedKeyCredential:
 case CredentialKind::kStorageSharedKey:
 return std::make_unique<DataLake::DataLakeServiceClient>(
 AccountDfsUrl(account_name), storage_shared_key_credential_);
 }
Expand Down

37 changes: 26 additions & 11 deletions
cpp/src/arrow/filesystem/azurefs.h

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -47,8 +47,23 @@ namespace arrow::fs {
class TestAzureFileSystem;

/// Options for the AzureFileSystem implementation.
///
/// By default, authentication is handled by the Azure SDK's credential chain
/// which may read from multiple environment variables, such as:
/// - `AZURE_TENANT_ID`
/// - `AZURE_CLIENT_ID`
/// - `AZURE_CLIENT_SECRET`
/// - `AZURE_AUTHORITY_HOST`
/// - `AZURE_CLIENT_CERTIFICATE_PATH`
/// - `AZURE_FEDERATED_TOKEN_FILE`
///
/// Functions are provided for explicit configuration of credentials if that is preferred.
struct ARROW_EXPORT AzureOptions {
 /// \brief account name of the Azure Storage account.
 /// \brief The name of the Azure Storage Account being accessed.
 ///
 /// All service URLs will be constructed using this storage account name.
 /// `ConfigureAccountKeyCredential` assumes the user wants to authenticate
 /// this account.
 std::string account_name;

 /// \brief hostname[:port] of the Azure Blob Storage Service.
Expand DownExpand Up@@ -92,30 +107,30 @@ struct ARROW_EXPORT AzureOptions {

 private:
 enum class CredentialKind {
 kDefault,
 kAnonymous,
 kTokenCredential,
 kStorageSharedKeyCredential,
 } credential_kind_ = CredentialKind::kAnonymous;
 kStorageSharedKey,
 kClientSecret,
 kManagedIdentity,
 kWorkloadIdentity,

Comment on lines

112
 to 
115

@Tom-NewtonTom-NewtonJan 4, 2024

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think we really need to change this. I would rather just keep kTokenCredential to cover all the credentials that are based on https://github.com/Azure/azure-sdk-for-cpp/blob/e5e675440b44ace7d7a9e7bc303f877c06b59ea5/sdk/core/azure-core/inc/azure/core/credentials/credentials.hpp#L68
@felipecrvfelipecrvJan 4, 2024•

edited

Loading

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We need this to support Equals. Think of it as runtime type-information that describes which concrete implementation of TokenCredential is being used.
@felipecrvfelipecrvJan 4, 2024

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Besides that, we would need to make a distinction between kDefault and all the others kToken at least (to support the implicit default behavior). It's clearer if we then make a distinction on all of them.
@Tom-NewtonTom-NewtonJan 5, 2024

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think I would have done it differently but I don't feel strongly.
 } credential_kind_ = CredentialKind::kDefault;

 std::shared_ptr<Azure::Core::Credentials::TokenCredential> token_credential_;
 std::shared_ptr<Azure::Storage::StorageSharedKeyCredential>
 storage_shared_key_credential_;
 mutable std::shared_ptr<Azure::Core::Credentials::TokenCredential> token_credential_;
@koukouJan 4, 2024

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How about always creating Azure::Identity::DefaultAzureCredential instead of using mutable?
diff --git a/cpp/src/arrow/filesystem/azurefs.cc b/cpp/src/arrow/filesystem/azurefs.cc
index e98d56c73..5099cd25d 100644
--- a/cpp/src/arrow/filesystem/azurefs.cc+++ b/cpp/src/arrow/filesystem/azurefs.cc@@ -110,7 +110,6 @@ std::string AzureOptions::AccountDfsUrl(const std::string& account_name) const {
Status AzureOptions::ConfigureDefaultCredential() {
credential_kind_ = CredentialKind::kDefault;
- token_credential_ = std::make_shared<Azure::Identity::DefaultAzureCredential>();
return Status::OK();
}
@@ -160,10 +159,9 @@ Result<std::unique_ptr<Blobs::BlobServiceClient>> AzureOptions::MakeBlobServiceC
case CredentialKind::kAnonymous:
return std::make_unique<Blobs::BlobServiceClient>(AccountBlobUrl(account_name));
case CredentialKind::kDefault:
- if (!token_credential_) {- token_credential_ = std::make_shared<Azure::Identity::DefaultAzureCredential>();- }- [[fallthrough]];+ return std::make_unique<Blobs::BlobServiceClient>(+ AccountBlobUrl(account_name),+ std::make_shared<Azure::Identity::DefaultAzureCredential>());
case CredentialKind::kClientSecret:
case CredentialKind::kManagedIdentity:
case CredentialKind::kWorkloadIdentity:
@@ -186,10 +184,9 @@ AzureOptions::MakeDataLakeServiceClient() const {
return std::make_unique<DataLake::DataLakeServiceClient>(
AccountDfsUrl(account_name));
case CredentialKind::kDefault:
- if (!token_credential_) {- token_credential_ = std::make_shared<Azure::Identity::DefaultAzureCredential>();- }- [[fallthrough]];+ return std::make_unique<DataLake::DataLakeServiceClient>(+ AccountDfsUrl(account_name),+ std::make_shared<Azure::Identity::DefaultAzureCredential>());
case CredentialKind::kClientSecret:
case CredentialKind::kManagedIdentity:
case CredentialKind::kWorkloadIdentity:
diff --git a/cpp/src/arrow/filesystem/azurefs.h b/cpp/src/arrow/filesystem/azurefs.h
index 55f89ba47..ba612f799 100644
--- a/cpp/src/arrow/filesystem/azurefs.h+++ b/cpp/src/arrow/filesystem/azurefs.h@@ -117,7 +117,7 @@ struct ARROW_EXPORT AzureOptions {
std::shared_ptr<Azure::Storage::StorageSharedKeyCredential>
storage_shared_key_credential_;
- mutable std::shared_ptr<Azure::Core::Credentials::TokenCredential> token_credential_;+ std::shared_ptr<Azure::Core::Credentials::TokenCredential> token_credential_;
public:
AzureOptions();
@felipecrvfelipecrvJan 5, 2024

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Creating DefaultAzureCredential is a lot of non-trivial work: env vars, multiple allocations and probes. We can't assume it to be a cheap operation. mutable is a common solution to lazily-initialized class members and this one has a very well-defined behavior: it's set once, then it doesn't change at all anymore.
@felipecrvfelipecrvJan 5, 2024

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

And it's important that we do mutate it in ConfigureDefaultCredential because the user might want to explicitly initialize the credential immediately after doing something with the env variables used by the Azure SDK or right before unsetting the variables.

 public:
 AzureOptions();
 ~AzureOptions();

 Status ConfigureDefaultCredential();

 Status ConfigureManagedIdentityCredential(const std::string& client_id = std::string());

 Status ConfigureWorkloadIdentityCredential();

 Status ConfigureAnonymousCredential();
 Status ConfigureAccountKeyCredential(const std::string& account_key);

 Status ConfigureClientSecretCredential(const std::string& tenant_id,
 const std::string& client_id,
 const std::string& client_secret);
 Status ConfigureManagedIdentityCredential(const std::string& client_id = std::string());
 Status ConfigureWorkloadIdentityCredential();

 bool Equals(const AzureOptions& other) const;

Expand Down

30 changes: 23 additions & 7 deletions
cpp/src/arrow/filesystem/azurefs_test.cc

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -280,22 +280,38 @@ TEST(AzureFileSystem, InitializingFilesystemWithoutAccountNameFails) {
 ASSERT_RAISES(Invalid, AzureFileSystem::Make(options));
}

TEST(AzureFileSystem, InitializeFilesystemWithClientSecretCredential) {
TEST(AzureFileSystem, InitializeWithDefaultCredential) {
 AzureOptions options;
 options.account_name = "dummy-account-name";
 ARROW_EXPECT_OK(
 options.ConfigureClientSecretCredential("tenant_id", "client_id", "client_secret"));
 ARROW_EXPECT_OK(options.ConfigureDefaultCredential());
 EXPECT_OK_AND_ASSIGN(auto fs, AzureFileSystem::Make(options));
}

TEST(AzureFileSystem, InitializeFilesystemWithDefaultCredential) {
TEST(AzureFileSystem, InitializeWithDefaultCredentialImplicitly) {
 AzureOptions options;
 options.account_name = "dummy-account-name";
 ARROW_EXPECT_OK(options.ConfigureDefaultCredential());
 AzureOptions explictly_default_options;
 explictly_default_options.account_name = "dummy-account-name";
 ARROW_EXPECT_OK(explictly_default_options.ConfigureDefaultCredential());
 ASSERT_TRUE(options.Equals(explictly_default_options));
}

TEST(AzureFileSystem, InitializeWithAnonymousCredential) {
 AzureOptions options;
 options.account_name = "dummy-account-name";
 ARROW_EXPECT_OK(options.ConfigureAnonymousCredential());
 EXPECT_OK_AND_ASSIGN(auto fs, AzureFileSystem::Make(options));
}

TEST(AzureFileSystem, InitializeWithClientSecretCredential) {
 AzureOptions options;
 options.account_name = "dummy-account-name";
 ARROW_EXPECT_OK(
 options.ConfigureClientSecretCredential("tenant_id", "client_id", "client_secret"));
 EXPECT_OK_AND_ASSIGN(auto fs, AzureFileSystem::Make(options));
}

TEST(AzureFileSystem, InitializeFilesystemWithManagedIdentityCredential) {
TEST(AzureFileSystem, InitializeWithManagedIdentityCredential) {
 AzureOptions options;
 options.account_name = "dummy-account-name";
 ARROW_EXPECT_OK(options.ConfigureManagedIdentityCredential());
Expand All@@ -305,7 +321,7 @@ TEST(AzureFileSystem, InitializeFilesystemWithManagedIdentityCredential) {
 EXPECT_OK_AND_ASSIGN(fs, AzureFileSystem::Make(options));
}

Comment thread
felipecrv marked this conversation as resolved.


Outdated

TEST(AzureFileSystem, InitializeFilesystemWithWorkloadIdentityCredential) {
TEST(AzureFileSystem, InitializeWithWorkloadIdentityCredential) {
 AzureOptions options;
 options.account_name = "dummy-account-name";
 ARROW_EXPECT_OK(options.ConfigureWorkloadIdentityCredential());
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
GH-39449: [C++] Use default Azure credentials implicitly and support anonymous credentials explicitly#39450

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

felipecrv
merged 6 commits into

from

Jan 5, 2024
 Merged


GH-39449: [C++] Use default Azure credentials implicitly and support anonymous credentials explicitly
#39450
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
fdf5931

GH-39449: [C++] Use default Azure credentials implicitly and support …


felipecrv Jan 4, 2024
3e2adff

Add one enum entry per kind of credential configuration


felipecrv Jan 4, 2024
ea37431

Expand explanation of AzureOptions::account_name


felipecrv Jan 4, 2024
90d457d

Add test for ConfigureAnonymousCredential()


felipecrv Jan 4, 2024
32d1690

Explain authentication in the AzureOptions docstring


felipecrv Jan 4, 2024
3460eb7

Fix unit test


felipecrv Jan 5, 2024

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


62 changes: 43 additions & 19 deletions
cpp/src/arrow/filesystem/azurefs.cc

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -73,13 +73,17 @@ bool AzureOptions::Equals(const AzureOptions& other) const {
 return false;
 }
 switch (credential_kind_) {
 case CredentialKind::kDefault:
 case CredentialKind::kAnonymous:
 return true;
 case CredentialKind::kTokenCredential:
 return token_credential_ == other.token_credential_;
 case CredentialKind::kStorageSharedKeyCredential:
 case CredentialKind::kStorageSharedKey:
 return storage_shared_key_credential_->AccountName ==
 other.storage_shared_key_credential_->AccountName;
 case CredentialKind::kClientSecret:
 case CredentialKind::kManagedIdentity:
 case CredentialKind::kWorkloadIdentity:
 return token_credential_->GetCredentialName() ==
 other.token_credential_->GetCredentialName();
 }
 DCHECK(false);
 return false;
Expand DownExpand Up@@ -113,8 +117,19 @@ std::string AzureOptions::AccountDfsUrl(const std::string& account_name) const {
 return BuildBaseUrl(dfs_storage_scheme, dfs_storage_authority, account_name);
}

Status AzureOptions::ConfigureDefaultCredential() {
 credential_kind_ = CredentialKind::kDefault;
 token_credential_ = std::make_shared<Azure::Identity::DefaultAzureCredential>();
 return Status::OK();
}

Status AzureOptions::ConfigureAnonymousCredential() {
 credential_kind_ = CredentialKind::kAnonymous;
 return Status::OK();
}

Status AzureOptions::ConfigureAccountKeyCredential(const std::string& account_key) {
 credential_kind_ = CredentialKind::kStorageSharedKeyCredential;
 credential_kind_ = CredentialKind::kStorageSharedKey;
 if (account_name.empty()) {
 return Status::Invalid("AzureOptions doesn't contain a valid account name");
 }
Expand All@@ -126,27 +141,21 @@ Status AzureOptions::ConfigureAccountKeyCredential(const std::string& account_ke
Status AzureOptions::ConfigureClientSecretCredential(const std::string& tenant_id,
 const std::string& client_id,
 const std::string& client_secret) {
 credential_kind_ = CredentialKind::kTokenCredential;
 credential_kind_ = CredentialKind::kClientSecret;
 token_credential_ = std::make_shared<Azure::Identity::ClientSecretCredential>(
 tenant_id, client_id, client_secret);
 return Status::OK();
}

Status AzureOptions::ConfigureDefaultCredential() {
 credential_kind_ = CredentialKind::kTokenCredential;
 token_credential_ = std::make_shared<Azure::Identity::DefaultAzureCredential>();
 return Status::OK();
}

Status AzureOptions::ConfigureManagedIdentityCredential(const std::string& client_id) {
 credential_kind_ = CredentialKind::kTokenCredential;
 credential_kind_ = CredentialKind::kManagedIdentity;
 token_credential_ =
 std::make_shared<Azure::Identity::ManagedIdentityCredential>(client_id);
 return Status::OK();
}

Status AzureOptions::ConfigureWorkloadIdentityCredential() {
 credential_kind_ = CredentialKind::kTokenCredential;
 credential_kind_ = CredentialKind::kWorkloadIdentity;
 token_credential_ = std::make_shared<Azure::Identity::WorkloadIdentityCredential>();
 return Status::OK();
}
Expand All@@ -158,11 +167,18 @@ Result<std::unique_ptr<Blobs::BlobServiceClient>> AzureOptions::MakeBlobServiceC
 }
 switch (credential_kind_) {
 case CredentialKind::kAnonymous:
 break;
 case CredentialKind::kTokenCredential:
 return std::make_unique<Blobs::BlobServiceClient>(AccountBlobUrl(account_name));
 case CredentialKind::kDefault:
 if (!token_credential_) {
 token_credential_ = std::make_shared<Azure::Identity::DefaultAzureCredential>();
 }
 [[fallthrough]];
 case CredentialKind::kClientSecret:
 case CredentialKind::kManagedIdentity:
 case CredentialKind::kWorkloadIdentity:
 return std::make_unique<Blobs::BlobServiceClient>(AccountBlobUrl(account_name),
 token_credential_);
 case CredentialKind::kStorageSharedKeyCredential:
 case CredentialKind::kStorageSharedKey:
 return std::make_unique<Blobs::BlobServiceClient>(AccountBlobUrl(account_name),
 storage_shared_key_credential_);
 }
Expand All@@ -176,11 +192,19 @@ AzureOptions::MakeDataLakeServiceClient() const {
 }
 switch (credential_kind_) {
 case CredentialKind::kAnonymous:
 break;
 case CredentialKind::kTokenCredential:
 return std::make_unique<DataLake::DataLakeServiceClient>(
 AccountDfsUrl(account_name));
 case CredentialKind::kDefault:
 if (!token_credential_) {
 token_credential_ = std::make_shared<Azure::Identity::DefaultAzureCredential>();
 }
 [[fallthrough]];
 case CredentialKind::kClientSecret:
 case CredentialKind::kManagedIdentity:
 case CredentialKind::kWorkloadIdentity:
 return std::make_unique<DataLake::DataLakeServiceClient>(
 AccountDfsUrl(account_name), token_credential_);
 case CredentialKind::kStorageSharedKeyCredential:
 case CredentialKind::kStorageSharedKey:
 return std::make_unique<DataLake::DataLakeServiceClient>(
 AccountDfsUrl(account_name), storage_shared_key_credential_);
 }
Expand Down

37 changes: 26 additions & 11 deletions
cpp/src/arrow/filesystem/azurefs.h

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -47,8 +47,23 @@ namespace arrow::fs {
class TestAzureFileSystem;

/// Options for the AzureFileSystem implementation.
///
/// By default, authentication is handled by the Azure SDK's credential chain
/// which may read from multiple environment variables, such as:
/// - `AZURE_TENANT_ID`
/// - `AZURE_CLIENT_ID`
/// - `AZURE_CLIENT_SECRET`
/// - `AZURE_AUTHORITY_HOST`
/// - `AZURE_CLIENT_CERTIFICATE_PATH`
/// - `AZURE_FEDERATED_TOKEN_FILE`
///
/// Functions are provided for explicit configuration of credentials if that is preferred.
struct ARROW_EXPORT AzureOptions {
 /// \brief account name of the Azure Storage account.
 /// \brief The name of the Azure Storage Account being accessed.
 ///
 /// All service URLs will be constructed using this storage account name.
 /// `ConfigureAccountKeyCredential` assumes the user wants to authenticate
 /// this account.
 std::string account_name;

 /// \brief hostname[:port] of the Azure Blob Storage Service.
Expand DownExpand Up@@ -92,30 +107,30 @@ struct ARROW_EXPORT AzureOptions {

 private:
 enum class CredentialKind {
 kDefault,
 kAnonymous,
 kTokenCredential,
 kStorageSharedKeyCredential,
 } credential_kind_ = CredentialKind::kAnonymous;
 kStorageSharedKey,
 kClientSecret,
 kManagedIdentity,
 kWorkloadIdentity,

Comment on lines

112
 to 
115

@Tom-NewtonTom-NewtonJan 4, 2024

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think we really need to change this. I would rather just keep kTokenCredential to cover all the credentials that are based on https://github.com/Azure/azure-sdk-for-cpp/blob/e5e675440b44ace7d7a9e7bc303f877c06b59ea5/sdk/core/azure-core/inc/azure/core/credentials/credentials.hpp#L68
@felipecrvfelipecrvJan 4, 2024•

edited

Loading

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We need this to support Equals. Think of it as runtime type-information that describes which concrete implementation of TokenCredential is being used.
@felipecrvfelipecrvJan 4, 2024

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Besides that, we would need to make a distinction between kDefault and all the others kToken at least (to support the implicit default behavior). It's clearer if we then make a distinction on all of them.
@Tom-NewtonTom-NewtonJan 5, 2024

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think I would have done it differently but I don't feel strongly.
 } credential_kind_ = CredentialKind::kDefault;

 std::shared_ptr<Azure::Core::Credentials::TokenCredential> token_credential_;
 std::shared_ptr<Azure::Storage::StorageSharedKeyCredential>
 storage_shared_key_credential_;
 mutable std::shared_ptr<Azure::Core::Credentials::TokenCredential> token_credential_;
@koukouJan 4, 2024

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How about always creating Azure::Identity::DefaultAzureCredential instead of using mutable?
diff --git a/cpp/src/arrow/filesystem/azurefs.cc b/cpp/src/arrow/filesystem/azurefs.cc
index e98d56c73..5099cd25d 100644
--- a/cpp/src/arrow/filesystem/azurefs.cc+++ b/cpp/src/arrow/filesystem/azurefs.cc@@ -110,7 +110,6 @@ std::string AzureOptions::AccountDfsUrl(const std::string& account_name) const {
Status AzureOptions::ConfigureDefaultCredential() {
credential_kind_ = CredentialKind::kDefault;
- token_credential_ = std::make_shared<Azure::Identity::DefaultAzureCredential>();
return Status::OK();
}
@@ -160,10 +159,9 @@ Result<std::unique_ptr<Blobs::BlobServiceClient>> AzureOptions::MakeBlobServiceC
case CredentialKind::kAnonymous:
return std::make_unique<Blobs::BlobServiceClient>(AccountBlobUrl(account_name));
case CredentialKind::kDefault:
- if (!token_credential_) {- token_credential_ = std::make_shared<Azure::Identity::DefaultAzureCredential>();- }- [[fallthrough]];+ return std::make_unique<Blobs::BlobServiceClient>(+ AccountBlobUrl(account_name),+ std::make_shared<Azure::Identity::DefaultAzureCredential>());
case CredentialKind::kClientSecret:
case CredentialKind::kManagedIdentity:
case CredentialKind::kWorkloadIdentity:
@@ -186,10 +184,9 @@ AzureOptions::MakeDataLakeServiceClient() const {
return std::make_unique<DataLake::DataLakeServiceClient>(
AccountDfsUrl(account_name));
case CredentialKind::kDefault:
- if (!token_credential_) {- token_credential_ = std::make_shared<Azure::Identity::DefaultAzureCredential>();- }- [[fallthrough]];+ return std::make_unique<DataLake::DataLakeServiceClient>(+ AccountDfsUrl(account_name),+ std::make_shared<Azure::Identity::DefaultAzureCredential>());
case CredentialKind::kClientSecret:
case CredentialKind::kManagedIdentity:
case CredentialKind::kWorkloadIdentity:
diff --git a/cpp/src/arrow/filesystem/azurefs.h b/cpp/src/arrow/filesystem/azurefs.h
index 55f89ba47..ba612f799 100644
--- a/cpp/src/arrow/filesystem/azurefs.h+++ b/cpp/src/arrow/filesystem/azurefs.h@@ -117,7 +117,7 @@ struct ARROW_EXPORT AzureOptions {
std::shared_ptr<Azure::Storage::StorageSharedKeyCredential>
storage_shared_key_credential_;
- mutable std::shared_ptr<Azure::Core::Credentials::TokenCredential> token_credential_;+ std::shared_ptr<Azure::Core::Credentials::TokenCredential> token_credential_;
public:
AzureOptions();
@felipecrvfelipecrvJan 5, 2024

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Creating DefaultAzureCredential is a lot of non-trivial work: env vars, multiple allocations and probes. We can't assume it to be a cheap operation. mutable is a common solution to lazily-initialized class members and this one has a very well-defined behavior: it's set once, then it doesn't change at all anymore.
@felipecrvfelipecrvJan 5, 2024

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

And it's important that we do mutate it in ConfigureDefaultCredential because the user might want to explicitly initialize the credential immediately after doing something with the env variables used by the Azure SDK or right before unsetting the variables.

 public:
 AzureOptions();
 ~AzureOptions();

 Status ConfigureDefaultCredential();

 Status ConfigureManagedIdentityCredential(const std::string& client_id = std::string());

 Status ConfigureWorkloadIdentityCredential();

 Status ConfigureAnonymousCredential();
 Status ConfigureAccountKeyCredential(const std::string& account_key);

 Status ConfigureClientSecretCredential(const std::string& tenant_id,
 const std::string& client_id,
 const std::string& client_secret);
 Status ConfigureManagedIdentityCredential(const std::string& client_id = std::string());
 Status ConfigureWorkloadIdentityCredential();

 bool Equals(const AzureOptions& other) const;

Expand Down

30 changes: 23 additions & 7 deletions
cpp/src/arrow/filesystem/azurefs_test.cc

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -280,22 +280,38 @@ TEST(AzureFileSystem, InitializingFilesystemWithoutAccountNameFails) {
 ASSERT_RAISES(Invalid, AzureFileSystem::Make(options));
}

TEST(AzureFileSystem, InitializeFilesystemWithClientSecretCredential) {
TEST(AzureFileSystem, InitializeWithDefaultCredential) {
 AzureOptions options;
 options.account_name = "dummy-account-name";
 ARROW_EXPECT_OK(
 options.ConfigureClientSecretCredential("tenant_id", "client_id", "client_secret"));
 ARROW_EXPECT_OK(options.ConfigureDefaultCredential());
 EXPECT_OK_AND_ASSIGN(auto fs, AzureFileSystem::Make(options));
}

TEST(AzureFileSystem, InitializeFilesystemWithDefaultCredential) {
TEST(AzureFileSystem, InitializeWithDefaultCredentialImplicitly) {
 AzureOptions options;
 options.account_name = "dummy-account-name";
 ARROW_EXPECT_OK(options.ConfigureDefaultCredential());
 AzureOptions explictly_default_options;
 explictly_default_options.account_name = "dummy-account-name";
 ARROW_EXPECT_OK(explictly_default_options.ConfigureDefaultCredential());
 ASSERT_TRUE(options.Equals(explictly_default_options));
}

TEST(AzureFileSystem, InitializeWithAnonymousCredential) {
 AzureOptions options;
 options.account_name = "dummy-account-name";
 ARROW_EXPECT_OK(options.ConfigureAnonymousCredential());
 EXPECT_OK_AND_ASSIGN(auto fs, AzureFileSystem::Make(options));
}

TEST(AzureFileSystem, InitializeWithClientSecretCredential) {
 AzureOptions options;
 options.account_name = "dummy-account-name";
 ARROW_EXPECT_OK(
 options.ConfigureClientSecretCredential("tenant_id", "client_id", "client_secret"));
 EXPECT_OK_AND_ASSIGN(auto fs, AzureFileSystem::Make(options));
}

TEST(AzureFileSystem, InitializeFilesystemWithManagedIdentityCredential) {
TEST(AzureFileSystem, InitializeWithManagedIdentityCredential) {
 AzureOptions options;
 options.account_name = "dummy-account-name";
 ARROW_EXPECT_OK(options.ConfigureManagedIdentityCredential());
Expand All@@ -305,7 +321,7 @@ TEST(AzureFileSystem, InitializeFilesystemWithManagedIdentityCredential) {
 EXPECT_OK_AND_ASSIGN(fs, AzureFileSystem::Make(options));
}

Comment thread
felipecrv marked this conversation as resolved.


Outdated

TEST(AzureFileSystem, InitializeFilesystemWithWorkloadIdentityCredential) {
TEST(AzureFileSystem, InitializeWithWorkloadIdentityCredential) {
 AzureOptions options;
 options.account_name = "dummy-account-name";
 ARROW_EXPECT_OK(options.ConfigureWorkloadIdentityCredential());
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
GH-39449: [C++] Use default Azure credentials implicitly and support anonymous credentials explicitly#39450

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

felipecrv
merged 6 commits into

from

Jan 5, 2024
 Merged


GH-39449: [C++] Use default Azure credentials implicitly and support anonymous credentials explicitly
#39450
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
fdf5931

GH-39449: [C++] Use default Azure credentials implicitly and support …


felipecrv Jan 4, 2024
3e2adff

Add one enum entry per kind of credential configuration


felipecrv Jan 4, 2024
ea37431

Expand explanation of AzureOptions::account_name


felipecrv Jan 4, 2024
90d457d

Add test for ConfigureAnonymousCredential()


felipecrv Jan 4, 2024
32d1690

Explain authentication in the AzureOptions docstring


felipecrv Jan 4, 2024
3460eb7

Fix unit test


felipecrv Jan 5, 2024

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


62 changes: 43 additions & 19 deletions
cpp/src/arrow/filesystem/azurefs.cc

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -73,13 +73,17 @@ bool AzureOptions::Equals(const AzureOptions& other) const {
 return false;
 }
 switch (credential_kind_) {
 case CredentialKind::kDefault:
 case CredentialKind::kAnonymous:
 return true;
 case CredentialKind::kTokenCredential:
 return token_credential_ == other.token_credential_;
 case CredentialKind::kStorageSharedKeyCredential:
 case CredentialKind::kStorageSharedKey:
 return storage_shared_key_credential_->AccountName ==
 other.storage_shared_key_credential_->AccountName;
 case CredentialKind::kClientSecret:
 case CredentialKind::kManagedIdentity:
 case CredentialKind::kWorkloadIdentity:
 return token_credential_->GetCredentialName() ==
 other.token_credential_->GetCredentialName();
 }
 DCHECK(false);
 return false;
Expand DownExpand Up@@ -113,8 +117,19 @@ std::string AzureOptions::AccountDfsUrl(const std::string& account_name) const {
 return BuildBaseUrl(dfs_storage_scheme, dfs_storage_authority, account_name);
}

Status AzureOptions::ConfigureDefaultCredential() {
 credential_kind_ = CredentialKind::kDefault;
 token_credential_ = std::make_shared<Azure::Identity::DefaultAzureCredential>();
 return Status::OK();
}

Status AzureOptions::ConfigureAnonymousCredential() {
 credential_kind_ = CredentialKind::kAnonymous;
 return Status::OK();
}

Status AzureOptions::ConfigureAccountKeyCredential(const std::string& account_key) {
 credential_kind_ = CredentialKind::kStorageSharedKeyCredential;
 credential_kind_ = CredentialKind::kStorageSharedKey;
 if (account_name.empty()) {
 return Status::Invalid("AzureOptions doesn't contain a valid account name");
 }
Expand All@@ -126,27 +141,21 @@ Status AzureOptions::ConfigureAccountKeyCredential(const std::string& account_ke
Status AzureOptions::ConfigureClientSecretCredential(const std::string& tenant_id,
 const std::string& client_id,
 const std::string& client_secret) {
 credential_kind_ = CredentialKind::kTokenCredential;
 credential_kind_ = CredentialKind::kClientSecret;
 token_credential_ = std::make_shared<Azure::Identity::ClientSecretCredential>(
 tenant_id, client_id, client_secret);
 return Status::OK();
}

Status AzureOptions::ConfigureDefaultCredential() {
 credential_kind_ = CredentialKind::kTokenCredential;
 token_credential_ = std::make_shared<Azure::Identity::DefaultAzureCredential>();
 return Status::OK();
}

Status AzureOptions::ConfigureManagedIdentityCredential(const std::string& client_id) {
 credential_kind_ = CredentialKind::kTokenCredential;
 credential_kind_ = CredentialKind::kManagedIdentity;
 token_credential_ =
 std::make_shared<Azure::Identity::ManagedIdentityCredential>(client_id);
 return Status::OK();
}

Status AzureOptions::ConfigureWorkloadIdentityCredential() {
 credential_kind_ = CredentialKind::kTokenCredential;
 credential_kind_ = CredentialKind::kWorkloadIdentity;
 token_credential_ = std::make_shared<Azure::Identity::WorkloadIdentityCredential>();
 return Status::OK();
}
Expand All@@ -158,11 +167,18 @@ Result<std::unique_ptr<Blobs::BlobServiceClient>> AzureOptions::MakeBlobServiceC
 }
 switch (credential_kind_) {
 case CredentialKind::kAnonymous:
 break;
 case CredentialKind::kTokenCredential:
 return std::make_unique<Blobs::BlobServiceClient>(AccountBlobUrl(account_name));
 case CredentialKind::kDefault:
 if (!token_credential_) {
 token_credential_ = std::make_shared<Azure::Identity::DefaultAzureCredential>();
 }
 [[fallthrough]];
 case CredentialKind::kClientSecret:
 case CredentialKind::kManagedIdentity:
 case CredentialKind::kWorkloadIdentity:
 return std::make_unique<Blobs::BlobServiceClient>(AccountBlobUrl(account_name),
 token_credential_);
 case CredentialKind::kStorageSharedKeyCredential:
 case CredentialKind::kStorageSharedKey:
 return std::make_unique<Blobs::BlobServiceClient>(AccountBlobUrl(account_name),
 storage_shared_key_credential_);
 }
Expand All@@ -176,11 +192,19 @@ AzureOptions::MakeDataLakeServiceClient() const {
 }
 switch (credential_kind_) {
 case CredentialKind::kAnonymous:
 break;
 case CredentialKind::kTokenCredential:
 return std::make_unique<DataLake::DataLakeServiceClient>(
 AccountDfsUrl(account_name));
 case CredentialKind::kDefault:
 if (!token_credential_) {
 token_credential_ = std::make_shared<Azure::Identity::DefaultAzureCredential>();
 }
 [[fallthrough]];
 case CredentialKind::kClientSecret:
 case CredentialKind::kManagedIdentity:
 case CredentialKind::kWorkloadIdentity:
 return std::make_unique<DataLake::DataLakeServiceClient>(
 AccountDfsUrl(account_name), token_credential_);
 case CredentialKind::kStorageSharedKeyCredential:
 case CredentialKind::kStorageSharedKey:
 return std::make_unique<DataLake::DataLakeServiceClient>(
 AccountDfsUrl(account_name), storage_shared_key_credential_);
 }
Expand Down

37 changes: 26 additions & 11 deletions
cpp/src/arrow/filesystem/azurefs.h

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -47,8 +47,23 @@ namespace arrow::fs {
class TestAzureFileSystem;

/// Options for the AzureFileSystem implementation.
///
/// By default, authentication is handled by the Azure SDK's credential chain
/// which may read from multiple environment variables, such as:
/// - `AZURE_TENANT_ID`
/// - `AZURE_CLIENT_ID`
/// - `AZURE_CLIENT_SECRET`
/// - `AZURE_AUTHORITY_HOST`
/// - `AZURE_CLIENT_CERTIFICATE_PATH`
/// - `AZURE_FEDERATED_TOKEN_FILE`
///
/// Functions are provided for explicit configuration of credentials if that is preferred.
struct ARROW_EXPORT AzureOptions {
 /// \brief account name of the Azure Storage account.
 /// \brief The name of the Azure Storage Account being accessed.
 ///
 /// All service URLs will be constructed using this storage account name.
 /// `ConfigureAccountKeyCredential` assumes the user wants to authenticate
 /// this account.
 std::string account_name;

 /// \brief hostname[:port] of the Azure Blob Storage Service.
Expand DownExpand Up@@ -92,30 +107,30 @@ struct ARROW_EXPORT AzureOptions {

 private:
 enum class CredentialKind {
 kDefault,
 kAnonymous,
 kTokenCredential,
 kStorageSharedKeyCredential,
 } credential_kind_ = CredentialKind::kAnonymous;
 kStorageSharedKey,
 kClientSecret,
 kManagedIdentity,
 kWorkloadIdentity,

Comment on lines

112
 to 
115

@Tom-NewtonTom-NewtonJan 4, 2024

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think we really need to change this. I would rather just keep kTokenCredential to cover all the credentials that are based on https://github.com/Azure/azure-sdk-for-cpp/blob/e5e675440b44ace7d7a9e7bc303f877c06b59ea5/sdk/core/azure-core/inc/azure/core/credentials/credentials.hpp#L68
@felipecrvfelipecrvJan 4, 2024•

edited

Loading

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We need this to support Equals. Think of it as runtime type-information that describes which concrete implementation of TokenCredential is being used.
@felipecrvfelipecrvJan 4, 2024

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Besides that, we would need to make a distinction between kDefault and all the others kToken at least (to support the implicit default behavior). It's clearer if we then make a distinction on all of them.
@Tom-NewtonTom-NewtonJan 5, 2024

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think I would have done it differently but I don't feel strongly.
 } credential_kind_ = CredentialKind::kDefault;

 std::shared_ptr<Azure::Core::Credentials::TokenCredential> token_credential_;
 std::shared_ptr<Azure::Storage::StorageSharedKeyCredential>
 storage_shared_key_credential_;
 mutable std::shared_ptr<Azure::Core::Credentials::TokenCredential> token_credential_;
@koukouJan 4, 2024

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How about always creating Azure::Identity::DefaultAzureCredential instead of using mutable?
diff --git a/cpp/src/arrow/filesystem/azurefs.cc b/cpp/src/arrow/filesystem/azurefs.cc
index e98d56c73..5099cd25d 100644
--- a/cpp/src/arrow/filesystem/azurefs.cc+++ b/cpp/src/arrow/filesystem/azurefs.cc@@ -110,7 +110,6 @@ std::string AzureOptions::AccountDfsUrl(const std::string& account_name) const {
Status AzureOptions::ConfigureDefaultCredential() {
credential_kind_ = CredentialKind::kDefault;
- token_credential_ = std::make_shared<Azure::Identity::DefaultAzureCredential>();
return Status::OK();
}
@@ -160,10 +159,9 @@ Result<std::unique_ptr<Blobs::BlobServiceClient>> AzureOptions::MakeBlobServiceC
case CredentialKind::kAnonymous:
return std::make_unique<Blobs::BlobServiceClient>(AccountBlobUrl(account_name));
case CredentialKind::kDefault:
- if (!token_credential_) {- token_credential_ = std::make_shared<Azure::Identity::DefaultAzureCredential>();- }- [[fallthrough]];+ return std::make_unique<Blobs::BlobServiceClient>(+ AccountBlobUrl(account_name),+ std::make_shared<Azure::Identity::DefaultAzureCredential>());
case CredentialKind::kClientSecret:
case CredentialKind::kManagedIdentity:
case CredentialKind::kWorkloadIdentity:
@@ -186,10 +184,9 @@ AzureOptions::MakeDataLakeServiceClient() const {
return std::make_unique<DataLake::DataLakeServiceClient>(
AccountDfsUrl(account_name));
case CredentialKind::kDefault:
- if (!token_credential_) {- token_credential_ = std::make_shared<Azure::Identity::DefaultAzureCredential>();- }- [[fallthrough]];+ return std::make_unique<DataLake::DataLakeServiceClient>(+ AccountDfsUrl(account_name),+ std::make_shared<Azure::Identity::DefaultAzureCredential>());
case CredentialKind::kClientSecret:
case CredentialKind::kManagedIdentity:
case CredentialKind::kWorkloadIdentity:
diff --git a/cpp/src/arrow/filesystem/azurefs.h b/cpp/src/arrow/filesystem/azurefs.h
index 55f89ba47..ba612f799 100644
--- a/cpp/src/arrow/filesystem/azurefs.h+++ b/cpp/src/arrow/filesystem/azurefs.h@@ -117,7 +117,7 @@ struct ARROW_EXPORT AzureOptions {
std::shared_ptr<Azure::Storage::StorageSharedKeyCredential>
storage_shared_key_credential_;
- mutable std::shared_ptr<Azure::Core::Credentials::TokenCredential> token_credential_;+ std::shared_ptr<Azure::Core::Credentials::TokenCredential> token_credential_;
public:
AzureOptions();
@felipecrvfelipecrvJan 5, 2024

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Creating DefaultAzureCredential is a lot of non-trivial work: env vars, multiple allocations and probes. We can't assume it to be a cheap operation. mutable is a common solution to lazily-initialized class members and this one has a very well-defined behavior: it's set once, then it doesn't change at all anymore.
@felipecrvfelipecrvJan 5, 2024

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

And it's important that we do mutate it in ConfigureDefaultCredential because the user might want to explicitly initialize the credential immediately after doing something with the env variables used by the Azure SDK or right before unsetting the variables.

 public:
 AzureOptions();
 ~AzureOptions();

 Status ConfigureDefaultCredential();

 Status ConfigureManagedIdentityCredential(const std::string& client_id = std::string());

 Status ConfigureWorkloadIdentityCredential();

 Status ConfigureAnonymousCredential();
 Status ConfigureAccountKeyCredential(const std::string& account_key);

 Status ConfigureClientSecretCredential(const std::string& tenant_id,
 const std::string& client_id,
 const std::string& client_secret);
 Status ConfigureManagedIdentityCredential(const std::string& client_id = std::string());
 Status ConfigureWorkloadIdentityCredential();

 bool Equals(const AzureOptions& other) const;

Expand Down

30 changes: 23 additions & 7 deletions
cpp/src/arrow/filesystem/azurefs_test.cc

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -280,22 +280,38 @@ TEST(AzureFileSystem, InitializingFilesystemWithoutAccountNameFails) {
 ASSERT_RAISES(Invalid, AzureFileSystem::Make(options));
}

TEST(AzureFileSystem, InitializeFilesystemWithClientSecretCredential) {
TEST(AzureFileSystem, InitializeWithDefaultCredential) {
 AzureOptions options;
 options.account_name = "dummy-account-name";
 ARROW_EXPECT_OK(
 options.ConfigureClientSecretCredential("tenant_id", "client_id", "client_secret"));
 ARROW_EXPECT_OK(options.ConfigureDefaultCredential());
 EXPECT_OK_AND_ASSIGN(auto fs, AzureFileSystem::Make(options));
}

TEST(AzureFileSystem, InitializeFilesystemWithDefaultCredential) {
TEST(AzureFileSystem, InitializeWithDefaultCredentialImplicitly) {
 AzureOptions options;
 options.account_name = "dummy-account-name";
 ARROW_EXPECT_OK(options.ConfigureDefaultCredential());
 AzureOptions explictly_default_options;
 explictly_default_options.account_name = "dummy-account-name";
 ARROW_EXPECT_OK(explictly_default_options.ConfigureDefaultCredential());
 ASSERT_TRUE(options.Equals(explictly_default_options));
}

TEST(AzureFileSystem, InitializeWithAnonymousCredential) {
 AzureOptions options;
 options.account_name = "dummy-account-name";
 ARROW_EXPECT_OK(options.ConfigureAnonymousCredential());
 EXPECT_OK_AND_ASSIGN(auto fs, AzureFileSystem::Make(options));
}

TEST(AzureFileSystem, InitializeWithClientSecretCredential) {
 AzureOptions options;
 options.account_name = "dummy-account-name";
 ARROW_EXPECT_OK(
 options.ConfigureClientSecretCredential("tenant_id", "client_id", "client_secret"));
 EXPECT_OK_AND_ASSIGN(auto fs, AzureFileSystem::Make(options));
}

TEST(AzureFileSystem, InitializeFilesystemWithManagedIdentityCredential) {
TEST(AzureFileSystem, InitializeWithManagedIdentityCredential) {
 AzureOptions options;
 options.account_name = "dummy-account-name";
 ARROW_EXPECT_OK(options.ConfigureManagedIdentityCredential());
Expand All@@ -305,7 +321,7 @@ TEST(AzureFileSystem, InitializeFilesystemWithManagedIdentityCredential) {
 EXPECT_OK_AND_ASSIGN(fs, AzureFileSystem::Make(options));
}

Comment thread
felipecrv marked this conversation as resolved.


Outdated

TEST(AzureFileSystem, InitializeFilesystemWithWorkloadIdentityCredential) {
TEST(AzureFileSystem, InitializeWithWorkloadIdentityCredential) {
 AzureOptions options;
 options.account_name = "dummy-account-name";
 ARROW_EXPECT_OK(options.ConfigureWorkloadIdentityCredential());
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
GH-39449: [C++] Use default Azure credentials implicitly and support anonymous credentials explicitly#39450

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

felipecrv
merged 6 commits into

from

Jan 5, 2024
 Merged


GH-39449: [C++] Use default Azure credentials implicitly and support anonymous credentials explicitly
#39450
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
fdf5931

GH-39449: [C++] Use default Azure credentials implicitly and support …


felipecrv Jan 4, 2024
3e2adff

Add one enum entry per kind of credential configuration


felipecrv Jan 4, 2024
ea37431

Expand explanation of AzureOptions::account_name


felipecrv Jan 4, 2024
90d457d

Add test for ConfigureAnonymousCredential()


felipecrv Jan 4, 2024
32d1690

Explain authentication in the AzureOptions docstring


felipecrv Jan 4, 2024
3460eb7

Fix unit test


felipecrv Jan 5, 2024

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


62 changes: 43 additions & 19 deletions
cpp/src/arrow/filesystem/azurefs.cc

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -73,13 +73,17 @@ bool AzureOptions::Equals(const AzureOptions& other) const {
 return false;
 }
 switch (credential_kind_) {
 case CredentialKind::kDefault:
 case CredentialKind::kAnonymous:
 return true;
 case CredentialKind::kTokenCredential:
 return token_credential_ == other.token_credential_;
 case CredentialKind::kStorageSharedKeyCredential:
 case CredentialKind::kStorageSharedKey:
 return storage_shared_key_credential_->AccountName ==
 other.storage_shared_key_credential_->AccountName;
 case CredentialKind::kClientSecret:
 case CredentialKind::kManagedIdentity:
 case CredentialKind::kWorkloadIdentity:
 return token_credential_->GetCredentialName() ==
 other.token_credential_->GetCredentialName();
 }
 DCHECK(false);
 return false;
Expand DownExpand Up@@ -113,8 +117,19 @@ std::string AzureOptions::AccountDfsUrl(const std::string& account_name) const {
 return BuildBaseUrl(dfs_storage_scheme, dfs_storage_authority, account_name);
}

Status AzureOptions::ConfigureDefaultCredential() {
 credential_kind_ = CredentialKind::kDefault;
 token_credential_ = std::make_shared<Azure::Identity::DefaultAzureCredential>();
 return Status::OK();
}

Status AzureOptions::ConfigureAnonymousCredential() {
 credential_kind_ = CredentialKind::kAnonymous;
 return Status::OK();
}

Status AzureOptions::ConfigureAccountKeyCredential(const std::string& account_key) {
 credential_kind_ = CredentialKind::kStorageSharedKeyCredential;
 credential_kind_ = CredentialKind::kStorageSharedKey;
 if (account_name.empty()) {
 return Status::Invalid("AzureOptions doesn't contain a valid account name");
 }
Expand All@@ -126,27 +141,21 @@ Status AzureOptions::ConfigureAccountKeyCredential(const std::string& account_ke
Status AzureOptions::ConfigureClientSecretCredential(const std::string& tenant_id,
 const std::string& client_id,
 const std::string& client_secret) {
 credential_kind_ = CredentialKind::kTokenCredential;
 credential_kind_ = CredentialKind::kClientSecret;
 token_credential_ = std::make_shared<Azure::Identity::ClientSecretCredential>(
 tenant_id, client_id, client_secret);
 return Status::OK();
}

Status AzureOptions::ConfigureDefaultCredential() {
 credential_kind_ = CredentialKind::kTokenCredential;
 token_credential_ = std::make_shared<Azure::Identity::DefaultAzureCredential>();
 return Status::OK();
}

Status AzureOptions::ConfigureManagedIdentityCredential(const std::string& client_id) {
 credential_kind_ = CredentialKind::kTokenCredential;
 credential_kind_ = CredentialKind::kManagedIdentity;
 token_credential_ =
 std::make_shared<Azure::Identity::ManagedIdentityCredential>(client_id);
 return Status::OK();
}

Status AzureOptions::ConfigureWorkloadIdentityCredential() {
 credential_kind_ = CredentialKind::kTokenCredential;
 credential_kind_ = CredentialKind::kWorkloadIdentity;
 token_credential_ = std::make_shared<Azure::Identity::WorkloadIdentityCredential>();
 return Status::OK();
}
Expand All@@ -158,11 +167,18 @@ Result<std::unique_ptr<Blobs::BlobServiceClient>> AzureOptions::MakeBlobServiceC
 }
 switch (credential_kind_) {
 case CredentialKind::kAnonymous:
 break;
 case CredentialKind::kTokenCredential:
 return std::make_unique<Blobs::BlobServiceClient>(AccountBlobUrl(account_name));
 case CredentialKind::kDefault:
 if (!token_credential_) {
 token_credential_ = std::make_shared<Azure::Identity::DefaultAzureCredential>();
 }
 [[fallthrough]];
 case CredentialKind::kClientSecret:
 case CredentialKind::kManagedIdentity:
 case CredentialKind::kWorkloadIdentity:
 return std::make_unique<Blobs::BlobServiceClient>(AccountBlobUrl(account_name),
 token_credential_);
 case CredentialKind::kStorageSharedKeyCredential:
 case CredentialKind::kStorageSharedKey:
 return std::make_unique<Blobs::BlobServiceClient>(AccountBlobUrl(account_name),
 storage_shared_key_credential_);
 }
Expand All@@ -176,11 +192,19 @@ AzureOptions::MakeDataLakeServiceClient() const {
 }
 switch (credential_kind_) {
 case CredentialKind::kAnonymous:
 break;
 case CredentialKind::kTokenCredential:
 return std::make_unique<DataLake::DataLakeServiceClient>(
 AccountDfsUrl(account_name));
 case CredentialKind::kDefault:
 if (!token_credential_) {
 token_credential_ = std::make_shared<Azure::Identity::DefaultAzureCredential>();
 }
 [[fallthrough]];
 case CredentialKind::kClientSecret:
 case CredentialKind::kManagedIdentity:
 case CredentialKind::kWorkloadIdentity:
 return std::make_unique<DataLake::DataLakeServiceClient>(
 AccountDfsUrl(account_name), token_credential_);
 case CredentialKind::kStorageSharedKeyCredential:
 case CredentialKind::kStorageSharedKey:
 return std::make_unique<DataLake::DataLakeServiceClient>(
 AccountDfsUrl(account_name), storage_shared_key_credential_);
 }
Expand Down

37 changes: 26 additions & 11 deletions
cpp/src/arrow/filesystem/azurefs.h

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -47,8 +47,23 @@ namespace arrow::fs {
class TestAzureFileSystem;

/// Options for the AzureFileSystem implementation.
///
/// By default, authentication is handled by the Azure SDK's credential chain
/// which may read from multiple environment variables, such as:
/// - `AZURE_TENANT_ID`
/// - `AZURE_CLIENT_ID`
/// - `AZURE_CLIENT_SECRET`
/// - `AZURE_AUTHORITY_HOST`
/// - `AZURE_CLIENT_CERTIFICATE_PATH`
/// - `AZURE_FEDERATED_TOKEN_FILE`
///
/// Functions are provided for explicit configuration of credentials if that is preferred.
struct ARROW_EXPORT AzureOptions {
 /// \brief account name of the Azure Storage account.
 /// \brief The name of the Azure Storage Account being accessed.
 ///
 /// All service URLs will be constructed using this storage account name.
 /// `ConfigureAccountKeyCredential` assumes the user wants to authenticate
 /// this account.
 std::string account_name;

 /// \brief hostname[:port] of the Azure Blob Storage Service.
Expand DownExpand Up@@ -92,30 +107,30 @@ struct ARROW_EXPORT AzureOptions {

 private:
 enum class CredentialKind {
 kDefault,
 kAnonymous,
 kTokenCredential,
 kStorageSharedKeyCredential,
 } credential_kind_ = CredentialKind::kAnonymous;
 kStorageSharedKey,
 kClientSecret,
 kManagedIdentity,
 kWorkloadIdentity,

Comment on lines

112
 to 
115

@Tom-NewtonTom-NewtonJan 4, 2024

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think we really need to change this. I would rather just keep kTokenCredential to cover all the credentials that are based on https://github.com/Azure/azure-sdk-for-cpp/blob/e5e675440b44ace7d7a9e7bc303f877c06b59ea5/sdk/core/azure-core/inc/azure/core/credentials/credentials.hpp#L68
@felipecrvfelipecrvJan 4, 2024•

edited

Loading

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We need this to support Equals. Think of it as runtime type-information that describes which concrete implementation of TokenCredential is being used.
@felipecrvfelipecrvJan 4, 2024

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Besides that, we would need to make a distinction between kDefault and all the others kToken at least (to support the implicit default behavior). It's clearer if we then make a distinction on all of them.
@Tom-NewtonTom-NewtonJan 5, 2024

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think I would have done it differently but I don't feel strongly.
 } credential_kind_ = CredentialKind::kDefault;

 std::shared_ptr<Azure::Core::Credentials::TokenCredential> token_credential_;
 std::shared_ptr<Azure::Storage::StorageSharedKeyCredential>
 storage_shared_key_credential_;
 mutable std::shared_ptr<Azure::Core::Credentials::TokenCredential> token_credential_;
@koukouJan 4, 2024

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How about always creating Azure::Identity::DefaultAzureCredential instead of using mutable?
diff --git a/cpp/src/arrow/filesystem/azurefs.cc b/cpp/src/arrow/filesystem/azurefs.cc
index e98d56c73..5099cd25d 100644
--- a/cpp/src/arrow/filesystem/azurefs.cc+++ b/cpp/src/arrow/filesystem/azurefs.cc@@ -110,7 +110,6 @@ std::string AzureOptions::AccountDfsUrl(const std::string& account_name) const {
Status AzureOptions::ConfigureDefaultCredential() {
credential_kind_ = CredentialKind::kDefault;
- token_credential_ = std::make_shared<Azure::Identity::DefaultAzureCredential>();
return Status::OK();
}
@@ -160,10 +159,9 @@ Result<std::unique_ptr<Blobs::BlobServiceClient>> AzureOptions::MakeBlobServiceC
case CredentialKind::kAnonymous:
return std::make_unique<Blobs::BlobServiceClient>(AccountBlobUrl(account_name));
case CredentialKind::kDefault:
- if (!token_credential_) {- token_credential_ = std::make_shared<Azure::Identity::DefaultAzureCredential>();- }- [[fallthrough]];+ return std::make_unique<Blobs::BlobServiceClient>(+ AccountBlobUrl(account_name),+ std::make_shared<Azure::Identity::DefaultAzureCredential>());
case CredentialKind::kClientSecret:
case CredentialKind::kManagedIdentity:
case CredentialKind::kWorkloadIdentity:
@@ -186,10 +184,9 @@ AzureOptions::MakeDataLakeServiceClient() const {
return std::make_unique<DataLake::DataLakeServiceClient>(
AccountDfsUrl(account_name));
case CredentialKind::kDefault:
- if (!token_credential_) {- token_credential_ = std::make_shared<Azure::Identity::DefaultAzureCredential>();- }- [[fallthrough]];+ return std::make_unique<DataLake::DataLakeServiceClient>(+ AccountDfsUrl(account_name),+ std::make_shared<Azure::Identity::DefaultAzureCredential>());
case CredentialKind::kClientSecret:
case CredentialKind::kManagedIdentity:
case CredentialKind::kWorkloadIdentity:
diff --git a/cpp/src/arrow/filesystem/azurefs.h b/cpp/src/arrow/filesystem/azurefs.h
index 55f89ba47..ba612f799 100644
--- a/cpp/src/arrow/filesystem/azurefs.h+++ b/cpp/src/arrow/filesystem/azurefs.h@@ -117,7 +117,7 @@ struct ARROW_EXPORT AzureOptions {
std::shared_ptr<Azure::Storage::StorageSharedKeyCredential>
storage_shared_key_credential_;
- mutable std::shared_ptr<Azure::Core::Credentials::TokenCredential> token_credential_;+ std::shared_ptr<Azure::Core::Credentials::TokenCredential> token_credential_;
public:
AzureOptions();
@felipecrvfelipecrvJan 5, 2024

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Creating DefaultAzureCredential is a lot of non-trivial work: env vars, multiple allocations and probes. We can't assume it to be a cheap operation. mutable is a common solution to lazily-initialized class members and this one has a very well-defined behavior: it's set once, then it doesn't change at all anymore.
@felipecrvfelipecrvJan 5, 2024

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

And it's important that we do mutate it in ConfigureDefaultCredential because the user might want to explicitly initialize the credential immediately after doing something with the env variables used by the Azure SDK or right before unsetting the variables.

 public:
 AzureOptions();
 ~AzureOptions();

 Status ConfigureDefaultCredential();

 Status ConfigureManagedIdentityCredential(const std::string& client_id = std::string());

 Status ConfigureWorkloadIdentityCredential();

 Status ConfigureAnonymousCredential();
 Status ConfigureAccountKeyCredential(const std::string& account_key);

 Status ConfigureClientSecretCredential(const std::string& tenant_id,
 const std::string& client_id,
 const std::string& client_secret);
 Status ConfigureManagedIdentityCredential(const std::string& client_id = std::string());
 Status ConfigureWorkloadIdentityCredential();

 bool Equals(const AzureOptions& other) const;

Expand Down

30 changes: 23 additions & 7 deletions
cpp/src/arrow/filesystem/azurefs_test.cc

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -280,22 +280,38 @@ TEST(AzureFileSystem, InitializingFilesystemWithoutAccountNameFails) {
 ASSERT_RAISES(Invalid, AzureFileSystem::Make(options));
}

TEST(AzureFileSystem, InitializeFilesystemWithClientSecretCredential) {
TEST(AzureFileSystem, InitializeWithDefaultCredential) {
 AzureOptions options;
 options.account_name = "dummy-account-name";
 ARROW_EXPECT_OK(
 options.ConfigureClientSecretCredential("tenant_id", "client_id", "client_secret"));
 ARROW_EXPECT_OK(options.ConfigureDefaultCredential());
 EXPECT_OK_AND_ASSIGN(auto fs, AzureFileSystem::Make(options));
}

TEST(AzureFileSystem, InitializeFilesystemWithDefaultCredential) {
TEST(AzureFileSystem, InitializeWithDefaultCredentialImplicitly) {
 AzureOptions options;
 options.account_name = "dummy-account-name";
 ARROW_EXPECT_OK(options.ConfigureDefaultCredential());
 AzureOptions explictly_default_options;
 explictly_default_options.account_name = "dummy-account-name";
 ARROW_EXPECT_OK(explictly_default_options.ConfigureDefaultCredential());
 ASSERT_TRUE(options.Equals(explictly_default_options));
}

TEST(AzureFileSystem, InitializeWithAnonymousCredential) {
 AzureOptions options;
 options.account_name = "dummy-account-name";
 ARROW_EXPECT_OK(options.ConfigureAnonymousCredential());
 EXPECT_OK_AND_ASSIGN(auto fs, AzureFileSystem::Make(options));
}

TEST(AzureFileSystem, InitializeWithClientSecretCredential) {
 AzureOptions options;
 options.account_name = "dummy-account-name";
 ARROW_EXPECT_OK(
 options.ConfigureClientSecretCredential("tenant_id", "client_id", "client_secret"));
 EXPECT_OK_AND_ASSIGN(auto fs, AzureFileSystem::Make(options));
}

TEST(AzureFileSystem, InitializeFilesystemWithManagedIdentityCredential) {
TEST(AzureFileSystem, InitializeWithManagedIdentityCredential) {
 AzureOptions options;
 options.account_name = "dummy-account-name";
 ARROW_EXPECT_OK(options.ConfigureManagedIdentityCredential());
Expand All@@ -305,7 +321,7 @@ TEST(AzureFileSystem, InitializeFilesystemWithManagedIdentityCredential) {
 EXPECT_OK_AND_ASSIGN(fs, AzureFileSystem::Make(options));
}

Comment thread
felipecrv marked this conversation as resolved.


Outdated

TEST(AzureFileSystem, InitializeFilesystemWithWorkloadIdentityCredential) {
TEST(AzureFileSystem, InitializeWithWorkloadIdentityCredential) {
 AzureOptions options;
 options.account_name = "dummy-account-name";
 ARROW_EXPECT_OK(options.ConfigureWorkloadIdentityCredential());
Expand Down