From 2eff3aa1b1c7e767befa7306becb9a3fee65d1f7 Mon Sep 17 00:00:00 2001 From: JinmingHu Date: Thu, 12 Nov 2020 16:30:04 +0800 Subject: [PATCH] rename ToSasQueryParameters->GenerateSasToken (#958) --- .../azure/storage/blobs/blob_sas_builder.hpp | 4 +- .../src/blob_sas_builder.cpp | 4 +- .../test/blob_batch_client_test.cpp | 2 +- .../test/blob_container_client_test.cpp | 2 +- .../test/blob_sas_test.cpp | 62 +++++++++---------- .../storage/common/account_sas_builder.hpp | 2 +- .../src/account_sas_builder.cpp | 2 +- .../files/datalake/datalake_sas_builder.hpp | 4 +- .../src/datalake_sas_builder.cpp | 4 +- .../test/datalake_sas_test.cpp | 34 +++++----- .../files/shares/share_sas_builder.hpp | 2 +- .../src/share_sas_builder.cpp | 2 +- .../test/share_sas_test.cpp | 16 ++--- 13 files changed, 70 insertions(+), 70 deletions(-) diff --git a/sdk/storage/azure-storage-blobs/inc/azure/storage/blobs/blob_sas_builder.hpp b/sdk/storage/azure-storage-blobs/inc/azure/storage/blobs/blob_sas_builder.hpp index cf8a7784e..a86edbfbc 100644 --- a/sdk/storage/azure-storage-blobs/inc/azure/storage/blobs/blob_sas_builder.hpp +++ b/sdk/storage/azure-storage-blobs/inc/azure/storage/blobs/blob_sas_builder.hpp @@ -285,7 +285,7 @@ namespace Azure { namespace Storage { namespace Blobs { * @param credential The storage account's shared key credential. * @return The SAS query parameters used for authenticating requests. */ - std::string ToSasQueryParameters(const SharedKeyCredential& credential); + std::string GenerateSasToken(const SharedKeyCredential& credential); /** * @brief Uses an account's user delegation key to sign this shared access signature, to @@ -295,7 +295,7 @@ namespace Azure { namespace Storage { namespace Blobs { * @param accountName The name of the storage account. * @return The SAS query parameters used for authenticating requests. */ - std::string ToSasQueryParameters( + std::string GenerateSasToken( const Models::UserDelegationKey& userDelegationKey, const std::string& accountName); diff --git a/sdk/storage/azure-storage-blobs/src/blob_sas_builder.cpp b/sdk/storage/azure-storage-blobs/src/blob_sas_builder.cpp index 52e5c12d6..32f011259 100644 --- a/sdk/storage/azure-storage-blobs/src/blob_sas_builder.cpp +++ b/sdk/storage/azure-storage-blobs/src/blob_sas_builder.cpp @@ -107,7 +107,7 @@ namespace Azure { namespace Storage { namespace Blobs { } } - std::string BlobSasBuilder::ToSasQueryParameters(const SharedKeyCredential& credential) + std::string BlobSasBuilder::GenerateSasToken(const SharedKeyCredential& credential) { std::string canonicalName = "/blob/" + credential.AccountName + "/" + ContainerName; if (Resource == BlobSasResource::Blob || Resource == BlobSasResource::BlobSnapshot @@ -193,7 +193,7 @@ namespace Azure { namespace Storage { namespace Blobs { return builder.GetAbsoluteUrl(); } - std::string BlobSasBuilder::ToSasQueryParameters( + std::string BlobSasBuilder::GenerateSasToken( const Models::UserDelegationKey& userDelegationKey, const std::string& accountName) { diff --git a/sdk/storage/azure-storage-blobs/test/blob_batch_client_test.cpp b/sdk/storage/azure-storage-blobs/test/blob_batch_client_test.cpp index e564480cd..770b28ef4 100644 --- a/sdk/storage/azure-storage-blobs/test/blob_batch_client_test.cpp +++ b/sdk/storage/azure-storage-blobs/test/blob_batch_client_test.cpp @@ -51,7 +51,7 @@ namespace Azure { namespace Storage { namespace Test { EXPECT_THROW(batchClient.SubmitBatch(batch), StorageException); batchClient = Blobs::BlobBatchClient( - serviceClient.GetUri() + accountSasBuilder.ToSasQueryParameters(*keyCredential)); + serviceClient.GetUri() + accountSasBuilder.GenerateSasToken(*keyCredential)); EXPECT_NO_THROW(batchClient.SubmitBatch(batch)); diff --git a/sdk/storage/azure-storage-blobs/test/blob_container_client_test.cpp b/sdk/storage/azure-storage-blobs/test/blob_container_client_test.cpp index f923f0c02..ad2f892ab 100644 --- a/sdk/storage/azure-storage-blobs/test/blob_container_client_test.cpp +++ b/sdk/storage/azure-storage-blobs/test/blob_container_client_test.cpp @@ -45,7 +45,7 @@ namespace Azure { namespace Storage { namespace Test { sasBuilder.ContainerName = m_containerName; sasBuilder.Resource = Blobs::BlobSasResource::Container; sasBuilder.SetPermissions(Blobs::BlobContainerSasPermissions::All); - return sasBuilder.ToSasQueryParameters( + return sasBuilder.GenerateSasToken( *Details::ParseConnectionString(StandardStorageConnectionString()).KeyCredential); } diff --git a/sdk/storage/azure-storage-blobs/test/blob_sas_test.cpp b/sdk/storage/azure-storage-blobs/test/blob_sas_test.cpp index 724a45531..97049af96 100644 --- a/sdk/storage/azure-storage-blobs/test/blob_sas_test.cpp +++ b/sdk/storage/azure-storage-blobs/test/blob_sas_test.cpp @@ -131,7 +131,7 @@ namespace Azure { namespace Storage { namespace Test { }) { accountSasBuilder.SetPermissions(permissions); - auto sasToken = accountSasBuilder.ToSasQueryParameters(*keyCredential); + auto sasToken = accountSasBuilder.GenerateSasToken(*keyCredential); if ((permissions & AccountSasPermissions::Read) == AccountSasPermissions::Read) { @@ -178,8 +178,8 @@ namespace Azure { namespace Storage { namespace Test { Blobs::BlobSasPermissions::DeleteVersion}) { blobSasBuilder.SetPermissions(permissions); - auto sasToken = blobSasBuilder.ToSasQueryParameters(*keyCredential); - auto sasToken2 = blobSasBuilder.ToSasQueryParameters(userDelegationKey, accountName); + auto sasToken = blobSasBuilder.GenerateSasToken(*keyCredential); + auto sasToken2 = blobSasBuilder.GenerateSasToken(userDelegationKey, accountName); if ((permissions & Blobs::BlobSasPermissions::Read) == Blobs::BlobSasPermissions::Read) { @@ -219,7 +219,7 @@ namespace Azure { namespace Storage { namespace Test { AccountSasBuilder builder2 = accountSasBuilder; builder2.StartsOn = ToIso8601(std::chrono::system_clock::now() - std::chrono::minutes(5)); builder2.ExpiresOn = ToIso8601(std::chrono::system_clock::now() - std::chrono::minutes(1)); - auto sasToken = builder2.ToSasQueryParameters(*keyCredential); + auto sasToken = builder2.GenerateSasToken(*keyCredential); EXPECT_THROW(verify_blob_create(sasToken), StorageException); } @@ -227,7 +227,7 @@ namespace Azure { namespace Storage { namespace Test { { AccountSasBuilder builder2 = accountSasBuilder; builder2.StartsOn.Reset(); - auto sasToken = builder2.ToSasQueryParameters(*keyCredential); + auto sasToken = builder2.GenerateSasToken(*keyCredential); EXPECT_NO_THROW(verify_blob_create(sasToken)); } @@ -235,12 +235,12 @@ namespace Azure { namespace Storage { namespace Test { { AccountSasBuilder builder2 = accountSasBuilder; builder2.IPRange = "1.1.1.1"; - auto sasToken = builder2.ToSasQueryParameters(*keyCredential); + auto sasToken = builder2.GenerateSasToken(*keyCredential); EXPECT_THROW(verify_blob_create(sasToken), StorageException); // TODO: Add this test case back with support to contain IPv6 ranges when service is ready. // builder2.IPRange = "0.0.0.0-255.255.255.255"; - // sasToken = builder2.ToSasQueryParameters(*keyCredential); + // sasToken = builder2.GenerateSasToken(*keyCredential); // EXPECT_NO_THROW(verify_blob_create(sasToken)); } @@ -248,11 +248,11 @@ namespace Azure { namespace Storage { namespace Test { { AccountSasBuilder builder2 = accountSasBuilder; builder2.Services = AccountSasServices::Files; - auto sasToken = builder2.ToSasQueryParameters(*keyCredential); + auto sasToken = builder2.GenerateSasToken(*keyCredential); EXPECT_THROW(verify_blob_create(sasToken), StorageException); builder2.Services = AccountSasServices::All; - sasToken = builder2.ToSasQueryParameters(*keyCredential); + sasToken = builder2.GenerateSasToken(*keyCredential); EXPECT_NO_THROW(verify_blob_create(sasToken)); } @@ -260,7 +260,7 @@ namespace Azure { namespace Storage { namespace Test { { AccountSasBuilder builder2 = accountSasBuilder; builder2.ResourceTypes = AccountSasResource::Service; - auto sasToken = builder2.ToSasQueryParameters(*keyCredential); + auto sasToken = builder2.GenerateSasToken(*keyCredential); EXPECT_THROW(verify_blob_create(sasToken), StorageException); auto serviceClient = Blobs::BlobServiceClient(serviceUri + sasToken); @@ -278,8 +278,8 @@ namespace Azure { namespace Storage { namespace Test { Blobs::BlobContainerSasPermissions::Tags}) { containerSasBuilder.SetPermissions(permissions); - auto sasToken = containerSasBuilder.ToSasQueryParameters(*keyCredential); - auto sasToken2 = containerSasBuilder.ToSasQueryParameters(userDelegationKey, accountName); + auto sasToken = containerSasBuilder.GenerateSasToken(*keyCredential); + auto sasToken2 = containerSasBuilder.GenerateSasToken(userDelegationKey, accountName); if ((permissions & Blobs::BlobContainerSasPermissions::Read) == Blobs::BlobContainerSasPermissions::Read) @@ -331,10 +331,10 @@ namespace Azure { namespace Storage { namespace Test { Blobs::BlobSasBuilder builder2 = blobSasBuilder; builder2.StartsOn = ToIso8601(std::chrono::system_clock::now() - std::chrono::minutes(5)); builder2.ExpiresOn = ToIso8601(std::chrono::system_clock::now() - std::chrono::minutes(1)); - auto sasToken = builder2.ToSasQueryParameters(*keyCredential); + auto sasToken = builder2.GenerateSasToken(*keyCredential); EXPECT_THROW(verify_blob_create(sasToken), StorageException); - auto sasToken2 = builder2.ToSasQueryParameters(userDelegationKey, accountName); + auto sasToken2 = builder2.GenerateSasToken(userDelegationKey, accountName); EXPECT_THROW(verify_blob_create(sasToken2), StorageException); } @@ -342,9 +342,9 @@ namespace Azure { namespace Storage { namespace Test { { Blobs::BlobSasBuilder builder2 = blobSasBuilder; builder2.StartsOn.Reset(); - auto sasToken = builder2.ToSasQueryParameters(*keyCredential); + auto sasToken = builder2.GenerateSasToken(*keyCredential); EXPECT_NO_THROW(verify_blob_create(sasToken)); - auto sasToken2 = builder2.ToSasQueryParameters(userDelegationKey, accountName); + auto sasToken2 = builder2.GenerateSasToken(userDelegationKey, accountName); EXPECT_NO_THROW(verify_blob_create(sasToken2)); } @@ -352,16 +352,16 @@ namespace Azure { namespace Storage { namespace Test { { Blobs::BlobSasBuilder builder2 = blobSasBuilder; builder2.IPRange = "0.0.0.0-0.0.0.1"; - auto sasToken = builder2.ToSasQueryParameters(*keyCredential); + auto sasToken = builder2.GenerateSasToken(*keyCredential); EXPECT_THROW(verify_blob_create(sasToken), StorageException); - auto sasToken2 = builder2.ToSasQueryParameters(userDelegationKey, accountName); + auto sasToken2 = builder2.GenerateSasToken(userDelegationKey, accountName); EXPECT_THROW(verify_blob_create(sasToken2), StorageException); // TODO: Add this test case back with support to contain IPv6 ranges when service is ready. // builder2.IPRange = "0.0.0.0-255.255.255.255"; - // sasToken = builder2.ToSasQueryParameters(*keyCredential); + // sasToken = builder2.GenerateSasToken(*keyCredential); // EXPECT_NO_THROW(verify_blob_create(sasToken)); - // sasToken2 = builder2.ToSasQueryParameters(userDelegationKey, accountName); + // sasToken2 = builder2.GenerateSasToken(userDelegationKey, accountName); // EXPECT_NO_THROW(verify_blob_create(sasToken2)); } @@ -384,7 +384,7 @@ namespace Azure { namespace Storage { namespace Test { builder2.SetPermissions(static_cast(0)); builder2.Identifier = identifier.Id; - auto sasToken = builder2.ToSasQueryParameters(*keyCredential); + auto sasToken = builder2.GenerateSasToken(*keyCredential); EXPECT_NO_THROW(verify_blob_read(sasToken)); } @@ -403,7 +403,7 @@ namespace Azure { namespace Storage { namespace Test { builder2.ContentDisposition = "attachment"; builder2.CacheControl = "no-cache"; builder2.ContentEncoding = "identify"; - auto sasToken = builder2.ToSasQueryParameters(*keyCredential); + auto sasToken = builder2.GenerateSasToken(*keyCredential); auto blobClient = Blobs::AppendBlobClient(blobUri + sasToken); blobClient0.Create(); auto p = blobClient.GetProperties(); @@ -413,7 +413,7 @@ namespace Azure { namespace Storage { namespace Test { EXPECT_EQ(p->HttpHeaders.CacheControl, headers.CacheControl); EXPECT_EQ(p->HttpHeaders.ContentEncoding, headers.ContentEncoding); - auto sasToken2 = builder2.ToSasQueryParameters(userDelegationKey, accountName); + auto sasToken2 = builder2.GenerateSasToken(userDelegationKey, accountName); blobClient = Blobs::AppendBlobClient(blobUri + sasToken2); p = blobClient.GetProperties(); EXPECT_EQ(p->HttpHeaders.ContentType, headers.ContentType); @@ -459,8 +459,8 @@ namespace Azure { namespace Storage { namespace Test { { create_snapshot(); BlobSnapshotSasBuilder.SetPermissions(permissions); - auto sasToken = BlobSnapshotSasBuilder.ToSasQueryParameters(*keyCredential); - auto sasToken2 = BlobSnapshotSasBuilder.ToSasQueryParameters(userDelegationKey, accountName); + auto sasToken = BlobSnapshotSasBuilder.GenerateSasToken(*keyCredential); + auto sasToken2 = BlobSnapshotSasBuilder.GenerateSasToken(userDelegationKey, accountName); if ((permissions & Blobs::BlobSasPermissions::Read) == Blobs::BlobSasPermissions::Read) { @@ -470,10 +470,10 @@ namespace Azure { namespace Storage { namespace Test { if ((permissions & Blobs::BlobSasPermissions::Delete) == Blobs::BlobSasPermissions::Delete) { create_snapshot(); - sasToken = BlobSnapshotSasBuilder.ToSasQueryParameters(*keyCredential); + sasToken = BlobSnapshotSasBuilder.GenerateSasToken(*keyCredential); verify_blob_snapshot_delete(sasToken); create_snapshot(); - sasToken2 = BlobSnapshotSasBuilder.ToSasQueryParameters(userDelegationKey, accountName); + sasToken2 = BlobSnapshotSasBuilder.GenerateSasToken(userDelegationKey, accountName); verify_blob_snapshot_delete(sasToken2); } } @@ -520,8 +520,8 @@ namespace Azure { namespace Storage { namespace Test { { create_version(); BlobVersionSasBuilder.SetPermissions(permissions); - auto sasToken = BlobVersionSasBuilder.ToSasQueryParameters(*keyCredential); - auto sasToken2 = BlobVersionSasBuilder.ToSasQueryParameters(userDelegationKey, accountName); + auto sasToken = BlobVersionSasBuilder.GenerateSasToken(*keyCredential); + auto sasToken2 = BlobVersionSasBuilder.GenerateSasToken(userDelegationKey, accountName); if ((permissions & Blobs::BlobSasPermissions::Read) == Blobs::BlobSasPermissions::Read) { @@ -532,10 +532,10 @@ namespace Azure { namespace Storage { namespace Test { == Blobs::BlobSasPermissions::DeleteVersion) { create_version(); - sasToken = BlobVersionSasBuilder.ToSasQueryParameters(*keyCredential); + sasToken = BlobVersionSasBuilder.GenerateSasToken(*keyCredential); verify_blob_delete_version(sasToken); create_version(); - sasToken2 = BlobVersionSasBuilder.ToSasQueryParameters(userDelegationKey, accountName); + sasToken2 = BlobVersionSasBuilder.GenerateSasToken(userDelegationKey, accountName); verify_blob_delete_version(sasToken2); } } diff --git a/sdk/storage/azure-storage-common/inc/azure/storage/common/account_sas_builder.hpp b/sdk/storage/azure-storage-common/inc/azure/storage/common/account_sas_builder.hpp index d554b81f8..e8348bcd1 100644 --- a/sdk/storage/azure-storage-common/inc/azure/storage/common/account_sas_builder.hpp +++ b/sdk/storage/azure-storage-common/inc/azure/storage/common/account_sas_builder.hpp @@ -257,7 +257,7 @@ namespace Azure { namespace Storage { * @return The SAS query parameters used for * authenticating requests. */ - std::string ToSasQueryParameters(const SharedKeyCredential& credential); + std::string GenerateSasToken(const SharedKeyCredential& credential); private: std::string Permissions; diff --git a/sdk/storage/azure-storage-common/src/account_sas_builder.cpp b/sdk/storage/azure-storage-common/src/account_sas_builder.cpp index 412ca4938..516bdf798 100644 --- a/sdk/storage/azure-storage-common/src/account_sas_builder.cpp +++ b/sdk/storage/azure-storage-common/src/account_sas_builder.cpp @@ -57,7 +57,7 @@ namespace Azure { namespace Storage { } } - std::string AccountSasBuilder::ToSasQueryParameters(const SharedKeyCredential& credential) + std::string AccountSasBuilder::GenerateSasToken(const SharedKeyCredential& credential) { std::string protocol; if (Protocol == SasProtocol::HttpsAndHtttp) diff --git a/sdk/storage/azure-storage-files-datalake/inc/azure/storage/files/datalake/datalake_sas_builder.hpp b/sdk/storage/azure-storage-files-datalake/inc/azure/storage/files/datalake/datalake_sas_builder.hpp index 172bccd32..118a2f71d 100644 --- a/sdk/storage/azure-storage-files-datalake/inc/azure/storage/files/datalake/datalake_sas_builder.hpp +++ b/sdk/storage/azure-storage-files-datalake/inc/azure/storage/files/datalake/datalake_sas_builder.hpp @@ -316,7 +316,7 @@ namespace Azure { namespace Storage { namespace Files { namespace DataLake { * @param credential The storage account's shared key credential. * @return The SAS query parameters used for authenticating requests. */ - std::string ToSasQueryParameters(const SharedKeyCredential& credential); + std::string GenerateSasToken(const SharedKeyCredential& credential); /** * @brief Uses an account's user delegation key to sign this shared access signature, to @@ -326,7 +326,7 @@ namespace Azure { namespace Storage { namespace Files { namespace DataLake { * @param accountName The name of the storage account. * @return The SAS query parameters used for authenticating requests. */ - std::string ToSasQueryParameters( + std::string GenerateSasToken( const UserDelegationKey& userDelegationKey, const std::string& accountName); diff --git a/sdk/storage/azure-storage-files-datalake/src/datalake_sas_builder.cpp b/sdk/storage/azure-storage-files-datalake/src/datalake_sas_builder.cpp index 684f22e60..0ba25e363 100644 --- a/sdk/storage/azure-storage-files-datalake/src/datalake_sas_builder.cpp +++ b/sdk/storage/azure-storage-files-datalake/src/datalake_sas_builder.cpp @@ -113,7 +113,7 @@ namespace Azure { namespace Storage { namespace Files { namespace DataLake { } } - std::string DataLakeSasBuilder::ToSasQueryParameters(const SharedKeyCredential& credential) + std::string DataLakeSasBuilder::GenerateSasToken(const SharedKeyCredential& credential) { std::string canonicalName = "/blob/" + credential.AccountName + "/" + FileSystemName; if (Resource == DataLakeSasResource::File) @@ -188,7 +188,7 @@ namespace Azure { namespace Storage { namespace Files { namespace DataLake { return builder.GetAbsoluteUrl(); } - std::string DataLakeSasBuilder::ToSasQueryParameters( + std::string DataLakeSasBuilder::GenerateSasToken( const UserDelegationKey& userDelegationKey, const std::string& accountName) { diff --git a/sdk/storage/azure-storage-files-datalake/test/datalake_sas_test.cpp b/sdk/storage/azure-storage-files-datalake/test/datalake_sas_test.cpp index d12cc7f3b..fab5b23cb 100644 --- a/sdk/storage/azure-storage-files-datalake/test/datalake_sas_test.cpp +++ b/sdk/storage/azure-storage-files-datalake/test/datalake_sas_test.cpp @@ -156,8 +156,8 @@ namespace Azure { namespace Storage { namespace Test { }) { fileSasBuilder.SetPermissions(permissions); - auto sasToken = fileSasBuilder.ToSasQueryParameters(*keyCredential); - auto sasToken2 = fileSasBuilder.ToSasQueryParameters(userDelegationKey, accountName); + auto sasToken = fileSasBuilder.GenerateSasToken(*keyCredential); + auto sasToken2 = fileSasBuilder.GenerateSasToken(userDelegationKey, accountName); if ((permissions & Files::DataLake::DataLakeSasPermissions::Read) == Files::DataLake::DataLakeSasPermissions::Read) @@ -212,7 +212,7 @@ namespace Azure { namespace Storage { namespace Test { }) { directorySasBuilder.SetPermissions(permissions); - auto sasToken2 = directorySasBuilder.ToSasQueryParameters(userDelegationKey, accountName); + auto sasToken2 = directorySasBuilder.GenerateSasToken(userDelegationKey, accountName); if ((permissions & Files::DataLake::DataLakeSasPermissions::Read) == Files::DataLake::DataLakeSasPermissions::Read) @@ -281,8 +281,8 @@ namespace Azure { namespace Storage { namespace Test { }) { filesystemSasBuilder.SetPermissions(permissions); - auto sasToken = filesystemSasBuilder.ToSasQueryParameters(*keyCredential); - auto sasToken2 = filesystemSasBuilder.ToSasQueryParameters(userDelegationKey, accountName); + auto sasToken = filesystemSasBuilder.GenerateSasToken(*keyCredential); + auto sasToken2 = filesystemSasBuilder.GenerateSasToken(userDelegationKey, accountName); if ((permissions & Files::DataLake::DataLakeFileSystemSasPermissions::All) == Files::DataLake::DataLakeFileSystemSasPermissions::All) @@ -339,10 +339,10 @@ namespace Azure { namespace Storage { namespace Test { Files::DataLake::DataLakeSasBuilder builder2 = fileSasBuilder; builder2.StartsOn = ToIso8601(std::chrono::system_clock::now() - std::chrono::minutes(5)); builder2.ExpiresOn = ToIso8601(std::chrono::system_clock::now() - std::chrono::minutes(1)); - auto sasToken = builder2.ToSasQueryParameters(*keyCredential); + auto sasToken = builder2.GenerateSasToken(*keyCredential); EXPECT_THROW(verify_file_create(sasToken), StorageException); - auto sasToken2 = builder2.ToSasQueryParameters(userDelegationKey, accountName); + auto sasToken2 = builder2.GenerateSasToken(userDelegationKey, accountName); EXPECT_THROW(verify_file_create(sasToken2), StorageException); } @@ -350,9 +350,9 @@ namespace Azure { namespace Storage { namespace Test { { Files::DataLake::DataLakeSasBuilder builder2 = fileSasBuilder; builder2.StartsOn.Reset(); - auto sasToken = builder2.ToSasQueryParameters(*keyCredential); + auto sasToken = builder2.GenerateSasToken(*keyCredential); EXPECT_NO_THROW(verify_file_create(sasToken)); - auto sasToken2 = builder2.ToSasQueryParameters(userDelegationKey, accountName); + auto sasToken2 = builder2.GenerateSasToken(userDelegationKey, accountName); EXPECT_NO_THROW(verify_file_create(sasToken2)); } @@ -360,16 +360,16 @@ namespace Azure { namespace Storage { namespace Test { { Files::DataLake::DataLakeSasBuilder builder2 = fileSasBuilder; builder2.IPRange = "0.0.0.0-0.0.0.1"; - auto sasToken = builder2.ToSasQueryParameters(*keyCredential); + auto sasToken = builder2.GenerateSasToken(*keyCredential); EXPECT_THROW(verify_file_create(sasToken), StorageException); - auto sasToken2 = builder2.ToSasQueryParameters(userDelegationKey, accountName); + auto sasToken2 = builder2.GenerateSasToken(userDelegationKey, accountName); EXPECT_THROW(verify_file_create(sasToken2), StorageException); // TODO: Add this test case back with support to contain IPv6 ranges when service is ready. // builder2.IPRange = "0.0.0.0-255.255.255.255"; - // sasToken = builder2.ToSasQueryParameters(*keyCredential); + // sasToken = builder2.GenerateSasToken(*keyCredential); // EXPECT_NO_THROW(verify_file_create(sasToken)); - // sasToken2 = builder2.ToSasQueryParameters(userDelegationKey, accountName); + // sasToken2 = builder2.GenerateSasToken(userDelegationKey, accountName); // EXPECT_NO_THROW(verify_file_create(sasToken2)); } @@ -378,7 +378,7 @@ namespace Azure { namespace Storage { namespace Test { Files::DataLake::DataLakeSasBuilder builder2 = fileSasBuilder; builder2.PreauthorizedAgentObjectId = Azure::Core::Uuid::CreateUuid().GetUuidString(); builder2.CorrelationId = Azure::Core::Uuid::CreateUuid().GetUuidString(); - auto sasToken2 = builder2.ToSasQueryParameters(userDelegationKey, accountName); + auto sasToken2 = builder2.GenerateSasToken(userDelegationKey, accountName); EXPECT_NO_THROW(verify_file_read(sasToken2)); } @@ -401,7 +401,7 @@ namespace Azure { namespace Storage { namespace Test { builder2.SetPermissions(static_cast(0)); builder2.Identifier = identifier.Id; - auto sasToken = builder2.ToSasQueryParameters(*keyCredential); + auto sasToken = builder2.GenerateSasToken(*keyCredential); EXPECT_NO_THROW(verify_file_read(sasToken)); } @@ -421,7 +421,7 @@ namespace Azure { namespace Storage { namespace Test { builder2.ContentDisposition = "attachment"; builder2.CacheControl = "no-cache"; builder2.ContentEncoding = "identify"; - auto sasToken = builder2.ToSasQueryParameters(*keyCredential); + auto sasToken = builder2.GenerateSasToken(*keyCredential); auto fileClient = Files::DataLake::FileClient(fileUri + sasToken); fileClient0.Create(); auto p = fileClient.GetProperties(); @@ -431,7 +431,7 @@ namespace Azure { namespace Storage { namespace Test { EXPECT_EQ(p->HttpHeaders.CacheControl, headers.CacheControl); EXPECT_EQ(p->HttpHeaders.ContentEncoding, headers.ContentEncoding); - auto sasToken2 = builder2.ToSasQueryParameters(userDelegationKey, accountName); + auto sasToken2 = builder2.GenerateSasToken(userDelegationKey, accountName); fileClient = Files::DataLake::FileClient(fileUri + sasToken); p = fileClient.GetProperties(); EXPECT_EQ(p->HttpHeaders.ContentType, headers.ContentType); diff --git a/sdk/storage/azure-storage-files-shares/inc/azure/storage/files/shares/share_sas_builder.hpp b/sdk/storage/azure-storage-files-shares/inc/azure/storage/files/shares/share_sas_builder.hpp index ff8c2bcff..e96afcfc1 100644 --- a/sdk/storage/azure-storage-files-shares/inc/azure/storage/files/shares/share_sas_builder.hpp +++ b/sdk/storage/azure-storage-files-shares/inc/azure/storage/files/shares/share_sas_builder.hpp @@ -224,7 +224,7 @@ namespace Azure { namespace Storage { namespace Files { namespace Shares { * @param credential The storage account's shared key credential. * @return The SAS query parameters used for authenticating requests. */ - std::string ToSasQueryParameters(const SharedKeyCredential& credential); + std::string GenerateSasToken(const SharedKeyCredential& credential); private: std::string Permissions; diff --git a/sdk/storage/azure-storage-files-shares/src/share_sas_builder.cpp b/sdk/storage/azure-storage-files-shares/src/share_sas_builder.cpp index f7181532a..98e1b085e 100644 --- a/sdk/storage/azure-storage-files-shares/src/share_sas_builder.cpp +++ b/sdk/storage/azure-storage-files-shares/src/share_sas_builder.cpp @@ -74,7 +74,7 @@ namespace Azure { namespace Storage { namespace Files { namespace Shares { } } - std::string ShareSasBuilder::ToSasQueryParameters(const SharedKeyCredential& credential) + std::string ShareSasBuilder::GenerateSasToken(const SharedKeyCredential& credential) { std::string canonicalName = "/file/" + credential.AccountName + "/" + ShareName; if (Resource == ShareSasResource::File) diff --git a/sdk/storage/azure-storage-files-shares/test/share_sas_test.cpp b/sdk/storage/azure-storage-files-shares/test/share_sas_test.cpp index e945e7e7a..bfdbc87cc 100644 --- a/sdk/storage/azure-storage-files-shares/test/share_sas_test.cpp +++ b/sdk/storage/azure-storage-files-shares/test/share_sas_test.cpp @@ -79,7 +79,7 @@ namespace Azure { namespace Storage { namespace Test { Files::Shares::ShareSasPermissions::All}) { shareSasBuilder.SetPermissions(permissions); - auto sasToken = shareSasBuilder.ToSasQueryParameters(*keyCredential); + auto sasToken = shareSasBuilder.GenerateSasToken(*keyCredential); if ((permissions & Files::Shares::ShareSasPermissions::Read) == Files::Shares::ShareSasPermissions::Read) @@ -115,7 +115,7 @@ namespace Azure { namespace Storage { namespace Test { Files::Shares::ShareFileSasPermissions::Create}) { fileSasBuilder.SetPermissions(permissions); - auto sasToken = fileSasBuilder.ToSasQueryParameters(*keyCredential); + auto sasToken = fileSasBuilder.GenerateSasToken(*keyCredential); if ((permissions & Files::Shares::ShareFileSasPermissions::Read) == Files::Shares::ShareFileSasPermissions::Read) @@ -145,7 +145,7 @@ namespace Azure { namespace Storage { namespace Test { Files::Shares::ShareSasBuilder builder2 = fileSasBuilder; builder2.StartsOn = ToIso8601(std::chrono::system_clock::now() - std::chrono::minutes(5)); builder2.ExpiresOn = ToIso8601(std::chrono::system_clock::now() - std::chrono::minutes(1)); - auto sasToken = builder2.ToSasQueryParameters(*keyCredential); + auto sasToken = builder2.GenerateSasToken(*keyCredential); EXPECT_THROW(verifyFileRead(sasToken), StorageException); } @@ -153,7 +153,7 @@ namespace Azure { namespace Storage { namespace Test { { Files::Shares::ShareSasBuilder builder2 = fileSasBuilder; builder2.StartsOn.Reset(); - auto sasToken = builder2.ToSasQueryParameters(*keyCredential); + auto sasToken = builder2.GenerateSasToken(*keyCredential); EXPECT_NO_THROW(verifyFileRead(sasToken)); } @@ -161,12 +161,12 @@ namespace Azure { namespace Storage { namespace Test { { Files::Shares::ShareSasBuilder builder2 = fileSasBuilder; builder2.IPRange = "0.0.0.0-0.0.0.1"; - auto sasToken = builder2.ToSasQueryParameters(*keyCredential); + auto sasToken = builder2.GenerateSasToken(*keyCredential); EXPECT_THROW(verifyFileRead(sasToken), StorageException); // TODO: Add this test case back with support to contain IPv6 ranges when service is ready. // builder2.IPRange = "0.0.0.0-255.255.255.255"; - // sasToken = builder2.ToSasQueryParameters(*keyCredential); + // sasToken = builder2.GenerateSasToken(*keyCredential); // EXPECT_NO_THROW(verifyFileRead(sasToken)); } @@ -188,7 +188,7 @@ namespace Azure { namespace Storage { namespace Test { builder2.SetPermissions(static_cast(0)); builder2.Identifier = identifier.Id; - auto sasToken = builder2.ToSasQueryParameters(*keyCredential); + auto sasToken = builder2.GenerateSasToken(*keyCredential); EXPECT_NO_THROW(verifyFileRead(sasToken)); } @@ -207,7 +207,7 @@ namespace Azure { namespace Storage { namespace Test { builder2.ContentDisposition = "attachment"; builder2.CacheControl = "no-cache"; builder2.ContentEncoding = "identify"; - auto sasToken = builder2.ToSasQueryParameters(*keyCredential); + auto sasToken = builder2.GenerateSasToken(*keyCredential); auto fileClient = Files::Shares::FileClient(fileUri + sasToken); fileClient0.Create(0); auto p = fileClient.GetProperties();