Skip to content
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.

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

[Storage] AppendBlobClient request validation #21974

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
20 changes: 20 additions & 0 deletions sdk/storage/Azure.Storage.Blobs/src/AppendBlobClient.cs
Original file line number Diff line number Diff line change
Expand Up @@ -866,6 +866,10 @@ private async Task<Response<BlobContentInfo>> CreateInternal(

DiagnosticScope scope = ClientConfiguration.ClientDiagnostics.CreateScope($"{nameof(AppendBlobClient)}.{nameof(Create)}");

conditions.ValidateConditionsNotPresent(
BlobRequestConditionProperty.IfAppendPositionEqual
| BlobRequestConditionProperty.IfMaxSizeLessThanOrEqual);

try
{
scope.Start();
Expand Down Expand Up @@ -1127,6 +1131,9 @@ internal async Task<Response<BlobAppendInfo>> AppendBlockInternal(

DiagnosticScope scope = ClientConfiguration.ClientDiagnostics.CreateScope($"{nameof(AppendBlobClient)}.{nameof(AppendBlock)}");

// All AppendBlobRequestConditions are valid.
conditions.ValidateConditionsNotPresent(BlobRequestConditionProperty.None);

try
{
scope.Start();
Expand Down Expand Up @@ -1522,6 +1529,15 @@ private async Task<Response<BlobAppendInfo>> AppendBlockFromUriInternal(

DiagnosticScope scope = ClientConfiguration.ClientDiagnostics.CreateScope($"{nameof(AppendBlobClient)}.{nameof(AppendBlockFromUri)}");

// All destination AppendBlobRequestConditions are valid.
conditions.ValidateConditionsNotPresent(BlobRequestConditionProperty.None);

sourceConditions.ValidateConditionsNotPresent(
BlobRequestConditionProperty.LeaseId
| BlobRequestConditionProperty.TagConditions
| BlobRequestConditionProperty.IfAppendPositionEqual
| BlobRequestConditionProperty.IfMaxSizeLessThanOrEqual);

try
{
scope.Start();
Expand Down Expand Up @@ -1691,6 +1707,10 @@ private async Task<Response<BlobInfo>> SealInternal(
{
DiagnosticScope scope = ClientConfiguration.ClientDiagnostics.CreateScope($"{nameof(AppendBlobClient)}.{nameof(Seal)}");

conditions.ValidateConditionsNotPresent(
BlobRequestConditionProperty.IfMaxSizeLessThanOrEqual
| BlobRequestConditionProperty.TagConditions);

try
{
scope.Start();
Expand Down
64 changes: 57 additions & 7 deletions sdk/storage/Azure.Storage.Blobs/src/BlobExtensions.cs
Original file line number Diff line number Diff line change
Expand Up @@ -1375,7 +1375,7 @@ internal static BlobLegalHoldResult ToBlobLegalHoldInfo(this ResponseWithHeaders
#endregion

#region ValidateConditionsNotPresent
internal static void ValidateConditionsNotPresent(this BlobRequestConditions requestConditions, BlobRequestConditionProperty invalidConditions)
internal static void ValidateConditionsNotPresent(this BlobLeaseRequestConditions requestConditions, BlobRequestConditionProperty invalidConditions)
{
if (AppContextSwitchHelper.GetConfigValue(
Constants.DisableRequestConditionsValidationSwitchName,
Expand All @@ -1389,12 +1389,6 @@ internal static void ValidateConditionsNotPresent(this BlobRequestConditions req
return;
}

if ((invalidConditions & BlobRequestConditionProperty.LeaseId) == BlobRequestConditionProperty.LeaseId
&& requestConditions.LeaseId != null)
{
throw new ArgumentException($"{nameof(BlobRequestConditions.LeaseId)} is not applicable to this API.");
}

if ((invalidConditions & BlobRequestConditionProperty.TagConditions) == BlobRequestConditionProperty.TagConditions
&& requestConditions.TagConditions != null)
{
Expand Down Expand Up @@ -1425,6 +1419,62 @@ internal static void ValidateConditionsNotPresent(this BlobRequestConditions req
throw new ArgumentException($"{nameof(BlobRequestConditions.IfNoneMatch)} is not applicable to this API.");
}
}

internal static void ValidateConditionsNotPresent(this BlobRequestConditions requestConditions, BlobRequestConditionProperty invalidConditions)
{
if (AppContextSwitchHelper.GetConfigValue(
Constants.DisableRequestConditionsValidationSwitchName,
Constants.DisableRequestConditionsValidationEnvVar))
{
return;
}

if (requestConditions == null)
{
return;
}

// Validate BlobLeaseRequestConditions conditions.
((BlobLeaseRequestConditions)requestConditions).ValidateConditionsNotPresent(invalidConditions);

// Validate BlobRequestConditions specific conditions.
if ((invalidConditions & BlobRequestConditionProperty.LeaseId) == BlobRequestConditionProperty.LeaseId
&& requestConditions.LeaseId != null)
{
throw new ArgumentException($"{nameof(BlobRequestConditions.LeaseId)} is not applicable to this API.");
}
}

internal static void ValidateConditionsNotPresent(this AppendBlobRequestConditions requestConditions, BlobRequestConditionProperty invalidConditions)
{
if (AppContextSwitchHelper.GetConfigValue(
Constants.DisableRequestConditionsValidationSwitchName,
Constants.DisableRequestConditionsValidationEnvVar))
{
return;
}

if (requestConditions == null)
{
return;
}

// Validate BlobRequestConditions
((BlobRequestConditions)requestConditions).ValidateConditionsNotPresent(invalidConditions);

// Validate AppendBlobRequestConditions specific conditions.
if ((invalidConditions & BlobRequestConditionProperty.IfAppendPositionEqual) == BlobRequestConditionProperty.IfAppendPositionEqual
&& requestConditions.IfAppendPositionEqual != null)
{
throw new ArgumentException($"{nameof(AppendBlobRequestConditions.IfAppendPositionEqual)} is not applicable to this API.");
}

if ((invalidConditions & BlobRequestConditionProperty.IfMaxSizeLessThanOrEqual) == BlobRequestConditionProperty.IfMaxSizeLessThanOrEqual
&& requestConditions.IfMaxSizeLessThanOrEqual != null)
{
throw new ArgumentException($"{nameof(AppendBlobRequestConditions.IfMaxSizeLessThanOrEqual)} is not applicable to this API.");
}
}
#endregion
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,14 @@ namespace Azure.Storage.Blobs.Models
{
internal enum BlobRequestConditionProperty
{
None = 0,
LeaseId = 1,
TagConditions = 2,
IfModifiedSince = 4,
IfUnmodifiedSince = 8,
IfMatch = 16,
IfNoneMatch = 32
IfNoneMatch = 32,
IfAppendPositionEqual = 64,
IfMaxSizeLessThanOrEqual = 128
}
}
108 changes: 106 additions & 2 deletions sdk/storage/Azure.Storage.Blobs/tests/AppendBlobClientTests.cs
Original file line number Diff line number Diff line change
Expand Up @@ -230,6 +230,39 @@ public async Task CreateAsync()
Assert.AreEqual(blobName, blobs.First().Name);
}

[RecordedTest]
[TestCase(nameof(AppendBlobRequestConditions.IfAppendPositionEqual))]
[TestCase(nameof(AppendBlobRequestConditions.IfMaxSizeLessThanOrEqual))]
public async Task CreateAsync_InvalidRequestConditions(string invalidCondition)
{
// Arrange
Uri uri = new Uri("https://www.doesntmatter.com");
AppendBlobClient appendBlobClient = new AppendBlobClient(uri, GetOptions());

AppendBlobRequestConditions conditions = new AppendBlobRequestConditions();

switch (invalidCondition)
{
case nameof(AppendBlobRequestConditions.IfAppendPositionEqual):
conditions.IfAppendPositionEqual = 0;
break;
case nameof(AppendBlobRequestConditions.IfMaxSizeLessThanOrEqual):
conditions.IfMaxSizeLessThanOrEqual = 0;
break;
}

AppendBlobCreateOptions options = new AppendBlobCreateOptions
{
Conditions = conditions
};

// Act
await TestHelper.AssertExpectedExceptionAsync<ArgumentException>(
appendBlobClient.CreateAsync(
options),
e => Assert.AreEqual($"{invalidCondition} is not applicable to this API.", e.Message));
}

[RecordedTest]
[ServiceVersion(Min = BlobClientOptions.ServiceVersion.V2019_12_12)]
public async Task CreateAsync_Tags()
Expand Down Expand Up @@ -962,6 +995,48 @@ public async Task AppendBlockFromUriAsync_Min()
}
}

[RecordedTest]
[TestCase(nameof(AppendBlobRequestConditions.LeaseId))]
[TestCase(nameof(AppendBlobRequestConditions.TagConditions))]
[TestCase(nameof(AppendBlobRequestConditions.IfAppendPositionEqual))]
[TestCase(nameof(AppendBlobRequestConditions.IfMaxSizeLessThanOrEqual))]
public async Task AppendBlockFromUriAsync_InvalidSourceRequestConditions(string invalidSourceCondition)
{
// Arrange
Uri uri = new Uri("https://www.doesntmatter.com");
AppendBlobClient appendBlobClient = new AppendBlobClient(uri, GetOptions());

AppendBlobRequestConditions sourceConditions = new AppendBlobRequestConditions();

switch (invalidSourceCondition)
{
case nameof(AppendBlobRequestConditions.LeaseId):
sourceConditions.LeaseId = "LeaseId";
break;
case nameof(AppendBlobRequestConditions.TagConditions):
sourceConditions.TagConditions = "TagConditions";
break;
case nameof(AppendBlobRequestConditions.IfAppendPositionEqual):
sourceConditions.IfAppendPositionEqual = 0;
break;
case nameof(AppendBlobRequestConditions.IfMaxSizeLessThanOrEqual):
sourceConditions.IfMaxSizeLessThanOrEqual = 0;
break;
}

AppendBlobAppendBlockFromUriOptions options = new AppendBlobAppendBlockFromUriOptions
{
SourceConditions = sourceConditions
};

// Act
await TestHelper.AssertExpectedExceptionAsync<ArgumentException>(
appendBlobClient.AppendBlockFromUriAsync(
uri,
options),
e => Assert.AreEqual($"{invalidSourceCondition} is not applicable to this API.", e.Message));
}

[RecordedTest]
public async Task AppendBlockFromUriAsync_CPK()
{
Expand Down Expand Up @@ -1472,6 +1547,35 @@ public async Task SealAsync()
Assert.IsTrue(blobs.First().Properties.IsSealed);
}

[RecordedTest]
[ServiceVersion(Min = BlobClientOptions.ServiceVersion.V2019_12_12)]
[TestCase(nameof(AppendBlobRequestConditions.IfMaxSizeLessThanOrEqual))]
[TestCase(nameof(AppendBlobRequestConditions.TagConditions))]
public async Task SealAsync_InvalidRequestConditions(string invalidCondition)
{
// Arrange
Uri uri = new Uri("https://www.doesntmatter.com");
AppendBlobClient appendBlobClient = new AppendBlobClient(uri, GetOptions());

AppendBlobRequestConditions conditions = new AppendBlobRequestConditions();

switch (invalidCondition)
{
case nameof(AppendBlobRequestConditions.IfMaxSizeLessThanOrEqual):
conditions.IfMaxSizeLessThanOrEqual = 0;
break;
case nameof(AppendBlobRequestConditions.TagConditions):
conditions.TagConditions = "TagConditions";
break;
}

// Act
await TestHelper.AssertExpectedExceptionAsync<ArgumentException>(
appendBlobClient.SealAsync(
conditions),
e => Assert.AreEqual($"{invalidCondition} is not applicable to this API.", e.Message));
}

[RecordedTest]
[ServiceVersion(Min = BlobClientOptions.ServiceVersion.V2019_12_12)]
public async Task SealAsync_Error()
Expand Down Expand Up @@ -1866,8 +1970,8 @@ public async Task OpenWriteAsync_AccessConditions(bool overwrite)
new AccessConditionParameters { Match = ReceivedETag },
new AccessConditionParameters { NoneMatch = GarbageETag },
new AccessConditionParameters { LeaseId = ReceivedLeaseId },
new AccessConditionParameters { AppendPosE = 0 },
new AccessConditionParameters { MaxSizeLTE = 100 }
new AccessConditionParameters { AppendPosE = overwrite ? null : 0 },
new AccessConditionParameters { MaxSizeLTE = overwrite ? null : 100 }
};
foreach (AccessConditionParameters parameters in testCases)
{
Expand Down

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading