Skip to content

Azure/ADLS GetOptions() XML: document missing AZURE_STORAGE_ACCESS_TOKEN and AZURE_STORAGE_SAS_TOKEN #14731

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

Open
rouault wants to merge 1 commit into
base: master
Choose a base branch
from
+37 −32
Open

Azure/ADLS GetOptions() XML: document missing AZURE_STORAGE_ACCESS_TOKEN and AZURE_STORAGE_SAS_TOKEN #14731

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
31 changes: 31 additions & 0 deletions port/cpl_azure.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@
#include "cpl_http.h"
#include "cpl_multiproc.h"
#include "cpl_vsi_virtual.h"
#include "cpl_vsil_curl_class.h"

#include <mutex>

Expand Down Expand Up @@ -1313,6 +1314,36 @@ std::string VSIAzureBlobHandleHelper::GetSignedURL(CSLConstList papszOptions)
return m_osURL;
}

/************************************************************************/
/* GetOptions() */
/************************************************************************/

/* static */
const char *VSIAzureBlobHandleHelper::GetOptions()
{
static std::string osOptions(
std::string("<Options>") +
" <Option name='AZURE_STORAGE_CONNECTION_STRING' type='string' "
"description='Connection string that contains account name and "
"secret key'/>"
" <Option name='AZURE_STORAGE_ACCOUNT' type='string' "
"description='Storage account. To use with AZURE_STORAGE_ACCESS_KEY'/>"
" <Option name='AZURE_STORAGE_ACCESS_KEY' type='string' "
"description='Secret key'/>"
" <Option name='AZURE_STORAGE_ACCESS_TOKEN' type='string' "
"description='Access token typically obtained using Microsoft "
"Authentication Library (MSAL).'/>"
" <Option name='AZURE_STORAGE_SAS_TOKEN' type='string' "
"description='Shared Access Signature'/>"
" <Option name='AZURE_NO_SIGN_REQUEST' type='boolean' "
"description='Whether to disable signing of requests' default='NO'/>"
" <Option name='VSIAZ_CHUNK_SIZE' type='int' "
"description='Size in MB for chunks of files that are uploaded' "
"default='4' min='1' max='4'/>" +
cpl::VSICurlFilesystemHandlerBase::GetOptionsStatic() + "</Options>");
return osOptions.c_str();
}

#endif // HAVE_CURL

//! @endcond
2 changes: 2 additions & 0 deletions port/cpl_azure.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,6 +107,8 @@ class VSIAzureBlobHandleHelper final : public IVSIS3LikeHandleHelper
static std::string GetSAS(const char *pszFilename);

static bool IsNoSignRequest(const char *pszFilename);

static const char *GetOptions();
};

namespace cpl
Expand Down
15 changes: 1 addition & 14 deletions port/cpl_vsil_adls.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2029,20 +2029,7 @@ char **VSIADLSFSHandler::GetFileList(const char *pszDirname, int nMaxFiles,

const char *VSIADLSFSHandler::GetOptions()
{
static std::string osOptions(
std::string("<Options>") +
" <Option name='AZURE_STORAGE_CONNECTION_STRING' type='string' "
"description='Connection string that contains account name and "
"secret key'/>"
" <Option name='AZURE_STORAGE_ACCOUNT' type='string' "
"description='Storage account. To use with AZURE_STORAGE_ACCESS_KEY'/>"
" <Option name='AZURE_STORAGE_ACCESS_KEY' type='string' "
"description='Secret key'/>"
" <Option name='VSIAZ_CHUNK_SIZE' type='int' "
"description='Size in MB for chunks of files that are uploaded' "
"default='4' min='1' max='4'/>" +
VSICurlFilesystemHandlerBase::GetOptionsStatic() + "</Options>");
return osOptions.c_str();
return VSIAzureBlobHandleHelper::GetOptions();
}

/************************************************************************/
Expand Down
17 changes: 1 addition & 16 deletions port/cpl_vsil_az.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2430,22 +2430,7 @@ char **VSIAzureFSHandler::GetFileList(const char *pszDirname, int nMaxFiles,

const char *VSIAzureFSHandler::GetOptions()
{
static std::string osOptions(
std::string("<Options>") +
" <Option name='AZURE_STORAGE_CONNECTION_STRING' type='string' "
"description='Connection string that contains account name and "
"secret key'/>"
" <Option name='AZURE_STORAGE_ACCOUNT' type='string' "
"description='Storage account. To use with AZURE_STORAGE_ACCESS_KEY'/>"
" <Option name='AZURE_STORAGE_ACCESS_KEY' type='string' "
"description='Secret key'/>"
" <Option name='AZURE_NO_SIGN_REQUEST' type='boolean' "
"description='Whether to disable signing of requests' default='NO'/>"
" <Option name='VSIAZ_CHUNK_SIZE' type='int' "
"description='Size in MB for chunks of files that are uploaded' "
"default='4' min='1' max='4'/>" +
VSICurlFilesystemHandlerBase::GetOptionsStatic() + "</Options>");
return osOptions.c_str();
return VSIAzureBlobHandleHelper::GetOptions();
}

/************************************************************************/
Expand Down
4 changes: 2 additions & 2 deletions port/cpl_vsil_curl_class.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -233,8 +233,6 @@ class VSICurlFilesystemHandlerBase : public VSIFilesystemHandler
int nMaxFiles, bool &bIsTruncated,
std::string &osNextMarker);

static const char *GetOptionsStatic();

VSICurlFilesystemHandlerBase();

public:
Expand Down Expand Up @@ -322,6 +320,8 @@ class VSICurlFilesystemHandlerBase : public VSIFilesystemHandler
GetStreamingFilename(const std::string &osFilename) const override = 0;

static std::set<std::string> GetS3IgnoredStorageClasses();

static const char *GetOptionsStatic();
};

class VSICurlFilesystemHandler final : public VSICurlFilesystemHandlerBase
Expand Down
Loading